contrib/hostapd/hostapd/accounting.c

   1 /*
   2  * hostapd / RADIUS Accounting
   3  * Copyright (c) 2002-2008, Jouni Malinen <j@w1.fi>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 as
   7  * published by the Free Software Foundation.
   8  *
   9  * Alternatively, this software may be distributed under the terms of BSD
  10  * license.
  11  *
  12  * See README and COPYING for more details.
  13  */
  14
  15 #include "includes.h"
  16
  17 #include "hostapd.h"
  18 #include "radius/radius.h"
  19 #include "radius/radius_client.h"
  20 #include "eloop.h"
  21 #include "accounting.h"
  22 #include "ieee802_1x.h"
  23 #include "driver.h"
  24
  25
  26 /* Default interval in seconds for polling TX/RX octets from the driver if
  27  * STA is not using interim accounting. This detects wrap arounds for
  28  * input/output octets and updates Acct-{Input,Output}-Gigawords. */
  29 #define ACCT_DEFAULT_UPDATE_INTERVAL 300
  30
  31 static void accounting_sta_get_id(struct hostapd_data *hapd,
  32                                   struct sta_info *sta);
  33
  34
  35 static struct radius_msg * accounting_msg(struct hostapd_data *hapd,
  36                                           struct sta_info *sta,
  37                                           int status_type)
  38 {
  39         struct radius_msg *msg;
  40         char buf[128];
  41         u8 *val;
  42         size_t len;
  43         int i;
  44
  45         msg = radius_msg_new(RADIUS_CODE_ACCOUNTING_REQUEST,
  46                              radius_client_get_id(hapd->radius));
  47         if (msg == NULL) {
  48                 printf("Could not create net RADIUS packet\n");
  49                 return NULL;
  50         }
  51
  52         if (sta) {
  53                 radius_msg_make_authenticator(msg, (u8 *) sta, sizeof(*sta));
  54
  55                 os_snprintf(buf, sizeof(buf), "%08X-%08X",
  56                             sta->acct_session_id_hi, sta->acct_session_id_lo);
  57                 if (!radius_msg_add_attr(msg, RADIUS_ATTR_ACCT_SESSION_ID,
  58                                          (u8 *) buf, os_strlen(buf))) {
  59                         printf("Could not add Acct-Session-Id\n");
  60                         goto fail;
  61                 }
  62         } else {
  63                 radius_msg_make_authenticator(msg, (u8 *) hapd, sizeof(*hapd));
  64         }
  65
  66         if (!radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_STATUS_TYPE,
  67                                        status_type)) {
  68                 printf("Could not add Acct-Status-Type\n");
  69                 goto fail;
  70         }
  71
  72         if (!radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_AUTHENTIC,
  73                                        hapd->conf->ieee802_1x ?
  74                                        RADIUS_ACCT_AUTHENTIC_RADIUS :
  75                                        RADIUS_ACCT_AUTHENTIC_LOCAL)) {
  76                 printf("Could not add Acct-Authentic\n");
  77                 goto fail;
  78         }
  79
  80         if (sta) {
  81                 val = ieee802_1x_get_identity(sta->eapol_sm, &len);
  82                 if (!val) {
  83                         os_snprintf(buf, sizeof(buf), RADIUS_ADDR_FORMAT,
  84                                     MAC2STR(sta->addr));
  85                         val = (u8 *) buf;
  86                         len = os_strlen(buf);
  87                 }
  88
  89                 if (!radius_msg_add_attr(msg, RADIUS_ATTR_USER_NAME, val,
  90                                          len)) {
  91                         printf("Could not add User-Name\n");
  92                         goto fail;
  93                 }
  94         }
  95
  96         if (hapd->conf->own_ip_addr.af == AF_INET &&
  97             !radius_msg_add_attr(msg, RADIUS_ATTR_NAS_IP_ADDRESS,
  98                                  (u8 *) &hapd->conf->own_ip_addr.u.v4, 4)) {
  99                 printf("Could not add NAS-IP-Address\n");
 100                 goto fail;
 101         }
 102
 103 #ifdef CONFIG_IPV6
 104         if (hapd->conf->own_ip_addr.af == AF_INET6 &&
 105             !radius_msg_add_attr(msg, RADIUS_ATTR_NAS_IPV6_ADDRESS,
 106                                  (u8 *) &hapd->conf->own_ip_addr.u.v6, 16)) {
 107                 printf("Could not add NAS-IPv6-Address\n");
 108                 goto fail;
 109         }
 110 #endif /* CONFIG_IPV6 */
 111
 112         if (hapd->conf->nas_identifier &&
 113             !radius_msg_add_attr(msg, RADIUS_ATTR_NAS_IDENTIFIER,
 114                                  (u8 *) hapd->conf->nas_identifier,
 115                                  os_strlen(hapd->conf->nas_identifier))) {
 116                 printf("Could not add NAS-Identifier\n");
 117                 goto fail;
 118         }
 119
 120         if (sta &&
 121             !radius_msg_add_attr_int32(msg, RADIUS_ATTR_NAS_PORT, sta->aid)) {
 122                 printf("Could not add NAS-Port\n");
 123                 goto fail;
 124         }
 125
 126         os_snprintf(buf, sizeof(buf), RADIUS_802_1X_ADDR_FORMAT ":%s",
 127                     MAC2STR(hapd->own_addr), hapd->conf->ssid.ssid);
 128         if (!radius_msg_add_attr(msg, RADIUS_ATTR_CALLED_STATION_ID,
 129                                  (u8 *) buf, os_strlen(buf))) {
 130                 printf("Could not add Called-Station-Id\n");
 131                 goto fail;
 132         }
 133
 134         if (sta) {
 135                 os_snprintf(buf, sizeof(buf), RADIUS_802_1X_ADDR_FORMAT,
 136                             MAC2STR(sta->addr));
 137                 if (!radius_msg_add_attr(msg, RADIUS_ATTR_CALLING_STATION_ID,
 138                                          (u8 *) buf, os_strlen(buf))) {
 139                         printf("Could not add Calling-Station-Id\n");
 140                         goto fail;
 141                 }
 142
 143                 if (!radius_msg_add_attr_int32(
 144                             msg, RADIUS_ATTR_NAS_PORT_TYPE,
 145                             RADIUS_NAS_PORT_TYPE_IEEE_802_11)) {
 146                         printf("Could not add NAS-Port-Type\n");
 147                         goto fail;
 148                 }
 149
 150                 os_snprintf(buf, sizeof(buf), "CONNECT %d%sMbps %s",
 151                             radius_sta_rate(hapd, sta) / 2,
 152                             (radius_sta_rate(hapd, sta) & 1) ? ".5" : "",
 153                             radius_mode_txt(hapd));
 154                 if (!radius_msg_add_attr(msg, RADIUS_ATTR_CONNECT_INFO,
 155                                          (u8 *) buf, os_strlen(buf))) {
 156                         printf("Could not add Connect-Info\n");
 157                         goto fail;
 158                 }
 159
 160                 for (i = 0; ; i++) {
 161                         val = ieee802_1x_get_radius_class(sta->eapol_sm, &len,
 162                                                           i);
 163                         if (val == NULL)
 164                                 break;
 165
 166                         if (!radius_msg_add_attr(msg, RADIUS_ATTR_CLASS,
 167                                                  val, len)) {
 168                                 printf("Could not add Class\n");
 169                                 goto fail;
 170                         }
 171                 }
 172         }
 173
 174         return msg;
 175
 176  fail:
 177         radius_msg_free(msg);
 178         os_free(msg);
 179         return NULL;
 180 }
 181
 182
 183 static int accounting_sta_update_stats(struct hostapd_data *hapd,
 184                                        struct sta_info *sta,
 185                                        struct hostap_sta_driver_data *data)
 186 {
 187         if (hostapd_read_sta_data(hapd, data, sta->addr))
 188                 return -1;
 189
 190         if (sta->last_rx_bytes > data->rx_bytes)
 191                 sta->acct_input_gigawords++;
 192         if (sta->last_tx_bytes > data->tx_bytes)
 193                 sta->acct_output_gigawords++;
 194         sta->last_rx_bytes = data->rx_bytes;
 195         sta->last_tx_bytes = data->tx_bytes;
 196
 197         hostapd_logger(hapd, sta->addr, HOSTAPD_MODULE_RADIUS,
 198                        HOSTAPD_LEVEL_DEBUG, "updated TX/RX stats: "
 199                        "Acct-Input-Octets=%lu Acct-Input-Gigawords=%u "
 200                        "Acct-Output-Octets=%lu Acct-Output-Gigawords=%u",
 201                        sta->last_rx_bytes, sta->acct_input_gigawords,
 202                        sta->last_tx_bytes, sta->acct_output_gigawords);
 203
 204         return 0;
 205 }
 206
 207
 208 static void accounting_interim_update(void *eloop_ctx, void *timeout_ctx)
 209 {
 210         struct hostapd_data *hapd = eloop_ctx;
 211         struct sta_info *sta = timeout_ctx;
 212         int interval;
 213
 214         if (sta->acct_interim_interval) {
 215                 accounting_sta_interim(hapd, sta);
 216                 interval = sta->acct_interim_interval;
 217         } else {
 218                 struct hostap_sta_driver_data data;
 219                 accounting_sta_update_stats(hapd, sta, &data);
 220                 interval = ACCT_DEFAULT_UPDATE_INTERVAL;
 221         }
 222
 223         eloop_register_timeout(interval, 0, accounting_interim_update,
 224                                hapd, sta);
 225 }
 226
 227
 228 /**
 229  * accounting_sta_start - Start STA accounting
 230  * @hapd: hostapd BSS data
 231  * @sta: The station
 232  */
 233 void accounting_sta_start(struct hostapd_data *hapd, struct sta_info *sta)
 234 {
 235         struct radius_msg *msg;
 236         int interval;
 237
 238         if (sta->acct_session_started)
 239                 return;
 240
 241         accounting_sta_get_id(hapd, sta);
 242         hostapd_logger(hapd, sta->addr, HOSTAPD_MODULE_RADIUS,
 243                        HOSTAPD_LEVEL_INFO,
 244                        "starting accounting session %08X-%08X",
 245                        sta->acct_session_id_hi, sta->acct_session_id_lo);
 246
 247         time(&sta->acct_session_start);
 248         sta->last_rx_bytes = sta->last_tx_bytes = 0;
 249         sta->acct_input_gigawords = sta->acct_output_gigawords = 0;
 250         hostapd_sta_clear_stats(hapd, sta->addr);
 251
 252         if (!hapd->conf->radius->acct_server)
 253                 return;
 254
 255         if (sta->acct_interim_interval)
 256                 interval = sta->acct_interim_interval;
 257         else
 258                 interval = ACCT_DEFAULT_UPDATE_INTERVAL;
 259         eloop_register_timeout(interval, 0, accounting_interim_update,
 260                                hapd, sta);
 261
 262         msg = accounting_msg(hapd, sta, RADIUS_ACCT_STATUS_TYPE_START);
 263         if (msg)
 264                 radius_client_send(hapd->radius, msg, RADIUS_ACCT, sta->addr);
 265
 266         sta->acct_session_started = 1;
 267 }
 268
 269
 270 static void accounting_sta_report(struct hostapd_data *hapd,
 271                                   struct sta_info *sta, int stop)
 272 {
 273         struct radius_msg *msg;
 274         int cause = sta->acct_terminate_cause;
 275         struct hostap_sta_driver_data data;
 276         u32 gigawords;
 277
 278         if (!hapd->conf->radius->acct_server)
 279                 return;
 280
 281         msg = accounting_msg(hapd, sta,
 282                              stop ? RADIUS_ACCT_STATUS_TYPE_STOP :
 283                              RADIUS_ACCT_STATUS_TYPE_INTERIM_UPDATE);
 284         if (!msg) {
 285                 printf("Could not create RADIUS Accounting message\n");
 286                 return;
 287         }
 288
 289         if (!radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_SESSION_TIME,
 290                                        time(NULL) - sta->acct_session_start)) {
 291                 printf("Could not add Acct-Session-Time\n");
 292                 goto fail;
 293         }
 294
 295         if (accounting_sta_update_stats(hapd, sta, &data) == 0) {
 296                 if (!radius_msg_add_attr_int32(msg,
 297                                                RADIUS_ATTR_ACCT_INPUT_PACKETS,
 298                                                data.rx_packets)) {
 299                         printf("Could not add Acct-Input-Packets\n");
 300                         goto fail;
 301                 }
 302                 if (!radius_msg_add_attr_int32(msg,
 303                                                RADIUS_ATTR_ACCT_OUTPUT_PACKETS,
 304                                                data.tx_packets)) {
 305                         printf("Could not add Acct-Output-Packets\n");
 306                         goto fail;
 307                 }
 308                 if (!radius_msg_add_attr_int32(msg,
 309                                                RADIUS_ATTR_ACCT_INPUT_OCTETS,
 310                                                data.rx_bytes)) {
 311                         printf("Could not add Acct-Input-Octets\n");
 312                         goto fail;
 313                 }
 314                 gigawords = sta->acct_input_gigawords;
 315 #if __WORDSIZE == 64
 316                 gigawords += data.rx_bytes >> 32;
 317 #endif
 318                 if (gigawords &&
 319                     !radius_msg_add_attr_int32(
 320                             msg, RADIUS_ATTR_ACCT_INPUT_GIGAWORDS,
 321                             gigawords)) {
 322                         printf("Could not add Acct-Input-Gigawords\n");
 323                         goto fail;
 324                 }
 325                 if (!radius_msg_add_attr_int32(msg,
 326                                                RADIUS_ATTR_ACCT_OUTPUT_OCTETS,
 327                                                data.tx_bytes)) {
 328                         printf("Could not add Acct-Output-Octets\n");
 329                         goto fail;
 330                 }
 331                 gigawords = sta->acct_output_gigawords;
 332 #if __WORDSIZE == 64
 333                 gigawords += data.tx_bytes >> 32;
 334 #endif
 335                 if (gigawords &&
 336                     !radius_msg_add_attr_int32(
 337                             msg, RADIUS_ATTR_ACCT_OUTPUT_GIGAWORDS,
 338                             gigawords)) {
 339                         printf("Could not add Acct-Output-Gigawords\n");
 340                         goto fail;
 341                 }
 342         }
 343
 344         if (!radius_msg_add_attr_int32(msg, RADIUS_ATTR_EVENT_TIMESTAMP,
 345                                        time(NULL))) {
 346                 printf("Could not add Event-Timestamp\n");
 347                 goto fail;
 348         }
 349
 350         if (eloop_terminated())
 351                 cause = RADIUS_ACCT_TERMINATE_CAUSE_ADMIN_REBOOT;
 352
 353         if (stop && cause &&
 354             !radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_TERMINATE_CAUSE,
 355                                        cause)) {
 356                 printf("Could not add Acct-Terminate-Cause\n");
 357                 goto fail;
 358         }
 359
 360         radius_client_send(hapd->radius, msg,
 361                            stop ? RADIUS_ACCT : RADIUS_ACCT_INTERIM,
 362                            sta->addr);
 363         return;
 364
 365  fail:
 366         radius_msg_free(msg);
 367         os_free(msg);
 368 }
 369
 370
 371 /**
 372  * accounting_sta_interim - Send a interim STA accounting report
 373  * @hapd: hostapd BSS data
 374  * @sta: The station
 375  */
 376 void accounting_sta_interim(struct hostapd_data *hapd, struct sta_info *sta)
 377 {
 378         if (sta->acct_session_started)
 379                 accounting_sta_report(hapd, sta, 0);
 380 }
 381
 382
 383 /**
 384  * accounting_sta_stop - Stop STA accounting
 385  * @hapd: hostapd BSS data
 386  * @sta: The station
 387  */
 388 void accounting_sta_stop(struct hostapd_data *hapd, struct sta_info *sta)
 389 {
 390         if (sta->acct_session_started) {
 391                 accounting_sta_report(hapd, sta, 1);
 392                 eloop_cancel_timeout(accounting_interim_update, hapd, sta);
 393                 hostapd_logger(hapd, sta->addr, HOSTAPD_MODULE_RADIUS,
 394                                HOSTAPD_LEVEL_INFO,
 395                                "stopped accounting session %08X-%08X",
 396                                sta->acct_session_id_hi,
 397                                sta->acct_session_id_lo);
 398                 sta->acct_session_started = 0;
 399         }
 400 }
 401
 402
 403 static void accounting_sta_get_id(struct hostapd_data *hapd,
 404                                   struct sta_info *sta)
 405 {
 406         sta->acct_session_id_lo = hapd->acct_session_id_lo++;
 407         if (hapd->acct_session_id_lo == 0) {
 408                 hapd->acct_session_id_hi++;
 409         }
 410         sta->acct_session_id_hi = hapd->acct_session_id_hi;
 411 }
 412
 413
 414 /**
 415  * accounting_receive - Process the RADIUS frames from Accounting Server
 416  * @msg: RADIUS response message
 417  * @req: RADIUS request message
 418  * @shared_secret: RADIUS shared secret
 419  * @shared_secret_len: Length of shared_secret in octets
 420  * @data: Context data (struct hostapd_data *)
 421  * Returns: Processing status
 422  */
 423 static RadiusRxResult
 424 accounting_receive(struct radius_msg *msg, struct radius_msg *req,
 425                    const u8 *shared_secret, size_t shared_secret_len,
 426                    void *data)
 427 {
 428         if (msg->hdr->code != RADIUS_CODE_ACCOUNTING_RESPONSE) {
 429                 printf("Unknown RADIUS message code\n");
 430                 return RADIUS_RX_UNKNOWN;
 431         }
 432
 433         if (radius_msg_verify(msg, shared_secret, shared_secret_len, req, 0)) {
 434                 printf("Incoming RADIUS packet did not have correct "
 435                        "Authenticator - dropped\n");
 436                 return RADIUS_RX_INVALID_AUTHENTICATOR;
 437         }
 438
 439         return RADIUS_RX_PROCESSED;
 440 }
 441
 442
 443 static void accounting_report_state(struct hostapd_data *hapd, int on)
 444 {
 445         struct radius_msg *msg;
 446
 447         if (!hapd->conf->radius->acct_server || hapd->radius == NULL)
 448                 return;
 449
 450         /* Inform RADIUS server that accounting will start/stop so that the
 451          * server can close old accounting sessions. */
 452         msg = accounting_msg(hapd, NULL,
 453                              on ? RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_ON :
 454                              RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_OFF);
 455         if (!msg)
 456                 return;
 457
 458         if (!radius_msg_add_attr_int32(msg, RADIUS_ATTR_ACCT_TERMINATE_CAUSE,
 459                                        RADIUS_ACCT_TERMINATE_CAUSE_NAS_REBOOT))
 460         {
 461                 printf("Could not add Acct-Terminate-Cause\n");
 462                 radius_msg_free(msg);
 463                 os_free(msg);
 464                 return;
 465         }
 466
 467         radius_client_send(hapd->radius, msg, RADIUS_ACCT, NULL);
 468 }
 469
 470
 471 /**
 472  * accounting_init: Initialize accounting
 473  * @hapd: hostapd BSS data
 474  * Returns: 0 on success, -1 on failure
 475  */
 476 int accounting_init(struct hostapd_data *hapd)
 477 {
 478         /* Acct-Session-Id should be unique over reboots. If reliable clock is
 479          * not available, this could be replaced with reboot counter, etc. */
 480         hapd->acct_session_id_hi = time(NULL);
 481
 482         if (radius_client_register(hapd->radius, RADIUS_ACCT,
 483                                    accounting_receive, hapd))
 484                 return -1;
 485
 486         accounting_report_state(hapd, 1);
 487
 488         return 0;
 489 }
 490
 491
 492 /**
 493  * accounting_deinit: Deinitilize accounting
 494  * @hapd: hostapd BSS data
 495  */
 496 void accounting_deinit(struct hostapd_data *hapd)
 497 {
 498         accounting_report_state(hapd, 0);
 499 }
 500
 501
 502 int accounting_reconfig(struct hostapd_data *hapd,
 503                         struct hostapd_config *oldconf)
 504 {
 505         if (!hapd->radius_client_reconfigured)
 506                 return 0;
 507
 508         accounting_deinit(hapd);
 509         return accounting_init(hapd);
 510 }