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 "eapol_auth/eapol_auth_sm.h"
14 #include "eapol_auth/eapol_auth_sm_i.h"
15 #include "radius/radius.h"
16 #include "radius/radius_client.h"
18 #include "ieee802_1x.h"
19 #include "ap_config.h"
21 #include "ap_drv_ops.h"
22 #include "accounting.h"
25 /* Default interval in seconds for polling TX/RX octets from the driver if
26 * STA is not using interim accounting. This detects wrap arounds for
27 * input/output octets and updates Acct-{Input,Output}-Gigawords. */
28 #define ACCT_DEFAULT_UPDATE_INTERVAL 300
30 static void accounting_sta_interim(struct hostapd_data *hapd,
31 struct sta_info *sta);
34 static struct radius_msg * accounting_msg(struct hostapd_data *hapd,
38 struct radius_msg *msg;
45 msg = radius_msg_new(RADIUS_CODE_ACCOUNTING_REQUEST,
46 radius_client_get_id(hapd->radius));
48 wpa_printf(MSG_INFO, "Could not create new RADIUS packet");
53 radius_msg_make_authenticator(msg, (u8 *) sta, sizeof(*sta));
55 if ((hapd->conf->wpa & 2) &&
56 !hapd->conf->disable_pmksa_caching &&
57 sta->eapol_sm && sta->eapol_sm->acct_multi_session_id_hi) {
58 os_snprintf(buf, sizeof(buf), "%08X+%08X",
59 sta->eapol_sm->acct_multi_session_id_hi,
60 sta->eapol_sm->acct_multi_session_id_lo);
61 if (!radius_msg_add_attr(
62 msg, RADIUS_ATTR_ACCT_MULTI_SESSION_ID,
63 (u8 *) buf, os_strlen(buf))) {
65 "Could not add Acct-Multi-Session-Id");
70 radius_msg_make_authenticator(msg, (u8 *) hapd, sizeof(*hapd));
73 if (!radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_STATUS_TYPE,
75 wpa_printf(MSG_INFO, "Could not add Acct-Status-Type");
79 if (!hostapd_config_get_radius_attr(hapd->conf->radius_acct_req_attr,
80 RADIUS_ATTR_ACCT_AUTHENTIC) &&
81 !radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_AUTHENTIC,
82 hapd->conf->ieee802_1x ?
83 RADIUS_ACCT_AUTHENTIC_RADIUS :
84 RADIUS_ACCT_AUTHENTIC_LOCAL)) {
85 wpa_printf(MSG_INFO, "Could not add Acct-Authentic");
90 /* Use 802.1X identity if available */
91 val = ieee802_1x_get_identity(sta->eapol_sm, &len);
93 /* Use RADIUS ACL identity if 802.1X provides no identity */
94 if (!val && sta->identity) {
95 val = (u8 *) sta->identity;
96 len = os_strlen(sta->identity);
99 /* Use STA MAC if neither 802.1X nor RADIUS ACL provided
102 os_snprintf(buf, sizeof(buf), RADIUS_ADDR_FORMAT,
105 len = os_strlen(buf);
108 if (!radius_msg_add_attr(msg, RADIUS_ATTR_USER_NAME, val,
110 wpa_printf(MSG_INFO, "Could not add User-Name");
115 if (add_common_radius_attr(hapd, hapd->conf->radius_acct_req_attr, sta,
121 val = ieee802_1x_get_radius_class(sta->eapol_sm, &len,
126 if (!radius_msg_add_attr(msg, RADIUS_ATTR_CLASS,
128 wpa_printf(MSG_INFO, "Could not add Class");
133 b = ieee802_1x_get_radius_cui(sta->eapol_sm);
135 !radius_msg_add_attr(msg,
136 RADIUS_ATTR_CHARGEABLE_USER_IDENTITY,
137 wpabuf_head(b), wpabuf_len(b))) {
138 wpa_printf(MSG_ERROR, "Could not add CUI");
142 if (!b && sta->radius_cui &&
143 !radius_msg_add_attr(msg,
144 RADIUS_ATTR_CHARGEABLE_USER_IDENTITY,
145 (u8 *) sta->radius_cui,
146 os_strlen(sta->radius_cui))) {
147 wpa_printf(MSG_ERROR, "Could not add CUI from ACL");
155 radius_msg_free(msg);
160 static int accounting_sta_update_stats(struct hostapd_data *hapd,
161 struct sta_info *sta,
162 struct hostap_sta_driver_data *data)
164 if (hostapd_drv_read_sta_data(hapd, data, sta->addr))
167 if (sta->last_rx_bytes > data->rx_bytes)
168 sta->acct_input_gigawords++;
169 if (sta->last_tx_bytes > data->tx_bytes)
170 sta->acct_output_gigawords++;
171 sta->last_rx_bytes = data->rx_bytes;
172 sta->last_tx_bytes = data->tx_bytes;
174 hostapd_logger(hapd, sta->addr, HOSTAPD_MODULE_RADIUS,
175 HOSTAPD_LEVEL_DEBUG, "updated TX/RX stats: "
176 "Acct-Input-Octets=%lu Acct-Input-Gigawords=%u "
177 "Acct-Output-Octets=%lu Acct-Output-Gigawords=%u",
178 sta->last_rx_bytes, sta->acct_input_gigawords,
179 sta->last_tx_bytes, sta->acct_output_gigawords);
185 static void accounting_interim_update(void *eloop_ctx, void *timeout_ctx)
187 struct hostapd_data *hapd = eloop_ctx;
188 struct sta_info *sta = timeout_ctx;
191 if (sta->acct_interim_interval) {
192 accounting_sta_interim(hapd, sta);
193 interval = sta->acct_interim_interval;
195 struct hostap_sta_driver_data data;
196 accounting_sta_update_stats(hapd, sta, &data);
197 interval = ACCT_DEFAULT_UPDATE_INTERVAL;
200 eloop_register_timeout(interval, 0, accounting_interim_update,
206 * accounting_sta_start - Start STA accounting
207 * @hapd: hostapd BSS data
210 void accounting_sta_start(struct hostapd_data *hapd, struct sta_info *sta)
212 struct radius_msg *msg;
215 if (sta->acct_session_started)
218 hostapd_logger(hapd, sta->addr, HOSTAPD_MODULE_RADIUS,
220 "starting accounting session %08X-%08X",
221 sta->acct_session_id_hi, sta->acct_session_id_lo);
223 os_get_reltime(&sta->acct_session_start);
224 sta->last_rx_bytes = sta->last_tx_bytes = 0;
225 sta->acct_input_gigawords = sta->acct_output_gigawords = 0;
226 hostapd_drv_sta_clear_stats(hapd, sta->addr);
228 if (!hapd->conf->radius->acct_server)
231 if (sta->acct_interim_interval)
232 interval = sta->acct_interim_interval;
234 interval = ACCT_DEFAULT_UPDATE_INTERVAL;
235 eloop_register_timeout(interval, 0, accounting_interim_update,
238 msg = accounting_msg(hapd, sta, RADIUS_ACCT_STATUS_TYPE_START);
240 radius_client_send(hapd->radius, msg, RADIUS_ACCT, sta->addr) < 0)
241 radius_msg_free(msg);
243 sta->acct_session_started = 1;
247 static void accounting_sta_report(struct hostapd_data *hapd,
248 struct sta_info *sta, int stop)
250 struct radius_msg *msg;
251 int cause = sta->acct_terminate_cause;
252 struct hostap_sta_driver_data data;
253 struct os_reltime now_r, diff;
257 if (!hapd->conf->radius->acct_server)
260 msg = accounting_msg(hapd, sta,
261 stop ? RADIUS_ACCT_STATUS_TYPE_STOP :
262 RADIUS_ACCT_STATUS_TYPE_INTERIM_UPDATE);
264 wpa_printf(MSG_INFO, "Could not create RADIUS Accounting message");
268 os_get_reltime(&now_r);
270 os_reltime_sub(&now_r, &sta->acct_session_start, &diff);
271 if (!radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_SESSION_TIME,
273 wpa_printf(MSG_INFO, "Could not add Acct-Session-Time");
277 if (accounting_sta_update_stats(hapd, sta, &data) == 0) {
278 if (!radius_msg_add_attr_int32(msg,
279 RADIUS_ATTR_ACCT_INPUT_PACKETS,
281 wpa_printf(MSG_INFO, "Could not add Acct-Input-Packets");
284 if (!radius_msg_add_attr_int32(msg,
285 RADIUS_ATTR_ACCT_OUTPUT_PACKETS,
287 wpa_printf(MSG_INFO, "Could not add Acct-Output-Packets");
290 if (!radius_msg_add_attr_int32(msg,
291 RADIUS_ATTR_ACCT_INPUT_OCTETS,
293 wpa_printf(MSG_INFO, "Could not add Acct-Input-Octets");
296 gigawords = sta->acct_input_gigawords;
298 gigawords += data.rx_bytes >> 32;
301 !radius_msg_add_attr_int32(
302 msg, RADIUS_ATTR_ACCT_INPUT_GIGAWORDS,
304 wpa_printf(MSG_INFO, "Could not add Acct-Input-Gigawords");
307 if (!radius_msg_add_attr_int32(msg,
308 RADIUS_ATTR_ACCT_OUTPUT_OCTETS,
310 wpa_printf(MSG_INFO, "Could not add Acct-Output-Octets");
313 gigawords = sta->acct_output_gigawords;
315 gigawords += data.tx_bytes >> 32;
318 !radius_msg_add_attr_int32(
319 msg, RADIUS_ATTR_ACCT_OUTPUT_GIGAWORDS,
321 wpa_printf(MSG_INFO, "Could not add Acct-Output-Gigawords");
326 if (!radius_msg_add_attr_int32(msg, RADIUS_ATTR_EVENT_TIMESTAMP,
328 wpa_printf(MSG_INFO, "Could not add Event-Timestamp");
332 if (eloop_terminated())
333 cause = RADIUS_ACCT_TERMINATE_CAUSE_ADMIN_REBOOT;
336 !radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_TERMINATE_CAUSE,
338 wpa_printf(MSG_INFO, "Could not add Acct-Terminate-Cause");
342 if (radius_client_send(hapd->radius, msg,
343 stop ? RADIUS_ACCT : RADIUS_ACCT_INTERIM,
349 radius_msg_free(msg);
354 * accounting_sta_interim - Send a interim STA accounting report
355 * @hapd: hostapd BSS data
358 static void accounting_sta_interim(struct hostapd_data *hapd,
359 struct sta_info *sta)
361 if (sta->acct_session_started)
362 accounting_sta_report(hapd, sta, 0);
367 * accounting_sta_stop - Stop STA accounting
368 * @hapd: hostapd BSS data
371 void accounting_sta_stop(struct hostapd_data *hapd, struct sta_info *sta)
373 if (sta->acct_session_started) {
374 accounting_sta_report(hapd, sta, 1);
375 eloop_cancel_timeout(accounting_interim_update, hapd, sta);
376 hostapd_logger(hapd, sta->addr, HOSTAPD_MODULE_RADIUS,
378 "stopped accounting session %08X-%08X",
379 sta->acct_session_id_hi,
380 sta->acct_session_id_lo);
381 sta->acct_session_started = 0;
386 void accounting_sta_get_id(struct hostapd_data *hapd,
387 struct sta_info *sta)
389 sta->acct_session_id_lo = hapd->acct_session_id_lo++;
390 if (hapd->acct_session_id_lo == 0) {
391 hapd->acct_session_id_hi++;
393 sta->acct_session_id_hi = hapd->acct_session_id_hi;
398 * accounting_receive - Process the RADIUS frames from Accounting Server
399 * @msg: RADIUS response message
400 * @req: RADIUS request message
401 * @shared_secret: RADIUS shared secret
402 * @shared_secret_len: Length of shared_secret in octets
403 * @data: Context data (struct hostapd_data *)
404 * Returns: Processing status
406 static RadiusRxResult
407 accounting_receive(struct radius_msg *msg, struct radius_msg *req,
408 const u8 *shared_secret, size_t shared_secret_len,
411 if (radius_msg_get_hdr(msg)->code != RADIUS_CODE_ACCOUNTING_RESPONSE) {
412 wpa_printf(MSG_INFO, "Unknown RADIUS message code");
413 return RADIUS_RX_UNKNOWN;
416 if (radius_msg_verify(msg, shared_secret, shared_secret_len, req, 0)) {
417 wpa_printf(MSG_INFO, "Incoming RADIUS packet did not have correct Authenticator - dropped");
418 return RADIUS_RX_INVALID_AUTHENTICATOR;
421 return RADIUS_RX_PROCESSED;
425 static void accounting_report_state(struct hostapd_data *hapd, int on)
427 struct radius_msg *msg;
429 if (!hapd->conf->radius->acct_server || hapd->radius == NULL)
432 /* Inform RADIUS server that accounting will start/stop so that the
433 * server can close old accounting sessions. */
434 msg = accounting_msg(hapd, NULL,
435 on ? RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_ON :
436 RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_OFF);
440 if (!radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_TERMINATE_CAUSE,
441 RADIUS_ACCT_TERMINATE_CAUSE_NAS_REBOOT))
443 wpa_printf(MSG_INFO, "Could not add Acct-Terminate-Cause");
444 radius_msg_free(msg);
448 if (radius_client_send(hapd->radius, msg, RADIUS_ACCT, NULL) < 0)
449 radius_msg_free(msg);
454 * accounting_init: Initialize accounting
455 * @hapd: hostapd BSS data
456 * Returns: 0 on success, -1 on failure
458 int accounting_init(struct hostapd_data *hapd)
462 /* Acct-Session-Id should be unique over reboots. Using a random number
463 * is preferred. If that is not available, take the current time. Mix
464 * in microseconds to make this more likely to be unique. */
466 if (os_get_random((u8 *) &hapd->acct_session_id_hi,
467 sizeof(hapd->acct_session_id_hi)) < 0)
468 hapd->acct_session_id_hi = now.sec;
469 hapd->acct_session_id_hi ^= now.usec;
471 if (radius_client_register(hapd->radius, RADIUS_ACCT,
472 accounting_receive, hapd))
475 accounting_report_state(hapd, 1);
482 * accounting_deinit: Deinitialize accounting
483 * @hapd: hostapd BSS data
485 void accounting_deinit(struct hostapd_data *hapd)
487 accounting_report_state(hapd, 0);