Class Ssl

java.lang.Object
org.springframework.boot.web.server.Ssl
@ConfigurationPropertiesSource public class Ssl extends Object
Simple server-independent abstraction for SSL configuration.
Since:
2.0.0
Author:
Andy Wilkinson, Vladimir Tsanev, Stephane Nicoll, Scott Frederick

  • Constructor Details

    • Ssl

      public Ssl()

  • Method Details

    • isEnabled

      public boolean isEnabled()
      Return whether to enable SSL support.
      Returns:
      whether to enable SSL support

    • setEnabled

      public void setEnabled(boolean enabled)

    • getBundle

      public @Nullable String getBundle()
      Return the name of the SSL bundle to use.
      Returns:
      the SSL bundle name
      Since:
      3.1.0

    • setBundle

      public void setBundle(@Nullable String bundle)
      Set the name of the SSL bundle to use.
      Parameters:
      bundle - the SSL bundle name
      Since:
      3.1.0

    • getClientAuth

      public @Nullable Ssl.ClientAuth getClientAuth()
      Return Whether client authentication is not wanted ("none"), wanted ("want") or needed ("need"). Requires a trust store.
      Returns:
      the Ssl.ClientAuth to use

    • setClientAuth

      public void setClientAuth(@Nullable Ssl.ClientAuth clientAuth)

    • getCiphers

      public String @Nullable [] getCiphers()
      Return the supported SSL ciphers.
      Returns:
      the supported SSL ciphers

    • setCiphers

      public void setCiphers(String @Nullable [] ciphers)

    • getEnabledProtocols

      public String @Nullable [] getEnabledProtocols()
      Return the enabled SSL protocols.
      Returns:
      the enabled SSL protocols.

    • setEnabledProtocols

      public void setEnabledProtocols(String @Nullable [] enabledProtocols)

    • getKeyAlias

      public @Nullable String getKeyAlias()
      Return the alias that identifies the key in the key store.
      Returns:
      the key alias

    • setKeyAlias

      public void setKeyAlias(@Nullable String keyAlias)

    • getKeyPassword

      public @Nullable String getKeyPassword()
      Return the password used to access the key in the key store.
      Returns:
      the key password

    • setKeyPassword

      public void setKeyPassword(@Nullable String keyPassword)

    • getKeyStore

      public @Nullable String getKeyStore()
      Return the path to the key store that holds the SSL certificate (typically a jks file).
      Returns:
      the path to the key store

    • setKeyStore

      public void setKeyStore(@Nullable String keyStore)

    • getKeyStorePassword

      public @Nullable String getKeyStorePassword()
      Return the password used to access the key store.
      Returns:
      the key store password

    • setKeyStorePassword

      public void setKeyStorePassword(@Nullable String keyStorePassword)

    • getKeyStoreType

      public @Nullable String getKeyStoreType()
      Return the type of the key store.
      Returns:
      the key store type

    • setKeyStoreType

      public void setKeyStoreType(@Nullable String keyStoreType)

    • getKeyStoreProvider

      public @Nullable String getKeyStoreProvider()
      Return the provider for the key store.
      Returns:
      the key store provider

    • setKeyStoreProvider

      public void setKeyStoreProvider(@Nullable String keyStoreProvider)

    • getTrustStore

      public @Nullable String getTrustStore()
      Return the trust store that holds SSL certificates.
      Returns:
      the trust store

    • setTrustStore

      public void setTrustStore(@Nullable String trustStore)

    • getTrustStorePassword

      public @Nullable String getTrustStorePassword()
      Return the password used to access the trust store.
      Returns:
      the trust store password

    • setTrustStorePassword

      public void setTrustStorePassword(@Nullable String trustStorePassword)

    • getTrustStoreType

      public @Nullable String getTrustStoreType()
      Return the type of the trust store.
      Returns:
      the trust store type

    • setTrustStoreType

      public void setTrustStoreType(@Nullable String trustStoreType)

    • getTrustStoreProvider

      public @Nullable String getTrustStoreProvider()
      Return the provider for the trust store.
      Returns:
      the trust store provider

    • setTrustStoreProvider

      public void setTrustStoreProvider(@Nullable String trustStoreProvider)

    • getCertificate

      public @Nullable String getCertificate()
      Return the location of the certificate in PEM format.
      Returns:
      the certificate location

    • setCertificate

      public void setCertificate(@Nullable String certificate)

    • getCertificatePrivateKey

      public @Nullable String getCertificatePrivateKey()
      Return the location of the private key for the certificate in PEM format.
      Returns:
      the location of the certificate private key

    • setCertificatePrivateKey

      public void setCertificatePrivateKey(@Nullable String certificatePrivateKey)

    • getTrustCertificate

      public @Nullable String getTrustCertificate()
      Return the location of the trust certificate authority chain in PEM format.
      Returns:
      the location of the trust certificate

    • setTrustCertificate

      public void setTrustCertificate(@Nullable String trustCertificate)

    • getTrustCertificatePrivateKey

      public @Nullable String getTrustCertificatePrivateKey()
      Return the location of the private key for the trust certificate in PEM format.
      Returns:
      the location of the trust certificate private key

    • setTrustCertificatePrivateKey

      public void setTrustCertificatePrivateKey(@Nullable String trustCertificatePrivateKey)

    • getProtocol

      public String getProtocol()
      Return the SSL protocol to use.
      Returns:
      the SSL protocol

    • setProtocol

      public void setProtocol(String protocol)

    • isEnabled

      @Contract("null -> false") public static boolean isEnabled(@Nullable Ssl ssl)
      Returns if SSL is enabled for the given instance.
      Parameters:
      ssl - the SSL instance or null
      Returns:
      true if SSL is enabled
      Since:
      3.1.0

    • getServerNameBundles

      public List<Ssl.ServerNameSslBundle> getServerNameBundles()
      Return the mapping of host names to SSL bundles for SNI configuration.
      Returns:
      the host name to SSL bundle mapping

    • setServerNameBundles

      public void setServerNameBundles(List<Ssl.ServerNameSslBundle> serverNameBundles)

    • forBundle

      public static Ssl forBundle(String bundle)
      Factory method to create an Ssl instance for a specific bundle name.
      Parameters:
      bundle - the name of the bundle
      Returns:
      a new Ssl instance with the bundle set
      Since:
      3.1.0