org.bouncycastle.crypto.tls

Interface TlsPeer

All Known Subinterfaces:

TlsClient, TlsServer

All Known Implementing Classes:

AbstractTlsClient, AbstractTlsPeer, AbstractTlsServer, DefaultTlsClient, DefaultTlsServer, PSKTlsClient, PSKTlsServer, SRPTlsClient, SRPTlsServer

public interface TlsPeer

Method Summary

Modifier and Type	Method and Description
TlsCipher	getCipher()
TlsCompression	getCompression()
void	notifyAlertRaised(short alertLevel, short alertDescription, String message, Throwable cause) This method will be called when an alert is raised by the protocol.
void	notifyAlertReceived(short alertLevel, short alertDescription) This method will be called when an alert is received from the remote peer.
void	notifyHandshakeComplete() Notifies the peer that the handshake has been successfully completed.
void	notifySecureRenegotiation(boolean secureNegotiation)
boolean	requiresExtendedMasterSecret() This implementation supports RFC 7627 and will always negotiate the extended_master_secret extension where possible.
boolean	shouldUseGMTUnixTime() draft-mathewson-no-gmtunixtime-00 2.

Method Detail

requiresExtendedMasterSecret

boolean requiresExtendedMasterSecret()

This implementation supports RFC 7627 and will always negotiate the extended_master_secret extension where possible. When connecting to a peer that does not offer/accept this extension, it is recommended to abort the handshake. This option is provided for interoperability with legacy peers, although some TLS features will be disabled in that case (see RFC 7627 5.4).

Returns:

true if the handshake should be aborted when the peer does not negotiate the extended_master_secret extension, or false to support legacy interoperability.

shouldUseGMTUnixTime

boolean shouldUseGMTUnixTime()

draft-mathewson-no-gmtunixtime-00 2. "If existing users of a TLS implementation may rely on gmt_unix_time containing the current time, we recommend that implementors MAY provide the ability to set gmt_unix_time as an option only, off by default."

Returns:

true if the current time should be used in the gmt_unix_time field of Random, or false if gmt_unix_time should contain a cryptographically random value.

notifySecureRenegotiation

void notifySecureRenegotiation(boolean secureNegotiation)
                        throws IOException

Throws:

IOException

getCompression

TlsCompression getCompression()
                       throws IOException

Throws:

IOException

getCipher

TlsCipher getCipher()
             throws IOException

Throws:

IOException

notifyAlertRaised

void notifyAlertRaised(short alertLevel,
                       short alertDescription,
                       String message,
                       Throwable cause)

This method will be called when an alert is raised by the protocol.

Parameters:

alertLevel - AlertLevel

alertDescription - AlertDescription

message - A human-readable message explaining what caused this alert. May be null.

cause - The Throwable that caused this alert to be raised. May be null.

notifyAlertReceived

void notifyAlertReceived(short alertLevel,
                         short alertDescription)

This method will be called when an alert is received from the remote peer.

Parameters:

alertLevel - AlertLevel

alertDescription - AlertDescription

notifyHandshakeComplete

void notifyHandshakeComplete()
                      throws IOException

Notifies the peer that the handshake has been successfully completed.

Throws:

IOException