AWSCredentialsProvider.h

Go to the documentation of this file.

/*
  * Copyright 2010-2016 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.
  */


#pragma once

#include <aws/core/Core_EXPORTS.h>

#include <aws/core/utils/UnreferencedParam.h>
#include <aws/core/utils/memory/stl/AWSMap.h>
#include <aws/core/utils/memory/stl/AWSString.h>

#include <memory>
#include <mutex>

namespace Aws
{
    namespace Internal
    {
        class EC2MetadataClient; //forward declaration;
    } // namespace Internal
    namespace Auth
    {
        static int REFRESH_THRESHOLD = 1000 * 60 * 15;

        class AWS_CORE_API AWSCredentials
        {
        public:
            AWSCredentials(const Aws::String& accessKeyId, const Aws::String& secretKey, const Aws::String& sessionToken = "") :
                m_accessKeyId(accessKeyId), m_secretKey(secretKey), m_sessionToken(sessionToken)
            {
            }

            inline const Aws::String& GetAWSAccessKeyId() const
            {
                return m_accessKeyId;
            }

            inline const Aws::String& GetAWSSecretKey() const
            {
                return m_secretKey;
            }

            inline const Aws::String& GetSessionToken() const
            {
                return m_sessionToken;
            }

            inline void SetAWSAccessKeyId(const Aws::String& accessKeyId)
            {
                m_accessKeyId = accessKeyId;
            }

            inline void SetAWSSecretKey(const Aws::String& secretKey)
            {
                m_secretKey = secretKey;
            }

            inline void SetSessionToken(const Aws::String& sessionToken)
            {
                m_sessionToken = sessionToken;
            }

            inline void SetAWSAccessKeyId(const char* accessKeyId)
            {
                m_accessKeyId = accessKeyId;
            }

            inline void SetAWSSecretKey(const char* secretKey)
            {
                m_secretKey = secretKey;
            }

            inline void SetSessionToken(const char* sessionToken)
            {
                m_sessionToken = sessionToken;
            }

        private:
            Aws::String m_accessKeyId;
            Aws::String m_secretKey;
            Aws::String m_sessionToken;
        };

        class AWS_CORE_API AWSCredentialsProvider
        {
        public:
            AWSCredentialsProvider() : m_lastLoadedMs(0)
            {
            }

            virtual ~AWSCredentialsProvider() = default;

            virtual AWSCredentials GetAWSCredentials() = 0;

        protected:
            virtual bool IsTimeToRefresh(long reloadFrequency);

        private:
            long long m_lastLoadedMs;
        };

        class AWS_CORE_API AnonymousAWSCredentialsProvider : public AWSCredentialsProvider
        {
        public:
            inline AWSCredentials GetAWSCredentials() override { return AWSCredentials("", ""); }
        };

        class AWS_CORE_API SimpleAWSCredentialsProvider : public AWSCredentialsProvider
        {
        public:
            inline SimpleAWSCredentialsProvider(const Aws::String& awsAccessKeyId, const Aws::String& awsSecretAccessKey, const Aws::String& sessionToken = "")
                : m_accessKeyId(awsAccessKeyId), m_secretAccessKey(awsSecretAccessKey), m_sessionToken(sessionToken)
            { }

            inline SimpleAWSCredentialsProvider(const AWSCredentials& credentials)
                : m_accessKeyId(credentials.GetAWSAccessKeyId()), m_secretAccessKey(credentials.GetAWSSecretKey()),
                m_sessionToken(credentials.GetSessionToken())
            { }

            inline AWSCredentials GetAWSCredentials() override
            {
                return AWSCredentials(m_accessKeyId, m_secretAccessKey, m_sessionToken);
            }

        private:
            Aws::String m_accessKeyId;
            Aws::String m_secretAccessKey;
            Aws::String m_sessionToken;
        };

        class AWS_CORE_API EnvironmentAWSCredentialsProvider : public AWSCredentialsProvider
        {
        public:
            AWSCredentials GetAWSCredentials() override;
        };

        class AWS_CORE_API ProfileConfigFileAWSCredentialsProvider : public AWSCredentialsProvider
        {
        public:

            ProfileConfigFileAWSCredentialsProvider(long refreshRateMs = REFRESH_THRESHOLD);

            ProfileConfigFileAWSCredentialsProvider(const char* profile, long refreshRateMs = REFRESH_THRESHOLD);

            AWSCredentials GetAWSCredentials() override;

            static Aws::String GetProfileFilename();

            static Aws::String GetProfileFilenameNoPath();

            static Aws::String GetProfileDirectory();

        private:

            void RefreshIfExpired();
            static Aws::Map<Aws::String, Aws::String> ParseProfileConfigFile(const Aws::String& filename);

            Aws::String m_fileName;
            Aws::String m_profileToUse;
            std::shared_ptr<AWSCredentials> m_credentials;
            mutable std::mutex m_reloadMutex;
            long m_loadFrequencyMs;
        };

        class AWS_CORE_API InstanceProfileCredentialsProvider : public AWSCredentialsProvider
        {
        public:
            InstanceProfileCredentialsProvider(long refreshRateMs = REFRESH_THRESHOLD);

            InstanceProfileCredentialsProvider(const std::shared_ptr<Internal::EC2MetadataClient>&, long refreshRateMs = REFRESH_THRESHOLD);

            AWSCredentials GetAWSCredentials() override;

        private:
            void RefreshIfExpired();

            std::shared_ptr<Internal::EC2MetadataClient> m_metadataClient;
            std::shared_ptr<AWSCredentials> m_credentials;
            long m_loadFrequencyMs;
            mutable std::mutex m_reloadMutex;
        };
    } // namespace Auth
} // namespace Aws