2 * RADIUS message processing
3 * Copyright (c) 2002-2009, 2012, 2014-2015, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
12 /* RFC 2865 - RADIUS */
21 be16 length; /* including this header */
23 /* followed by length-20 octets of attributes */
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
43 struct radius_attr_hdr {
45 u8 length; /* including this header */
46 /* followed by length-2 octets of attribute value */
49 #define RADIUS_MAX_ATTR_LEN (255 - sizeof(struct radius_attr_hdr))
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_IP_ADDRESS = 8,
56 RADIUS_ATTR_FRAMED_MTU = 12,
57 RADIUS_ATTR_REPLY_MESSAGE = 18,
58 RADIUS_ATTR_STATE = 24,
59 RADIUS_ATTR_CLASS = 25,
60 RADIUS_ATTR_VENDOR_SPECIFIC = 26,
61 RADIUS_ATTR_SESSION_TIMEOUT = 27,
62 RADIUS_ATTR_IDLE_TIMEOUT = 28,
63 RADIUS_ATTR_TERMINATION_ACTION = 29,
64 RADIUS_ATTR_CALLED_STATION_ID = 30,
65 RADIUS_ATTR_CALLING_STATION_ID = 31,
66 RADIUS_ATTR_NAS_IDENTIFIER = 32,
67 RADIUS_ATTR_PROXY_STATE = 33,
68 RADIUS_ATTR_ACCT_STATUS_TYPE = 40,
69 RADIUS_ATTR_ACCT_DELAY_TIME = 41,
70 RADIUS_ATTR_ACCT_INPUT_OCTETS = 42,
71 RADIUS_ATTR_ACCT_OUTPUT_OCTETS = 43,
72 RADIUS_ATTR_ACCT_SESSION_ID = 44,
73 RADIUS_ATTR_ACCT_AUTHENTIC = 45,
74 RADIUS_ATTR_ACCT_SESSION_TIME = 46,
75 RADIUS_ATTR_ACCT_INPUT_PACKETS = 47,
76 RADIUS_ATTR_ACCT_OUTPUT_PACKETS = 48,
77 RADIUS_ATTR_ACCT_TERMINATE_CAUSE = 49,
78 RADIUS_ATTR_ACCT_MULTI_SESSION_ID = 50,
79 RADIUS_ATTR_ACCT_LINK_COUNT = 51,
80 RADIUS_ATTR_ACCT_INPUT_GIGAWORDS = 52,
81 RADIUS_ATTR_ACCT_OUTPUT_GIGAWORDS = 53,
82 RADIUS_ATTR_EVENT_TIMESTAMP = 55,
83 RADIUS_ATTR_EGRESS_VLANID = 56,
84 RADIUS_ATTR_NAS_PORT_TYPE = 61,
85 RADIUS_ATTR_TUNNEL_TYPE = 64,
86 RADIUS_ATTR_TUNNEL_MEDIUM_TYPE = 65,
87 RADIUS_ATTR_TUNNEL_PASSWORD = 69,
88 RADIUS_ATTR_CONNECT_INFO = 77,
89 RADIUS_ATTR_EAP_MESSAGE = 79,
90 RADIUS_ATTR_MESSAGE_AUTHENTICATOR = 80,
91 RADIUS_ATTR_TUNNEL_PRIVATE_GROUP_ID = 81,
92 RADIUS_ATTR_ACCT_INTERIM_INTERVAL = 85,
93 RADIUS_ATTR_CHARGEABLE_USER_IDENTITY = 89,
94 RADIUS_ATTR_NAS_IPV6_ADDRESS = 95,
95 RADIUS_ATTR_ERROR_CAUSE = 101,
96 RADIUS_ATTR_EAP_KEY_NAME = 102,
97 RADIUS_ATTR_OPERATOR_NAME = 126,
98 RADIUS_ATTR_LOCATION_INFO = 127,
99 RADIUS_ATTR_LOCATION_DATA = 128,
100 RADIUS_ATTR_BASIC_LOCATION_POLICY_RULES = 129,
101 RADIUS_ATTR_EXTENDED_LOCATION_POLICY_RULES = 130,
102 RADIUS_ATTR_LOCATION_CAPABLE = 131,
103 RADIUS_ATTR_REQUESTED_LOCATION_INFO = 132,
104 RADIUS_ATTR_MOBILITY_DOMAIN_ID = 177,
105 RADIUS_ATTR_WLAN_HESSID = 181,
106 RADIUS_ATTR_WLAN_PAIRWISE_CIPHER = 186,
107 RADIUS_ATTR_WLAN_GROUP_CIPHER = 187,
108 RADIUS_ATTR_WLAN_AKM_SUITE = 188,
109 RADIUS_ATTR_WLAN_GROUP_MGMT_CIPHER = 189,
113 /* Termination-Action */
114 #define RADIUS_TERMINATION_ACTION_DEFAULT 0
115 #define RADIUS_TERMINATION_ACTION_RADIUS_REQUEST 1
118 #define RADIUS_NAS_PORT_TYPE_IEEE_802_11 19
120 /* Acct-Status-Type */
121 #define RADIUS_ACCT_STATUS_TYPE_START 1
122 #define RADIUS_ACCT_STATUS_TYPE_STOP 2
123 #define RADIUS_ACCT_STATUS_TYPE_INTERIM_UPDATE 3
124 #define RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_ON 7
125 #define RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_OFF 8
128 #define RADIUS_ACCT_AUTHENTIC_RADIUS 1
129 #define RADIUS_ACCT_AUTHENTIC_LOCAL 2
130 #define RADIUS_ACCT_AUTHENTIC_REMOTE 3
132 /* Acct-Terminate-Cause */
133 #define RADIUS_ACCT_TERMINATE_CAUSE_USER_REQUEST 1
134 #define RADIUS_ACCT_TERMINATE_CAUSE_LOST_CARRIER 2
135 #define RADIUS_ACCT_TERMINATE_CAUSE_LOST_SERVICE 3
136 #define RADIUS_ACCT_TERMINATE_CAUSE_IDLE_TIMEOUT 4
137 #define RADIUS_ACCT_TERMINATE_CAUSE_SESSION_TIMEOUT 5
138 #define RADIUS_ACCT_TERMINATE_CAUSE_ADMIN_RESET 6
139 #define RADIUS_ACCT_TERMINATE_CAUSE_ADMIN_REBOOT 7
140 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_ERROR 8
141 #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_ERROR 9
142 #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_REQUEST 10
143 #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_REBOOT 11
144 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_UNNEEDED 12
145 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_PREEMPTED 13
146 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_SUSPENDED 14
147 #define RADIUS_ACCT_TERMINATE_CAUSE_SERVICE_UNAVAILABLE 15
148 #define RADIUS_ACCT_TERMINATE_CAUSE_CALLBACK 16
149 #define RADIUS_ACCT_TERMINATE_CAUSE_USER_ERROR 17
150 #define RADIUS_ACCT_TERMINATE_CAUSE_HOST_REQUEST 18
152 #define RADIUS_TUNNEL_TAGS 32
155 #define RADIUS_TUNNEL_TYPE_PPTP 1
156 #define RADIUS_TUNNEL_TYPE_L2TP 3
157 #define RADIUS_TUNNEL_TYPE_IPIP 7
158 #define RADIUS_TUNNEL_TYPE_GRE 10
159 #define RADIUS_TUNNEL_TYPE_VLAN 13
161 /* Tunnel-Medium-Type */
162 #define RADIUS_TUNNEL_MEDIUM_TYPE_IPV4 1
163 #define RADIUS_TUNNEL_MEDIUM_TYPE_IPV6 2
164 #define RADIUS_TUNNEL_MEDIUM_TYPE_802 6
167 struct radius_attr_vendor {
172 #define RADIUS_VENDOR_ID_CISCO 9
173 #define RADIUS_CISCO_AV_PAIR 1
175 /* RFC 2548 - Microsoft Vendor-specific RADIUS Attributes */
176 #define RADIUS_VENDOR_ID_MICROSOFT 311
178 enum { RADIUS_VENDOR_ATTR_MS_MPPE_SEND_KEY = 16,
179 RADIUS_VENDOR_ATTR_MS_MPPE_RECV_KEY = 17
183 /* Hotspot 2.0 - WFA Vendor-specific RADIUS Attributes */
184 #define RADIUS_VENDOR_ID_WFA 40808
187 RADIUS_VENDOR_ATTR_WFA_HS20_SUBSCR_REMEDIATION = 1,
188 RADIUS_VENDOR_ATTR_WFA_HS20_AP_VERSION = 2,
189 RADIUS_VENDOR_ATTR_WFA_HS20_STA_VERSION = 3,
190 RADIUS_VENDOR_ATTR_WFA_HS20_DEAUTH_REQ = 4,
191 RADIUS_VENDOR_ATTR_WFA_HS20_SESSION_INFO_URL = 5,
196 #endif /* _MSC_VER */
198 struct radius_ms_mppe_keys {
208 /* Default size to be allocated for new RADIUS messages */
209 #define RADIUS_DEFAULT_MSG_SIZE 1024
211 /* Default size to be allocated for attribute array */
212 #define RADIUS_DEFAULT_ATTR_COUNT 16
215 /* MAC address ASCII format for IEEE 802.1X use
216 * (draft-congdon-radius-8021x-20.txt) */
217 #define RADIUS_802_1X_ADDR_FORMAT "%02X-%02X-%02X-%02X-%02X-%02X"
218 /* MAC address ASCII format for non-802.1X use */
219 #define RADIUS_ADDR_FORMAT "%02x%02x%02x%02x%02x%02x"
221 struct radius_hdr * radius_msg_get_hdr(struct radius_msg *msg);
222 struct wpabuf * radius_msg_get_buf(struct radius_msg *msg);
223 struct radius_msg * radius_msg_new(u8 code, u8 identifier);
224 void radius_msg_free(struct radius_msg *msg);
225 void radius_msg_dump(struct radius_msg *msg);
226 int radius_msg_finish(struct radius_msg *msg, const u8 *secret,
228 int radius_msg_finish_srv(struct radius_msg *msg, const u8 *secret,
229 size_t secret_len, const u8 *req_authenticator);
230 int radius_msg_finish_das_resp(struct radius_msg *msg, const u8 *secret,
232 const struct radius_hdr *req_hdr);
233 void radius_msg_finish_acct(struct radius_msg *msg, const u8 *secret,
235 void radius_msg_finish_acct_resp(struct radius_msg *msg, const u8 *secret,
237 const u8 *req_authenticator);
238 int radius_msg_verify_acct_req(struct radius_msg *msg, const u8 *secret,
240 int radius_msg_verify_das_req(struct radius_msg *msg, const u8 *secret,
242 struct radius_attr_hdr * radius_msg_add_attr(struct radius_msg *msg, u8 type,
243 const u8 *data, size_t data_len);
244 struct radius_msg * radius_msg_parse(const u8 *data, size_t len);
245 int radius_msg_add_eap(struct radius_msg *msg, const u8 *data,
247 struct wpabuf * radius_msg_get_eap(struct radius_msg *msg);
248 int radius_msg_verify(struct radius_msg *msg, const u8 *secret,
249 size_t secret_len, struct radius_msg *sent_msg,
251 int radius_msg_verify_msg_auth(struct radius_msg *msg, const u8 *secret,
252 size_t secret_len, const u8 *req_auth);
253 int radius_msg_copy_attr(struct radius_msg *dst, struct radius_msg *src,
255 int radius_msg_make_authenticator(struct radius_msg *msg);
256 struct radius_ms_mppe_keys *
257 radius_msg_get_ms_keys(struct radius_msg *msg, struct radius_msg *sent_msg,
258 const u8 *secret, size_t secret_len);
259 struct radius_ms_mppe_keys *
260 radius_msg_get_cisco_keys(struct radius_msg *msg, struct radius_msg *sent_msg,
261 const u8 *secret, size_t secret_len);
262 int radius_msg_add_mppe_keys(struct radius_msg *msg,
263 const u8 *req_authenticator,
264 const u8 *secret, size_t secret_len,
265 const u8 *send_key, size_t send_key_len,
266 const u8 *recv_key, size_t recv_key_len);
267 int radius_msg_add_wfa(struct radius_msg *msg, u8 subtype, const u8 *data,
269 int radius_user_password_hide(struct radius_msg *msg,
270 const u8 *data, size_t data_len,
271 const u8 *secret, size_t secret_len,
272 u8 *buf, size_t buf_len);
273 struct radius_attr_hdr *
274 radius_msg_add_attr_user_password(struct radius_msg *msg,
275 const u8 *data, size_t data_len,
276 const u8 *secret, size_t secret_len);
277 int radius_msg_get_attr(struct radius_msg *msg, u8 type, u8 *buf, size_t len);
278 int radius_msg_get_vlanid(struct radius_msg *msg, int *untagged, int numtagged,
280 char * radius_msg_get_tunnel_password(struct radius_msg *msg, int *keylen,
281 const u8 *secret, size_t secret_len,
282 struct radius_msg *sent_msg, size_t n);
284 static inline int radius_msg_add_attr_int32(struct radius_msg *msg, u8 type,
287 u32 val = htonl(value);
288 return radius_msg_add_attr(msg, type, (u8 *) &val, 4) != NULL;
291 static inline int radius_msg_get_attr_int32(struct radius_msg *msg, u8 type,
296 res = radius_msg_get_attr(msg, type, (u8 *) &val, 4);
303 int radius_msg_get_attr_ptr(struct radius_msg *msg, u8 type, u8 **buf,
304 size_t *len, const u8 *start);
305 int radius_msg_count_attr(struct radius_msg *msg, u8 type, int min_len);
308 struct radius_attr_data {
313 struct radius_class_data {
314 struct radius_attr_data *attr;
318 void radius_free_class(struct radius_class_data *c);
319 int radius_copy_class(struct radius_class_data *dst,
320 const struct radius_class_data *src);
322 u8 radius_msg_find_unlisted_attr(struct radius_msg *msg, u8 *attrs);
324 int radius_gen_session_id(u8 *id, size_t len);
326 #endif /* RADIUS_H */