io.servicetalk.grpc.api

Interface GrpcClientSecurityConfigurator<U,R>

Type Parameters:

U - the type of address before resolution (unresolved address)

R - the type of address after resolution (resolved address)

All Superinterfaces:

ClientSecurityConfigurator, SecurityConfigurator

public interface GrpcClientSecurityConfigurator<U,R>
extends ClientSecurityConfigurator

A ClientSecurityConfigurator for SingleAddressGrpcClientBuilder.

Nested Class Summary

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

SecurityConfigurator.SslProvider

Method Summary

Modifier and Type	Method and Description
GrpcClientSecurityConfigurator<U,R>	ciphers(java.lang.Iterable<java.lang.String> ciphers) The cipher suites to enable, in the order of preference.
GrpcClientBuilder<U,R>	commit() Commit configuring client security.
GrpcClientSecurityConfigurator<U,R>	disableHostnameVerification() Disable verification of the server identity.
GrpcClientSecurityConfigurator<U,R>	hostnameVerification(java.lang.String hostNameVerificationHost) Set the host name used to verify the server identity.
GrpcClientSecurityConfigurator<U,R>	hostnameVerification(java.lang.String hostNameVerificationHost, int hostNameVerificationPort) Set the host name and port used to verify the server identity.
GrpcClientSecurityConfigurator<U,R>	hostnameVerification(java.lang.String hostNameVerificationAlgorithm, java.lang.String hostNameVerificationHost) Determines what algorithm to use for hostname verification.
GrpcClientSecurityConfigurator<U,R>	hostnameVerification(java.lang.String hostNameVerificationAlgorithm, java.lang.String hostNameVerificationHost, int hostNameVerificationPort) Determines what algorithm to use for hostname verification.
GrpcClientSecurityConfigurator<U,R>	hostnameVerificationAlgorithm(java.lang.String hostNameVerificationAlgorithm) Determines what algorithm to use for hostname verification.
GrpcClientSecurityConfigurator<U,R>	keyManager(javax.net.ssl.KeyManagerFactory keyManagerFactory) Identifying certificate for this host.
GrpcClientSecurityConfigurator<U,R>	keyManager(java.util.function.Supplier<java.io.InputStream> keyCertChainSupplier, java.util.function.Supplier<java.io.InputStream> keySupplier) Identifying certificate for this host.
GrpcClientSecurityConfigurator<U,R>	keyManager(java.util.function.Supplier<java.io.InputStream> keyCertChainSupplier, java.util.function.Supplier<java.io.InputStream> keySupplier, java.lang.String keyPassword) Identifying certificate for this host.
GrpcClientSecurityConfigurator<U,R>	protocols(java.lang.String... protocols) The SSL protocols to enable, in the order of preference.
GrpcClientSecurityConfigurator<U,R>	provider(SecurityConfigurator.SslProvider provider) Sets the SecurityConfigurator.SslProvider to use.
GrpcClientSecurityConfigurator<U,R>	sessionCacheSize(long sessionCacheSize) Set the size of the cache used for storing SSL session objects.
GrpcClientSecurityConfigurator<U,R>	sessionTimeout(long sessionTimeout) Set the timeout for the cached SSL session objects, in seconds.
GrpcClientSecurityConfigurator<U,R>	sniHostname(java.lang.String sniHostname) Set the SNI host name.
GrpcClientSecurityConfigurator<U,R>	trustManager(java.util.function.Supplier<java.io.InputStream> trustCertChainSupplier) Trusted certificates for verifying the remote endpoint's certificate.
GrpcClientSecurityConfigurator<U,R>	trustManager(javax.net.ssl.TrustManagerFactory trustManagerFactory) Trust manager for verifying the remote endpoint's certificate.

Method Detail

commit

GrpcClientBuilder<U,R> commit()

Commit configuring client security.

Returns:

Original GrpcClientBuilder that initiated the security configuration process.

trustManager

GrpcClientSecurityConfigurator<U,R> 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 ClientSecurityConfigurator

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

GrpcClientSecurityConfigurator<U,R> 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 ClientSecurityConfigurator

Specified by:

trustManager in interface SecurityConfigurator

Parameters:

trustManagerFactory - the TrustManagerFactory to use.

Returns:

this.

protocols

GrpcClientSecurityConfigurator<U,R> 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 ClientSecurityConfigurator

Specified by:

protocols in interface SecurityConfigurator

Parameters:

protocols - the protocols to use.

Returns:

this.

See Also:

SSLEngine.setEnabledProtocols(String[])

ciphers

GrpcClientSecurityConfigurator<U,R> 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 ClientSecurityConfigurator

Specified by:

ciphers in interface SecurityConfigurator

Parameters:

ciphers - the ciphers to use.

Returns:

this.

sessionCacheSize

GrpcClientSecurityConfigurator<U,R> 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 ClientSecurityConfigurator

Specified by:

sessionCacheSize in interface SecurityConfigurator

Parameters:

sessionCacheSize - the cache size.

Returns:

this.

sessionTimeout

GrpcClientSecurityConfigurator<U,R> sessionTimeout(long sessionTimeout)

Description copied from interface: SecurityConfigurator

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

Specified by:

sessionTimeout in interface ClientSecurityConfigurator

Specified by:

sessionTimeout in interface SecurityConfigurator

Parameters:

sessionTimeout - the session timeout.

Returns:

this.

provider

GrpcClientSecurityConfigurator<U,R> provider(SecurityConfigurator.SslProvider provider)

Description copied from interface: SecurityConfigurator

Sets the SecurityConfigurator.SslProvider to use.

Specified by:

provider in interface ClientSecurityConfigurator

Specified by:

