Top Inners Fields Constructors Methods
org.bouncycastle.crypto.modes

public Class ChaCha20Poly1305

extends Object
implements AEADCipher
Class Inheritance
All Implemented Interfaces
org.bouncycastle.crypto.modes.AEADCipher
Imports
org.bouncycastle.crypto.CipherParameters, .DataLengthException, .InvalidCipherTextException, .Mac, .OutputLengthException, org.bouncycastle.crypto.engines.ChaCha7539Engine, org.bouncycastle.crypto.macs.Poly1305, org.bouncycastle.crypto.params.AEADParameters, .KeyParameter, .ParametersWithIV, org.bouncycastle.util.Arrays, .Pack

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
ChaCha20Poly1305.State

Field Summary

Modifier and TypeField and Description
private static final long
AAD_LIMIT

private long
aadCount

private final byte[]
buf

private static final int
BUF_SIZE

private int
bufPos

private final ChaCha7539Engine
chacha20

private static final long
DATA_LIMIT

private long
dataCount

private byte[]
initialAAD

private final byte[]
key

private static final int
KEY_SIZE

private final byte[]
mac

private static final int
MAC_SIZE

private final byte[]
nonce

private static final int
NONCE_SIZE

private final Mac
poly1305

private int
state

private static final byte[]
ZEROES

Constructor Summary

AccessConstructor and Description
public
ChaCha20Poly1305()

public
ChaCha20Poly1305(Mac poly1305)

Method Summary

Modifier and TypeMethod and Description
private void
checkAAD()

private void
checkData()

public int
doFinal(byte[]
space for any resulting output data.
out, int
offset into out to start copying the data at.
outOff)

Implements org.bouncycastle.crypto.modes.AEADCipher.doFinal.

Finish the operation either appending or verifying the MAC at the end of the data.

private void
finishAAD(int nextState)

private void
finishData(int nextState)

public String
getAlgorithmName()

Implements org.bouncycastle.crypto.modes.AEADCipher.getAlgorithmName.

Return the name of the algorithm.

public byte[]
getMac()

Implements org.bouncycastle.crypto.modes.AEADCipher.getMac.

Return the value of the MAC associated with the last stream processed.

public int
getOutputSize(int
the length of the input.
len)

Implements org.bouncycastle.crypto.modes.AEADCipher.getOutputSize.

return the size of the output buffer required for a processBytes plus a doFinal with an input of len bytes.

public int
getUpdateOutputSize(int
the length of the input.
len)

Implements org.bouncycastle.crypto.modes.AEADCipher.getUpdateOutputSize.

return the size of the output buffer required for a processBytes an input of len bytes.

private long
incrementCount(long count, int increment, long limit)

public void
init(boolean
true if we are setting up for encryption, false otherwise.
forEncryption, CipherParameters
the necessary parameters for the underlying cipher to be initialised.
params)

Implements org.bouncycastle.crypto.modes.AEADCipher.init.

initialise the underlying cipher.

private void
initMAC()

private void
padMAC(long count)

public void
processAADByte(byte
the byte to be processed.
in)

Implements org.bouncycastle.crypto.modes.AEADCipher.processAADByte.

Add a single byte to the associated data check.

public void
processAADBytes(byte[]
the input byte array.
in, int
the offset into the in array where the data to be processed starts.
inOff, int
the number of bytes to be processed.
len)

Implements org.bouncycastle.crypto.modes.AEADCipher.processAADBytes.

Add a sequence of bytes to the associated data check.

public int
processByte(byte
the byte to be processed.
in, byte[]
the output buffer the processed byte goes into.
out, int
the offset into the output byte array the processed data starts at.
outOff)

Implements org.bouncycastle.crypto.modes.AEADCipher.processByte.

encrypt/decrypt a single byte.

public int
processBytes(byte[]
the input byte array.
in, int
the offset into the in array where the data to be processed starts.
inOff, int
the number of bytes to be processed.
len, byte[]
the output buffer the processed bytes go into.
out, int
the offset into the output byte array the processed data starts at.
outOff)

Implements org.bouncycastle.crypto.modes.AEADCipher.processBytes.

process a block of bytes from in putting the result into out.

private void
processData(byte[] in, int inOff, int inLen, byte[] out, int outOff)

public void
reset()

