Removed strayed code fragment
[strongswan.git] / src / charon / plugins / eap_radius / radius_message.h
1 /*
2 * Copyright (C) 2009 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
16 /**
17 * @defgroup radius_message radius_message
18 * @{ @ingroup eap_radius
19 */
20
21 #ifndef RADIUS_MESSAGE_H_
22 #define RADIUS_MESSAGE_H_
23
24 #include <library.h>
25
26 typedef struct radius_message_t radius_message_t;
27 typedef enum radius_message_code_t radius_message_code_t;
28 typedef enum radius_attribute_type_t radius_attribute_type_t;
29
30 /**
31 * RADIUS Message Codes.
32 */
33 enum radius_message_code_t {
34 RMC_ACCESS_REQUEST = 1,
35 RMC_ACCESS_ACCEPT = 2,
36 RMC_ACCESS_REJECT = 3,
37 RMC_ACCOUNTING_REQUEST = 4,
38 RMC_ACCOUNTING_RESPONSE = 5,
39 RMC_ACCESS_CHALLENGE = 11,
40 };
41
42 /**
43 * Enum names for radius_attribute_type_t.
44 */
45 extern enum_name_t *radius_message_code_names;
46
47 /**
48 * RADIUS Attribute Types.
49 */
50 enum radius_attribute_type_t {
51 RAT_USER_NAME = 1,
52 RAT_USER_PASSWORD = 2,
53 RAT_CHAP_PASSWORD = 3,
54 RAT_NAS_IP_ADDRESS = 4,
55 RAT_NAS_PORT = 5,
56 RAT_SERVICE_TYPE = 6,
57 RAT_FRAMED_PROTOCOL = 7,
58 RAT_FRAMED_IP_ADDRESS = 8,
59 RAT_FRAMED_IP_NETMASK = 9,
60 RAT_FRAMED_ROUTING = 10,
61 RAT_FILTER_ID = 11,
62 RAT_FRAMED_MTU = 12,
63 RAT_FRAMED_COMPRESSION = 13,
64 RAT_LOGIN_IP_HOST = 14,
65 RAT_LOGIN_SERVICE = 15,
66 RAT_LOGIN_TCP_PORT = 16,
67 RAT_REPLY_MESSAGE = 18,
68 RAT_CALLBACK_NUMBER = 19,
69 RAT_CALLBACK_ID = 20,
70 RAT_FRAMED_ROUTE = 22,
71 RAT_FRAMED_IPX_NETWORK = 23,
72 RAT_STATE = 24,
73 RAT_CLASS = 25,
74 RAT_VENDOR_SPECIFIC = 26,
75 RAT_SESSION_TIMEOUT = 27,
76 RAT_IDLE_TIMEOUT = 28,
77 RAT_TERMINATION_ACTION = 29,
78 RAT_CALLED_STATION_ID = 30,
79 RAT_CALLING_STATION_ID = 31,
80 RAT_NAS_IDENTIFIER = 32,
81 RAT_PROXY_STATE = 33,
82 RAT_LOGIN_LAT_SERVICE = 34,
83 RAT_LOGIN_LAT_NODE = 35,
84 RAT_LOGIN_LAT_GROUP = 36,
85 RAT_FRAMED_APPLETALK_LINK = 37,
86 RAT_FRAMED_APPLETALK_NETWORK = 38,
87 RAT_FRAMED_APPLETALK_ZONE = 39,
88 RAT_ACCT_STATUS_TYPE = 40,
89 RAT_ACCT_DELAY_TIME = 41,
90 RAT_ACCT_INPUT_OCTETS = 42,
91 RAT_ACCT_OUTPUT_OCTETS = 43,
92 RAT_ACCT_SESSION_ID = 44,
93 RAT_ACCT_AUTHENTIC = 45,
94 RAT_ACCT_SESSION_TIME = 46,
95 RAT_ACCT_INPUT_PACKETS = 47,
96 RAT_ACCT_OUTPUT_PACKETS = 48,
97 RAT_ACCT_TERMINATE_CAUSE = 49,
98 RAT_ACCT_MULTI_SESSION_ID = 50,
99 RAT_ACCT_LINK_COUNT = 51,
100 RAT_ACCT_INPUT_GIGAWORDS = 52,
101 RAT_ACCT_OUTPUT_GIGAWORDS = 53,
102 RAT_EVENT_TIMESTAMP = 55,
103 RAT_EGRESS_VLANID = 56,
104 RAT_INGRESS_FILTERS = 57,
105 RAT_EGRESS_VLAN_NAME = 58,
106 RAT_USER_PRIORITY_TABLE = 59,
107 RAT_CHAP_CHALLENGE = 60,
108 RAT_NAS_PORT_TYPE = 61,
109 RAT_PORT_LIMIT = 62,
110 RAT_LOGIN_LAT_PORT = 63,
111 RAT_TUNNEL_TYPE = 64,
112 RAT_TUNNEL_MEDIUM_TYPE = 65,
113 RAT_TUNNEL_CLIENT_ENDPOINT = 66,
114 RAT_TUNNEL_SERVER_ENDPOINT = 67,
115 RAT_ACCT_TUNNEL_CONNECTION = 68,
116 RAT_TUNNEL_PASSWORD = 69,
117 RAT_ARAP_PASSWORD = 70,
118 RAT_ARAP_FEATURES = 71,
119 RAT_ARAP_ZONE_ACCESS = 72,
120 RAT_ARAP_SECURITY = 73,
121 RAT_ARAP_SECURITY_DATA = 74,
122 RAT_PASSWORD_RETRY = 75,
123 RAT_PROMPT = 76,
124 RAT_CONNECT_INFO = 77,
125 RAT_CONFIGURATION_TOKEN = 78,
126 RAT_EAP_MESSAGE = 79,
127 RAT_MESSAGE_AUTHENTICATOR = 80,
128 RAT_TUNNEL_PRIVATE_GROUP_ID = 81,
129 RAT_TUNNEL_ASSIGNMENT_ID = 82,
130 RAT_TUNNEL_PREFERENCE = 83,
131 RAT_ARAP_CHALLENGE_RESPONSE = 84,
132 RAT_ACCT_INTERIM_INTERVAL = 85,
133 RAT_ACCT_TUNNEL_PACKETS_LOST = 86,
134 RAT_NAS_PORT_ID = 87,
135 RAT_FRAMED_POOL = 88,
136 RAT_CUI = 89,
137 RAT_TUNNEL_CLIENT_AUTH_ID = 90,
138 RAT_TUNNEL_SERVER_AUTH_ID = 91,
139 RAT_NAS_FILTER_RULE = 92,
140 RAT_UNASSIGNED = 93,
141 RAT_ORIGINATING_LINE_INFO = 94,
142 RAT_NAS_IPV6_ADDRESS = 95,
143 RAT_FRAMED_INTERFACE_ID = 96,
144 RAT_FRAMED_IPV6_PREFIX = 97,
145 RAT_LOGIN_IPV6_HOST = 98,
146 RAT_FRAMED_IPV6_ROUTE = 99,
147 RAT_FRAMED_IPV6_POOL = 100,
148 RAT_ERROR_CAUSE = 101,
149 RAT_EAP_KEY_NAME = 102,
150 RAT_DIGEST_RESPONSE = 103,
151 RAT_DIGEST_REALM = 104,
152 RAT_DIGEST_NONCE = 105,
153 RAT_DIGEST_RESPONSE_AUTH = 106,
154 RAT_DIGEST_NEXTNONCE = 107,
155 RAT_DIGEST_METHOD = 108,
156 RAT_DIGEST_URI = 109,
157 RAT_DIGEST_QOP = 110,
158 RAT_DIGEST_ALGORITHM = 111,
159 RAT_DIGEST_ENTITY_BODY_HASH = 112,
160 RAT_DIGEST_CNONCE = 113,
161 RAT_DIGEST_NONCE_COUNT = 114,
162 RAT_DIGEST_USERNAME = 115,
163 RAT_DIGEST_OPAQUE = 116,
164 RAT_DIGEST_AUTH_PARAM = 117,
165 RAT_DIGEST_AKA_AUTS = 118,
166 RAT_DIGEST_DOMAIN = 119,
167 RAT_DIGEST_STALE = 120,
168 RAT_DIGEST_HA1 = 121,
169 RAT_SIP_AOR = 122,
170 RAT_DELEGATED_IPV6_PREFIX = 123,
171 RAT_MIP6_FEATURE_VECTOR = 124,
172 RAT_MIP6_HOME_LINK_PREFIX = 125,
173 };
174
175 /**
176 * Enum names for radius_attribute_type_t.
177 */
178 extern enum_name_t *radius_attribute_type_names;
179
180 /**
181 * A RADIUS message, contains attributes.
182 */
183 struct radius_message_t {
184
185 /**
186 * Create an enumerator over contained RADIUS attributes.
187 *
188 * @return enumerator over (int type, chunk_t data)
189 */
190 enumerator_t* (*create_enumerator)(radius_message_t *this);
191
192 /**
193 * Add a RADIUS attribute to the message.
194 *
195 * @param type type of attribute to add
196 * @param attribute data, gets cloned
197 */
198 void (*add)(radius_message_t *this, radius_attribute_type_t type,
199 chunk_t data);
200
201 /**
202 * Get the message type (code).
203 *
204 * @return message code
205 */
206 radius_message_code_t (*get_code)(radius_message_t *this);
207
208 /**
209 * Get the message identifier.
210 *
211 * @return message identifier
212 */
213 u_int8_t (*get_identifier)(radius_message_t *this);
214
215 /**
216 * Set the message identifier.
217 *
218 * @param identifier message identifier
219 */
220 void (*set_identifier)(radius_message_t *this, u_int8_t identifier);
221
222 /**
223 * Get the 16 byte authenticator.
224 *
225 * @return pointer to the Authenticator field
226 */
227 u_int8_t* (*get_authenticator)(radius_message_t *this);
228
229 /**
230 * Get the RADIUS message in its encoded form.
231 *
232 * @return chunk pointing to internal RADIUS message.
233 */
234 chunk_t (*get_encoding)(radius_message_t *this);
235
236 /**
237 * Calculate and add the Message-Authenticator attribute to the message.
238 *
239 * @param rng RNG to create Request-Authenticator
240 * @param signer HMAC-MD5 signer with secret set
241 */
242 void (*sign)(radius_message_t *this, rng_t *rng, signer_t *signer);
243
244 /**
245 * Verify the integrity of a received RADIUS response.
246 *
247 * @param req_auth 16 byte Authenticator of the corresponding request
248 * @param secret shared RADIUS secret
249 * @param hasher hasher to verify Response-Authenticator
250 * @param signer signer to verify Message-Authenticator attribute
251 */
252 bool (*verify)(radius_message_t *this, u_int8_t *req_auth, chunk_t secret,
253 hasher_t *hasher, signer_t *signer);
254
255 /**
256 * Destroy the message.
257 */
258 void (*destroy)(radius_message_t *this);
259 };
260
261 /**
262 * Create an empty RADIUS request message (RMT_ACCESS_REQUEST).
263 *
264 * @return radius_message_t object
265 */
266 radius_message_t *radius_message_create_request();
267
268 /**
269 * Parse and verify a recevied RADIUS response.
270 *
271 * @param data received message data
272 * @return radius_message_t object, NULL if length invalid
273 */
274 radius_message_t *radius_message_parse_response(chunk_t data);
275
276 #endif /** RADIUS_MESSAGE_H_ @}*/