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