Class SslServerConfig


  • public class SslServerConfig
    extends Object
    Shared configuration for setting up server-side SSL.
    • Field Detail

      • certificate

        @ConfigItem
        public Optional<Path> certificate
        The classpath path or file path to a server certificate or certificate chain in PEM format.
      • key

        @ConfigItem
        public Optional<Path> key
        The classpath path or file path to the corresponding certificate private key file in PEM format.
      • keyStore

        @ConfigItem
        public Optional<Path> keyStore
        An optional key store which holds the certificate information instead of specifying separate files. The key store can be either on classpath or an external file.
      • keyStoreType

        @ConfigItem
        public Optional<String> keyStoreType
        An optional parameter to specify the type of the key store file. If not given, the type is automatically detected based on the file name.
      • keyStorePassword

        @ConfigItem
        public Optional<String> keyStorePassword
        A parameter to specify the password of the key store file. If not given, the default ("password") is used.
      • trustStore

        @ConfigItem
        public Optional<Path> trustStore
        An optional trust store which holds the certificate information of the certificates to trust

        The trust store can be either on classpath or an external file.

      • trustStoreType

        @ConfigItem
        public Optional<String> trustStoreType
        An optional parameter to specify type of the trust store file. If not given, the type is automatically detected based on the file name.
      • trustStorePassword

        @ConfigItem
        public Optional<String> trustStorePassword
        A parameter to specify the password of the trust store file.
      • cipherSuites

        @ConfigItem
        public Optional<List<String>> cipherSuites
        The cipher suites to use. If none is given, a reasonable default is selected.
      • protocols

        @DefaultConverter
        @ConfigItem(defaultValue="TLSv1.3,TLSv1.2")
        public Set<String> protocols
        Sets the ordered list of enabled SSL/TLS protocols.

        If not set, it defaults to "TLSv1.3, TLSv1.2". The following list of protocols are supported: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3. To only enable TLSv1.3, set the value to to "TLSv1.3".

        Note that setting an empty list, and enabling SSL/TLS is invalid. You must at least have one protocol.

      • clientAuth

        @ConfigItem(defaultValue="NONE")
        public io.vertx.core.http.ClientAuth clientAuth
        Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED
    • Constructor Detail

      • SslServerConfig

        public SslServerConfig()