Add base XML documentation for res_sip
[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 /*** DOCUMENTATION
34         <configInfo name="res_sip_endpoint_identifier_ip" language="en_US">
35                 <synopsis>Module that identifies endpoints via source IP address</synopsis>
36                 <configFile name="res_sip.conf">
37                         <configObject name="identify">
38                                 <configOption name="endpoint">
39                                         <synopsis>Name of Endpoint</synopsis>
40                                 </configOption>
41                                 <configOption name="match">
42                                         <synopsis>IP addresses or networks to match against</synopsis>
43                                 </configOption>
44                                 <configOption name="type">
45                                         <synopsis>Must be of type 'identify'.</synopsis>
46                                 </configOption>
47                         </configObject>
48                 </configFile>
49         </configInfo>
50  ***/
51
52 /*! \brief Structure for an IP identification matching object */
53 struct ip_identify_match {
54         /*! \brief Sorcery object details */
55         SORCERY_OBJECT(details);
56         /*! \brief Stringfields */
57         AST_DECLARE_STRING_FIELDS(
58                 /*! The name of the endpoint */
59                 AST_STRING_FIELD(endpoint_name);
60         );
61         /*! \brief Networks or addresses that should match this */
62         struct ast_ha *matches;
63 };
64
65 /*! \brief Destructor function for a matching object */
66 static void ip_identify_destroy(void *obj)
67 {
68         struct ip_identify_match *identify = obj;
69
70         ast_string_field_free_memory(identify);
71         ast_free_ha(identify->matches);
72 }
73
74 /*! \brief Allocator function for a matching object */
75 static void *ip_identify_alloc(const char *name)
76 {
77         struct ip_identify_match *identify = ao2_alloc(sizeof(*identify), ip_identify_destroy);
78
79         if (!identify || ast_string_field_init(identify, 256)) {
80                 ao2_cleanup(identify);
81                 return NULL;
82         }
83
84         return identify;
85 }
86
87 /*! \brief Comparator function for a matching object */
88 static int ip_identify_match_check(void *obj, void *arg, int flags)
89 {
90         struct ip_identify_match *identify = obj;
91         struct ast_sockaddr *addr = arg;
92
93         return (ast_apply_ha(identify->matches, addr) != AST_SENSE_ALLOW) ? CMP_MATCH | CMP_STOP : 0;
94 }
95
96 static struct ast_sip_endpoint *ip_identify(pjsip_rx_data *rdata)
97 {
98         struct ast_sockaddr addr = { { 0, } };
99         RAII_VAR(struct ao2_container *, candidates, NULL, ao2_cleanup);
100         RAII_VAR(struct ip_identify_match *, match, NULL, ao2_cleanup);
101
102         /* If no possibilities exist return early to save some time */
103         if (!(candidates = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "identify", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL)) ||
104                 !ao2_container_count(candidates)) {
105                 return NULL;
106         }
107
108         ast_sockaddr_parse(&addr, rdata->pkt_info.src_name, PARSE_PORT_FORBID);
109         ast_sockaddr_set_port(&addr, rdata->pkt_info.src_port);
110
111         if (!(match = ao2_callback(candidates, 0, ip_identify_match_check, &addr))) {
112                 return NULL;
113         }
114
115         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint", match->endpoint_name);
116 }
117
118 static struct ast_sip_endpoint_identifier ip_identifier = {
119         .identify_endpoint = ip_identify,
120 };
121
122 /*! \brief Custom handler for match field */
123 static int ip_identify_match_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
124 {
125         struct ip_identify_match *identify = obj;
126         int error = 0;
127
128         /* We deny what we actually want to match because there is an implicit permit all rule for ACLs */
129         if (!(identify->matches = ast_append_ha("d", var->value, identify->matches, &error))) {
130                 return -1;
131         }
132
133         return error;
134 }
135
136 static int load_module(void)
137 {
138         ast_sorcery_apply_default(ast_sip_get_sorcery(), "identify", "config", "res_sip.conf,criteria=type=identify");
139
140         if (ast_sorcery_object_register(ast_sip_get_sorcery(), "identify", ip_identify_alloc, NULL, NULL)) {
141                 return AST_MODULE_LOAD_DECLINE;
142         }
143
144         ast_sorcery_object_field_register(ast_sip_get_sorcery(), "identify", "type", "", OPT_NOOP_T, 0, 0);
145         ast_sorcery_object_field_register(ast_sip_get_sorcery(), "identify", "endpoint", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ip_identify_match, endpoint_name));
146         ast_sorcery_object_field_register_custom(ast_sip_get_sorcery(), "identify", "match", "", ip_identify_match_handler, NULL, 0, 0);
147         ast_sorcery_reload_object(ast_sip_get_sorcery(), "identify");
148
149         ast_sip_register_endpoint_identifier(&ip_identifier);
150
151         return AST_MODULE_LOAD_SUCCESS;
152 }
153
154 static int reload_module(void)
155 {
156         ast_sorcery_reload_object(ast_sip_get_sorcery(), "identify");
157         return 0;
158 }
159
160 static int unload_module(void)
161 {
162         ast_sip_unregister_endpoint_identifier(&ip_identifier);
163         return 0;
164 }
165
166 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "SIP IP endpoint identifier",
167                 .load = load_module,
168                 .reload = reload_module,
169                 .unload = unload_module,
170                 .load_pri = AST_MODPRI_APP_DEPEND,
171                );