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