Kea 2.0.0
basic_auth_config.h
Go to the documentation of this file.
1// Copyright (C) 2020 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7#ifndef HTTP_BASIC_AUTH_CONFIG_H
8#define HTTP_BASIC_AUTH_CONFIG_H
9
10#include <http/auth_config.h>
11#include <http/basic_auth.h>
12#include <list>
13#include <unordered_map>
14
15namespace isc {
16namespace http {
17
23typedef std::unordered_map<std::string, std::string> BasicHttpAuthMap;
24
28public:
29
35 BasicHttpAuthClient(const std::string& user,
36 const std::string& password,
37 const isc::data::ConstElementPtr& user_context);
38
40 const std::string& getUser() const {
41 return (user_);
42 }
43
45 const std::string& getPassword() const {
46 return (password_);
47 }
48
52 virtual isc::data::ElementPtr toElement() const;
53
54private:
55
57 std::string user_;
58
60 std::string password_;
61};
62
64typedef std::list<BasicHttpAuthClient> BasicHttpAuthClientList;
65
68public:
69
72
79 void add(const std::string& user,
80 const std::string& password,
82
86 virtual bool empty() const;
87
89 virtual void clear();
90
95 return (list_);
96 }
97
102 return (map_);
103 }
104
110 void parse(const isc::data::ConstElementPtr& config);
111
115 virtual isc::data::ElementPtr toElement() const;
116
124 const isc::http::HttpRequestPtr& request) const;
125
126private:
127
130
132 BasicHttpAuthMap map_;
133};
134
136typedef boost::shared_ptr<BasicHttpAuthConfig> BasicHttpAuthConfigPtr;
137
138} // end of namespace isc::http
139} // end of namespace isc
140
141#endif // endif HTTP_BASIC_AUTH_CONFIG_H
Basic HTTP authentication client configuration.
const std::string & getPassword() const
Returns the password.
const std::string & getUser() const
Returns the user id.
BasicHttpAuthClient(const std::string &user, const std::string &password, const isc::data::ConstElementPtr &user_context)
Constructor.
virtual isc::data::ElementPtr toElement() const
Unparses basic HTTP authentication client configuration.
Basic HTTP authentication configuration.
const BasicHttpAuthClientList & getClientList() const
Returns the list of client configuration.
virtual isc::data::ElementPtr toElement() const
Unparses basic HTTP authentication configuration.
void parse(const isc::data::ConstElementPtr &config)
Parses basic HTTP authentication configuration.
virtual isc::http::HttpResponseJsonPtr checkAuth(const isc::http::HttpResponseCreator &creator, const isc::http::HttpRequestPtr &request) const
Validate HTTP request.
virtual void clear()
Clear configuration.
virtual ~BasicHttpAuthConfig()
Destructor.
void add(const std::string &user, const std::string &password, const isc::data::ConstElementPtr &user_context=isc::data::ConstElementPtr())
Add a client configuration.
virtual bool empty() const
Empty predicate.
const BasicHttpAuthMap & getCredentialMap() const
Returns the credential and user id map.
Base type of HTTP authentication configuration.
Definition: auth_config.h:23
Specifies an interface for classes creating HTTP responses from HTTP requests.
boost::shared_ptr< const Element > ConstElementPtr
Definition: data.h:27
boost::shared_ptr< Element > ElementPtr
Definition: data.h:24
std::unordered_map< std::string, std::string > BasicHttpAuthMap
Type of basic HTTP authentication credential and user id map, e.g.
boost::shared_ptr< HttpResponseJson > HttpResponseJsonPtr
Pointer to the HttpResponseJson object.
Definition: response_json.h:24
std::list< BasicHttpAuthClient > BasicHttpAuthClientList
Type of basic HTTP authentication client configuration list.
boost::shared_ptr< BasicHttpAuthConfig > BasicHttpAuthConfigPtr
Type of shared pointers to basic HTTP authentication configuration.
boost::shared_ptr< HttpRequest > HttpRequestPtr
Pointer to the HttpRequest object.
Definition: request.h:27
Defines the logger used by the top-level component of kea-lfc.
Abstract class for configuration Cfg_* classes.
Base class for user context.
Definition: user_context.h:22