9fd6250e81f791ddf13fdb0b80282b80c14afc31
[asterisk/asterisk.git] / res / res_pjsip / pjsip_distributor.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 #include "asterisk.h"
20
21 #include <pjsip.h>
22
23 #include "asterisk/res_pjsip.h"
24
25 static int distribute(void *data);
26 static pj_bool_t distributor(pjsip_rx_data *rdata);
27
28 static pjsip_module distributor_mod = {
29         .name = {"Request Distributor", 19},
30         .priority = PJSIP_MOD_PRIORITY_TSX_LAYER - 6,
31         .on_rx_request = distributor,
32         .on_rx_response = distributor,
33 };
34
35 /*! Dialog-specific information the distributor uses */
36 struct distributor_dialog_data {
37         /* Serializer to distribute tasks to for this dialog */
38         struct ast_taskprocessor *serializer;
39         /* Endpoint associated with this dialog */
40         struct ast_sip_endpoint *endpoint;
41 };
42
43 /*!
44  * \internal
45  *
46  * \note Call this with the dialog locked
47  */
48 static struct distributor_dialog_data *distributor_dialog_data_alloc(pjsip_dialog *dlg)
49 {
50         struct distributor_dialog_data *dist;
51
52         dist = PJ_POOL_ZALLOC_T(dlg->pool, struct distributor_dialog_data);
53         pjsip_dlg_set_mod_data(dlg, distributor_mod.id, dist);
54
55         return dist;
56 }
57
58 void ast_sip_dialog_set_serializer(pjsip_dialog *dlg, struct ast_taskprocessor *serializer)
59 {
60         struct distributor_dialog_data *dist;
61         SCOPED_LOCK(lock, dlg, pjsip_dlg_inc_lock, pjsip_dlg_dec_lock);
62
63         dist = pjsip_dlg_get_mod_data(dlg, distributor_mod.id);
64         if (!dist) {
65                 dist = distributor_dialog_data_alloc(dlg);
66         }
67         dist->serializer = serializer;
68 }
69
70 void ast_sip_dialog_set_endpoint(pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint)
71 {
72         struct distributor_dialog_data *dist;
73         SCOPED_LOCK(lock, dlg, pjsip_dlg_inc_lock, pjsip_dlg_dec_lock);
74
75         dist = pjsip_dlg_get_mod_data(dlg, distributor_mod.id);
76         if (!dist) {
77                 dist = distributor_dialog_data_alloc(dlg);
78         }
79         dist->endpoint = endpoint;
80 }
81
82 struct ast_sip_endpoint *ast_sip_dialog_get_endpoint(pjsip_dialog *dlg)
83 {
84         struct distributor_dialog_data *dist;
85         SCOPED_LOCK(lock, dlg, pjsip_dlg_inc_lock, pjsip_dlg_dec_lock);
86
87         dist = pjsip_dlg_get_mod_data(dlg, distributor_mod.id);
88         if (!dist || !dist->endpoint) {
89                 return NULL;
90         }
91         ao2_ref(dist->endpoint, +1);
92         return dist->endpoint;
93 }
94
95 static pjsip_dialog *find_dialog(pjsip_rx_data *rdata)
96 {
97         pj_str_t tsx_key;
98         pjsip_transaction *tsx;
99         pjsip_dialog *dlg;
100         pj_str_t *local_tag;
101         pj_str_t *remote_tag;
102
103         if (rdata->msg_info.msg->type == PJSIP_REQUEST_MSG) {
104                 local_tag = &rdata->msg_info.to->tag;
105                 remote_tag = &rdata->msg_info.from->tag;
106         } else {
107                 local_tag = &rdata->msg_info.from->tag;
108                 remote_tag = &rdata->msg_info.to->tag;
109         }
110
111         /* We can only call the convenient method for
112          *  1) responses
113          *  2) non-CANCEL requests
114          *  3) CANCEL requests with a to-tag
115          */
116         if (rdata->msg_info.msg->type == PJSIP_RESPONSE_MSG ||
117                         pjsip_method_cmp(&rdata->msg_info.msg->line.req.method, &pjsip_cancel_method) ||
118                         rdata->msg_info.to->tag.slen != 0) {
119                 return pjsip_ua_find_dialog(&rdata->msg_info.cid->id, local_tag,
120                                 remote_tag, PJ_TRUE);
121         }
122
123         /* Incoming CANCEL without a to-tag can't use same method for finding the
124          * dialog. Instead, we have to find the matching INVITE transaction and
125          * then get the dialog from the transaction
126          */
127         pjsip_tsx_create_key(rdata->tp_info.pool, &tsx_key, PJSIP_ROLE_UAS,
128                         pjsip_get_invite_method(), rdata);
129
130         tsx = pjsip_tsx_layer_find_tsx(&tsx_key, PJ_TRUE);
131         if (!tsx) {
132                 ast_log(LOG_ERROR, "Could not find matching INVITE transaction for CANCEL request\n");
133                 return NULL;
134         }
135
136         dlg = pjsip_tsx_get_dlg(tsx);
137         pj_mutex_unlock(tsx->mutex);
138
139         if (!dlg) {
140                 return NULL;
141         }
142
143         pjsip_dlg_inc_lock(dlg);
144         return dlg;
145 }
146
147 static pj_bool_t distributor(pjsip_rx_data *rdata)
148 {
149         pjsip_dialog *dlg = find_dialog(rdata);
150         struct distributor_dialog_data *dist = NULL;
151         struct ast_taskprocessor *serializer = NULL;
152         pjsip_rx_data *clone;
153
154         if (dlg) {
155                 dist = pjsip_dlg_get_mod_data(dlg, distributor_mod.id);
156                 if (dist) {
157                         serializer = dist->serializer;
158                 }
159         }
160
161         if (rdata->msg_info.msg->type == PJSIP_REQUEST_MSG && (
162                 !pjsip_method_cmp(&rdata->msg_info.msg->line.req.method, &pjsip_cancel_method) || 
163                 !pjsip_method_cmp(&rdata->msg_info.msg->line.req.method, &pjsip_bye_method)) &&
164                 !serializer) {
165                 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 481, NULL, NULL, NULL);
166                 goto end;
167         }
168
169         pjsip_rx_data_clone(rdata, 0, &clone);
170
171         if (dist) {
172                 clone->endpt_info.mod_data[distributor_mod.id] = dist->endpoint;
173         }
174
175         ast_sip_push_task(serializer, distribute, clone);
176
177 end:
178         if (dlg) {
179                 pjsip_dlg_dec_lock(dlg);
180         }
181
182         return PJ_TRUE;
183 }
184
185 static pj_bool_t endpoint_lookup(pjsip_rx_data *rdata);
186
187 static pjsip_module endpoint_mod = {
188         .name = {"Endpoint Identifier", 19},
189         .priority = PJSIP_MOD_PRIORITY_TSX_LAYER - 3,
190         .on_rx_request = endpoint_lookup,
191 };
192
193 static struct ast_sip_auth *artificial_auth;
194
195 static int create_artificial_auth(void)
196 {
197         if (!(artificial_auth = ast_sorcery_alloc(
198                       ast_sip_get_sorcery(), SIP_SORCERY_AUTH_TYPE, "artificial"))) {
199                 ast_log(LOG_ERROR, "Unable to create artificial auth\n");
200                 return -1;
201         }
202
203         ast_string_field_set(artificial_auth, realm, "asterisk");
204         ast_string_field_set(artificial_auth, auth_user, "");
205         ast_string_field_set(artificial_auth, auth_pass, "");
206         artificial_auth->type = AST_SIP_AUTH_TYPE_ARTIFICIAL;
207         return 0;
208 }
209
210 struct ast_sip_auth *ast_sip_get_artificial_auth(void)
211 {
212         ao2_ref(artificial_auth, +1);
213         return artificial_auth;
214 }
215
216 static struct ast_sip_endpoint *artificial_endpoint;
217
218 static int create_artificial_endpoint(void)
219 {
220         if (!(artificial_endpoint = ast_sorcery_alloc(
221                       ast_sip_get_sorcery(), "endpoint", NULL))) {
222                 return -1;
223         }
224
225         artificial_endpoint->inbound_auths.num = 1;
226         return 0;
227 }
228
229 struct ast_sip_endpoint *ast_sip_get_artificial_endpoint(void)
230 {
231         ao2_ref(artificial_endpoint, +1);
232         return artificial_endpoint;
233 }
234
235 static void log_unidentified_request(pjsip_rx_data *rdata)
236 {
237         char from_buf[PJSIP_MAX_URL_SIZE];
238         char callid_buf[PJSIP_MAX_URL_SIZE];
239         pjsip_uri_print(PJSIP_URI_IN_FROMTO_HDR, rdata->msg_info.from->uri, from_buf, PJSIP_MAX_URL_SIZE);
240         ast_copy_pj_str(callid_buf, &rdata->msg_info.cid->id, PJSIP_MAX_URL_SIZE);
241         ast_log(LOG_NOTICE, "Request from '%s' failed for '%s:%d' (callid: %s) - No matching endpoint found\n",
242                 from_buf, rdata->pkt_info.src_name, rdata->pkt_info.src_port, callid_buf);
243 }
244
245 static pj_bool_t endpoint_lookup(pjsip_rx_data *rdata)
246 {
247         struct ast_sip_endpoint *endpoint;
248         int is_ack = rdata->msg_info.msg->line.req.method.id == PJSIP_ACK_METHOD;
249
250         endpoint = rdata->endpt_info.mod_data[distributor_mod.id];
251         if (endpoint) {
252                 /* Bumping the refcount makes refcounting consistent whether an endpoint
253                  * is looked up or not */
254                 ao2_ref(endpoint, +1);
255         } else {
256                 endpoint = ast_sip_identify_endpoint(rdata);
257         }
258
259         if (!endpoint && !is_ack) {
260                 char name[AST_UUID_STR_LEN] = "";
261                 pjsip_uri *from = rdata->msg_info.from->uri;
262
263                 /* always use an artificial endpoint - per discussion no reason
264                    to have "alwaysauthreject" as an option.  It is felt using it
265                    was a bug fix and it is not needed since we are not worried about
266                    breaking old stuff and we really don't want to enable the discovery
267                    of SIP accounts */
268                 endpoint = ast_sip_get_artificial_endpoint();
269
270                 if (PJSIP_URI_SCHEME_IS_SIP(from) || PJSIP_URI_SCHEME_IS_SIPS(from)) {
271                         pjsip_sip_uri *sip_from = pjsip_uri_get_uri(from);
272                         ast_copy_pj_str(name, &sip_from->user, sizeof(name));
273                 }
274
275                 log_unidentified_request(rdata);
276                 ast_sip_report_invalid_endpoint(name, rdata);
277         }
278         rdata->endpt_info.mod_data[endpoint_mod.id] = endpoint;
279         return PJ_FALSE;
280 }
281
282 static pj_bool_t authenticate(pjsip_rx_data *rdata)
283 {
284         RAII_VAR(struct ast_sip_endpoint *, endpoint, ast_pjsip_rdata_get_endpoint(rdata), ao2_cleanup);
285         int is_ack = rdata->msg_info.msg->line.req.method.id == PJSIP_ACK_METHOD;
286
287         ast_assert(endpoint != NULL);
288
289         if (!is_ack && ast_sip_requires_authentication(endpoint, rdata)) {
290                 pjsip_tx_data *tdata;
291                 pjsip_endpt_create_response(ast_sip_get_pjsip_endpoint(), rdata, 401, NULL, &tdata);
292                 switch (ast_sip_check_authentication(endpoint, rdata, tdata)) {
293                 case AST_SIP_AUTHENTICATION_CHALLENGE:
294                         /* Send the 401 we created for them */
295                         ast_sip_report_auth_challenge_sent(endpoint, rdata, tdata);
296                         pjsip_endpt_send_response2(ast_sip_get_pjsip_endpoint(), rdata, tdata, NULL, NULL);
297                         return PJ_TRUE;
298                 case AST_SIP_AUTHENTICATION_SUCCESS:
299                         ast_sip_report_auth_success(endpoint, rdata);
300                         pjsip_tx_data_dec_ref(tdata);
301                         return PJ_FALSE;
302                 case AST_SIP_AUTHENTICATION_FAILED:
303                         ast_sip_report_auth_failed_challenge_response(endpoint, rdata);
304                         pjsip_endpt_send_response2(ast_sip_get_pjsip_endpoint(), rdata, tdata, NULL, NULL);
305                         return PJ_TRUE;
306                 case AST_SIP_AUTHENTICATION_ERROR:
307                         ast_sip_report_auth_failed_challenge_response(endpoint, rdata);
308                         pjsip_tx_data_dec_ref(tdata);
309                         pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 500, NULL, NULL, NULL);
310                         return PJ_TRUE;
311                 }
312         }
313
314         return PJ_FALSE;
315 }
316
317 static pjsip_module auth_mod = {
318         .name = {"Request Authenticator", 21},
319         .priority = PJSIP_MOD_PRIORITY_APPLICATION - 1,
320         .on_rx_request = authenticate,
321 };
322
323 static int distribute(void *data)
324 {
325         static pjsip_process_rdata_param param = {
326                 .start_mod = &distributor_mod,
327                 .idx_after_start = 1,
328         };
329         pj_bool_t handled;
330         pjsip_rx_data *rdata = data;
331         int is_request = rdata->msg_info.msg->type == PJSIP_REQUEST_MSG;
332         int is_ack = is_request ? rdata->msg_info.msg->line.req.method.id == PJSIP_ACK_METHOD : 0;
333         struct ast_sip_endpoint *endpoint;
334
335         pjsip_endpt_process_rx_data(ast_sip_get_pjsip_endpoint(), rdata, &param, &handled);
336         if (!handled && is_request && !is_ack) {
337                 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 501, NULL, NULL, NULL);
338         }
339
340         /* The endpoint_mod stores an endpoint reference in the mod_data of rdata. This
341          * is the only appropriate spot to actually decrement the reference.
342          */
343         endpoint = rdata->endpt_info.mod_data[endpoint_mod.id];
344         ao2_cleanup(endpoint);
345         pjsip_rx_data_free_cloned(rdata);
346         return 0;
347 }
348
349 struct ast_sip_endpoint *ast_pjsip_rdata_get_endpoint(pjsip_rx_data *rdata)
350 {
351         struct ast_sip_endpoint *endpoint = rdata->endpt_info.mod_data[endpoint_mod.id];
352         if (endpoint) {
353                 ao2_ref(endpoint, +1);
354         }
355         return endpoint;
356 }
357
358 int ast_sip_initialize_distributor(void)
359 {
360         if (create_artificial_endpoint() || create_artificial_auth()) {
361                 return -1;
362         }
363
364         if (ast_sip_register_service(&distributor_mod)) {
365                 return -1;
366         }
367         if (ast_sip_register_service(&endpoint_mod)) {
368                 return -1;
369         }
370         if (ast_sip_register_service(&auth_mod)) {
371                 return -1;
372         }
373
374         return 0;
375 }
376
377 void ast_sip_destroy_distributor(void)
378 {
379         ast_sip_unregister_service(&distributor_mod);
380         ast_sip_unregister_service(&endpoint_mod);
381         ast_sip_unregister_service(&auth_mod);
382
383         ao2_cleanup(artificial_auth);
384         ao2_cleanup(artificial_endpoint);
385 }