Package org.bouncycastle.tls

Interface TlsServer

All Superinterfaces:

TlsPeer

All Known Implementing Classes:

AbstractTlsServer, DefaultTlsServer, PSKTlsServer, SRPTlsServer

public interface TlsServer
extends TlsPeer

Interface describing a TLS server endpoint.

Method Summary

Modifier and Type	Method	Description
CertificateRequest	getCertificateRequest()
CertificateStatus	getCertificateStatus()	This method will be called (only) if the server included an extension of type "status_request" with empty "extension_data" in the extended server hello.
TlsCredentials	getCredentials()	Return server credentials to use.
TlsDHConfig	getDHConfig()
TlsECConfig	getECDHConfig()
TlsPSKExternal	getExternalPSK(Vector identities)	WARNING: EXPERIMENTAL FEATURE, UNSTABLE API Return the external PSK to select from the ClientHello.
byte[]	getNewSessionID()
NewSessionTicket	getNewSessionTicket()	RFC 5077 3.3.
TlsPSKIdentityManager	getPSKIdentityManager()
int	getSelectedCipherSuite()
Hashtable	getServerExtensions()
void	getServerExtensionsForConnection(Hashtable serverExtensions)
Vector	getServerSupplementalData()
ProtocolVersion	getServerVersion()
TlsSession	getSessionToResume(byte[] sessionID)	Return the specified session, if available.
TlsSRPLoginParameters	getSRPLoginParameters()
int[]	getSupportedGroups()
void	init(TlsServerContext context)
void	notifyClientCertificate(Certificate clientCertificate)	Called by the protocol handler to report the client certificate, only if getCertificateRequest() returned non-null.
void	notifyClientVersion(ProtocolVersion clientVersion)
void	notifyFallback(boolean isFallback)
void	notifyOfferedCipherSuites(int[] offeredCipherSuites)
void	notifySession(TlsSession session)
void	processClientExtensions(Hashtable clientExtensions)
void	processClientSupplementalData(Vector clientSupplementalData)

Methods inherited from interface org.bouncycastle.tls.TlsPeer

allowLegacyResumption, cancel, getCipherSuites, getCrypto, getHandshakeResendTimeMillis, getHandshakeTimeoutMillis, getHeartbeat, getHeartbeatPolicy, getKeyExchangeFactory, getMaxCertificateChainLength, getMaxHandshakeMessageSize, getProtocolVersions, getPskKeyExchangeModes, getRenegotiationPolicy, notifyAlertRaised, notifyAlertReceived, notifyCloseHandle, notifyConnectionClosed, notifyHandshakeBeginning, notifyHandshakeComplete, notifySecureRenegotiation, requiresCloseNotify, requiresExtendedMasterSecret, shouldCheckSigAlgOfPeerCerts, shouldUseExtendedMasterSecret, shouldUseExtendedPadding, shouldUseGMTUnixTime

Method Details

init

void init(TlsServerContext context)

getSessionToResume

TlsSession getSessionToResume(byte[] sessionID)

Return the specified session, if available. Note that the peer's certificate chain for the session (if any) may need to be periodically revalidated.

Parameters:

sessionID - the ID of the session to resume.

Returns:

A TlsSession with the specified session ID, or null.

See Also:

• SessionParameters.getPeerCertificate()

getNewSessionID

byte[] getNewSessionID()

getExternalPSK

TlsPSKExternal getExternalPSK(Vector identities)

WARNING: EXPERIMENTAL FEATURE, UNSTABLE API Return the external PSK to select from the ClientHello. Note that this will only be called when TLS 1.3 or higher is amongst the offered protocol versions, and one or more PSKs are actually offered.

Parameters:

identities - a Vector of PskIdentity instances.

Returns:

the TlsPSKExternal corresponding to the selected identity, or null to not select any.

notifySession

void notifySession(TlsSession session)

notifyClientVersion

void notifyClientVersion(ProtocolVersion clientVersion)
                  throws IOException

Throws:

IOException

notifyFallback

void notifyFallback(boolean isFallback)
             throws IOException

Throws:

IOException

notifyOfferedCipherSuites

void notifyOfferedCipherSuites(int[] offeredCipherSuites)
                        throws IOException

Throws:

IOException

processClientExtensions

void processClientExtensions(Hashtable clientExtensions)
                      throws IOException

Throws:

IOException

getServerVersion

ProtocolVersion getServerVersion()
                          throws IOException

Throws:

IOException

getSupportedGroups

int[] getSupportedGroups()
                  throws IOException

Throws:

IOException

getSelectedCipherSuite

int getSelectedCipherSuite()
                    throws IOException

Throws:

IOException

getServerExtensions

Hashtable getServerExtensions()
                       throws IOException

Throws:

IOException

getServerExtensionsForConnection

void getServerExtensionsForConnection(Hashtable serverExtensions)
                               throws IOException

Throws:

IOException

getServerSupplementalData

Vector getServerSupplementalData()
                          throws IOException

Throws:

IOException

getCredentials

TlsCredentials getCredentials()
                       throws IOException

Return server credentials to use. The returned value may be null, or else it MUST implement exactly one of TlsCredentialedAgreement, TlsCredentialedDecryptor, or TlsCredentialedSigner, depending on the key exchange that was negotiated.

Returns:

a TlsCredentials object or null for anonymous key exchanges

Throws:

IOException

getCertificateStatus

CertificateStatus getCertificateStatus()
                                throws IOException

This method will be called (only) if the server included an extension of type "status_request" with empty "extension_data" in the extended server hello. See RFC 3546 3.6. Certificate Status Request. If a non-null CertificateStatus is returned, it is sent to the client as a handshake message of type "certificate_status".

Returns:

A CertificateStatus to be sent to the client (or null for none).

Throws:

IOException

getCertificateRequest

CertificateRequest getCertificateRequest()
                                  throws IOException

Throws:

IOException

getPSKIdentityManager

TlsPSKIdentityManager getPSKIdentityManager()
                                     throws IOException

Throws:

IOException

getSRPLoginParameters

TlsSRPLoginParameters getSRPLoginParameters()
                                     throws IOException

Throws:

IOException

getDHConfig

TlsDHConfig getDHConfig()
                 throws IOException

Throws:

IOException

getECDHConfig

TlsECConfig getECDHConfig()
                   throws IOException

Throws:

IOException

processClientSupplementalData

void processClientSupplementalData(Vector clientSupplementalData)
                            throws IOException

Throws:

IOException

notifyClientCertificate

void notifyClientCertificate(Certificate clientCertificate)
                      throws IOException

Called by the protocol handler to report the client certificate, only if getCertificateRequest() returned non-null. Note: this method is responsible for certificate verification and validation.

Parameters:

clientCertificate - the effective client certificate (may be an empty chain).

Throws:

IOException

getNewSessionTicket

NewSessionTicket getNewSessionTicket()
                              throws IOException

RFC 5077 3.3. NewSessionTicket Handshake Message.

This method will be called (only) if a NewSessionTicket extension was sent by the server. See RFC 5077 4. Recommended Ticket Construction for recommended format and protection.

Returns:

The ticket.

Throws:

IOException