OGR
cpl_aws.h
1 /**********************************************************************
2  * $Id: cpl_aws.h 1d0f559204e90d0e54d4aebe6ea8b65f0851be69 2018-06-20 16:38:42 +0200 Even Rouault $
3  *
4  * Name: cpl_aws.h
5  * Project: CPL - Common Portability Library
6  * Purpose: Amazon Web Services routines
7  * Author: Even Rouault <even.rouault at spatialys.com>
8  *
9  **********************************************************************
10  * Copyright (c) 2015, Even Rouault <even.rouault at spatialys.com>
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a
13  * copy of this software and associated documentation files (the "Software"),
14  * to deal in the Software without restriction, including without limitation
15  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16  * and/or sell copies of the Software, and to permit persons to whom the
17  * Software is furnished to do so, subject to the following conditions:
18  *
19  * The above copyright notice and this permission notice shall be included
20  * in all copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28  * DEALINGS IN THE SOFTWARE.
29  ****************************************************************************/
30 
31 #ifndef CPL_AWS_INCLUDED_H
32 #define CPL_AWS_INCLUDED_H
33 
34 #ifndef DOXYGEN_SKIP
35 
36 #ifdef HAVE_CURL
37 
38 #include <cstddef>
39 
40 #include "cpl_string.h"
41 
42 #include <curl/curl.h>
43 #include <map>
44 
45 CPLString CPLGetLowerCaseHexSHA256( const void *pabyData, size_t nBytes );
46 CPLString CPLGetLowerCaseHexSHA256( const CPLString& osStr );
47 
48 CPLString CPLGetAWS_SIGN4_Timestamp();
49 
50 CPLString CPLAWSURLEncode(const CPLString& osURL, bool bEncodeSlash = true);
51 
52 CPLString CPLAWSGetHeaderVal(const struct curl_slist* psExistingHeaders,
53  const char* pszKey);
54 
56 CPLGetAWS_SIGN4_Signature( const CPLString& osSecretAccessKey,
57  const CPLString& osAccessToken,
58  const CPLString& osRegion,
59  const CPLString& osRequestPayer,
60  const CPLString& osService,
61  const CPLString& osVerb,
62  const struct curl_slist* psExistingHeaders,
63  const CPLString& osHost,
64  const CPLString& osCanonicalURI,
65  const CPLString& osCanonicalQueryString,
66  const CPLString& osXAMZContentSHA256,
67  const CPLString& osTimestamp,
68  CPLString& osSignedHeaders );
69 
70 CPLString CPLGetAWS_SIGN4_Authorization(const CPLString& osSecretAccessKey,
71  const CPLString& osAccessKeyId,
72  const CPLString& osAccessToken,
73  const CPLString& osRegion,
74  const CPLString& osRequestPayer,
75  const CPLString& osService,
76  const CPLString& osVerb,
77  const struct curl_slist* psExistingHeaders,
78  const CPLString& osHost,
79  const CPLString& osCanonicalURI,
80  const CPLString& osCanonicalQueryString,
81  const CPLString& osXAMZContentSHA256,
82  const CPLString& osTimestamp);
83 
84 class IVSIS3LikeHandleHelper
85 {
86 protected:
87  std::map<CPLString, CPLString> m_oMapQueryParameters;
88 
89  virtual void RebuildURL() = 0;
90  CPLString GetQueryString(bool bAddEmptyValueAfterEqual) const;
91 
92 public:
93  IVSIS3LikeHandleHelper() {}
94  virtual ~IVSIS3LikeHandleHelper() {}
95 
96  void ResetQueryParameters();
97  void AddQueryParameter(const CPLString& osKey, const CPLString& osValue);
98 
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;
103 
104  virtual bool AllowAutomaticRedirection() { return true; }
105  virtual bool CanRestartOnError(const char*, const char* /* pszHeaders*/,
106  bool /*bSetError*/, bool* /*pbUpdateMap*/ = nullptr) { return false;}
107 
108  virtual const CPLString& GetURL() const = 0;
109 
110  static bool GetBucketAndObjectKey(const char* pszURI,
111  const char* pszFSPrefix,
112  bool bAllowNoObject,
113  CPLString &osBucketOut,
114  CPLString &osObjectKeyOut);
115 
116  static CPLString BuildCanonicalizedHeaders(
117  std::map<CPLString, CPLString>& oSortedMapHeaders,
118  const struct curl_slist* psExistingHeaders,
119  const char* pszHeaderPrefix);
120 
121  static CPLString GetRFC822DateTime();
122 };
123 
124 class VSIS3HandleHelper final: public IVSIS3LikeHandleHelper
125 {
126  CPLString m_osURL;
127  CPLString m_osSecretAccessKey;
128  CPLString m_osAccessKeyId;
129  CPLString m_osSessionToken;
130  CPLString m_osEndpoint;
131  CPLString m_osRegion;
132  CPLString m_osRequestPayer;
133  CPLString m_osBucket;
134  CPLString m_osObjectKey;
135  bool m_bUseHTTPS;
136  bool m_bUseVirtualHosting;
137 
138  void RebuildURL() override;
139 
140  static bool GetConfigurationFromEC2(CPLString& osSecretAccessKey,
141  CPLString& osAccessKeyId,
142  CPLString& osSessionToken);
143 
144  static bool GetConfigurationFromAWSConfigFiles(
145  CPLString& osSecretAccessKey,
146  CPLString& osAccessKeyId,
147  CPLString& osSessionToken,
148  CPLString& osRegion,
149  CPLString& osCredentials);
150 
151  static bool GetConfiguration(CSLConstList papszOptions,
152  CPLString& osSecretAccessKey,
153  CPLString& osAccessKeyId,
154  CPLString& osSessionToken,
155  CPLString& osRegion);
156  protected:
157 
158  public:
159  VSIS3HandleHelper(const CPLString& osSecretAccessKey,
160  const CPLString& osAccessKeyId,
161  const CPLString& osSessionToken,
162  const CPLString& osEndpoint,
163  const CPLString& osRegion,
164  const CPLString& osRequestPayer,
165  const CPLString& osBucket,
166  const CPLString& osObjectKey,
167  bool bUseHTTPS, bool bUseVirtualHosting);
168  ~VSIS3HandleHelper();
169 
170  static VSIS3HandleHelper* BuildFromURI(const char* pszURI,
171  const char* pszFSPrefix,
172  bool bAllowNoObject,
173  CSLConstList papszOptions = nullptr);
174  static CPLString BuildURL(const CPLString& osEndpoint,
175  const CPLString& osBucket,
176  const CPLString& osObjectKey,
177  bool bUseHTTPS, bool bUseVirtualHosting);
178 
179  struct curl_slist* GetCurlHeaders(
180  const CPLString& osVerb,
181  const struct curl_slist* psExistingHeaders,
182  const void *pabyDataContent = nullptr,
183  size_t nBytesContent = 0) const override;
184 
185  bool AllowAutomaticRedirection() override { return false; }
186  bool CanRestartOnError(const char*, const char* pszHeaders,
187  bool bSetError,
188  bool* pbUpdateMap = nullptr) override;
189 
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);
198  void SetRegion(const CPLString &osStr);
199  void SetRequestPayer(const CPLString &osStr);
200  void SetVirtualHosting(bool b);
201 
202  CPLString GetSignedURL(CSLConstList papszOptions);
203 
204  static void CleanMutex();
205  static void ClearCache();
206 };
207 
208 class VSIS3UpdateParams
209 {
210  public:
211  CPLString m_osRegion;
212  CPLString m_osEndpoint;
213  CPLString m_osRequestPayer;
214  bool m_bUseVirtualHosting;
215 
216  VSIS3UpdateParams() :
217  m_bUseVirtualHosting(false) {}
218 
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()) {}
224 
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);
230  }
231 };
232 
233 #endif /* HAVE_CURL */
234 
235 #endif /* #ifndef DOXYGEN_SKIP */
236 
237 #endif /* CPL_AWS_INCLUDED_H */
CPLHTTPFetch
CPLHTTPResult * CPLHTTPFetch(const char *pszURL, CSLConstList papszOptions)
Fetch a document from an url and return in a string.
Definition: cpl_http.cpp:620
CPLReadLineL
const char * CPLReadLineL(VSILFILE *)
Definition: cpl_conv.cpp:630
CSLTokenizeString2
char ** CSLTokenizeString2(const char *pszString, const char *pszDelimiter, int nCSLTFlags)
Definition: cpl_string.cpp:836
GByte
unsigned char GByte
Definition: cpl_port.h:213
VSIFReadL
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read bytes from file.
Definition: cpl_vsil.cpp:1146
CPLPrintTime
int CPLPrintTime(char *, int, const char *, const struct tm *, const char *)
Definition: cpl_conv.cpp:1500
CPLHTTPDestroyResult
void CPLHTTPDestroyResult(CPLHTTPResult *psResult)
Clean the memory associated with the return value of CPLHTTPFetch()
Definition: cpl_http.cpp:1932
CPLStringList
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:447
cpl_minixml.h
CPLPopErrorHandler
void CPLPopErrorHandler(void)
Definition: cpl_error.cpp:1223
CSLT_HONOURSTRINGS
#define CSLT_HONOURSTRINGS
Definition: cpl_string.h:83
CSLFetchNameValueDef
const char * CSLFetchNameValueDef(CSLConstList papszStrList, const char *pszName, const char *pszDefault)
Definition: cpl_string.cpp:1646
CSLSetNameValue
char ** CSLSetNameValue(char **papszStrList, const char *pszName, const char *pszValue)
Definition: cpl_string.cpp:1877
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:336
CPLParseXMLString
CPLXMLNode * CPLParseXMLString(const char *)
Parse an XML string into tree form.
Definition: cpl_minixml.cpp:614
CPLXMLNode
Definition: cpl_minixml.h:66
EQUAL
#define EQUAL(a, b)
Definition: cpl_port.h:559
VSIFCloseL
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:928
cpl_http.h
CPLPushErrorHandler
void CPLPushErrorHandler(CPLErrorHandler)
Definition: cpl_error.cpp:1166
CPLStringList::SetNameValue
CPLStringList & SetNameValue(const char *pszKey, const char *pszValue)
Definition: cplstringlist.cpp:422
CPLTestBool
bool CPLTestBool(const char *pszValue)
Definition: cpl_string.cpp:1526
CSLConstList
char ** CSLConstList
Definition: cpl_port.h:1184
CPLHTTPResult
Definition: cpl_http.h:61
CPLHTTPResult::pabyData
GByte * pabyData
Definition: cpl_http.h:77
CPLDestroyXMLNode
void CPLDestroyXMLNode(CPLXMLNode *)
Destroy a tree.
Definition: cpl_minixml.cpp:1412
CPLDebug
void CPLDebug(const char *, const char *,...)
Definition: cpl_error.cpp:544
VSIStatL
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:558
STARTS_WITH
#define STARTS_WITH(a, b)
Definition: cpl_port.h:568
cpl_string.h
CPLSPrintf
const char * CPLSPrintf(const char *fmt,...)
Definition: cpl_string.cpp:977
CPLGetXMLValue
const char * CPLGetXMLValue(const CPLXMLNode *poRoot, const char *pszPath, const char *pszDefault)
Fetch element/attribute value.
Definition: cpl_minixml.cpp:1645
CPLMutexHolder
Definition: cpl_multiproc.h:139
CPLError
void CPLError(CPLErr eErrClass, CPLErrorNum err_no, const char *fmt,...)
Definition: cpl_error.cpp:232
CPLParseNameValue
const char * CPLParseNameValue(const char *pszNameValue, char **ppszKey)
Definition: cpl_string.cpp:1754
CPLString::Trim
CPLSTRING_DLL CPLString & Trim()
Definition: cplstring.cpp:214
CPLHTTPResult::nStatus
int nStatus
Definition: cpl_http.h:63
CSLDestroy
void CSLDestroy(char **papszStrList)
Definition: cpl_string.cpp:200
GIntBig
long long GIntBig
Definition: cpl_port.h:246
VSIStatBufL
struct stat64 VSIStatBufL
Definition: cpl_vsi.h:191
EQUALN
#define EQUALN(a, b, n)
Definition: cpl_port.h:557
VSIFOpenL
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:818
CPLQuietErrorHandler
void CPLQuietErrorHandler(CPLErr, CPLErrorNum, const char *)
Definition: cpl_error.cpp:948
CPLFree
#define CPLFree
Definition: cpl_conv.h:81
CPLStringList::FetchNameValueDef
const char * FetchNameValueDef(const char *pszKey, const char *pszDefault) const
Definition: cplstringlist.cpp:745
CPLGetConfigOption
const char * CPLGetConfigOption(const char *, const char *)
Definition: cpl_conv.cpp:1690
VSILFILE
FILE VSILFILE
Definition: cpl_vsi.h:155
STARTS_WITH_CI
#define STARTS_WITH_CI(a, b)
Definition: cpl_port.h:570
CPLE_AppDefined
#define CPLE_AppDefined
Definition: cpl_error.h:99

Generated for GDAL by doxygen 1.8.17.