/********************************************************************** * * Name: cpl_aws.h * Project: CPL - Common Portability Library * Purpose: Amazon Web Services routines * Author: Even Rouault * ********************************************************************** * Copyright (c) 2015, Even Rouault * * SPDX-License-Identifier: MIT ****************************************************************************/ #ifndef CPL_AWS_INCLUDED_H #define CPL_AWS_INCLUDED_H #ifndef DOXYGEN_SKIP #ifdef HAVE_CURL #include #include #include "cpl_string.h" #include #include std::string CPLGetLowerCaseHexSHA256(const void *pabyData, size_t nBytes); std::string CPLGetLowerCaseHexSHA256(const std::string &osStr); std::string CPLGetAWS_SIGN4_Timestamp(GIntBig timestamp); std::string CPLAWSURLEncode(const std::string &osURL, bool bEncodeSlash = true); std::string CPLAWSGetHeaderVal(const struct curl_slist *psExistingHeaders, const char *pszKey); class IVSIS3LikeHandleHelper { CPL_DISALLOW_COPY_ASSIGN(IVSIS3LikeHandleHelper) protected: std::map m_oMapQueryParameters{}; virtual void RebuildURL() = 0; std::string GetQueryString(bool bAddEmptyValueAfterEqual) const; public: IVSIS3LikeHandleHelper(); virtual ~IVSIS3LikeHandleHelper(); void ResetQueryParameters(); void AddQueryParameter(const std::string &osKey, const std::string &osValue); virtual struct curl_slist * GetCurlHeaders(const std::string &osVerb, struct curl_slist *psHeaders, const void *pabyDataContent = nullptr, size_t nBytesContent = 0) const = 0; virtual bool AllowAutomaticRedirection() { return true; } virtual bool CanRestartOnError(const char *, const char * /* pszHeaders*/, bool /*bSetError*/) { return false; } virtual const std::string &GetURL() const = 0; std::string GetURLNoKVP() const; virtual std::string GetCopySourceHeader() const { return std::string(); } virtual const char *GetMetadataDirectiveREPLACE() const { return ""; } static bool GetBucketAndObjectKey(const char *pszURI, const char *pszFSPrefix, bool bAllowNoObject, std::string &osBucketOut, std::string &osObjectKeyOut); static std::string BuildCanonicalizedHeaders( std::map &oSortedMapHeaders, const struct curl_slist *psExistingHeaders, const char *pszHeaderPrefix); static std::string GetRFC822DateTime(); }; enum class AWSCredentialsSource { UNINITIALIZED, NO_SIGN_REQUEST, REGULAR, // credentials from env variables or ~/.aws/crediential EC2, // credentials from EC2 private networking WEB_IDENTITY, // credentials from Web Identity Token // See // https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html ASSUMED_ROLE, // credentials from an STS assumed role // See // https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-cli.html // and // https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html SSO, // credentials from Single-Sign On // credentials from credential_process command // See https://docs.aws.amazon.com/sdkref/latest/guide/feature-process-credentials.html CREDENTIAL_PROCESS, }; class VSIS3HandleHelper final : public IVSIS3LikeHandleHelper { CPL_DISALLOW_COPY_ASSIGN(VSIS3HandleHelper) std::string m_osURL{}; std::string m_osService{}; mutable std::string m_osSecretAccessKey{}; mutable std::string m_osAccessKeyId{}; mutable std::string m_osSessionToken{}; std::string m_osS3SessionToken{}; std::string m_osEndpoint{}; std::string m_osRegion{}; std::string m_osRequestPayer{}; std::string m_osBucket{}; std::string m_osObjectKey{}; bool m_bUseHTTPS = false; bool m_bUseVirtualHosting = false; bool m_bIsDirectoryBucket = false; AWSCredentialsSource m_eCredentialsSource = AWSCredentialsSource::REGULAR; void RebuildURL() override; static bool GetOrRefreshTemporaryCredentialsForRole( bool bForceRefresh, std::string &osSecretAccessKey, std::string &osAccessKeyId, std::string &osSessionToken, std::string &osRegion); static bool GetOrRefreshTemporaryCredentialsForSSO( bool bForceRefresh, std::string &osSecretAccessKey, std::string &osAccessKeyId, std::string &osSessionToken, std::string &osRegion); static bool GetOrRefreshTemporaryCredentialsFromProcess( bool bForceRefresh, std::string &osSecretAccessKey, std::string &osAccessKeyId, std::string &osSessionToken); static bool GetConfigurationFromAssumeRoleWithWebIdentity( bool bForceRefresh, const std::string &osPathForOption, const std::string &osRoleArnIn, const std::string &osWebIdentityTokenFileIn, std::string &osSecretAccessKey, std::string &osAccessKeyId, std::string &osSessionToken); static bool GetConfigurationFromEC2(bool bForceRefresh, const std::string &osPathForOption, std::string &osSecretAccessKey, std::string &osAccessKeyId, std::string &osSessionToken); static bool GetConfigurationFromAWSConfigFiles( const std::string &osPathForOption, const char *pszProfile, std::string &osSecretAccessKey, std::string &osAccessKeyId, std::string &osSessionToken, std::string &osRegion, std::string &osCredentials, std::string &osRoleArn, std::string &osSourceProfile, std::string &osExternalId, std::string &osMFASerial, std::string &osRoleSessionName, std::string &osWebIdentityTokenFile, std::string &osSSOStartURL, std::string &osSSOAccountID, std::string &osSSORoleName, std::string &osSSOSession, std::string &osCredentialProcess); static bool GetConfiguration(const std::string &osPathForOption, CSLConstList papszOptions, std::string &osSecretAccessKey, std::string &osAccessKeyId, std::string &osSessionToken, std::string &osRegion, AWSCredentialsSource &eCredentialsSource); void RefreshCredentials(const std::string &osPathForOption, bool bForceRefresh) const; protected: public: VSIS3HandleHelper( const std::string &osService, const std::string &osSecretAccessKey, const std::string &osAccessKeyId, const std::string &osSessionToken, const std::string &osS3SessionToken, const std::string &osEndpoint, const std::string &osRegion, const std::string &osRequestPayer, const std::string &osBucket, const std::string &osObjectKey, bool bUseHTTPS, bool bUseVirtualHosting, AWSCredentialsSource eCredentialsSource, bool bIsDirectoryBucket); ~VSIS3HandleHelper() override; static VSIS3HandleHelper *BuildFromURI(const char *pszURI, const char *pszFSPrefix, bool bAllowNoObject, CSLConstList papszOptions = nullptr); static std::string BuildURL(const std::string &osEndpoint, const std::string &osBucket, const std::string &osObjectKey, bool bUseHTTPS, bool bUseVirtualHosting); struct curl_slist *GetCurlHeaders(const std::string &osVerb, struct curl_slist *psHeaders, const void *pabyDataContent = nullptr, size_t nBytesContent = 0) const override; bool IsDirectoryBucket() const { return m_bIsDirectoryBucket; } bool AllowAutomaticRedirection() override { return false; } bool CanRestartOnError(const char *, const char *pszHeaders, bool bSetError) override; const std::string &GetURL() const override { return m_osURL; } const std::string &GetBucket() const { return m_osBucket; } const std::string &GetObjectKey() const { return m_osObjectKey; } const std::string &GetEndpoint() const { return m_osEndpoint; } const std::string &GetRegion() const { return m_osRegion; } const std::string &GetAccessKeyId() const { return m_osAccessKeyId; } const std::string &GetSecretAccessKey() const { return m_osSecretAccessKey; } const std::string &GetSessionToken() const { return m_osSessionToken; } AWSCredentialsSource GetCredentialsSource() const { return m_eCredentialsSource; } const std::string &GetRequestPayer() const { return m_osRequestPayer; } bool GetVirtualHosting() const { return m_bUseVirtualHosting; } bool GetUseHTTPS() const { return m_bUseHTTPS; } void SetEndpoint(const std::string &osStr); void SetRegion(const std::string &osStr); void SetRequestPayer(const std::string &osStr); void SetVirtualHosting(bool b); std::string GetCopySourceHeader() const override { return "x-amz-copy-source"; } const char *GetMetadataDirectiveREPLACE() const override { return "x-amz-metadata-directive: REPLACE"; } std::string GetSignedURL(CSLConstList papszOptions); static void CleanMutex(); static void ClearCache(); }; class VSIS3UpdateParams { private: std::string m_osRegion{}; std::string m_osEndpoint{}; std::string m_osRequestPayer{}; bool m_bUseVirtualHosting = false; explicit VSIS3UpdateParams(const VSIS3HandleHelper *poHelper) : m_osRegion(poHelper->GetRegion()), m_osEndpoint(poHelper->GetEndpoint()), m_osRequestPayer(poHelper->GetRequestPayer()), m_bUseVirtualHosting(poHelper->GetVirtualHosting()) { } void UpdateHandlerHelper(VSIS3HandleHelper *poHelper) { poHelper->SetRegion(m_osRegion); poHelper->SetEndpoint(m_osEndpoint); poHelper->SetRequestPayer(m_osRequestPayer); poHelper->SetVirtualHosting(m_bUseVirtualHosting); } static std::mutex gsMutex; static std::map goMapBucketsToS3Params; public: VSIS3UpdateParams() = default; static void UpdateMapFromHandle(VSIS3HandleHelper *poS3HandleHelper); static void UpdateHandleFromMap(VSIS3HandleHelper *poS3HandleHelper); static void ClearCache(); }; #endif /* HAVE_CURL */ #endif /* #ifndef DOXYGEN_SKIP */ #endif /* CPL_AWS_INCLUDED_H */