2 * hostapd / RADIUS Accounting
3 * Copyright (c) 2002-2009, 2012, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
9 #include "utils/includes.h"
11 #include "utils/common.h"
12 #include "utils/eloop.h"
13 #include "drivers/driver.h"
14 #include "radius/radius.h"
15 #include "radius/radius_client.h"
17 #include "ieee802_1x.h"
18 #include "ap_config.h"
20 #include "ap_drv_ops.h"
21 #include "accounting.h"
24 /* Default interval in seconds for polling TX/RX octets from the driver if
25 * STA is not using interim accounting. This detects wrap arounds for
26 * input/output octets and updates Acct-{Input,Output}-Gigawords. */
27 #define ACCT_DEFAULT_UPDATE_INTERVAL 300
29 static void accounting_sta_get_id(struct hostapd_data *hapd,
30 struct sta_info *sta);
31 static void accounting_sta_interim(struct hostapd_data *hapd,
32 struct sta_info *sta);
35 static struct radius_msg * accounting_msg(struct hostapd_data *hapd,
39 struct radius_msg *msg;
46 msg = radius_msg_new(RADIUS_CODE_ACCOUNTING_REQUEST,
47 radius_client_get_id(hapd->radius));
49 printf("Could not create net RADIUS packet\n");
54 radius_msg_make_authenticator(msg, (u8 *) sta, sizeof(*sta));
56 os_snprintf(buf, sizeof(buf), "%08X-%08X",
57 sta->acct_session_id_hi, sta->acct_session_id_lo);
58 if (!radius_msg_add_attr(msg, RADIUS_ATTR_ACCT_SESSION_ID,
59 (u8 *) buf, os_strlen(buf))) {
60 printf("Could not add Acct-Session-Id\n");
64 radius_msg_make_authenticator(msg, (u8 *) hapd, sizeof(*hapd));
67 if (!radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_STATUS_TYPE,
69 printf("Could not add Acct-Status-Type\n");
73 if (!hostapd_config_get_radius_attr(hapd->conf->radius_acct_req_attr,
74 RADIUS_ATTR_ACCT_AUTHENTIC) &&
75 !radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_AUTHENTIC,
76 hapd->conf->ieee802_1x ?
77 RADIUS_ACCT_AUTHENTIC_RADIUS :
78 RADIUS_ACCT_AUTHENTIC_LOCAL)) {
79 printf("Could not add Acct-Authentic\n");
84 /* Use 802.1X identity if available */
85 val = ieee802_1x_get_identity(sta->eapol_sm, &len);
87 /* Use RADIUS ACL identity if 802.1X provides no identity */
88 if (!val && sta->identity) {
89 val = (u8 *) sta->identity;
90 len = os_strlen(sta->identity);
93 /* Use STA MAC if neither 802.1X nor RADIUS ACL provided
96 os_snprintf(buf, sizeof(buf), RADIUS_ADDR_FORMAT,
102 if (!radius_msg_add_attr(msg, RADIUS_ATTR_USER_NAME, val,
104 printf("Could not add User-Name\n");
109 if (add_common_radius_attr(hapd, hapd->conf->radius_acct_req_attr, sta,
115 val = ieee802_1x_get_radius_class(sta->eapol_sm, &len,
120 if (!radius_msg_add_attr(msg, RADIUS_ATTR_CLASS,
122 printf("Could not add Class\n");
127 b = ieee802_1x_get_radius_cui(sta->eapol_sm);
129 !radius_msg_add_attr(msg,
130 RADIUS_ATTR_CHARGEABLE_USER_IDENTITY,
131 wpabuf_head(b), wpabuf_len(b))) {
132 wpa_printf(MSG_ERROR, "Could not add CUI");
136 if (!b && sta->radius_cui &&
137 !radius_msg_add_attr(msg,
138 RADIUS_ATTR_CHARGEABLE_USER_IDENTITY,
139 (u8 *) sta->radius_cui,
140 os_strlen(sta->radius_cui))) {
141 wpa_printf(MSG_ERROR, "Could not add CUI from ACL");
149 radius_msg_free(msg);
154 static int accounting_sta_update_stats(struct hostapd_data *hapd,
155 struct sta_info *sta,
156 struct hostap_sta_driver_data *data)
158 if (hostapd_drv_read_sta_data(hapd, data, sta->addr))
161 if (sta->last_rx_bytes > data->rx_bytes)
162 sta->acct_input_gigawords++;
163 if (sta->last_tx_bytes > data->tx_bytes)
164 sta->acct_output_gigawords++;
165 sta->last_rx_bytes = data->rx_bytes;
166 sta->last_tx_bytes = data->tx_bytes;
168 hostapd_logger(hapd, sta->addr, HOSTAPD_MODULE_RADIUS,
169 HOSTAPD_LEVEL_DEBUG, "updated TX/RX stats: "
170 "Acct-Input-Octets=%lu Acct-Input-Gigawords=%u "
171 "Acct-Output-Octets=%lu Acct-Output-Gigawords=%u",
172 sta->last_rx_bytes, sta->acct_input_gigawords,
173 sta->last_tx_bytes, sta->acct_output_gigawords);
179 static void accounting_interim_update(void *eloop_ctx, void *timeout_ctx)
181 struct hostapd_data *hapd = eloop_ctx;
182 struct sta_info *sta = timeout_ctx;
185 if (sta->acct_interim_interval) {
186 accounting_sta_interim(hapd, sta);
187 interval = sta->acct_interim_interval;
189 struct hostap_sta_driver_data data;
190 accounting_sta_update_stats(hapd, sta, &data);
191 interval = ACCT_DEFAULT_UPDATE_INTERVAL;
194 eloop_register_timeout(interval, 0, accounting_interim_update,
200 * accounting_sta_start - Start STA accounting
201 * @hapd: hostapd BSS data
204 void accounting_sta_start(struct hostapd_data *hapd, struct sta_info *sta)
206 struct radius_msg *msg;
210 if (sta->acct_session_started)
213 accounting_sta_get_id(hapd, sta);
214 hostapd_logger(hapd, sta->addr, HOSTAPD_MODULE_RADIUS,
216 "starting accounting session %08X-%08X",
217 sta->acct_session_id_hi, sta->acct_session_id_lo);
220 sta->acct_session_start = t.sec;
221 sta->last_rx_bytes = sta->last_tx_bytes = 0;
222 sta->acct_input_gigawords = sta->acct_output_gigawords = 0;
223 hostapd_drv_sta_clear_stats(hapd, sta->addr);
225 if (!hapd->conf->radius->acct_server)
228 if (sta->acct_interim_interval)
229 interval = sta->acct_interim_interval;
231 interval = ACCT_DEFAULT_UPDATE_INTERVAL;
232 eloop_register_timeout(interval, 0, accounting_interim_update,
235 msg = accounting_msg(hapd, sta, RADIUS_ACCT_STATUS_TYPE_START);
237 radius_client_send(hapd->radius, msg, RADIUS_ACCT, sta->addr) < 0)
238 radius_msg_free(msg);
240 sta->acct_session_started = 1;
244 static void accounting_sta_report(struct hostapd_data *hapd,
245 struct sta_info *sta, int stop)
247 struct radius_msg *msg;
248 int cause = sta->acct_terminate_cause;
249 struct hostap_sta_driver_data data;
253 if (!hapd->conf->radius->acct_server)
256 msg = accounting_msg(hapd, sta,
257 stop ? RADIUS_ACCT_STATUS_TYPE_STOP :
258 RADIUS_ACCT_STATUS_TYPE_INTERIM_UPDATE);
260 printf("Could not create RADIUS Accounting message\n");
265 if (!radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_SESSION_TIME,
266 now.sec - sta->acct_session_start)) {
267 printf("Could not add Acct-Session-Time\n");
271 if (accounting_sta_update_stats(hapd, sta, &data) == 0) {
272 if (!radius_msg_add_attr_int32(msg,
273 RADIUS_ATTR_ACCT_INPUT_PACKETS,
275 printf("Could not add Acct-Input-Packets\n");
278 if (!radius_msg_add_attr_int32(msg,
279 RADIUS_ATTR_ACCT_OUTPUT_PACKETS,
281 printf("Could not add Acct-Output-Packets\n");
284 if (!radius_msg_add_attr_int32(msg,
285 RADIUS_ATTR_ACCT_INPUT_OCTETS,
287 printf("Could not add Acct-Input-Octets\n");
290 gigawords = sta->acct_input_gigawords;
292 gigawords += data.rx_bytes >> 32;
295 !radius_msg_add_attr_int32(
296 msg, RADIUS_ATTR_ACCT_INPUT_GIGAWORDS,
298 printf("Could not add Acct-Input-Gigawords\n");
301 if (!radius_msg_add_attr_int32(msg,
302 RADIUS_ATTR_ACCT_OUTPUT_OCTETS,
304 printf("Could not add Acct-Output-Octets\n");
307 gigawords = sta->acct_output_gigawords;
309 gigawords += data.tx_bytes >> 32;
312 !radius_msg_add_attr_int32(
313 msg, RADIUS_ATTR_ACCT_OUTPUT_GIGAWORDS,
315 printf("Could not add Acct-Output-Gigawords\n");
320 if (!radius_msg_add_attr_int32(msg, RADIUS_ATTR_EVENT_TIMESTAMP,
322 printf("Could not add Event-Timestamp\n");
326 if (eloop_terminated())
327 cause = RADIUS_ACCT_TERMINATE_CAUSE_ADMIN_REBOOT;
330 !radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_TERMINATE_CAUSE,
332 printf("Could not add Acct-Terminate-Cause\n");
336 if (radius_client_send(hapd->radius, msg,
337 stop ? RADIUS_ACCT : RADIUS_ACCT_INTERIM,
343 radius_msg_free(msg);
348 * accounting_sta_interim - Send a interim STA accounting report
349 * @hapd: hostapd BSS data
352 static void accounting_sta_interim(struct hostapd_data *hapd,
353 struct sta_info *sta)
355 if (sta->acct_session_started)
356 accounting_sta_report(hapd, sta, 0);
361 * accounting_sta_stop - Stop STA accounting
362 * @hapd: hostapd BSS data
365 void accounting_sta_stop(struct hostapd_data *hapd, struct sta_info *sta)
367 if (sta->acct_session_started) {
368 accounting_sta_report(hapd, sta, 1);
369 eloop_cancel_timeout(accounting_interim_update, hapd, sta);
370 hostapd_logger(hapd, sta->addr, HOSTAPD_MODULE_RADIUS,
372 "stopped accounting session %08X-%08X",
373 sta->acct_session_id_hi,
374 sta->acct_session_id_lo);
375 sta->acct_session_started = 0;
380 static void accounting_sta_get_id(struct hostapd_data *hapd,
381 struct sta_info *sta)
383 sta->acct_session_id_lo = hapd->acct_session_id_lo++;
384 if (hapd->acct_session_id_lo == 0) {
385 hapd->acct_session_id_hi++;
387 sta->acct_session_id_hi = hapd->acct_session_id_hi;
392 * accounting_receive - Process the RADIUS frames from Accounting Server
393 * @msg: RADIUS response message
394 * @req: RADIUS request message
395 * @shared_secret: RADIUS shared secret
396 * @shared_secret_len: Length of shared_secret in octets
397 * @data: Context data (struct hostapd_data *)
398 * Returns: Processing status
400 static RadiusRxResult
401 accounting_receive(struct radius_msg *msg, struct radius_msg *req,
402 const u8 *shared_secret, size_t shared_secret_len,
405 if (radius_msg_get_hdr(msg)->code != RADIUS_CODE_ACCOUNTING_RESPONSE) {
406 printf("Unknown RADIUS message code\n");
407 return RADIUS_RX_UNKNOWN;
410 if (radius_msg_verify(msg, shared_secret, shared_secret_len, req, 0)) {
411 printf("Incoming RADIUS packet did not have correct "
412 "Authenticator - dropped\n");
413 return RADIUS_RX_INVALID_AUTHENTICATOR;
416 return RADIUS_RX_PROCESSED;
420 static void accounting_report_state(struct hostapd_data *hapd, int on)
422 struct radius_msg *msg;
424 if (!hapd->conf->radius->acct_server || hapd->radius == NULL)
427 /* Inform RADIUS server that accounting will start/stop so that the
428 * server can close old accounting sessions. */
429 msg = accounting_msg(hapd, NULL,
430 on ? RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_ON :
431 RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_OFF);
435 if (!radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_TERMINATE_CAUSE,
436 RADIUS_ACCT_TERMINATE_CAUSE_NAS_REBOOT))
438 printf("Could not add Acct-Terminate-Cause\n");
439 radius_msg_free(msg);
443 if (radius_client_send(hapd->radius, msg, RADIUS_ACCT, NULL) < 0)
444 radius_msg_free(msg);
449 * accounting_init: Initialize accounting
450 * @hapd: hostapd BSS data
451 * Returns: 0 on success, -1 on failure
453 int accounting_init(struct hostapd_data *hapd)
457 /* Acct-Session-Id should be unique over reboots. If reliable clock is
458 * not available, this could be replaced with reboot counter, etc. */
460 hapd->acct_session_id_hi = now.sec;
462 if (radius_client_register(hapd->radius, RADIUS_ACCT,
463 accounting_receive, hapd))
466 accounting_report_state(hapd, 1);
473 * accounting_deinit: Deinitilize accounting
474 * @hapd: hostapd BSS data
476 void accounting_deinit(struct hostapd_data *hapd)
478 accounting_report_state(hapd, 0);