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_AUTHENTICATOR_HPP_INCLUDED
#define VMIME_SECURITY_AUTHENTICATOR_HPP_INCLUDED
#include "vmime/config.hpp"
#if VMIME_HAVE_MESSAGING_FEATURES
#include "vmime/types.hpp"
// Forward declarations
namespace vmime {
namespace net {
class service;
} // net
} // vmime
namespace vmime {
namespace security {
/** Provides required information for user authentication. The same
* information can be requested multiple time (eg. in IMAP, there is a
* new connection started each time a folder is open), so the object is
* responsible for caching the information to avoid useless interactions
* with the user.
*
* Usually, you should not inherit from this class, but instead from the
* more convenient defaultAuthenticator class.
*
* WARNING: an authenticator should be used with one and ONLY ONE messaging
* service at a time.
*/
class VMIME_EXPORT authenticator : public object {
public:
/** Return the authentication identity (usually, this
* is the username).
*
* @return username
* @throw exceptions::no_auth_information if the information
* could not be provided
*/
virtual const string getUsername() const = 0;
/** Return the password of the authentication identity.
*
* @return password
* @throw exceptions::no_auth_information if the information
* could not be provided
*/
virtual const string getPassword() const = 0;
/** Return the optional access token for authentication. This is
* used for example with XOAuth2 SASL authentication.
*
* @return access token
* @throw exceptions::no_auth_information if the information
* could not be provided
*/
virtual const string getAccessToken() const = 0;
/** Return the local host name of the machine.
*
* @return hostname
* @throw exceptions::no_auth_information if the information
* could not be provided
*/
virtual const string getHostname() const = 0;
/** Return the anonymous token (usually, this is the user's
* email address).
*
* @return anonymous token
* @throw exceptions::no_auth_information if the information
* could not be provided
*/
virtual const string getAnonymousToken() const = 0;
/** Return the registered service name of the application
* service (eg: "imap"). This can be used by GSSAPI or DIGEST-MD5
* mechanisms with SASL.
*
* @return service name
* @throw exceptions::no_auth_information if the information
* could not be provided
*/
virtual const string getServiceName() const = 0;
/** Called by the messaging service to allow this authenticator to
* know which service is currently using it. This is called just
* before the service starts the authentication process.
*
* @param serv messaging service instance
*/
virtual void setService(const shared_ptr <net::service>& serv) = 0;
};
} // security
} // vmime
#endif // VMIME_HAVE_MESSAGING_FEATURES
#endif // VMIME_SECURITY_AUTHENTICATOR_HPP_INCLUDED
|
