a8240e5dda583cf0560894a9e63a9491c4cccaf2
[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/module.h"
31 #include "asterisk/acl.h"
32
33 /*** DOCUMENTATION
34         <configInfo name="res_pjsip_endpoint_identifier_ip" language="en_US">
35                 <synopsis>Module that identifies endpoints via source IP address</synopsis>
36                 <configFile name="pjsip.conf">
37                         <configObject name="identify">
38                                 <synopsis>Identifies endpoints via source IP address</synopsis>
39                                 <configOption name="endpoint">
40                                         <synopsis>Name of Endpoint</synopsis>
41                                 </configOption>
42                                 <configOption name="match">
43                                         <synopsis>IP addresses or networks to match against</synopsis>
44                                         <description><para>
45                                                 The value is a comma-delimited list of IP addresses. IP addresses may
46                                                 have a subnet mask appended. The subnet mask may be written in either
47                                                 CIDR or dot-decimal notation. Separate the IP address and subnet
48                                                 mask with a slash ('/')
49                                         </para></description>
50                                 </configOption>
51                                 <configOption name="type">
52                                         <synopsis>Must be of type 'identify'.</synopsis>
53                                 </configOption>
54                         </configObject>
55                 </configFile>
56         </configInfo>
57  ***/
58
59 /*! \brief Structure for an IP identification matching object */
60 struct ip_identify_match {
61         /*! \brief Sorcery object details */
62         SORCERY_OBJECT(details);
63         /*! \brief Stringfields */
64         AST_DECLARE_STRING_FIELDS(
65                 /*! The name of the endpoint */
66                 AST_STRING_FIELD(endpoint_name);
67         );
68         /*! \brief Networks or addresses that should match this */
69         struct ast_ha *matches;
70 };
71
72 /*! \brief Destructor function for a matching object */
73 static void ip_identify_destroy(void *obj)
74 {
75         struct ip_identify_match *identify = obj;
76
77         ast_string_field_free_memory(identify);
78         ast_free_ha(identify->matches);
79 }
80
81 /*! \brief Allocator function for a matching object */
82 static void *ip_identify_alloc(const char *name)
83 {
84         struct ip_identify_match *identify = ast_sorcery_generic_alloc(sizeof(*identify), ip_identify_destroy);
85
86         if (!identify || ast_string_field_init(identify, 256)) {
87                 ao2_cleanup(identify);
88                 return NULL;
89         }
90
91         return identify;
92 }
93
94 /*! \brief Comparator function for a matching object */
95 static int ip_identify_match_check(void *obj, void *arg, int flags)
96 {
97         struct ip_identify_match *identify = obj;
98         struct ast_sockaddr *addr = arg;
99         int sense;
100
101         sense = ast_apply_ha(identify->matches, addr);
102         if (sense != AST_SENSE_ALLOW) {
103                 ast_debug(3, "Source address %s matches identify '%s'\n",
104                                 ast_sockaddr_stringify(addr),
105                                 ast_sorcery_object_get_id(identify));
106                 return CMP_MATCH | CMP_STOP;
107         } else {
108                 ast_debug(3, "Source address %s does not match identify '%s'\n",
109                                 ast_sockaddr_stringify(addr),
110                                 ast_sorcery_object_get_id(identify));
111                 return 0;
112         }
113 }
114
115 static struct ast_sip_endpoint *ip_identify(pjsip_rx_data *rdata)
116 {
117         struct ast_sockaddr addr = { { 0, } };
118         RAII_VAR(struct ao2_container *, candidates, NULL, ao2_cleanup);
119         RAII_VAR(struct ip_identify_match *, match, NULL, ao2_cleanup);
120         struct ast_sip_endpoint *endpoint;
121
122         /* If no possibilities exist return early to save some time */
123         if (!(candidates = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "identify", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL)) ||
124                 !ao2_container_count(candidates)) {
125                 ast_debug(3, "No identify sections to match against\n");
126                 return NULL;
127         }
128
129         ast_sockaddr_parse(&addr, rdata->pkt_info.src_name, PARSE_PORT_FORBID);
130         ast_sockaddr_set_port(&addr, rdata->pkt_info.src_port);
131
132         if (!(match = ao2_callback(candidates, 0, ip_identify_match_check, &addr))) {
133                 ast_debug(3, "'%s' did not match any identify section rules\n",
134                                 ast_sockaddr_stringify(&addr));
135                 return NULL;
136         }
137
138         endpoint = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint", match->endpoint_name);
139         if (endpoint) {
140                 ast_debug(3, "Retrieved endpoint %s\n", ast_sorcery_object_get_id(endpoint));
141         } else {
142                 ast_log(LOG_WARNING, "Identify section '%s' points to endpoint '%s' but endpoint could not be looked up\n",
143                                 ast_sorcery_object_get_id(match), match->endpoint_name);
144         }
145
146         return endpoint;
147 }
148
149 static struct ast_sip_endpoint_identifier ip_identifier = {
150         .identify_endpoint = ip_identify,
151 };
152
153 /*! \brief Custom handler for match field */
154 static int ip_identify_match_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
155 {
156         struct ip_identify_match *identify = obj;
157         int error = 0;
158
159         /* We deny what we actually want to match because there is an implicit permit all rule for ACLs */
160         if (!(identify->matches = ast_append_ha("d", var->value, identify->matches, &error))) {
161                 return -1;
162         }
163
164         return error;
165 }
166
167 static int load_module(void)
168 {
169         ast_sorcery_apply_default(ast_sip_get_sorcery(), "identify", "config", "pjsip.conf,criteria=type=identify");
170
171         if (ast_sorcery_object_register(ast_sip_get_sorcery(), "identify", ip_identify_alloc, NULL, NULL)) {
172                 return AST_MODULE_LOAD_DECLINE;
173         }
174
175         ast_sorcery_object_field_register(ast_sip_get_sorcery(), "identify", "type", "", OPT_NOOP_T, 0, 0);
176         ast_sorcery_object_field_register(ast_sip_get_sorcery(), "identify", "endpoint", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ip_identify_match, endpoint_name));
177         ast_sorcery_object_field_register_custom(ast_sip_get_sorcery(), "identify", "match", "", ip_identify_match_handler, NULL, 0, 0);
178         ast_sorcery_reload_object(ast_sip_get_sorcery(), "identify");
179
180         ast_sip_register_endpoint_identifier(&ip_identifier);
181
182         return AST_MODULE_LOAD_SUCCESS;
183 }
184
185 static int reload_module(void)
186 {
187         ast_sorcery_reload_object(ast_sip_get_sorcery(), "identify");
188         return 0;
189 }
190
191 static int unload_module(void)
192 {
193         ast_sip_unregister_endpoint_identifier(&ip_identifier);
194         return 0;
195 }
196
197 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP IP endpoint identifier",
198                 .load = load_module,
199                 .reload = reload_module,
200                 .unload = unload_module,
201                 .load_pri = AST_MODPRI_APP_DEPEND,
202                );