6c924af68e62170c39878370cc07d6a09087a650
[asterisk/asterisk.git] / res / res_sip_nat.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@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         <support_level>core</support_level>
21  ***/
22
23 #include "asterisk.h"
24
25 #include <pjsip.h>
26 #include <pjsip_ua.h>
27
28 #include "asterisk/res_sip.h"
29 #include "asterisk/module.h"
30 #include "asterisk/acl.h"
31
32 static pj_bool_t nat_on_rx_request(pjsip_rx_data *rdata)
33 {
34         RAII_VAR(struct ast_sip_endpoint *, endpoint, ast_pjsip_rdata_get_endpoint(rdata), ao2_cleanup);
35         pjsip_contact_hdr *contact;
36
37         if (!endpoint) {
38                 return PJ_FALSE;
39         }
40
41         if (endpoint->rewrite_contact && (contact = pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_CONTACT, NULL)) &&
42                 (PJSIP_URI_SCHEME_IS_SIP(contact->uri) || PJSIP_URI_SCHEME_IS_SIPS(contact->uri))) {
43                 pjsip_sip_uri *uri = pjsip_uri_get_uri(contact->uri);
44
45                 pj_cstr(&uri->host, rdata->pkt_info.src_name);
46                 uri->port = rdata->pkt_info.src_port;
47         }
48
49         if (endpoint->force_rport) {
50                 rdata->msg_info.via->rport_param = 0;
51         }
52
53         return PJ_FALSE;
54 }
55
56 /*! \brief Structure which contains information about a transport */
57 struct request_transport_details {
58         /*! \brief Type of transport */
59         enum ast_sip_transport_type type;
60         /*! \brief Potential pointer to the transport itself, if UDP */
61         pjsip_transport *transport;
62         /*! \brief Potential pointer to the transport factory itself, if TCP/TLS */
63         pjsip_tpfactory *factory;
64         /*! \brief Local address for transport */
65         pj_str_t local_address;
66         /*! \brief Local port for transport */
67         int local_port;
68 };
69
70 /*! \brief Callback function for finding the transport the request is going out on */
71 static int find_transport_in_use(void *obj, void *arg, int flags)
72 {
73         struct ast_sip_transport *transport = obj;
74         struct request_transport_details *details = arg;
75
76         /* If an explicit transport or factory matches then this is what is in use, if we are unavailable
77          * to compare based on that we make sure that the type is the same and the source IP address/port are the same
78          */
79         if ((details->transport && details->transport == transport->state->transport) ||
80                 (details->factory && details->factory == transport->state->factory) ||
81                 ((details->type == transport->type) && (transport->state->factory) &&
82                         !pj_strcmp(&transport->state->factory->addr_name.host, &details->local_address) &&
83                         transport->state->factory->addr_name.port == details->local_port)) {
84                 return CMP_MATCH | CMP_STOP;
85         }
86
87         return 0;
88 }
89
90 /*! \brief Helper function which returns the SIP URI of a Contact header */
91 static pjsip_sip_uri *nat_get_contact_sip_uri(pjsip_tx_data *tdata)
92 {
93         pjsip_contact_hdr *contact = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_CONTACT, NULL);
94
95         if (!contact || (!PJSIP_URI_SCHEME_IS_SIP(contact->uri) && !PJSIP_URI_SCHEME_IS_SIPS(contact->uri))) {
96                 return NULL;
97         }
98
99         return pjsip_uri_get_uri(contact->uri);
100 }
101
102 /*! \brief Structure which contains hook details */
103 struct nat_hook_details {
104         /*! \brief Outgoing message itself */
105         pjsip_tx_data *tdata;
106         /*! \brief Chosen transport */
107         struct ast_sip_transport *transport;
108 };
109
110 /*! \brief Callback function for invoking hooks */
111 static int nat_invoke_hook(void *obj, void *arg, int flags)
112 {
113         struct ast_sip_nat_hook *hook = obj;
114         struct nat_hook_details *details = arg;
115
116         if (hook->outgoing_external_message) {
117                 hook->outgoing_external_message(details->tdata, details->transport);
118         }
119
120         return 0;
121 }
122
123 static pj_status_t nat_on_tx_message(pjsip_tx_data *tdata)
124 {
125         RAII_VAR(struct ao2_container *, transports, NULL, ao2_cleanup);
126         RAII_VAR(struct ast_sip_transport *, transport, NULL, ao2_cleanup);
127         struct request_transport_details details = { 0, };
128         pjsip_via_hdr *via = NULL;
129         struct ast_sockaddr addr = { { 0, } };
130         pjsip_sip_uri *uri = NULL;
131         RAII_VAR(struct ao2_container *, hooks, NULL, ao2_cleanup);
132
133         /* If a transport selector is in use we know the transport or factory, so explicitly find it */
134         if (tdata->tp_sel.type == PJSIP_TPSELECTOR_TRANSPORT) {
135                 details.transport = tdata->tp_sel.u.transport;
136         } else if (tdata->tp_sel.type == PJSIP_TPSELECTOR_LISTENER) {
137                 details.factory = tdata->tp_sel.u.listener;
138         } else if (tdata->tp_info.transport->key.type == PJSIP_TRANSPORT_UDP || tdata->tp_info.transport->key.type == PJSIP_TRANSPORT_UDP6) {
139                 /* Connectionless uses the same transport for all requests */
140                 details.type = AST_SIP_TRANSPORT_UDP;
141                 details.transport = tdata->tp_info.transport;
142         } else {
143                 if (tdata->tp_info.transport->key.type == PJSIP_TRANSPORT_TCP) {
144                         details.type = AST_SIP_TRANSPORT_TCP;
145                 } else if (tdata->tp_info.transport->key.type == PJSIP_TRANSPORT_TLS) {
146                         details.type = AST_SIP_TRANSPORT_TLS;
147                 } else {
148                         /* Unknown transport type, we can't map and thus can't apply NAT changes */
149                         return PJ_SUCCESS;
150                 }
151
152                 if ((uri = nat_get_contact_sip_uri(tdata))) {
153                         details.local_address = uri->host;
154                         details.local_port = uri->port;
155                 } else if ((tdata->msg->type == PJSIP_REQUEST_MSG) &&
156                         (via = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_VIA, NULL))) {
157                         details.local_address = via->sent_by.host;
158                         details.local_port = via->sent_by.port;
159                 } else {
160                         return PJ_SUCCESS;
161                 }
162
163                 if (!details.local_port) {
164                         details.local_port = (details.type == AST_SIP_TRANSPORT_TLS) ? 5061 : 5060;
165                 }
166         }
167
168         if (!(transports = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "transport", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL)) ||
169                 !(transport = ao2_callback(transports, 0, find_transport_in_use, &details)) || !transport->localnet ||
170                 ast_sockaddr_isnull(&transport->external_address)) {
171                 return PJ_SUCCESS;
172         }
173
174         ast_sockaddr_parse(&addr, tdata->tp_info.dst_name, PARSE_PORT_FORBID);
175         ast_sockaddr_set_port(&addr, tdata->tp_info.dst_port);
176
177         /* See if where we are sending this request is local or not, and if not that we can get a Contact URI to modify */
178         if (ast_apply_ha(transport->localnet, &addr) != AST_SENSE_ALLOW) {
179                 return PJ_SUCCESS;
180         }
181
182         /* Update the contact header with the external address */
183         if (uri || (uri = nat_get_contact_sip_uri(tdata))) {
184                 pj_strdup2(tdata->pool, &uri->host, ast_sockaddr_stringify_host(&transport->external_address));
185                 if (transport->external_signaling_port) {
186                         uri->port = transport->external_signaling_port;
187                 }
188         }
189
190         /* Update the via header if relevant */
191         if ((tdata->msg->type == PJSIP_REQUEST_MSG) && (via || (via = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_VIA, NULL)))) {
192                 pj_strdup2(tdata->pool, &via->sent_by.host, ast_sockaddr_stringify_host(&transport->external_address));
193                 if (transport->external_signaling_port) {
194                         via->sent_by.port = transport->external_signaling_port;
195                 }
196         }
197
198         /* Invoke any additional hooks that may be registered */
199         if ((hooks = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "nat_hook", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL))) {
200                 struct nat_hook_details hook_details = {
201                         .tdata = tdata,
202                         .transport = transport,
203                 };
204                 ao2_callback(hooks, 0, nat_invoke_hook, &hook_details);
205         }
206
207         return PJ_SUCCESS;
208 }
209
210 static pjsip_module nat_module = {
211         .name = { "NAT", 3 },
212         .id = -1,
213         .priority = PJSIP_MOD_PRIORITY_TSX_LAYER - 2,
214         .on_rx_request = nat_on_rx_request,
215         .on_tx_request = nat_on_tx_message,
216         .on_tx_response = nat_on_tx_message,
217 };
218
219 static int load_module(void)
220 {
221         ast_sip_register_service(&nat_module);
222         return AST_MODULE_LOAD_SUCCESS;
223 }
224
225 static int unload_module(void)
226 {
227         ast_sip_unregister_service(&nat_module);
228         return 0;
229 }
230
231 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "SIP NAT Support",
232                 .load = load_module,
233                 .unload = unload_module,
234                 .load_pri = AST_MODPRI_APP_DEPEND,
235                );