Package io.servicetalk.transport.api

Class ClientSslConfigBuilder

  • public final class ClientSslConfigBuilder
extends java.lang.Object
    Default builder for ClientSslConfig objects.

    • Constructor Summary

      Constructors 
      Constructor Description
      ClientSslConfigBuilder()
      Create a new instance using this JVM's TrustManagerFactory.getDefaultAlgorithm() and default TrustManagerFactory.
      ClientSslConfigBuilder​(java.util.function.Supplier<java.io.InputStream> trustCertChainSupplier)
      Create a new instance using trustCertChainSupplier to verify trusted servers.
      ClientSslConfigBuilder​(javax.net.ssl.TrustManagerFactory tmf)
      Create a new instance using tmf to verify trusted servers.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      T alpnProtocols​(java.lang.String... protocols)
      Set the TLS ALPN protocols.
      T alpnProtocols​(java.util.List<java.lang.String> protocols)
      Set the TLS ALPN protocols.
      ClientSslConfig build()
      Build a new ClientSslConfig.
      T ciphers​(java.lang.String... ciphers)
      Set the cipher suites to enable, in the order of preference.
      T ciphers​(java.util.List<java.lang.String> ciphers)
      Set the cipher suites to enable, in the order of preference.
      ClientSslConfigBuilder disableHostnameVerification()
      Deprecated.
      Disabling hostname verification may leave you vulnerable to man-in-the-middle attacks.
      ClientSslConfigBuilder hostnameVerificationAlgorithm​(java.lang.String algorithm)
      Set the algorithm to use for hostname verification to verify the server identity.
      T keyManager​(java.util.function.Supplier<java.io.InputStream> keyCertChainSupplier, java.util.function.Supplier<java.io.InputStream> keySupplier)
      Set a InputStream which provides X.509 certificate chain in PEM format and a PKCS#8 private key in PEM format.
      T keyManager​(java.util.function.Supplier<java.io.InputStream> keyCertChainSupplier, java.util.function.Supplier<java.io.InputStream> keySupplier, java.lang.String keyPassword)
      Set a InputStream which provides X.509 certificate chain in PEM format and a PKCS#8 private key in PEM format protected by a password.
      T keyManager​(javax.net.ssl.KeyManagerFactory kmf)
      Set the KeyManagerFactory to use for the SSL/TLS handshake.
      ClientSslConfigBuilder peerHost​(java.lang.String peerHost)
      Set the non-authoritative name of the peer.
      ClientSslConfigBuilder peerPort​(int peerPort)
      Set the non-authoritative port of the peer.
      T provider​(SslProvider provider)
      Get the SslProvider to use.
      T sessionCacheSize​(long sessionCacheSize)
      Get the size of the cache used for storing SSL session objects.
      T sessionTimeout​(long sessionTimeout)
      Get the timeout for the cached SSL session objects, in seconds.
      ClientSslConfigBuilder sniHostname​(java.lang.String sniHostname)
      Set the SNI host name.
      T sslProtocols​(java.lang.String... protocols)
      Set the TLS protocols to enable, in the order of preference.
      T sslProtocols​(java.util.List<java.lang.String> protocols)
      Set the TLS protocols to enable, in the order of preference.
      protected ClientSslConfigBuilder thisT()  
      T trustManager​(java.util.function.Supplier<java.io.InputStream> trustCertChainSupplier)
      Set the trusted certificates for verifying the remote endpoint's certificate.
      T trustManager​(javax.net.ssl.TrustManagerFactory tmf)
      Set the TrustManagerFactory used for verifying the remote endpoint's certificate.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ClientSslConfigBuilder

        public ClientSslConfigBuilder()
        Create a new instance using this JVM's TrustManagerFactory.getDefaultAlgorithm() and default TrustManagerFactory.

      • ClientSslConfigBuilder

        public ClientSslConfigBuilder​(javax.net.ssl.TrustManagerFactory tmf)
        Create a new instance using tmf to verify trusted servers.
        Parameters:
        tmf - The TrustManagerFactory used to verify trusted servers.

      • ClientSslConfigBuilder

        public ClientSslConfigBuilder​(java.util.function.Supplier<java.io.InputStream> trustCertChainSupplier)
        Create a new instance using trustCertChainSupplier to verify trusted servers.
        Parameters:
        trustCertChainSupplier - the trusted certificates for verifying the remote endpoint's certificate. The input stream should contain an X.509 certificate chain in PEM format.

        Each invocation of the Supplier should provide an independent instance of InputStream and the caller is responsible for invoking InputStream.close().

    • Method Detail

      • hostnameVerificationAlgorithm

        public ClientSslConfigBuilder hostnameVerificationAlgorithm​(java.lang.String algorithm)
        Set the algorithm to use for hostname verification to verify the server identity.
        Parameters:
        algorithm - The algorithm to use when verifying the host name. See Endpoint Identification Algorithm Name
        Returns:
        this.
        See Also:
        SSLParameters.setEndpointIdentificationAlgorithm(String)

      • disableHostnameVerification

        @Deprecated
