101d1abb2de5b4bcb003149456de23d54798c7e8
[asterisk/asterisk.git] / cdr / cdr_radius.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file
21  * \brief RADIUS CDR Support
22  *
23  * \author Philippe Sultan
24  * The Radius Client Library
25  *      http://developer.berlios.de/projects/radiusclient-ng/
26  *
27  * \arg See also \ref AstCDR
28  * \ingroup cdr_drivers
29  */
30
31 /*** MODULEINFO
32         <depend>radius</depend>
33         <support_level>extended</support_level>
34  ***/
35
36 #include "asterisk.h"
37
38 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
39
40 #include <radiusclient-ng.h>
41
42 #include "asterisk/channel.h"
43 #include "asterisk/cdr.h"
44 #include "asterisk/module.h"
45 #include "asterisk/utils.h"
46
47 /*! ISO 8601 standard format */
48 #define DATE_FORMAT "%Y-%m-%d %T %z"
49
50 #define VENDOR_CODE           22736
51
52 enum {
53         PW_AST_ACCT_CODE =    101,
54         PW_AST_SRC =          102,
55         PW_AST_DST =          103,
56         PW_AST_DST_CTX =      104,
57         PW_AST_CLID =         105,
58         PW_AST_CHAN =         106,
59         PW_AST_DST_CHAN =     107,
60         PW_AST_LAST_APP =     108,
61         PW_AST_LAST_DATA =    109,
62         PW_AST_START_TIME =   110,
63         PW_AST_ANSWER_TIME =  111,
64         PW_AST_END_TIME =     112,
65         PW_AST_DURATION =     113,
66         PW_AST_BILL_SEC =     114,
67         PW_AST_DISPOSITION =  115,
68         PW_AST_AMA_FLAGS =    116,
69         PW_AST_UNIQUE_ID =    117,
70         PW_AST_USER_FIELD =   118
71 };
72
73 enum {
74         /*! Log dates and times in UTC */
75         RADIUS_FLAG_USEGMTIME = (1 << 0),
76         /*! Log Unique ID */
77         RADIUS_FLAG_LOGUNIQUEID = (1 << 1),
78         /*! Log User Field */
79         RADIUS_FLAG_LOGUSERFIELD = (1 << 2)
80 };
81
82 static const char desc[] = "RADIUS CDR Backend";
83 static const char name[] = "radius";
84 static const char cdr_config[] = "cdr.conf";
85
86 static char radiuscfg[PATH_MAX] = "/etc/radiusclient-ng/radiusclient.conf";
87
88 static struct ast_flags global_flags = { RADIUS_FLAG_USEGMTIME | RADIUS_FLAG_LOGUNIQUEID | RADIUS_FLAG_LOGUSERFIELD };
89
90 static rc_handle *rh = NULL;
91
92 static int build_radius_record(VALUE_PAIR **tosend, struct ast_cdr *cdr)
93 {
94         int recordtype = PW_STATUS_STOP;
95         struct ast_tm tm;
96         char timestr[128];
97         char *tmp;
98
99         if (!rc_avpair_add(rh, tosend, PW_ACCT_STATUS_TYPE, &recordtype, 0, 0))
100                 return -1;
101
102         /* Account code */
103         if (!rc_avpair_add(rh, tosend, PW_AST_ACCT_CODE, &cdr->accountcode, strlen(cdr->accountcode), VENDOR_CODE))
104                 return -1;
105
106         /* Source */
107         if (!rc_avpair_add(rh, tosend, PW_AST_SRC, &cdr->src, strlen(cdr->src), VENDOR_CODE))
108                 return -1;
109
110         /* Destination */
111         if (!rc_avpair_add(rh, tosend, PW_AST_DST, &cdr->dst, strlen(cdr->dst), VENDOR_CODE))
112                 return -1;
113
114         /* Destination context */
115         if (!rc_avpair_add(rh, tosend, PW_AST_DST_CTX, &cdr->dcontext, strlen(cdr->dcontext), VENDOR_CODE))
116                 return -1;
117
118         /* Caller ID */
119         if (!rc_avpair_add(rh, tosend, PW_AST_CLID, &cdr->clid, strlen(cdr->clid), VENDOR_CODE))
120                 return -1;
121
122         /* Channel */
123         if (!rc_avpair_add(rh, tosend, PW_AST_CHAN, &cdr->channel, strlen(cdr->channel), VENDOR_CODE))
124                 return -1;
125
126         /* Destination Channel */
127         if (!rc_avpair_add(rh, tosend, PW_AST_DST_CHAN, &cdr->dstchannel, strlen(cdr->dstchannel), VENDOR_CODE))
128                 return -1;
129
130         /* Last Application */
131         if (!rc_avpair_add(rh, tosend, PW_AST_LAST_APP, &cdr->lastapp, strlen(cdr->lastapp), VENDOR_CODE))
132                 return -1;
133
134         /* Last Data */
135         if (!rc_avpair_add(rh, tosend, PW_AST_LAST_DATA, &cdr->lastdata, strlen(cdr->lastdata), VENDOR_CODE))
136                 return -1;
137
138
139         /* Start Time */
140         ast_strftime(timestr, sizeof(timestr), DATE_FORMAT,
141                 ast_localtime(&cdr->start, &tm,
142                         ast_test_flag(&global_flags, RADIUS_FLAG_USEGMTIME) ? "GMT" : NULL));
143         if (!rc_avpair_add(rh, tosend, PW_AST_START_TIME, timestr, strlen(timestr), VENDOR_CODE))
144                 return -1;
145
146         /* Answer Time */
147         ast_strftime(timestr, sizeof(timestr), DATE_FORMAT,
148                 ast_localtime(&cdr->answer, &tm,
149                         ast_test_flag(&global_flags, RADIUS_FLAG_USEGMTIME) ? "GMT" : NULL));
150         if (!rc_avpair_add(rh, tosend, PW_AST_ANSWER_TIME, timestr, strlen(timestr), VENDOR_CODE))
151                 return -1;
152
153         /* End Time */
154         ast_strftime(timestr, sizeof(timestr), DATE_FORMAT,
155                 ast_localtime(&cdr->end, &tm,
156                         ast_test_flag(&global_flags, RADIUS_FLAG_USEGMTIME) ? "GMT" : NULL));
157         if (!rc_avpair_add(rh, tosend, PW_AST_END_TIME, timestr, strlen(timestr), VENDOR_CODE))
158                 return -1;
159
160         /* Duration */
161         if (!rc_avpair_add(rh, tosend, PW_AST_DURATION, &cdr->duration, 0, VENDOR_CODE))
162                 return -1;
163
164         /* Billable seconds */
165         if (!rc_avpair_add(rh, tosend, PW_AST_BILL_SEC, &cdr->billsec, 0, VENDOR_CODE))
166                 return -1;
167
168         /* Disposition */
169         tmp = ast_cdr_disp2str(cdr->disposition);
170         if (!rc_avpair_add(rh, tosend, PW_AST_DISPOSITION, tmp, strlen(tmp), VENDOR_CODE))
171                 return -1;
172
173         /* AMA Flags */
174         tmp = ast_cdr_flags2str(cdr->amaflags);
175         if (!rc_avpair_add(rh, tosend, PW_AST_AMA_FLAGS, tmp, strlen(tmp), VENDOR_CODE))
176                 return -1;
177
178         if (ast_test_flag(&global_flags, RADIUS_FLAG_LOGUNIQUEID)) {
179                 /* Unique ID */
180                 if (!rc_avpair_add(rh, tosend, PW_AST_UNIQUE_ID, &cdr->uniqueid, strlen(cdr->uniqueid), VENDOR_CODE))
181                         return -1;
182         }
183
184         if (ast_test_flag(&global_flags, RADIUS_FLAG_LOGUSERFIELD)) {
185                 /* append the user field */
186                 if (!rc_avpair_add(rh, tosend, PW_AST_USER_FIELD, &cdr->userfield, strlen(cdr->userfield), VENDOR_CODE))
187                         return -1;
188         }
189
190         /* Setting Acct-Session-Id & User-Name attributes for proper generation
191          * of Acct-Unique-Session-Id on server side 
192          */
193         /* Channel */
194         if (!rc_avpair_add(rh, tosend, PW_USER_NAME, &cdr->channel, strlen(cdr->channel), 0))
195                 return -1;
196
197         /* Unique ID */
198         if (!rc_avpair_add(rh, tosend, PW_ACCT_SESSION_ID, &cdr->uniqueid, strlen(cdr->uniqueid), 0))
199                 return -1;
200
201         return 0;
202 }
203
204 static int radius_log(struct ast_cdr *cdr)
205 {
206         int result = ERROR_RC;
207         VALUE_PAIR *tosend = NULL;
208
209         if (build_radius_record(&tosend, cdr)) {
210                 ast_debug(1, "Unable to create RADIUS record. CDR not recorded!\n");
211                 goto return_cleanup;
212         }
213
214         result = rc_acct(rh, 0, tosend);
215         if (result != OK_RC) {
216                 ast_log(LOG_ERROR, "Failed to record Radius CDR record!\n");
217         }
218
219 return_cleanup:
220         if (tosend) {
221                 rc_avpair_free(tosend);
222         }
223
224         return result;
225 }
226
227 static int unload_module(void)
228 {
229         ast_cdr_unregister(name);
230         if (rh) {
231                 rc_destroy(rh);
232                 rh = NULL;
233         }
234         return 0;
235 }
236
237 static int load_module(void)
238 {
239         struct ast_config *cfg;
240         struct ast_flags config_flags = { 0 };
241         const char *tmp;
242
243         if ((cfg = ast_config_load(cdr_config, config_flags)) && cfg != CONFIG_STATUS_FILEINVALID) {
244                 ast_set2_flag(&global_flags, ast_true(ast_variable_retrieve(cfg, "radius", "usegmtime")), RADIUS_FLAG_USEGMTIME);
245                 ast_set2_flag(&global_flags, ast_true(ast_variable_retrieve(cfg, "radius", "loguniqueid")), RADIUS_FLAG_LOGUNIQUEID);
246                 ast_set2_flag(&global_flags, ast_true(ast_variable_retrieve(cfg, "radius", "loguserfield")), RADIUS_FLAG_LOGUSERFIELD);
247                 if ((tmp = ast_variable_retrieve(cfg, "radius", "radiuscfg")))
248                         ast_copy_string(radiuscfg, tmp, sizeof(radiuscfg));
249                 ast_config_destroy(cfg);
250         } else
251                 return AST_MODULE_LOAD_DECLINE;
252
253         /*
254          * start logging
255          *
256          * NOTE: Yes this causes a slight memory leak if the module is
257          * unloaded.  However, it is better than a crash if cdr_radius
258          * and cel_radius are both loaded.
259          */
260         tmp = ast_strdup("asterisk");
261         if (tmp) {
262                 rc_openlog((char *) tmp);
263         }
264
265         /* read radiusclient-ng config file */
266         if (!(rh = rc_read_config(radiuscfg))) {
267                 ast_log(LOG_NOTICE, "Cannot load radiusclient-ng configuration file %s.\n", radiuscfg);
268                 return AST_MODULE_LOAD_DECLINE;
269         }
270
271         /* read radiusclient-ng dictionaries */
272         if (rc_read_dictionary(rh, rc_conf_str(rh, "dictionary"))) {
273                 ast_log(LOG_NOTICE, "Cannot load radiusclient-ng dictionary file.\n");
274                 rc_destroy(rh);
275                 rh = NULL;
276                 return AST_MODULE_LOAD_DECLINE;
277         }
278
279         if (ast_cdr_register(name, desc, radius_log)) {
280                 rc_destroy(rh);
281                 rh = NULL;
282                 return AST_MODULE_LOAD_DECLINE;
283         } else {
284                 return AST_MODULE_LOAD_SUCCESS;
285         }
286 }
287
288 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "RADIUS CDR Backend",
289                 .load = load_module,
290                 .unload = unload_module,
291                 .load_pri = AST_MODPRI_CDR_DRIVER,
292         );