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