public ClientSslConfigBuilder disableHostnameVerification()
        Deprecated.
        Disabling hostname verification may leave you vulnerable to man-in-the-middle attacks. See server identity on the risks of disabling. If the expected value isn't automatically inferred use peerHost(String) to set the expected value.
        Disable host name verification.
        Returns:
        this.
        See Also:
        SSLParameters.setEndpointIdentificationAlgorithm(String)

      • peerHost

        public ClientSslConfigBuilder peerHost​(java.lang.String peerHost)
        Set the non-authoritative name of the peer.
        Parameters:
        peerHost - the non-authoritative name of the peer.
        Returns:
        this.
        See Also:
        SSLEngine.getPeerHost()

      • peerPort

        public ClientSslConfigBuilder peerPort​(int peerPort)
        Set the non-authoritative port of the peer.
        Parameters:
        peerPort - the non-authoritative port of the peer, or -1 if unavailable (which may prevent session resumption).
        Returns:
        this.
        See Also:
        SSLEngine.getPeerPort()

      • sniHostname

        public ClientSslConfigBuilder sniHostname​(java.lang.String sniHostname)
        Set the SNI host name.
        Parameters:
        sniHostname - SNI host name.
        Returns:
        this.
        See Also:
        SSLParameters.setServerNames(List)

      • trustManager

        public final T trustManager​(javax.net.ssl.TrustManagerFactory tmf)
        Set the TrustManagerFactory used for verifying the remote endpoint's certificate.
        Parameters:
        tmf - the TrustManagerFactory used for verifying the remote endpoint's certificate.
        Returns:
        this.

      • trustManager

        public final T trustManager​(java.util.function.Supplier<java.io.InputStream> trustCertChainSupplier)
        Set the trusted certificates for verifying the remote endpoint's certificate. The input stream should contain an X.509 certificate chain in PEM format.
        Parameters:
        trustCertChainSupplier - the trusted certificates for verifying the remote endpoint's certificate. The input stream should contain an X.509 certificate chain in PEM format.

        Each invocation of the Supplier should provide an independent instance of InputStream and the caller is responsible for invoking InputStream.close().

        Returns:
        this.

      • keyManager

        public final T keyManager​(javax.net.ssl.KeyManagerFactory kmf)
        Set the KeyManagerFactory to use for the SSL/TLS handshake.
        Parameters:
        kmf - the KeyManagerFactory to use for the SSL/TLS handshake.
        Returns:
        this.

      • keyManager

        public final T keyManager​(java.util.function.Supplier<java.io.InputStream> keyCertChainSupplier,
                          java.util.function.Supplier<java.io.InputStream> keySupplier)
        Set a InputStream which provides X.509 certificate chain in PEM format and a PKCS#8 private key in PEM format.
        Parameters:
        keyCertChainSupplier - the X.509 certificate chain in PEM format.

        Each invocation of the Supplier should provide an independent instance of InputStream and the caller is responsible for invoking InputStream.close().

        keySupplier - a InputStream which provides a PKCS#8 private key in PEM format associated with.

        Each invocation of the Supplier should provide an independent instance of InputStream and the caller is responsible for invoking InputStream.close().

        Returns:
        this.

      • keyManager

        public final T keyManager​(java.util.function.Supplier<java.io.InputStream> keyCertChainSupplier,
                          java.util.function.Supplier<java.io.InputStream> keySupplier,
                          @Nullable
                          java.lang.String keyPassword)
        Set a InputStream which provides X.509 certificate chain in PEM format and a PKCS#8 private key in PEM format protected by a password.
        Parameters:
        keyCertChainSupplier - the X.509 certificate chain in PEM format.

        Each invocation of the Supplier should provide an independent instance of InputStream and the caller is responsible for invoking InputStream.close().

        keySupplier - a InputStream which provides a PKCS#8 private key in PEM format associated with.

        Each invocation of the Supplier should provide an independent instance of InputStream and the caller is responsible for invoking InputStream.close().

        keyPassword - the password required to access the key material from keySupplier.
        Returns:
        this.

      • sslProtocols

        public final T sslProtocols​(java.util.List<java.lang.String> protocols)
        Set the TLS protocols to enable, in the order of preference.
        Parameters:
        protocols - the TLS protocols to enable, in the order of preference.
        Returns:
        this.
        See Also:
        SSLEngine.setEnabledProtocols(String[])

      • sslProtocols

        public final T sslProtocols​(java.lang.String... protocols)
        Set the TLS protocols to enable, in the order of preference.
        Parameters:
        protocols - the TLS protocols to enable, in the order of preference.
        Returns:
        this.
        See Also:
        SSLEngine.setEnabledProtocols(String[])

      • alpnProtocols

        public final T alpnProtocols​(java.util.List<java.lang.String> protocols)
        Set the TLS ALPN protocols.

        Note that each ALPN protocol typically requires corresponding configuration at the protocol layer and as a result maybe inferred and overridden by the protocol layer.

        Parameters:
        protocols - the TLS ALPN protocols.
        Returns:
        this.

      • alpnProtocols

        public final T alpnProtocols​(java.lang.String... protocols)
        Set the TLS ALPN protocols.

        Note that each ALPN protocol typically requires corresponding configuration at the protocol layer and as a result maybe inferred and overridden by the protocol layer.

        Parameters:
        protocols - the TLS ALPN protocols.
        Returns:
        this.

      • ciphers

        public final T ciphers​(java.util.List<java.lang.String> ciphers)
        Set the cipher suites to enable, in the order of preference.
        Parameters:
        ciphers - the ciphers to use.
        Returns:
        this.

      • ciphers

        public final T ciphers​(java.lang.String... ciphers)
        Set the cipher suites to enable, in the order of preference.
        Parameters:
        ciphers - the ciphers to use.
        Returns:
        this.

      • sessionCacheSize

        public final T sessionCacheSize​(long sessionCacheSize)
        Get the size of the cache used for storing SSL session objects.
        Parameters:
        sessionCacheSize - the size of the cache used for storing SSL session objects.
        Returns:
        this.
        See Also:
        SSLSessionContext.setSessionCacheSize(int)

      • sessionTimeout

        public final T sessionTimeout​(long sessionTimeout)
        Get the timeout for the cached SSL session objects, in seconds.
        Parameters:
        sessionTimeout - the timeout for the cached SSL session objects, in seconds.
        Returns:
        this.
        See Also:
        SSLSessionContext.setSessionTimeout(int)