E-MailRelay

gsaslserverpam.h
Go to the documentation of this file.
1//
2// Copyright (C) 2001-2024 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 gsaslserverpam.h
19///
20
21#ifndef G_SASL_SERVER_PAM_H
22#define G_SASL_SERVER_PAM_H
23
24#include "gdef.h"
25#include "gsecrets.h"
26#include "gsaslserver.h"
27#include "gexception.h"
28#include "gaddress.h"
29#include "gpath.h"
30#include <memory>
31
32 namespace GAuth
33{
34 class SaslServerPamImp ;
35 class SaslServerPam ;
36}
37
38//| \class GAuth::SaslServerPam
39/// An implementation of the SaslServer interface using PAM as the
40/// authentication mechanism.
41///
42/// This class tries to match up the PAM interface with the SASL server
43/// interface. The match is not perfect; only single-challenge PAM
44/// mechanisms are supported, the PAM delay feature is not implemented,
45/// and PAM sessions are not part of the SASL interface.
46///
47 class GAuth::SaslServerPam : public SaslServer
48{
49 public:
50 explicit SaslServerPam( bool with_apop ) ;
51 ///< Constructor.
52
53 public:
54 ~SaslServerPam() override ;
55 SaslServerPam( const SaslServerPam & ) = delete ;
56 SaslServerPam( SaslServerPam && ) = delete ;
57 SaslServerPam & operator=( const SaslServerPam & ) = delete ;
58 SaslServerPam & operator=( SaslServerPam && ) = delete ;
59
60 private: // overrides
61 G::StringArray mechanisms( bool ) const override ; // Override from GAuth::SaslServer.
62 void reset() override ; // Override from GAuth::SaslServer.
63 bool init( bool , const std::string & mechanism ) override ; // Override from GAuth::SaslServer.
64 std::string mechanism() const override ; // Override from GAuth::SaslServer.
65 std::string preferredMechanism( bool ) 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 G::StringArray & , const std::string & ) const override ; // Override from GAuth::SaslServer.
72
73 private:
74 std::unique_ptr<SaslServerPamImp> m_imp ;
75} ;
76
77#endif
GAuth::SaslServerPam
An implementation of the SaslServer interface using PAM as the authentication mechanism.
Definition: gsaslserverpam.h:48
GAuth::SaslServerPam::SaslServerPam
SaslServerPam(bool with_apop)
Constructor.
Definition: gsaslserverpam.cpp:213
GAuth::SaslServer
An interface for implementing the server-side SASL challenge/response concept.
Definition: gsaslserver.h:76
gaddress.h
gexception.h
gpath.h
gsaslserver.h
gsecrets.h
GAuth
SASL authentication classes.
Definition: gcram.cpp:38
G::StringArray
std::vector< std::string > StringArray
A std::vector of std::strings.
Definition: gstringarray.h:30