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