Package org.bouncycastle.tls.crypto.impl

Class TlsNullCipher

java.lang.Object

org.bouncycastle.tls.crypto.impl.TlsNullCipher

All Implemented Interfaces:

TlsCipher

public class TlsNullCipher
extends java.lang.Object
implements TlsCipher

The NULL cipher.

Field Summary

Fields

Modifier and Type	Field	Description
protected TlsCryptoParameters	cryptoParams
protected TlsSuiteHMac	readMac
protected TlsSuiteHMac	writeMac

Constructor Summary

Constructors

Constructor	Description
TlsNullCipher(TlsCryptoParameters cryptoParams, TlsHMAC clientMac, TlsHMAC serverMac)

Method Summary

Modifier and Type	Method	Description
TlsDecodeResult	decodeCiphertext(long seqNo, short recordType, ProtocolVersion recordVersion, byte[] ciphertext, int offset, int len)	Decode the passed in ciphertext using the current bulk cipher.
TlsEncodeResult	encodePlaintext(long seqNo, short contentType, ProtocolVersion recordVersion, int headerAllocation, byte[] plaintext, int offset, int len)	Encode the passed in plaintext using the current bulk cipher.
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()
boolean	usesOpaqueRecordType()

Methods inherited from class java.lang.Object

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

Field Detail

cryptoParams

protected final TlsCryptoParameters cryptoParams

readMac

protected final TlsSuiteHMac readMac

writeMac

protected final TlsSuiteHMac writeMac

Constructor Detail

TlsNullCipher

public TlsNullCipher(TlsCryptoParameters cryptoParams,
                     TlsHMAC clientMac,
                     TlsHMAC serverMac)
              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 offset,
                                       int len)
                                throws java.io.IOException

Description copied from interface: TlsCipher

Encode the passed in plaintext using the current bulk cipher.

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 plaintext to the cipher.

offset - offset into input array the plaintext starts at.

len - 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 offset,
                                        int len)
                                 throws java.io.IOException

Description copied from interface: TlsCipher

Decode the passed in ciphertext using the current bulk cipher.

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 ciphertext to the cipher.

offset - offset into input array the ciphertext starts at.

len - length of the ciphertext 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