• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_MOBILITY_DOMAIN_ID = 177,
96        RADIUS_ATTR_WLAN_HESSID = 181,
97        RADIUS_ATTR_WLAN_PAIRWISE_CIPHER = 186,
98        RADIUS_ATTR_WLAN_GROUP_CIPHER = 187,
99        RADIUS_ATTR_WLAN_AKM_SUITE = 188,
100        RADIUS_ATTR_WLAN_GROUP_MGMT_CIPHER = 189,
101 };
102 
103 
104 /* Termination-Action */
105 #define RADIUS_TERMINATION_ACTION_DEFAULT 0
106 #define RADIUS_TERMINATION_ACTION_RADIUS_REQUEST 1
107 
108 /* NAS-Port-Type */
109 #define RADIUS_NAS_PORT_TYPE_IEEE_802_11 19
110 
111 /* Acct-Status-Type */
112 #define RADIUS_ACCT_STATUS_TYPE_START 1
113 #define RADIUS_ACCT_STATUS_TYPE_STOP 2
114 #define RADIUS_ACCT_STATUS_TYPE_INTERIM_UPDATE 3
115 #define RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_ON 7
116 #define RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_OFF 8
117 
118 /* Acct-Authentic */
119 #define RADIUS_ACCT_AUTHENTIC_RADIUS 1
120 #define RADIUS_ACCT_AUTHENTIC_LOCAL 2
121 #define RADIUS_ACCT_AUTHENTIC_REMOTE 3
122 
123 /* Acct-Terminate-Cause */
124 #define RADIUS_ACCT_TERMINATE_CAUSE_USER_REQUEST 1
125 #define RADIUS_ACCT_TERMINATE_CAUSE_LOST_CARRIER 2
126 #define RADIUS_ACCT_TERMINATE_CAUSE_LOST_SERVICE 3
127 #define RADIUS_ACCT_TERMINATE_CAUSE_IDLE_TIMEOUT 4
128 #define RADIUS_ACCT_TERMINATE_CAUSE_SESSION_TIMEOUT 5
129 #define RADIUS_ACCT_TERMINATE_CAUSE_ADMIN_RESET 6
130 #define RADIUS_ACCT_TERMINATE_CAUSE_ADMIN_REBOOT 7
131 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_ERROR 8
132 #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_ERROR 9
133 #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_REQUEST 10
134 #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_REBOOT 11
135 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_UNNEEDED 12
136 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_PREEMPTED 13
137 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_SUSPENDED 14
138 #define RADIUS_ACCT_TERMINATE_CAUSE_SERVICE_UNAVAILABLE 15
139 #define RADIUS_ACCT_TERMINATE_CAUSE_CALLBACK 16
140 #define RADIUS_ACCT_TERMINATE_CAUSE_USER_ERROR 17
141 #define RADIUS_ACCT_TERMINATE_CAUSE_HOST_REQUEST 18
142 
143 #define RADIUS_TUNNEL_TAGS 32
144 
145 /* Tunnel-Type */
146 #define RADIUS_TUNNEL_TYPE_PPTP 1
147 #define RADIUS_TUNNEL_TYPE_L2TP 3
148 #define RADIUS_TUNNEL_TYPE_IPIP 7
149 #define RADIUS_TUNNEL_TYPE_GRE 10
150 #define RADIUS_TUNNEL_TYPE_VLAN 13
151 
152 /* Tunnel-Medium-Type */
153 #define RADIUS_TUNNEL_MEDIUM_TYPE_IPV4 1
154 #define RADIUS_TUNNEL_MEDIUM_TYPE_IPV6 2
155 #define RADIUS_TUNNEL_MEDIUM_TYPE_802 6
156 
157 
158 struct radius_attr_vendor {
159 	u8 vendor_type;
160 	u8 vendor_length;
161 } STRUCT_PACKED;
162 
163 #define RADIUS_VENDOR_ID_CISCO 9
164 #define RADIUS_CISCO_AV_PAIR 1
165 
166 /* RFC 2548 - Microsoft Vendor-specific RADIUS Attributes */
167 #define RADIUS_VENDOR_ID_MICROSOFT 311
168 
169 enum { RADIUS_VENDOR_ATTR_MS_MPPE_SEND_KEY = 16,
170        RADIUS_VENDOR_ATTR_MS_MPPE_RECV_KEY = 17
171 };
172 
173 
174 /* Hotspot 2.0 - WFA Vendor-specific RADIUS Attributes */
175 #define RADIUS_VENDOR_ID_WFA 40808
176 
177 enum {
178 	RADIUS_VENDOR_ATTR_WFA_HS20_SUBSCR_REMEDIATION = 1,
179 	RADIUS_VENDOR_ATTR_WFA_HS20_AP_VERSION = 2,
180 	RADIUS_VENDOR_ATTR_WFA_HS20_STA_VERSION = 3,
181 	RADIUS_VENDOR_ATTR_WFA_HS20_DEAUTH_REQ = 4,
182 	RADIUS_VENDOR_ATTR_WFA_HS20_SESSION_INFO_URL = 5,
183 };
184 
185 #ifdef _MSC_VER
186 #pragma pack(pop)
187 #endif /* _MSC_VER */
188 
189 struct radius_ms_mppe_keys {
190 	u8 *send;
191 	size_t send_len;
192 	u8 *recv;
193 	size_t recv_len;
194 };
195 
196 
197 struct radius_msg;
198 
199 /* Default size to be allocated for new RADIUS messages */
200 #define RADIUS_DEFAULT_MSG_SIZE 1024
201 
202 /* Default size to be allocated for attribute array */
203 #define RADIUS_DEFAULT_ATTR_COUNT 16
204 
205 
206 /* MAC address ASCII format for IEEE 802.1X use
207  * (draft-congdon-radius-8021x-20.txt) */
208 #define RADIUS_802_1X_ADDR_FORMAT "%02X-%02X-%02X-%02X-%02X-%02X"
209 /* MAC address ASCII format for non-802.1X use */
210 #define RADIUS_ADDR_FORMAT "%02x%02x%02x%02x%02x%02x"
211 
212 struct radius_hdr * radius_msg_get_hdr(struct radius_msg *msg);
213 struct wpabuf * radius_msg_get_buf(struct radius_msg *msg);
214 struct radius_msg * radius_msg_new(u8 code, u8 identifier);
215 void radius_msg_free(struct radius_msg *msg);
216 void radius_msg_dump(struct radius_msg *msg);
217 int radius_msg_finish(struct radius_msg *msg, const u8 *secret,
218 		      size_t secret_len);
219 int radius_msg_finish_srv(struct radius_msg *msg, const u8 *secret,
220 			  size_t secret_len, const u8 *req_authenticator);
221 int radius_msg_finish_das_resp(struct radius_msg *msg, const u8 *secret,
222 			       size_t secret_len,
223 			       const struct radius_hdr *req_hdr);
224 void radius_msg_finish_acct(struct radius_msg *msg, const u8 *secret,
225 			    size_t secret_len);
226 void radius_msg_finish_acct_resp(struct radius_msg *msg, const u8 *secret,
227 				 size_t secret_len,
228 				 const u8 *req_authenticator);
229 int radius_msg_verify_acct_req(struct radius_msg *msg, const u8 *secret,
230 			       size_t secret_len);
231 int radius_msg_verify_das_req(struct radius_msg *msg, const u8 *secret,
232 			       size_t secret_len);
233 struct radius_attr_hdr * radius_msg_add_attr(struct radius_msg *msg, u8 type,
234 					     const u8 *data, size_t data_len);
235 struct radius_msg * radius_msg_parse(const u8 *data, size_t len);
236 int radius_msg_add_eap(struct radius_msg *msg, const u8 *data,
237 		       size_t data_len);
238 struct wpabuf * radius_msg_get_eap(struct radius_msg *msg);
239 int radius_msg_verify(struct radius_msg *msg, const u8 *secret,
240 		      size_t secret_len, struct radius_msg *sent_msg,
241 		      int auth);
242 int radius_msg_verify_msg_auth(struct radius_msg *msg, const u8 *secret,
243 			       size_t secret_len, const u8 *req_auth);
244 int radius_msg_copy_attr(struct radius_msg *dst, struct radius_msg *src,
245 			 u8 type);
246 void radius_msg_make_authenticator(struct radius_msg *msg,
247 				   const u8 *data, size_t len);
248 struct radius_ms_mppe_keys *
249 radius_msg_get_ms_keys(struct radius_msg *msg, struct radius_msg *sent_msg,
250 		       const u8 *secret, size_t secret_len);
251 struct radius_ms_mppe_keys *
252 radius_msg_get_cisco_keys(struct radius_msg *msg, struct radius_msg *sent_msg,
253 			  const u8 *secret, size_t secret_len);
254 int radius_msg_add_mppe_keys(struct radius_msg *msg,
255 			     const u8 *req_authenticator,
256 			     const u8 *secret, size_t secret_len,
257 			     const u8 *send_key, size_t send_key_len,
258 			     const u8 *recv_key, size_t recv_key_len);
259 int radius_msg_add_wfa(struct radius_msg *msg, u8 subtype, const u8 *data,
260 		       size_t len);
261 int radius_user_password_hide(struct radius_msg *msg,
262 			      const u8 *data, size_t data_len,
263 			      const u8 *secret, size_t secret_len,
264 			      u8 *buf, size_t buf_len);
265 struct radius_attr_hdr *
266 radius_msg_add_attr_user_password(struct radius_msg *msg,
267 				  const u8 *data, size_t data_len,
268 				  const u8 *secret, size_t secret_len);
269 int radius_msg_get_attr(struct radius_msg *msg, u8 type, u8 *buf, size_t len);
270 int radius_msg_get_vlanid(struct radius_msg *msg);
271 char * radius_msg_get_tunnel_password(struct radius_msg *msg, int *keylen,
272 				      const u8 *secret, size_t secret_len,
273 				      struct radius_msg *sent_msg, size_t n);
274 
radius_msg_add_attr_int32(struct radius_msg * msg,u8 type,u32 value)275 static inline int radius_msg_add_attr_int32(struct radius_msg *msg, u8 type,
276 					    u32 value)
277 {
278 	u32 val = htonl(value);
279 	return radius_msg_add_attr(msg, type, (u8 *) &val, 4) != NULL;
280 }
281 
radius_msg_get_attr_int32(struct radius_msg * msg,u8 type,u32 * value)282 static inline int radius_msg_get_attr_int32(struct radius_msg *msg, u8 type,
283 					    u32 *value)
284 {
285 	u32 val;
286 	int res;
287 	res = radius_msg_get_attr(msg, type, (u8 *) &val, 4);
288 	if (res != 4)
289 		return -1;
290 
291 	*value = ntohl(val);
292 	return 0;
293 }
294 int radius_msg_get_attr_ptr(struct radius_msg *msg, u8 type, u8 **buf,
295 			    size_t *len, const u8 *start);
296 int radius_msg_count_attr(struct radius_msg *msg, u8 type, int min_len);
297 
298 
299 struct radius_attr_data {
300 	u8 *data;
301 	size_t len;
302 };
303 
304 struct radius_class_data {
305 	struct radius_attr_data *attr;
306 	size_t count;
307 };
308 
309 void radius_free_class(struct radius_class_data *c);
310 int radius_copy_class(struct radius_class_data *dst,
311 		      const struct radius_class_data *src);
312 
313 u8 radius_msg_find_unlisted_attr(struct radius_msg *msg, u8 *attrs);
314 
315 #endif /* RADIUS_H */
316