org.springframework.vault.authentication

Class KubernetesServiceAccountTokenFile

java.lang.Object

org.springframework.vault.authentication.KubernetesServiceAccountTokenFile

All Implemented Interfaces:

Supplier<String>, KubernetesJwtSupplier

public class KubernetesServiceAccountTokenFile
extends Object
implements KubernetesJwtSupplier

Mechanism to retrieve a Kubernetes service account token.

A file containing a token for a pod's service account is automatically mounted at /var/run/secrets/kubernetes.io/serviceaccount/token.

Since:

2.0

Author:

Michal Budzyn, Mark Paluch

See Also:

KubernetesJwtSupplier

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_KUBERNETES_SERVICE_ACCOUNT_TOKEN_FILE Default path to the service account token file.

Constructor Summary

Constructors

Constructor and Description
KubernetesServiceAccountTokenFile() Create a new KubernetesServiceAccountTokenFile pointing to the DEFAULT_KUBERNETES_SERVICE_ACCOUNT_TOKEN_FILE.
KubernetesServiceAccountTokenFile(File file) Create a new KubernetesServiceAccountTokenFile KubernetesServiceAccountTokenFile from a File handle.
KubernetesServiceAccountTokenFile(Resource resource) Create a new KubernetesServiceAccountTokenFile KubernetesServiceAccountTokenFile from a Resource handle.
KubernetesServiceAccountTokenFile(String path) Create a new KubernetesServiceAccountTokenFile KubernetesServiceAccountTokenFile from a path.

Method Summary

Modifier and Type	Method and Description
String	get() Get a JWT for Kubernetes authentication.
protected static byte[]	readToken(Resource resource) Read the token from Resource.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KUBERNETES_SERVICE_ACCOUNT_TOKEN_FILE

public static final String DEFAULT_KUBERNETES_SERVICE_ACCOUNT_TOKEN_FILE

Default path to the service account token file.

See Also:

Constant Field Values

Constructor Detail

KubernetesServiceAccountTokenFile

public KubernetesServiceAccountTokenFile()

Create a new KubernetesServiceAccountTokenFile pointing to the DEFAULT_KUBERNETES_SERVICE_ACCOUNT_TOKEN_FILE. Construction fails with an exception if the file does not exist.

Throws:

IllegalArgumentException - if the DEFAULT_KUBERNETES_SERVICE_ACCOUNT_TOKEN_FILE does not exist.

KubernetesServiceAccountTokenFile

public KubernetesServiceAccountTokenFile(String path)

Create a new KubernetesServiceAccountTokenFile KubernetesServiceAccountTokenFile from a path.

Parameters:

path - path to the service account token file.

Throws:

IllegalArgumentException - if thepath does not exist.

KubernetesServiceAccountTokenFile

public KubernetesServiceAccountTokenFile(File file)

Create a new KubernetesServiceAccountTokenFile KubernetesServiceAccountTokenFile from a File handle.

Parameters:

file - path to the service account token file.

Throws:

IllegalArgumentException - if thepath does not exist.

KubernetesServiceAccountTokenFile

public KubernetesServiceAccountTokenFile(Resource resource)

Create a new KubernetesServiceAccountTokenFile KubernetesServiceAccountTokenFile from a Resource handle.

Parameters:

resource - resource pointing to the service account token file.

Throws:

IllegalArgumentException - if thepath does not exist.

Method Detail

get

public String get()

Description copied from interface: KubernetesJwtSupplier

Get a JWT for Kubernetes authentication.

Specified by:

get in interface Supplier<String>

Specified by:

get in interface KubernetesJwtSupplier

Returns:

the Kubernetes Service Account JWT.

readToken

protected static byte[] readToken(Resource resource)
                           throws IOException

Read the token from Resource.

Parameters:

resource - the resource to read from, must not be null.

Returns:

the new byte array that has been copied to (possibly empty).

Throws:

IOException - in case of I/O errors.