2013-04-25 18:25:31 +00:00
|
|
|
/*
|
|
|
|
* Asterisk -- An open source telephony toolkit.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2013, Digium, Inc.
|
|
|
|
*
|
|
|
|
* Mark Michelson <mmichelson@digium.com>
|
|
|
|
*
|
|
|
|
* See http://www.asterisk.org for more information about
|
|
|
|
* the Asterisk project. Please do not directly contact
|
|
|
|
* any of the maintainers of this project for assistance;
|
|
|
|
* the project provides a web site, mailing lists and IRC
|
|
|
|
* channels for your use.
|
|
|
|
*
|
|
|
|
* This program is free software, distributed under the terms of
|
|
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
|
|
* at the top of the source tree.
|
|
|
|
*/
|
|
|
|
|
2013-04-26 21:52:06 +00:00
|
|
|
/*** MODULEINFO
|
|
|
|
<depend>pjproject</depend>
|
2013-07-30 18:14:50 +00:00
|
|
|
<depend>res_pjsip</depend>
|
2013-04-26 21:52:06 +00:00
|
|
|
<support_level>core</support_level>
|
|
|
|
***/
|
|
|
|
|
2013-04-25 18:25:31 +00:00
|
|
|
#include "asterisk.h"
|
|
|
|
|
|
|
|
#include <pjsip.h>
|
|
|
|
|
2013-07-30 18:14:50 +00:00
|
|
|
#include "asterisk/res_pjsip.h"
|
2013-04-25 18:25:31 +00:00
|
|
|
#include "asterisk/logger.h"
|
|
|
|
#include "asterisk/module.h"
|
|
|
|
#include "asterisk/strings.h"
|
|
|
|
|
2013-09-13 14:44:43 +00:00
|
|
|
static pjsip_www_authenticate_hdr *get_auth_header(pjsip_rx_data *challenge) {
|
|
|
|
pjsip_hdr_e search_type;
|
|
|
|
|
|
|
|
if (challenge->msg_info.msg->line.status.code == PJSIP_SC_UNAUTHORIZED) {
|
|
|
|
search_type = PJSIP_H_WWW_AUTHENTICATE;
|
|
|
|
} else if (challenge->msg_info.msg->line.status.code == PJSIP_SC_PROXY_AUTHENTICATION_REQUIRED) {
|
|
|
|
search_type = PJSIP_H_PROXY_AUTHENTICATE;
|
|
|
|
} else {
|
|
|
|
ast_log(LOG_ERROR,
|
|
|
|
"Status code %d was received when it should have been 401 or 407.\n",
|
|
|
|
challenge->msg_info.msg->line.status.code);
|
|
|
|
return NULL ;
|
|
|
|
}
|
|
|
|
|
|
|
|
return pjsip_msg_find_hdr(challenge->msg_info.msg, search_type, NULL);
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
static int set_outbound_authentication_credentials(pjsip_auth_clt_sess *auth_sess,
|
2013-12-09 16:10:05 +00:00
|
|
|
const struct ast_sip_auth_vector *auth_vector, pjsip_rx_data *challenge)
|
2013-04-25 18:25:31 +00:00
|
|
|
{
|
2013-12-09 16:10:05 +00:00
|
|
|
size_t auth_size = AST_VECTOR_SIZE(auth_vector);
|
|
|
|
struct ast_sip_auth **auths = ast_alloca(auth_size * sizeof(*auths));
|
|
|
|
pjsip_cred_info *auth_creds = ast_alloca(auth_size * sizeof(*auth_creds));
|
2013-09-13 14:44:43 +00:00
|
|
|
pjsip_www_authenticate_hdr *auth_hdr = NULL;
|
2013-04-25 18:25:31 +00:00
|
|
|
int res = 0;
|
|
|
|
int i;
|
|
|
|
|
2013-12-09 16:10:05 +00:00
|
|
|
if (ast_sip_retrieve_auths(auth_vector, auths)) {
|
2013-04-25 18:25:31 +00:00
|
|
|
res = -1;
|
|
|
|
goto cleanup;
|
|
|
|
}
|
|
|
|
|
2013-09-13 14:44:43 +00:00
|
|
|
auth_hdr = get_auth_header(challenge);
|
|
|
|
if (auth_hdr == NULL) {
|
|
|
|
res = -1;
|
|
|
|
ast_log(LOG_ERROR, "Unable to find authenticate header in challenge.\n");
|
|
|
|
goto cleanup;
|
|
|
|
}
|
|
|
|
|
2013-12-09 16:10:05 +00:00
|
|
|
for (i = 0; i < auth_size; ++i) {
|
2013-09-13 14:44:43 +00:00
|
|
|
if (ast_strlen_zero(auths[i]->realm)) {
|
2013-10-12 16:53:06 +00:00
|
|
|
auth_creds[i].realm = auth_hdr->challenge.common.realm;
|
2013-09-13 14:44:43 +00:00
|
|
|
} else {
|
|
|
|
pj_cstr(&auth_creds[i].realm, auths[i]->realm);
|
|
|
|
}
|
2013-04-25 18:25:31 +00:00
|
|
|
pj_cstr(&auth_creds[i].username, auths[i]->auth_user);
|
|
|
|
pj_cstr(&auth_creds[i].scheme, "digest");
|
|
|
|
switch (auths[i]->type) {
|
|
|
|
case AST_SIP_AUTH_TYPE_USER_PASS:
|
|
|
|
pj_cstr(&auth_creds[i].data, auths[i]->auth_pass);
|
|
|
|
auth_creds[i].data_type = PJSIP_CRED_DATA_PLAIN_PASSWD;
|
|
|
|
break;
|
|
|
|
case AST_SIP_AUTH_TYPE_MD5:
|
|
|
|
pj_cstr(&auth_creds[i].data, auths[i]->md5_creds);
|
|
|
|
auth_creds[i].data_type = PJSIP_CRED_DATA_DIGEST;
|
|
|
|
break;
|
2013-07-02 17:06:06 +00:00
|
|
|
case AST_SIP_AUTH_TYPE_ARTIFICIAL:
|
|
|
|
ast_log(LOG_ERROR, "Trying to set artificial outbound auth credentials shouldn't happen.\n");
|
|
|
|
break;
|
2013-04-25 18:25:31 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-12-09 16:10:05 +00:00
|
|
|
pjsip_auth_clt_set_credentials(auth_sess, auth_size, auth_creds);
|
2013-04-25 18:25:31 +00:00
|
|
|
|
|
|
|
cleanup:
|
2013-12-09 16:10:05 +00:00
|
|
|
ast_sip_cleanup_auths(auths, auth_size);
|
2013-04-25 18:25:31 +00:00
|
|
|
return res;
|
|
|
|
}
|
|
|
|
|
2013-12-09 16:10:05 +00:00
|
|
|
static int digest_create_request_with_auth(const struct ast_sip_auth_vector *auths, pjsip_rx_data *challenge,
|
2015-04-27 21:13:22 +00:00
|
|
|
pjsip_tx_data *old_request, pjsip_tx_data **new_request)
|
2013-04-25 18:25:31 +00:00
|
|
|
{
|
|
|
|
pjsip_auth_clt_sess auth_sess;
|
2015-04-24 14:17:25 +00:00
|
|
|
pjsip_cseq_hdr *cseq;
|
2016-11-14 20:36:52 +00:00
|
|
|
pj_status_t status;
|
2013-04-25 18:25:31 +00:00
|
|
|
|
|
|
|
if (pjsip_auth_clt_init(&auth_sess, ast_sip_get_pjsip_endpoint(),
|
2015-04-27 21:13:22 +00:00
|
|
|
old_request->pool, 0) != PJ_SUCCESS) {
|
2013-04-25 18:25:31 +00:00
|
|
|
ast_log(LOG_WARNING, "Failed to initialize client authentication session\n");
|
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
2013-09-13 14:44:43 +00:00
|
|
|
if (set_outbound_authentication_credentials(&auth_sess, auths, challenge)) {
|
2013-04-25 18:25:31 +00:00
|
|
|
ast_log(LOG_WARNING, "Failed to set authentication credentials\n");
|
2016-11-14 20:36:52 +00:00
|
|
|
#if defined(HAVE_PJSIP_AUTH_CLT_DEINIT)
|
|
|
|
/* In case it is not a noop here in the future. */
|
|
|
|
pjsip_auth_clt_deinit(&auth_sess);
|
|
|
|
#endif
|
2013-04-25 18:25:31 +00:00
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
2016-11-14 20:36:52 +00:00
|
|
|
status = pjsip_auth_clt_reinit_req(&auth_sess, challenge, old_request, new_request);
|
|
|
|
#if defined(HAVE_PJSIP_AUTH_CLT_DEINIT)
|
|
|
|
/* Release any cached auths */
|
|
|
|
pjsip_auth_clt_deinit(&auth_sess);
|
|
|
|
#endif
|
|
|
|
switch (status) {
|
2013-09-04 22:49:25 +00:00
|
|
|
case PJ_SUCCESS:
|
2015-04-24 14:17:25 +00:00
|
|
|
/* PJSIP creates a new transaction for new_request (meaning it creates a new
|
|
|
|
* branch). However, it recycles the Call-ID, from-tag, and CSeq from the
|
|
|
|
* original request. Some SIP implementations will not process the new request
|
|
|
|
* since the CSeq is the same as the original request. Incrementing it here
|
|
|
|
* fixes the interop issue
|
|
|
|
*/
|
|
|
|
cseq = pjsip_msg_find_hdr((*new_request)->msg, PJSIP_H_CSEQ, NULL);
|
|
|
|
ast_assert(cseq != NULL);
|
|
|
|
++cseq->cseq;
|
2013-09-04 22:49:25 +00:00
|
|
|
return 0;
|
|
|
|
case PJSIP_ENOCREDENTIAL:
|
2017-01-01 09:47:50 +00:00
|
|
|
ast_log(LOG_WARNING,
|
|
|
|
"Unable to create request with auth. No auth credentials for any realms in challenge.\n");
|
2013-09-04 22:49:25 +00:00
|
|
|
break;
|
|
|
|
case PJSIP_EAUTHSTALECOUNT:
|
2017-01-01 09:47:50 +00:00
|
|
|
ast_log(LOG_WARNING,
|
|
|
|
"Unable to create request with auth. Number of stale retries exceeded.\n");
|
2013-09-04 22:49:25 +00:00
|
|
|
break;
|
|
|
|
case PJSIP_EFAILEDCREDENTIAL:
|
2017-01-01 09:47:50 +00:00
|
|
|
ast_log(LOG_WARNING, "Authentication credentials not accepted by server.\n");
|
2013-09-04 22:49:25 +00:00
|
|
|
break;
|
|
|
|
default:
|
2017-01-01 09:47:50 +00:00
|
|
|
ast_log(LOG_WARNING, "Unable to create request with auth. Unknown failure.\n");
|
2013-09-04 22:49:25 +00:00
|
|
|
break;
|
2013-04-25 18:25:31 +00:00
|
|
|
}
|
|
|
|
|
2013-09-04 22:49:25 +00:00
|
|
|
return -1;
|
2013-04-25 18:25:31 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static struct ast_sip_outbound_authenticator digest_authenticator = {
|
|
|
|
.create_request_with_auth = digest_create_request_with_auth,
|
|
|
|
};
|
|
|
|
|
|
|
|
static int load_module(void)
|
|
|
|
{
|
2014-10-16 16:32:25 +00:00
|
|
|
CHECK_PJSIP_MODULE_LOADED();
|
|
|
|
|
2013-04-25 18:25:31 +00:00
|
|
|
if (ast_sip_register_outbound_authenticator(&digest_authenticator)) {
|
|
|
|
return AST_MODULE_LOAD_DECLINE;
|
|
|
|
}
|
|
|
|
return AST_MODULE_LOAD_SUCCESS;
|
|
|
|
}
|
|
|
|
|
|
|
|
static int unload_module(void)
|
|
|
|
{
|
|
|
|
ast_sip_unregister_outbound_authenticator(&digest_authenticator);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2013-07-30 18:14:50 +00:00
|
|
|
AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP authentication resource",
|
2015-05-06 00:49:04 +00:00
|
|
|
.support_level = AST_MODULE_SUPPORT_CORE,
|
|
|
|
.load = load_module,
|
|
|
|
.unload = unload_module,
|
|
|
|
.load_pri = AST_MODPRI_CHANNEL_DEPEND,
|
2013-04-25 18:25:31 +00:00
|
|
|
);
|