Apache Mina SSHD 2.15.0 · org.apache.sshd.common.cipher.BaseCipher

Modifier and Type	Class and Description
pack-priv static interface	BaseCipher.CipherFactory

Modifier and Type	Field and Description
private final String	algorithm
pack-priv static boolean	alwaysReInit
private final int	authSize
private final int	blkSize
private Cipher	cipher
pack-priv static BaseCipher.CipherFactory	factory
private final int	ivsize
private final int	kdfSize
private final int	keySize
protected Cipher.Mode	mode
private String	s
private SecretKey	secretKey
private final String	transformation

Access	Constructor and Description
public	BaseCipher(int ivsize, int authSize, int kdfSize, String algorithm, int keySize, String transformation, int blkSize)

Method Summary

Modifier and Type	Method and Description
protected Cipher	createCipherInstance(Cipher.Mode mode, byte[] key, byte[] iv)
protected AlgorithmParameterSpec	determineNewParameters(byte[] processed, int offset, int length)
public String	getAlgorithm() Implements org.apache.sshd.common.AlgorithmNameProvider.getAlgorithm.
public int	getAuthenticationTagSize() Implements org.apache.sshd.common.cipher.CipherInformation.getAuthenticationTagSize.
public int	getCipherBlockSize() Implements org.apache.sshd.common.cipher.CipherInformation.getCipherBlockSize.
protected Cipher	getCipherInstance()
public int	getIVSize() Implements org.apache.sshd.common.cipher.CipherInformation.getIVSize.
public int	getKdfSize() Implements org.apache.sshd.common.cipher.CipherInformation.getKdfSize.
public int	getKeySize() Implements org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize.
public String	getTransformation() Implements org.apache.sshd.common.cipher.CipherInformation.getTransformation.
public void	init(Cipher.Mode Encrypt/Decrypt initialization mode, byte[] Key bytes key, byte[] Initialization vector bytes iv) Implements org.apache.sshd.common.cipher.Cipher.init. Initialize the cipher for encryption or decryption with the given key and initialization vector
protected byte[]	initializeIVData(Cipher.Mode mode, byte[] iv, int reqLen)
protected byte[]	initializeKeyData(Cipher.Mode mode, byte[] key, int reqLen)
protected void	reInit(byte[] processed, int offset, int length)
protected static byte[]	resize(byte[] data, int size)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	update(byte[] The input/output bytes input, int The offset of the data in the data buffer inputOffset, int The number of bytes to update, starting at the given offset; must be a multiple of the cipher's block size inputLen) Implements org.apache.sshd.common.cipher.Cipher.update. Performs in-place encryption or decryption on the given data.
public void	updateAAD(byte[] The additional data to authenticate data, int The offset of the additional data in the buffer offset, int The number of bytes in the buffer to use for authentication length) Implements org.apache.sshd.common.cipher.Cipher.updateAAD. Adds the provided input data as additional authenticated data during encryption or decryption.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

algorithm	back to summary
private final String algorithm

alwaysReInit	back to summary
pack-priv static boolean alwaysReInit

authSize	back to summary
private final int authSize

blkSize	back to summary
private final int blkSize

cipher	back to summary
private Cipher cipher

factory	back to summary
pack-priv static BaseCipher.CipherFactory factory

ivsize	back to summary
private final int ivsize

kdfSize	back to summary
private final int kdfSize

keySize	back to summary
private final int keySize

mode	back to summary
protected Cipher.Mode mode

s	back to summary
private String s

secretKey	back to summary
private SecretKey secretKey

transformation	back to summary
private final String transformation

BaseCipher	back to summary
public BaseCipher(int ivsize, int authSize, int kdfSize, String algorithm, int keySize, String transformation, int blkSize)

Method Detail

createCipherInstance	back to summary
protected Cipher createCipherInstance(Cipher.Mode mode, byte[] key, byte[] iv) throws Exception

determineNewParameters	back to summary
protected AlgorithmParameterSpec determineNewParameters(byte[] processed, int offset, int length)

getAlgorithm	back to summary
public String getAlgorithm() Implements org.apache.sshd.common.AlgorithmNameProvider.getAlgorithm. Annotations @Override

getAlgorithm

back to summary

public String getAlgorithm()

Implements org.apache.sshd.common.AlgorithmNameProvider.getAlgorithm.

Annotations

@Override

getAuthenticationTagSize	back to summary
public int getAuthenticationTagSize() Implements org.apache.sshd.common.cipher.CipherInformation.getAuthenticationTagSize. Returns:int Doc from org.apache.sshd.common.cipher.CipherInformation.getAuthenticationTagSize. Size of the authentication tag (AT) in bytes or 0 if this cipher does not support authentication Annotations @Override

getAuthenticationTagSize

back to summary

public int getAuthenticationTagSize()

Implements org.apache.sshd.common.cipher.CipherInformation.getAuthenticationTagSize.

Returns:int

Doc from org.apache.sshd.common.cipher.CipherInformation.getAuthenticationTagSize.

Size of the authentication tag (AT) in bytes or 0 if this cipher does not support authentication

Annotations

@Override

getCipherBlockSize	back to summary
public int getCipherBlockSize() Implements org.apache.sshd.common.cipher.CipherInformation.getCipherBlockSize. Returns:int Doc from org.apache.sshd.common.cipher.CipherInformation.getCipherBlockSize. Size of block data used by the cipher (in bytes). For stream ciphers this value is (currently) used to indicate some average work buffer size to be used for the automatic re-keying mechanism described in RFC 4253 - Section 9 Annotations @Override

getCipherBlockSize

back to summary

public int getCipherBlockSize()

Implements org.apache.sshd.common.cipher.CipherInformation.getCipherBlockSize.

Returns:int

Doc from org.apache.sshd.common.cipher.CipherInformation.getCipherBlockSize.

Size of block data used by the cipher (in bytes). For stream ciphers this value is (currently) used to indicate some average work buffer size to be used for the automatic re-keying mechanism described in RFC 4253 - Section 9

Annotations

@Override

getCipherInstance	back to summary
protected Cipher getCipherInstance()

getIVSize	back to summary
public int getIVSize() Implements org.apache.sshd.common.cipher.CipherInformation.getIVSize. Returns:int Doc from org.apache.sshd.common.cipher.CipherInformation.getIVSize. Size of the initialization vector (in bytes) Annotations @Override

getIVSize

back to summary

public int getIVSize()

Implements org.apache.sshd.common.cipher.CipherInformation.getIVSize.

Returns:int

Doc from org.apache.sshd.common.cipher.CipherInformation.getIVSize.

Size of the initialization vector (in bytes)

Annotations

@Override

getKdfSize	back to summary
public int getKdfSize() Implements org.apache.sshd.common.cipher.CipherInformation.getKdfSize. Returns:int Doc from org.apache.sshd.common.cipher.CipherInformation.getKdfSize. The block size (in bytes) used to derive the secret key for this cipher Annotations @Override

getKdfSize

back to summary

public int getKdfSize()

Implements org.apache.sshd.common.cipher.CipherInformation.getKdfSize.

Returns:int

Doc from org.apache.sshd.common.cipher.CipherInformation.getKdfSize.

The block size (in bytes) used to derive the secret key for this cipher

Annotations

@Override

getKeySize	back to summary
public int getKeySize() Implements org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize. Returns:int Doc from org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize. The number of bits used in the key Annotations @Override

getKeySize

back to summary

public int getKeySize()

Implements org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize.

Returns:int

Doc from org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize.

The number of bits used in the key

Annotations

@Override

getTransformation	back to summary
public String getTransformation() Implements org.apache.sshd.common.cipher.CipherInformation.getTransformation. Returns:String Doc from org.apache.sshd.common.cipher.CipherInformation.getTransformation. The actual transformation used - e.g., AES/CBC/NoPadding Annotations @Override

getTransformation

back to summary

public String getTransformation()

Implements org.apache.sshd.common.cipher.CipherInformation.getTransformation.

Returns:String

Doc from org.apache.sshd.common.cipher.CipherInformation.getTransformation.

The actual transformation used - e.g., AES/CBC/NoPadding

Annotations

@Override

init	back to summary
public void init(Cipher.Mode mode, byte[] key, byte[] iv) throws Exception Implements org.apache.sshd.common.cipher.Cipher.init. Doc from org.apache.sshd.common.cipher.Cipher.init. Initialize the cipher for encryption or decryption with the given key and initialization vector Parameters mode:Cipher.Mode Encrypt/Decrypt initialization key:byte[] Key bytes iv:byte[] Initialization vector bytes Annotations @Override Exceptions Exception: If failed to initialize

init

back to summary

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

Implements org.apache.sshd.common.cipher.Cipher.init.

Doc from org.apache.sshd.common.cipher.Cipher.init.

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

Parameters

mode:Cipher.Mode: Encrypt/Decrypt initialization
key:byte[]: Key bytes
iv:byte[]: Initialization vector bytes

Annotations

@Override

Exceptions

Exception:: If failed to initialize

initializeIVData	back to summary
protected byte[] initializeIVData(Cipher.Mode mode, byte[] iv, int reqLen)

initializeKeyData	back to summary
protected byte[] initializeKeyData(Cipher.Mode mode, byte[] key, int reqLen)

reInit	back to summary
protected void reInit(byte[] processed, int offset, int length) throws InvalidKeyException, InvalidAlgorithmParameterException

resize	back to summary
protected static byte[] resize(byte[] data, int size)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

update	back to summary
public void update(byte[] input, int inputOffset, int inputLen) throws Exception Implements org.apache.sshd.common.cipher.Cipher.update. Doc from org.apache.sshd.common.cipher.Cipher.update. Performs in-place encryption or decryption on the given data. Parameters input:byte[] The input/output bytes inputOffset:int The offset of the data in the data buffer inputLen:int The number of bytes to update, starting at the given offset; must be a multiple of the cipher's block size Annotations @Override Exceptions Exception: If failed to execute

update

back to summary

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

Implements org.apache.sshd.common.cipher.Cipher.update.

Doc from org.apache.sshd.common.cipher.Cipher.update.

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

Parameters

input:byte[]: The input/output bytes
inputOffset:int: The offset of the data in the data buffer
inputLen:int: The number of bytes to update, starting at the given offset; must be a multiple of the cipher's block size

Annotations

@Override

Exceptions

Exception:: If failed to execute

updateAAD	back to summary
public void updateAAD(byte[] data, int offset, int length) throws Exception Implements org.apache.sshd.common.cipher.Cipher.updateAAD. Doc from org.apache.sshd.common.cipher.Cipher.updateAAD. Adds the provided input data as additional authenticated data during encryption or decryption. Parameters data:byte[] The additional data to authenticate offset:int The offset of the additional data in the buffer length:int The number of bytes in the buffer to use for authentication Annotations @Override Exceptions Exception: If failed to execute

updateAAD

back to summary

public void updateAAD(byte[] data, int offset, int length) throws Exception

Implements org.apache.sshd.common.cipher.Cipher.updateAAD.

Doc from org.apache.sshd.common.cipher.Cipher.updateAAD.

Adds the provided input data as additional authenticated data during encryption or decryption.

Parameters