org.apache.hadoop.fs.s3a.auth

Class CredentialProviderListFactory

java.lang.Object

org.apache.hadoop.fs.s3a.auth.CredentialProviderListFactory

public final class CredentialProviderListFactory
extends Object

This class provides methods to create a AWSCredentialProviderList list of AWS credential providers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMOUS_CREDENTIALS_V1 V1 credential provider: "com.amazonaws.auth.AnonymousAWSCredentials".
static String	E_FORBIDDEN_AWS_PROVIDER Error message when the AWS provider list built up contains a forbidden entry.
static String	EC2_CONTAINER_CREDENTIALS_V1 V1 credential provider: "com.amazonaws.auth.EC2ContainerCredentialsProviderWrapper".
static String	EC2_IAM_CREDENTIALS_V1 V1 credential provider: "com.amazonaws.auth.InstanceProfileCredentialsProvider".
static String	EC2_IAM_CREDENTIALS_V2 V2 EC2 instance/container credential provider.
static String	ENVIRONMENT_CREDENTIALS_V1 V1 env var credential provider: "com.amazonaws.auth.EnvironmentVariableCredentialsProvider".
static String	ENVIRONMENT_CREDENTIALS_V2 V2 environment variables credential provider.
static String	PROFILE_CREDENTIALS_V1 V1 profile credential provider: "com.amazonaws.auth.profile.ProfileCredentialsProvider".
static String	PROFILE_CREDENTIALS_V2 V2 environment variables credential provider.
static List<Class<?>>	STANDARD_AWS_PROVIDERS The standard AWS provider list for AWS connections.

Method Summary

Modifier and Type	Method and Description
static AWSCredentialProviderList	buildAWSProviderList(URI binding, org.apache.hadoop.conf.Configuration conf, String key, List<Class<?>> defaultValues, Set<Class<?>> forbidden) Load list of AWS credential provider/credential provider factory classes; support a forbidden list to prevent loops, mandate full secrets, etc.
static AWSCredentialProviderList	createAWSCredentialProviderList(URI binding, org.apache.hadoop.conf.Configuration conf) Create the AWS credentials from the providers, the URI and the key Constants.AWS_CREDENTIALS_PROVIDER in the configuration.

Methods inherited from class java.lang.Object

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

Field Detail

E_FORBIDDEN_AWS_PROVIDER

@VisibleForTesting
public static final String E_FORBIDDEN_AWS_PROVIDER

Error message when the AWS provider list built up contains a forbidden entry.

See Also:

Constant Field Values

STANDARD_AWS_PROVIDERS

public static final List<Class<?>> STANDARD_AWS_PROVIDERS

The standard AWS provider list for AWS connections.

ANONYMOUS_CREDENTIALS_V1

public static final String ANONYMOUS_CREDENTIALS_V1

V1 credential provider: "com.amazonaws.auth.AnonymousAWSCredentials".

See Also:

Constant Field Values

EC2_CONTAINER_CREDENTIALS_V1

public static final String EC2_CONTAINER_CREDENTIALS_V1

V1 credential provider: "com.amazonaws.auth.EC2ContainerCredentialsProviderWrapper".

See Also:

Constant Field Values

EC2_IAM_CREDENTIALS_V1

public static final String EC2_IAM_CREDENTIALS_V1

V1 credential provider: "com.amazonaws.auth.InstanceProfileCredentialsProvider".

See Also:

Constant Field Values

EC2_IAM_CREDENTIALS_V2

public static final String EC2_IAM_CREDENTIALS_V2

V2 EC2 instance/container credential provider.

ENVIRONMENT_CREDENTIALS_V1

public static final String ENVIRONMENT_CREDENTIALS_V1

V1 env var credential provider: "com.amazonaws.auth.EnvironmentVariableCredentialsProvider".

See Also:

Constant Field Values

ENVIRONMENT_CREDENTIALS_V2

public static final String ENVIRONMENT_CREDENTIALS_V2

V2 environment variables credential provider.

PROFILE_CREDENTIALS_V1

public static final String PROFILE_CREDENTIALS_V1

V1 profile credential provider: "com.amazonaws.auth.profile.ProfileCredentialsProvider".

See Also:

Constant Field Values

PROFILE_CREDENTIALS_V2

public static final String PROFILE_CREDENTIALS_V2

V2 environment variables credential provider.

Method Detail

createAWSCredentialProviderList

public static AWSCredentialProviderList createAWSCredentialProviderList(@Nullable
                                                                        URI binding,
                                                                        org.apache.hadoop.conf.Configuration conf)
                                                                 throws IOException

Create the AWS credentials from the providers, the URI and the key Constants.AWS_CREDENTIALS_PROVIDER in the configuration.

Parameters:

binding - Binding URI -may be null

conf - filesystem configuration

Returns:

a credentials provider list

Throws:

IOException - Problems loading the providers (including reading secrets from credential files).

buildAWSProviderList

public static AWSCredentialProviderList buildAWSProviderList(@Nullable
                                                             URI binding,
                                                             org.apache.hadoop.conf.Configuration conf,
                                                             String key,
                                                             List<Class<?>> defaultValues,
                                                             Set<Class<?>> forbidden)
                                                      throws IOException

Load list of AWS credential provider/credential provider factory classes; support a forbidden list to prevent loops, mandate full secrets, etc.

Parameters:

binding - Binding URI -may be null

conf - configuration

key - configuration key to use

forbidden - a possibly empty set of forbidden classes.

defaultValues - list of default providers.

Returns:

the list of classes, possibly empty

Throws:

IOException - on a failure to load the list.