SDTS_AL
cpl_google_cloud.h
1 /**********************************************************************
2  * Project: CPL - Common Portability Library
3  * Purpose: Google Cloud Storage 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_GOOGLE_CLOUD_INCLUDED_H
29 #define CPL_GOOGLE_CLOUD_INCLUDED_H
30 
31 #ifndef DOXYGEN_SKIP
32 
33 #include <cstddef>
34 
35 #include "cpl_string.h"
36 
37 #ifdef HAVE_CURL
38 
39 #include <curl/curl.h>
40 #include "cpl_http.h"
41 #include "cpl_aws.h"
42 #include <map>
43 
44 class VSIGSHandleHelper final: public IVSIS3LikeHandleHelper
45 {
46  CPLString m_osURL;
47  CPLString m_osEndpoint;
48  CPLString m_osBucketObjectKey;
49  CPLString m_osSecretAccessKey;
50  CPLString m_osAccessKeyId;
51  bool m_bUseHeaderFile;
52  GOA2Manager m_oManager;
53 
54  static bool GetConfiguration(CSLConstList papszOptions,
55  CPLString& osSecretAccessKey,
56  CPLString& osAccessKeyId,
57  CPLString& osHeaderFile,
58  GOA2Manager& oManager);
59 
60  static bool GetConfigurationFromConfigFile(
61  CPLString& osSecretAccessKey,
62  CPLString& osAccessKeyId,
63  CPLString& osOAuth2RefreshToken,
64  CPLString& osOAuth2ClientId,
65  CPLString& osOAuth2ClientSecret,
66  CPLString& osCredentials);
67 
68  void RebuildURL() override;
69 
70  public:
71  VSIGSHandleHelper(const CPLString& osEndpoint,
72  const CPLString& osBucketObjectKey,
73  const CPLString& osSecretAccessKey,
74  const CPLString& osAccessKeyId,
75  bool bUseHeaderFile,
76  const GOA2Manager& oManager);
77  ~VSIGSHandleHelper();
78 
79  static VSIGSHandleHelper* BuildFromURI(const char* pszURI,
80  const char* pszFSPrefix,
81  CSLConstList papszOptions = nullptr);
82 
83  struct curl_slist* GetCurlHeaders(
84  const CPLString& osVerbosVerb,
85  const struct curl_slist* psExistingHeaders,
86  const void *pabyDataContent = nullptr,
87  size_t nBytesContent = 0) const override;
88 
89  const CPLString& GetURL() const override { return m_osURL; }
90 
91  CPLString GetSignedURL(CSLConstList papszOptions);
92 
93  static void CleanMutex();
94  static void ClearCache();
95 };
96 
97 #endif /* HAVE_CURL */
98 
99 #endif /* #ifndef DOXYGEN_SKIP */
100 
101 #endif /* CPL_GOOGLE_CLOUD_INCLUDED_H */
char ** CSLConstList
Definition: cpl_port.h:1184