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