res_resolver_unbound: Fix config documentation.
[asterisk/asterisk.git] / res / res_pjsip_authenticator_digest.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 #include "asterisk/logger.h"
25 #include "asterisk/module.h"
26 #include "asterisk/strings.h"
27
28 /*** MODULEINFO
29         <depend>pjproject</depend>
30         <depend>res_pjsip</depend>
31         <support_level>core</support_level>
32  ***/
33
34 /* From the auth/realm realtime column size */
35 #define MAX_REALM_LENGTH 40
36 static char default_realm[MAX_REALM_LENGTH + 1];
37
38 AO2_GLOBAL_OBJ_STATIC(entity_id);
39
40 /*!
41  * \brief Determine if authentication is required
42  *
43  * Authentication is required if the endpoint has at least one auth
44  * section specified
45  */
46 static int digest_requires_authentication(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata)
47 {
48         RAII_VAR(struct ast_sip_endpoint *, artificial, ast_sip_get_artificial_endpoint(), ao2_cleanup);
49
50         return endpoint == artificial || AST_VECTOR_SIZE(&endpoint->inbound_auths) > 0;
51 }
52
53 static void auth_store_cleanup(void *data)
54 {
55         struct ast_sip_auth **auth = data;
56
57         ao2_cleanup(*auth);
58         ast_free(data);
59 }
60
61 /*!
62  * \brief Thread-local storage for \ref ast_sip_auth
63  *
64  * The PJSIP authentication API is a bit annoying. When you set
65  * up an authentication server, you specify a lookup callback to
66  * call into when verifying incoming credentials. The problem
67  * with this callback is that it only gives you the realm and
68  * authentication username. In 2.0.5, there is a new version of
69  * the callback you can use that gives the pjsip_rx_data in
70  * addition.
71  *
72  * Unfortunately, the data we actually \b need is the
73  * \ref ast_sip_auth we are currently observing. So we have two
74  * choices:
75  * 1) Use the current PJSIP API and use thread-local storage
76  * to temporarily store our SIP authentication information. Then
77  * in the callback, we can retrieve the authentication info and
78  * use as needed. Given our threading model, this is safe.
79  * 2) Use the 2.0.5 API and temporarily store the authentication
80  * information in the rdata's endpoint_info. Then in the callback,
81  * we can retrieve the authentication info from the rdata.
82  *
83  * I've chosen option 1 since it does not require backporting
84  * any APIs from future versions of PJSIP, plus I feel the
85  * thread-local option is a bit cleaner.
86  */
87 AST_THREADSTORAGE_CUSTOM(auth_store, NULL, auth_store_cleanup);
88
89 /*!
90  * \brief Store authentication information in thread-local storage
91  */
92 static int store_auth(struct ast_sip_auth *auth)
93 {
94         struct ast_sip_auth **pointing;
95         pointing = ast_threadstorage_get(&auth_store, sizeof(pointing));
96         if (!pointing || *pointing) {
97                 return -1;
98         }
99
100         ao2_ref(auth, +1);
101         *pointing = auth;
102         return 0;
103 }
104
105 /*!
106  * \brief Remove authentication information from thread-local storage
107  */
108 static int remove_auth(void)
109 {
110         struct ast_sip_auth **pointing;
111         pointing = ast_threadstorage_get(&auth_store, sizeof(pointing));
112         if (!pointing) {
113                 return -1;
114         }
115
116         ao2_cleanup(*pointing);
117         *pointing = NULL;
118         return 0;
119 }
120
121 /*!
122  * \brief Retrieve authentication information from thread-local storage
123  */
124 static struct ast_sip_auth *get_auth(void)
125 {
126         struct ast_sip_auth **auth;
127         auth = ast_threadstorage_get(&auth_store, sizeof(auth));
128         if (auth && *auth) {
129                 ao2_ref(*auth, +1);
130                 return *auth;
131         }
132         return NULL;
133 }
134
135 /*!
136  * \brief Lookup callback for authentication verification
137  *
138  * This function is called when we call pjsip_auth_srv_verify(). It
139  * expects us to verify that the realm and account name from the
140  * Authorization header is correct. We are then supposed to supply
141  * a password or MD5 sum of credentials.
142  *
143  * \param pool A memory pool we can use for allocations
144  * \param realm The realm from the Authorization header
145  * \param acc_name the user from the Authorization header
146  * \param[out] info The credentials we need to fill in
147  * \retval PJ_SUCCESS Successful authentication
148  * \retval other Unsuccessful
149  */
150 static pj_status_t digest_lookup(pj_pool_t *pool, const pj_str_t *realm,
151                 const pj_str_t *acc_name, pjsip_cred_info *info)
152 {
153         RAII_VAR(struct ast_sip_auth *, auth, get_auth(), ao2_cleanup);
154         if (!auth) {
155                 return PJSIP_SC_FORBIDDEN;
156         }
157
158         if (auth->type == AST_SIP_AUTH_TYPE_ARTIFICIAL) {
159                 return PJSIP_SC_FORBIDDEN;
160         }
161
162         if (pj_strcmp2(realm, auth->realm)) {
163                 return PJSIP_SC_FORBIDDEN;
164         }
165         if (pj_strcmp2(acc_name, auth->auth_user)) {
166                 return PJSIP_SC_FORBIDDEN;
167         }
168
169         pj_strdup2(pool, &info->realm, auth->realm);
170         pj_strdup2(pool, &info->username, auth->auth_user);
171
172         switch (auth->type) {
173         case AST_SIP_AUTH_TYPE_USER_PASS:
174                 pj_strdup2(pool, &info->data, auth->auth_pass);
175                 info->data_type = PJSIP_CRED_DATA_PLAIN_PASSWD;
176                 break;
177         case AST_SIP_AUTH_TYPE_MD5:
178                 pj_strdup2(pool, &info->data, auth->md5_creds);
179                 info->data_type = PJSIP_CRED_DATA_DIGEST;
180                 break;
181         default:
182                 return PJSIP_SC_FORBIDDEN;
183         }
184         return PJ_SUCCESS;
185 }
186
187 /*!
188  * \brief Calculate a nonce
189  *
190  * We use this in order to create authentication challenges. We also use this in order
191  * to verify that an incoming request with credentials could be in response to one
192  * of our challenges.
193  *
194  * The nonce is calculated from a timestamp, the source IP address, the source port, a
195  * unique ID for us, and the realm. This helps to ensure that the incoming request
196  * is from the same source that the nonce was calculated for. Including the realm
197  * ensures that multiple challenges to the same request have different nonces.
198  *
199  * \param A UNIX timestamp expressed as a string
200  * \param rdata The incoming request
201  * \param realm The realm for which authentication should occur
202  */
203 static int build_nonce(struct ast_str **nonce, const char *timestamp, const pjsip_rx_data *rdata, const char *realm)
204 {
205         struct ast_str *str = ast_str_alloca(256);
206         RAII_VAR(char *, eid, ao2_global_obj_ref(entity_id), ao2_cleanup);
207         char hash[33];
208
209         /*
210          * Note you may be tempted to think why not include the port. The reason
211          * is that when using TCP the port can potentially differ from before.
212          */
213         ast_str_append(&str, 0, "%s", timestamp);
214         ast_str_append(&str, 0, ":%s", rdata->pkt_info.src_name);
215         ast_str_append(&str, 0, ":%s", eid);
216         ast_str_append(&str, 0, ":%s", realm);
217         ast_md5_hash(hash, ast_str_buffer(str));
218
219         ast_str_append(nonce, 0, "%s/%s", timestamp, hash);
220         return 0;
221 }
222
223 /*!
224  * \brief Ensure that a nonce on an incoming request is sane.
225  *
226  * The nonce in an incoming Authorization header needs to pass some scrutiny in order
227  * for us to consider accepting it. What we do is re-build a nonce based on request
228  * data and a realm and see if it matches the nonce they sent us.
229  * \param candidate The nonce on an incoming request
230  * \param rdata The incoming request
231  * \param auth The auth credentials we are trying to match against.
232  * \retval 0 Nonce does not pass validity checks
233  * \retval 1 Nonce passes validity check
234  */
235 static int check_nonce(const char *candidate, const pjsip_rx_data *rdata, const struct ast_sip_auth *auth)
236 {
237         char *copy = ast_strdupa(candidate);
238         char *timestamp = strsep(&copy, "/");
239         int timestamp_int;
240         time_t now = time(NULL);
241         struct ast_str *calculated = ast_str_alloca(64);
242
243         if (!copy) {
244                 /* Clearly a bad nonce! */
245                 return 0;
246         }
247
248         if (sscanf(timestamp, "%30d", &timestamp_int) != 1) {
249                 return 0;
250         }
251
252         if ((int) now - timestamp_int > auth->nonce_lifetime) {
253                 return 0;
254         }
255
256         build_nonce(&calculated, timestamp, rdata, auth->realm);
257         ast_debug(3, "Calculated nonce %s. Actual nonce is %s\n", ast_str_buffer(calculated), candidate);
258         if (strcmp(ast_str_buffer(calculated), candidate)) {
259                 return 0;
260         }
261         return 1;
262 }
263
264 static int find_challenge(const pjsip_rx_data *rdata, const struct ast_sip_auth *auth)
265 {
266         struct pjsip_authorization_hdr *auth_hdr = (pjsip_authorization_hdr *) &rdata->msg_info.msg->hdr;
267         int challenge_found = 0;
268         char nonce[64];
269
270         while ((auth_hdr = (pjsip_authorization_hdr *) pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_AUTHORIZATION, auth_hdr->next))) {
271                 ast_copy_pj_str(nonce, &auth_hdr->credential.digest.nonce, sizeof(nonce));
272                 if (check_nonce(nonce, rdata, auth) && !pj_strcmp2(&auth_hdr->credential.digest.realm, auth->realm)) {
273                         challenge_found = 1;
274                         break;
275                 }
276         }
277
278         return challenge_found;
279 }
280
281 /*!
282  * \brief Common code for initializing a pjsip_auth_srv
283  */
284 static void setup_auth_srv(pj_pool_t *pool, pjsip_auth_srv *auth_server, const char *realm)
285 {
286         pj_str_t realm_str;
287         pj_cstr(&realm_str, realm);
288
289         pjsip_auth_srv_init(pool, auth_server, &realm_str, digest_lookup, 0);
290 }
291
292 /*!
293  * \brief Result of digest verification
294  */
295 enum digest_verify_result {
296         /*! Authentication credentials incorrect */
297         AUTH_FAIL,
298         /*! Authentication credentials correct */
299         AUTH_SUCCESS,
300         /*! Authentication credentials correct but nonce mismatch */
301         AUTH_STALE,
302         /*! Authentication credentials were not provided */
303         AUTH_NOAUTH,
304 };
305
306 /*!
307  * \brief astobj2 callback for verifying incoming credentials
308  *
309  * \param auth The ast_sip_auth to check against
310  * \param rdata The incoming request
311  * \param pool A pool to use for the auth server
312  * \return CMP_MATCH on successful authentication
313  * \return 0 on failed authentication
314  */
315 static int verify(struct ast_sip_auth *auth, pjsip_rx_data *rdata, pj_pool_t *pool)
316 {
317         pj_status_t authed;
318         int response_code;
319         pjsip_auth_srv auth_server;
320         int stale = 0;
321
322         if (!find_challenge(rdata, auth)) {
323                 /* Couldn't find a challenge with a sane nonce.
324                  * Nonce mismatch may just be due to staleness.
325                  */
326                 stale = 1;
327         }
328
329         setup_auth_srv(pool, &auth_server, auth->realm);
330
331         store_auth(auth);
332
333         authed = pjsip_auth_srv_verify(&auth_server, rdata, &response_code);
334
335         remove_auth();
336
337         if (authed == PJ_SUCCESS) {
338                 if (stale) {
339                         return AUTH_STALE;
340                 } else {
341                         return AUTH_SUCCESS;
342                 }
343         }
344
345         if (authed == PJSIP_EAUTHNOAUTH) {
346                 return AUTH_NOAUTH;
347         }
348
349         return AUTH_FAIL;
350 }
351
352 /*!
353  * \brief astobj2 callback for adding digest challenges to responses
354  *
355  * \param realm An auth's realm to build a challenge from
356  * \param tdata The response to add the challenge to
357  * \param rdata The request the challenge is in response to
358  * \param is_stale Indicates whether nonce on incoming request was stale
359  */
360 static void challenge(const char *realm, pjsip_tx_data *tdata, const pjsip_rx_data *rdata, int is_stale)
361 {
362         pj_str_t qop;
363         pj_str_t pj_nonce;
364         pjsip_auth_srv auth_server;
365         struct ast_str *nonce = ast_str_alloca(256);
366         char time_buf[32];
367         time_t timestamp = time(NULL);
368         snprintf(time_buf, sizeof(time_buf), "%d", (int) timestamp);
369
370         build_nonce(&nonce, time_buf, rdata, realm);
371
372         setup_auth_srv(tdata->pool, &auth_server, realm);
373
374         pj_cstr(&pj_nonce, ast_str_buffer(nonce));
375         pj_cstr(&qop, "auth");
376         pjsip_auth_srv_challenge(&auth_server, &qop, &pj_nonce, NULL, is_stale ? PJ_TRUE : PJ_FALSE, tdata);
377 }
378
379 /*!
380  * \brief Check authentication using Digest scheme
381  *
382  * This function will check an incoming message against configured authentication
383  * options. If \b any of the incoming Authorization headers result in successful
384  * authentication, then authentication is considered successful.
385  *
386  * \see ast_sip_check_authentication
387  */
388 static enum ast_sip_check_auth_result digest_check_auth(struct ast_sip_endpoint *endpoint,
389                 pjsip_rx_data *rdata, pjsip_tx_data *tdata)
390 {
391         struct ast_sip_auth **auths;
392         enum digest_verify_result *verify_res;
393         enum ast_sip_check_auth_result res;
394         int i;
395         int failures = 0;
396         size_t auth_size;
397
398         RAII_VAR(struct ast_sip_endpoint *, artificial_endpoint,
399                  ast_sip_get_artificial_endpoint(), ao2_cleanup);
400
401         auth_size = AST_VECTOR_SIZE(&endpoint->inbound_auths);
402
403         auths = ast_alloca(auth_size * sizeof(*auths));
404         verify_res = ast_alloca(auth_size * sizeof(*verify_res));
405
406         if (!auths) {
407                 return AST_SIP_AUTHENTICATION_ERROR;
408         }
409
410         if (endpoint == artificial_endpoint) {
411                 auths[0] = ast_sip_get_artificial_auth();
412         } else if (ast_sip_retrieve_auths(&endpoint->inbound_auths, auths)) {
413                 res = AST_SIP_AUTHENTICATION_ERROR;
414                 goto cleanup;
415         }
416
417         for (i = 0; i < auth_size; ++i) {
418                 if (ast_strlen_zero(auths[i]->realm)) {
419                         ast_string_field_set(auths[i], realm, default_realm);
420                 }
421                 verify_res[i] = verify(auths[i], rdata, tdata->pool);
422                 if (verify_res[i] == AUTH_SUCCESS) {
423                         res = AST_SIP_AUTHENTICATION_SUCCESS;
424                         goto cleanup;
425                 }
426                 if (verify_res[i] == AUTH_FAIL) {
427                         failures++;
428                 }
429         }
430
431         for (i = 0; i < auth_size; ++i) {
432                 challenge(auths[i]->realm, tdata, rdata, verify_res[i] == AUTH_STALE);
433         }
434
435         if (failures == auth_size) {
436                 res = AST_SIP_AUTHENTICATION_FAILED;
437         } else {
438                 res = AST_SIP_AUTHENTICATION_CHALLENGE;
439         }
440
441 cleanup:
442         ast_sip_cleanup_auths(auths, auth_size);
443         return res;
444 }
445
446 static struct ast_sip_authenticator digest_authenticator = {
447         .requires_authentication = digest_requires_authentication,
448         .check_authentication = digest_check_auth,
449 };
450
451 static int build_entity_id(void)
452 {
453         char *eid;
454
455         eid = ao2_alloc(AST_UUID_STR_LEN, NULL);
456         if (!eid) {
457                 return -1;
458         }
459
460         ast_uuid_generate_str(eid, AST_UUID_STR_LEN);
461         ao2_global_obj_replace_unref(entity_id, eid);
462         ao2_ref(eid, -1);
463         return 0;
464 }
465
466 static void global_loaded(const char *object_type)
467 {
468         ast_sip_get_default_realm(default_realm, sizeof(default_realm));
469 }
470
471 /*! \brief Observer which is used to update our default_realm when the global setting changes */
472 static struct ast_sorcery_observer global_observer = {
473         .loaded = global_loaded,
474 };
475
476 static int reload_module(void)
477 {
478         if (build_entity_id()) {
479                 return -1;
480         }
481         return 0;
482 }
483
484 static int load_module(void)
485 {
486         CHECK_PJSIP_MODULE_LOADED();
487
488         if (build_entity_id()) {
489                 return AST_MODULE_LOAD_DECLINE;
490         }
491
492         ast_sorcery_observer_add(ast_sip_get_sorcery(), "global", &global_observer);
493         ast_sorcery_reload_object(ast_sip_get_sorcery(), "global");
494
495         if (ast_sip_register_authenticator(&digest_authenticator)) {
496                 ao2_global_obj_release(entity_id);
497                 return AST_MODULE_LOAD_DECLINE;
498         }
499         return AST_MODULE_LOAD_SUCCESS;
500 }
501
502 static int unload_module(void)
503 {
504         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "global", &global_observer);
505         ast_sip_unregister_authenticator(&digest_authenticator);
506         ao2_global_obj_release(entity_id);
507         return 0;
508 }
509
510 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP authentication resource",
511         .support_level = AST_MODULE_SUPPORT_CORE,
512         .load = load_module,
513         .unload = unload_module,
514         .reload = reload_module,
515         .load_pri = AST_MODPRI_CHANNEL_DEPEND - 5,
516 );