xref: /freebsd/contrib/wpa/src/radius/radius.h (revision b0d29bc47dba79f6f38e67eabadfb4b32ffd9390)
1 /*
2  * RADIUS message processing
3  * Copyright (c) 2002-2009, 2012, 2014-2015, Jouni Malinen <j@w1.fi>
4  *
5  * This software may be distributed under the terms of the BSD license.
6  * See README for more details.
7  */
8 
9 #ifndef RADIUS_H
10 #define RADIUS_H
11 
12 /* RFC 2865 - RADIUS */
13 
14 #ifdef _MSC_VER
15 #pragma pack(push, 1)
16 #endif /* _MSC_VER */
17 
18 struct radius_hdr {
19 	u8 code;
20 	u8 identifier;
21 	be16 length; /* including this header */
22 	u8 authenticator[16];
23 	/* followed by length-20 octets of attributes */
24 } STRUCT_PACKED;
25 
26 enum { RADIUS_CODE_ACCESS_REQUEST = 1,
27        RADIUS_CODE_ACCESS_ACCEPT = 2,
28        RADIUS_CODE_ACCESS_REJECT = 3,
29        RADIUS_CODE_ACCOUNTING_REQUEST = 4,
30        RADIUS_CODE_ACCOUNTING_RESPONSE = 5,
31        RADIUS_CODE_ACCESS_CHALLENGE = 11,
32        RADIUS_CODE_STATUS_SERVER = 12,
33        RADIUS_CODE_STATUS_CLIENT = 13,
34        RADIUS_CODE_DISCONNECT_REQUEST = 40,
35        RADIUS_CODE_DISCONNECT_ACK = 41,
36        RADIUS_CODE_DISCONNECT_NAK = 42,
37        RADIUS_CODE_COA_REQUEST = 43,
38        RADIUS_CODE_COA_ACK = 44,
39        RADIUS_CODE_COA_NAK = 45,
40        RADIUS_CODE_RESERVED = 255
41 };
42 
43 struct radius_attr_hdr {
44 	u8 type;
45 	u8 length; /* including this header */
46 	/* followed by length-2 octets of attribute value */
47 } STRUCT_PACKED;
48 
49 #define RADIUS_MAX_ATTR_LEN (255 - sizeof(struct radius_attr_hdr))
50 
51 enum { RADIUS_ATTR_USER_NAME = 1,
52        RADIUS_ATTR_USER_PASSWORD = 2,
53        RADIUS_ATTR_NAS_IP_ADDRESS = 4,
54        RADIUS_ATTR_NAS_PORT = 5,
55        RADIUS_ATTR_SERVICE_TYPE = 6,
56        RADIUS_ATTR_FRAMED_IP_ADDRESS = 8,
57        RADIUS_ATTR_FRAMED_MTU = 12,
58        RADIUS_ATTR_REPLY_MESSAGE = 18,
59        RADIUS_ATTR_STATE = 24,
60        RADIUS_ATTR_CLASS = 25,
61        RADIUS_ATTR_VENDOR_SPECIFIC = 26,
62        RADIUS_ATTR_SESSION_TIMEOUT = 27,
63        RADIUS_ATTR_IDLE_TIMEOUT = 28,
64        RADIUS_ATTR_TERMINATION_ACTION = 29,
65        RADIUS_ATTR_CALLED_STATION_ID = 30,
66        RADIUS_ATTR_CALLING_STATION_ID = 31,
67        RADIUS_ATTR_NAS_IDENTIFIER = 32,
68        RADIUS_ATTR_PROXY_STATE = 33,
69        RADIUS_ATTR_ACCT_STATUS_TYPE = 40,
70        RADIUS_ATTR_ACCT_DELAY_TIME = 41,
71        RADIUS_ATTR_ACCT_INPUT_OCTETS = 42,
72        RADIUS_ATTR_ACCT_OUTPUT_OCTETS = 43,
73        RADIUS_ATTR_ACCT_SESSION_ID = 44,
74        RADIUS_ATTR_ACCT_AUTHENTIC = 45,
75        RADIUS_ATTR_ACCT_SESSION_TIME = 46,
76        RADIUS_ATTR_ACCT_INPUT_PACKETS = 47,
77        RADIUS_ATTR_ACCT_OUTPUT_PACKETS = 48,
78        RADIUS_ATTR_ACCT_TERMINATE_CAUSE = 49,
79        RADIUS_ATTR_ACCT_MULTI_SESSION_ID = 50,
80        RADIUS_ATTR_ACCT_LINK_COUNT = 51,
81        RADIUS_ATTR_ACCT_INPUT_GIGAWORDS = 52,
82        RADIUS_ATTR_ACCT_OUTPUT_GIGAWORDS = 53,
83        RADIUS_ATTR_EVENT_TIMESTAMP = 55,
84        RADIUS_ATTR_EGRESS_VLANID = 56,
85        RADIUS_ATTR_NAS_PORT_TYPE = 61,
86        RADIUS_ATTR_TUNNEL_TYPE = 64,
87        RADIUS_ATTR_TUNNEL_MEDIUM_TYPE = 65,
88        RADIUS_ATTR_TUNNEL_PASSWORD = 69,
89        RADIUS_ATTR_CONNECT_INFO = 77,
90        RADIUS_ATTR_EAP_MESSAGE = 79,
91        RADIUS_ATTR_MESSAGE_AUTHENTICATOR = 80,
92        RADIUS_ATTR_TUNNEL_PRIVATE_GROUP_ID = 81,
93        RADIUS_ATTR_ACCT_INTERIM_INTERVAL = 85,
94        RADIUS_ATTR_CHARGEABLE_USER_IDENTITY = 89,
95        RADIUS_ATTR_NAS_IPV6_ADDRESS = 95,
96        RADIUS_ATTR_ERROR_CAUSE = 101,
97        RADIUS_ATTR_EAP_KEY_NAME = 102,
98        RADIUS_ATTR_OPERATOR_NAME = 126,
99        RADIUS_ATTR_LOCATION_INFO = 127,
100        RADIUS_ATTR_LOCATION_DATA = 128,
101        RADIUS_ATTR_BASIC_LOCATION_POLICY_RULES = 129,
102        RADIUS_ATTR_EXTENDED_LOCATION_POLICY_RULES = 130,
103        RADIUS_ATTR_LOCATION_CAPABLE = 131,
104        RADIUS_ATTR_REQUESTED_LOCATION_INFO = 132,
105        RADIUS_ATTR_GSS_ACCEPTOR_SERVICE_NAME = 164,
106        RADIUS_ATTR_GSS_ACCEPTOR_HOST_NAME = 165,
107        RADIUS_ATTR_GSS_ACCEPTOR_SERVICE_SPECIFICS = 166,
108        RADIUS_ATTR_GSS_ACCEPTOR_REALM_NAME = 167,
109        RADIUS_ATTR_MOBILITY_DOMAIN_ID = 177,
110        RADIUS_ATTR_WLAN_HESSID = 181,
111        RADIUS_ATTR_WLAN_REASON_CODE = 185,
112        RADIUS_ATTR_WLAN_PAIRWISE_CIPHER = 186,
113        RADIUS_ATTR_WLAN_GROUP_CIPHER = 187,
114        RADIUS_ATTR_WLAN_AKM_SUITE = 188,
115        RADIUS_ATTR_WLAN_GROUP_MGMT_CIPHER = 189,
116 };
117 
118 
119 /* Service-Type values (RFC 2865, 5.6) */
120 #define RADIUS_SERVICE_TYPE_FRAMED 2
121 
122 /* Termination-Action */
123 #define RADIUS_TERMINATION_ACTION_DEFAULT 0
124 #define RADIUS_TERMINATION_ACTION_RADIUS_REQUEST 1
125 
126 /* NAS-Port-Type */
127 #define RADIUS_NAS_PORT_TYPE_IEEE_802_11 19
128 
129 /* Acct-Status-Type */
130 #define RADIUS_ACCT_STATUS_TYPE_START 1
131 #define RADIUS_ACCT_STATUS_TYPE_STOP 2
132 #define RADIUS_ACCT_STATUS_TYPE_INTERIM_UPDATE 3
133 #define RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_ON 7
134 #define RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_OFF 8
135 
136 /* Acct-Authentic */
137 #define RADIUS_ACCT_AUTHENTIC_RADIUS 1
138 #define RADIUS_ACCT_AUTHENTIC_LOCAL 2
139 #define RADIUS_ACCT_AUTHENTIC_REMOTE 3
140 
141 /* Acct-Terminate-Cause */
142 #define RADIUS_ACCT_TERMINATE_CAUSE_USER_REQUEST 1
143 #define RADIUS_ACCT_TERMINATE_CAUSE_LOST_CARRIER 2
144 #define RADIUS_ACCT_TERMINATE_CAUSE_LOST_SERVICE 3
145 #define RADIUS_ACCT_TERMINATE_CAUSE_IDLE_TIMEOUT 4
146 #define RADIUS_ACCT_TERMINATE_CAUSE_SESSION_TIMEOUT 5
147 #define RADIUS_ACCT_TERMINATE_CAUSE_ADMIN_RESET 6
148 #define RADIUS_ACCT_TERMINATE_CAUSE_ADMIN_REBOOT 7
149 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_ERROR 8
150 #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_ERROR 9
151 #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_REQUEST 10
152 #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_REBOOT 11
153 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_UNNEEDED 12
154 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_PREEMPTED 13
155 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_SUSPENDED 14
156 #define RADIUS_ACCT_TERMINATE_CAUSE_SERVICE_UNAVAILABLE 15
157 #define RADIUS_ACCT_TERMINATE_CAUSE_CALLBACK 16
158 #define RADIUS_ACCT_TERMINATE_CAUSE_USER_ERROR 17
159 #define RADIUS_ACCT_TERMINATE_CAUSE_HOST_REQUEST 18
160 
161 #define RADIUS_TUNNEL_TAGS 32
162 
163 /* Tunnel-Type */
164 #define RADIUS_TUNNEL_TYPE_PPTP 1
165 #define RADIUS_TUNNEL_TYPE_L2TP 3
166 #define RADIUS_TUNNEL_TYPE_IPIP 7
167 #define RADIUS_TUNNEL_TYPE_GRE 10
168 #define RADIUS_TUNNEL_TYPE_VLAN 13
169 
170 /* Tunnel-Medium-Type */
171 #define RADIUS_TUNNEL_MEDIUM_TYPE_IPV4 1
172 #define RADIUS_TUNNEL_MEDIUM_TYPE_IPV6 2
173 #define RADIUS_TUNNEL_MEDIUM_TYPE_802 6
174 
175 
176 struct radius_attr_vendor {
177 	u8 vendor_type;
178 	u8 vendor_length;
179 } STRUCT_PACKED;
180 
181 #define RADIUS_VENDOR_ID_CISCO 9
182 #define RADIUS_CISCO_AV_PAIR 1
183 
184 /* RFC 2548 - Microsoft Vendor-specific RADIUS Attributes */
185 #define RADIUS_VENDOR_ID_MICROSOFT 311
186 
187 enum { RADIUS_VENDOR_ATTR_MS_MPPE_SEND_KEY = 16,
188        RADIUS_VENDOR_ATTR_MS_MPPE_RECV_KEY = 17
189 };
190 
191 
192 /* Hotspot 2.0 - WFA Vendor-specific RADIUS Attributes */
193 #define RADIUS_VENDOR_ID_WFA 40808
194 
195 enum {
196 	RADIUS_VENDOR_ATTR_WFA_HS20_SUBSCR_REMEDIATION = 1,
197 	RADIUS_VENDOR_ATTR_WFA_HS20_AP_VERSION = 2,
198 	RADIUS_VENDOR_ATTR_WFA_HS20_STA_VERSION = 3,
199 	RADIUS_VENDOR_ATTR_WFA_HS20_DEAUTH_REQ = 4,
200 	RADIUS_VENDOR_ATTR_WFA_HS20_SESSION_INFO_URL = 5,
201 	RADIUS_VENDOR_ATTR_WFA_HS20_ROAMING_CONSORTIUM = 6,
202 	RADIUS_VENDOR_ATTR_WFA_HS20_T_C_FILENAME = 7,
203 	RADIUS_VENDOR_ATTR_WFA_HS20_TIMESTAMP = 8,
204 	RADIUS_VENDOR_ATTR_WFA_HS20_T_C_FILTERING = 9,
205 	RADIUS_VENDOR_ATTR_WFA_HS20_T_C_URL = 10,
206 };
207 
208 #ifdef _MSC_VER
209 #pragma pack(pop)
210 #endif /* _MSC_VER */
211 
212 struct radius_ms_mppe_keys {
213 	u8 *send;
214 	size_t send_len;
215 	u8 *recv;
216 	size_t recv_len;
217 };
218 
219 
220 struct radius_msg;
221 
222 /* Default size to be allocated for new RADIUS messages */
223 #define RADIUS_DEFAULT_MSG_SIZE 1024
224 
225 /* Default size to be allocated for attribute array */
226 #define RADIUS_DEFAULT_ATTR_COUNT 16
227 
228 
229 /* MAC address ASCII format for IEEE 802.1X use
230  * (draft-congdon-radius-8021x-20.txt) */
231 #define RADIUS_802_1X_ADDR_FORMAT "%02X-%02X-%02X-%02X-%02X-%02X"
232 /* MAC address ASCII format for non-802.1X use */
233 #define RADIUS_ADDR_FORMAT "%02x%02x%02x%02x%02x%02x"
234 
235 struct radius_hdr * radius_msg_get_hdr(struct radius_msg *msg);
236 struct wpabuf * radius_msg_get_buf(struct radius_msg *msg);
237 struct radius_msg * radius_msg_new(u8 code, u8 identifier);
238 void radius_msg_free(struct radius_msg *msg);
239 void radius_msg_dump(struct radius_msg *msg);
240 int radius_msg_finish(struct radius_msg *msg, const u8 *secret,
241 		      size_t secret_len);
242 int radius_msg_finish_srv(struct radius_msg *msg, const u8 *secret,
243 			  size_t secret_len, const u8 *req_authenticator);
244 int radius_msg_finish_das_resp(struct radius_msg *msg, const u8 *secret,
245 			       size_t secret_len,
246 			       const struct radius_hdr *req_hdr);
247 void radius_msg_finish_acct(struct radius_msg *msg, const u8 *secret,
248 			    size_t secret_len);
249 void radius_msg_finish_acct_resp(struct radius_msg *msg, const u8 *secret,
250 				 size_t secret_len,
251 				 const u8 *req_authenticator);
252 int radius_msg_verify_acct_req(struct radius_msg *msg, const u8 *secret,
253 			       size_t secret_len);
254 int radius_msg_verify_das_req(struct radius_msg *msg, const u8 *secret,
255 			      size_t secret_len,
256 			      int require_message_authenticator);
257 struct radius_attr_hdr * radius_msg_add_attr(struct radius_msg *msg, u8 type,
258 					     const u8 *data, size_t data_len);
259 struct radius_msg * radius_msg_parse(const u8 *data, size_t len);
260 int radius_msg_add_eap(struct radius_msg *msg, const u8 *data,
261 		       size_t data_len);
262 struct wpabuf * radius_msg_get_eap(struct radius_msg *msg);
263 int radius_msg_verify(struct radius_msg *msg, const u8 *secret,
264 		      size_t secret_len, struct radius_msg *sent_msg,
265 		      int auth);
266 int radius_msg_verify_msg_auth(struct radius_msg *msg, const u8 *secret,
267 			       size_t secret_len, const u8 *req_auth);
268 int radius_msg_copy_attr(struct radius_msg *dst, struct radius_msg *src,
269 			 u8 type);
270 int radius_msg_make_authenticator(struct radius_msg *msg);
271 struct radius_ms_mppe_keys *
272 radius_msg_get_ms_keys(struct radius_msg *msg, struct radius_msg *sent_msg,
273 		       const u8 *secret, size_t secret_len);
274 struct radius_ms_mppe_keys *
275 radius_msg_get_cisco_keys(struct radius_msg *msg, struct radius_msg *sent_msg,
276 			  const u8 *secret, size_t secret_len);
277 int radius_msg_add_mppe_keys(struct radius_msg *msg,
278 			     const u8 *req_authenticator,
279 			     const u8 *secret, size_t secret_len,
280 			     const u8 *send_key, size_t send_key_len,
281 			     const u8 *recv_key, size_t recv_key_len);
282 int radius_msg_add_wfa(struct radius_msg *msg, u8 subtype, const u8 *data,
283 		       size_t len);
284 int radius_user_password_hide(struct radius_msg *msg,
285 			      const u8 *data, size_t data_len,
286 			      const u8 *secret, size_t secret_len,
287 			      u8 *buf, size_t buf_len);
288 struct radius_attr_hdr *
289 radius_msg_add_attr_user_password(struct radius_msg *msg,
290 				  const u8 *data, size_t data_len,
291 				  const u8 *secret, size_t secret_len);
292 int radius_msg_get_attr(struct radius_msg *msg, u8 type, u8 *buf, size_t len);
293 int radius_msg_get_vlanid(struct radius_msg *msg, int *untagged, int numtagged,
294 			  int *tagged);
295 char * radius_msg_get_tunnel_password(struct radius_msg *msg, int *keylen,
296 				      const u8 *secret, size_t secret_len,
297 				      struct radius_msg *sent_msg, size_t n);
298 
299 static inline int radius_msg_add_attr_int32(struct radius_msg *msg, u8 type,
300 					    u32 value)
301 {
302 	u32 val = htonl(value);
303 	return radius_msg_add_attr(msg, type, (u8 *) &val, 4) != NULL;
304 }
305 
306 static inline int radius_msg_get_attr_int32(struct radius_msg *msg, u8 type,
307 					    u32 *value)
308 {
309 	u32 val;
310 	int res;
311 	res = radius_msg_get_attr(msg, type, (u8 *) &val, 4);
312 	if (res != 4)
313 		return -1;
314 
315 	*value = ntohl(val);
316 	return 0;
317 }
318 int radius_msg_get_attr_ptr(struct radius_msg *msg, u8 type, u8 **buf,
319 			    size_t *len, const u8 *start);
320 int radius_msg_count_attr(struct radius_msg *msg, u8 type, int min_len);
321 
322 
323 struct radius_attr_data {
324 	u8 *data;
325 	size_t len;
326 };
327 
328 struct radius_class_data {
329 	struct radius_attr_data *attr;
330 	size_t count;
331 };
332 
333 void radius_free_class(struct radius_class_data *c);
334 int radius_copy_class(struct radius_class_data *dst,
335 		      const struct radius_class_data *src);
336 
337 u8 radius_msg_find_unlisted_attr(struct radius_msg *msg, u8 *attrs);
338 
339 int radius_gen_session_id(u8 *id, size_t len);
340 
341 #endif /* RADIUS_H */
342