31 #ifndef CPL_AWS_INCLUDED_H
32 #define CPL_AWS_INCLUDED_H
42 #include <curl/curl.h>
45 CPLString CPLGetLowerCaseHexSHA256(
const void *pabyData,
size_t nBytes );
52 CPLString CPLAWSGetHeaderVal(
const struct curl_slist* psExistingHeaders,
56 CPLGetAWS_SIGN4_Signature(
const CPLString& osSecretAccessKey,
62 const struct curl_slist* psExistingHeaders,
77 const struct curl_slist* psExistingHeaders,
84 class IVSIS3LikeHandleHelper
87 std::map<CPLString, CPLString> m_oMapQueryParameters;
89 virtual void RebuildURL() = 0;
90 CPLString GetQueryString(
bool bAddEmptyValueAfterEqual)
const;
93 IVSIS3LikeHandleHelper() {}
94 virtual ~IVSIS3LikeHandleHelper() {}
96 void ResetQueryParameters();
99 virtual struct curl_slist* GetCurlHeaders(
const CPLString& osVerb,
100 const struct curl_slist* psExistingHeaders,
101 const void *pabyDataContent =
nullptr,
102 size_t nBytesContent = 0)
const = 0;
104 virtual bool AllowAutomaticRedirection() {
return true; }
105 virtual bool CanRestartOnError(
const char*,
const char* ,
106 bool ,
bool* =
nullptr) {
return false;}
108 virtual const CPLString& GetURL()
const = 0;
110 static bool GetBucketAndObjectKey(
const char* pszURI,
111 const char* pszFSPrefix,
116 static CPLString BuildCanonicalizedHeaders(
117 std::map<CPLString, CPLString>& oSortedMapHeaders,
118 const struct curl_slist* psExistingHeaders,
119 const char* pszHeaderPrefix);
124 class VSIS3HandleHelper final:
public IVSIS3LikeHandleHelper
136 bool m_bUseVirtualHosting;
138 void RebuildURL()
override;
140 static bool GetConfigurationFromEC2(
CPLString& osSecretAccessKey,
144 static bool GetConfigurationFromAWSConfigFiles(
159 VSIS3HandleHelper(
const CPLString& osSecretAccessKey,
167 bool bUseHTTPS,
bool bUseVirtualHosting);
168 ~VSIS3HandleHelper();
170 static VSIS3HandleHelper* BuildFromURI(
const char* pszURI,
171 const char* pszFSPrefix,
177 bool bUseHTTPS,
bool bUseVirtualHosting);
179 struct curl_slist* GetCurlHeaders(
181 const struct curl_slist* psExistingHeaders,
182 const void *pabyDataContent =
nullptr,
183 size_t nBytesContent = 0)
const override;
185 bool AllowAutomaticRedirection()
override {
return false; }
186 bool CanRestartOnError(
const char*,
const char* pszHeaders,
188 bool* pbUpdateMap =
nullptr)
override;
190 const CPLString& GetURL()
const override {
return m_osURL; }
191 const CPLString& GetBucket()
const {
return m_osBucket; }
192 const CPLString& GetObjectKey()
const {
return m_osObjectKey; }
193 const CPLString& GetEndpoint()
const {
return m_osEndpoint; }
194 const CPLString& GetRegion()
const {
return m_osRegion; }
195 const CPLString& GetRequestPayer()
const {
return m_osRequestPayer; }
196 bool GetVirtualHosting()
const {
return m_bUseVirtualHosting; }
197 void SetEndpoint(
const CPLString &osStr);
199 void SetRequestPayer(
const CPLString &osStr);
200 void SetVirtualHosting(
bool b);
204 static void CleanMutex();
205 static void ClearCache();
208 class VSIS3UpdateParams
214 bool m_bUseVirtualHosting;
216 VSIS3UpdateParams() :
217 m_bUseVirtualHosting(false) {}
219 explicit VSIS3UpdateParams(
const VSIS3HandleHelper* poHelper) :
220 m_osRegion(poHelper->GetRegion()),
221 m_osEndpoint(poHelper->GetEndpoint()),
222 m_osRequestPayer(poHelper->GetRequestPayer()),
223 m_bUseVirtualHosting(poHelper->GetVirtualHosting()) {}
225 void UpdateHandlerHelper(VSIS3HandleHelper* poHelper) {
226 poHelper->SetRegion(m_osRegion);
227 poHelper->SetEndpoint(m_osEndpoint);
228 poHelper->SetRequestPayer(m_osRequestPayer);
229 poHelper->SetVirtualHosting(m_bUseVirtualHosting);
CPLHTTPResult * CPLHTTPFetch(const char *pszURL, CSLConstList papszOptions)
Fetch a document from an url and return in a string.
Definition: cpl_http.cpp:620
const char * CPLReadLineL(VSILFILE *)
Definition: cpl_conv.cpp:630
char ** CSLTokenizeString2(const char *pszString, const char *pszDelimiter, int nCSLTFlags)
Definition: cpl_string.cpp:836
unsigned char GByte
Definition: cpl_port.h:213
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read bytes from file.
Definition: cpl_vsil.cpp:1146
int CPLPrintTime(char *, int, const char *, const struct tm *, const char *)
Definition: cpl_conv.cpp:1500
void CPLHTTPDestroyResult(CPLHTTPResult *psResult)
Clean the memory associated with the return value of CPLHTTPFetch()
Definition: cpl_http.cpp:1932
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:447
void CPLPopErrorHandler(void)
Definition: cpl_error.cpp:1223
#define CSLT_HONOURSTRINGS
Definition: cpl_string.h:83
const char * CSLFetchNameValueDef(CSLConstList papszStrList, const char *pszName, const char *pszDefault)
Definition: cpl_string.cpp:1646
char ** CSLSetNameValue(char **papszStrList, const char *pszName, const char *pszValue)
Definition: cpl_string.cpp:1877
Convenient string class based on std::string.
Definition: cpl_string.h:336
CPLXMLNode * CPLParseXMLString(const char *)
Parse an XML string into tree form.
Definition: cpl_minixml.cpp:614
Definition: cpl_minixml.h:66
#define EQUAL(a, b)
Definition: cpl_port.h:559
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:928
void CPLPushErrorHandler(CPLErrorHandler)
Definition: cpl_error.cpp:1166
CPLStringList & SetNameValue(const char *pszKey, const char *pszValue)
Definition: cplstringlist.cpp:422
bool CPLTestBool(const char *pszValue)
Definition: cpl_string.cpp:1526
char ** CSLConstList
Definition: cpl_port.h:1184
Definition: cpl_http.h:61
GByte * pabyData
Definition: cpl_http.h:77
void CPLDestroyXMLNode(CPLXMLNode *)
Destroy a tree.
Definition: cpl_minixml.cpp:1412
void CPLDebug(const char *, const char *,...)
Definition: cpl_error.cpp:544
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:558
#define STARTS_WITH(a, b)
Definition: cpl_port.h:568
const char * CPLSPrintf(const char *fmt,...)
Definition: cpl_string.cpp:977
const char * CPLGetXMLValue(const CPLXMLNode *poRoot, const char *pszPath, const char *pszDefault)
Fetch element/attribute value.
Definition: cpl_minixml.cpp:1645
Definition: cpl_multiproc.h:139
void CPLError(CPLErr eErrClass, CPLErrorNum err_no, const char *fmt,...)
Definition: cpl_error.cpp:232
const char * CPLParseNameValue(const char *pszNameValue, char **ppszKey)
Definition: cpl_string.cpp:1754
CPLSTRING_DLL CPLString & Trim()
Definition: cplstring.cpp:214
int nStatus
Definition: cpl_http.h:63
void CSLDestroy(char **papszStrList)
Definition: cpl_string.cpp:200
long long GIntBig
Definition: cpl_port.h:246
struct stat64 VSIStatBufL
Definition: cpl_vsi.h:191
#define EQUALN(a, b, n)
Definition: cpl_port.h:557
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:818
void CPLQuietErrorHandler(CPLErr, CPLErrorNum, const char *)
Definition: cpl_error.cpp:948
#define CPLFree
Definition: cpl_conv.h:81
const char * FetchNameValueDef(const char *pszKey, const char *pszDefault) const
Definition: cplstringlist.cpp:745
const char * CPLGetConfigOption(const char *, const char *)
Definition: cpl_conv.cpp:1690
FILE VSILFILE
Definition: cpl_vsi.h:155
#define STARTS_WITH_CI(a, b)
Definition: cpl_port.h:570
#define CPLE_AppDefined
Definition: cpl_error.h:99
Generated for GDAL by
1.8.17.