com.azure.identity.EnvironmentCredential Maven / Gradle / Ivy

Go to download
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.identity;

import com.azure.core.annotation.Immutable;
import com.azure.core.credential.AccessToken;
import com.azure.core.credential.TokenCredential;
import com.azure.core.credential.TokenRequestContext;
import com.azure.core.util.Configuration;
import com.azure.core.util.logging.ClientLogger;
import com.azure.identity.implementation.IdentityClientOptions;
import reactor.core.publisher.Mono;

/**
 * A credential provider that provides token credentials based on environment variables.  The environment variables
 * expected are:
 * 
 *     {@link Configuration#PROPERTY_AZURE_CLIENT_ID AZURE_CLIENT_ID}
 *     {@link Configuration#PROPERTY_AZURE_CLIENT_SECRET AZURE_CLIENT_SECRET}
 *     {@link Configuration#PROPERTY_AZURE_TENANT_ID AZURE_TENANT_ID}
 * 
 * or:
 * 
 *     {@link Configuration#PROPERTY_AZURE_CLIENT_ID AZURE_CLIENT_ID}
 *     {@link Configuration#PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH AZURE_CLIENT_CERTIFICATE_PATH}
 *     {@link Configuration#PROPERTY_AZURE_TENANT_ID AZURE_TENANT_ID}
 * 
 * or:
 * 
 *     {@link Configuration#PROPERTY_AZURE_CLIENT_ID AZURE_CLIENT_ID}
 *     {@link Configuration#PROPERTY_AZURE_USERNAME AZURE_USERNAME}
 *     {@link Configuration#PROPERTY_AZURE_PASSWORD AZURE_PASSWORD}
 * 
 */
@Immutable
public class EnvironmentCredential implements TokenCredential {
    private final Configuration configuration;
    private final IdentityClientOptions identityClientOptions;
    private final ClientLogger logger = new ClientLogger(EnvironmentCredential.class);
    private final TokenCredential tokenCredential;

    /**
     * Creates an instance of the default environment credential provider.
     *
     * @param identityClientOptions the options for configuring the identity client
     */
    EnvironmentCredential(IdentityClientOptions identityClientOptions) {
        this.configuration = Configuration.getGlobalConfiguration().clone();
        this.identityClientOptions = identityClientOptions;
        TokenCredential targetCredential = null;

        String clientId = configuration.get(Configuration.PROPERTY_AZURE_CLIENT_ID);
        String tenantId = configuration.get(Configuration.PROPERTY_AZURE_TENANT_ID);
        String clientSecret = configuration.get(Configuration.PROPERTY_AZURE_CLIENT_SECRET);
        String certPath = configuration.get(Configuration.PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH);
        String username = configuration.get(Configuration.PROPERTY_AZURE_USERNAME);
        String password = configuration.get(Configuration.PROPERTY_AZURE_PASSWORD);
        if (verifyNotNull(clientId)) {
            if (verifyNotNull(tenantId, clientSecret)) {
                targetCredential = new ClientSecretCredential(tenantId, clientId, clientSecret, identityClientOptions);
            } else if (verifyNotNull(tenantId, certPath)) {
                targetCredential = new ClientCertificateCredential(tenantId, clientId, certPath,
                        null, identityClientOptions);
            } else if (verifyNotNull(username, password)) {
                targetCredential = new UsernamePasswordCredential(clientId,
                        tenantId,
                        username,
                        password,
                        identityClientOptions);
            }
        }
        tokenCredential = targetCredential;
    }

    @Override
    public Mono getToken(TokenRequestContext request) {
        if (tokenCredential == null) {
            return Mono.error(logger.logExceptionAsError(new CredentialUnavailableException(
                    "Cannot create any credentials with the current environment variables")));
        } else {
            return tokenCredential.getToken(request);
        }
    }

    private boolean verifyNotNull(String... configs) {
        for (String config: configs) {
            if (config == null) {
                return false;
            }
        }
        return true;
    }
}