GDAL

cpl_http.h
Go to the documentation of this file.
1 /******************************************************************************
2 * $Id$
3 *
4 * Project: Common Portability Library
5 * Purpose: Function wrapper for libcurl HTTP access.
6 * Author: Frank Warmerdam, warmerdam@pobox.com
7 *
8 ******************************************************************************
9 * Copyright (c) 2006, Frank Warmerdam
10 * Copyright (c) 2009, Even Rouault <even dot rouault at spatialys.com>
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be included
20 * in all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28 * DEALINGS IN THE SOFTWARE.
29 ****************************************************************************/
30
31 #ifndef CPL_HTTP_H_INCLUDED
32 #define CPL_HTTP_H_INCLUDED
33
34 #include "cpl_conv.h"
35 #include "cpl_string.h"
36 #include "cpl_progress.h"
37 #include "cpl_vsi.h"
38
46 #ifndef CPL_HTTP_MAX_RETRY
47 #define CPL_HTTP_MAX_RETRY 0
48 #endif
49
50 #ifndef CPL_HTTP_RETRY_DELAY
51 #define CPL_HTTP_RETRY_DELAY 30.0
52 #endif
55 CPL_C_START
56
58 typedef struct { char **papszHeaders;
60 GByte *pabyData; int nDataLen;
63 } CPLMimePart;
64
66 typedef struct {
68 int nStatus;
69
71 char *pszContentType;
72
74 char *pszErrBuf;
75
77 int nDataLen;
79 int nDataAlloc;
80
82 GByte *pabyData;
83
85 char **papszHeaders;
86
88 int nMimePartCount;
89
91 CPLMimePart *pasMimePart;
92
93 } CPLHTTPResult;
94
96 typedef size_t (*CPLHTTPFetchWriteFunc)(void *pBuffer, size_t nSize, size_t nMemb, void *pWriteArg);
99 int CPL_DLL CPLHTTPEnabled( void );
100 CPLHTTPResult CPL_DLL *CPLHTTPFetch( const char *pszURL, CSLConstList papszOptions);
101 CPLHTTPResult CPL_DLL *CPLHTTPFetchEx( const char *pszURL,CSLConstList papszOptions,
102 GDALProgressFunc pfnProgress,
103 void *pProgressArg,
104 CPLHTTPFetchWriteFunc pfnWrite,
105 void *pWriteArg);
106 CPLHTTPResult CPL_DLL **CPLHTTPMultiFetch( const char * const * papszURL,
107 int nURLCount,
108 int nMaxSimultaneous,
109 CSLConstList papszOptions);
110
111 void CPL_DLL CPLHTTPCleanup( void );
112 void CPL_DLL CPLHTTPDestroyResult( CPLHTTPResult *psResult );
113 void CPL_DLL CPLHTTPDestroyMultiResult( CPLHTTPResult **papsResults, int nCount );
114 int CPL_DLL CPLHTTPParseMultipartMime( CPLHTTPResult *psResult );
115
116 /* -------------------------------------------------------------------- */
117 /* To install an alternate network layer to the default Curl one */
118 /* -------------------------------------------------------------------- */
134 typedef CPLHTTPResult* (*CPLHTTPFetchCallbackFunc)( const char *pszURL,
135 CSLConstList papszOptions,
136 GDALProgressFunc pfnProgress,
137 void *pProgressArg,
138 CPLHTTPFetchWriteFunc pfnWrite,
139 void *pWriteArg,
140 void* pUserData );
141
142 void CPL_DLL CPLHTTPSetFetchCallback( CPLHTTPFetchCallbackFunc pFunc,
143 void* pUserData );
144
145 int CPL_DLL CPLHTTPPushFetchCallback( CPLHTTPFetchCallbackFunc pFunc,
146 void* pUserData );
147 int CPL_DLL CPLHTTPPopFetchCallback(void);
148
149 /* -------------------------------------------------------------------- */
150 /* The following is related to OAuth2 authorization around */
151 /* google services like fusion tables, and potentially others */
152 /* in the future. Code in cpl_google_oauth2.cpp. */
153 /* */
154 /* These services are built on CPL HTTP services. */
155 /* -------------------------------------------------------------------- */
156
157 char CPL_DLL *GOA2GetAuthorizationURL( const char *pszScope );
158 char CPL_DLL *GOA2GetRefreshToken( const char *pszAuthToken,
159 const char *pszScope );
160 char CPL_DLL *GOA2GetAccessToken( const char *pszRefreshToken,
161 const char *pszScope );
162
163 char CPL_DLL **GOA2GetAccessTokenFromServiceAccount(
164 const char* pszPrivateKey,
165 const char* pszClientEmail,
166 const char* pszScope,
167 CSLConstList papszAdditionalClaims,
168 CSLConstList papszOptions);
169
170 char CPL_DLL **GOA2GetAccessTokenFromCloudEngineVM( CSLConstList papszOptions );
171
172 CPL_C_END
173
174 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
176 // Not sure if this belong here, used in cpl_http.cpp, cpl_vsil_curl.cpp and frmts/wms/gdalhttp.cpp
177 void* CPLHTTPSetOptions(void *pcurl, const char *pszURL, const char * const* papszOptions);
178 char** CPLHTTPGetOptionsFromEnv();
179 double CPLHTTPGetNewRetryDelay(int response_code, double dfOldDelay,
180 const char* pszErrBuf, const char* pszCurlError);
181 void* CPLHTTPIgnoreSigPipe();
182 void CPLHTTPRestoreSigPipeHandler(void* old_handler);
183 bool CPLMultiPerformWait(void* hCurlMultiHandle, int& repeats);
186 bool CPLIsMachinePotentiallyGCEInstance();
187 bool CPLIsMachineForSureGCEInstance();
188
196 class GOA2Manager
197 {
198 public:
199
200 GOA2Manager();
201
203 typedef enum
204 {
205 NONE,
206 GCE,
207 ACCESS_TOKEN_FROM_REFRESH,
208 SERVICE_ACCOUNT
209 } AuthMethod;
210
211 bool SetAuthFromGCE( CSLConstList papszOptions );
212 bool SetAuthFromRefreshToken( const char* pszRefreshToken,
213 const char* pszClientId,
214 const char* pszClientSecret,
215 CSLConstList papszOptions );
216 bool SetAuthFromServiceAccount(const char* pszPrivateKey,
217 const char* pszClientEmail,
218 const char* pszScope,
219 CSLConstList papszAdditionalClaims,
220 CSLConstList papszOptions );
221
223 AuthMethod GetAuthMethod() const { return m_eMethod; }
224
225 const char* GetBearer() const;
226
228 const CPLString& GetPrivateKey() const { return m_osPrivateKey; }
229
231 const CPLString& GetClientEmail() const { return m_osClientEmail; }
232
233 private:
234
235 mutable CPLString m_osCurrentBearer{};
236 mutable time_t m_nExpirationTime = 0;
237 AuthMethod m_eMethod = NONE;
238
239 // for ACCESS_TOKEN_FROM_REFRESH
240 CPLString m_osClientId{};
241 CPLString m_osClientSecret{};
242 CPLString m_osRefreshToken{};
243
244 // for SERVICE_ACCOUNT
245 CPLString m_osPrivateKey{};
246 CPLString m_osClientEmail{};
247 CPLString m_osScope{};
248 CPLStringList m_aosAdditionalClaims{};
249
250 CPLStringList m_aosOptions{};
251 };
252
253
254 #endif // __cplusplus
255
256 #endif /* ndef CPL_HTTP_H_INCLUDED */
CPLStringList
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:442
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:333
GOA2Manager
Manager of Google OAuth2 authentication.
Definition: cpl_http.h:197
GOA2Manager::GOA2Manager
GOA2Manager()
Constructor.
GOA2Manager::GetAuthMethod
AuthMethod GetAuthMethod() const
Returns the authentication method.
Definition: cpl_http.h:223
GOA2Manager::SetAuthFromRefreshToken
bool SetAuthFromRefreshToken(const char *pszRefreshToken, const char *pszClientId, const char *pszClientSecret, CSLConstList papszOptions)
Specifies that the authentication will be done using the OAuth2 client id method.
Definition: cpl_google_oauth2.cpp:605
GOA2Manager::GetClientEmail
const CPLString & GetClientEmail() const
Returns client email for SERVICE_ACCOUNT method.
Definition: cpl_http.h:231
GOA2Manager::SetAuthFromServiceAccount
bool SetAuthFromServiceAccount(const char *pszPrivateKey, const char *pszClientEmail, const char *pszScope, CSLConstList papszAdditionalClaims, CSLConstList papszOptions)
Specifies that the authentication will be done using the OAuth2 service account method.
Definition: cpl_google_oauth2.cpp:641
GOA2Manager::GetPrivateKey
const CPLString & GetPrivateKey() const
Returns private key for SERVICE_ACCOUNT method.
Definition: cpl_http.h:228
GOA2Manager::GetBearer
const char * GetBearer() const
Return the access token.
Definition: cpl_google_oauth2.cpp:687
GOA2Manager::SetAuthFromGCE
bool SetAuthFromGCE(CSLConstList papszOptions)
Specifies that the authentication will be done using the local credentials of the current Google Comp...
Definition: cpl_google_oauth2.cpp:580
GOA2Manager::AuthMethod
AuthMethod
Authentication method.
Definition: cpl_http.h:204
cpl_conv.h
Various convenience functions for CPL.
CPLHTTPPopFetchCallback
int CPLHTTPPopFetchCallback(void)
Uninstalls a callback set by CPLHTTPPushFetchCallback().
Definition: cpl_http.cpp:873
GOA2GetAccessTokenFromServiceAccount
char ** GOA2GetAccessTokenFromServiceAccount(const char *pszPrivateKey, const char *pszClientEmail, const char *pszScope, CSLConstList papszAdditionalClaims, CSLConstList papszOptions)
Fetch access token using Service Account OAuth2.
Definition: cpl_google_oauth2.cpp:469
CPLHTTPPushFetchCallback
int CPLHTTPPushFetchCallback(CPLHTTPFetchCallbackFunc pFunc, void *pUserData)
Installs an alternate callback to the default implementation of CPLHTTPFetchEx().
Definition: cpl_http.cpp:853
CPLHTTPCleanup
void CPLHTTPCleanup(void)
Cleanup function to call at application termination.
Definition: cpl_http.cpp:2344
CPLIsMachinePotentiallyGCEInstance
bool CPLIsMachinePotentiallyGCEInstance()
Returns whether the current machine is potentially a Google Compute Engine instance.
Definition: cpl_google_cloud.cpp:110
CPLHTTPFetch
CPLHTTPResult * CPLHTTPFetch(const char *pszURL, CSLConstList papszOptions)
Fetch a document from an url and return in a string.
Definition: cpl_http.cpp:982
CPLIsMachineForSureGCEInstance
bool CPLIsMachineForSureGCEInstance()
Returns whether the current machine is surely a Google Compute Engine instance.
Definition: cpl_google_cloud.cpp:58
CPLHTTPSetFetchCallback
void CPLHTTPSetFetchCallback(CPLHTTPFetchCallbackFunc pFunc, void *pUserData)
Installs an alternate callback to the default implementation of CPLHTTPFetchEx().
Definition: cpl_http.cpp:831
CPLHTTPFetchEx
CPLHTTPResult * CPLHTTPFetchEx(const char *pszURL, CSLConstList papszOptions, GDALProgressFunc pfnProgress, void *pProgressArg, CPLHTTPFetchWriteFunc pfnWrite, void *pWriteArg)
Fetch a document from an url and return in a string.
Definition: cpl_http.cpp:998
GOA2GetAccessTokenFromCloudEngineVM
char ** GOA2GetAccessTokenFromCloudEngineVM(CSLConstList papszOptions)
Fetch access token using Cloud Engine internal REST API.
Definition: cpl_google_oauth2.cpp:428
CPLHTTPMultiFetch
CPLHTTPResult ** CPLHTTPMultiFetch(const char *const *papszURL, int nURLCount, int nMaxSimultaneous, CSLConstList papszOptions)
Fetch several documents at once.
Definition: cpl_http.cpp:1528
GOA2GetAuthorizationURL
char * GOA2GetAuthorizationURL(const char *pszScope)
Return authorization url for a given scope.
Definition: cpl_google_oauth2.cpp:127
CPLHTTPEnabled
int CPLHTTPEnabled(void)
Return if CPLHTTP services can be useful.
Definition: cpl_http.cpp:2327
GOA2GetRefreshToken
char * GOA2GetRefreshToken(const char *pszAuthToken, const char *pszScope)
Turn Auth Token into a Refresh Token.
Definition: cpl_google_oauth2.cpp:164
GOA2GetAccessToken
char * GOA2GetAccessToken(const char *pszRefreshToken, const char *pszScope)
Fetch access token using refresh token.
Definition: cpl_google_oauth2.cpp:397
CPLHTTPDestroyResult
void CPLHTTPDestroyResult(CPLHTTPResult *psResult)
Clean the memory associated with the return value of CPLHTTPFetch()
Definition: cpl_http.cpp:2400
CPLHTTPFetchCallbackFunc
CPLHTTPResult *(* CPLHTTPFetchCallbackFunc)(const char *pszURL, CSLConstList papszOptions, GDALProgressFunc pfnProgress, void *pProgressArg, CPLHTTPFetchWriteFunc pfnWrite, void *pWriteArg, void *pUserData)
Callback function to process network requests.
Definition: cpl_http.h:134
CPLHTTPDestroyMultiResult
void CPLHTTPDestroyMultiResult(CPLHTTPResult **papsResults, int nCount)
Clean the memory associated with the return value of CPLHTTPMultiFetch()
Definition: cpl_http.cpp:1775
CPLHTTPParseMultipartMime
int CPLHTTPParseMultipartMime(CPLHTTPResult *psResult)
Parses a MIME multipart message.
Definition: cpl_http.cpp:2433
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1216
GByte
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:215
cpl_string.h
Various convenience functions for working with strings and string lists.
cpl_vsi.h
Standard C Covers.
CPLHTTPResult
Definition: cpl_http.h:66
CPLHTTPResult::pabyData
GByte * pabyData
Definition: cpl_http.h:82
CPLHTTPResult::nStatus
int nStatus
Definition: cpl_http.h:68
CPLHTTPResult::pasMimePart
CPLMimePart * pasMimePart
Definition: cpl_http.h:91
CPLHTTPResult::pszContentType
char * pszContentType
Definition: cpl_http.h:71
CPLHTTPResult::nDataAlloc
int nDataAlloc
Definition: cpl_http.h:79
CPLHTTPResult::papszHeaders
char ** papszHeaders
Definition: cpl_http.h:85
CPLHTTPResult::pszErrBuf
char * pszErrBuf
Definition: cpl_http.h:74
CPLHTTPResult::nMimePartCount
int nMimePartCount
Definition: cpl_http.h:88
CPLHTTPResult::nDataLen
int nDataLen
Definition: cpl_http.h:77
CPLMimePart
Definition: cpl_http.h:58