Package org.spongycastle.tls

Class TlsClientProtocol

java.lang.Object

org.spongycastle.tls.TlsProtocol

org.spongycastle.tls.TlsClientProtocol

All Implemented Interfaces:

TlsCloseable

public class TlsClientProtocol
extends TlsProtocol

Field Summary

Fields

Modifier and Type	Field	Description
protected TlsAuthentication	authentication
protected CertificateRequest	certificateRequest
protected CertificateStatus	certificateStatus
protected Hashtable	clientAgreements
protected ClientHello	clientHello
protected TlsKeyExchange	keyExchange
protected TlsClient	tlsClient

Fields inherited from class org.spongycastle.tls.TlsProtocol

ADS_MODE_0_N, ADS_MODE_0_N_FIRSTONLY, ADS_MODE_1_Nsub1, blocking, clientExtensions, connection_state, CS_CLIENT_CERTIFICATE, CS_CLIENT_CERTIFICATE_VERIFY, CS_CLIENT_END_OF_EARLY_DATA, CS_CLIENT_FINISHED, CS_CLIENT_HELLO, CS_CLIENT_HELLO_RETRY, CS_CLIENT_KEY_EXCHANGE, CS_CLIENT_SUPPLEMENTAL_DATA, CS_END, CS_SERVER_CERTIFICATE, CS_SERVER_CERTIFICATE_REQUEST, CS_SERVER_CERTIFICATE_STATUS, CS_SERVER_CERTIFICATE_VERIFY, CS_SERVER_ENCRYPTED_EXTENSIONS, CS_SERVER_FINISHED, CS_SERVER_HELLO, CS_SERVER_HELLO_DONE, CS_SERVER_HELLO_RETRY_REQUEST, CS_SERVER_KEY_EXCHANGE, CS_SERVER_SESSION_TICKET, CS_SERVER_SUPPLEMENTAL_DATA, CS_START, expectSessionTicket, EXT_RenegotiationInfo, EXT_SessionTicket, inputBuffers, outputBuffer, receivedChangeCipherSpec, retryCookie, retryGroup, selectedPSK13, serverExtensions, sessionMasterSecret, sessionParameters, tlsSession

Constructor Summary

Constructors

Constructor	Description
TlsClientProtocol()	Constructor for non-blocking mode. When data is received, use TlsProtocol.offerInput(byte[]) to provide the received ciphertext, then use TlsProtocol.readInput(byte[], int, int) to read the corresponding cleartext. Similarly, when data needs to be sent, use TlsProtocol.writeApplicationData(byte[], int, int) to provide the cleartext, then use TlsProtocol.readOutput(byte[], int, int) to get the corresponding ciphertext.
TlsClientProtocol(InputStream input, OutputStream output)	Constructor for blocking mode.

Method Summary

Modifier and Type	Method	Description
protected void	beginHandshake(boolean renegotiation)
protected void	cleanupHandshake()
void	connect(TlsClient tlsClient)	Initiates a TLS handshake in the role of client. In blocking mode, this will not return until the handshake is complete.
protected TlsContext	getContext()
protected TlsPeer	getPeer()
protected void	handle13HandshakeMessage(short type, HandshakeMessageInput buf)
protected void	handleHandshakeMessage(short type, HandshakeMessageInput buf)
protected void	handleServerCertificate()
protected void	handleSupplementalData(Vector serverSupplementalData)
protected void	process13HelloRetryRequest(ServerHello helloRetryRequest)
protected void	process13ServerHello(ServerHello serverHello, boolean afterHelloRetryRequest)
protected void	process13ServerHelloCoda(ServerHello serverHello, boolean afterHelloRetryRequest)
protected void	processServerHello(ServerHello serverHello)
protected void	receive13CertificateRequest(ByteArrayInputStream buf, boolean postHandshakeAuth)
protected void	receive13EncryptedExtensions(ByteArrayInputStream buf)
protected void	receive13NewSessionTicket(ByteArrayInputStream buf)
protected void	receive13ServerCertificate(ByteArrayInputStream buf)
protected void	receive13ServerCertificateVerify(ByteArrayInputStream buf)
protected void	receive13ServerFinished(ByteArrayInputStream buf)
protected void	receiveCertificateRequest(ByteArrayInputStream buf)
protected void	receiveNewSessionTicket(ByteArrayInputStream buf)
protected ServerHello	receiveServerHelloMessage(ByteArrayInputStream buf)
protected void	send13ClientHelloRetry()
protected void	sendCertificateVerifyMessage(DigitallySigned certificateVerify)
protected void	sendClientHello()
protected void	sendClientHelloMessage()
protected void	sendClientKeyExchange()
protected void	skip13CertificateRequest()
protected void	skip13ServerCertificate()

