GDAL
cpl_aws.h
1 /**********************************************************************
2  * $Id$
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  CPL_DISALLOW_COPY_ASSIGN(IVSIS3LikeHandleHelper)
87 
88 protected:
89  std::map<CPLString, CPLString> m_oMapQueryParameters{};
90 
91  virtual void RebuildURL() = 0;
92  CPLString GetQueryString(bool bAddEmptyValueAfterEqual) const;
93 
94 public:
95  IVSIS3LikeHandleHelper() = default;
96  virtual ~IVSIS3LikeHandleHelper() = default;
97 
98  void ResetQueryParameters();
99  void AddQueryParameter(const CPLString& osKey, const CPLString& osValue);
100 
101  virtual struct curl_slist* GetCurlHeaders(const CPLString& osVerb,
102  const struct curl_slist* psExistingHeaders,
103  const void *pabyDataContent = nullptr,
104  size_t nBytesContent = 0) const = 0;
105 
106  virtual bool AllowAutomaticRedirection() { return true; }
107  virtual bool CanRestartOnError(const char*, const char* /* pszHeaders*/,
108  bool /*bSetError*/, bool* /*pbUpdateMap*/ = nullptr) { return false;}
109 
110  virtual const CPLString& GetURL() const = 0;
111 
112  static bool GetBucketAndObjectKey(const char* pszURI,
113  const char* pszFSPrefix,
114  bool bAllowNoObject,
115  CPLString &osBucketOut,
116  CPLString &osObjectKeyOut);
117 
118  static CPLString BuildCanonicalizedHeaders(
119  std::map<CPLString, CPLString>& oSortedMapHeaders,
120  const struct curl_slist* psExistingHeaders,
121  const char* pszHeaderPrefix);
122 };
123 
124 class VSIS3HandleHelper final: public IVSIS3LikeHandleHelper
125 {
126  CPL_DISALLOW_COPY_ASSIGN(VSIS3HandleHelper)
127 
128  CPLString m_osURL{};
129  CPLString m_osSecretAccessKey{};
130  CPLString m_osAccessKeyId{};
131  CPLString m_osSessionToken{};
132  CPLString m_osEndpoint{};
133  CPLString m_osRegion{};
134  CPLString m_osRequestPayer{};
135  CPLString m_osBucket{};
136  CPLString m_osObjectKey{};
137  bool m_bUseHTTPS = false;
138  bool m_bUseVirtualHosting = false;
139 
140  void RebuildURL() override;
141 
142  static bool GetConfigurationFromEC2(CPLString& osSecretAccessKey,
143  CPLString& osAccessKeyId,
144  CPLString& osSessionToken);
145 
146  static bool GetConfigurationFromAWSConfigFiles(
147  CPLString& osSecretAccessKey,
148  CPLString& osAccessKeyId,
149  CPLString& osSessionToken,
150  CPLString& osRegion,
151  CPLString& osCredentials);
152 
153  static bool GetConfiguration(CSLConstList papszOptions,
154  CPLString& osSecretAccessKey,
155  CPLString& osAccessKeyId,
156  CPLString& osSessionToken,
157  CPLString& osRegion);
158  protected:
159 
160  public:
161  VSIS3HandleHelper(const CPLString& osSecretAccessKey,
162  const CPLString& osAccessKeyId,
163  const CPLString& osSessionToken,
164  const CPLString& osEndpoint,
165  const CPLString& osRegion,
166  const CPLString& osRequestPayer,
167  const CPLString& osBucket,
168  const CPLString& osObjectKey,
169  bool bUseHTTPS, bool bUseVirtualHosting);
170  ~VSIS3HandleHelper();
171 
172  static VSIS3HandleHelper* BuildFromURI(const char* pszURI,
173  const char* pszFSPrefix,
174  bool bAllowNoObject,
175  CSLConstList papszOptions = nullptr);
176  static CPLString BuildURL(const CPLString& osEndpoint,
177  const CPLString& osBucket,
178  const CPLString& osObjectKey,
179  bool bUseHTTPS, bool bUseVirtualHosting);
180 
181  struct curl_slist* GetCurlHeaders(
182  const CPLString& osVerb,
183  const struct curl_slist* psExistingHeaders,
184  const void *pabyDataContent = nullptr,
185  size_t nBytesContent = 0) const override;
186 
187  bool AllowAutomaticRedirection() override { return false; }
188  bool CanRestartOnError(const char*, const char* pszHeaders,
189  bool bSetError,
190  bool* pbUpdateMap = nullptr) override;
191 
192  const CPLString& GetURL() const override { return m_osURL; }
193  const CPLString& GetBucket() const { return m_osBucket; }
194  const CPLString& GetObjectKey() const { return m_osObjectKey; }
195  const CPLString& GetEndpoint()const { return m_osEndpoint; }
196  const CPLString& GetRegion() const { return m_osRegion; }
197  const CPLString& GetRequestPayer() const { return m_osRequestPayer; }
198  bool GetVirtualHosting() const { return m_bUseVirtualHosting; }
199  void SetEndpoint(const CPLString &osStr);
200  void SetRegion(const CPLString &osStr);
201  void SetRequestPayer(const CPLString &osStr);
202  void SetVirtualHosting(bool b);
203 
204  CPLString GetSignedURL(CSLConstList papszOptions);
205 
206  static void CleanMutex();
207  static void ClearCache();
208 };
209 
210 class VSIS3UpdateParams
211 {
212  public:
213  CPLString m_osRegion{};
214  CPLString m_osEndpoint{};
215  CPLString m_osRequestPayer{};
216  bool m_bUseVirtualHosting = false;
217 
218  VSIS3UpdateParams() = default;
219 
220  explicit VSIS3UpdateParams(const VSIS3HandleHelper* poHelper) :
221  m_osRegion(poHelper->GetRegion()),
222  m_osEndpoint(poHelper->GetEndpoint()),
223  m_osRequestPayer(poHelper->GetRequestPayer()),
224  m_bUseVirtualHosting(poHelper->GetVirtualHosting()) {}
225 
226  void UpdateHandlerHelper(VSIS3HandleHelper* poHelper) {
227  poHelper->SetRegion(m_osRegion);
228  poHelper->SetEndpoint(m_osEndpoint);
229  poHelper->SetRequestPayer(m_osRequestPayer);
230  poHelper->SetVirtualHosting(m_bUseVirtualHosting);
231  }
232 };
233 
234 #endif /* HAVE_CURL */
235 
236 #endif /* #ifndef DOXYGEN_SKIP */
237 
238 #endif /* CPL_AWS_INCLUDED_H */
Convenient string class based on std::string.
Definition: cpl_string.h:327
Various convenience functions for working with strings and string lists.
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1184
#define CPL_DISALLOW_COPY_ASSIGN(ClassName)
Helper to remove the copy and assignment constructors so that the compiler will not generate the defa...
Definition: cpl_port.h:987

Generated for GDAL by doxygen 1.8.8.