res_pjsip: allow configuration of endpoint identifier query order
[asterisk/asterisk.git] / res / res_pjsip_endpoint_identifier_ip.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@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 /*** MODULEINFO
20         <depend>pjproject</depend>
21         <depend>res_pjsip</depend>
22         <support_level>core</support_level>
23  ***/
24
25 #include "asterisk.h"
26
27 #include <pjsip.h>
28
29 #include "asterisk/res_pjsip.h"
30 #include "asterisk/res_pjsip_cli.h"
31 #include "asterisk/module.h"
32 #include "asterisk/acl.h"
33 #include "asterisk/manager.h"
34 #include "res_pjsip/include/res_pjsip_private.h"
35
36 /*** DOCUMENTATION
37         <configInfo name="res_pjsip_endpoint_identifier_ip" language="en_US">
38                 <synopsis>Module that identifies endpoints via source IP address</synopsis>
39                 <configFile name="pjsip.conf">
40                         <configObject name="identify">
41                                 <synopsis>Identifies endpoints via source IP address</synopsis>
42                                 <configOption name="endpoint">
43                                         <synopsis>Name of Endpoint</synopsis>
44                                 </configOption>
45                                 <configOption name="match">
46                                         <synopsis>IP addresses or networks to match against</synopsis>
47                                         <description><para>
48                                                 The value is a comma-delimited list of IP addresses. IP addresses may
49                                                 have a subnet mask appended. The subnet mask may be written in either
50                                                 CIDR or dot-decimal notation. Separate the IP address and subnet
51                                                 mask with a slash ('/')
52                                         </para></description>
53                                 </configOption>
54                                 <configOption name="type">
55                                         <synopsis>Must be of type 'identify'.</synopsis>
56                                 </configOption>
57                         </configObject>
58                 </configFile>
59         </configInfo>
60  ***/
61
62 /*! \brief Structure for an IP identification matching object */
63 struct ip_identify_match {
64         /*! \brief Sorcery object details */
65         SORCERY_OBJECT(details);
66         /*! \brief Stringfields */
67         AST_DECLARE_STRING_FIELDS(
68                 /*! The name of the endpoint */
69                 AST_STRING_FIELD(endpoint_name);
70         );
71         /*! \brief Networks or addresses that should match this */
72         struct ast_ha *matches;
73 };
74
75 /*! \brief Destructor function for a matching object */
76 static void ip_identify_destroy(void *obj)
77 {
78         struct ip_identify_match *identify = obj;
79
80         ast_string_field_free_memory(identify);
81         ast_free_ha(identify->matches);
82 }
83
84 /*! \brief Allocator function for a matching object */
85 static void *ip_identify_alloc(const char *name)
86 {
87         struct ip_identify_match *identify = ast_sorcery_generic_alloc(sizeof(*identify), ip_identify_destroy);
88
89         if (!identify || ast_string_field_init(identify, 256)) {
90                 ao2_cleanup(identify);
91                 return NULL;
92         }
93
94         return identify;
95 }
96
97 /*! \brief Comparator function for a matching object */
98 static int ip_identify_match_check(void *obj, void *arg, int flags)
99 {
100         struct ip_identify_match *identify = obj;
101         struct ast_sockaddr *addr = arg;
102         int sense;
103
104         sense = ast_apply_ha(identify->matches, addr);
105         if (sense != AST_SENSE_ALLOW) {
106                 ast_debug(3, "Source address %s matches identify '%s'\n",
107                                 ast_sockaddr_stringify(addr),
108                                 ast_sorcery_object_get_id(identify));
109                 return CMP_MATCH | CMP_STOP;
110         } else {
111                 ast_debug(3, "Source address %s does not match identify '%s'\n",
112                                 ast_sockaddr_stringify(addr),
113                                 ast_sorcery_object_get_id(identify));
114                 return 0;
115         }
116 }
117
118 static struct ast_sip_endpoint *ip_identify(pjsip_rx_data *rdata)
119 {
120         struct ast_sockaddr addr = { { 0, } };
121         RAII_VAR(struct ao2_container *, candidates, NULL, ao2_cleanup);
122         RAII_VAR(struct ip_identify_match *, match, NULL, ao2_cleanup);
123         struct ast_sip_endpoint *endpoint;
124
125         /* If no possibilities exist return early to save some time */
126         if (!(candidates = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "identify", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL)) ||
127                 !ao2_container_count(candidates)) {
128                 ast_debug(3, "No identify sections to match against\n");
129                 return NULL;
130         }
131
132         ast_sockaddr_parse(&addr, rdata->pkt_info.src_name, PARSE_PORT_FORBID);
133         ast_sockaddr_set_port(&addr, rdata->pkt_info.src_port);
134
135         if (!(match = ao2_callback(candidates, 0, ip_identify_match_check, &addr))) {
136                 ast_debug(3, "'%s' did not match any identify section rules\n",
137                                 ast_sockaddr_stringify(&addr));
138                 return NULL;
139         }
140
141         endpoint = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint", match->endpoint_name);
142         if (endpoint) {
143                 ast_debug(3, "Retrieved endpoint %s\n", ast_sorcery_object_get_id(endpoint));
144         } else {
145                 ast_log(LOG_WARNING, "Identify section '%s' points to endpoint '%s' but endpoint could not be looked up\n",
146                                 ast_sorcery_object_get_id(match), match->endpoint_name);
147         }
148
149         return endpoint;
150 }
151
152 static struct ast_sip_endpoint_identifier ip_identifier = {
153         .name = "ip",
154         .identify_endpoint = ip_identify,
155 };
156
157 /*! \brief Custom handler for match field */
158 static int ip_identify_match_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
159 {
160         struct ip_identify_match *identify = obj;
161         char *input_string = ast_strdupa(var->value);
162         char *current_string;
163
164         if (ast_strlen_zero(var->value)) {
165                 return 0;
166         }
167
168         while ((current_string = strsep(&input_string, ","))) {
169                 struct ast_sockaddr *addrs;
170                 int num_addrs = 0, error = 0, i;
171                 char *mask = strrchr(current_string, '/');
172
173                 if (mask) {
174                         identify->matches = ast_append_ha("d", current_string, identify->matches, &error);
175
176                         if (!identify->matches || error) {
177                                 ast_log(LOG_ERROR, "Failed to add address '%s' to ip endpoint identifier '%s'\n",
178                                         current_string, ast_sorcery_object_get_id(obj));
179                                 return -1;
180                         }
181
182                         continue;
183                 }
184
185                 num_addrs = ast_sockaddr_resolve(&addrs, current_string, PARSE_PORT_FORBID, AST_AF_UNSPEC);
186                 if (!num_addrs) {
187                         ast_log(LOG_ERROR, "Address '%s' provided on ip endpoint identifier '%s' did not resolve to any address\n",
188                                 var->value, ast_sorcery_object_get_id(obj));
189                         return -1;
190                 }
191
192                 for (i = 0; i < num_addrs; ++i) {
193                         /* We deny what we actually want to match because there is an implicit permit all rule for ACLs */
194                         identify->matches = ast_append_ha("d", ast_sockaddr_stringify_addr(&addrs[i]), identify->matches, &error);
195
196                         if (!identify->matches || error) {
197                                 ast_log(LOG_ERROR, "Failed to add address '%s' to ip endpoint identifier '%s'\n",
198                                         ast_sockaddr_stringify_addr(&addrs[i]), ast_sorcery_object_get_id(obj));
199                                 error = -1;
200                                 break;
201                         }
202                 }
203
204                 ast_free(addrs);
205
206                 if (error) {
207                         return -1;
208                 }
209         }
210
211         return 0;
212 }
213
214
215 static int match_to_str(const void *obj, const intptr_t *args, char **buf)
216 {
217         RAII_VAR(struct ast_str *, str, ast_str_create(MAX_OBJECT_FIELD), ast_free);
218         const struct ip_identify_match *identify = obj;
219
220         ast_ha_join(identify->matches, &str);
221         *buf = ast_strdup(ast_str_buffer(str));
222         return 0;
223 }
224
225 static int match_to_var_list(const void *obj, struct ast_variable **fields)
226 {
227         char str[MAX_OBJECT_FIELD];
228         const struct ip_identify_match *identify = obj;
229         struct ast_variable *head = NULL;
230         struct ast_ha *ha = identify->matches;
231
232         for (; ha; ha = ha->next) {
233                 const char *addr = ast_strdupa(ast_sockaddr_stringify_addr(&ha->addr));
234                 snprintf(str, MAX_OBJECT_FIELD, "%s%s/%s", ha->sense == AST_SENSE_ALLOW ? "!" : "",
235                         addr, ast_sockaddr_stringify_addr(&ha->netmask));
236
237                 ast_variable_list_append(&head, ast_variable_new("match", str, ""));
238
239         }
240
241         if (head) {
242                 *fields = head;
243         }
244
245         return 0;
246 }
247
248 static int sip_identify_to_ami(const struct ip_identify_match *identify,
249                                struct ast_str **buf)
250 {
251         return ast_sip_sorcery_object_to_ami(identify, buf);
252 }
253
254 static int find_identify_by_endpoint(void *obj, void *arg, int flags)
255 {
256         struct ip_identify_match *identify = obj;
257         const char *endpoint_name = arg;
258
259         return strcmp(identify->endpoint_name, endpoint_name) ? 0 : CMP_MATCH;
260 }
261
262 static int format_ami_endpoint_identify(const struct ast_sip_endpoint *endpoint,
263                                         struct ast_sip_ami *ami)
264 {
265         RAII_VAR(struct ao2_container *, identifies, NULL, ao2_cleanup);
266         RAII_VAR(struct ip_identify_match *, identify, NULL, ao2_cleanup);
267         RAII_VAR(struct ast_str *, buf, NULL, ast_free);
268
269         identifies = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "identify",
270                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
271         if (!identifies) {
272                 return -1;
273         }
274
275         identify = ao2_callback(identifies, 0, find_identify_by_endpoint,
276                 (void *) ast_sorcery_object_get_id(endpoint));
277         if (!identify) {
278                 return 1;
279         }
280
281         if (!(buf = ast_sip_create_ami_event("IdentifyDetail", ami))) {
282                 return -1;
283         }
284
285         if (sip_identify_to_ami(identify, &buf)) {
286                 return -1;
287         }
288
289         ast_str_append(&buf, 0, "EndpointName: %s\r\n",
290                 ast_sorcery_object_get_id(endpoint));
291
292         astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
293         ami->count++;
294
295         return 0;
296 }
297
298 struct ast_sip_endpoint_formatter endpoint_identify_formatter = {
299         .format_ami = format_ami_endpoint_identify
300 };
301
302 static int cli_populate_container(void *obj, void *arg, int flags)
303 {
304         ao2_link(arg, obj);
305
306         return 0;
307 }
308
309 static int cli_iterator(void *container, ao2_callback_fn callback, void *args)
310 {
311         const struct ast_sip_endpoint *endpoint = container;
312         struct ao2_container *identifies;
313
314         struct ast_variable fields = {
315                 .name = "endpoint",
316                 .value = ast_sorcery_object_get_id(endpoint),
317                 .next = NULL,
318         };
319
320         identifies = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "identify",
321                 AST_RETRIEVE_FLAG_MULTIPLE, &fields);
322         if (!identifies) {
323                 return -1;
324         }
325
326         ao2_callback(identifies, OBJ_NODATA, callback, args);
327         ao2_cleanup(identifies);
328
329         return 0;
330 }
331
332 static int cli_endpoint_gather_identifies(void *obj, void *arg, int flags)
333 {
334         struct ast_sip_endpoint *endpoint = obj;
335         struct ao2_container *container = arg;
336
337         cli_iterator(endpoint, cli_populate_container, container);
338
339         return 0;
340 }
341
342 static struct ao2_container *cli_get_container(void)
343 {
344         RAII_VAR(struct ao2_container *, parent_container, NULL, ao2_cleanup);
345         RAII_VAR(struct ao2_container *, s_parent_container, NULL, ao2_cleanup);
346         struct ao2_container *child_container;
347
348         parent_container =  ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "endpoint",
349                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
350         if (!parent_container) {
351                 return NULL;
352         }
353
354         s_parent_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
355                 ast_sorcery_object_id_sort, ast_sorcery_object_id_compare);
356         if (!s_parent_container) {
357                 return NULL;
358         }
359
360         if (ao2_container_dup(s_parent_container, parent_container, 0)) {
361                 return NULL;
362         }
363
364         child_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
365                 ast_sorcery_object_id_sort, ast_sorcery_object_id_compare);
366         if (!child_container) {
367                 return NULL;
368         }
369
370         ao2_callback(s_parent_container, OBJ_NODATA, cli_endpoint_gather_identifies, child_container);
371
372         return child_container;
373 }
374
375 static void *cli_retrieve_by_id(const char *id)
376 {
377         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "identify", id);
378 }
379
380 static int cli_print_header(void *obj, void *arg, int flags)
381 {
382         struct ast_sip_cli_context *context = arg;
383         int indent = CLI_INDENT_TO_SPACES(context->indent_level);
384         int filler = CLI_MAX_WIDTH - indent - 22;
385
386         ast_assert(context->output_buffer != NULL);
387
388         ast_str_append(&context->output_buffer, 0,
389                 "%*s:  <Identify/Endpoint%*.*s>\n",
390                 indent, "Identify", filler, filler, CLI_HEADER_FILLER);
391
392         if (context->recurse) {
393                 context->indent_level++;
394                 indent = CLI_INDENT_TO_SPACES(context->indent_level);
395                 filler = CLI_LAST_TABSTOP - indent - 24;
396
397                 ast_str_append(&context->output_buffer, 0,
398                         "%*s:  <ip/cidr%*.*s>\n",
399                         indent, "Match", filler, filler, CLI_HEADER_FILLER);
400
401                 context->indent_level--;
402         }
403
404         return 0;
405 }
406
407 static int cli_print_body(void *obj, void *arg, int flags)
408 {
409         RAII_VAR(struct ast_str *, str, ast_str_create(MAX_OBJECT_FIELD), ast_free);
410         struct ip_identify_match *ident = obj;
411         struct ast_sip_cli_context *context = arg;
412         struct ast_ha *match;
413         int indent;
414
415         ast_assert(context->output_buffer != NULL);
416
417         ast_str_append(&context->output_buffer, 0, "%*s:  %s/%s\n",
418                 CLI_INDENT_TO_SPACES(context->indent_level), "Identify",
419                 ast_sorcery_object_get_id(ident), ident->endpoint_name);
420
421         if (context->recurse) {
422                 context->indent_level++;
423                 indent = CLI_INDENT_TO_SPACES(context->indent_level);
424
425                 for (match = ident->matches; match; match = match->next) {
426                         const char *addr = ast_sockaddr_stringify_addr(&match->addr);
427
428                         ast_str_append(&context->output_buffer, 0, "%*s: %s%s/%d\n",
429                                 indent,
430                                 "Match",
431                                 match->sense == AST_SENSE_ALLOW ? "!" : "",
432                                 addr, ast_sockaddr_cidr_bits(&match->netmask));
433                 }
434
435                 context->indent_level--;
436
437                 if (context->indent_level == 0) {
438                         ast_str_append(&context->output_buffer, 0, "\n");
439                 }
440         }
441
442         if (context->show_details
443                 || (context->show_details_only_level_0 && context->indent_level == 0)) {
444                 ast_str_append(&context->output_buffer, 0, "\n");
445                 ast_sip_cli_print_sorcery_objectset(ident, context, 0);
446         }
447
448         return 0;
449 }
450
451 /*
452  * A function pointer to callback needs to be within the
453  * module in order to avoid problems with an undefined
454  * symbol when the module is loaded.
455  */
456 static char *my_cli_traverse_objects(struct ast_cli_entry *e, int cmd,
457         struct ast_cli_args *a)
458 {
459         return ast_sip_cli_traverse_objects(e, cmd, a);
460 }
461
462 static struct ast_cli_entry cli_identify[] = {
463 AST_CLI_DEFINE(my_cli_traverse_objects, "List PJSIP Identifies",
464         .command = "pjsip list identifies",
465         .usage = "Usage: pjsip list identifies\n"
466         "       List the configured PJSIP Identifies\n"),
467 AST_CLI_DEFINE(my_cli_traverse_objects, "Show PJSIP Identifies",
468         .command = "pjsip show identifies",
469         .usage = "Usage: pjsip show identifies\n"
470         "       Show the configured PJSIP Identifies\n"),
471 AST_CLI_DEFINE(my_cli_traverse_objects, "Show PJSIP Identify",
472         .command = "pjsip show identify",
473         .usage = "Usage: pjsip show identify <id>\n"
474         "       Show the configured PJSIP Identify\n"),
475 };
476
477 static struct ast_sip_cli_formatter_entry *cli_formatter;
478
479 static int load_module(void)
480 {
481         CHECK_PJSIP_MODULE_LOADED();
482
483         ast_sorcery_apply_config(ast_sip_get_sorcery(), "res_pjsip_endpoint_identifier_ip");
484         ast_sorcery_apply_default(ast_sip_get_sorcery(), "identify", "config", "pjsip.conf,criteria=type=identify");
485
486         if (ast_sorcery_object_register(ast_sip_get_sorcery(), "identify", ip_identify_alloc, NULL, NULL)) {
487                 return AST_MODULE_LOAD_DECLINE;
488         }
489
490         ast_sorcery_object_field_register(ast_sip_get_sorcery(), "identify", "type", "", OPT_NOOP_T, 0, 0);
491         ast_sorcery_object_field_register(ast_sip_get_sorcery(), "identify", "endpoint", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ip_identify_match, endpoint_name));
492         ast_sorcery_object_field_register_custom(ast_sip_get_sorcery(), "identify", "match", "", ip_identify_match_handler, match_to_str, match_to_var_list, 0, 0);
493         ast_sorcery_reload_object(ast_sip_get_sorcery(), "identify");
494
495         ast_sip_register_endpoint_identifier(&ip_identifier);
496         ast_sip_register_endpoint_formatter(&endpoint_identify_formatter);
497
498         cli_formatter = ao2_alloc(sizeof(struct ast_sip_cli_formatter_entry), NULL);
499         if (!cli_formatter) {
500                 ast_log(LOG_ERROR, "Unable to allocate memory for cli formatter\n");
501                 return AST_MODULE_LOAD_DECLINE;
502         }
503         cli_formatter->name = "identify";
504         cli_formatter->print_header = cli_print_header;
505         cli_formatter->print_body = cli_print_body;
506         cli_formatter->get_container = cli_get_container;
507         cli_formatter->iterate = cli_iterator;
508         cli_formatter->get_id = ast_sorcery_object_get_id;
509         cli_formatter->retrieve_by_id = cli_retrieve_by_id;
510
511         ast_sip_register_cli_formatter(cli_formatter);
512         ast_cli_register_multiple(cli_identify, ARRAY_LEN(cli_identify));
513
514         return AST_MODULE_LOAD_SUCCESS;
515 }
516
517 static int reload_module(void)
518 {
519         ast_sorcery_reload_object(ast_sip_get_sorcery(), "identify");
520
521         return 0;
522 }
523
524 static int unload_module(void)
525 {
526         ast_cli_unregister_multiple(cli_identify, ARRAY_LEN(cli_identify));
527         ast_sip_unregister_cli_formatter(cli_formatter);
528         ast_sip_unregister_endpoint_formatter(&endpoint_identify_formatter);
529         ast_sip_unregister_endpoint_identifier(&ip_identifier);
530
531         return 0;
532 }
533
534 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP IP endpoint identifier",
535                 .support_level = AST_MODULE_SUPPORT_CORE,
536                 .load = load_module,
537                 .reload = reload_module,
538                 .unload = unload_module,
539                 .load_pri = AST_MODPRI_APP_DEPEND,
540                );