res_pjsip_rfc3329.c File Reference

#include "asterisk.h"
#include <pjsip.h>
#include <pjsip_ua.h>
#include "asterisk/res_pjsip.h"
#include "asterisk/res_pjsip_session.h"
#include "asterisk/module.h"
#include "asterisk/causes.h"
#include "asterisk/threadpool.h"

Include dependency graph for res_pjsip_rfc3329.c:

Go to the source code of this file.

Data Structures
struct	rfc3329_store_data
	Private data structure used with the modules's datastore. More...

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
static void	add_outgoing_request_headers (struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata, struct ast_datastore *datastore)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static void	datastore_destroy_cb (void *data)
static int	load_module (void)
static void	rfc3329_incoming_response (struct ast_sip_session *session, struct pjsip_rx_data *rdata)
static void	rfc3329_options_request (struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata)
static void	rfc3329_outgoing_request (struct ast_sip_session *session, struct pjsip_tx_data *tdata)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "PJSIP RFC3329 Support (partial)" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_APP_DEPEND, .requires = "res_pjsip,res_pjsip_session", }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct ast_sip_supplement	rfc3329_options_supplement
static const struct ast_datastore_info	rfc3329_store_datastore
	The channel datastore the module uses to store state.
static struct ast_sip_session_supplement	rfc3329_supplement

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 189 of file res_pjsip_rfc3329.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 189 of file res_pjsip_rfc3329.c.

add_outgoing_request_headers()

static void add_outgoing_request_headers ( struct ast_sip_endpoint *  endpoint, struct ast_sip_contact *  contact, struct pjsip_tx_data *  tdata, struct ast_datastore *  datastore  )

static

Definition at line 109 of file res_pjsip_rfc3329.c.

{
    static const pj_str_t security_verify = { "Security-Verify", 15 };
    struct pjsip_generic_string_hdr *hdr = NULL;
    struct ast_sip_contact_status *contact_status = NULL;
    struct rfc3329_store_data *store_data;
    
    if (endpoint->security_negotiation != AST_SIP_SECURITY_NEG_MEDIASEC) {
        return;
    }
 
    contact_status = ast_sip_get_contact_status(contact);
    hdr = pjsip_msg_find_hdr_by_name(tdata->msg, &security_verify, NULL);
 
    if (contact_status == NULL) {
        return;
    }
 
    ao2_lock(contact_status);
    if (AST_VECTOR_SIZE(&contact_status->security_mechanisms) && hdr == NULL) {
        /* Add Security-Verify headers (with q-value) */
        ast_sip_add_security_headers(&contact_status->security_mechanisms, "Security-Verify", 0, tdata);
    }
    if (datastore) {
        store_data = datastore->data;
        if (store_data->last_rx_status_code == 401) {
            /* Add Security-Client headers (no q-value) */
            ast_sip_add_security_headers(&endpoint->security_mechanisms, "Security-Client", 0, tdata);
        }
    }
    ao2_unlock(contact_status);
 
    ao2_cleanup(contact_status);
}

References ao2_cleanup, ao2_lock, ao2_unlock, ast_sip_add_security_headers(), ast_sip_get_contact_status(), AST_SIP_SECURITY_NEG_MEDIASEC, AST_VECTOR_SIZE, ast_datastore::data, rfc3329_store_data::last_rx_status_code, NULL, ast_sip_contact_status::security_mechanisms, ast_sip_endpoint::security_mechanisms, and ast_sip_endpoint::security_negotiation.

Referenced by rfc3329_options_request(), and rfc3329_outgoing_request().

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 189 of file res_pjsip_rfc3329.c.

datastore_destroy_cb()

static void datastore_destroy_cb ( void *  data )

static

Definition at line 42 of file res_pjsip_rfc3329.c.

{
    struct rfc3329_store_data *d = data;
    if (d) {
        ast_free(d);
    }
}

References ast_free, and d.

load_module()

static int load_module ( void  )

static

Definition at line 169 of file res_pjsip_rfc3329.c.

{
    ast_sip_session_register_supplement(&rfc3329_supplement);
    ast_sip_register_supplement(&rfc3329_options_supplement);
    return AST_MODULE_LOAD_SUCCESS;
}

References AST_MODULE_LOAD_SUCCESS, ast_sip_register_supplement(), ast_sip_session_register_supplement, rfc3329_options_supplement, and rfc3329_supplement.

rfc3329_incoming_response()

static void rfc3329_incoming_response ( struct ast_sip_session *  session, struct pjsip_rx_data *  rdata  )

static

Definition at line 56 of file res_pjsip_rfc3329.c.

