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