res_pjsip: Ensure in-dialog responses have an endpoint associated.
[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) {
104                 return NULL;
105         }
106
107         if (rdata->msg_info.msg->type == PJSIP_REQUEST_MSG) {
108                 local_tag = &rdata->msg_info.to->tag;
109                 remote_tag = &rdata->msg_info.from->tag;
110         } else {
111                 local_tag = &rdata->msg_info.from->tag;
112                 remote_tag = &rdata->msg_info.to->tag;
113         }
114
115         /* We can only call the convenient method for
116          *  1) responses
117          *  2) non-CANCEL requests
118          *  3) CANCEL requests with a to-tag
119          */
120         if (rdata->msg_info.msg->type == PJSIP_RESPONSE_MSG ||
121                         pjsip_method_cmp(&rdata->msg_info.msg->line.req.method, &pjsip_cancel_method) ||
122                         rdata->msg_info.to->tag.slen != 0) {
123                 return pjsip_ua_find_dialog(&rdata->msg_info.cid->id, local_tag,
124                                 remote_tag, PJ_TRUE);
125         }
126
127         /* Incoming CANCEL without a to-tag can't use same method for finding the
128          * dialog. Instead, we have to find the matching INVITE transaction and
129          * then get the dialog from the transaction
130          */
131         pjsip_tsx_create_key(rdata->tp_info.pool, &tsx_key, PJSIP_ROLE_UAS,
132                         pjsip_get_invite_method(), rdata);
133
134         tsx = pjsip_tsx_layer_find_tsx(&tsx_key, PJ_TRUE);
135         if (!tsx) {
136                 ast_log(LOG_ERROR, "Could not find matching INVITE transaction for CANCEL request\n");
137                 return NULL;
138         }
139
140         dlg = pjsip_tsx_get_dlg(tsx);
141
142 #ifdef HAVE_PJ_TRANSACTION_GRP_LOCK
143         pj_grp_lock_release(tsx->grp_lock);
144 #else
145         pj_mutex_unlock(tsx->mutex);
146 #endif
147
148         if (!dlg) {
149                 return NULL;
150         }
151
152         pjsip_dlg_inc_lock(dlg);
153         return dlg;
154 }
155
156 static pj_bool_t endpoint_lookup(pjsip_rx_data *rdata);
157
158 static pjsip_module endpoint_mod = {
159         .name = {"Endpoint Identifier", 19},
160         .priority = PJSIP_MOD_PRIORITY_TSX_LAYER - 3,
161         .on_rx_request = endpoint_lookup,
162 };
163
164 static pj_bool_t distributor(pjsip_rx_data *rdata)
165 {
166         pjsip_dialog *dlg = find_dialog(rdata);
167         struct distributor_dialog_data *dist = NULL;
168         struct ast_taskprocessor *serializer = NULL;
169         pjsip_rx_data *clone;
170
171         if (dlg) {
172                 dist = pjsip_dlg_get_mod_data(dlg, distributor_mod.id);
173                 if (dist) {
174                         serializer = dist->serializer;
175                 }
176         }
177
178         if (rdata->msg_info.msg->type == PJSIP_REQUEST_MSG && (
179                 !pjsip_method_cmp(&rdata->msg_info.msg->line.req.method, &pjsip_cancel_method) || 
180                 !pjsip_method_cmp(&rdata->msg_info.msg->line.req.method, &pjsip_bye_method)) &&
181                 !serializer) {
182                 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 481, NULL, NULL, NULL);
183                 goto end;
184         }
185
186         pjsip_rx_data_clone(rdata, 0, &clone);
187
188         if (dist) {
189                 clone->endpt_info.mod_data[endpoint_mod.id] = ao2_bump(dist->endpoint);
190         }
191
192         ast_sip_push_task(serializer, distribute, clone);
193
194 end:
195         if (dlg) {
196                 pjsip_dlg_dec_lock(dlg);
197         }
198
199         return PJ_TRUE;
200 }
201
202 static struct ast_sip_auth *artificial_auth;
203
204 static int create_artificial_auth(void)
205 {
206         if (!(artificial_auth = ast_sorcery_alloc(
207                       ast_sip_get_sorcery(), SIP_SORCERY_AUTH_TYPE, "artificial"))) {
208                 ast_log(LOG_ERROR, "Unable to create artificial auth\n");
209                 return -1;
210         }
211
212         ast_string_field_set(artificial_auth, realm, "asterisk");
213         ast_string_field_set(artificial_auth, auth_user, "");
214         ast_string_field_set(artificial_auth, auth_pass, "");
215         artificial_auth->type = AST_SIP_AUTH_TYPE_ARTIFICIAL;
216         return 0;
217 }
218
219 struct ast_sip_auth *ast_sip_get_artificial_auth(void)
220 {
221         ao2_ref(artificial_auth, +1);
222         return artificial_auth;
223 }
224
225 static struct ast_sip_endpoint *artificial_endpoint;
226
227 static int create_artificial_endpoint(void)
228 {
229         if (!(artificial_endpoint = ast_sorcery_alloc(
230                       ast_sip_get_sorcery(), "endpoint", NULL))) {
231                 return -1;
232         }
233
234         AST_VECTOR_INIT(&artificial_endpoint->inbound_auths, 1);
235         /* Pushing a bogus value into the vector will ensure that
236          * the proper size of the vector is returned. This value is
237          * not actually used anywhere
238          */
239         AST_VECTOR_APPEND(&artificial_endpoint->inbound_auths, "artificial-auth");
240         return 0;
241 }
242
243 struct ast_sip_endpoint *ast_sip_get_artificial_endpoint(void)
244 {
245         ao2_ref(artificial_endpoint, +1);
246         return artificial_endpoint;
247 }
248
249 static void log_unidentified_request(pjsip_rx_data *rdata)
250 {
251         char from_buf[PJSIP_MAX_URL_SIZE];
252         char callid_buf[PJSIP_MAX_URL_SIZE];
253         pjsip_uri_print(PJSIP_URI_IN_FROMTO_HDR, rdata->msg_info.from->uri, from_buf, PJSIP_MAX_URL_SIZE);
254         ast_copy_pj_str(callid_buf, &rdata->msg_info.cid->id, PJSIP_MAX_URL_SIZE);
255         ast_log(LOG_NOTICE, "Request from '%s' failed for '%s:%d' (callid: %s) - No matching endpoint found\n",
256                 from_buf, rdata->pkt_info.src_name, rdata->pkt_info.src_port, callid_buf);
257 }
258
259 static pj_bool_t endpoint_lookup(pjsip_rx_data *rdata)
260 {
261         struct ast_sip_endpoint *endpoint;
262         int is_ack = rdata->msg_info.msg->line.req.method.id == PJSIP_ACK_METHOD;
263
264         endpoint = rdata->endpt_info.mod_data[endpoint_mod.id];
265         if (endpoint) {
266                 return PJ_FALSE;
267         }
268
269         endpoint = ast_sip_identify_endpoint(rdata);
270
271         if (!endpoint && !is_ack) {
272                 char name[AST_UUID_STR_LEN] = "";
273                 pjsip_uri *from = rdata->msg_info.from->uri;
274
275                 /* always use an artificial endpoint - per discussion no reason
276                    to have "alwaysauthreject" as an option.  It is felt using it
277                    was a bug fix and it is not needed since we are not worried about
278                    breaking old stuff and we really don't want to enable the discovery
279                    of SIP accounts */
280                 endpoint = ast_sip_get_artificial_endpoint();
281
282                 if (PJSIP_URI_SCHEME_IS_SIP(from) || PJSIP_URI_SCHEME_IS_SIPS(from)) {
283                         pjsip_sip_uri *sip_from = pjsip_uri_get_uri(from);
284                         ast_copy_pj_str(name, &sip_from->user, sizeof(name));
285                 }
286
287                 log_unidentified_request(rdata);
288                 ast_sip_report_invalid_endpoint(name, rdata);
289         }
290         rdata->endpt_info.mod_data[endpoint_mod.id] = endpoint;
291         return PJ_FALSE;
292 }
293
294 static pj_bool_t authenticate(pjsip_rx_data *rdata)
295 {
296         RAII_VAR(struct ast_sip_endpoint *, endpoint, ast_pjsip_rdata_get_endpoint(rdata), ao2_cleanup);
297         int is_ack = rdata->msg_info.msg->line.req.method.id == PJSIP_ACK_METHOD;
298
299         ast_assert(endpoint != NULL);
300
301         if (!is_ack && ast_sip_requires_authentication(endpoint, rdata)) {
302                 pjsip_tx_data *tdata;
303                 pjsip_endpt_create_response(ast_sip_get_pjsip_endpoint(), rdata, 401, NULL, &tdata);
304                 switch (ast_sip_check_authentication(endpoint, rdata, tdata)) {
305                 case AST_SIP_AUTHENTICATION_CHALLENGE:
306                         /* Send the 401 we created for them */
307                         ast_sip_report_auth_challenge_sent(endpoint, rdata, tdata);
308                         pjsip_endpt_send_response2(ast_sip_get_pjsip_endpoint(), rdata, tdata, NULL, NULL);
309                         return PJ_TRUE;
310                 case AST_SIP_AUTHENTICATION_SUCCESS:
311                         ast_sip_report_auth_success(endpoint, rdata);
312                         pjsip_tx_data_dec_ref(tdata);
313                         return PJ_FALSE;
314                 case AST_SIP_AUTHENTICATION_FAILED:
315                         ast_sip_report_auth_failed_challenge_response(endpoint, rdata);
316                         pjsip_endpt_send_response2(ast_sip_get_pjsip_endpoint(), rdata, tdata, NULL, NULL);
317                         return PJ_TRUE;
318                 case AST_SIP_AUTHENTICATION_ERROR:
319                         ast_sip_report_auth_failed_challenge_response(endpoint, rdata);
320                         pjsip_tx_data_dec_ref(tdata);
321                         pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 500, NULL, NULL, NULL);
322                         return PJ_TRUE;
323                 }
324         }
325
326         return PJ_FALSE;
327 }
328
329 static pjsip_module auth_mod = {
330         .name = {"Request Authenticator", 21},
331         .priority = PJSIP_MOD_PRIORITY_APPLICATION - 2,
332         .on_rx_request = authenticate,
333 };
334
335 static int distribute(void *data)
336 {
337         static pjsip_process_rdata_param param = {
338                 .start_mod = &distributor_mod,
339                 .idx_after_start = 1,
340         };
341         pj_bool_t handled;
342         pjsip_rx_data *rdata = data;
343         int is_request = rdata->msg_info.msg->type == PJSIP_REQUEST_MSG;
344         int is_ack = is_request ? rdata->msg_info.msg->line.req.method.id == PJSIP_ACK_METHOD : 0;
345         struct ast_sip_endpoint *endpoint;
346
347         pjsip_endpt_process_rx_data(ast_sip_get_pjsip_endpoint(), rdata, &param, &handled);
348         if (!handled && is_request && !is_ack) {
349                 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 501, NULL, NULL, NULL);
350         }
351
352         /* The endpoint_mod stores an endpoint reference in the mod_data of rdata. This
353          * is the only appropriate spot to actually decrement the reference.
354          */
355         endpoint = rdata->endpt_info.mod_data[endpoint_mod.id];
356         ao2_cleanup(endpoint);
357         pjsip_rx_data_free_cloned(rdata);
358         return 0;
359 }
360
361 struct ast_sip_endpoint *ast_pjsip_rdata_get_endpoint(pjsip_rx_data *rdata)
362 {
363         struct ast_sip_endpoint *endpoint = rdata->endpt_info.mod_data[endpoint_mod.id];
364         if (endpoint) {
365                 ao2_ref(endpoint, +1);
366         }
367         return endpoint;
368 }
369
370 int ast_sip_initialize_distributor(void)
371 {
372         if (create_artificial_endpoint() || create_artificial_auth()) {
373                 return -1;
374         }
375
376         if (ast_sip_register_service(&distributor_mod)) {
377                 return -1;
378         }
379         if (ast_sip_register_service(&endpoint_mod)) {
380                 return -1;
381         }
382         if (ast_sip_register_service(&auth_mod)) {
383                 return -1;
384         }
385
386         return 0;
387 }
388
389 void ast_sip_destroy_distributor(void)
390 {
391         ast_sip_unregister_service(&distributor_mod);
392         ast_sip_unregister_service(&endpoint_mod);
393         ast_sip_unregister_service(&auth_mod);
394
395         ao2_cleanup(artificial_auth);
396         ao2_cleanup(artificial_endpoint);
397 }