Add missing module dependencies to various res_sip* modules
[asterisk/asterisk.git] / res / res_sip_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_sip</depend>
22         <support_level>core</support_level>
23  ***/
24
25 #include "asterisk.h"
26
27 #include <pjsip.h>
28
29 #include "asterisk/res_sip.h"
30 #include "asterisk/module.h"
31 #include "asterisk/acl.h"
32
33 /*! \brief Structure for an IP identification matching object */
34 struct ip_identify_match {
35         /*! \brief Sorcery object details */
36         SORCERY_OBJECT(details);
37         /*! \brief Stringfields */
38         AST_DECLARE_STRING_FIELDS(
39                 /*! The name of the endpoint */
40                 AST_STRING_FIELD(endpoint_name);
41         );
42         /*! \brief Networks or addresses that should match this */
43         struct ast_ha *matches;
44 };
45
46 /*! \brief Destructor function for a matching object */
47 static void ip_identify_destroy(void *obj)
48 {
49         struct ip_identify_match *identify = obj;
50
51         ast_string_field_free_memory(identify);
52         ast_free_ha(identify->matches);
53 }
54
55 /*! \brief Allocator function for a matching object */
56 static void *ip_identify_alloc(const char *name)
57 {
58         struct ip_identify_match *identify = ao2_alloc(sizeof(*identify), ip_identify_destroy);
59
60         if (!identify || ast_string_field_init(identify, 256)) {
61                 ao2_cleanup(identify);
62                 return NULL;
63         }
64
65         return identify;
66 }
67
68 /*! \brief Comparator function for a matching object */
69 static int ip_identify_match_check(void *obj, void *arg, int flags)
70 {
71         struct ip_identify_match *identify = obj;
72         struct ast_sockaddr *addr = arg;
73
74         return (ast_apply_ha(identify->matches, addr) != AST_SENSE_ALLOW) ? CMP_MATCH | CMP_STOP : 0;
75 }
76
77 static struct ast_sip_endpoint *ip_identify(pjsip_rx_data *rdata)
78 {
79         struct ast_sockaddr addr = { { 0, } };
80         RAII_VAR(struct ao2_container *, candidates, NULL, ao2_cleanup);
81         RAII_VAR(struct ip_identify_match *, match, NULL, ao2_cleanup);
82
83         /* If no possibilities exist return early to save some time */
84         if (!(candidates = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "identify", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL)) ||
85                 !ao2_container_count(candidates)) {
86                 return NULL;
87         }
88
89         ast_sockaddr_parse(&addr, rdata->pkt_info.src_name, PARSE_PORT_FORBID);
90         ast_sockaddr_set_port(&addr, rdata->pkt_info.src_port);
91
92         if (!(match = ao2_callback(candidates, 0, ip_identify_match_check, &addr))) {
93                 return NULL;
94         }
95
96         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint", match->endpoint_name);
97 }
98
99 static struct ast_sip_endpoint_identifier ip_identifier = {
100         .identify_endpoint = ip_identify,
101 };
102
103 /*! \brief Custom handler for match field */
104 static int ip_identify_match_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
105 {
106         struct ip_identify_match *identify = obj;
107         int error = 0;
108
109         /* We deny what we actually want to match because there is an implicit permit all rule for ACLs */
110         if (!(identify->matches = ast_append_ha("d", var->value, identify->matches, &error))) {
111                 return -1;
112         }
113
114         return error;
115 }
116
117 static int load_module(void)
118 {
119         ast_sorcery_apply_default(ast_sip_get_sorcery(), "identify", "config", "res_sip.conf,criteria=type=identify");
120
121         if (ast_sorcery_object_register(ast_sip_get_sorcery(), "identify", ip_identify_alloc, NULL, NULL)) {
122                 return AST_MODULE_LOAD_DECLINE;
123         }
124
125         ast_sorcery_object_field_register(ast_sip_get_sorcery(), "identify", "type", "", OPT_NOOP_T, 0, 0);
126         ast_sorcery_object_field_register(ast_sip_get_sorcery(), "identify", "endpoint", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ip_identify_match, endpoint_name));
127         ast_sorcery_object_field_register_custom(ast_sip_get_sorcery(), "identify", "match", "", ip_identify_match_handler, NULL, 0, 0);
128         ast_sorcery_reload_object(ast_sip_get_sorcery(), "identify");
129
130         ast_sip_register_endpoint_identifier(&ip_identifier);
131
132         return AST_MODULE_LOAD_SUCCESS;
133 }
134
135 static int reload_module(void)
136 {
137         ast_sorcery_reload_object(ast_sip_get_sorcery(), "identify");
138         return 0;
139 }
140
141 static int unload_module(void)
142 {
143         ast_sip_unregister_endpoint_identifier(&ip_identifier);
144         return 0;
145 }
146
147 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "SIP IP endpoint identifier",
148                 .load = load_module,
149                 .reload = reload_module,
150                 .unload = unload_module,
151                 .load_pri = AST_MODPRI_APP_DEPEND,
152                );