Implements org.bouncycastle.crypto.modes.AEADCipher.reset.

Reset the cipher.

private void
reset(boolean clearMac, boolean resetCipher)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

AAD_LIMITback to summary
private static final long AAD_LIMIT
aadCountback to summary
private long aadCount
bufback to summary
private final byte[] buf
BUF_SIZEback to summary
private static final int BUF_SIZE
bufPosback to summary
private int bufPos
chacha20back to summary
private final ChaCha7539Engine chacha20
DATA_LIMITback to summary
private static final long DATA_LIMIT
dataCountback to summary
private long dataCount
initialAADback to summary
private byte[] initialAAD
keyback to summary
private final byte[] key
KEY_SIZEback to summary
private static final int KEY_SIZE
macback to summary
private final byte[] mac
MAC_SIZEback to summary
private static final int MAC_SIZE
nonceback to summary
private final byte[] nonce
NONCE_SIZEback to summary
private static final int NONCE_SIZE
poly1305back to summary
private final Mac poly1305
stateback to summary
private int state
ZEROESback to summary
private static final byte[] ZEROES

Constructor Detail

ChaCha20Poly1305back to summary
public ChaCha20Poly1305()
ChaCha20Poly1305back to summary
public ChaCha20Poly1305(Mac poly1305)

Method Detail

checkAADback to summary
private void checkAAD()
checkDataback to summary
private void checkData()
doFinalback to summary
public int doFinal(byte[] out, int outOff) throws IllegalStateException, InvalidCipherTextException

Implements org.bouncycastle.crypto.modes.AEADCipher.doFinal.

Doc from org.bouncycastle.crypto.modes.AEADCipher.doFinal.

Finish the operation either appending or verifying the MAC at the end of the data.

Parameters
out:byte[]

space for any resulting output data.

outOff:int

offset into out to start copying the data at.

Returns:int

number of bytes written into out.

Exceptions
IllegalStateException:
if the cipher is in an inappropriate state.
InvalidCipherTextException:
if the MAC fails to match.
finishAADback to summary
private void finishAAD(int nextState)
finishDataback to summary
private void finishData(int nextState)
getAlgorithmNameback to summary
public String getAlgorithmName()

Implements org.bouncycastle.crypto.modes.AEADCipher.getAlgorithmName.

Doc from org.bouncycastle.crypto.modes.AEADCipher.getAlgorithmName.

Return the name of the algorithm.

Returns:String

the algorithm name.

getMacback to summary
public byte[] getMac()

Implements org.bouncycastle.crypto.modes.AEADCipher.getMac.

Doc from org.bouncycastle.crypto.modes.AEADCipher.getMac.

Return the value of the MAC associated with the last stream processed.

Returns:byte[]

MAC for plaintext data.

getOutputSizeback to summary
public int getOutputSize(int len)

Implements org.bouncycastle.crypto.modes.AEADCipher.getOutputSize.

Doc from org.bouncycastle.crypto.modes.AEADCipher.getOutputSize.

return the size of the output buffer required for a processBytes plus a doFinal with an input of len bytes.

The returned size may be dependent on the initialisation of this cipher and may not be accurate once subsequent input data is processed - this method should be invoked immediately prior to a call to final processing of input data and a call to doFinal(byte[], int).

Parameters
len:int

the length of the input.

Returns:int

the space required to accommodate a call to processBytes and doFinal with len bytes of input.

getUpdateOutputSizeback to summary
public int getUpdateOutputSize(int len)

Implements org.bouncycastle.crypto.modes.AEADCipher.getUpdateOutputSize.

Doc from org.bouncycastle.crypto.modes.AEADCipher.getUpdateOutputSize.

return the size of the output buffer required for a processBytes an input of len bytes.

The returned size may be dependent on the initialisation of this cipher and may not be accurate once subsequent input data is processed - this method should be invoked immediately prior to input data being processed.

Parameters
len:int

the length of the input.

Returns:int

the space required to accommodate a call to processBytes with len bytes of input.

incrementCountback to summary
private long incrementCount(long count, int increment, long limit)
initback to summary
public void init(boolean forEncryption, CipherParameters params) throws IllegalArgumentException

Implements org.bouncycastle.crypto.modes.AEADCipher.init.

Doc from org.bouncycastle.crypto.modes.AEADCipher.init.

