org.bouncycastle.tls.crypto.impl

Class TlsAEADCipher

java.lang.Object

org.bouncycastle.tls.crypto.impl.TlsAEADCipher

All Implemented Interfaces:

TlsCipher

public class TlsAEADCipher
extends java.lang.Object
implements TlsCipher

A generic TLS 1.2 AEAD cipher.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AEAD_CCM
static int	AEAD_CHACHA20_POLY1305
static int	AEAD_GCM
protected TlsCryptoParameters	cryptoParams
protected TlsAEADCipherImpl	decryptCipher
protected byte[]	decryptNonce
protected TlsAEADCipherImpl	encryptCipher
protected byte[]	encryptNonce
protected int	fixed_iv_length
protected boolean	isTLSv13
protected int	keySize
protected int	macSize
protected int	nonceMode
protected int	record_iv_length

Constructor Summary

Constructors

Constructor and Description
TlsAEADCipher(TlsCryptoParameters cryptoParams, TlsAEADCipherImpl encryptCipher, TlsAEADCipherImpl decryptCipher, int keySize, int macSize, int aeadType)

Method Summary

Modifier and Type	Method and Description
TlsDecodeResult	decodeCiphertext(long seqNo, short recordType, ProtocolVersion recordVersion, byte[] ciphertext, int ciphertextOffset, int ciphertextLength) Validate and decrypt the passed in cipher text using the current cipher suite.
TlsEncodeResult	encodePlaintext(long seqNo, short contentType, ProtocolVersion recordVersion, int headerAllocation, byte[] plaintext, int plaintextOffset, int plaintextLength) Encrypt and MAC the passed in plain text using the current cipher suite.
protected byte[]	getAdditionalData(long seqNo, short recordType, ProtocolVersion recordVersion, int ciphertextLength, int plaintextLength)
int	getCiphertextDecodeLimit(int plaintextLimit) Return the maximum input size for a ciphertext given a maximum output size for the plaintext of plaintextLimit bytes.
int	getCiphertextEncodeLimit(int plaintextLength, int plaintextLimit) Return the maximum output size for a ciphertext given an actual input plaintext size of plaintextLength bytes and a maximum input plaintext size of plaintextLimit bytes.
int	getPlaintextLimit(int ciphertextLimit) Return the maximum size for the plaintext given ciphertextlimit bytes of ciphertext.
void	rekeyDecoder()
void	rekeyEncoder()
protected void	setup13Cipher(TlsAEADCipherImpl cipher, byte[] nonce, TlsSecret secret, short hash)
boolean	usesOpaqueRecordType()

Methods inherited from class java.lang.Object

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

Field Detail

AEAD_CCM

public static final int AEAD_CCM

See Also:

Constant Field Values

AEAD_CHACHA20_POLY1305

public static final int AEAD_CHACHA20_POLY1305

See Also:

Constant Field Values

AEAD_GCM

public static final int AEAD_GCM

See Also:

Constant Field Values

cryptoParams

protected final TlsCryptoParameters cryptoParams

keySize

protected final int keySize

macSize

protected final int macSize

fixed_iv_length

protected final int fixed_iv_length

record_iv_length

protected final int record_iv_length

decryptCipher

protected final TlsAEADCipherImpl decryptCipher

encryptCipher

protected final TlsAEADCipherImpl encryptCipher

decryptNonce

protected final byte[] decryptNonce

encryptNonce

protected final byte[] encryptNonce

isTLSv13

protected final boolean isTLSv13

nonceMode

protected final int nonceMode

Constructor Detail

TlsAEADCipher

public TlsAEADCipher(TlsCryptoParameters cryptoParams,
                     TlsAEADCipherImpl encryptCipher,
                     TlsAEADCipherImpl decryptCipher,
                     int keySize,
                     int macSize,
                     int aeadType)
              throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getCiphertextDecodeLimit

public int getCiphertextDecodeLimit(int plaintextLimit)

Description copied from interface: TlsCipher

Return the maximum input size for a ciphertext given a maximum output size for the plaintext of plaintextLimit bytes.

Specified by:

