com.couchbase.client.dcp

Class CertificateAuthenticator

java.lang.Object

com.couchbase.client.dcp.CertificateAuthenticator

All Implemented Interfaces:

Authenticator

public class CertificateAuthenticator
extends Object
implements Authenticator

Performs authentication through a client certificate instead of supplying username and password.

Method Summary

Modifier and Type	Method and Description
void	applyTlsProperties(io.netty.handler.ssl.SslContextBuilder context) The authenticator gets the chance to attach the client certificate to the ssl context if needed.
static CertificateAuthenticator	fromKey(PrivateKey key, String keyPassword, List<X509Certificate> keyCertChain) Creates a new CertificateAuthenticator directly from a key and certificate chain.
static CertificateAuthenticator	fromKeyManagerFactory(Supplier<KeyManagerFactory> keyManagerFactory) Creates a new CertificateAuthenticator from a KeyManagerFactory.
static CertificateAuthenticator	fromKeyStore(KeyStore keyStore, String keyStorePassword) Creates a new CertificateAuthenticator from a key store.
static CertificateAuthenticator	fromKeyStore(Path keyStorePath, String keyStorePassword) Creates a new CertificateAuthenticator from a key store path.
static CertificateAuthenticator	fromKeyStore(Path keyStorePath, String keyStorePassword, String keyStoreType) Creates a new CertificateAuthenticator from a key store path.
boolean	requiresTls() If this authenticator only works with encrypted connections.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.couchbase.client.dcp.Authenticator

authKeyValueConnection

Method Detail

fromKeyStore

public static CertificateAuthenticator fromKeyStore(Path keyStorePath,
                                                    String keyStorePassword)

Creates a new CertificateAuthenticator from a key store path.

Assumes the file format is readable by KeyStore.getDefaultType() (this typically includes JKS and PKCS12).

Parameters:

keyStorePath - the file path to the keystore.

keyStorePassword - the password for the keystore.

Returns:

the created CertificateAuthenticator.

fromKeyStore

public static CertificateAuthenticator fromKeyStore(Path keyStorePath,
                                                    String keyStorePassword,
                                                    String keyStoreType)

Creates a new CertificateAuthenticator from a key store path.

Parameters:

keyStorePath - the file path to the keystore.

keyStorePassword - the password for the keystore.

keyStoreType - (nullable) the type of the key store. If null, the KeyStore.getDefaultType() will be used.

Returns:

the created CertificateAuthenticator.

fromKeyStore

public static CertificateAuthenticator fromKeyStore(KeyStore keyStore,
                                                    String keyStorePassword)

Creates a new CertificateAuthenticator from a key store.

Parameters:

keyStore - the key store to load the certificate from.

keyStorePassword - the password for the key store.

Returns:

the created CertificateAuthenticator.

fromKeyManagerFactory

public static CertificateAuthenticator fromKeyManagerFactory(Supplier<KeyManagerFactory> keyManagerFactory)

Creates a new CertificateAuthenticator from a KeyManagerFactory.

Parameters:

keyManagerFactory - the key manager factory in a supplier that should be used.

Returns:

the created CertificateAuthenticator.

fromKey

public static CertificateAuthenticator fromKey(PrivateKey key,
                                               String keyPassword,
                                               List<X509Certificate> keyCertChain)

Creates a new CertificateAuthenticator directly from a key and certificate chain.

Parameters:

key - the private key to authenticate.

keyPassword - the password for to use.

keyCertChain - the key certificate chain to use.

Returns:

the created CertificateAuthenticator.

applyTlsProperties

public void applyTlsProperties(io.netty.handler.ssl.SslContextBuilder context)

Description copied from interface: Authenticator

The authenticator gets the chance to attach the client certificate to the ssl context if needed.

Specified by:

applyTlsProperties in interface Authenticator

Parameters:

context - the netty context builder

requiresTls

public boolean requiresTls()

Description copied from interface: Authenticator

If this authenticator only works with encrypted connections.

Specified by:

requiresTls in interface Authenticator

toString

public String toString()

Overrides:

toString in class Object