a (incomplete) implementation of draft-sheffer-ikev2-gtc-00.txt using PAM
[strongswan.git] / src / charon / sa / authenticators / eap / eap_method.h
1 /*
2 * Copyright (C) 2006 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 *
15 * $Id$
16 */
17
18 /**
19 * @defgroup eap_method eap_method
20 * @{ @ingroup eap
21 */
22
23 #ifndef EAP_METHOD_H_
24 #define EAP_METHOD_H_
25
26 typedef struct eap_method_t eap_method_t;
27 typedef enum eap_role_t eap_role_t;
28 typedef enum eap_type_t eap_type_t;
29 typedef enum eap_code_t eap_code_t;
30
31 #include <library.h>
32 #include <utils/identification.h>
33 #include <encoding/payloads/eap_payload.h>
34
35 /**
36 * Role of an eap_method, SERVER or PEER (client)
37 */
38 enum eap_role_t {
39 EAP_SERVER,
40 EAP_PEER,
41 };
42 /**
43 * enum names for eap_role_t.
44 */
45 extern enum_name_t *eap_role_names;
46
47 /**
48 * EAP types, defines the EAP method implementation
49 */
50 enum eap_type_t {
51 EAP_IDENTITY = 1,
52 EAP_NOTIFICATION = 2,
53 EAP_NAK = 3,
54 EAP_MD5 = 4,
55 EAP_OTP = 5,
56 EAP_GTC = 6,
57 EAP_SIM = 18,
58 EAP_AKA = 23,
59 EAP_EXPANDED = 254,
60 EAP_EXPERIMENTAL = 255,
61 };
62
63 /**
64 * enum names for eap_type_t.
65 */
66 extern enum_name_t *eap_type_names;
67
68 /**
69 * EAP code, type of an EAP message
70 */
71 enum eap_code_t {
72 EAP_REQUEST = 1,
73 EAP_RESPONSE = 2,
74 EAP_SUCCESS = 3,
75 EAP_FAILURE = 4,
76 };
77
78 /**
79 * enum names for eap_code_t.
80 */
81 extern enum_name_t *eap_code_names;
82
83
84 /**
85 * Interface of an EAP method for server and client side.
86 *
87 * An EAP method initiates an EAP exchange and processes requests and
88 * responses. An EAP method may need multiple exchanges before succeeding, and
89 * the eap_authentication may use multiple EAP methods to authenticate a peer.
90 * To accomplish these requirements, all EAP methods have their own
91 * implementation while the eap_authenticatior uses one or more of these
92 * EAP methods. Sending of EAP(SUCCESS/FAILURE) message is not the job
93 * of the method, the eap_authenticator does this.
94 * An EAP method may establish a MSK, this is used the complete the
95 * authentication. Even if a mutual EAP method is used, the traditional
96 * AUTH payloads are required. Only these include the nonces and messages from
97 * ike_sa_init and therefore prevent man in the middle attacks.
98 */
99 struct eap_method_t {
100
101 /**
102 * Initiate the EAP exchange.
103 *
104 * initiate() is only useable for server implementations, as clients only
105 * reply to server requests.
106 * A eap_payload is created in "out" if result is NEED_MORE.
107 *
108 * @param out eap_payload to send to the client
109 * @return
110 * - NEED_MORE, if an other exchange is required
111 * - FAILED, if unable to create eap request payload
112 */
113 status_t (*initiate) (eap_method_t *this, eap_payload_t **out);
114
115 /**
116 * Process a received EAP message.
117 *
118 * A eap_payload is created in "out" if result is NEED_MORE.
119 *
120 * @param in eap_payload response received
121 * @param out created eap_payload to send
122 * @return
123 * - NEED_MORE, if an other exchange is required
124 * - FAILED, if EAP method failed
125 * - SUCCESS, if EAP method succeeded
126 */
127 status_t (*process) (eap_method_t *this, eap_payload_t *in,
128 eap_payload_t **out);
129
130 /**
131 * Get the EAP type implemented in this method.
132 *
133 * @param vendor pointer receiving vendor identifier for type, 0 for none
134 * @return type of the EAP method
135 */
136 eap_type_t (*get_type) (eap_method_t *this, u_int32_t *vendor);
137
138 /**
139 * Check if this EAP method authenticates the server.
140 *
141 * Some EAP methods provide mutual authentication and
142 * allow authentication using only EAP, if the peer supports it.
143 *
144 * @return TRUE if methods provides mutual authentication
145 */
146 bool (*is_mutual) (eap_method_t *this);
147
148 /**
149 * Get the MSK established by this EAP method.
150 *
151 * Not all EAP methods establish a shared secret.
152 *
153 * @param msk chunk receiving internal stored MSK
154 * @return
155 * - SUCCESS, or
156 * - FAILED, if MSK not established (yet)
157 */
158 status_t (*get_msk) (eap_method_t *this, chunk_t *msk);
159
160 /**
161 * Destroys a eap_method_t object.
162 */
163 void (*destroy) (eap_method_t *this);
164 };
165
166 /**
167 * Constructor definition for a pluggable EAP method.
168 *
169 * Each EAP module must define a constructor function which will return
170 * an initialized object with the methods defined in eap_method_t.
171 * Constructors for server and peers are identical, to support both roles
172 * of a EAP method, a plugin needs register two constructors in the
173 * eap_manager_t.
174 *
175 * @param server ID of the server to use for credential lookup
176 * @param peer ID of the peer to use for credential lookup
177 * @return implementation of the eap_method_t interface
178 */
179 typedef eap_method_t *(*eap_constructor_t)(identification_t *server,
180 identification_t *peer);
181
182 #endif /* EAP_METHOD_H_ @} */