AwsCredentialsProviderFactory.java

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
//
// Copied from
// https://github.com/awslabs/aws-glue-data-catalog-client-for-apache-hive-metastore/blob/branch-3.4.0/
//

package org.apache.doris.datasource.property.common;


import software.amazon.awssdk.auth.credentials.AnonymousCredentialsProvider;
import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider;
import software.amazon.awssdk.auth.credentials.AwsCredentialsProviderChain;
import software.amazon.awssdk.auth.credentials.ContainerCredentialsProvider;
import software.amazon.awssdk.auth.credentials.EnvironmentVariableCredentialsProvider;
import software.amazon.awssdk.auth.credentials.InstanceProfileCredentialsProvider;
import software.amazon.awssdk.auth.credentials.SystemPropertyCredentialsProvider;
import software.amazon.awssdk.auth.credentials.WebIdentityTokenFileCredentialsProvider;

import java.util.ArrayList;
import java.util.List;

public final class AwsCredentialsProviderFactory {

    private AwsCredentialsProviderFactory() {
    }

    /* =========================
     * AWS SDK V1
     * ========================= */

    public static com.amazonaws.auth.AWSCredentialsProvider createV1(
            AwsCredentialsProviderMode mode) {

        switch (mode) {
            case ENV:
                return new com.amazonaws.auth.EnvironmentVariableCredentialsProvider();
            case SYSTEM_PROPERTIES:
                return new com.amazonaws.auth.SystemPropertiesCredentialsProvider();
            case WEB_IDENTITY:
                return com.amazonaws.auth.WebIdentityTokenCredentialsProvider.create();
            case CONTAINER:
                return new com.amazonaws.auth.EC2ContainerCredentialsProviderWrapper();
            case ANONYMOUS:
                throw new UnsupportedOperationException(
                        "AWS SDK V1 does not support anonymous credentials provider.");
            case INSTANCE_PROFILE:
                return new com.amazonaws.auth.InstanceProfileCredentialsProvider();
            case DEFAULT:
                return createDefaultV1();
            default:
                throw new UnsupportedOperationException(
                        "AWS SDK V1 does not support credentials provider mode: " + mode);
        }
    }

    private static com.amazonaws.auth.AWSCredentialsProvider createDefaultV1() {
        List<com.amazonaws.auth.AWSCredentialsProvider> providers = new ArrayList<>();
        providers.add(new com.amazonaws.auth.InstanceProfileCredentialsProvider());
        //lazy + env
        providers.add(com.amazonaws.auth.WebIdentityTokenCredentialsProvider.create());
        providers.add(new com.amazonaws.auth.EC2ContainerCredentialsProviderWrapper());
        providers.add(new com.amazonaws.auth.EnvironmentVariableCredentialsProvider());
        providers.add(new com.amazonaws.auth.SystemPropertiesCredentialsProvider());
        return new com.amazonaws.auth.AWSCredentialsProviderChain(
                providers.toArray(new com.amazonaws.auth.AWSCredentialsProvider[0]));
    }

    /* =========================
     * AWS SDK V2
     * ========================= */

    public static AwsCredentialsProvider createV2(
            AwsCredentialsProviderMode mode,
            boolean includeAnonymousInDefault) {
        switch (mode) {
            case ENV:
                return EnvironmentVariableCredentialsProvider.create();
            case SYSTEM_PROPERTIES:
                return SystemPropertyCredentialsProvider.create();
            case WEB_IDENTITY:
                return WebIdentityTokenFileCredentialsProvider.create();
            case CONTAINER:
                return ContainerCredentialsProvider.create();
            case INSTANCE_PROFILE:
                return InstanceProfileCredentialsProvider.create();
            case ANONYMOUS:
                return AnonymousCredentialsProvider.create();
            case DEFAULT:
                return createDefaultV2(includeAnonymousInDefault);
            default:
                throw new UnsupportedOperationException(
                        "AWS SDK V2 does not support credentials provider mode: " + mode);
        }
    }

    private static AwsCredentialsProvider createDefaultV2(
            boolean includeAnonymous) {

        List<AwsCredentialsProvider> providers = new ArrayList<>();
        providers.add(InstanceProfileCredentialsProvider.create());
        providers.add(WebIdentityTokenFileCredentialsProvider.create());
        providers.add(ContainerCredentialsProvider.create());
        providers.add(EnvironmentVariableCredentialsProvider.create());
        providers.add(SystemPropertyCredentialsProvider.create());
        if (includeAnonymous) {
            providers.add(AnonymousCredentialsProvider.create());
        }
        return AwsCredentialsProviderChain.builder()
                .credentialsProviders(providers)
                .build();
    }

    public static String getV2ClassName(AwsCredentialsProviderMode mode, boolean includeAnonymousInDefault) {
        switch (mode) {
            case ENV:
                return EnvironmentVariableCredentialsProvider.class.getName();
            case SYSTEM_PROPERTIES:
                return SystemPropertyCredentialsProvider.class.getName();
            case WEB_IDENTITY:
                return WebIdentityTokenFileCredentialsProvider.class.getName();
            case CONTAINER:
                return ContainerCredentialsProvider.class.getName();
            case INSTANCE_PROFILE:
                return InstanceProfileCredentialsProvider.class.getName();
            case ANONYMOUS:
                return AnonymousCredentialsProvider.class.getName();
            case DEFAULT:
                List<String> providers = new ArrayList<>();
                providers.add(EnvironmentVariableCredentialsProvider.class.getName());
                providers.add(SystemPropertyCredentialsProvider.class.getName());
                providers.add(WebIdentityTokenFileCredentialsProvider.class.getName());
                providers.add(ContainerCredentialsProvider.class.getName());
                providers.add(InstanceProfileCredentialsProvider.class.getName());
                if (includeAnonymousInDefault) {
                    providers.add(AnonymousCredentialsProvider.class.getName());
                }
                return String.join("+", providers);
            default:
                throw new UnsupportedOperationException(
                        "AWS SDK V2 does not support credentials provider mode: " + mode);
        }
    }
}