Methods inherited from class org.spongycastle.tls.TlsProtocol

applicationDataAvailable, applyMaxFragmentLengthExtension, assertEmpty, blockForHandshake, cancelSession, checkReceivedChangeCipherSpec, close, closeConnection, closeInput, completeHandshake, createRandomBlock, createRenegotiationInfo, establishMasterSecret, establishSession, flush, getAppDataSplitMode, getApplicationDataLimit, getAvailableInputBytes, getAvailableOutputBytes, getInputStream, getOutputStream, getRenegotiationPolicy, handleAlertMessage, handleAlertWarningMessage, handleChangeCipherSpecMessage, handleClose, handleException, handleFailure, handleRenegotiation, invalidateSession, isClosed, isConnected, isHandshaking, isLegacyConnectionState, isResumableHandshake, isTLSv13ConnectionState, offerInput, offerInput, previewInputRecord, previewOutputRecord, previewOutputRecord, process13FinishedMessage, processFinishedMessage, processMaxFragmentLengthExtension, processRecord, raiseAlertFatal, raiseAlertWarning, readApplicationData, readExtensions, readExtensionsData, readExtensionsData13, readExtensionsDataClientHello, readInput, readInput, readOutput, readOutput, readSupplementalDataMessage, receive13KeyUpdate, refuseRenegotiation, resumeHandshake, safePreviewRecordHeader, safeReadFullRecord, safeReadRecord, safeWriteRecord, send13CertificateMessage, send13CertificateVerifyMessage, send13FinishedMessage, send13KeyUpdate, sendCertificateMessage, sendChangeCipherSpec, sendChangeCipherSpecMessage, sendFinishedMessage, sendSupplementalDataMessage, setAppDataSplitMode, setResumableHandshake, writeApplicationData, writeExtensions, writeExtensions, writeExtensionsData, writeExtensionsData, writeExtensionsData, writePreSharedKeyExtension, writeSelectedExtensions, writeSupplementalData

Methods inherited from class java.lang.Object

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

Field Details

tlsClient

protected TlsClient tlsClient

clientAgreements

protected Hashtable clientAgreements

clientHello

protected ClientHello clientHello

keyExchange

protected TlsKeyExchange keyExchange

authentication

protected TlsAuthentication authentication

certificateStatus

protected CertificateStatus certificateStatus

certificateRequest

protected CertificateRequest certificateRequest

Constructor Details

TlsClientProtocol

public TlsClientProtocol()

Constructor for non-blocking mode.

When data is received, use TlsProtocol.offerInput(byte[]) to provide the received ciphertext, then use TlsProtocol.readInput(byte[], int, int) to read the corresponding cleartext.

Similarly, when data needs to be sent, use TlsProtocol.writeApplicationData(byte[], int, int) to provide the cleartext, then use TlsProtocol.readOutput(byte[], int, int) to get the corresponding ciphertext.

TlsClientProtocol

public TlsClientProtocol(InputStream input,
 OutputStream output)

Constructor for blocking mode.

Parameters:

input - The stream of data from the server

output - The stream of data to the server

Method Details

connect

public void connect(TlsClient tlsClient)
             throws IOException

Initiates a TLS handshake in the role of client.

In blocking mode, this will not return until the handshake is complete. In non-blocking mode, use TlsPeer.notifyHandshakeComplete() to receive a callback when the handshake is complete.

