1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002 Vincent Richard <vincent@vmime.org>
//
// 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, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library. Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//
#ifndef VMIME_SECURITY_SASL_SASLMECHANISMFACTORY_HPP_INCLUDED
#define VMIME_SECURITY_SASL_SASLMECHANISMFACTORY_HPP_INCLUDED
#include "vmime/config.hpp"
#if VMIME_HAVE_MESSAGING_FEATURES && VMIME_HAVE_SASL_SUPPORT
#include "vmime/types.hpp"
#include "vmime/base.hpp"
#include "vmime/security/sasl/SASLMechanism.hpp"
#include <map>
namespace vmime {
namespace security {
namespace sasl {
class SASLContext;
/** Constructs SASL mechanism objects.
*/
class VMIME_EXPORT SASLMechanismFactory : public object {
private:
SASLMechanismFactory();
~SASLMechanismFactory();
struct registeredMechanism : public object {
virtual shared_ptr <SASLMechanism> create(
const shared_ptr <SASLContext>& ctx, const string& name
) = 0;
};
template <typename T>
struct registeredMechanismImpl : public registeredMechanism {
shared_ptr <SASLMechanism> create(
const shared_ptr <SASLContext>& ctx,
const string& name
) {
return vmime::make_shared <T>(ctx, name);
}
};
typedef std::map <string, shared_ptr <registeredMechanism> > MapType;
MapType m_mechs;
public:
static SASLMechanismFactory* getInstance();
/** Register a mechanism into this factory, so that subsequent
* calls to create return a valid object for this mechanism.
*
* @param name mechanism name
*/
template <typename MECH_CLASS>
void registerMechanism(const string& name) {
m_mechs.insert(
MapType::value_type(
name,
vmime::make_shared <registeredMechanismImpl <MECH_CLASS> >()
)
);
}
/** Create a mechanism object given its name.
*
* @param ctx SASL context
* @param name mechanism name
* @return a new mechanism object
* @throw exceptions::no_such_mechanism if no mechanism is
* registered for the specified name
*/
shared_ptr <SASLMechanism> create(const shared_ptr <SASLContext>& ctx, const string& name);
/** Return a list of supported mechanisms. This includes mechanisms
* registered using registerMechanism() as well as the ones that
* are built-in.
*
* @return list of supported mechanisms
*/
const std::vector <string> getSupportedMechanisms() const;
/** Test whether an authentication mechanism is supported.
*
* @param name mechanism name
* @return true if the specified mechanism is supported,
* false otherwise
*/
bool isMechanismSupported(const string& name) const;
/** Test whether an authentication mechanism is directly supported
* by the underlying SASL library.
*
* @param name mechanism name
* @return true if the specified mechanism is built-in,
* or false otherwise
*/
bool isBuiltinMechanism(const string& name) const;
private:
#ifdef GSASL_VERSION
Gsasl* m_gsaslContext;
#else
void* m_gsaslContext;
#endif // GSASL_VERSION
};
} // sasl
} // security
} // vmime
#endif // VMIME_HAVE_MESSAGING_FEATURES && VMIME_HAVE_SASL_SUPPORT
#endif // VMIME_SECURITY_SASL_SASLMECHANISMFACTORY_HPP_INCLUDED
|
