com.google.auth.mtls

Class X509Provider

java.lang.Object

com.google.auth.mtls.X509Provider

public class X509Provider
extends Object

This class provides certificate key stores to the Google Auth library transport layer via certificate configuration files. This is only meant to be used internally to Google Cloud libraries, and the public facing methods may be changed without notice, and have no guarantee of backwards compatability.

Constructor Summary

Constructors

Constructor and Description
X509Provider() Creates a new X.509 provider that will check the environment variable path and the well known Gcloud certificate configuration location.
X509Provider(String certConfigPathOverride) Creates an X509 provider with an override path for the certificate configuration, bypassing the normal checks for the well known certificate configuration file path and environment variable.

Method Summary

Modifier and Type	Method and Description
KeyStore	getKeyStore() Finds the certificate configuration file, then builds a Keystore using the X.509 certificate and private key pointed to by the configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

X509Provider

public X509Provider(String certConfigPathOverride)

Creates an X509 provider with an override path for the certificate configuration, bypassing the normal checks for the well known certificate configuration file path and environment variable. This is meant for internal Google Cloud usage and behavior may be changed without warning.

Parameters:

certConfigPathOverride - the path to read the certificate configuration from.

X509Provider

public X509Provider()

Creates a new X.509 provider that will check the environment variable path and the well known Gcloud certificate configuration location. This is meant for internal Google Cloud usage and behavior may be changed without warning.

Method Detail

getKeyStore

public KeyStore getKeyStore()
                     throws IOException

Finds the certificate configuration file, then builds a Keystore using the X.509 certificate and private key pointed to by the configuration. This will check the following locations in order.

• The certificate config override path, if set.
• The path pointed to by the "GOOGLE_API_CERTIFICATE_CONFIG" environment variable
• The well known gcloud location for the certificate configuration file.

Returns:

a KeyStore containing the X.509 certificate specified by the certificate configuration.

Throws:

IOException - if there is an error retrieving the certificate configuration.