GDAL

- Main Page
- Related Pages
- Classes
- Files
- Download
- Issue Tracker

- File List
- File Members

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
55 CPLString
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
122 class VSIS3HandleHelper final: public IVSIS3LikeHandleHelper
123 {
124 CPLString m_osURL;
125 CPLString m_osSecretAccessKey;
126 CPLString m_osAccessKeyId;
127 CPLString m_osSessionToken;
128 CPLString m_osEndpoint;
129 CPLString m_osRegion;
130 CPLString m_osRequestPayer;
131 CPLString m_osBucket;
132 CPLString m_osObjectKey;
133 bool m_bUseHTTPS;
134 bool m_bUseVirtualHosting;
135
136 void RebuildURL() override;
137
138 static bool GetConfigurationFromEC2(CPLString& osSecretAccessKey,
139 CPLString& osAccessKeyId,
140 CPLString& osSessionToken);
141
142 static bool GetConfigurationFromAWSConfigFiles(
143 CPLString& osSecretAccessKey,
144 CPLString& osAccessKeyId,
145 CPLString& osSessionToken,
146 CPLString& osRegion,
147 CPLString& osCredentials);
148
149 static bool GetConfiguration(CSLConstList papszOptions,
150 CPLString& osSecretAccessKey,
151 CPLString& osAccessKeyId,
152 CPLString& osSessionToken,
153 CPLString& osRegion);
154 protected:
155
156 public:
157 VSIS3HandleHelper(const CPLString& osSecretAccessKey,
158 const CPLString& osAccessKeyId,
159 const CPLString& osSessionToken,
160 const CPLString& osEndpoint,
161 const CPLString& osRegion,
162 const CPLString& osRequestPayer,
163 const CPLString& osBucket,
164 const CPLString& osObjectKey,
165 bool bUseHTTPS, bool bUseVirtualHosting);
166 ~VSIS3HandleHelper();
167
168 static VSIS3HandleHelper* BuildFromURI(const char* pszURI,
169 const char* pszFSPrefix,
170 bool bAllowNoObject,
171 CSLConstList papszOptions = nullptr);
172 static CPLString BuildURL(const CPLString& osEndpoint,
173 const CPLString& osBucket,
174 const CPLString& osObjectKey,
175 bool bUseHTTPS, bool bUseVirtualHosting);
176
177 struct curl_slist* GetCurlHeaders(
178 const CPLString& osVerb,
179 const struct curl_slist* psExistingHeaders,
180 const void *pabyDataContent = nullptr,
181 size_t nBytesContent = 0) const override;
182
183 bool AllowAutomaticRedirection() override { return false; }
184 bool CanRestartOnError(const char*, const char* pszHeaders,
185 bool bSetError,
186 bool* pbUpdateMap = nullptr) override;
187
188 const CPLString& GetURL() const override { return m_osURL; }
189 const CPLString& GetBucket() const { return m_osBucket; }
190 const CPLString& GetObjectKey() const { return m_osObjectKey; }
191 const CPLString& GetEndpoint()const { return m_osEndpoint; }
192 const CPLString& GetRegion() const { return m_osRegion; }
193 const CPLString& GetRequestPayer() const { return m_osRequestPayer; }
194 bool GetVirtualHosting() const { return m_bUseVirtualHosting; }
195 void SetEndpoint(const CPLString &osStr);
196 void SetRegion(const CPLString &osStr);
197 void SetRequestPayer(const CPLString &osStr);
198 void SetVirtualHosting(bool b);
199
200 CPLString GetSignedURL(CSLConstList papszOptions);
201
202 static void CleanMutex();
203 static void ClearCache();
204 };
205
206 class VSIS3UpdateParams
207 {
208 public:
209 CPLString m_osRegion;
210 CPLString m_osEndpoint;
211 CPLString m_osRequestPayer;
212 bool m_bUseVirtualHosting;
213
214 VSIS3UpdateParams() :
215 m_bUseVirtualHosting(false) {}
216
217 explicit VSIS3UpdateParams(const VSIS3HandleHelper* poHelper) :
218 m_osRegion(poHelper->GetRegion()),
219 m_osEndpoint(poHelper->GetEndpoint()),
220 m_osRequestPayer(poHelper->GetRequestPayer()),
221 m_bUseVirtualHosting(poHelper->GetVirtualHosting()) {}
222
223 void UpdateHandlerHelper(VSIS3HandleHelper* poHelper) {
224 poHelper->SetRegion(m_osRegion);
225 poHelper->SetEndpoint(m_osEndpoint);
226 poHelper->SetRequestPayer(m_osRequestPayer);
227 poHelper->SetVirtualHosting(m_bUseVirtualHosting);
228 }
229 };
230
231 #endif /* HAVE_CURL */
232
233 #endif /* #ifndef DOXYGEN_SKIP */
234
235 #endif /* CPL_AWS_INCLUDED_H */
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:334
cpl_string.h
Various convenience functions for working with strings and string lists.
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1190

Generated for GDAL by 1.8.8.