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
|
//
// 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_SASLCONTEXT_HPP_INCLUDED
#define VMIME_SECURITY_SASL_SASLCONTEXT_HPP_INCLUDED
#include "vmime/config.hpp"
#if VMIME_HAVE_MESSAGING_FEATURES && VMIME_HAVE_SASL_SUPPORT
#include "vmime/types.hpp"
#include "vmime/security/sasl/SASLSession.hpp"
#include "vmime/security/sasl/SASLMechanismFactory.hpp"
namespace vmime {
namespace security {
namespace sasl {
/** An SASL client context.
*/
class VMIME_EXPORT SASLContext : public object, public enable_shared_from_this <SASLContext> {
friend class SASLSession;
friend class builtinSASLMechanism;
public:
~SASLContext();
/** Construct and initialize a new SASL context.
*
* @return pointer to a new SASL context
*/
static shared_ptr <SASLContext> create();
/** Create and initialize a new SASL session.
*
* @param serviceName name of the service which will use the session
* @param auth authenticator object to use during the session
* @param mech SASL mechanism
* @return a new SASL session
*/
shared_ptr <SASLSession> createSession(
const string& serviceName,
const shared_ptr <authenticator>& auth,
const shared_ptr <SASLMechanism>& mech
);
/** Create an instance of an SASL mechanism.
*
* @param name mechanism name
* @return a new instance of the specified SASL mechanism
* @throw exceptions::no_such_mechanism if no mechanism is
* registered for the specified name
*/
shared_ptr <SASLMechanism> createMechanism(const string& name);
/** Suggests an SASL mechanism among a set of mechanisms
* supported by the server.
*
* @param mechs list of mechanisms
* @return suggested mechanism (usually the safest mechanism
* supported by both the client and the server)
*/
shared_ptr <SASLMechanism> suggestMechanism(
const std::vector <shared_ptr <SASLMechanism> >& mechs
);
/** Helper function for decoding Base64-encoded challenge.
*
* @param input input buffer
* @param output output buffer
* @param outputLen length of output buffer
*/
void decodeB64(const string& input, byte_t** output, size_t* outputLen);
/** Helper function for encoding challenge in Base64.
*
* @param input input buffer
* @param inputLen length of input buffer
* @return Base64-encoded challenge
*/
const string encodeB64(const byte_t* input, const size_t inputLen);
private:
SASLContext();
SASLContext(SASLContext&);
static const string getErrorMessage(const string& fname, const int code);
#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_SASLCONTEXT_HPP_INCLUDED
|
