Bouncy Castle TLS/JSSE APIs (FIPS Distribution) 1.0.19 · org.bouncycastle.tls.TlsProtocol

Field Summary

Modifier and Type	Field and Description
protected static final short	ADS_MODE_0_N
protected static final short	ADS_MODE_0_N_FIRSTONLY
protected static final short	ADS_MODE_1_Nsub1
private ByteQueue	alertQueue
private volatile boolean	appDataReady
private volatile boolean	appDataSplitEnabled
private volatile int	appDataSplitMode
private ByteQueue	applicationDataQueue
protected boolean	blocking
protected Hashtable<K, V>	clientExtensions
private volatile boolean	closed
protected short	connection_state
protected static final short	CS_CLIENT_CERTIFICATE
protected static final short	CS_CLIENT_CERTIFICATE_VERIFY
protected static final short	CS_CLIENT_END_OF_EARLY_DATA
protected static final short	CS_CLIENT_FINISHED
protected static final short	CS_CLIENT_HELLO
protected static final short	CS_CLIENT_HELLO_RETRY
protected static final short	CS_CLIENT_KEY_EXCHANGE
protected static final short	CS_CLIENT_SUPPLEMENTAL_DATA
protected static final short	CS_END
protected static final short	CS_SERVER_CERTIFICATE
protected static final short	CS_SERVER_CERTIFICATE_REQUEST
protected static final short	CS_SERVER_CERTIFICATE_STATUS
protected static final short	CS_SERVER_CERTIFICATE_VERIFY
protected static final short	CS_SERVER_ENCRYPTED_EXTENSIONS
protected static final short	CS_SERVER_FINISHED
protected static final short	CS_SERVER_HELLO
protected static final short	CS_SERVER_HELLO_DONE
protected static final short	CS_SERVER_HELLO_RETRY_REQUEST
protected static final short	CS_SERVER_KEY_EXCHANGE
protected static final short	CS_SERVER_SESSION_TICKET
protected static final short	CS_SERVER_SUPPLEMENTAL_DATA
protected static final short	CS_START
protected boolean	expectSessionTicket
protected static final Integer	EXT_RenegotiationInfo
protected static final Integer	EXT_SessionTicket
private volatile boolean	failedWithError
pack-priv TlsHandshakeHash	handshakeHash
private ByteQueue	handshakeQueue
protected ByteQueueInputStream	inputBuffers
private volatile boolean	keyUpdateEnabled
private volatile boolean	keyUpdatePendingSend
private int	maxHandshakeMessageSize
protected ByteQueueOutputStream	outputBuffer
protected boolean	receivedChangeCipherSpec
pack-priv final RecordStream	recordStream
pack-priv final Object	recordWriteLock
private volatile boolean	resumableHandshake
protected byte[]	retryCookie
protected int	retryGroup
protected boolean	selectedPSK13
protected Hashtable<K, V>	serverExtensions
protected TlsSecret	sessionMasterSecret
protected SessionParameters	sessionParameters
private TlsInputStream	tlsInputStream
private TlsOutputStream	tlsOutputStream
protected TlsSession	tlsSession

Access	Constructor and Description
protected	TlsProtocol()
protected	TlsProtocol(InputStream input, OutputStream output)

Method Summary

