res_pjsip_endpoint_identifier_ip: Add support for SRV lookups.
[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="srv_lookups" default="yes">
55                                         <synopsis>Perform SRV lookups for provided hostnames.</synopsis>
56                                         <description><para>When enabled, <replaceable>srv_lookups</replaceable> will
57                                         perform SRV lookups for _sip._udp, _sip._tcp, and _sips._tcp of the given
58                                         hostnames to determine additional addresses that traffic may originate from.
59                                         </para></description>
60                                 </configOption>
61                                 <configOption name="type">
62                                         <synopsis>Must be of type 'identify'.</synopsis>
63                                 </configOption>
64                         </configObject>
65                 </configFile>
66         </configInfo>
67  ***/
68
69 /*! \brief Structure for an IP identification matching object */
70 struct ip_identify_match {
71         /*! \brief Sorcery object details */
72         SORCERY_OBJECT(details);
73         /*! \brief Stringfields */
74         AST_DECLARE_STRING_FIELDS(
75                 /*! The name of the endpoint */
76                 AST_STRING_FIELD(endpoint_name);
77         );
78         /*! \brief Networks or addresses that should match this */
79         struct ast_ha *matches;
80         /*! \brief Perform SRV resolution of hostnames */
81         unsigned int srv_lookups;
82 };
83
84 /*! \brief Destructor function for a matching object */
85 static void ip_identify_destroy(void *obj)
86 {
87         struct ip_identify_match *identify = obj;
88
89         ast_string_field_free_memory(identify);
90         ast_free_ha(identify->matches);
91 }
92
93 /*! \brief Allocator function for a matching object */
94 static void *ip_identify_alloc(const char *name)
95 {
96         struct ip_identify_match *identify = ast_sorcery_generic_alloc(sizeof(*identify), ip_identify_destroy);
97
98         if (!identify || ast_string_field_init(identify, 256)) {
99                 ao2_cleanup(identify);
100                 return NULL;
101         }
102
103         return identify;
104 }
105
106 /*! \brief Comparator function for a matching object */
107 static int ip_identify_match_check(void *obj, void *arg, int flags)
108 {
109         struct ip_identify_match *identify = obj;
110         struct ast_sockaddr *addr = arg;
111         int sense;
112
113         sense = ast_apply_ha(identify->matches, addr);
114         if (sense != AST_SENSE_ALLOW) {
115                 ast_debug(3, "Source address %s matches identify '%s'\n",
116                                 ast_sockaddr_stringify(addr),
117                                 ast_sorcery_object_get_id(identify));
118                 return CMP_MATCH | CMP_STOP;
119         } else {
120                 ast_debug(3, "Source address %s does not match identify '%s'\n",
121                                 ast_sockaddr_stringify(addr),
122                                 ast_sorcery_object_get_id(identify));
123                 return 0;
124         }
125 }
126
127 static struct ast_sip_endpoint *ip_identify(pjsip_rx_data *rdata)
128 {
129         struct ast_sockaddr addr = { { 0, } };
130         RAII_VAR(struct ao2_container *, candidates, NULL, ao2_cleanup);
131         RAII_VAR(struct ip_identify_match *, match, NULL, ao2_cleanup);
132         struct ast_sip_endpoint *endpoint;
133
134         /* If no possibilities exist return early to save some time */
135         if (!(candidates = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "identify", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL)) ||
136                 !ao2_container_count(candidates)) {
137                 ast_debug(3, "No identify sections to match against\n");
138                 return NULL;
139         }
140
141         ast_sockaddr_parse(&addr, rdata->pkt_info.src_name, PARSE_PORT_FORBID);
142         ast_sockaddr_set_port(&addr, rdata->pkt_info.src_port);
143
144         if (!(match = ao2_callback(candidates, 0, ip_identify_match_check, &addr))) {
145                 ast_debug(3, "'%s' did not match any identify section rules\n",
146                                 ast_sockaddr_stringify(&addr));
147                 return NULL;
148         }
149
150         endpoint = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint", match->endpoint_name);
151         if (endpoint) {
152                 ast_debug(3, "Retrieved endpoint %s\n", ast_sorcery_object_get_id(endpoint));
153         } else {
154                 ast_log(LOG_WARNING, "Identify section '%s' points to endpoint '%s' but endpoint could not be looked up\n",
155                                 ast_sorcery_object_get_id(match), match->endpoint_name);
156         }
157
158         return endpoint;
159 }
160
161 static struct ast_sip_endpoint_identifier ip_identifier = {
162         .identify_endpoint = ip_identify,
163 };
164
165 /*! \brief Helper function which performs a host lookup and adds result to identify match */
166 static int ip_identify_match_host_lookup(struct ip_identify_match *identify, const char *host)
167 {
168         struct ast_sockaddr *addrs;
169         int num_addrs = 0, error = 0, i;
170         int results = 0;
171
172         num_addrs = ast_sockaddr_resolve(&addrs, host, PARSE_PORT_FORBID, AST_AF_UNSPEC);
173         if (!num_addrs) {
174                 return -1;
175         }
176
177         for (i = 0; i < num_addrs; ++i) {
178                 /* Check if the address is already in the list, if so don't bother adding it again */
179                 if (identify->matches && (ast_apply_ha(identify->matches, &addrs[i]) != AST_SENSE_ALLOW)) {
180                         continue;
181                 }
182
183                 /* We deny what we actually want to match because there is an implicit permit all rule for ACLs */
184                 identify->matches = ast_append_ha("d", ast_sockaddr_stringify_addr(&addrs[i]), identify->matches, &error);
185
186                 if (!identify->matches || error) {
187                         results = -1;
188                         break;
189                 }
190
191                 results += 1;
192         }
193
194         ast_free(addrs);
195
196         return results;
197 }
198
199 /*! \brief Helper function which performs an SRV lookup and then resolves the hostname */
200 static int ip_identify_match_srv_lookup(struct ip_identify_match *identify, const char *prefix, const char *host)
201 {
202         char service[NI_MAXHOST];
203         struct srv_context *context = NULL;
204         int srv_ret;
205         const char *srvhost;
206         unsigned short srvport;
207         int results = 0;
208
209         snprintf(service, sizeof(service), "%s.%s", prefix, host);
210
211         while (!(srv_ret = ast_srv_lookup(&context, service, &srvhost, &srvport))) {
212                 int hosts;
213
214                 /* In the case of the SRV lookup we don't care if it fails, we will output a log message
215                  * when we fallback to a normal lookup.
216                  */
217                 hosts = ip_identify_match_host_lookup(identify, srvhost);
218                 if (hosts == -1) {
219                         results = -1;
220                         break;
221                 } else {
222                         results += hosts;
223                 }
224         }
225
226         ast_srv_cleanup(&context);
227
228         return results;
229 }
230
231 /*! \brief Custom handler for match field */
232 static int ip_identify_match_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
233 {
234         struct ip_identify_match *identify = obj;
235         char *input_string = ast_strdupa(var->value);
236         char *current_string;
237
238         if (ast_strlen_zero(var->value)) {
239                 return 0;
240         }
241
242         while ((current_string = ast_strip(strsep(&input_string, ",")))) {
243                 char *mask = strrchr(current_string, '/');
244                 struct ast_sockaddr address;
245                 int error, results = 0;
246
247                 if (ast_strlen_zero(current_string)) {
248                         continue;
249                 }
250
251                 if (mask) {
252                         identify->matches = ast_append_ha("d", current_string, identify->matches, &error);
253
254                         if (!identify->matches || error) {
255                                 ast_log(LOG_ERROR, "Failed to add address '%s' to ip endpoint identifier '%s'\n",
256                                         current_string, ast_sorcery_object_get_id(obj));
257                                 return -1;
258                         }
259
260                         continue;
261                 }
262
263                 /* If the provided string is not an IP address perform SRV resolution on it */
264                 if (identify->srv_lookups && !ast_sockaddr_parse(&address, current_string, 0)) {
265                         results = ip_identify_match_srv_lookup(identify, "_sip._udp", current_string);
266                         if (results != -1) {
267                                 results += ip_identify_match_srv_lookup(identify, "_sip._tcp", current_string);
268                         }
269                         if (results != -1) {
270                                 results += ip_identify_match_srv_lookup(identify, "_sips._tcp", current_string);
271                         }
272                 }
273
274                 /* If SRV falls fall back to a normal lookup on the host itself */
275                 if (!results) {
276                         results = ip_identify_match_host_lookup(identify, current_string);
277                 }
278
279                 if (results == 0) {
280                         ast_log(LOG_ERROR, "Address '%s' provided on ip endpoint identifier '%s' did not resolve to any address\n",
281                                 current_string, ast_sorcery_object_get_id(obj));
282                 } else if (results == -1) {
283                         ast_log(LOG_ERROR, "An error occurred when adding resolution results of '%s' on '%s'\n",
284                                 current_string, ast_sorcery_object_get_id(obj));
285                         return -1;
286                 }
287         }
288
289         return 0;
290 }
291
292
293 static int match_to_str(const void *obj, const intptr_t *args, char **buf)
294 {
295         RAII_VAR(struct ast_str *, str, ast_str_create(MAX_OBJECT_FIELD), ast_free);
296         const struct ip_identify_match *identify = obj;
297
298         ast_ha_join(identify->matches, &str);
299         *buf = ast_strdup(ast_str_buffer(str));
300         return 0;
301 }
302
303 static int match_to_var_list(const void *obj, struct ast_variable **fields)
304 {
305         char str[MAX_OBJECT_FIELD];
306         const struct ip_identify_match *identify = obj;
307         struct ast_variable *head = NULL;
308         struct ast_ha *ha = identify->matches;
309
310         for (; ha; ha = ha->next) {
311                 const char *addr = ast_strdupa(ast_sockaddr_stringify_addr(&ha->addr));
312                 snprintf(str, MAX_OBJECT_FIELD, "%s%s/%s", ha->sense == AST_SENSE_ALLOW ? "!" : "",
313                         addr, ast_sockaddr_stringify_addr(&ha->netmask));
314
315                 ast_variable_list_append(&head, ast_variable_new("match", str, ""));
316
317         }
318
319         if (head) {
320                 *fields = head;
321         }
322
323         return 0;
324 }
325
326 static int sip_identify_to_ami(const struct ip_identify_match *identify,
327                                struct ast_str **buf)
328 {
329         return ast_sip_sorcery_object_to_ami(identify, buf);
330 }
331
332 static int find_identify_by_endpoint(void *obj, void *arg, int flags)
333 {
334         struct ip_identify_match *identify = obj;
335         const char *endpoint_name = arg;
336
337         return strcmp(identify->endpoint_name, endpoint_name) ? 0 : CMP_MATCH;
338 }
339
340 static int format_ami_endpoint_identify(const struct ast_sip_endpoint *endpoint,
341                                         struct ast_sip_ami *ami)
342 {
343         RAII_VAR(struct ao2_container *, identifies, NULL, ao2_cleanup);
344         RAII_VAR(struct ip_identify_match *, identify, NULL, ao2_cleanup);
345         RAII_VAR(struct ast_str *, buf, NULL, ast_free);
346
347         identifies = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "identify",
348                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
349         if (!identifies) {
350                 return -1;
351         }
352
353         identify = ao2_callback(identifies, 0, find_identify_by_endpoint,
354                 (void *) ast_sorcery_object_get_id(endpoint));
355         if (!identify) {
356                 return 1;
357         }
358
359         if (!(buf = ast_sip_create_ami_event("IdentifyDetail", ami))) {
360                 return -1;
361         }
362
363         if (sip_identify_to_ami(identify, &buf)) {
364                 return -1;
365         }
366
367         ast_str_append(&buf, 0, "EndpointName: %s\r\n",
368                 ast_sorcery_object_get_id(endpoint));
369
370         astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
371         ami->count++;
372
373         return 0;
374 }
375
376 struct ast_sip_endpoint_formatter endpoint_identify_formatter = {
377         .format_ami = format_ami_endpoint_identify
378 };
379
380 static int cli_iterator(void *container, ao2_callback_fn callback, void *args)
381 {
382         const struct ast_sip_endpoint *endpoint = container;
383         struct ao2_container *identifies;
384
385         struct ast_variable fields = {
386                 .name = "endpoint",
387                 .value = ast_sorcery_object_get_id(endpoint),
388                 .next = NULL,
389         };
390
391         identifies = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "identify",
392                 AST_RETRIEVE_FLAG_MULTIPLE, &fields);
393         if (!identifies) {
394                 return -1;
395         }
396
397         ao2_callback(identifies, OBJ_NODATA, callback, args);
398         ao2_cleanup(identifies);
399
400         return 0;
401 }
402
403 static struct ao2_container *cli_get_container(const char *regex)
404 {
405         RAII_VAR(struct ao2_container *, container, NULL, ao2_cleanup);
406         struct ao2_container *s_container;
407
408         container =  ast_sorcery_retrieve_by_regex(ast_sip_get_sorcery(), "identify", regex);
409         if (!container) {
410                 return NULL;
411         }
412
413         s_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
414                 ast_sorcery_object_id_sort, ast_sorcery_object_id_compare);
415         if (!s_container) {
416                 return NULL;
417         }
418
419         if (ao2_container_dup(s_container, container, 0)) {
420                 ao2_ref(s_container, -1);
421                 return NULL;
422         }
423
424         return s_container;
425 }
426
427 static void *cli_retrieve_by_id(const char *id)
428 {
429         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "identify", id);
430 }
431
432 static int cli_print_header(void *obj, void *arg, int flags)
433 {
434         struct ast_sip_cli_context *context = arg;
435         int indent = CLI_INDENT_TO_SPACES(context->indent_level);
436         int filler = CLI_MAX_WIDTH - indent - 22;
437
438         ast_assert(context->output_buffer != NULL);
439
440         ast_str_append(&context->output_buffer, 0,
441                 "%*s:  <Identify/Endpoint%*.*s>\n",
442                 indent, "Identify", filler, filler, CLI_HEADER_FILLER);
443
444         if (context->recurse) {
445                 context->indent_level++;
446                 indent = CLI_INDENT_TO_SPACES(context->indent_level);
447                 filler = CLI_LAST_TABSTOP - indent - 24;
448
449                 ast_str_append(&context->output_buffer, 0,
450                         "%*s:  <ip/cidr%*.*s>\n",
451                         indent, "Match", filler, filler, CLI_HEADER_FILLER);
452
453                 context->indent_level--;
454         }
455
456         return 0;
457 }
458
459 static int cli_print_body(void *obj, void *arg, int flags)
460 {
461         RAII_VAR(struct ast_str *, str, ast_str_create(MAX_OBJECT_FIELD), ast_free);
462         struct ip_identify_match *ident = obj;
463         struct ast_sip_cli_context *context = arg;
464         struct ast_ha *match;
465         int indent;
466
467         ast_assert(context->output_buffer != NULL);
468
469         ast_str_append(&context->output_buffer, 0, "%*s:  %s/%s\n",
470                 CLI_INDENT_TO_SPACES(context->indent_level), "Identify",
471                 ast_sorcery_object_get_id(ident), ident->endpoint_name);
472
473         if (context->recurse) {
474                 context->indent_level++;
475                 indent = CLI_INDENT_TO_SPACES(context->indent_level);
476
477                 for (match = ident->matches; match; match = match->next) {
478                         const char *addr = ast_sockaddr_stringify_addr(&match->addr);
479
480                         ast_str_append(&context->output_buffer, 0, "%*s: %s%s/%d\n",
481                                 indent,
482                                 "Match",
483                                 match->sense == AST_SENSE_ALLOW ? "!" : "",
484                                 addr, ast_sockaddr_cidr_bits(&match->netmask));
485                 }
486
487                 context->indent_level--;
488
489                 if (context->indent_level == 0) {
490                         ast_str_append(&context->output_buffer, 0, "\n");
491                 }
492         }
493
494         if (context->show_details
495                 || (context->show_details_only_level_0 && context->indent_level == 0)) {
496                 ast_str_append(&context->output_buffer, 0, "\n");
497                 ast_sip_cli_print_sorcery_objectset(ident, context, 0);
498         }
499
500         return 0;
501 }
502
503 /*
504  * A function pointer to callback needs to be within the
505  * module in order to avoid problems with an undefined
506  * symbol when the module is loaded.
507  */
508 static char *my_cli_traverse_objects(struct ast_cli_entry *e, int cmd,
509         struct ast_cli_args *a)
510 {
511         return ast_sip_cli_traverse_objects(e, cmd, a);
512 }
513
514 static struct ast_cli_entry cli_identify[] = {
515 AST_CLI_DEFINE(my_cli_traverse_objects, "List PJSIP Identifies",
516         .command = "pjsip list identifies",
517         .usage = "Usage: pjsip list identifies [ like <pattern> ]\n"
518         "       List the configured PJSIP Identifies\n"
519         "       Optional regular expression pattern is used to filter the list.\n"),
520 AST_CLI_DEFINE(my_cli_traverse_objects, "Show PJSIP Identifies",
521         .command = "pjsip show identifies",
522         .usage = "Usage: pjsip show identifies [ like <pattern> ]\n"
523         "       Show the configured PJSIP Identifies\n"
524         "       Optional regular expression pattern is used to filter the list.\n"),
525 AST_CLI_DEFINE(my_cli_traverse_objects, "Show PJSIP Identify",
526         .command = "pjsip show identify",
527         .usage = "Usage: pjsip show identify <id>\n"
528         "       Show the configured PJSIP Identify\n"),
529 };
530
531 static struct ast_sip_cli_formatter_entry *cli_formatter;
532
533 static int load_module(void)
534 {
535         CHECK_PJSIP_MODULE_LOADED();
536
537         ast_sorcery_apply_config(ast_sip_get_sorcery(), "res_pjsip_endpoint_identifier_ip");
538         ast_sorcery_apply_default(ast_sip_get_sorcery(), "identify", "config", "pjsip.conf,criteria=type=identify");
539
540         if (ast_sorcery_object_register(ast_sip_get_sorcery(), "identify", ip_identify_alloc, NULL, NULL)) {
541                 return AST_MODULE_LOAD_DECLINE;
542         }
543
544         ast_sorcery_object_field_register(ast_sip_get_sorcery(), "identify", "type", "", OPT_NOOP_T, 0, 0);
545         ast_sorcery_object_field_register(ast_sip_get_sorcery(), "identify", "endpoint", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ip_identify_match, endpoint_name));
546         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);
547         ast_sorcery_object_field_register(ast_sip_get_sorcery(), "identify", "srv_lookups", "yes", OPT_BOOL_T, 1, FLDSET(struct ip_identify_match, srv_lookups));
548         ast_sorcery_load_object(ast_sip_get_sorcery(), "identify");
549
550         ast_sip_register_endpoint_identifier_with_name(&ip_identifier, "ip");
551         ast_sip_register_endpoint_formatter(&endpoint_identify_formatter);
552
553         cli_formatter = ao2_alloc(sizeof(struct ast_sip_cli_formatter_entry), NULL);
554         if (!cli_formatter) {
555                 ast_log(LOG_ERROR, "Unable to allocate memory for cli formatter\n");
556                 return AST_MODULE_LOAD_DECLINE;
557         }
558         cli_formatter->name = "identify";
559         cli_formatter->print_header = cli_print_header;
560         cli_formatter->print_body = cli_print_body;
561         cli_formatter->get_container = cli_get_container;
562         cli_formatter->iterate = cli_iterator;
563         cli_formatter->get_id = ast_sorcery_object_get_id;
564         cli_formatter->retrieve_by_id = cli_retrieve_by_id;
565
566         ast_sip_register_cli_formatter(cli_formatter);
567         ast_cli_register_multiple(cli_identify, ARRAY_LEN(cli_identify));
568
569         return AST_MODULE_LOAD_SUCCESS;
570 }
571
572 static int reload_module(void)
573 {
574         ast_sorcery_reload_object(ast_sip_get_sorcery(), "identify");
575
576         return 0;
577 }
578
579 static int unload_module(void)
580 {
581         ast_cli_unregister_multiple(cli_identify, ARRAY_LEN(cli_identify));
582         ast_sip_unregister_cli_formatter(cli_formatter);
583         ast_sip_unregister_endpoint_formatter(&endpoint_identify_formatter);
584         ast_sip_unregister_endpoint_identifier(&ip_identifier);
585
586         return 0;
587 }
588
589 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP IP endpoint identifier",
590         .support_level = AST_MODULE_SUPPORT_CORE,
591         .load = load_module,
592         .reload = reload_module,
593         .unload = unload_module,
594         .load_pri = AST_MODPRI_CHANNEL_DEPEND - 4,
595 );