Parameters:

tlsClient - The TlsClient to use for the handshake.

Throws:

IOException - If in blocking mode and handshake was not successful.

beginHandshake

protected void beginHandshake(boolean renegotiation)
                       throws IOException

Overrides:

beginHandshake in class TlsProtocol

Throws:

IOException

cleanupHandshake

protected void cleanupHandshake()

Overrides:

cleanupHandshake in class TlsProtocol

getContext

protected TlsContext getContext()

Specified by:

getContext in class TlsProtocol

getPeer

protected TlsPeer getPeer()

Specified by:

getPeer in class TlsProtocol

handle13HandshakeMessage

protected void handle13HandshakeMessage(short type,
 HandshakeMessageInput buf)
                                 throws IOException

Throws:

IOException

handleHandshakeMessage

protected void handleHandshakeMessage(short type,
 HandshakeMessageInput buf)
                               throws IOException

Specified by:

handleHandshakeMessage in class TlsProtocol

Throws:

IOException

handleServerCertificate

protected void handleServerCertificate()
                                throws IOException

Throws:

IOException

handleSupplementalData

protected void handleSupplementalData(Vector serverSupplementalData)
                               throws IOException

Throws:

IOException

process13HelloRetryRequest

protected void process13HelloRetryRequest(ServerHello helloRetryRequest)
                                   throws IOException

Throws:

IOException

process13ServerHello

protected void process13ServerHello(ServerHello serverHello,
 boolean afterHelloRetryRequest)
                             throws IOException

Throws:

IOException

process13ServerHelloCoda

protected void process13ServerHelloCoda(ServerHello serverHello,
 boolean afterHelloRetryRequest)
                                 throws IOException

Throws:

IOException

processServerHello

protected void processServerHello(ServerHello serverHello)
                           throws IOException

Throws:

IOException

receive13CertificateRequest

protected void receive13CertificateRequest(ByteArrayInputStream buf,
 boolean postHandshakeAuth)
                                    throws IOException

Throws:

IOException

receive13EncryptedExtensions

protected void receive13EncryptedExtensions(ByteArrayInputStream buf)
                                     throws IOException

Throws:

IOException

receive13NewSessionTicket

protected void receive13NewSessionTicket(ByteArrayInputStream buf)
                                  throws IOException

Throws:

IOException

receive13ServerCertificate

protected void receive13ServerCertificate(ByteArrayInputStream buf)
                                   throws IOException

Throws:

IOException

receive13ServerCertificateVerify

protected void receive13ServerCertificateVerify(ByteArrayInputStream buf)
                                         throws IOException

Throws:

IOException

receive13ServerFinished

protected void receive13ServerFinished(ByteArrayInputStream buf)
                                throws IOException

Throws:

IOException

receiveCertificateRequest

protected void receiveCertificateRequest(ByteArrayInputStream buf)
                                  throws IOException

Throws:

IOException

receiveNewSessionTicket

protected void receiveNewSessionTicket(ByteArrayInputStream buf)
                                throws IOException

Throws:

IOException

receiveServerHelloMessage

protected ServerHello receiveServerHelloMessage(ByteArrayInputStream buf)
                                         throws IOException

Throws:

IOException

send13ClientHelloRetry

protected void send13ClientHelloRetry()
                               throws IOException

Throws:

IOException

sendCertificateVerifyMessage

protected void sendCertificateVerifyMessage(DigitallySigned certificateVerify)
                                     throws IOException

Throws:

IOException

sendClientHello

protected void sendClientHello()
                        throws IOException

Throws:

IOException

sendClientHelloMessage

protected void sendClientHelloMessage()
                               throws IOException

Throws:

IOException

sendClientKeyExchange

protected void sendClientKeyExchange()
                              throws IOException

Throws:

IOException

skip13CertificateRequest

protected void skip13CertificateRequest()
                                 throws IOException

Throws:

IOException

skip13ServerCertificate

protected void skip13ServerCertificate()
                                throws IOException

Throws:

IOException