Package org.apache.sshd.common.cipher

Class BaseGCMCipher

java.lang.Object

org.apache.sshd.common.cipher.BaseCipher

org.apache.sshd.common.cipher.BaseGCMCipher

All Implemented Interfaces:

AlgorithmNameProvider, Cipher, CipherInformation, KeySizeIndicator

public class BaseGCMCipher
extends BaseCipher

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BaseGCMCipher.CounterGCMParameterSpec	Algorithm parameters for AES/GCM that assumes the IV uses an 8-byte counter field as its least significant bytes.

Nested classes/interfaces inherited from interface org.apache.sshd.common.cipher.Cipher

Cipher.Mode

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	initialized
protected Cipher.Mode	mode
protected BaseGCMCipher.CounterGCMParameterSpec	parameters
protected javax.crypto.SecretKey	secretKey

Constructor Summary

Constructors

Constructor	Description
BaseGCMCipher(int ivsize, int authSize, int kdfSize, java.lang.String algorithm, int keySize, java.lang.String transformation, int blkSize)

Method Summary

Modifier and Type	Method	Description
protected javax.crypto.Cipher	createCipherInstance(Cipher.Mode mode, byte[] key, byte[] iv)
protected javax.crypto.Cipher	getInitializedCipherInstance()
void	update(byte[] input, int inputOffset, int inputLen)	Performs in-place encryption or decryption on the given data.
void	updateAAD(byte[] data, int offset, int length)	Adds the provided input data as additional authenticated data during encryption or decryption.

Methods inherited from class org.apache.sshd.common.cipher.BaseCipher

getAlgorithm, getAuthenticationTagSize, getCipherBlockSize, getCipherInstance, getIVSize, getKdfSize, getKeySize, getTransformation, init, initializeIVData, initializeKeyData, resize, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.cipher.Cipher

update, updateAAD, updateWithAAD

Field Detail

mode

protected Cipher.Mode mode

initialized

protected boolean initialized

parameters

protected BaseGCMCipher.CounterGCMParameterSpec parameters

secretKey

protected javax.crypto.SecretKey secretKey

Constructor Detail

BaseGCMCipher

public BaseGCMCipher(int ivsize,
                     int authSize,
                     int kdfSize,
                     java.lang.String algorithm,
                     int keySize,
                     java.lang.String transformation,
                     int blkSize)

Method Detail

createCipherInstance

protected javax.crypto.Cipher createCipherInstance(Cipher.Mode mode,
                                                   byte[] key,
                                                   byte[] iv)
                                            throws java.lang.Exception

Overrides:

createCipherInstance in class BaseCipher

Throws:

java.lang.Exception

getInitializedCipherInstance

protected javax.crypto.Cipher getInitializedCipherInstance()
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

updateAAD

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

Description copied from interface: Cipher

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

Specified by:

updateAAD in interface Cipher

Overrides:

updateAAD in class BaseCipher

Parameters:

data - The additional data to authenticate

offset - The offset of the additional data in the buffer

length - The number of bytes in the buffer to use for authentication

Throws:

java.lang.Exception - If failed to execute

update

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

Description copied from interface: Cipher

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

Specified by:

update in interface Cipher

Overrides:

update in class BaseCipher

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:

java.lang.Exception - If failed to execute