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 bool m_bIncludeMSVersion = true;
52
53 enum class Service
54 {
55 SERVICE_BLOB,
56 SERVICE_ADLS,
57 };
58
59 static bool GetConfiguration(const std::string &osPathForOption,
60 CSLConstList papszOptions, Service eService,
61 bool &bUseHTTPS, CPLString &osEndpoint,
62 CPLString &osStorageAccount,
63 CPLString &osStorageKey, CPLString &osSAS,
64 CPLString &osAccessToken,
65 bool &bFromManagedIdentities);
66
67 static CPLString BuildURL(const CPLString &osEndpoint,
68 const CPLString &osBucket,
69 const CPLString &osObjectKey,
70 const CPLString &osSAS);
71
72 void RebuildURL() override;
73
74 public:
75 VSIAzureBlobHandleHelper(
76 const CPLString &osEndpoint, const CPLString &osBucket,
77 const CPLString &osObjectKey, const CPLString &osStorageAccount,
78 const CPLString &osStorageKey, const CPLString &osSAS,
79 const CPLString &osAccessToken, bool bFromManagedIdentities);
80 ~VSIAzureBlobHandleHelper();
81
82 static VSIAzureBlobHandleHelper *
83 BuildFromURI(const char *pszURI, const char *pszFSPrefix,
84 CSLConstList papszOptions = nullptr);
85
86 void SetIncludeMSVersion(bool bInclude)
87 {
88 m_bIncludeMSVersion = bInclude;
89 }
90
91 struct curl_slist *
92 GetCurlHeaders(const CPLString &osVerbosVerb,
93 const struct curl_slist *psExistingHeaders,
94 const void *pabyDataContent = nullptr,
95 size_t nBytesContent = 0) const override;
96
97 const CPLString &GetURL() const override
98 {
99 return m_osURL;
100 }
101
102 CPLString GetSignedURL(CSLConstList papszOptions);
103
104 static void ClearCache();
105
106 std::string GetSASQueryString() const;
107 };
108
109 namespace cpl
110 {
111 int GetAzureBufferSize();
112 }
113
114 #endif /* HAVE_CURL */
115
116 #endif /* #ifndef DOXYGEN_SKIP */
117
118 #endif /* CPL_AZURE_INCLUDED_H */
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:311
cpl_http.h
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1195