Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.tls.crypto.TlsCipher

Method Summary

Modifier and Type	Method and Description
public TlsDecodeResult	Returns: A `TlsDecodeResult` containing the result of decoding. decodeCiphertext(long sequence number of the message represented by ciphertext. seqNo, short content type used in the record for this message. recordType, ProtocolVersion `ProtocolVersion` used for the record. recordVersion, byte[] array holding input ciphertext to the cipher. ciphertext, int offset into input array the ciphertext starts at. offset, int length of the ciphertext in the array. len) Decode the passed in ciphertext using the current bulk cipher.
public TlsEncodeResult	Returns: A `TlsEncodeResult` containing the result of encoding (after 'headerAllocation' unused bytes). encodePlaintext(long sequence number of the message represented by plaintext. seqNo, short content type of the message represented by plaintext. contentType, ProtocolVersion `ProtocolVersion` used for the record. recordVersion, int extra bytes to allocate at start of returned byte array. headerAllocation, byte[] array holding input plaintext to the cipher. plaintext, int offset into input array the plaintext starts at. offset, int length of the plaintext in the array. len) Encode the passed in plaintext using the current bulk cipher.
public int	Returns: the maximum input size of the ciphertext for plaintextLimit bytes of output. getCiphertextDecodeLimit(int the maximum output size for the plaintext. plaintextLimit) Return the maximum input size for a ciphertext given a maximum output size for the plaintext of plaintextLimit bytes.
public int	Returns: the maximum output size of the ciphertext for plaintextLimit bytes of input. getCiphertextEncodeLimit(int the maximum input size for the plaintext. plaintextLimit) Return the maximum output size for a ciphertext given a maximum input size for the plaintext of plaintextLimit bytes.
public int	Returns: the maximum output size of the plaintext for ciphertextLimit bytes of input. getPlaintextDecodeLimit(int the maximum input size for the ciphertext. ciphertextLimit) Return the maximum output size for the plaintext given a maximum input size for the ciphertext of ciphertextLimit bytes.
public int	Returns: the maximum input size of the plaintext for ciphertextLimit bytes of output. getPlaintextEncodeLimit(int the maximum output size for the ciphertext. ciphertextLimit) Return the maximum input size for the plaintext given a maximum output size for the ciphertext of ciphertextLimit bytes.
public void	rekeyDecoder()
public void	rekeyEncoder()
public boolean	usesOpaqueRecordTypeDecode()
public boolean	usesOpaqueRecordTypeEncode()

Method Detail

decodeCiphertext back to summary

decodeCiphertext	back to summary
public TlsDecodeResult decodeCiphertext(long seqNo, short recordType, ProtocolVersion recordVersion, byte[] ciphertext, int offset, int len) throws IOException Decode the passed in ciphertext using the current bulk cipher. Parameters seqNo:long sequence number of the message represented by ciphertext. recordType:short content type used in the record for this message. recordVersion:ProtocolVersion `ProtocolVersion` used for the record. ciphertext:byte[] array holding input ciphertext to the cipher. offset:int offset into input array the ciphertext starts at. len:int length of the ciphertext in the array. Returns:TlsDecodeResult A `TlsDecodeResult` containing the result of decoding.

public TlsDecodeResult decodeCiphertext(long seqNo, short recordType, ProtocolVersion recordVersion, byte[] ciphertext, int offset, int len) throws IOException

Decode the passed in ciphertext using the current bulk cipher.

Parameters

seqNo:long: sequence number of the message represented by ciphertext.
recordType:short: content type used in the record for this message.
recordVersion:ProtocolVersion: ProtocolVersion used for the record.
ciphertext:byte[]: array holding input ciphertext to the cipher.
offset:int: offset into input array the ciphertext starts at.
len:int: length of the ciphertext in the array.

Returns:TlsDecodeResult

A TlsDecodeResult containing the result of decoding.

encodePlaintext back to summary

