Merged revisions 321926 via svnmerge from
[asterisk/asterisk.git] / cel / cel_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 /*! \file
20  *
21  * \brief RADIUS CEL Support
22  * \author Philippe Sultan
23  * \extref The Radius Client Library - http://developer.berlios.de/projects/radiusclient-ng/
24  *
25  * \arg See also \ref AstCEL
26  * \ingroup cel_drivers
27  */
28
29 /*** MODULEINFO
30         <depend>radius</depend>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Rev$")
36
37 #include <radiusclient-ng.h>
38
39 #include "asterisk/channel.h"
40 #include "asterisk/cel.h"
41 #include "asterisk/module.h"
42 #include "asterisk/logger.h"
43 #include "asterisk/utils.h"
44 #include "asterisk/options.h"
45
46 /*! ISO 8601 standard format */
47 #define DATE_FORMAT "%Y-%m-%d %T %z"
48
49 #define VENDOR_CODE           22736
50
51 enum {
52         PW_AST_ACCT_CODE =    101,
53         PW_AST_CIDNUM =       102,
54         PW_AST_CIDNAME =      103,
55         PW_AST_CIDANI =       104,
56         PW_AST_CIDRDNIS =     105,
57         PW_AST_CIDDNID =      106,
58         PW_AST_EXTEN =        107,
59         PW_AST_CONTEXT =      108,
60         PW_AST_CHANNAME =     109,
61         PW_AST_APPNAME =      110,
62         PW_AST_APPDATA =      111,
63         PW_AST_EVENT_TIME =   112,
64         PW_AST_AMA_FLAGS =    113,
65         PW_AST_UNIQUE_ID =    114,
66         PW_AST_USER_NAME =    115,
67         PW_AST_LINKED_ID =    116,
68 };
69
70 enum {
71         /*! Log dates and times in UTC */
72         RADIUS_FLAG_USEGMTIME = (1 << 0),
73         /*! Log Unique ID */
74         RADIUS_FLAG_LOGUNIQUEID = (1 << 1),
75         /*! Log User Field */
76         RADIUS_FLAG_LOGUSERFIELD = (1 << 2)
77 };
78
79 static char *cel_config = "cel.conf";
80
81 static char radiuscfg[PATH_MAX] = "/etc/radiusclient-ng/radiusclient.conf";
82
83 static struct ast_flags global_flags = { RADIUS_FLAG_USEGMTIME | RADIUS_FLAG_LOGUNIQUEID | RADIUS_FLAG_LOGUSERFIELD };
84
85 static rc_handle *rh = NULL;
86 static struct ast_event_sub *event_sub = NULL;
87
88 #define ADD_VENDOR_CODE(x,y) (rc_avpair_add(rh, send, x, &y, strlen(y), VENDOR_CODE))
89
90 static int build_radius_record(VALUE_PAIR **send, struct ast_cel_event_record *record)
91 {
92         int recordtype = PW_STATUS_STOP;
93         struct ast_tm tm;
94         char timestr[128];
95         char *amaflags;
96
97         if (!rc_avpair_add(rh, send, PW_ACCT_STATUS_TYPE, &recordtype, 0, 0)) {
98                 return -1;
99         }
100         /* Account code */
101         if (!ADD_VENDOR_CODE(PW_AST_ACCT_CODE, record->account_code)) {
102                 return -1;
103         }
104         /* Source */
105         if (!ADD_VENDOR_CODE(PW_AST_CIDNUM, record->caller_id_num)) {
106                 return -1;
107         }
108         /* Destination */
109         if (!ADD_VENDOR_CODE(PW_AST_EXTEN, record->extension)) {
110                 return -1;
111         }
112         /* Destination context */
113         if (!ADD_VENDOR_CODE(PW_AST_CONTEXT, record->context)) {
114                 return -1;
115         }
116         /* Caller ID */
117         if (!ADD_VENDOR_CODE(PW_AST_CIDNAME, record->caller_id_name)) {
118                 return -1;
119         }
120         /* Caller ID ani */
121         if (!ADD_VENDOR_CODE(PW_AST_CIDANI, record->caller_id_ani)) {
122                 return -1;
123         }
124         /* Caller ID rdnis */
125         if (!ADD_VENDOR_CODE(PW_AST_CIDRDNIS, record->caller_id_rdnis)) {
126                 return -1;
127         }
128         /* Caller ID dnid */
129         if (!ADD_VENDOR_CODE(PW_AST_CIDDNID, record->caller_id_dnid)) {
130                 return -1;
131         }
132         /* Channel */
133         if (!ADD_VENDOR_CODE(PW_AST_CHANNAME, record->channel_name)) {
134                 return -1;
135         }
136         /* Last Application */
137         if (!ADD_VENDOR_CODE(PW_AST_APPNAME, record->application_name)) {
138                 return -1;
139         }
140         /* Last Data */
141         if (!ADD_VENDOR_CODE(PW_AST_APPDATA, record->application_data)) {
142                 return -1;
143         }
144         /* Event Time */
145         ast_localtime(&record->event_time, &tm,
146                 ast_test_flag(&global_flags, RADIUS_FLAG_USEGMTIME) ? "GMT" : NULL);
147         ast_strftime(timestr, sizeof(timestr), DATE_FORMAT, &tm);
148         if (!rc_avpair_add(rh, send, PW_AST_EVENT_TIME, timestr, strlen(timestr), VENDOR_CODE)) {
149                 return -1;
150         }
151         /* AMA Flags */
152         amaflags = ast_strdupa(ast_cel_get_ama_flag_name(record->amaflag));
153         if (!rc_avpair_add(rh, send, PW_AST_AMA_FLAGS, amaflags, strlen(amaflags), VENDOR_CODE)) {
154                 return -1;
155         }
156         if (ast_test_flag(&global_flags, RADIUS_FLAG_LOGUNIQUEID)) {
157                 /* Unique ID */
158                 if (!ADD_VENDOR_CODE(PW_AST_UNIQUE_ID, record->unique_id)) {
159                         return -1;
160                 }
161         }
162         /* LinkedID */
163         if (!ADD_VENDOR_CODE(PW_AST_LINKED_ID, record->linked_id)) {
164                 return -1;
165         }
166         /* Setting Acct-Session-Id & User-Name attributes for proper generation
167            of Acct-Unique-Session-Id on server side */
168         /* Channel */
169         if (!rc_avpair_add(rh, send, PW_USER_NAME, &record->channel_name,
170                         strlen(record->channel_name), 0)) {
171                 return -1;
172         }
173         return 0;
174 }
175
176 static void radius_log(const struct ast_event *event, void *userdata)
177 {
178         int result = ERROR_RC;
179         VALUE_PAIR *send = NULL;
180         struct ast_cel_event_record record = {
181                 .version = AST_CEL_EVENT_RECORD_VERSION,
182         };
183
184         if (ast_cel_fill_record(event, &record)) {
185                 return;
186         }
187
188         if (build_radius_record(&send, &record)) {
189                 ast_debug(1, "Unable to create RADIUS record. CEL not recorded!\n");
190                 goto return_cleanup;
191         }
192
193         result = rc_acct(rh, 0, send);
194         if (result != OK_RC) {
195                 ast_log(LOG_ERROR, "Failed to record Radius CEL record!\n");
196         }
197
198 return_cleanup:
199         if (send) {
200                 rc_avpair_free(send);
201         }
202 }
203
204 static int unload_module(void)
205 {
206         if (event_sub) {
207                 event_sub = ast_event_unsubscribe(event_sub);
208         }
209         if (rh) {
210                 rc_destroy(rh);
211                 rh = NULL;
212         }
213         return AST_MODULE_LOAD_SUCCESS;
214 }
215
216 static int load_module(void)
217 {
218         struct ast_config *cfg;
219         struct ast_flags config_flags = { 0 };
220         const char *tmp;
221
222         if ((cfg = ast_config_load(cel_config, config_flags))) {
223                 ast_set2_flag(&global_flags, ast_true(ast_variable_retrieve(cfg, "radius", "usegmtime")), RADIUS_FLAG_USEGMTIME);
224                 if ((tmp = ast_variable_retrieve(cfg, "radius", "radiuscfg"))) {
225                         ast_copy_string(radiuscfg, tmp, sizeof(radiuscfg));
226                 }
227                 ast_config_destroy(cfg);
228         } else {
229                 return AST_MODULE_LOAD_DECLINE;
230         }
231
232         /*
233          * start logging
234          *
235          * NOTE: Yes this causes a slight memory leak if the module is
236          * unloaded.  However, it is better than a crash if cdr_radius
237          * and cel_radius are both loaded.
238          */
239         tmp = ast_strdup("asterisk");
240         if (tmp) {
241                 rc_openlog((char *) tmp);
242         }
243
244         /* read radiusclient-ng config file */
245         if (!(rh = rc_read_config(radiuscfg))) {
246                 ast_log(LOG_NOTICE, "Cannot load radiusclient-ng configuration file %s.\n", radiuscfg);
247                 return AST_MODULE_LOAD_DECLINE;
248         }
249
250         /* read radiusclient-ng dictionaries */
251         if (rc_read_dictionary(rh, rc_conf_str(rh, "dictionary"))) {
252                 ast_log(LOG_NOTICE, "Cannot load radiusclient-ng dictionary file.\n");
253                 rc_destroy(rh);
254                 rh = NULL;
255                 return AST_MODULE_LOAD_DECLINE;
256         }
257
258         event_sub = ast_event_subscribe(AST_EVENT_CEL, radius_log, "CEL Radius Logging", NULL, AST_EVENT_IE_END);
259         if (!event_sub) {
260                 rc_destroy(rh);
261                 rh = NULL;
262                 return AST_MODULE_LOAD_DECLINE;
263         } else {
264                 return AST_MODULE_LOAD_SUCCESS;
265         }
266 }
267
268 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "RADIUS CEL Backend",
269         .load = load_module,
270         .unload = unload_module,
271         .load_pri = AST_MODPRI_CDR_DRIVER,
272 );