io.servicetalk.transport.api

Interface SecurityConfigurator

All Known Subinterfaces:

ClientSecurityConfigurator, GrpcClientSecurityConfigurator<U,R>, GrpcServerSecurityConfigurator, HttpServerSecurityConfigurator, PartitionedHttpClientSecurityConfigurator<U,R>, ServerSecurityConfigurator, SingleAddressHttpClientSecurityConfigurator<U,R>

public interface SecurityConfigurator

An abstraction to configure SSL/TLS.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SecurityConfigurator.SslProvider The provider to use for SSLEngine.

Method Summary

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

Method Detail

trustManager

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

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

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

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

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

Parameters:

trustManagerFactory - the TrustManagerFactory to use.

Returns:

this.

protocols

SecurityConfigurator protocols(java.lang.String... protocols)

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

Parameters:

protocols - the protocols to use.

Returns:

this.

See Also:

SSLEngine.setEnabledProtocols(String[])

ciphers

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

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

Parameters:

ciphers - the ciphers to use.

Returns:

this.

sessionCacheSize

SecurityConfigurator sessionCacheSize(long sessionCacheSize)

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

Parameters:

sessionCacheSize - the cache size.

Returns:

this.

sessionTimeout

SecurityConfigurator sessionTimeout(long sessionTimeout)

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

Parameters:

sessionTimeout - the session timeout.

Returns:

this.

provider

SecurityConfigurator provider(SecurityConfigurator.SslProvider provider)

Sets the SecurityConfigurator.SslProvider to use.

Parameters:

provider - the provider.

Returns:

this.