encodePlaintext	back to summary
public TlsEncodeResult encodePlaintext(long seqNo, short contentType, ProtocolVersion recordVersion, int headerAllocation, byte[] plaintext, int offset, int len) throws IOException Encode the passed in plaintext using the current bulk cipher. Parameters seqNo:long sequence number of the message represented by plaintext. contentType:short content type of the message represented by plaintext. recordVersion:ProtocolVersion `ProtocolVersion` used for the record. headerAllocation:int extra bytes to allocate at start of returned byte array. plaintext:byte[] array holding input plaintext to the cipher. offset:int offset into input array the plaintext starts at. len:int length of the plaintext in the array. Returns:TlsEncodeResult A `TlsEncodeResult` containing the result of encoding (after 'headerAllocation' unused bytes).

public TlsEncodeResult encodePlaintext(long seqNo, short contentType, ProtocolVersion recordVersion, int headerAllocation, byte[] plaintext, int offset, int len) throws IOException

Encode the passed in plaintext using the current bulk cipher.

Parameters

seqNo:long: sequence number of the message represented by plaintext.
contentType:short: content type of the message represented by plaintext.
recordVersion:ProtocolVersion: ProtocolVersion used for the record.
headerAllocation:int: extra bytes to allocate at start of returned byte array.
plaintext:byte[]: array holding input plaintext to the cipher.
offset:int: offset into input array the plaintext starts at.
len:int: length of the plaintext in the array.

Returns:TlsEncodeResult

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

getCiphertextDecodeLimit	back to summary
public int getCiphertextDecodeLimit(int plaintextLimit) Return the maximum input size for a ciphertext given a maximum output size for the plaintext of plaintextLimit bytes. Parameters plaintextLimit:int the maximum output size for the plaintext. Returns:int the maximum input size of the ciphertext for plaintextLimit bytes of output.

getCiphertextDecodeLimit

back to summary

public int getCiphertextDecodeLimit(int plaintextLimit)

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

Parameters

plaintextLimit:int: the maximum output size for the plaintext.

Returns:int

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

getCiphertextEncodeLimit	back to summary
public int getCiphertextEncodeLimit(int plaintextLimit) Return the maximum output size for a ciphertext given a maximum input size for the plaintext of plaintextLimit bytes. Parameters plaintextLimit:int the maximum input size for the plaintext. Returns:int the maximum output size of the ciphertext for plaintextLimit bytes of input.

getCiphertextEncodeLimit

back to summary

public int getCiphertextEncodeLimit(int plaintextLimit)

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

Parameters

plaintextLimit:int: the maximum input size for the plaintext.

Returns:int

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

getPlaintextDecodeLimit	back to summary
public int getPlaintextDecodeLimit(int ciphertextLimit) Return the maximum output size for the plaintext given a maximum input size for the ciphertext of ciphertextLimit bytes. Parameters ciphertextLimit:int the maximum input size for the ciphertext. Returns:int the maximum output size of the plaintext for ciphertextLimit bytes of input.

getPlaintextDecodeLimit

back to summary

public int getPlaintextDecodeLimit(int ciphertextLimit)

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

Parameters

ciphertextLimit:int: the maximum input size for the ciphertext.

Returns:int

the maximum output size of the plaintext for ciphertextLimit bytes of input.

getPlaintextEncodeLimit	back to summary
public int getPlaintextEncodeLimit(int ciphertextLimit) Return the maximum input size for the plaintext given a maximum output size for the ciphertext of ciphertextLimit bytes. Parameters ciphertextLimit:int the maximum output size for the ciphertext. Returns:int the maximum input size of the plaintext for ciphertextLimit bytes of output.

getPlaintextEncodeLimit

back to summary

public int getPlaintextEncodeLimit(int ciphertextLimit)

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

Parameters

ciphertextLimit:int: the maximum output size for the ciphertext.

Returns:int

the maximum input size of the plaintext for ciphertextLimit bytes of output.

rekeyDecoder	back to summary
public void rekeyDecoder() throws IOException

rekeyEncoder	back to summary
public void rekeyEncoder() throws IOException

usesOpaqueRecordTypeDecode	back to summary
public boolean usesOpaqueRecordTypeDecode()

usesOpaqueRecordTypeEncode	back to summary
public boolean usesOpaqueRecordTypeEncode()

public Interface TlsCipher

Method Summary

Method Detail