E-MailRelay

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

gsaslclientsecrets.h
Go to the documentation of this file.
1 //
2 // Copyright (C) 2001-2018 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 gsaslclientsecrets.h
19 ///
20
21 #ifndef G_SASL_CLIENT_SECRETS_H
22 #define G_SASL_CLIENT_SECRETS_H
23
24 #include "gdef.h"
25 #include "gvalid.h"
26 #include "gsecret.h"
27
28 namespace GAuth
29 {
30 class SaslClientSecrets ;
31 }
32
33 /// \class GAuth::SaslClientSecrets
34 /// An interface used by GAuth::SaslClient to obtain a client id and
35 /// its authentication secret. Conceptually there is one client and
36 /// they can have a secrets encoded in multiple ways.
37 ///
38 class GAuth::SaslClientSecrets : public virtual Valid
39 {
40 public:
41 virtual Secret clientSecret( const std::string & encoding_type ) const = 0 ;
42 ///< Returns the client secret for the given encoding type.
43 ///< Returns an invalid secret if none.
44
45 protected:
46 virtual ~SaslClientSecrets() ;
47 ///< Destructor.
48
49 private:
50 void operator=( const SaslClientSecrets & ) ;
51 } ;
52
53 #endif
GAuth::SaslClientSecrets
An interface used by GAuth::SaslClient to obtain a client id and its authentication secret...
Definition: gsaslclientsecrets.h:38
gsecret.h
gvalid.h
GAuth::SaslClientSecrets::clientSecret
virtual Secret clientSecret(const std::string &encoding_type) const =0
Returns the client secret for the given encoding type.
GAuth::SaslClientSecrets::~SaslClientSecrets
virtual ~SaslClientSecrets()
Destructor.
Definition: gsaslclientsecrets.cpp:24
GAuth
SASL authentication classes.
Definition: gcram.h:30
GAuth::Secret
Encapsulates a shared secret from the secrets file plus the associated userid.
Definition: gsecret.h:42
GAuth::Valid
A trivial mix-in interface containing a valid() method.
Definition: gvalid.h:33