-
Notifications
You must be signed in to change notification settings - Fork 909
/
group_mod.c
340 lines (286 loc) · 7.74 KB
/
group_mod.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
/*
* Copyright (C) 2001-2003 FhG Fokus
*
* This file is part of Kamailio, a free SIP server.
*
* Kamailio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version
*
* Kamailio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
/**
* \file
* \brief Group membership module
* \ingroup group
* - Module: \ref group
*/
/*!
* \defgroup group GROUP :: The Kamailio group Module
* This module provides functions to check if a certain user belongs to a
* group. This group definitions are read from a DB table.
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "../../core/sr_module.h"
#include "../../core/dprint.h"
#include "../../core/ut.h"
#include "../../core/error.h"
#include "../../core/mem/mem.h"
#include "../../core/usr_avp.h"
#include "../../core/kemi.h"
#include "group_mod.h"
#include "group.h"
#include "re_group.h"
MODULE_VERSION
#define TABLE_VERSION 2
#define RE_TABLE_VERSION 1
/*!
* \brief Module destroy function prototype
*/
static void destroy(void);
/*!
* \brief Module child-init function prototype
*/
static int child_init(int rank);
/*!
* \brief Module initialization function prototype
*/
static int mod_init(void);
/*! Header field fixup */
static int hf_fixup(void **param, int param_no);
/*! get user group ID fixup */
static int get_gid_fixup(void **param, int param_no);
#define TABLE "grp"
#define USER_COL "username"
#define DOMAIN_COL "domain"
#define GROUP_COL "grp"
#define RE_TABLE "re_grp"
#define RE_EXP_COL "reg_exp"
#define RE_GID_COL "group_id"
/*
* Module parameter variables
*/
static str db_url = str_init(DEFAULT_RODB_URL);
/*! Table name where group definitions are stored */
str table = str_init(TABLE);
str user_column = str_init(USER_COL);
str domain_column = str_init(DOMAIN_COL);
str group_column = str_init(GROUP_COL);
int use_domain = 0;
/* table and columns used for regular expression-based groups */
str re_table = {0, 0};
str re_exp_column = str_init(RE_EXP_COL);
str re_gid_column = str_init(RE_GID_COL);
int multiple_gid = 1;
/* DB functions and handlers */
db_func_t group_dbf;
db1_con_t *group_dbh = 0;
/*!
* Exported functions
*/
static cmd_export_t cmds[] = {
{"is_user_in", (cmd_function)is_user_in, 2, hf_fixup, 0,
REQUEST_ROUTE | FAILURE_ROUTE | BRANCH_ROUTE | LOCAL_ROUTE},
{"get_user_group", (cmd_function)get_user_group, 2, get_gid_fixup, 0,
REQUEST_ROUTE | FAILURE_ROUTE | BRANCH_ROUTE | LOCAL_ROUTE},
{0, 0, 0, 0, 0, 0}};
/*!
* Exported parameters
*/
static param_export_t params[] = {{"db_url", PARAM_STR, &db_url},
{"table", PARAM_STR, &table}, {"user_column", PARAM_STR, &user_column},
{"domain_column", PARAM_STR, &domain_column},
{"group_column", PARAM_STR, &group_column},
{"use_domain", INT_PARAM, &use_domain},
{"re_table", PARAM_STR, &re_table},
{"re_exp_column", PARAM_STR, &re_exp_column},
{"re_gid_column", PARAM_STR, &re_gid_column},
{"multiple_gid", INT_PARAM, &multiple_gid}, {0, 0, 0}};
/*!
* Module interface
*/
struct module_exports exports = {
"group", /* module name */
DEFAULT_DLFLAGS, /* dlopen flags */
cmds, /* exported functions */
params, /* exported parameters */
0, /* RPC method exports */
0, /* exported pseudo-variables */
0, /* response handling function */
mod_init, /* module initialization function */
child_init, /* per-child init function */
destroy /* module destroy function */
};
static int child_init(int rank)
{
if(rank == PROC_INIT || rank == PROC_MAIN || rank == PROC_TCP_MAIN)
return 0; /* do nothing for the main process */
return group_db_init(&db_url);
}
static int mod_init(void)
{
/* Find a database module */
if(group_db_bind(&db_url)) {
return -1;
}
if(group_db_init(&db_url) < 0) {
LM_ERR("unable to open database connection\n");
return -1;
}
/* check version for group table */
if(db_check_table_version(&group_dbf, group_dbh, &table, TABLE_VERSION)
< 0) {
DB_TABLE_VERSION_ERROR(table);
goto dberror;
}
if(re_table.len) {
/* check version for group re_group table */
if(db_check_table_version(
&group_dbf, group_dbh, &re_table, RE_TABLE_VERSION)
< 0) {
DB_TABLE_VERSION_ERROR(re_table);
goto dberror;
}
if(load_re(&re_table) != 0) {
LM_ERR("failed to load <%s> table\n", re_table.s);
goto dberror;
}
}
group_db_close();
return 0;
dberror:
group_db_close();
return -1;
}
static void destroy(void)
{
group_db_close();
}
/*!
* \brief Convert HF description string to hdr_field pointer
*
* Convert a header field description string to hdr_field structure
* Supported strings: "Request-URI", "To", "From", "Credentials"
* \param str1 header field description string
* \return hdr_field structure on success, NULL on failure
*/
static group_check_p get_hf(char *str1)
{
group_check_p gcp = NULL;
str s;
gcp = (group_check_p)pkg_malloc(sizeof(group_check_t));
if(gcp == NULL) {
LM_ERR("no pkg more memory\n");
return 0;
}
memset(gcp, 0, sizeof(group_check_t));
if(!strcasecmp(str1, "Request-URI")) {
gcp->id = 1;
} else if(!strcasecmp(str1, "To")) {
gcp->id = 2;
} else if(!strcasecmp(str1, "From")) {
gcp->id = 3;
} else if(!strcasecmp(str1, "Credentials")) {
gcp->id = 4;
} else {
s.s = str1;
s.len = strlen(s.s);
if(pv_parse_spec(&s, &gcp->sp) == NULL || gcp->sp.type != PVT_AVP) {
LM_ERR("unsupported User Field identifier\n");
pkg_free(gcp);
return 0;
}
gcp->id = 5;
}
/* do not free all the time, needed by pseudo-variable spec */
if(gcp->id != 5)
pkg_free(str1);
return gcp;
}
/*!
* \brief Header fixup function
* \param param fixed parameter
* \param param_no number of parameters
* \return 0 on success, negative on failure
*/
static int hf_fixup(void **param, int param_no)
{
void *ptr;
str *s;
if(param_no == 1) {
ptr = *param;
if((*param = (void *)get_hf(ptr)) == 0)
return E_UNSPEC;
} else if(param_no == 2) {
s = (str *)pkg_malloc(sizeof(str));
if(!s) {
LM_ERR("no pkg memory left\n");
return E_UNSPEC;
}
s->s = (char *)*param;
s->len = strlen(s->s);
*param = (void *)s;
}
return 0;
}
/*!
* \brief Group ID fixup
* \param param fixed parameter
* \param param_no number of parameters
* \return 0 on success, negative on failure
*/
static int get_gid_fixup(void **param, int param_no)
{
pv_spec_t *sp;
void *ptr;
str name;
if(param_no == 1) {
ptr = *param;
if((*param = (void *)get_hf(ptr)) == 0)
return E_UNSPEC;
} else if(param_no == 2) {
name.s = (char *)*param;
name.len = strlen(name.s);
sp = (pv_spec_t *)pkg_malloc(sizeof(pv_spec_t));
if(sp == NULL) {
LM_ERR("no more pkg memory\n");
return E_UNSPEC;
}
if(pv_parse_spec(&name, sp) == NULL || sp->type != PVT_AVP) {
LM_ERR("bad AVP spec <%s>\n", name.s);
pv_spec_free(sp);
return E_UNSPEC;
}
*param = sp;
}
return 0;
}
/**
*
*/
/* clang-format off */
static sr_kemi_t sr_kemi_group_exports[] = {
{ str_init("group"), str_init("is_user_in"),
SR_KEMIP_INT, ki_is_user_in,
{ SR_KEMIP_STR, SR_KEMIP_STR, SR_KEMIP_NONE,
SR_KEMIP_NONE, SR_KEMIP_NONE, SR_KEMIP_NONE }
},
{ {0, 0}, {0, 0}, 0, NULL, { 0, 0, 0, 0, 0, 0 } }
};
/* clang-format on */
int mod_register(char *path, int *dlflags, void *p1, void *p2)
{
sr_kemi_modules_add(sr_kemi_group_exports);
return 0;
}