GDAL
cpl_aws.h
1 /**********************************************************************
2  * $Id: cpl_aws.h 40377 2017-10-09 22:51:05Z 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 
55 CPLString CPLGetAWS_SIGN4_Authorization(const CPLString& osSecretAccessKey,
56  const CPLString& osAccessKeyId,
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 
69 class IVSIS3LikeHandleHelper
70 {
71 protected:
72  std::map<CPLString, CPLString> m_oMapQueryParameters;
73 
74  virtual void RebuildURL() = 0;
75  CPLString GetQueryString() const;
76 
77 public:
78  IVSIS3LikeHandleHelper() {}
79  virtual ~IVSIS3LikeHandleHelper() {}
80 
81  void ResetQueryParameters();
82  void AddQueryParameter(const CPLString& osKey, const CPLString& osValue);
83 
84  virtual struct curl_slist* GetCurlHeaders(const CPLString& osVerb,
85  const struct curl_slist* psExistingHeaders,
86  const void *pabyDataContent = NULL,
87  size_t nBytesContent = 0) const = 0;
88 
89  virtual bool CanRestartOnError(const char*, bool /*bSetError*/ = false) { return false;}
90 
91  virtual const CPLString& GetURL() const = 0;
92 
93  static bool GetBucketAndObjectKey(const char* pszURI,
94  const char* pszFSPrefix,
95  bool bAllowNoObject,
96  CPLString &osBucketOut,
97  CPLString &osObjectKeyOut);
98 
99  static CPLString BuildCanonicalizedHeaders(
100  std::map<CPLString, CPLString>& oSortedMapHeaders,
101  const struct curl_slist* psExistingHeaders,
102  const char* pszHeaderPrefix);
103 };
104 
105 class VSIS3HandleHelper: public IVSIS3LikeHandleHelper
106 {
107  CPLString m_osURL;
108  CPLString m_osSecretAccessKey;
109  CPLString m_osAccessKeyId;
110  CPLString m_osSessionToken;
111  CPLString m_osEndpoint;
112  CPLString m_osRegion;
113  CPLString m_osRequestPayer;
114  CPLString m_osBucket;
115  CPLString m_osObjectKey;
116  bool m_bUseHTTPS;
117  bool m_bUseVirtualHosting;
118 
119  virtual void RebuildURL() CPL_OVERRIDE;
120 
121  static bool GetConfigurationFromEC2(CPLString& osSecretAccessKey,
122  CPLString& osAccessKeyId,
123  CPLString& osSessionToken);
124 
125  static bool GetConfigurationFromAWSConfigFiles(
126  CPLString& osSecretAccessKey,
127  CPLString& osAccessKeyId,
128  CPLString& osSessionToken,
129  CPLString& osRegion,
130  CPLString& osCredentials);
131  protected:
132 
133  public:
134  VSIS3HandleHelper(const CPLString& osSecretAccessKey,
135  const CPLString& osAccessKeyId,
136  const CPLString& osSessionToken,
137  const CPLString& osEndpoint,
138  const CPLString& osRegion,
139  const CPLString& osRequestPayer,
140  const CPLString& osBucket,
141  const CPLString& osObjectKey,
142  bool bUseHTTPS, bool bUseVirtualHosting);
143  ~VSIS3HandleHelper();
144 
145  static VSIS3HandleHelper* BuildFromURI(const char* pszURI, const char* pszFSPrefix,
146  bool bAllowNoObject);
147  static CPLString BuildURL(const CPLString& osEndpoint,
148  const CPLString& osBucket,
149  const CPLString& osObjectKey,
150  bool bUseHTTPS, bool bUseVirtualHosting);
151 
152  struct curl_slist* GetCurlHeaders(const CPLString& osVerb,
153  const struct curl_slist* psExistingHeaders,
154  const void *pabyDataContent = NULL,
155  size_t nBytesContent = 0) const CPL_OVERRIDE;
156 
157  bool CanRestartOnError(const char*, bool bSetError = false) CPL_OVERRIDE;
158 
159  const CPLString& GetURL() const CPL_OVERRIDE { return m_osURL; }
160  const CPLString& GetBucket() const { return m_osBucket; }
161  const CPLString& GetObjectKey() const { return m_osObjectKey; }
162  const CPLString& GetEndpoint()const { return m_osEndpoint; }
163  const CPLString& GetRegion() const { return m_osRegion; }
164  const CPLString& GetRequestPayer() const { return m_osRequestPayer; }
165  bool GetVirtualHosting() const { return m_bUseVirtualHosting; }
166  void SetEndpoint(const CPLString &osStr);
167  void SetRegion(const CPLString &osStr);
168  void SetRequestPayer(const CPLString &osStr);
169  void SetVirtualHosting(bool b);
170 
171  static bool GetConfiguration(CPLString& osSecretAccessKey,
172  CPLString& osAccessKeyId,
173  CPLString& osSessionToken,
174  CPLString& osRegion);
175  static void CleanMutex();
176  static void ClearCache();
177 };
178 
179 class VSIS3UpdateParams
180 {
181  public:
182  CPLString m_osRegion;
183  CPLString m_osEndpoint;
184  CPLString m_osRequestPayer;
185  bool m_bUseVirtualHosting;
186 
187  VSIS3UpdateParams() :
188  m_bUseVirtualHosting(false) {}
189 
190  explicit VSIS3UpdateParams(const VSIS3HandleHelper* poHelper) :
191  m_osRegion(poHelper->GetRegion()),
192  m_osEndpoint(poHelper->GetEndpoint()),
193  m_osRequestPayer(poHelper->GetRequestPayer()),
194  m_bUseVirtualHosting(poHelper->GetVirtualHosting()) {}
195 
196  void UpdateHandlerHelper(VSIS3HandleHelper* poHelper) {
197  poHelper->SetRegion(m_osRegion);
198  poHelper->SetEndpoint(m_osEndpoint);
199  poHelper->SetRequestPayer(m_osRequestPayer);
200  poHelper->SetVirtualHosting(m_bUseVirtualHosting);
201  }
202 };
203 
204 #endif /* HAVE_CURL */
205 
206 #endif /* #ifndef DOXYGEN_SKIP */
207 
208 #endif /* CPL_AWS_INCLUDED_H */
#define CPL_OVERRIDE
To be used in public headers only.
Definition: cpl_port.h:1055
Convenient string class based on std::string.
Definition: cpl_string.h:338
Various convenience functions for working with strings and string lists.

Generated for GDAL by doxygen 1.8.8.