OGR
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  CPL_DISALLOW_COPY_ASSIGN(VSIGSHandleHelper)
47 
48  CPLString m_osURL;
49  CPLString m_osEndpoint;
50  CPLString m_osBucketObjectKey;
51  CPLString m_osSecretAccessKey;
52  CPLString m_osAccessKeyId;
53  bool m_bUseHeaderFile;
54  GOA2Manager m_oManager;
55 
56  static bool GetConfiguration(CSLConstList papszOptions,
57  CPLString& osSecretAccessKey,
58  CPLString& osAccessKeyId,
59  CPLString& osHeaderFile,
60  GOA2Manager& oManager);
61 
62  static bool GetConfigurationFromConfigFile(
63  CPLString& osSecretAccessKey,
64  CPLString& osAccessKeyId,
65  CPLString& osOAuth2RefreshToken,
66  CPLString& osOAuth2ClientId,
67  CPLString& osOAuth2ClientSecret,
68  CPLString& osCredentials);
69 
70  void RebuildURL() override;
71 
72  public:
73  VSIGSHandleHelper(const CPLString& osEndpoint,
74  const CPLString& osBucketObjectKey,
75  const CPLString& osSecretAccessKey,
76  const CPLString& osAccessKeyId,
77  bool bUseHeaderFile,
78  const GOA2Manager& oManager);
79  ~VSIGSHandleHelper();
80 
81  static VSIGSHandleHelper* BuildFromURI(const char* pszURI,
82  const char* pszFSPrefix,
83  CSLConstList papszOptions = nullptr);
84 
85  struct curl_slist* GetCurlHeaders(
86  const CPLString& osVerbosVerb,
87  const struct curl_slist* psExistingHeaders,
88  const void *pabyDataContent = nullptr,
89  size_t nBytesContent = 0) const override;
90 
91  const CPLString& GetURL() const override { return m_osURL; }
92 
93  CPLString GetSignedURL(CSLConstList papszOptions);
94 
95  static void CleanMutex();
96  static void ClearCache();
97 };
98 
99 #endif /* HAVE_CURL */
100 
101 #endif /* #ifndef DOXYGEN_SKIP */
102 
103 #endif /* CPL_GOOGLE_CLOUD_INCLUDED_H */
CPLPopFinderLocation
void CPLPopFinderLocation(void)
Definition: cpl_findfile.cpp:285
CPLRecodeFromWChar
char * CPLRecodeFromWChar(const wchar_t *pwszSource, const char *pszSrcEncoding, const char *pszDstEncoding)
Definition: cpl_recode.cpp:149
CPLReadLineL
const char * CPLReadLineL(VSILFILE *)
Definition: cpl_conv.cpp:630
CSLFindStringCaseSensitive
int CSLFindStringCaseSensitive(CSLConstList papszList, const char *pszTarget)
Definition: cpl_string.cpp:704
GByte
unsigned char GByte
Definition: cpl_port.h:215
GOA2Manager::GetBearer
const char * GetBearer() const
Definition: cpl_google_oauth2.cpp:677
VSIFReadL
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read bytes from file.
Definition: cpl_vsil.cpp:1690
GOA2Manager
Definition: cpl_http.h:163
CPLGetExecPath
int CPLGetExecPath(char *pszPathBuf, int nMaxLength)
Definition: cpl_getexecpath.cpp:132
CPLFindFile
const char * CPLFindFile(const char *pszClass, const char *pszBasename)
Definition: cpl_findfile.cpp:177
CPLString::Printf
CPLSTRING_METHOD_DLL CPLString & Printf(const char *pszFormat,...)
Definition: cplstring.cpp:59
CPLCalloc
void * CPLCalloc(size_t, size_t)
Definition: cpl_conv.cpp:138
cpl_vsi.h
CSLFetchNameValueDef
const char * CSLFetchNameValueDef(CSLConstList papszStrList, const char *pszName, const char *pszDefault)
Definition: cpl_string.cpp:1646
CPLIsMachinePotentiallyGCEInstance
bool CPLIsMachinePotentiallyGCEInstance()
Definition: cpl_google_cloud.cpp:110
CPLPushFinderLocation
void CPLPushFinderLocation(const char *)
Definition: cpl_findfile.cpp:246
CPLJSONDocument::Load
bool Load(const std::string &osPath)
Definition: cpl_json.cpp:143
CSLCount
int CSLCount(CSLConstList papszStrList)
Definition: cpl_string.cpp:147
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:329
CPLJSONObject::GetString
std::string GetString(const std::string &osName, const std::string &osDefault="") const
Definition: cpl_json.cpp:800
CPLRealloc
void * CPLRealloc(void *, size_t)
Definition: cpl_conv.cpp:225
CPL_FRMT_GIB
#define CPL_FRMT_GIB
Definition: cpl_port.h:316
EQUAL
#define EQUAL(a, b)
Definition: cpl_port.h:569
GOA2Manager::SetAuthFromRefreshToken
bool SetAuthFromRefreshToken(const char *pszRefreshToken, const char *pszClientId, const char *pszClientSecret, CSLConstList papszOptions)
Definition: cpl_google_oauth2.cpp:595
VSIFCloseL
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:1472
cpl_http.h
CPLFinderClean
void CPLFinderClean(void)
Definition: cpl_findfile.cpp:134
CPLDefaultFindFile
const char * CPLDefaultFindFile(const char *pszClass, const char *pszBasename)
Definition: cpl_findfile.cpp:149
FindFileTLS
Definition: cpl_findfile.cpp:41
CPLTestBool
bool CPLTestBool(const char *pszValue)
Definition: cpl_string.cpp:1526
CPLFileFinder
const typedef char *(* CPLFileFinder)(const char *, const char *)
Definition: cpl_conv.h:179
CSLConstList
char ** CSLConstList
Definition: cpl_port.h:1194
CPL_ENC_UTF8
#define CPL_ENC_UTF8
Definition: cpl_string.h:265
CPLBase64Encode
char * CPLBase64Encode(int nBytes, const GByte *pabyData)
Definition: cpl_base64.cpp:199
CPLDebug
void CPLDebug(const char *, const char *,...)
Definition: cpl_error.cpp:602
CPLFormFilename
const char * CPLFormFilename(const char *pszPath, const char *pszBasename, const char *pszExtension)
Definition: cpl_path.cpp:537
VSIStatL
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:737
CPLMalloc
void * CPLMalloc(size_t)
Definition: cpl_conv.cpp:168
cpl_conv.h
cpl_string.h
VSI_CALLOC_VERBOSE
#define VSI_CALLOC_VERBOSE(nCount, nSize)
Definition: cpl_vsi.h:283
cpl_json.h
CPLSPrintf
const char * CPLSPrintf(const char *fmt,...)
Definition: cpl_string.cpp:977
CSLAddStringMayFail
char ** CSLAddStringMayFail(char **papszStrList, const char *pszNewString)
Definition: cpl_string.cpp:92
CPLMutexHolder
Definition: cpl_multiproc.h:139
CPLError
void CPLError(CPLErr eErrClass, CPLErrorNum err_no, const char *fmt,...)
Definition: cpl_error.cpp:308
CPLParseNameValue
const char * CPLParseNameValue(const char *pszNameValue, char **ppszKey)
Definition: cpl_string.cpp:1754
GOA2Manager::SetAuthFromServiceAccount
bool SetAuthFromServiceAccount(const char *pszPrivateKey, const char *pszClientEmail, const char *pszScope, CSLConstList papszAdditionalClaims, CSLConstList papszOptions)
Definition: cpl_google_oauth2.cpp:631
CPLE_NotSupported
#define CPLE_NotSupported
Definition: cpl_error.h:109
CPLIsMachineForSureGCEInstance
bool CPLIsMachineForSureGCEInstance()
Definition: cpl_google_cloud.cpp:58
CPLString::Trim
CPLSTRING_METHOD_DLL CPLString & Trim()
Definition: cplstring.cpp:203
CPLJSONDocument::GetRoot
CPLJSONObject GetRoot()
Definition: cpl_json.cpp:119
GOA2Manager::SetAuthFromGCE
bool SetAuthFromGCE(CSLConstList papszOptions)
Definition: cpl_google_oauth2.cpp:570
CPLString::replaceAll
CPLSTRING_METHOD_DLL CPLString & replaceAll(const std::string &osBefore, const std::string &osAfter)
Definition: cplstring.cpp:349
GIntBig
long long GIntBig
Definition: cpl_port.h:248
CPL_ENC_UCS2
#define CPL_ENC_UCS2
Definition: cpl_string.h:269
CPL_UNUSED
#define CPL_UNUSED
Definition: cpl_port.h:948
VSIStatBufL
struct stat64 VSIStatBufL
Definition: cpl_vsi.h:194
cpl_port.h
CPLJSONDocument
The CPLJSONDocument class Wrapper class around json-c library.
Definition: cpl_json.h:188
VSIFOpenL
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:997
CSLFetchNameValue
const char * CSLFetchNameValue(CSLConstList papszStrList, const char *pszName)
Definition: cpl_string.cpp:1674
CPLPopFileFinder
CPLFileFinder CPLPopFileFinder(void)
Definition: cpl_findfile.cpp:235
CPLPushFileFinder
void CPLPushFileFinder(CPLFileFinder pfnFinder)
Definition: cpl_findfile.cpp:200
CPLE_FileIO
#define CPLE_FileIO
Definition: cpl_error.h:103
CPLFree
#define CPLFree
Definition: cpl_conv.h:81
CPL_DISALLOW_COPY_ASSIGN
#define CPL_DISALLOW_COPY_ASSIGN(ClassName)
Definition: cpl_port.h:997
GOA2Manager::GetAuthMethod
AuthMethod GetAuthMethod() const
Definition: cpl_http.h:190
CPLGetConfigOption
const char * CPLGetConfigOption(const char *, const char *)
Definition: cpl_conv.cpp:1692
VSILFILE
FILE VSILFILE
Definition: cpl_vsi.h:156
STARTS_WITH_CI
#define STARTS_WITH_CI(a, b)
Definition: cpl_port.h:580
CPLE_AppDefined
#define CPLE_AppDefined
Definition: cpl_error.h:99

Generated for GDAL by doxygen 1.8.17.