gsaslclient.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_SASL_CLIENT_H
#define G_SASL_CLIENT_H

#include "gdef.h"
#include "gauth.h"
#include "gvalid.h"
#include "gexception.h"
#include "gaddress.h"
#include "gstrings.h"
#include "gpath.h"
#include <map>
#include <memory>

namespace GAuth
{
        class SaslClient ;
        class SaslClientImp ;
}

class GAuth::SaslClient 
{
public:
        class Secrets : public virtual Valid 
        {
                public: virtual std::string id( const std::string & mechanism ) const = 0 ;
                public: virtual std::string secret( const std::string & id ) const = 0 ;
                public: virtual ~Secrets() ;
                private: void operator=( const Secrets & ) ; // not implemented
        } ;

        SaslClient( const Secrets & secrets , const std::string & server_name ) ;

        ~SaslClient() ;

        bool active() const ;

        std::string response( const std::string & mechanism , const std::string & challenge , 
                bool & done , bool & error , bool & sensitive ) const ;

        std::string preferred( const G::Strings & mechanisms ) const ;

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

private:
        SaslClientImp * m_imp ;
} ;

#endif