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 Details

    • preferLocalSupportedGroups

      boolean preferLocalSupportedGroups()

    • 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:

    • getNewSessionID

      byte[] getNewSessionID()

    • getExternalPSK

      TlsPSKExternal getExternalPSK(Vector identities) throws IOException
      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.
      Throws:
      IOException - if the handshake should be aborted. An implementation may throw a TlsFatalAlert to control the alert sent to the peer - e.g. AlertDescription.unknown_psk_identity when none of the offered identities is recognised, or AlertDescription.decrypt_error when an identity is recognised but is invalid or expired (see RFC 8446 6.2). Returning null instead leaves PSK unselected without aborting.

    • 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 SecurityParameters.getStatusRequestVersion() is non-zero, meaning the client asked for a stapled response and the server undertook to answer: up to (D)TLS 1.2, that it echoed an extension of type "status_request" (RFC 6066 sec. 8. Certificate Status Request) or "status_request_v2" (RFC 6961 sec. 2.2. Multiple Certificate Status Request Record) with empty "extension_data" in the extended server hello; in TLS 1.3, simply that the client offered "status_request".

      The status request version says which of the two shapes the client will accept; returning the other one is a fatal alert at the client:

      • 1 – "status_request". Return a CertificateStatusType.ocsp status carrying a single response, for the end-entity certificate.
      • 2 – "status_request_v2" was echoed. Return a CertificateStatusType.ocsp_multi status carrying one entry per certificate in the chain that was sent, in the same order, with a null entry wherever no response is available.
      Whether either extension is echoed at all up to (D)TLS 1.2 is decided by AbstractTlsServer.allowCertificateStatus() (defaults to true) and AbstractTlsServer.allowMultiCertStatus() (defaults to false).

      How the returned status reaches the client depends on the negotiated version. Up to (D)TLS 1.2 it is sent as a handshake message of type "certificate_status", for the whole chain at once. In TLS 1.3 there is no such message: the response travels in a "status_request" extension of the CertificateEntry containing the certificate it answers for (RFC 8446 sec. 4.4.2.1), and the protocol distributes what this callback returns across those entries - an CertificateStatusType.ocsp status answering for the end-entity certificate, an CertificateStatusType.ocsp_multi status answering positionally, entry i of its list for certificate i of the chain. So a TLS 1.3 server with a response for more than the end-entity certificate returns the ocsp_multi shape even though the status request version is 1. An entry the server has itself given a "status_request" extension - by attaching it to the Certificate its credentials supply, which was previously the only way to staple in TLS 1.3 - is left as it stands.

      OCSPStaplingServerExample in the misc module is a worked example.

      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