New SIP Channel driver: Always Auth Reject
[asterisk/asterisk.git] / res / res_sip / sip_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_sip.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 pj_bool_t distributor(pjsip_rx_data *rdata)
96 {
97         pjsip_dialog *dlg = pjsip_ua_find_dialog(&rdata->msg_info.cid->id, &rdata->msg_info.to->tag, &rdata->msg_info.from->tag, PJ_TRUE);
98         struct distributor_dialog_data *dist = NULL;
99         struct ast_taskprocessor *serializer = NULL;
100         pjsip_rx_data *clone;
101
102         pjsip_rx_data_clone(rdata, 0, &clone);
103         if (dlg) {
104                 dist = pjsip_dlg_get_mod_data(dlg, distributor_mod.id);
105                 if (dist) {
106                         serializer = dist->serializer;
107                         clone->endpt_info.mod_data[distributor_mod.id] = dist->endpoint;
108                 }
109         }
110
111         ast_sip_push_task(serializer, distribute, clone);
112
113         if (dlg) {
114                 pjsip_dlg_dec_lock(dlg);
115         }
116
117         return PJ_TRUE;
118 }
119
120 static pj_bool_t endpoint_lookup(pjsip_rx_data *rdata);
121
122 static pjsip_module endpoint_mod = {
123         .name = {"Endpoint Identifier", 19},
124         .priority = PJSIP_MOD_PRIORITY_TSX_LAYER - 3,
125         .on_rx_request = endpoint_lookup,
126 };
127
128 static struct ast_sip_auth *artificial_auth;
129
130 static int create_artificial_auth(void)
131 {
132         if (!(artificial_auth = ast_sorcery_alloc(
133                       ast_sip_get_sorcery(), SIP_SORCERY_AUTH_TYPE, "artificial"))) {
134                 ast_log(LOG_ERROR, "Unable to create artificial auth\n");
135                 return -1;
136         }
137
138         ast_string_field_set(artificial_auth, realm, "asterisk");
139         ast_string_field_set(artificial_auth, auth_user, "");
140         ast_string_field_set(artificial_auth, auth_pass, "");
141         artificial_auth->type = AST_SIP_AUTH_TYPE_ARTIFICIAL;
142         return 0;
143 }
144
145 struct ast_sip_auth *ast_sip_get_artificial_auth(void)
146 {
147         ao2_ref(artificial_auth, +1);
148         return artificial_auth;
149 }
150
151 static struct ast_sip_endpoint *artificial_endpoint;
152
153 static int create_artificial_endpoint(void)
154 {
155         if (!(artificial_endpoint = ast_sorcery_alloc(
156                       ast_sip_get_sorcery(), "endpoint", NULL))) {
157                 return -1;
158         }
159
160         artificial_endpoint->num_inbound_auths = 1;
161         return 0;
162 }
163
164 struct ast_sip_endpoint *ast_sip_get_artificial_endpoint(void)
165 {
166         ao2_ref(artificial_endpoint, +1);
167         return artificial_endpoint;
168 }
169
170 static pj_bool_t endpoint_lookup(pjsip_rx_data *rdata)
171 {
172         struct ast_sip_endpoint *endpoint;
173         int is_ack = rdata->msg_info.msg->line.req.method.id == PJSIP_ACK_METHOD;
174
175         endpoint = rdata->endpt_info.mod_data[distributor_mod.id];
176         if (endpoint) {
177                 /* Bumping the refcount makes refcounting consistent whether an endpoint
178                  * is looked up or not */
179                 ao2_ref(endpoint, +1);
180         } else {
181                 endpoint = ast_sip_identify_endpoint(rdata);
182         }
183
184         if (!endpoint && !is_ack) {
185                 char name[AST_UUID_STR_LEN] = "";
186                 pjsip_uri *from = rdata->msg_info.from->uri;
187
188                 /* always use an artificial endpoint - per discussion no reason
189                    to have "alwaysauthreject" as an option.  It is felt using it
190                    was a bug fix and it is not needed since we are not worried about
191                    breaking old stuff and we really don't want to enable the discovery
192                    of SIP accounts */
193                 endpoint = ast_sip_get_artificial_endpoint();
194
195                 if (PJSIP_URI_SCHEME_IS_SIP(from) || PJSIP_URI_SCHEME_IS_SIPS(from)) {
196                         pjsip_sip_uri *sip_from = pjsip_uri_get_uri(from);
197                         ast_copy_pj_str(name, &sip_from->user, sizeof(name));
198                 }
199
200                 ast_sip_report_invalid_endpoint(name, rdata);
201         }
202         rdata->endpt_info.mod_data[endpoint_mod.id] = endpoint;
203         return PJ_FALSE;
204 }
205
206 static pj_bool_t authenticate(pjsip_rx_data *rdata)
207 {
208         RAII_VAR(struct ast_sip_endpoint *, endpoint, ast_pjsip_rdata_get_endpoint(rdata), ao2_cleanup);
209         int is_ack = rdata->msg_info.msg->line.req.method.id == PJSIP_ACK_METHOD;
210
211         ast_assert(endpoint != NULL);
212
213         if (!is_ack && ast_sip_requires_authentication(endpoint, rdata)) {
214                 pjsip_tx_data *tdata;
215                 pjsip_endpt_create_response(ast_sip_get_pjsip_endpoint(), rdata, 401, NULL, &tdata);
216                 switch (ast_sip_check_authentication(endpoint, rdata, tdata)) {
217                 case AST_SIP_AUTHENTICATION_CHALLENGE:
218                         /* Send the 401 we created for them */
219                         ast_sip_report_auth_challenge_sent(endpoint, rdata, tdata);
220                         pjsip_endpt_send_response2(ast_sip_get_pjsip_endpoint(), rdata, tdata, NULL, NULL);
221                         return PJ_TRUE;
222                 case AST_SIP_AUTHENTICATION_SUCCESS:
223                         ast_sip_report_auth_success(endpoint, rdata);
224                         pjsip_tx_data_dec_ref(tdata);
225                         return PJ_FALSE;
226                 case AST_SIP_AUTHENTICATION_FAILED:
227                         ast_sip_report_auth_failed_challenge_response(endpoint, rdata);
228                         pjsip_endpt_send_response2(ast_sip_get_pjsip_endpoint(), rdata, tdata, NULL, NULL);
229                         return PJ_TRUE;
230                 case AST_SIP_AUTHENTICATION_ERROR:
231                         ast_sip_report_auth_failed_challenge_response(endpoint, rdata);
232                         pjsip_tx_data_dec_ref(tdata);
233                         pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 500, NULL, NULL, NULL);
234                         return PJ_TRUE;
235                 }
236         }
237
238         return PJ_FALSE;
239 }
240
241 static pjsip_module auth_mod = {
242         .name = {"Request Authenticator", 21},
243         .priority = PJSIP_MOD_PRIORITY_APPLICATION - 1,
244         .on_rx_request = authenticate,
245 };
246
247 static int distribute(void *data)
248 {
249         static pjsip_process_rdata_param param = {
250                 .start_mod = &distributor_mod,
251                 .idx_after_start = 1,
252         };
253         pj_bool_t handled;
254         pjsip_rx_data *rdata = data;
255         int is_request = rdata->msg_info.msg->type == PJSIP_REQUEST_MSG;
256         int is_ack = is_request ? rdata->msg_info.msg->line.req.method.id == PJSIP_ACK_METHOD : 0;
257         struct ast_sip_endpoint *endpoint;
258
259         pjsip_endpt_process_rx_data(ast_sip_get_pjsip_endpoint(), rdata, &param, &handled);
260         if (!handled && is_request && !is_ack) {
261                 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 501, NULL, NULL, NULL);
262         }
263
264         /* The endpoint_mod stores an endpoint reference in the mod_data of rdata. This
265          * is the only appropriate spot to actually decrement the reference.
266          */
267         endpoint = rdata->endpt_info.mod_data[endpoint_mod.id];
268         ao2_cleanup(endpoint);
269         pjsip_rx_data_free_cloned(rdata);
270         return 0;
271 }
272
273 struct ast_sip_endpoint *ast_pjsip_rdata_get_endpoint(pjsip_rx_data *rdata)
274 {
275         struct ast_sip_endpoint *endpoint = rdata->endpt_info.mod_data[endpoint_mod.id];
276         if (endpoint) {
277                 ao2_ref(endpoint, +1);
278         }
279         return endpoint;
280 }
281
282 int ast_sip_initialize_distributor(void)
283 {
284         if (create_artificial_endpoint() || create_artificial_auth()) {
285                 return -1;
286         }
287
288         if (ast_sip_register_service(&distributor_mod)) {
289                 return -1;
290         }
291         if (ast_sip_register_service(&endpoint_mod)) {
292                 return -1;
293         }
294         if (ast_sip_register_service(&auth_mod)) {
295                 return -1;
296         }
297
298         return 0;
299 }
300
301 void ast_sip_destroy_distributor(void)
302 {
303         ast_sip_unregister_service(&distributor_mod);
304         ast_sip_unregister_service(&endpoint_mod);
305         ast_sip_unregister_service(&auth_mod);
306
307         ao2_cleanup(artificial_auth);
308         ao2_cleanup(artificial_endpoint);
309 }