io.servicetalk.transport.api

Interface ServerSecurityConfigurator

All Superinterfaces:

SecurityConfigurator

All Known Subinterfaces:

GrpcServerSecurityConfigurator, HttpServerSecurityConfigurator

public interface ServerSecurityConfigurator
extends SecurityConfigurator

A SecurityConfigurator contract for servers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ServerSecurityConfigurator.ClientAuth Indicates the state of the SSLEngine with respect to client authentication.

Nested classes/interfaces inherited from interface io.servicetalk.transport.api.SecurityConfigurator

SecurityConfigurator.SslProvider

Method Summary

Modifier and Type	Method and Description
ServerSecurityConfigurator	ciphers(java.lang.Iterable<java.lang.String> ciphers) The cipher suites to enable, in the order of preference.
ServerSecurityConfigurator	clientAuth(ServerSecurityConfigurator.ClientAuth clientAuth) Sets the client authentication mode.
ServerSecurityConfigurator	protocols(java.lang.String... protocols) The SSL protocols to enable, in the order of preference.
ServerSecurityConfigurator	provider(SecurityConfigurator.SslProvider provider) Sets the SecurityConfigurator.SslProvider to use.
ServerSecurityConfigurator	sessionCacheSize(long sessionCacheSize) Set the size of the cache used for storing SSL session objects.
ServerSecurityConfigurator	sessionTimeout(long sessionTimeout) Set the timeout for the cached SSL session objects, in seconds.
ServerSecurityConfigurator	trustManager(java.util.function.Supplier<java.io.InputStream> trustCertChainSupplier) Trusted certificates for verifying the remote endpoint's certificate.
ServerSecurityConfigurator	trustManager(javax.net.ssl.TrustManagerFactory trustManagerFactory) Trust manager for verifying the remote endpoint's certificate.

Method Detail

trustManager

ServerSecurityConfigurator trustManager(java.util.function.Supplier<java.io.InputStream> trustCertChainSupplier)

Description copied from interface: SecurityConfigurator

Trusted certificates for verifying the remote endpoint's certificate. The input stream should contain an X.509 certificate chain in PEM format.

Specified by:

trustManager in interface SecurityConfigurator

Parameters:

trustCertChainSupplier - a supplier for the certificate chain input stream.

The responsibility to call InputStream.close() is transferred to callers of the returned Supplier. If this is not the desired behavior then wrap the InputStream and override InputStream.close().

Returns:

this.

trustManager

ServerSecurityConfigurator trustManager(javax.net.ssl.TrustManagerFactory trustManagerFactory)

Description copied from interface: SecurityConfigurator

Trust manager for verifying the remote endpoint's certificate. The TrustManagerFactory which take preference over any configured Supplier.

Specified by:

trustManager in interface SecurityConfigurator

Parameters:

trustManagerFactory - the TrustManagerFactory to use.

Returns:

this.

protocols

ServerSecurityConfigurator protocols(java.lang.String... protocols)

Description copied from interface: SecurityConfigurator

The SSL protocols to enable, in the order of preference.

Specified by:

protocols in interface SecurityConfigurator

Parameters:

protocols - the protocols to use.

Returns:

this.

See Also:

SSLEngine.setEnabledProtocols(String[])

ciphers

ServerSecurityConfigurator ciphers(java.lang.Iterable<java.lang.String> ciphers)

Description copied from interface: SecurityConfigurator

The cipher suites to enable, in the order of preference.

Specified by:

ciphers in interface SecurityConfigurator

Parameters:

ciphers - the ciphers to use.

Returns:

this.

sessionCacheSize

ServerSecurityConfigurator sessionCacheSize(long sessionCacheSize)

Description copied from interface: SecurityConfigurator

Set the size of the cache used for storing SSL session objects.

Specified by:

sessionCacheSize in interface SecurityConfigurator

Parameters:

sessionCacheSize - the cache size.

Returns:

this.

sessionTimeout

ServerSecurityConfigurator sessionTimeout(long sessionTimeout)

Description copied from interface: SecurityConfigurator

Set the timeout for the cached SSL session objects, in seconds.

Specified by:

sessionTimeout in interface SecurityConfigurator

Parameters:

sessionTimeout - the session timeout.

Returns:

this.

provider

ServerSecurityConfigurator provider(SecurityConfigurator.SslProvider provider)

Description copied from interface: SecurityConfigurator

Sets the SecurityConfigurator.SslProvider to use.

Specified by:

provider in interface SecurityConfigurator

Parameters:

provider - the provider.

Returns:

this.

clientAuth

ServerSecurityConfigurator clientAuth(ServerSecurityConfigurator.ClientAuth clientAuth)

Sets the client authentication mode.

Parameters:

clientAuth - the auth configuration to use.

Returns:

this.