31 #ifndef CPL_AWS_INCLUDED_H
32 #define CPL_AWS_INCLUDED_H
43 #include <curl/curl.h>
46 CPLString CPLGetLowerCaseHexSHA256(
const void *pabyData,
size_t nBytes );
53 CPLString CPLAWSGetHeaderVal(
const struct curl_slist* psExistingHeaders,
57 CPLGetAWS_SIGN4_Signature(
const CPLString& osSecretAccessKey,
63 const struct curl_slist* psExistingHeaders,
78 const struct curl_slist* psExistingHeaders,
85 class IVSIS3LikeHandleHelper
90 std::map<CPLString, CPLString> m_oMapQueryParameters{};
92 virtual void RebuildURL() = 0;
93 CPLString GetQueryString(
bool bAddEmptyValueAfterEqual)
const;
96 IVSIS3LikeHandleHelper() =
default;
97 virtual ~IVSIS3LikeHandleHelper() =
default;
99 void ResetQueryParameters();
102 virtual struct curl_slist* GetCurlHeaders(
const CPLString& osVerb,
103 const struct curl_slist* psExistingHeaders,
104 const void *pabyDataContent =
nullptr,
105 size_t nBytesContent = 0)
const = 0;
107 virtual bool AllowAutomaticRedirection() {
return true; }
108 virtual bool CanRestartOnError(
const char*,
const char* ,
109 bool ,
bool* =
nullptr) {
return false;}
111 virtual const CPLString& GetURL()
const = 0;
113 virtual CPLString GetCopySourceHeader()
const {
return std::string(); }
115 static bool GetBucketAndObjectKey(
const char* pszURI,
116 const char* pszFSPrefix,
121 static CPLString BuildCanonicalizedHeaders(
122 std::map<CPLString, CPLString>& oSortedMapHeaders,
123 const struct curl_slist* psExistingHeaders,
124 const char* pszHeaderPrefix);
129 class VSIS3HandleHelper final:
public IVSIS3LikeHandleHelper
142 bool m_bUseHTTPS =
false;
143 bool m_bUseVirtualHosting =
false;
144 bool m_bFromEC2 =
false;
146 void RebuildURL()
override;
148 static bool GetConfigurationFromEC2(
CPLString& osSecretAccessKey,
152 static bool GetConfigurationFromAWSConfigFiles(
168 VSIS3HandleHelper(
const CPLString& osSecretAccessKey,
176 bool bUseHTTPS,
bool bUseVirtualHosting,
bool bFromEC2);
177 ~VSIS3HandleHelper();
179 static VSIS3HandleHelper* BuildFromURI(
const char* pszURI,
180 const char* pszFSPrefix,
186 bool bUseHTTPS,
bool bUseVirtualHosting);
188 struct curl_slist* GetCurlHeaders(
190 const struct curl_slist* psExistingHeaders,
191 const void *pabyDataContent =
nullptr,
192 size_t nBytesContent = 0)
const override;
194 bool AllowAutomaticRedirection()
override {
return false; }
195 bool CanRestartOnError(
const char*,
const char* pszHeaders,
197 bool* pbUpdateMap =
nullptr)
override;
199 const CPLString& GetURL()
const override {
return m_osURL; }
200 const CPLString& GetBucket()
const {
return m_osBucket; }
201 const CPLString& GetObjectKey()
const {
return m_osObjectKey; }
202 const CPLString& GetEndpoint()
const {
return m_osEndpoint; }
203 const CPLString& GetRegion()
const {
return m_osRegion; }
204 const CPLString& GetRequestPayer()
const {
return m_osRequestPayer; }
205 bool GetVirtualHosting()
const {
return m_bUseVirtualHosting; }
206 void SetEndpoint(
const CPLString &osStr);
208 void SetRequestPayer(
const CPLString &osStr);
209 void SetVirtualHosting(
bool b);
211 CPLString GetCopySourceHeader()
const override {
return "x-amz-copy-source"; }
215 static void CleanMutex();
216 static void ClearCache();
219 class VSIS3UpdateParams
225 bool m_bUseVirtualHosting =
false;
227 VSIS3UpdateParams() =
default;
229 explicit VSIS3UpdateParams(
const VSIS3HandleHelper* poHelper) :
230 m_osRegion(poHelper->GetRegion()),
231 m_osEndpoint(poHelper->GetEndpoint()),
232 m_osRequestPayer(poHelper->GetRequestPayer()),
233 m_bUseVirtualHosting(poHelper->GetVirtualHosting()) {}
235 void UpdateHandlerHelper(VSIS3HandleHelper* poHelper) {
236 poHelper->SetRegion(m_osRegion);
237 poHelper->SetEndpoint(m_osEndpoint);
238 poHelper->SetRequestPayer(m_osRequestPayer);
239 poHelper->SetVirtualHosting(m_bUseVirtualHosting);
242 static std::mutex gsMutex;
243 static std::map< CPLString, VSIS3UpdateParams > goMapBucketsToS3Params;
244 static void UpdateMapFromHandle( IVSIS3LikeHandleHelper* poHandleHelper );
245 static void UpdateHandleFromMap( IVSIS3LikeHandleHelper* poHandleHelper );
246 static void ClearCache();