com.amazonaws.auth.profile.internal.ProfilesConfigFileLoader Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file 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.
 */
package com.amazonaws.auth.profile.internal;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Scanner;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import com.amazonaws.AmazonClientException;
import com.amazonaws.auth.BasicAWSCredentials;
import com.amazonaws.auth.BasicSessionCredentials;

public class ProfilesConfigFileLoader {

    private static final Log LOG = LogFactory.getLog(ProfilesConfigFileLoader.class);

    public static Map loadProfiles(File file) {
        if (file == null) {
            throw new IllegalArgumentException(
                    "Unable to load AWS profiles: specified file is null.");
        }

        if (!file.exists() || !file.isFile()) {
            throw new IllegalArgumentException(
                    "AWS credential profiles file not found in the given path: "
                            + file.getAbsolutePath());
        }

        FileInputStream fis = null;
        try {
            fis = new FileInputStream(file);
            return loadProfiles(fis);
        } catch (IOException ioe) {
            throw new AmazonClientException(
                    "Unable to load AWS credential profiles file at: " + file.getAbsolutePath(), ioe);
        } finally {
            if (fis != null) try {fis.close();} catch (IOException ioe) {}
        }
    }

    /**
     * Loads the credential profiles from the given input stream.
     *
     * @param is input stream from where the profile details are read.
     * @throws IOException
     */
    private static Map loadProfiles(InputStream is) throws IOException {
        ProfilesConfigFileLoaderHelper helper = new ProfilesConfigFileLoaderHelper();
        Map> allProfileProperties = helper.parseProfileProperties(new Scanner(is));

        // Convert the loaded property map to credential objects
        Map profilesByName = new LinkedHashMap();

        for (Entry> entry : allProfileProperties.entrySet()) {
            String profileName = entry.getKey();
            Map properties = entry.getValue();

            if (profileName.startsWith("profile ")) {
                LOG.warn("The legacy profile format requires the 'profile ' prefix before the profile name. "
                        + "The latest code does not require such prefix, and will consider it as part of the profile name. "
                        + "Please remove the prefix if you are seeing this warning.");
            }

            String accessKey    = properties.get(Profile.AWS_ACCESS_KEY_ID);
            String secretKey    = properties.get(Profile.AWS_SECRET_ACCESS_KEY);
            String sessionToken = properties.get(Profile.AWS_SESSION_TOKEN);

            assertParameterNotEmpty(profileName,
                                  "Unable to load credentials into profile: ProfileName is empty.");
            if (accessKey == null) {
                throw new AmazonClientException(
                        String.format("Unable to load credentials into profile [%s]: AWS Access Key ID is not specified.",
                                      profileName));
            }
            if (secretKey == null) {
                throw new AmazonClientException(
                        String.format("Unable to load credentials into profile [%s]: AWS Secret Access Key is not specified.",
                                profileName));
            }

            if (sessionToken == null) {
                profilesByName.put(
                        profileName,
                        new Profile(profileName,
                                    new BasicAWSCredentials(accessKey, secretKey)));
            } else {
                if (sessionToken.isEmpty()) {
                    throw new AmazonClientException(
                            String.format("Unable to load credentials into profile [%s]: AWS Session Token is empty.",
                                    profileName));
                }

                profilesByName.put(
                        profileName,
                        new Profile(profileName,
                                    new BasicSessionCredentials(accessKey, secretKey, sessionToken)));
            }
        }

        return profilesByName;
    }

    /**
     * 
     * Asserts that the specified parameter value is neither empty
     * nor null, and if it is, throws an AmazonClientException with
     * the specified error message.
     * 
     *
     * @param parameterValue
     *            The parameter value being checked.
     * @param errorMessage
     *            The error message to include in the AmazonClientException if
     *            the specified parameter value is empty.
     */
    private static void assertParameterNotEmpty(String parameterValue, String errorMessage) {
        if (parameterValue == null || parameterValue.isEmpty())
            throw new AmazonClientException(errorMessage);
    }

    /**
     * Implementation of AbstractProfilesConfigFileScanner that groups profile
     * properties into a map while scanning through the credentials profile.
     */
    private static class ProfilesConfigFileLoaderHelper extends AbstractProfilesConfigFileScanner {

        /**
         * Map from the parsed profile name to the map of all the property values
         * included the specific profile
         */
        protected final Map> allProfileProperties = new LinkedHashMap>();

        /**
         * Parses the input and returns a map of all the profile properties.
         */
        public Map> parseProfileProperties(Scanner scanner) {
            allProfileProperties.clear();
            run(scanner);
            return new LinkedHashMap>(allProfileProperties);
        }

        @Override
        protected void onEmptyOrCommentLine(String profileName, String line) {
            // Ignore empty or comment line
        }

        @Override
        protected void onProfileStartingLine(String newProfileName, String line) {
            // If the same profile name has already been declared, clobber the
            // previous one
            allProfileProperties.put(newProfileName, new HashMap());
        }

        @Override
        protected void onProfileEndingLine(String prevProfileName) {
            // No-op
        }

        @Override
        protected void onProfileProperty(String profileName,
                String propertyKey, String propertyValue,
                boolean isSupportedProperty, String line) {
            if ( !isSupportedProperty ) {
                LOG.info(String.format(
                        "Skip unsupported property name %s in profile [%s].",
                        propertyKey, profileName));
                return;
            }

            // Not strictly necessary, since the abstract super class guarantees
            // onProfileStartingLine is always invoked before this method.
            // Just to be safe...
            if (allProfileProperties.get(profileName) == null) {
                allProfileProperties.put(profileName, new HashMap());
            }

            Map properties = allProfileProperties.get(profileName);

            if (properties.containsKey(propertyKey)) {
                throw new IllegalArgumentException(
                        "Duplicate property values for ["
                                + propertyKey + "].");
            }

            properties.put(propertyKey, propertyValue);
        }

        @Override
        protected void onEndOfFile() {
            // No-op
        }
    }

}