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

public Class KCCMBlockCipher

extends Object
implements AEADBlockCipher
Class Inheritance
All Implemented Interfaces
org.bouncycastle.crypto.modes.AEADBlockCipher, org.bouncycastle.crypto.modes.AEADCipher
Imports
java.io.ByteArrayOutputStream, org.bouncycastle.crypto.BlockCipher, .CipherParameters, .DataLengthException, .InvalidCipherTextException, .OutputLengthException, org.bouncycastle.crypto.params.AEADParameters, .ParametersWithIV, org.bouncycastle.util.Arrays
Implementation of DSTU7624 CCM mode

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
KCCMBlockCipher.ExposedByteArrayOutputStream

Field Summary

Modifier and TypeField and Description
private KCCMBlockCipher.ExposedByteArrayOutputStream
associatedText

private static final int
BITS_IN_BYTE

private byte[]
buffer

private static final int
BYTES_IN_INT

private byte[]
counter

private KCCMBlockCipher.ExposedByteArrayOutputStream
data

private BlockCipher
engine

private boolean
forEncryption

private byte[]
G1

private byte[]
initialAssociatedText

private byte[]
mac

private byte[]
macBlock

private int
macSize

private static final int
MAX_MAC_BIT_LENGTH

private static final int
MIN_MAC_BIT_LENGTH

private int
Nb_

private byte[]
nonce

private byte[]
s

Constructor Summary

AccessConstructor and Description
public
KCCMBlockCipher(BlockCipher
base cipher to use under CCM.
engine)

Base constructor.

public
KCCMBlockCipher(BlockCipher
base cipher to use under CCM.
engine, int
Nb value to use.
nB)

Constructor allowing Nb configuration.

Method Summary

Modifier and TypeMethod and Description
private void
CalculateMac(byte[] authText, int authOff, int len)

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.
public String
getAlgorithmName()

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

Return the name of the algorithm.
private byte
getFlag(boolean authTextPresents, int macSize)

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 BlockCipher
getUnderlyingCipher()

Implements org.bouncycastle.crypto.modes.AEADBlockCipher.getUnderlyingCipher.

return the BlockCipher this object wraps.
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.
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
intToBytes(int num, byte[] outBytes, int outOff)

private void
processAAD(byte[] assocText, int assocOff, int assocLen, int dataLen)

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.
private void
ProcessBlock(byte[] input, int inOff, int len, byte[] output, int outOff)

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.
inLen, 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.
public int
processPacket(byte[] in, int inOff, int len, byte[] out, int outOff)

public void
reset()

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

Reset the cipher.
private void
setNb(int Nb)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

associatedTextback to summary
private KCCMBlockCipher.ExposedByteArrayOutputStream associatedText
BITS_IN_BYTEback to summary
private static final int BITS_IN_BYTE
bufferback to summary
private byte[] buffer
BYTES_IN_INTback to summary
private static final int BYTES_IN_INT
counterback to summary
private byte[] counter
databack to summary
private KCCMBlockCipher.ExposedByteArrayOutputStream data
engineback to summary
private BlockCipher engine
forEncryptionback to summary
private boolean forEncryption
G1back to summary
private byte[] G1
initialAssociatedTextback to summary
private byte[] initialAssociatedText
macback to summary
private byte[] mac
macBlockback to summary
private byte[] macBlock
macSizeback to summary
private int macSize
MAX_MAC_BIT_LENGTHback to summary
private static final int MAX_MAC_BIT_LENGTH
MIN_MAC_BIT_LENGTHback to summary
private static final int MIN_MAC_BIT_LENGTH
Nb_back to summary
private int Nb_
nonceback to summary
private byte[] nonce
sback to summary
private byte[] s

Constructor Detail

KCCMBlockCipherback to summary
public KCCMBlockCipher(BlockCipher engine)

Base constructor. Nb value is set to 4.

Parameters
engine:BlockCipher

base cipher to use under CCM.

KCCMBlockCipherback to summary
public KCCMBlockCipher(BlockCipher engine, int nB)

Constructor allowing Nb configuration.

Nb is a parameter specified in CCM mode of DSTU7624 standard. This parameter specifies maximum possible length of input. It should be calculated as follows: Nb = 1/8 * (-3 + log[2]Nmax) + 1, where Nmax - length of input message in bits. For practical reasons Nmax usually less than 4Gb, e.g. for Nmax = 2^32 - 1, Nb = 4.

Parameters
engine:BlockCipher

base cipher to use under CCM.

nB:int

Nb value to use.

Method Detail

CalculateMacback to summary
private void CalculateMac(byte[] authText, int authOff, int len)
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.
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.

getFlagback to summary
private byte getFlag(boolean authTextPresents, int macSize)
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.

getUnderlyingCipherback to summary
public BlockCipher getUnderlyingCipher()

Implements org.bouncycastle.crypto.modes.AEADBlockCipher.getUnderlyingCipher.

Doc from org.bouncycastle.crypto.modes.AEADBlockCipher.getUnderlyingCipher.

return the BlockCipher this object wraps.

Returns:BlockCipher

the BlockCipher this object wraps.

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.

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.
intToBytesback to summary
private void intToBytes(int num, byte[] outBytes, int outOff)
processAADback to summary
private void processAAD(byte[] assocText, int assocOff, int assocLen, int dataLen)
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.

ProcessBlockback to summary
private void ProcessBlock(byte[] input, int inOff, int len, byte[] output, int outOff)
processByteback to summary
public int processByte(byte in, byte[] out, int outOff) throws DataLengthException, IllegalStateException

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 inLen, byte[] out, int outOff) throws DataLengthException, IllegalStateException

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.

inLen: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.
processPacketback to summary
public int processPacket(byte[] in, int inOff, int len, byte[] out, int outOff) throws IllegalStateException, InvalidCipherTextException
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).

setNbback to summary
private void setNb(int Nb)
org.bouncycastle.crypto.modes back to summary

private Class KCCMBlockCipher.ExposedByteArrayOutputStream

extends ByteArrayOutputStream
Class Inheritance

Field Summary

Inherited from java.io.ByteArrayOutputStream:
bufcount

Constructor Summary

AccessConstructor and Description
public
ExposedByteArrayOutputStream()

Method Summary

Modifier and TypeMethod and Description
public byte[]
getBuffer()

Inherited from java.io.ByteArrayOutputStream:
closeresetsizetoByteArraytoStringtoStringtoStringtoStringwritewritewriteByteswriteTo

Constructor Detail

ExposedByteArrayOutputStreamback to summary
public ExposedByteArrayOutputStream()

Method Detail

getBufferback to summary
public byte[] getBuffer()