initialise the underlying cipher. Parameter can either be an AEADParameters or a ParametersWithIV object.

Parameters
forEncryption:boolean

true if we are setting up for encryption, false otherwise.

params:CipherParameters

the necessary parameters for the underlying cipher to be initialised.

Exceptions
IllegalArgumentException:
if the params argument is inappropriate.
initMACback to summary
private void initMAC()
padMACback to summary
private void padMAC(long count)
processAADByteback to summary
public void processAADByte(byte in)

Implements org.bouncycastle.crypto.modes.AEADCipher.processAADByte.

Doc from org.bouncycastle.crypto.modes.AEADCipher.processAADByte.

Add a single byte to the associated data check.
If the implementation supports it, this will be an online operation and will not retain the associated data.

Parameters
in:byte

the byte to be processed.

processAADBytesback to summary
public void processAADBytes(byte[] in, int inOff, int len)

Implements org.bouncycastle.crypto.modes.AEADCipher.processAADBytes.

Doc from org.bouncycastle.crypto.modes.AEADCipher.processAADBytes.

Add a sequence of bytes to the associated data check.
If the implementation supports it, this will be an online operation and will not retain the associated data.

Parameters
in:byte[]

the input byte array.

inOff:int

the offset into the in array where the data to be processed starts.

len:int

the number of bytes to be processed.

processByteback to summary
public int processByte(byte in, byte[] out, int outOff) throws DataLengthException

Implements org.bouncycastle.crypto.modes.AEADCipher.processByte.

Doc from org.bouncycastle.crypto.modes.AEADCipher.processByte.

encrypt/decrypt a single byte.

Parameters
in:byte

the byte to be processed.

out:byte[]

the output buffer the processed byte goes into.

outOff:int

the offset into the output byte array the processed data starts at.

Returns:int

the number of bytes written to out.

Exceptions
DataLengthException:
if the output buffer is too small.
processBytesback to summary
public int processBytes(byte[] in, int inOff, int len, byte[] out, int outOff) throws DataLengthException

Implements org.bouncycastle.crypto.modes.AEADCipher.processBytes.

Doc from org.bouncycastle.crypto.modes.AEADCipher.processBytes.

process a block of bytes from in putting the result into out.

Parameters
in:byte[]

the input byte array.

inOff:int

the offset into the in array where the data to be processed starts.

len:int

the number of bytes to be processed.

out:byte[]

the output buffer the processed bytes go into.

outOff:int

the offset into the output byte array the processed data starts at.

Returns:int

the number of bytes written to out.

Exceptions
DataLengthException:
if the output buffer is too small.
processDataback to summary
private void processData(byte[] in, int inOff, int inLen, byte[] out, int outOff)
resetback to summary
public void reset()

Implements org.bouncycastle.crypto.modes.AEADCipher.reset.

Doc from org.bouncycastle.crypto.modes.AEADCipher.reset.

Reset the cipher. After resetting the cipher is in the same state as it was after the last init (if there was one).

resetback to summary
private void reset(boolean clearMac, boolean resetCipher)
org.bouncycastle.crypto.modes back to summary

private final Class ChaCha20Poly1305.State

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv static final int
DEC_AAD

pack-priv static final int
DEC_DATA

pack-priv static final int
DEC_FINAL

pack-priv static final int
DEC_INIT

pack-priv static final int
ENC_AAD

pack-priv static final int
ENC_DATA

pack-priv static final int
ENC_FINAL

pack-priv static final int
ENC_INIT

pack-priv static final int
UNINITIALIZED

Constructor Summary

AccessConstructor and Description
private
State()

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEC_AADback to summary
pack-priv static final int DEC_AAD
DEC_DATAback to summary
pack-priv static final int DEC_DATA
DEC_FINALback to summary
pack-priv static final int DEC_FINAL
DEC_INITback to summary
pack-priv static final int DEC_INIT
ENC_AADback to summary
pack-priv static final int ENC_AAD
ENC_DATAback to summary
pack-priv static final int ENC_DATA
ENC_FINALback to summary
pack-priv static final int ENC_FINAL
ENC_INITback to summary
pack-priv static final int ENC_INIT
UNINITIALIZEDback to summary
pack-priv static final int UNINITIALIZED

Constructor Detail

Stateback to summary
private State()