org.apache.commons.crypto.cipher

?? CryptoCipher

??????:

AutoCloseable, Closeable

public interface CryptoCipher
extends Closeable

The interface of cryptographic cipher for encryption and decryption.

Note that implementations must provide a constructor that has 2 parameters:
a Properties instance and a String (transformation)

????

??????	?????
int	doFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
int	doFinal(ByteBuffer inBuffer, ByteBuffer outBuffer) Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
String	getAlgorithm() Returns the algorithm name of this CryptoCipher object.
int	getBlockSize() Returns the block size (in bytes).
void	init(int mode, Key key, AlgorithmParameterSpec params) Initializes the cipher with mode, key and iv.
int	update(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) Continues a multiple-part encryption/decryption operation.
int	update(ByteBuffer inBuffer, ByteBuffer outBuffer) Continues a multiple-part encryption/decryption operation.

???????? java.io.Closeable

close

??????

getBlockSize

int getBlockSize()

Returns the block size (in bytes).

??:

the block size (in bytes), or 0 if the underlying algorithm is not a block cipher

getAlgorithm

String getAlgorithm()

Returns the algorithm name of this CryptoCipher object.

This is the same name that was specified in one of the CryptoCipherFactory#getInstance calls that created this CryptoCipher object..

??:

the algorithm name of this CryptoCipher object.

init

void init(int mode,
          Key key,
          AlgorithmParameterSpec params)
   throws InvalidKeyException,
          InvalidAlgorithmParameterException

Initializes the cipher with mode, key and iv.

??:

mode - Cipher.ENCRYPT_MODE or Cipher.DECRYPT_MODE

key - crypto key for the cipher

params - the algorithm parameters

??:

InvalidKeyException - if the given key is inappropriate for initializing this cipher, or its keysize exceeds the maximum allowable keysize (as determined from the configured jurisdiction policy files).

InvalidAlgorithmParameterException - if the given algorithm parameters are inappropriate for this cipher, or this cipher requires algorithm parameters and params is null, or the given algorithm parameters imply a cryptographic strength that would exceed the legal limits (as determined from the configured jurisdiction policy files).

update

int update(ByteBuffer inBuffer,
           ByteBuffer outBuffer)
    throws ShortBufferException

Continues a multiple-part encryption/decryption operation. The data is encrypted or decrypted, depending on how this cipher was initialized.

??:

inBuffer - the input ByteBuffer

outBuffer - the output ByteBuffer

??:

int number of bytes stored in output

??:

ShortBufferException - if there is insufficient space in the output buffer

update

int update(byte[] input,
           int inputOffset,
           int inputLen,
           byte[] output,
           int outputOffset)
    throws ShortBufferException

Continues a multiple-part encryption/decryption operation. The data is encrypted or decrypted, depending on how this cipher was initialized.

??:

input - the input byte array

inputOffset - the offset in input where the input starts

inputLen - the input length

output - the byte array for the result

outputOffset - the offset in output where the result is stored

??:

the number of bytes stored in output

??:

ShortBufferException - if there is insufficient space in the output byte array

doFinal

int doFinal(ByteBuffer inBuffer,
            ByteBuffer outBuffer)
     throws ShortBufferException,
            IllegalBlockSizeException,
            BadPaddingException

Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.

??:

inBuffer - the input ByteBuffer

outBuffer - the output ByteBuffer

??:

int number of bytes stored in output

??:

BadPaddingException - if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes

IllegalBlockSizeException - if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.

ShortBufferException - if the given output buffer is too small to hold the result

doFinal

int doFinal(byte[] input,
            int inputOffset,
            int inputLen,
            byte[] output,
            int outputOffset)
     throws ShortBufferException,
            IllegalBlockSizeException,
            BadPaddingException

Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.

??:

input - the input byte array

inputOffset - the offset in input where the input starts

inputLen - the input length

output - the byte array for the result

outputOffset - the offset in output where the result is stored

??:

the number of bytes stored in output

??:

ShortBufferException - if the given output byte array is too small to hold the result

BadPaddingException - if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes

IllegalBlockSizeException - if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.