{
    RAII_VAR(struct ast_datastore *, datastore, ast_sip_session_get_datastore(session, "rfc3329_store"), ao2_cleanup);
    static const pj_str_t str_security_server = { "Security-Server", 15 };
    struct ast_sip_contact_status *contact_status = NULL;
    struct ast_sip_security_mechanism *mech;
    struct rfc3329_store_data *store_data;
    pjsip_generic_string_hdr *header;
    char buf[128];
    char *hdr_val;
    char *mechanism;
 
    if (!session || !session->endpoint || !session->endpoint->security_negotiation
        || !session->contact || !(contact_status = ast_sip_get_contact_status(session->contact))
        || !session->inv_session->dlg) {
        return;
    }
 
    ao2_lock(contact_status);
    if (AST_VECTOR_SIZE(&contact_status->security_mechanisms)) {
        goto out;
    }
 
    if (!datastore
        && (datastore = ast_sip_session_alloc_datastore(&rfc3329_store_datastore, "rfc3329_store"))
        && (store_data = ast_calloc(1, sizeof(struct rfc3329_store_data)))) {
 
        store_data->last_rx_status_code = rdata->msg_info.msg->line.status.code;
        datastore->data = store_data;
        ast_sip_session_add_datastore(session, datastore);
    } else {
        ast_log(AST_LOG_WARNING, "Could not store session data. Still attempting requests, but they might be missing necessary headers.\n");
    }
 
    header = pjsip_msg_find_hdr_by_name(rdata->msg_info.msg, &str_security_server, NULL);
    for (; header;
        header = pjsip_msg_find_hdr_by_name(rdata->msg_info.msg, &str_security_server, header->next)) {
        /* Parse Security-Server headers and add to contact status to use for future requests. */
        ast_copy_pj_str(buf, &header->hvalue, sizeof(buf));
        hdr_val = ast_skip_blanks(buf);
 
        while ((mechanism = ast_strsep(&hdr_val, ',', AST_STRSEP_ALL))) {
            if (!ast_sip_str_to_security_mechanism(&mech, mechanism)) {
                AST_VECTOR_APPEND(&contact_status->security_mechanisms, mech);
            }
        }
    }
 
out:
    ao2_unlock(contact_status);
    ao2_cleanup(contact_status);
}

References ao2_cleanup, ao2_lock, ao2_unlock, ast_calloc, ast_copy_pj_str(), ast_log, AST_LOG_WARNING, ast_sip_get_contact_status(), ast_sip_session_add_datastore(), ast_sip_session_alloc_datastore(), ast_sip_session_get_datastore(), ast_sip_str_to_security_mechanism(), ast_skip_blanks(), ast_strsep(), AST_STRSEP_ALL, AST_VECTOR_APPEND, AST_VECTOR_SIZE, buf, rfc3329_store_data::last_rx_status_code, header::next, NULL, out, RAII_VAR, rfc3329_store_datastore, ast_sip_contact_status::security_mechanisms, and session.

rfc3329_options_request()

static void rfc3329_options_request ( struct ast_sip_endpoint *  endpoint, struct ast_sip_contact *  contact, struct pjsip_tx_data *  tdata  )

static

Definition at line 159 of file res_pjsip_rfc3329.c.

{
    add_outgoing_request_headers(endpoint, contact, tdata, NULL);
}

References add_outgoing_request_headers(), and NULL.

rfc3329_outgoing_request()

static void rfc3329_outgoing_request ( struct ast_sip_session *  session, struct pjsip_tx_data *  tdata  )

static

Definition at line 145 of file res_pjsip_rfc3329.c.

{
    RAII_VAR(struct ast_datastore *, datastore, ast_sip_session_get_datastore(session, "rfc3329_store"), ao2_cleanup);
    if (session->contact == NULL) {
        return;
    }
    add_outgoing_request_headers(session->endpoint, session->contact, tdata, datastore);
}

References add_outgoing_request_headers(), ao2_cleanup, ast_sip_session_get_datastore(), NULL, RAII_VAR, and session.

unload_module()

static int unload_module ( void  )

static

Definition at line 176 of file res_pjsip_rfc3329.c.

{
    ast_sip_session_unregister_supplement(&rfc3329_supplement);
    ast_sip_unregister_supplement(&rfc3329_options_supplement);
    return 0;
}

References ast_sip_session_unregister_supplement(), ast_sip_unregister_supplement(), rfc3329_options_supplement, and rfc3329_supplement.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "PJSIP RFC3329 Support (partial)" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_APP_DEPEND, .requires = "res_pjsip,res_pjsip_session", }

static

Definition at line 189 of file res_pjsip_rfc3329.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 189 of file res_pjsip_rfc3329.c.

rfc3329_options_supplement

struct ast_sip_supplement rfc3329_options_supplement

static

Initial value:

= {
    .method = "OPTIONS",
    .outgoing_request = rfc3329_options_request,
}

Definition at line 164 of file res_pjsip_rfc3329.c.

                                                              {
    .method = "OPTIONS",
    .outgoing_request = rfc3329_options_request,
};

Referenced by load_module(), and unload_module().

rfc3329_store_datastore

const struct ast_datastore_info rfc3329_store_datastore

static

Initial value:

= {
    .type = "rfc3329_store",
    .destroy = datastore_destroy_cb
}

The channel datastore the module uses to store state.

Definition at line 51 of file res_pjsip_rfc3329.c.

                                                                 {
    .type = "rfc3329_store",
    .destroy = datastore_destroy_cb
};

Referenced by rfc3329_incoming_response().

rfc3329_supplement

struct ast_sip_session_supplement rfc3329_supplement

static

Initial value:

= {
    .incoming_response = rfc3329_incoming_response,
    .outgoing_request = rfc3329_outgoing_request,
}

Definition at line 154 of file res_pjsip_rfc3329.c.

                                                              {
    .incoming_response = rfc3329_incoming_response,
    .outgoing_request = rfc3329_outgoing_request,
};

Referenced by load_module(), and unload_module().