org.apache.sshd.common.cipher

Interface Cipher

All Known Implementing Classes:

BaseCipher, BaseRC4Cipher, CipherNone

public interface Cipher

Wrapper for a cryptographic cipher, used either for encryption or decryption.

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Cipher.Mode

Method Summary

Modifier and Type	Method and Description
int	getBlockSize()
int	getIVSize()
void	init(Cipher.Mode mode, byte[] key, byte[] iv) Initialize the cipher for encryption or decryption with the given key and initialization vector
void	update(byte[] input) Performs in-place encryption or decryption on the given data.
void	update(byte[] input, int inputOffset, int inputLen) Performs in-place encryption or decryption on the given data.

Method Detail

getIVSize

int getIVSize()

Returns:

Size of the initialization vector (in bytes)

getBlockSize

int getBlockSize()

Returns:

The block size (in bytes) for this cipher

init

void init(Cipher.Mode mode,
          byte[] key,
          byte[] iv)
   throws Exception

Initialize the cipher for encryption or decryption with the given key and initialization vector

Parameters:

mode - Encrypt/Decrypt initialization

key - Key bytes

iv - Initialization vector bytes

Throws:

Exception - If failed to initialize

update

void update(byte[] input)
     throws Exception

Performs in-place encryption or decryption on the given data.

Parameters:

input - The input/output bytes

Throws:

Exception - If failed to execute

See Also:

update(byte[], int, int)

update

void update(byte[] input,
            int inputOffset,
            int inputLen)
     throws Exception

Performs in-place encryption or decryption on the given data.

Parameters:

input - The input/output bytes

inputOffset - The offset of the data in the data buffer

inputLen - The number of bytes to update - starting at the given offset

Throws:

Exception - If failed to execute