Class ChaCha20Cipher

java.lang.Object

org.apache.sshd.common.cipher.AbstractChaCha20Cipher

org.apache.sshd.common.cipher.ChaCha20Cipher

All Implemented Interfaces:

AlgorithmNameProvider, Cipher, CipherInformation, KeySizeIndicator

public class ChaCha20Cipher
extends AbstractChaCha20Cipher

AEAD cipher based on the OpenSSH ChaCha20-Poly1305 cipher extension.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ChaCha20Cipher.ChaChaEngine

Nested classes/interfaces inherited from interface Cipher

Cipher.Mode

Field Summary

Fields

Modifier and Type	Field	Description
protected final ChaCha20Cipher.ChaChaEngine	bodyEngine
protected final ChaCha20Cipher.ChaChaEngine	headerEngine
protected final Mac	mac
protected Cipher.Mode	mode

Fields inherited from class AbstractChaCha20Cipher

BLOCK_BYTES

Constructor Summary

Constructors

Constructor	Description
ChaCha20Cipher()

Method Summary

Modifier and Type	Method	Description
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, 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 AbstractChaCha20Cipher

getAlgorithm, getAuthenticationTagSize, getCipherBlockSize, getIVSize, getKdfSize, getKeySize, getTransformation, toString

Methods inherited from class Object

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

Methods inherited from interface Cipher

update, updateAAD, updateWithAAD

Field Details

headerEngine

protected final ChaCha20Cipher.ChaChaEngine headerEngine

bodyEngine

protected final ChaCha20Cipher.ChaChaEngine bodyEngine

mac

protected final Mac mac

mode

protected Cipher.Mode mode

Constructor Details

ChaCha20Cipher

public ChaCha20Cipher()

Method Details

init

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

Description copied from interface: Cipher

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

updateAAD

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

Description copied from interface: Cipher

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

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:

Exception - If failed to execute

update

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

Description copied from interface: Cipher

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; must be a multiple of the cipher's block size

Throws:

Exception - If failed to execute