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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
//
// 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_SASLSESSION_HPP_INCLUDED
#define VMIME_SECURITY_SASL_SASLSESSION_HPP_INCLUDED
#include "vmime/config.hpp"
#if VMIME_HAVE_MESSAGING_FEATURES && VMIME_HAVE_SASL_SUPPORT
#include "vmime/types.hpp"
#include "vmime/net/socket.hpp"
#include "vmime/security/sasl/SASLAuthenticator.hpp"
#include "vmime/security/sasl/SASLMechanism.hpp"
namespace vmime {
namespace security {
namespace sasl {
class SASLContext;
/** An SASL client session.
*/
class VMIME_EXPORT SASLSession : public object, public enable_shared_from_this <SASLSession> {
friend class builtinSASLMechanism;
friend class SASLSocket;
public:
~SASLSession();
/** Construct a new SASL session.
*
* @param serviceName name of the service using this session
* @param ctx SASL context
* @param auth authenticator to use for this session
* @param mech SASL mechanism
*/
static shared_ptr <SASLSession> create(
const string& serviceName,
const shared_ptr <SASLContext>& ctx,
const shared_ptr <authenticator>& auth,
const shared_ptr <SASLMechanism>& mech
);
/** Initialize this SASL session. This must be called before
* calling any other method on this object (except accessors).
*/
void init();
/** Return the authenticator used for this session. This is the
* authenticator which has been previously set with a call to
* setAuthenticator().
*
* @return authenticator object
*/
shared_ptr <authenticator> getAuthenticator();
/** Return the mechanism used for this session.
*
* @return SASL mechanism
*/
shared_ptr <SASLMechanism> getMechanism();
/** Return the SASL context.
*
* @return SASL context
*/
shared_ptr <SASLContext> getContext();
/** Perform one step of SASL authentication. Accept data from the
* server (challenge), process it and return data to be returned
* in response to the server.
*
* If the challenge is empty (challengeLen == 0), the initial
* response is returned, if the mechanism has one.
*
* @param challenge challenge sent from the server
* @param challengeLen length of challenge
* @param response response to send to the server (allocated by
* this function, free with delete[])
* @param responseLen length of response buffer
* @return true if authentication terminated successfully, or
* false if the authentication process should continue
* @throw exceptions::sasl_exception if an error occurred during
* authentication (in this case, the values in 'response' and
* 'responseLen' are undetermined)
*/
bool evaluateChallenge(
const byte_t* challenge,
const size_t challengeLen,
byte_t** response,
size_t* responseLen
);
/** Return a socket in which transmitted data is integrity
* and/or privacy protected, depending on the QOP (Quality of
* Protection) negotiated during the SASL authentication.
*
* @param sok socket to wrap
* @return secured socket
*/
shared_ptr <net::socket> getSecuredSocket(const shared_ptr <net::socket>& sok);
/** Return the name of the service which is using this
* SASL session (eg. "imap"). This value should be returned
* by the authenticator when INFO_SERVICE is requested.
*
* @return service name
*/
const string getServiceName() const;
private:
SASLSession(
const string& serviceName,
const shared_ptr <SASLContext>& ctx,
const shared_ptr <authenticator>& auth,
const shared_ptr <SASLMechanism>& mech
);
const string m_serviceName;
shared_ptr <SASLContext> m_context;
shared_ptr <authenticator> m_auth;
shared_ptr <SASLMechanism> m_mech;
#ifdef GSASL_VERSION
Gsasl* m_gsaslContext;
Gsasl_session* m_gsaslSession;
static int gsaslCallback(Gsasl* ctx, Gsasl_session* sctx, Gsasl_property prop);
#else
void* m_gsaslContext;
void* m_gsaslSession;
static int gsaslCallback(void* ctx, void* sctx, int prop);
#endif // GSASL_VERSION
};
} // sasl
} // security
} // vmime
#endif // VMIME_HAVE_MESSAGING_FEATURES && VMIME_HAVE_SASL_SUPPORT
#endif // VMIME_SECURITY_SASL_SASLSESSION_HPP_INCLUDED
|
