net.devh.boot.grpc.server.config

Class GrpcServerProperties.Security

java.lang.Object

net.devh.boot.grpc.server.config.GrpcServerProperties.Security

Enclosing class:

GrpcServerProperties

public static class GrpcServerProperties.Security
extends Object

The security configuration for the gRPC server.

Constructor Summary

Constructors

Constructor and Description
Security()

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Resource	getCertificateChain() The resource containing the SSL certificate chain.
List<String>	getCiphers() Specifies the cipher suite.
ClientAuth	getClientAuth() Whether the client has to authenticate himself via certificates.
Resource	getPrivateKey() The resource containing the private key.
String	getPrivateKeyPassword() Password for the private key.
String[]	getProtocols() Specifies the protocols accepted for secure connections.
Resource	getTrustCertCollection() The resource containing the trusted certificate collection.
int	hashCode()
boolean	isEnabled() Flag that controls whether transport security is used.
void	setCertificateChain(Resource certificateChain) The resource containing the SSL certificate chain.
void	setCiphers(String ciphers)
void	setClientAuth(ClientAuth clientAuth) Whether the client has to authenticate himself via certificates.
void	setEnabled(boolean enabled) Flag that controls whether transport security is used.
void	setPrivateKey(Resource privateKey) The resource containing the private key.
void	setPrivateKeyPassword(String privateKeyPassword) Password for the private key.
void	setProtocols(String protocols)
void	setTrustCertCollection(Resource trustCertCollection) The resource containing the trusted certificate collection.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Security

public Security()

Method Detail

setCiphers

public void setCiphers(String ciphers)

setProtocols

public void setProtocols(String protocols)

isEnabled

public boolean isEnabled()

Flag that controls whether transport security is used. Defaults to false.

Returns:

True, if transport security should be enabled. False otherwise.

getCertificateChain

public Resource getCertificateChain()

The resource containing the SSL certificate chain. Required if isEnabled() is true.

Returns:

The certificate chain resource or null, if security is not enabled.

See Also:

GrpcSslContexts.forServer(InputStream, InputStream, String)

getPrivateKey

public Resource getPrivateKey()

The resource containing the private key. Required if enabled is true.

Returns:

The private key resource or null, if security is not enabled.

See Also:

GrpcSslContexts.forServer(InputStream, InputStream, String)

getPrivateKeyPassword

public String getPrivateKeyPassword()

Password for the private key.

Returns:

The password for the private key or null, if the private key is not set or not encrypted.

See Also:

GrpcSslContexts.forServer(File, File, String)

getClientAuth

public ClientAuth getClientAuth()

Whether the client has to authenticate himself via certificates. Can be either of NONE, OPTIONAL or REQUIRE. Defaults to ClientAuth.NONE.

Returns:

Whether the client has to authenticate himself via certificates.

See Also:

SslContextBuilder#clientAuth(ClientAuth)

getTrustCertCollection

public Resource getTrustCertCollection()

The resource containing the trusted certificate collection. If null or empty it will use the system's default collection (Default). This collection will be used to verify client certificates.

Returns:

The trusted certificate collection resource or null.

See Also:

SslContextBuilder.trustManager(InputStream)

getCiphers

public List<String> getCiphers()

Specifies the cipher suite. If null or empty it will use the system's default cipher suite.

Returns:

The cipher suite accepted for secure connections or null.

getProtocols

public String[] getProtocols()

Specifies the protocols accepted for secure connections. If null or empty it will use the system's default (all supported) protocols.

Returns:

The protocols accepted for secure connections or null.

setEnabled

public void setEnabled(boolean enabled)

Flag that controls whether transport security is used. Defaults to false.

Parameters:

enabled - Whether transport security should be enabled.

setCertificateChain

public void setCertificateChain(Resource certificateChain)

The resource containing the SSL certificate chain. Required if isEnabled() is true.

Parameters:

certificateChain - The certificate chain resource.

See Also:

GrpcSslContexts.forServer(InputStream, InputStream, String)

setPrivateKey

public void setPrivateKey(Resource privateKey)

The resource containing the private key. Required if enabled is true.

Parameters:

privateKey - The private key resource.

See Also:

GrpcSslContexts.forServer(InputStream, InputStream, String)

setPrivateKeyPassword

public void setPrivateKeyPassword(String privateKeyPassword)

Password for the private key.

Parameters:

privateKeyPassword - The password for the private key.

See Also:

GrpcSslContexts.forServer(File, File, String)

setClientAuth

public void setClientAuth(ClientAuth clientAuth)

Whether the client has to authenticate himself via certificates. Can be either of NONE, OPTIONAL or REQUIRE. Defaults to ClientAuth.NONE.

Parameters:

clientAuth - Whether the client has to authenticate himself via certificates.

See Also:

SslContextBuilder#clientAuth(ClientAuth)

setTrustCertCollection

public void setTrustCertCollection(Resource trustCertCollection)

The resource containing the trusted certificate collection. If null or empty it will use the system's default collection (Default). This collection will be used to verify client certificates.

Parameters:

trustCertCollection - The trusted certificate collection resource.

See Also:

SslContextBuilder.trustManager(InputStream)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object