Wolframe, 0.0.3

authUnit.hpp
Go to the documentation of this file.
1 /************************************************************************
2 
3  Copyright (C) 2011 - 2014 Project Wolframe.
4  All rights reserved.
5 
6  This file is part of Project Wolframe.
7 
8  Commercial Usage
9  Licensees holding valid Project Wolframe Commercial licenses may
10  use this file in accordance with the Project Wolframe
11  Commercial License Agreement provided with the Software or,
12  alternatively, in accordance with the terms contained
13  in a written agreement between the licensee and Project Wolframe.
14 
15  GNU General Public License Usage
16  Alternatively, you can redistribute this file and/or modify it
17  under the terms of the GNU General Public License as published by
18  the Free Software Foundation, either version 3 of the License, or
19  (at your option) any later version.
20 
21  Wolframe is distributed in the hope that it will be useful,
22  but WITHOUT ANY WARRANTY; without even the implied warranty of
23  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24  GNU General Public License for more details.
25 
26  You should have received a copy of the GNU General Public License
27  along with Wolframe. If not, see <http://www.gnu.org/licenses/>.
28 
29  If you have questions regarding the use of this file, please contact
30  Project Wolframe.
31 
32 ************************************************************************/
37 
38 #ifndef _AUTHENTICATION_UNIT_HPP_INCLUDED
39 #define _AUTHENTICATION_UNIT_HPP_INCLUDED
40 
41 #include <string>
42 
43 #include "user.hpp"
44 #include "AAAA/authSlice.hpp"
45 #include "AAAA/passwordChanger.hpp"
46 #include "database/DBprovider.hpp"
48 
49 namespace _Wolframe {
50 namespace AAAA {
51 
55 {
56 public:
57  AuthenticationUnit( const std::string& id )
58  : m_identifier( id ) {}
59 
60  virtual ~AuthenticationUnit() {}
61 
62  const std::string& identifier() const { return m_identifier; }
63 
64  virtual bool resolveDB( const db::DatabaseProvider& /*db*/ )
65  { return true; }
66  virtual const char* className() const = 0;
67 
72  virtual const char** mechs() const = 0;
73 
75  virtual AuthenticatorSlice* slice( const std::string& mech,
76  const net::RemoteEndpoint& client ) = 0;
77 
79  virtual PasswordChanger* passwordChanger( const User& /*user*/,
80  const net::RemoteEndpoint& /*client*/ )
81  { return NULL; }
82 private:
83  const std::string m_identifier;
84 };
85 
86 }} // namespace _Wolframe::AAAA
87 
88 #endif // _AUTHENTICATION_UNIT_HPP_INCLUDED
Basic user login information.
const std::string m_identifier
Definition: authUnit.hpp:83
const std::string & identifier() const
Definition: authUnit.hpp:62
Classes for network endpoints.
virtual bool resolveDB(const db::DatabaseProvider &)
Definition: authUnit.hpp:64
Database provider interface.
Database provider.
Definition: DBprovider.hpp:70
Password changer interface This the only interface to be used by the system. All other interfaces are...
Definition: passwordChanger.hpp:52
This is the base class for authenticator slices implementations An authenticator has (usually) severa...
Definition: authSlice.hpp:55
AuthenticationSlice interface.
Data structure containing all login data of a user.
Definition: user.hpp:47
This is the base class for the authentication unit implementations.
Definition: authUnit.hpp:54
virtual const char ** mechs() const =0
The list of mechs implemented by this unit.
virtual PasswordChanger * passwordChanger(const User &, const net::RemoteEndpoint &)
A PasswordChanger for the user (or NULL)
Definition: authUnit.hpp:79
virtual AuthenticatorSlice * slice(const std::string &mech, const net::RemoteEndpoint &client)=0
An AuthenticatorSlice for the required mech (or NULL)
virtual ~AuthenticationUnit()
Definition: authUnit.hpp:60
virtual const char * className() const =0
Remote connection endpoint.
Definition: connectionEndpoint.hpp:190
AuthenticationUnit(const std::string &id)
Definition: authUnit.hpp:57