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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
// Copyright (C) 2020-2022 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
#ifndef HTTP_BASIC_AUTH_CONFIG_H
#define HTTP_BASIC_AUTH_CONFIG_H
#include <http/auth_config.h>
#include <http/basic_auth.h>
#include <list>
#include <unordered_map>
namespace isc {
namespace http {
/// @brief Type of basic HTTP authentication credential and user id map,
/// e.g. map["am9obmRvZTpzZWNyZXQx"] = "johndoe".
///
/// The map is used to verify a received credential: if it is not in it
/// the authentication fails, if it is in it the user id is logged.
typedef std::unordered_map<std::string, std::string> BasicHttpAuthMap;
/// @brief Basic HTTP authentication client configuration.
class BasicHttpAuthClient : public isc::data::UserContext,
public isc::data::CfgToElement {
public:
/// @brief Constructor (legacy).
///
/// @param user User id.
/// @param password Password.
/// @param user_context Optional user context.
BasicHttpAuthClient(const std::string& user,
const std::string& password,
const isc::data::ConstElementPtr& user_context);
/// @brief Constructor.
///
/// @param user User id.
/// @param user_file File with the user id.
/// @param password Password.
/// @param password_file File with the password.
/// @param password_file_only Flag true if the password file includes
/// the user id too.
/// @param user_context Optional user context.
BasicHttpAuthClient(const std::string& user,
const std::string& user_file,
const std::string& password,
const std::string& password_file,
bool password_file_only,
const isc::data::ConstElementPtr& user_context);
/// @brief Returns the user id.
///
/// @return The user id.
const std::string& getUser() const {
return (user_);
}
/// @brief Returns the user id file.
///
/// @return The user id file.
const std::string& getUserFile() const {
return (user_file_);
}
/// @brief Returns the password.
///
/// @return The password.
const std::string& getPassword() const {
return (password_);
}
/// @brief Returns the password file.
///
/// @return The password file.
const std::string& getPasswordFile() const {
return (password_file_);
}
/// @brief Returns the password file only flag.
///
/// @return The password file only flag.
bool getPasswordFileOnly() const {
return (password_file_only_);
}
/// @brief Unparses basic HTTP authentication client configuration.
///
/// @return A pointer to unparsed client configuration.
virtual isc::data::ElementPtr toElement() const;
private:
/// @brief The user id e.g. johndoe.
std::string user_;
/// @brief The user id file.
std::string user_file_;
/// @brief The password e.g. secret1.
std::string password_;
/// @brief The password file.
std::string password_file_;
/// @brief The password file only flag.
bool password_file_only_;
};
/// @brief Type of basic HTTP authentication client configuration list.
typedef std::list<BasicHttpAuthClient> BasicHttpAuthClientList;
/// @brief Basic HTTP authentication configuration.
class BasicHttpAuthConfig : public HttpAuthConfig {
public:
/// @brief Destructor.
virtual ~BasicHttpAuthConfig() { }
/// @brief Add a client configuration.
///
/// @param user User id.
/// @param user_file File with the user id.
/// @param password Password.
/// @param password_file File with the password.
/// @param password_file_only Flag true if the password file includes
/// the user id too.
/// @param user_context Optional user context.
/// @throw BadValue if the user id contains the ':' character.
void add(const std::string& user,
const std::string& user_file,
const std::string& password,
const std::string& password_file,
bool password_file_only = false,
const isc::data::ConstElementPtr& user_context = isc::data::ConstElementPtr());
/// @brief Empty predicate.
///
/// @return true if the configuration is empty so authentication
/// is not required.
virtual bool empty() const;
/// @brief Clear configuration.
virtual void clear();
/// @brief Get the content of {directory}/{file-name} regular file.
///
/// @param file_name The file name.
/// @return The content of the {directory}/{file-name} regular file.
std::string getFileContent(const std::string& file_name) const;
/// @brief Returns the list of client configuration.
///
/// @return List of basic HTTP authentication client configuration.
const BasicHttpAuthClientList& getClientList() const {
return (list_);
}
/// @brief Returns the credential and user id map.
///
/// @return The basic HTTP authentication credential and user id map.
const BasicHttpAuthMap& getCredentialMap() const {
return (map_);
}
/// @brief Parses basic HTTP authentication configuration.
///
/// @param config Element holding the basic HTTP authentication
/// configuration to be parsed.
/// @throw DhcpConfigError when the configuration is invalid.
void parse(const isc::data::ConstElementPtr& config);
/// @brief Unparses basic HTTP authentication configuration.
///
/// @return A pointer to unparsed basic HTTP authentication configuration.
virtual isc::data::ElementPtr toElement() const;
/// @brief Validate HTTP request.
///
/// @param creator The HTTP response creator.
/// @param request The HTTP request to validate.
/// @return Error HTTP response if validation failed, null otherwise.
virtual isc::http::HttpResponseJsonPtr
checkAuth(const isc::http::HttpResponseCreator& creator,
const isc::http::HttpRequestPtr& request) const;
private:
/// @brief The list of basic HTTP authentication client configuration.
BasicHttpAuthClientList list_;
/// @brief The basic HTTP authentication credential and user id map.
BasicHttpAuthMap map_;
};
/// @brief Type of shared pointers to basic HTTP authentication configuration.
typedef boost::shared_ptr<BasicHttpAuthConfig> BasicHttpAuthConfigPtr;
} // end of namespace isc::http
} // end of namespace isc
#endif // endif HTTP_BASIC_AUTH_CONFIG_H
|
