GDAL

cpl_azure.h
1 /**********************************************************************
2 * Project: CPL - Common Portability Library
3 * Purpose: Microsoft Azure Storage Blob routines
4 * Author: Even Rouault <even.rouault at spatialys.com>
5 *
6 **********************************************************************
7 * Copyright (c) 2017, 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_AZURE_INCLUDED_H
29 #define CPL_AZURE_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 <map>
39
40 class VSIAzureBlobHandleHelper final: public IVSIS3LikeHandleHelper
41 {
42 CPLString m_osURL;
43 CPLString m_osEndpoint;
44 CPLString m_osBucket;
45 CPLString m_osObjectKey;
46 CPLString m_osStorageAccount;
47 CPLString m_osStorageKey;
48 CPLString m_osSAS;
49 CPLString m_osAccessToken;
50 bool m_bFromManagedIdentities;
51
52 enum class Service
53 {
54 SERVICE_BLOB,
55 SERVICE_ADLS,
56 };
57
58 static bool GetConfiguration(const std::string& osPathForOption,
59 CSLConstList papszOptions,
60 Service eService,
61 bool& bUseHTTPS,
62 CPLString& osEndpoint,
63 CPLString& osStorageAccount,
64 CPLString& osStorageKey,
65 CPLString& osSAS,
66 CPLString& osAccessToken,
67 bool& bFromManagedIdentities);
68
69 static CPLString BuildURL(const CPLString& osEndpoint,
70 const CPLString& osBucket,
71 const CPLString& osObjectKey,
72 const CPLString& osSAS);
73
74 void RebuildURL() override;
75
76 public:
77 VSIAzureBlobHandleHelper(const CPLString& osEndpoint,
78 const CPLString& osBucket,
79 const CPLString& osObjectKey,
80 const CPLString& osStorageAccount,
81 const CPLString& osStorageKey,
82 const CPLString& osSAS,
83 const CPLString& osAccessToken,
84 bool bFromManagedIdentities);
85 ~VSIAzureBlobHandleHelper();
86
87 static VSIAzureBlobHandleHelper* BuildFromURI(const char* pszURI,
88 const char* pszFSPrefix,
89 CSLConstList papszOptions = nullptr);
90
91 struct curl_slist* GetCurlHeaders(const CPLString& osVerbosVerb,
92 const struct curl_slist* psExistingHeaders,
93 const void *pabyDataContent = nullptr,
94 size_t nBytesContent = 0) const override;
95
96 const CPLString& GetURL() const override { return m_osURL; }
97
98 CPLString GetSignedURL(CSLConstList papszOptions);
99
100 static void ClearCache();
101
102 std::string GetSASQueryString() const;
103 };
104
105 namespace cpl
106 {
107 int GetAzureBufferSize();
108 }
109
110 #endif /* HAVE_CURL */
111
112 #endif /* #ifndef DOXYGEN_SKIP */
113
114 #endif /* CPL_AZURE_INCLUDED_H */
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:320
cpl_http.h
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1056