GDAL

cpl_swift.h
1 /**********************************************************************
2 * Project: CPL - Common Portability Library
3 * Purpose: OpenStack Swift Object Storage routines
4 * Author: Even Rouault <even.rouault at spatialys.com>
5 *
6 **********************************************************************
7 * Copyright (c) 2018, Even Rouault <even.rouault at spatialys.com>
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included
17 * in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25 * DEALINGS IN THE SOFTWARE.
26 ****************************************************************************/
27
28 #ifndef CPL_SWIFT_INCLUDED_H
29 #define CPL_SWIFT_INCLUDED_H
30
31 #ifndef DOXYGEN_SKIP
32
33 #ifdef HAVE_CURL
34
35 #include <curl/curl.h>
36 #include "cpl_http.h"
37 #include "cpl_aws.h"
38 #include "cpl_json.h"
39 #include <map>
40
41 class VSISwiftHandleHelper final: public IVSIS3LikeHandleHelper
42 {
43 CPLString m_osURL;
44 CPLString m_osStorageURL;
45 CPLString m_osAuthToken;
46 CPLString m_osBucket;
47 CPLString m_osObjectKey;
48
49 static bool GetConfiguration(const std::string& osPathForOption,
50 CPLString& osStorageURL,
51 CPLString& osAuthToken);
52
53 static bool GetCached(const std::string& osPathForOption,
54 const char* pszURLKey,
55 const char* pszUserKey,
56 const char* pszPasswordKey,
57 CPLString& osStorageURL,
58 CPLString& osAuthToken);
59
60 static CPLString BuildURL(const CPLString& osStorageURL,
61 const CPLString& osBucket,
62 const CPLString& osObjectKey);
63
64 void RebuildURL() override;
65
66 // V1 Authentication
67 static bool CheckCredentialsV1(const std::string& osPathForOption);
68 static bool AuthV1(const std::string& osPathForOption,
69 CPLString& osStorageURL,
70 CPLString& osAuthToken);
71
72 // V3 Authentication
73 static bool CheckCredentialsV3(const std::string& osPathForOption,
74 const CPLString& osAuthType);
75 static bool AuthV3(const std::string& osPathForOption,
76 const CPLString& osAuthType,
77 CPLString& osStorageURL,
78 CPLString& osAuthToken);
79 static CPLJSONObject CreateAuthV3RequestObject(const std::string& osPathForOption,
80 const CPLString& osAuthType);
81 static bool GetAuthV3StorageURL(const std::string& osPathForOption,
82 const CPLHTTPResult *psResult,
83 CPLString& storageURL);
84
85 public:
86 VSISwiftHandleHelper(const CPLString& osStorageURL,
87 const CPLString& osAuthToken,
88 const CPLString& osBucket,
89 const CPLString& osObjectKey);
90 ~VSISwiftHandleHelper();
91
92 bool Authenticate(const std::string& osPathForOption);
93
94 static VSISwiftHandleHelper* BuildFromURI(const char* pszURI,
95 const char* pszFSPrefix);
96
97 struct curl_slist* GetCurlHeaders(const CPLString& osVerbosVerb,
98 const struct curl_slist* psExistingHeaders,
99 const void *pabyDataContent = nullptr,
100 size_t nBytesContent = 0) const override;
101
102 const CPLString& GetURL() const override { return m_osURL; }
103
104 static void CleanMutex();
105 static void ClearCache();
106 };
107
108
109 #endif /* HAVE_CURL */
110
111 #endif /* #ifndef DOXYGEN_SKIP */
112
113 #endif /* CPL_SWIFT_INCLUDED_H */
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:319
cpl_http.h
CPLJSONObject
The CPLJSONArray class holds JSON object from CPLJSONDocument.
Definition: cpl_json.h:53
CPLHTTPResult
Definition: cpl_http.h:66
cpl_json.h