File: cpl_swift.h

package info (click to toggle)
gdal 3.10.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 87,476 kB
  • sloc: cpp: 1,151,435; ansic: 215,362; python: 26,401; java: 5,972; xml: 4,596; sh: 3,263; cs: 2,503; yacc: 1,090; makefile: 289
file content (97 lines) | stat: -rw-r--r-- 3,498 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/**********************************************************************
 * Project:  CPL - Common Portability Library
 * Purpose:  OpenStack Swift Object Storage routines
 * Author:   Even Rouault <even.rouault at spatialys.com>
 *
 **********************************************************************
 * Copyright (c) 2018, Even Rouault <even.rouault at spatialys.com>
 *
 * SPDX-License-Identifier: MIT
 ****************************************************************************/

#ifndef CPL_SWIFT_INCLUDED_H
#define CPL_SWIFT_INCLUDED_H

#ifndef DOXYGEN_SKIP

#ifdef HAVE_CURL

#include <curl/curl.h>
#include "cpl_http.h"
#include "cpl_aws.h"
#include "cpl_json.h"
#include <map>

class VSISwiftHandleHelper final : public IVSIS3LikeHandleHelper
{
    std::string m_osURL;
    std::string m_osStorageURL;
    std::string m_osAuthToken;
    std::string m_osBucket;
    std::string m_osObjectKey;

    static bool GetConfiguration(const std::string &osPathForOption,
                                 std::string &osStorageURL,
                                 std::string &osAuthToken);

    static bool GetCached(const std::string &osPathForOption,
                          const char *pszURLKey, const char *pszUserKey,
                          const char *pszPasswordKey, std::string &osStorageURL,
                          std::string &osAuthToken);

    static std::string BuildURL(const std::string &osStorageURL,
                                const std::string &osBucket,
                                const std::string &osObjectKey);

    void RebuildURL() override;

    // V1 Authentication
    static bool CheckCredentialsV1(const std::string &osPathForOption);
    static bool AuthV1(const std::string &osPathForOption,
                       std::string &osStorageURL, std::string &osAuthToken);

    // V3 Authentication
    static bool CheckCredentialsV3(const std::string &osPathForOption,
                                   const std::string &osAuthType);
    static bool AuthV3(const std::string &osPathForOption,
                       const std::string &osAuthType, std::string &osStorageURL,
                       std::string &osAuthToken);
    static CPLJSONObject
    CreateAuthV3RequestObject(const std::string &osPathForOption,
                              const std::string &osAuthType);
    static bool GetAuthV3StorageURL(const std::string &osPathForOption,
                                    const CPLHTTPResult *psResult,
                                    std::string &storageURL);

  public:
    VSISwiftHandleHelper(const std::string &osStorageURL,
                         const std::string &osAuthToken,
                         const std::string &osBucket,
                         const std::string &osObjectKey);
    ~VSISwiftHandleHelper();

    bool Authenticate(const std::string &osPathForOption);

    static VSISwiftHandleHelper *BuildFromURI(const char *pszURI,
                                              const char *pszFSPrefix);

    struct curl_slist *
    GetCurlHeaders(const std::string &osVerbosVerb,
                   const struct curl_slist *psExistingHeaders,
                   const void *pabyDataContent = nullptr,
                   size_t nBytesContent = 0) const override;

    const std::string &GetURL() const override
    {
        return m_osURL;
    }

    static void CleanMutex();
    static void ClearCache();
};

#endif /* HAVE_CURL */

#endif /* #ifndef DOXYGEN_SKIP */

#endif /* CPL_SWIFT_INCLUDED_H */