libzypp: zypp/media/CredentialManager.h Source File

libzypp 17.25.10

CredentialManager.h
Go to the documentation of this file.
1 /*---------------------------------------------------------------------\
2 | ____ _ __ __ ___ |
3 | |__ / \ / / . \ . \ |
4 | / / \ V /| _/ _/ |
5 | / /__ | | | | | | |
6 | /_____||_| |_| |_| |
7 | |
8 \---------------------------------------------------------------------*/
12 #ifndef ZYPP_MEDIA_CREDENTIALMANAGER_H
13 #define ZYPP_MEDIA_CREDENTIALMANAGER_H
14
15 #include <set>
16
17 #include <zypp/Pathname.h>
18 #include <zypp/media/MediaUserAuth.h>
19
21 namespace zypp
22 {
23
24 class Url;
25
27 namespace media
28 {
29
30
32 //
33 // CLASS NAME : CredManagerOptions
34 //
38 struct CredManagerOptions
39 {
40 CredManagerOptions(const Pathname & rootdir = "");
41
42 Pathname globalCredFilePath;
43 Pathname userCredFilePath;
44 Pathname customCredFileDir;
45 };
47
48 // comparator for CredentialSet
49 struct AuthDataComparator
50 {
51 bool operator()(const AuthData_Ptr & lhs, const AuthData_Ptr & rhs) const;
52 };
53
55 //
56 // CLASS NAME : CredentialManager
57 //
62 class CredentialManager
63 {
64 public:
65 typedef std::set<AuthData_Ptr, AuthDataComparator> CredentialSet;
66 typedef CredentialSet::size_type CredentialSize;
67 typedef CredentialSet::const_iterator CredentialIterator;
68
69
70 CredentialManager(const CredManagerOptions & opts = CredManagerOptions());
71
72 ~CredentialManager()
73 {}
74
75 public:
87 AuthData_Ptr getCred(const Url & url);
88
92 AuthData_Ptr getCredFromFile(const Pathname & file);
93
97 void addGlobalCred(const AuthData & cred);
98
102 void addUserCred(const AuthData & cred);
103
118 void addCred(const AuthData & cred);
119
124 void save();
125
133 void saveInGlobal(const AuthData & cred);
134
142 void saveInUser(const AuthData & cred);
143
152 void saveInFile(const AuthData &, const Pathname & credFile);
153
159 void clearAll(bool global = false);
160
161
162 CredentialIterator credsGlobalBegin() const;
163 CredentialIterator credsGlobalEnd() const;
164 CredentialSize credsGlobalSize() const;
165 bool credsGlobalEmpty() const;
166
167 CredentialIterator credsUserBegin() const;
168 CredentialIterator credsUserEnd() const;
169 CredentialSize credsUserSize() const;
170 bool credsUserEmpty() const;
171
172 struct Impl;
173 private:
174 RW_pointer<Impl> _pimpl;
175 };
177
178
180 } // media
183 } // zypp
185
186 #endif /* ZYPP_MEDIA_CREDENTIALMANAGER_H */
187
url
Url url
Definition: MediaCurl.cc:66
MediaUserAuth.h
Convenience interface for handling authentication data of media user.
Pathname.h
Impl
zypp::Url
Url manipulation class.
Definition: Url.h:92
zypp::filesystem::Pathname
Pathname.
Definition: Pathname.h:45
zypp::media::AuthData
Class for handling media authentication data.
Definition: MediaUserAuth.h:31
zypp::media::CredentialManager
Definition: CredentialManager.h:63
zypp::media::CredentialManager::credsUserSize
CredentialSize credsUserSize() const
Definition: CredentialManager.cc:434
zypp::media::CredentialManager::save
void save()
Saves any unsaved credentials added via addUserCred() or addGlobalCred() methods.
Definition: CredentialManager.cc:348
zypp::media::CredentialManager::getCredFromFile
AuthData_Ptr getCredFromFile(const Pathname &file)
Read credentials from a file.
Definition: CredentialManager.cc:301
zypp::media::CredentialManager::credsGlobalBegin
CredentialIterator credsGlobalBegin() const
Definition: CredentialManager.cc:415
zypp::media::CredentialManager::credsUserBegin
CredentialIterator credsUserBegin() const
Definition: CredentialManager.cc:428
zypp::media::CredentialManager::CredentialSet
std::set< AuthData_Ptr, AuthDataComparator > CredentialSet
Definition: CredentialManager.h:65
zypp::media::CredentialManager::~CredentialManager
~CredentialManager()
Definition: CredentialManager.h:72
zypp::media::CredentialManager::CredentialIterator
CredentialSet::const_iterator CredentialIterator
Definition: CredentialManager.h:67
zypp::media::CredentialManager::saveInUser
void saveInUser(const AuthData &cred)
Saves given cred to user's credentials file.
Definition: CredentialManager.cc:366
zypp::media::CredentialManager::getCred
AuthData_Ptr getCred(const Url &url)
Get credentials for the specified url.
Definition: CredentialManager.cc:292
zypp::media::CredentialManager::addUserCred
void addUserCred(const AuthData &cred)
Add new user credentials.
Definition: CredentialManager.cc:332
zypp::media::CredentialManager::credsGlobalEmpty
bool credsGlobalEmpty() const
Definition: CredentialManager.cc:424
zypp::media::CredentialManager::credsUserEmpty
bool credsUserEmpty() const
Definition: CredentialManager.cc:437
zypp::media::CredentialManager::saveInFile
void saveInFile(const AuthData &, const Pathname &credFile)
Saves given cred to user specified credentials file.
Definition: CredentialManager.cc:373
zypp::media::CredentialManager::credsGlobalEnd
CredentialIterator credsGlobalEnd() const
Definition: CredentialManager.cc:418
zypp::media::CredentialManager::_pimpl
RW_pointer< Impl > _pimpl
Definition: CredentialManager.h:172
zypp::media::CredentialManager::credsUserEnd
CredentialIterator credsUserEnd() const
Definition: CredentialManager.cc:431
zypp::media::CredentialManager::credsGlobalSize
CredentialSize credsGlobalSize() const
Definition: CredentialManager.cc:421
zypp::media::CredentialManager::addCred
void addCred(const AuthData &cred)
Add new credentials with user callbacks.
Definition: CredentialManager.cc:305
zypp::media::CredentialManager::addGlobalCred
void addGlobalCred(const AuthData &cred)
Add new global credentials.
Definition: CredentialManager.cc:316
zypp::media::CredentialManager::CredentialSize
CredentialSet::size_type CredentialSize
Definition: CredentialManager.h:66
zypp::media::CredentialManager::saveInGlobal
void saveInGlobal(const AuthData &cred)
Saves given cred to global credentials file.
Definition: CredentialManager.cc:359
zypp::media::CredentialManager::clearAll
void clearAll(bool global=false)
Remove all global or user credentials from memory and disk.
Definition: CredentialManager.cc:396
zypp::media::CredentialManager::CredentialManager
CredentialManager(const CredManagerOptions &opts=CredManagerOptions())
Definition: CredentialManager.cc:287
zypp::media::AuthData_Ptr
shared_ptr< AuthData > AuthData_Ptr
Definition: MediaUserAuth.h:69
zypp::misc::testcase::TestcaseRepoType::Url
@ Url
zypp::sat::detail::size_type
SolvableIdType size_type
Definition: PoolMember.h:126
zypp
Easy-to use interface to the ZYPP dependency resolver.
Definition: CodePitfalls.doc:2
zypp::RW_pointer
Wrapper for const correct access via Smart pointer types.
Definition: PtrTypes.h:286
zypp::media::AuthDataComparator
Definition: CredentialManager.h:50
zypp::media::AuthDataComparator::operator()
bool operator()(const AuthData_Ptr &lhs, const AuthData_Ptr &rhs) const
Definition: CredentialManager.cc:42
zypp::media::CredManagerOptions
Definition: CredentialManager.h:39
zypp::media::CredManagerOptions::globalCredFilePath
Pathname globalCredFilePath
Definition: CredentialManager.h:42
zypp::media::CredManagerOptions::customCredFileDir
Pathname customCredFileDir
Definition: CredentialManager.h:44
zypp::media::CredManagerOptions::CredManagerOptions
CredManagerOptions(const Pathname &rootdir="")
Definition: CredentialManager.cc:61
zypp::media::CredManagerOptions::userCredFilePath
Pathname userCredFilePath
Definition: CredentialManager.h:43