E-MailRelay

gsaslserverbasic.h
Go to the documentation of this file.
1//
2// Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
3//
4// This program is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// This program is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with this program. If not, see <http://www.gnu.org/licenses/>.
16// ===
17///
18/// \file gsaslserverbasic.h
19///
20
21#ifndef G_SASL_SERVER_BASIC_H
22#define G_SASL_SERVER_BASIC_H
23
24#include "gdef.h"
25#include "gvalid.h"
26#include "gsecrets.h"
27#include "gsaslserver.h"
28#include "gexception.h"
29#include "gaddress.h"
30#include "gstrings.h"
31#include "gpath.h"
32#include <map>
33#include <memory>
34
35 namespace GAuth
36{
37 class SaslServerBasicImp ;
38 class SaslServerBasic ;
39}
40
41//| \class GAuth::SaslServerBasic
42/// An implementation of the SaslServer interface that does not use PAM.
43/// \see GAuth::SaslServerPam
44///
45 class GAuth::SaslServerBasic : public SaslServer
46{
47 public:
48 G_EXCEPTION( NoMechanisms , "no server authentication mechanisms available" ) ;
49
50 explicit SaslServerBasic( const SaslServerSecrets & , const std::string & config , bool allow_apop ) ;
51 ///< Constructor.
52
53 public:
54 ~SaslServerBasic() override ;
55 SaslServerBasic( const SaslServerBasic & ) = delete ;
56 SaslServerBasic( SaslServerBasic && ) = delete ;
57 void operator=( const SaslServerBasic & ) = delete ;
58 void operator=( SaslServerBasic && ) = delete ;
59
60 private: // overrides
61 bool requiresEncryption() const override ; // Override from GAuth::SaslServer.
62 bool active() const override ; // Override from GAuth::SaslServer.
63 std::string mechanisms( char sep ) const override ; // Override from GAuth::SaslServer.
64 bool init( const std::string & mechanism ) override ; // Override from GAuth::SaslServer.
65 std::string mechanism() const override ; // Override from GAuth::SaslServer.
66 bool mustChallenge() const override ; // Override from GAuth::SaslServer.
67 std::string initialChallenge() const override ; // Override from GAuth::SaslServer.
68 std::string apply( const std::string & response , bool & done ) override ; // Override from GAuth::SaslServer.
69 bool authenticated() const override ; // Override from GAuth::SaslServer.
70 std::string id() const override ; // Override from GAuth::SaslServer.
71 bool trusted( const GNet::Address & ) const override ; // Override from GAuth::SaslServer.
72
73 private:
74 std::unique_ptr<SaslServerBasicImp> m_imp ;
75} ;
76
77#endif
GAuth::SaslServerBasic
An implementation of the SaslServer interface that does not use PAM.
Definition: gsaslserverbasic.h:46
GAuth::SaslServerBasic::SaslServerBasic
SaslServerBasic(const SaslServerSecrets &, const std::string &config, bool allow_apop)
Constructor.
Definition: gsaslserverbasic.cpp:307
GAuth::SaslServerSecrets
An interface used by GAuth::SaslServer to obtain authentication secrets.
Definition: gsaslserversecrets.h:40
GAuth::SaslServer
An interface for implementing the server-side SASL challenge/response concept.
Definition: gsaslserver.h:67
GNet::Address
The GNet::Address class encapsulates a TCP/UDP transport address.
Definition: gaddress.h:53
gaddress.h
gexception.h
gpath.h
gsaslserver.h
gsecrets.h
gstrings.h
gvalid.h
GAuth
SASL authentication classes.
Definition: gcram.cpp:36