provider in interface SecurityConfigurator

Parameters:

provider - the provider.

Returns:

this.

hostnameVerificationAlgorithm

GrpcClientSecurityConfigurator<U,R> hostnameVerificationAlgorithm(java.lang.String hostNameVerificationAlgorithm)

Description copied from interface: ClientSecurityConfigurator

Determines what algorithm to use for hostname verification.

Specified by:

hostnameVerificationAlgorithm in interface ClientSecurityConfigurator

Parameters:

hostNameVerificationAlgorithm - The algorithm to use when verifying the host name. See Supported algorithm names.

Returns:

this.

See Also:

SSLParameters.setEndpointIdentificationAlgorithm(String)

hostnameVerification

GrpcClientSecurityConfigurator<U,R> hostnameVerification(java.lang.String hostNameVerificationAlgorithm,
                                                         java.lang.String hostNameVerificationHost)

Description copied from interface: ClientSecurityConfigurator

Determines what algorithm to use for hostname verification.

Specified by:

hostnameVerification in interface ClientSecurityConfigurator

Parameters:

hostNameVerificationAlgorithm - The algorithm to use when verifying the host name. See Supported algorithm names.

hostNameVerificationHost - the host name used to verify the server identity.

Returns:

this.

See Also:

SSLParameters.setEndpointIdentificationAlgorithm(String)

hostnameVerification

GrpcClientSecurityConfigurator<U,R> hostnameVerification(java.lang.String hostNameVerificationAlgorithm,
                                                         java.lang.String hostNameVerificationHost,
                                                         int hostNameVerificationPort)

Description copied from interface: ClientSecurityConfigurator

Determines what algorithm to use for hostname verification.

Specified by:

hostnameVerification in interface ClientSecurityConfigurator

Parameters:

hostNameVerificationAlgorithm - The algorithm to use when verifying the host name. See Supported algorithm names.

hostNameVerificationHost - the host name used to verify the server identity.

hostNameVerificationPort - The port which maybe used to verify the server identity.

Returns:

this.

See Also:

SSLParameters.setEndpointIdentificationAlgorithm(String)

hostnameVerification

GrpcClientSecurityConfigurator<U,R> hostnameVerification(java.lang.String hostNameVerificationHost)

Description copied from interface: ClientSecurityConfigurator

Set the host name used to verify the server identity.

Specified by:

hostnameVerification in interface ClientSecurityConfigurator

Parameters:

hostNameVerificationHost - the host name used to verify the server identity.

Returns:

this.

hostnameVerification

GrpcClientSecurityConfigurator<U,R> hostnameVerification(java.lang.String hostNameVerificationHost,
                                                         int hostNameVerificationPort)

Description copied from interface: ClientSecurityConfigurator

Set the host name and port used to verify the server identity.

Specified by:

hostnameVerification in interface ClientSecurityConfigurator

Parameters:

hostNameVerificationHost - the host name used to verify the server identity.

hostNameVerificationPort - The port which maybe used to verify the server identity.

Returns:

this.

See Also:

SSLParameters.setEndpointIdentificationAlgorithm(String)

sniHostname

GrpcClientSecurityConfigurator<U,R> sniHostname(java.lang.String sniHostname)

Description copied from interface: ClientSecurityConfigurator

Set the SNI host name.

Specified by:

sniHostname in interface ClientSecurityConfigurator

Parameters:

sniHostname - The SNI host name.

Returns:

this.

disableHostnameVerification

GrpcClientSecurityConfigurator<U,R> disableHostnameVerification()

Description copied from interface: ClientSecurityConfigurator

Disable verification of the server identity.

Specified by:

disableHostnameVerification in interface ClientSecurityConfigurator

Returns:

this.

keyManager

GrpcClientSecurityConfigurator<U,R> keyManager(javax.net.ssl.KeyManagerFactory keyManagerFactory)

Description copied from interface: ClientSecurityConfigurator

Identifying certificate for this host. keyManagerFactory may be null, which disables mutual authentication. The KeyManagerFactory which take preference over any configured Supplier.

Specified by:

keyManager in interface ClientSecurityConfigurator

Parameters:

keyManagerFactory - an KeyManagerFactory.

Returns:

this.

keyManager

GrpcClientSecurityConfigurator<U,R> keyManager(java.util.function.Supplier<java.io.InputStream> keyCertChainSupplier,
                                               java.util.function.Supplier<java.io.InputStream> keySupplier)

Description copied from interface: ClientSecurityConfigurator

Identifying certificate for this host. keyCertChainInputStream and keyInputStream may be null, which disables mutual authentication.

Specified by:

keyManager in interface ClientSecurityConfigurator

Parameters:

keyCertChainSupplier - a Supplier that will provide an input stream for a X.509 certificate chain in PEM format.

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

keySupplier - an Supplier that will provide an input stream for a KCS#8 private key in PEM format.

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

Returns:

this.

keyManager

GrpcClientSecurityConfigurator<U,R> keyManager(java.util.function.Supplier<java.io.InputStream> keyCertChainSupplier,
                                               java.util.function.Supplier<java.io.InputStream> keySupplier,
                                               java.lang.String keyPassword)

Description copied from interface: ClientSecurityConfigurator

Identifying certificate for this host. keyCertChainInputStream and keyInputStream may be null, which disables mutual authentication.

Specified by:

keyManager in interface ClientSecurityConfigurator

Parameters:

keyCertChainSupplier - an Supplier that will provide an input stream for a X.509 certificate chain in PEM format.

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

keySupplier - an Supplier that will provide an input stream for a KCS#8 private key in PEM format.

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

keyPassword - the password of the keyInputStream.

Returns:

this.