authenticator.hpp

Go to the documentation of this file.

/************************************************************************

 Copyright (C) 2011 - 2014 Project Wolframe.
 All rights reserved.

 This file is part of Project Wolframe.

 Commercial Usage
    Licensees holding valid Project Wolframe Commercial licenses may
    use this file in accordance with the Project Wolframe
    Commercial License Agreement provided with the Software or,
    alternatively, in accordance with the terms contained
    in a written agreement between the licensee and Project Wolframe.

 GNU General Public License Usage
    Alternatively, you can redistribute this file and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Wolframe is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Wolframe.  If not, see <http://www.gnu.org/licenses/>.

 If you have questions regarding the use of this file, please contact
 Project Wolframe.

************************************************************************/

#ifndef _AUTHENTICATOR_HPP_INCLUDED
#define _AUTHENTICATOR_HPP_INCLUDED

#include <string>
#include <vector>
#include "AAAA/user.hpp"
#include "system/connectionEndpoint.hpp"

namespace _Wolframe {
namespace AAAA {

class Authenticator
{
public:
        enum Status     {
                INITIALIZED,            
                MESSAGE_AVAILABLE,      
                AWAITING_MESSAGE,       
                AUTHENTICATED,          
                INVALID_CREDENTIALS,    
                MECH_UNAVAILABLE,       
                SYSTEM_FAILURE          
        };

        static const char* statusName( Status i)
        {
                static const char* ar[] = {"INITIALIZED","MESSAGE_AVAILABLE","AWAITING_MESSAGE","AUTHENTICATED","INVALID_CREDENTIALS","MECH_UNAVAILABLE","SYSTEM_FAILURE"};
                return ar[i];
        }

        virtual ~Authenticator()        {}

        virtual void dispose() = 0;

        virtual const std::vector<std::string>& mechs() const = 0;

        virtual bool setMech( const std::string& mech ) = 0;

        virtual void messageIn( const std::string& message ) = 0;

        virtual std::string messageOut() = 0;

        virtual Status status() const = 0;

        virtual User* user() = 0;
};

}} // namespace _Wolframe::AAAA

#endif // _AUTHENTICATOR_HPP_INCLUDED