Modifier and Type	Method and Description
public int	applicationDataAvailable()
protected void	applyMaxFragmentLengthExtension(short maxFragmentLength)
protected static void	assertEmpty(ByteArrayInputStream The InputStream to check. buf) Make sure the InputStream 'buf' now empty.
protected void	beginHandshake(boolean renegotiation)
protected void	blockForHandshake()
protected void	cancelSession()
protected void	checkReceivedChangeCipherSpec(boolean expected)
protected void	cleanupHandshake()
public void	close() Implements org.bouncycastle.tls.TlsCloseable.close. Closes this connection.
protected void	closeConnection()
public void	closeInput() Should be called in non-blocking mode when the input data reaches EOF.
protected void	completeHandshake()
protected static byte[]	createRandomBlock(boolean useGMTUnixTime, TlsContext context)
protected static byte[]	createRenegotiationInfo(byte[] renegotiated_connection)
protected static void	establishMasterSecret(TlsContext context, TlsKeyExchange keyExchange)
protected boolean	establishSession(TlsSession sessionToResume)
public void	flush()
public int	getAppDataSplitMode()
public int	getApplicationDataLimit()
public int	Returns: The number of bytes of available application data getAvailableInputBytes() Gets the amount of received application data.
public int	Returns: The number of bytes of available encrypted data getAvailableOutputBytes() Gets the amount of encrypted data available to be sent.
protected abstract TlsContext	getContext()
pack-priv abstract AbstractTlsContext	getContextAdmin()
public InputStream	Returns: An InputStream which can be used to read data. Only allowed in blocking mode. getInputStream()
public OutputStream	Returns: An OutputStream which can be used to send data. Only allowed in blocking mode. getOutputStream()
protected abstract TlsPeer	getPeer()
protected int	getRenegotiationPolicy()
protected void	handleAlertMessage(short alertLevel, short alertDescription)
protected void	handleAlertWarningMessage(short alertDescription)
protected void	handleChangeCipherSpecMessage()
protected void	handleClose(boolean user_canceled)
protected void	handleException(short alertDescription, String message, Throwable e)
protected void	handleFailure()
protected abstract void	handleHandshakeMessage(short type, HandshakeMessageInput buf)
protected boolean	handleRenegotiation()
protected void	invalidateSession()
pack-priv boolean	isApplicationDataReady()
public boolean	isClosed()
public boolean	isConnected()
public boolean	isHandshaking()
protected boolean	isLegacyConnectionState()
public boolean	isResumableHandshake()
protected boolean	isTLSv13ConnectionState()
public void	offerInput(byte[] The input buffer to offer input) Equivalent to `offerInput(input, 0, input.length)`
public void	offerInput(byte[] The input buffer to offer input, int The offset within the input buffer that input begins inputOff, int The number of bytes of input being offered inputLen) Offer input from an arbitrary source.
public RecordPreview	previewInputRecord(byte[] recordHeader)
public int	previewOutputRecord()
public RecordPreview	previewOutputRecord(int applicationDataSize)
protected void	process13FinishedMessage(ByteArrayInputStream buf)
private void	processAlertQueue()
private void	processApplicationDataQueue()
private void	processChangeCipherSpec(byte[] buf, int off, int len) This method is called, when a change cipher spec message is received.
protected void	processFinishedMessage(ByteArrayInputStream buf)
private void	processHandshakeQueue(ByteQueue queue)
protected short	processMaxFragmentLengthExtension(Hashtable<K, V> clientExtensions, Hashtable<K, V> serverExtensions, short alertDescription) Deprecated Will be removed.
protected void	processRecord(short protocol, byte[] buf, int off, int len)
protected void	raiseAlertFatal(short alertDescription, String message, Throwable cause)
protected void	raiseAlertWarning(short alertDescription, String message)
public int	Returns: The number of bytes read. readApplicationData(byte[] The buffer where the data will be copied to. buf, int The position where the data will be placed in the buffer. off, int The maximum number of bytes to read. len) Read data from the network.
protected static Hashtable<K, V>	readExtensions(ByteArrayInputStream input)
protected static Hashtable<K, V>	readExtensionsData(byte[] extBytes)
protected static Hashtable<K, V>	readExtensionsData13(int handshakeType, byte[] extBytes)
protected static Hashtable<K, V>	readExtensionsDataClientHello(byte[] extBytes)
public int	Returns: The total number of bytes copied to the buffer. May be less than the length specified if the length was greater than the amount of available data. readInput(byte[] The buffer to hold the application data buffer, int The start offset in the buffer at which the data is written offset, int The maximum number of bytes to read length) Retrieves received application data.
public int	Returns: The total number of bytes copied to the buffer. May be less than the length specified if the length was greater than the amount of available data. readInput(ByteBuffer The `ByteBuffer` to hold the application data buffer, int The maximum number of bytes to read length) Retrieves received application data into a `ByteBuffer`.
public int	Returns: The total number of bytes copied to the buffer. May be less than the length specified if the length was greater than the amount of available data. readOutput(byte[] The buffer to hold the encrypted data buffer, int The start offset in the buffer at which the data is written offset, int The maximum number of bytes to read length) Retrieves encrypted data to be sent.
public int	Returns: The total number of bytes copied to the buffer. May be less than the length specified if the length was greater than the amount of available data. readOutput(ByteBuffer The `ByteBuffer` to hold the encrypted data buffer, int The maximum number of bytes to read length) Retrieves encrypted data to be sent.
protected static Vector<E>	readSupplementalDataMessage(ByteArrayInputStream input)
protected void	receive13KeyUpdate(ByteArrayInputStream buf)
protected void	refuseRenegotiation()
public void	resumeHandshake()
protected RecordPreview	safePreviewRecordHeader(byte[] recordHeader)
protected boolean	safeReadFullRecord(byte[] input, int inputOff, int inputLen)
protected void	safeReadRecord()
protected void	safeWriteRecord(short type, byte[] buf, int offset, int len)
protected void	send13CertificateMessage(Certificate certificate)
protected void	send13CertificateVerifyMessage(DigitallySigned certificateVerify)
protected void	send13FinishedMessage()
protected void	send13KeyUpdate(boolean updateRequested)
protected void	sendCertificateMessage(Certificate certificate, OutputStream endPointHash)
protected void	sendChangeCipherSpec()
protected void	sendChangeCipherSpecMessage()
protected void	sendFinishedMessage()
protected void	sendSupplementalDataMessage(Vector<E> supplementalData)
public void	setAppDataSplitMode(int appDataSplitMode)
public void	setResumableHandshake(boolean resumableHandshake)
public void	writeApplicationData(byte[] The buffer containing application data to send buf, int The offset at which the application data begins off, int The number of bytes of application data len) Write some application data.
protected static void	writeExtensions(OutputStream output, Hashtable<K, V> extensions)
protected static void	writeExtensions(OutputStream output, Hashtable<K, V> extensions, int bindersSize)
protected static byte[]	writeExtensionsData(Hashtable<K, V> extensions)
protected static byte[]	writeExtensionsData(Hashtable<K, V> extensions, int bindersSize)
protected static void	writeExtensionsData(Hashtable<K, V> extensions, int bindersSize, ByteArrayOutputStream buf)
pack-priv void	writeHandshakeMessage(byte[] buf, int off, int len)
protected static void	writePreSharedKeyExtension(OutputStream output, Hashtable<K, V> extensions, int bindersSize)
protected static void	writeSelectedExtensions(OutputStream output, Hashtable<K, V> extensions, boolean selectEmpty)
protected static void	writeSupplementalData(OutputStream output, Vector<E> supplementalData)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public abstract Class TlsProtocol

Field Summary

Constructor Summary

Method Summary