getCiphertextDecodeLimit in interface TlsCipher

Parameters:

plaintextLimit - the maximum output size for the plaintext.

Returns:

the maximum input size of the ciphertext for plaintextlimit bytes of output.

getCiphertextEncodeLimit

public int getCiphertextEncodeLimit(int plaintextLength,
                                    int plaintextLimit)

Description copied from interface: TlsCipher

Return the maximum output size for a ciphertext given an actual input plaintext size of plaintextLength bytes and a maximum input plaintext size of plaintextLimit bytes.

Specified by:

getCiphertextEncodeLimit in interface TlsCipher

Parameters:

plaintextLength - the actual input size for the plaintext.

plaintextLimit - the maximum input size for the plaintext.

Returns:

the maximum output size of the ciphertext for plaintextlimit bytes of input.

getPlaintextLimit

public int getPlaintextLimit(int ciphertextLimit)

Description copied from interface: TlsCipher

Return the maximum size for the plaintext given ciphertextlimit bytes of ciphertext.

Specified by:

getPlaintextLimit in interface TlsCipher

Parameters:

ciphertextLimit - the maximum number of bytes of ciphertext.

Returns:

the maximum size of the plaintext for ciphertextlimit bytes of input.

encodePlaintext

public TlsEncodeResult encodePlaintext(long seqNo,
                                       short contentType,
                                       ProtocolVersion recordVersion,
                                       int headerAllocation,
                                       byte[] plaintext,
                                       int plaintextOffset,
                                       int plaintextLength)
                                throws java.io.IOException

Description copied from interface: TlsCipher

Encrypt and MAC the passed in plain text using the current cipher suite.

Specified by:

encodePlaintext in interface TlsCipher

Parameters:

seqNo - sequence number of the message represented by plaintext.

contentType - content type of the message represented by plaintext.

recordVersion - ProtocolVersion used for the record.

headerAllocation - extra bytes to allocate at start of returned byte array.

plaintext - array holding input plain text to the cipher.

plaintextOffset - offset into input array the plain text starts at.

plaintextLength - length of the plaintext in the array.

Returns:

A TlsEncodeResult containing the result of encoding (after 'headerAllocation' unused bytes).

Throws:

java.io.IOException

decodeCiphertext

public TlsDecodeResult decodeCiphertext(long seqNo,
                                        short recordType,
                                        ProtocolVersion recordVersion,
                                        byte[] ciphertext,
                                        int ciphertextOffset,
                                        int ciphertextLength)
                                 throws java.io.IOException

Description copied from interface: TlsCipher

Validate and decrypt the passed in cipher text using the current cipher suite.

Specified by:

decodeCiphertext in interface TlsCipher

Parameters:

seqNo - sequence number of the message represented by ciphertext.

recordType - content type used in the record for this message.

recordVersion - ProtocolVersion used for the record.

ciphertext - array holding input cipher text to the cipher.

ciphertextOffset - offset into input array the cipher text starts at.

ciphertextLength - length of the cipher text in the array.

Returns:

A TlsDecodeResult containing the result of decoding.

Throws:

java.io.IOException

rekeyDecoder

public void rekeyDecoder()
                  throws java.io.IOException

Specified by:

rekeyDecoder in interface TlsCipher

Throws:

java.io.IOException

rekeyEncoder

public void rekeyEncoder()
                  throws java.io.IOException

Specified by:

rekeyEncoder in interface TlsCipher

Throws:

java.io.IOException

usesOpaqueRecordType

public boolean usesOpaqueRecordType()

Specified by:

usesOpaqueRecordType in interface TlsCipher

getAdditionalData

protected byte[] getAdditionalData(long seqNo,
                                   short recordType,
                                   ProtocolVersion recordVersion,
                                   int ciphertextLength,
                                   int plaintextLength)
                            throws java.io.IOException

Throws:

java.io.IOException

setup13Cipher

protected void setup13Cipher(TlsAEADCipherImpl cipher,
                             byte[] nonce,
                             TlsSecret secret,
                             short hash)
                      throws java.io.IOException

Throws:

java.io.IOException