gpam.h

Go to the documentation of this file.

//
// Copyright (C) 2001-2013 Graeme Walker <graeme_walker@users.sourceforge.net>
// 
// This program is free software: you can redistribute it 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.
// 
// This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
// ===

#ifndef G_PAM_H
#define G_PAM_H

#include "gdef.h"
#include "gexception.h"
#include <string>
#include <vector>

namespace G
{
        class Pam ;
        class PamImp ;
}

class G::Pam 
{
public:
        struct Item 
        {
                const std::string in_type ; // "password", "prompt", "error", "info"
                const std::string in ; // password prompt, non-password prompt, error text, infomation message, etc
                std::string out ; // password, or whatever was prompted for
                bool out_defined ; // to be set to true if 'out' is assigned
        } ;
        typedef std::vector<Item> ItemArray ;

        class Error : public G::Exception 
        { 
                public: int m_pam_error ;
                public: Error( const std::string & op , int pam_error ) ;
                public: Error( const std::string & op , int pam_error , const char * ) ;
        } ;

        Pam( const std::string & app , const std::string & user , bool silent ) ;

        virtual ~Pam() ;

        bool authenticate( bool require_token ) ;

        std::string name() const ;

        void checkAccount( bool require_token ) ;

        void establishCredentials() ;

        void openSession() ;

        void closeSession() ;

        void deleteCredentials() ;

        void reinitialiseCredentials() ;

        void refreshCredentials() ;

        virtual void converse( ItemArray & ) = 0 ;

        virtual void delay( unsigned int usec ) = 0 ;

private:
        Pam( const Pam & ) ; // not implemented
        void operator=( const Pam & ) ; // not implemented

private:
        PamImp * m_imp ;
} ;

#endif