security_events: Fix error caused by DTD validation error
[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         .identify_endpoint = ip_identify,
154 };
155
156 /*! \brief Custom handler for match field */
157 static int ip_identify_match_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
158 {
159         struct ip_identify_match *identify = obj;
160         int num_addrs = 0, error = 0, i;
161         struct ast_sockaddr *addrs;
162
163         num_addrs = ast_sockaddr_resolve(&addrs, var->value, PARSE_PORT_FORBID, AST_AF_UNSPEC);
164         if (!num_addrs) {
165                 ast_log(LOG_ERROR, "Address '%s' provided on ip endpoint identifier '%s' did not resolve to any address\n",
166                         var->value, ast_sorcery_object_get_id(obj));
167                 return -1;
168         }
169
170         for (i = 0; i < num_addrs; ++i) {
171                 /* We deny what we actually want to match because there is an implicit permit all rule for ACLs */
172                 identify->matches = ast_append_ha("d", ast_sockaddr_stringify_addr(&addrs[i]), identify->matches, &error);
173
174                 if (!identify->matches || error) {
175                         ast_log(LOG_ERROR, "Failed to add address '%s' to ip endpoint identifier '%s'\n",
176                                 ast_sockaddr_stringify_addr(&addrs[i]), ast_sorcery_object_get_id(obj));
177                         error = -1;
178                         break;
179                 }
180         }
181
182         ast_free(addrs);
183
184         return error;
185 }
186
187 static int ip_identify_match_to_str(const void *obj, const intptr_t *args, char **buf)
188 {
189         RAII_VAR(struct ast_str *, str, ast_str_create(MAX_OBJECT_FIELD), ast_free);
190         const struct ip_identify_match *identify = obj;
191
192         ast_ha_join(identify->matches, &str);
193         *buf = ast_strdup(ast_str_buffer(str));
194         return 0;
195 }
196
197 static int sip_identify_to_ami(const struct ip_identify_match *identify,
198                                struct ast_str **buf)
199 {
200         return ast_sip_sorcery_object_to_ami(identify, buf);
201 }
202
203 static int find_identify_by_endpoint(void *obj, void *arg, int flags)
204 {
205         struct ip_identify_match *identify = obj;
206         const char *endpoint_name = arg;
207
208         return strcmp(identify->endpoint_name, endpoint_name) ? 0 : CMP_MATCH;
209 }
210
211 static int format_ami_endpoint_identify(const struct ast_sip_endpoint *endpoint,
212                                         struct ast_sip_ami *ami)
213 {
214         RAII_VAR(struct ao2_container *, identifies, NULL, ao2_cleanup);
215         RAII_VAR(struct ip_identify_match *, identify, NULL, ao2_cleanup);
216         RAII_VAR(struct ast_str *, buf, NULL, ast_free);
217
218         identifies = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "identify",
219                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
220         if (!identifies) {
221                 return -1;
222         }
223
224         identify = ao2_callback(identifies, 0, find_identify_by_endpoint,
225                 (void *) ast_sorcery_object_get_id(endpoint));
226         if (!identify) {
227                 return 1;
228         }
229
230         if (!(buf = ast_sip_create_ami_event("IdentifyDetail", ami))) {
231                 return -1;
232         }
233
234         if (sip_identify_to_ami(identify, &buf)) {
235                 return -1;
236         }
237
238         ast_str_append(&buf, 0, "EndpointName: %s\r\n",
239                 ast_sorcery_object_get_id(endpoint));
240
241         astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
242         return 0;
243 }
244
245 struct ast_sip_endpoint_formatter endpoint_identify_formatter = {
246         .format_ami = format_ami_endpoint_identify
247 };
248
249 static int populate_identify_container(void *obj, void *arg, int flags)
250 {
251         struct ast_sip_ip_identify_match *ident = obj;
252         struct ao2_container *container = arg;
253
254         ao2_link(container, ident);
255         return 0;
256 }
257
258 static int cli_iterator(const void *container, ao2_callback_fn callback, void *args)
259 {
260         const struct ast_sip_endpoint *endpoint = container;
261         struct ao2_container *identifies;
262
263         struct ast_variable fields = {
264                 .name = "endpoint",
265                 .value = ast_sorcery_object_get_id(endpoint),
266                 .next = NULL,
267         };
268
269         identifies = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "identify",
270                 AST_RETRIEVE_FLAG_MULTIPLE, &fields);
271         if (!identifies) {
272                 return -1;
273         }
274
275         ao2_callback(identifies, OBJ_NODATA, callback, args);
276
277         return 0;
278 }
279
280 static int gather_endpoint_identifies(void *obj, void *arg, int flags)
281 {
282         struct ast_sip_endpoint *endpoint = obj;
283         struct ao2_container *container = arg;
284
285         cli_iterator(endpoint, populate_identify_container, container);
286         return 0;
287 }
288
289 static struct ao2_container *cli_get_identify_container(void)
290 {
291         RAII_VAR(struct ao2_container *, parent_container, NULL, ao2_cleanup);
292         RAII_VAR(struct ao2_container *, s_parent_container, NULL, ao2_cleanup);
293         struct ao2_container *child_container;
294
295         parent_container =  ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "endpoint",
296                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
297         if (!parent_container) {
298                 return NULL;
299         }
300
301         s_parent_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
302                 ast_sorcery_object_id_compare, NULL);
303         if (!s_parent_container) {
304                 return NULL;
305         }
306
307         if (ao2_container_dup(s_parent_container, parent_container, 0)) {
308                 return NULL;
309         }
310
311         child_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
312                 ast_sorcery_object_id_compare, NULL);
313         if (!child_container) {
314                 return NULL;
315         }
316
317         ao2_callback(s_parent_container, OBJ_NODATA, gather_endpoint_identifies, child_container);
318         ao2_ref(child_container, +1);
319         return child_container;
320 }
321
322
323 static int cli_print_identify_header(void *obj, void *arg, int flags)
324 {
325         struct ast_sip_cli_context *context = arg;
326         int indent = CLI_INDENT_TO_SPACES(context->indent_level);
327         int filler = CLI_MAX_WIDTH - indent - 14;
328
329         if (!context->output_buffer) {
330                 return -1;
331         }
332
333         ast_str_append(&context->output_buffer, 0,
334                 "%*s:  <MatchList%*.*s>\n",
335                 indent, "Identify", filler, filler, CLI_HEADER_FILLER);
336
337         return 0;
338 }
339
340 static int cli_print_identify_body(void *obj, void *arg, int flags)
341 {
342         RAII_VAR(struct ast_str *, str, ast_str_create(MAX_OBJECT_FIELD), ast_free);
343         struct ip_identify_match *ident = obj;
344         struct ast_sip_cli_context *context = arg;
345
346         if (!context->output_buffer || !str) {
347                 return -1;
348         }
349
350         ast_str_append(&context->output_buffer, 0, "%*s:  ",
351                 CLI_INDENT_TO_SPACES(context->indent_level), "Identify");
352         ast_ha_join(ident->matches, &str);
353         ast_str_append(&context->output_buffer, 0, "%s\n", ast_str_buffer(str));
354
355         return 0;
356 }
357
358 static struct ast_sip_cli_formatter_entry  cli_identify_formatter = {
359         .name = "identify",
360         .print_header = cli_print_identify_header,
361         .print_body = cli_print_identify_body,
362         .get_container = cli_get_identify_container,
363         .comparator = ast_sorcery_object_id_compare,
364         .iterator = cli_iterator,
365 };
366
367 static int load_module(void)
368 {
369         ast_sorcery_apply_default(ast_sip_get_sorcery(), "identify", "config", "pjsip.conf,criteria=type=identify");
370
371         if (ast_sorcery_object_register(ast_sip_get_sorcery(), "identify", ip_identify_alloc, NULL, NULL)) {
372                 return AST_MODULE_LOAD_DECLINE;
373         }
374
375         ast_sorcery_object_field_register(ast_sip_get_sorcery(), "identify", "type", "", OPT_NOOP_T, 0, 0);
376         ast_sorcery_object_field_register(ast_sip_get_sorcery(), "identify", "endpoint", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ip_identify_match, endpoint_name));
377         ast_sorcery_object_field_register_custom(ast_sip_get_sorcery(), "identify", "match", "", ip_identify_match_handler, ip_identify_match_to_str, 0, 0);
378         ast_sorcery_reload_object(ast_sip_get_sorcery(), "identify");
379
380         ast_sip_register_endpoint_identifier(&ip_identifier);
381         ast_sip_register_endpoint_formatter(&endpoint_identify_formatter);
382         ast_sip_register_cli_formatter(&cli_identify_formatter);
383
384         return AST_MODULE_LOAD_SUCCESS;
385 }
386
387 static int reload_module(void)
388 {
389         ast_sorcery_reload_object(ast_sip_get_sorcery(), "identify");
390         return 0;
391 }
392
393 static int unload_module(void)
394 {
395         ast_sip_unregister_cli_formatter(&cli_identify_formatter);
396         ast_sip_unregister_endpoint_formatter(&endpoint_identify_formatter);
397         ast_sip_unregister_endpoint_identifier(&ip_identifier);
398         return 0;
399 }
400
401 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP IP endpoint identifier",
402                 .load = load_module,
403                 .reload = reload_module,
404                 .unload = unload_module,
405                 .load_pri = AST_MODPRI_APP_DEPEND,
406                );