res_pjsip_logger.c File Reference

#include "asterisk.h"
#include <netinet/in.h>
#include <pjsip.h>
#include "asterisk/res_pjsip.h"
#include "asterisk/vector.h"
#include "asterisk/module.h"
#include "asterisk/logger.h"
#include "asterisk/cli.h"
#include "asterisk/netsock2.h"
#include "asterisk/acl.h"

Include dependency graph for res_pjsip_logger.c:

Go to the source code of this file.

Data Structures
struct	method_logging_info
struct	pcap_ethernet_header
	PCAP Ethernet Header. More...
struct	pcap_header
	PCAP Header. More...
struct	pcap_ipv4_header
	PCAP IPv4 Header. More...
struct	pcap_ipv6_header
	PCAP IPv6 Header. More...
struct	pcap_record_header
	PCAP Packet Record Header. More...
struct	pcap_udp_header
	PCAP UDP Header. More...
struct	pjsip_logger_session
	PJSIP Logging Session. More...

Enumerations
enum	pjsip_logger_mask {   AST_PJSIP_LOGGER_UNSET = 0 , AST_PJSIP_LOGGER_NONE = (1 << 0) , AST_PJSIP_LOGGER_HOST = (1 << 1) , AST_PJSIP_LOGGER_METHOD = (1 << 2) ,   AST_PJSIP_LOGGER_VERBOSE = (1 << 3) , AST_PJSIP_LOGGER_PCAP = (1 << 4) , AST_PJSIP_LOGGER_ALL = (1 << 5) }

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
static int	apply_method_filter (const struct pjsip_logger_session *session, const pjsip_method *method)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static void	check_debug (void)
static void	global_reloaded (const char *object_type)
static int	load_module (void)
static pj_bool_t	logging_on_rx_msg (pjsip_rx_data *rdata)
static pj_status_t	logging_on_tx_msg (pjsip_tx_data *tdata)
static struct method_logging_info *	method_logging_info_alloc (const char *method)
static int	method_logging_info_cmp (const struct method_logging_info *element, const struct method_logging_info *candidate)
static int	method_logging_info_sort_cmp (const void *a, const void *b)
static char *	pjsip_disable_logger (int fd)
static char *	pjsip_enable_logger_all (int fd)
static char *	pjsip_enable_logger_host (int fd, const char *arg, unsigned int add_host)
static char *	pjsip_enable_logger_method (int fd, const char *arg, int add_method)
	Add the current or an additional method to match for filtering. More...
static int	pjsip_log_test_filter (const struct pjsip_logger_session *session, const char *address, int port, const pjsip_method *method)
	See if we pass debug filter. More...
static struct pjsip_logger_session *	pjsip_logger_session_alloc (void)
	Allocator for logger session. More...
static void	pjsip_logger_session_destroy (void *obj)
	Destructor for logger session. More...
static void	pjsip_logger_write_to_pcap (struct pjsip_logger_session *session, const char *msg, size_t msg_len, pj_sockaddr *source, pj_sockaddr *destination)
static char *	pjsip_set_logger (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	pjsip_set_logger_pcap (int fd, const char *arg)
static char *	pjsip_set_logger_verbose (int fd, const char *arg)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "PJSIP Packet Logger" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .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", }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct ast_cli_entry	cli_pjsip []
static struct pjsip_logger_session *	default_logger
	The default logger session. More...
static const struct ast_sorcery_observer	global_observer
static enum pjsip_logger_mask	logger_cli_settings = AST_PJSIP_LOGGER_UNSET
static enum pjsip_logger_mask	logger_config_settings = AST_PJSIP_LOGGER_UNSET
static pjsip_module	logging_module

Enumeration Type Documentation

pjsip_logger_mask

enum pjsip_logger_mask

Enumerator
AST_PJSIP_LOGGER_UNSET
AST_PJSIP_LOGGER_NONE
AST_PJSIP_LOGGER_HOST
AST_PJSIP_LOGGER_METHOD
AST_PJSIP_LOGGER_VERBOSE
AST_PJSIP_LOGGER_PCAP
AST_PJSIP_LOGGER_ALL

Definition at line 601 of file res_pjsip_logger.c.

                       {
    AST_PJSIP_LOGGER_UNSET = 0,
    AST_PJSIP_LOGGER_NONE = (1 << 0),
    AST_PJSIP_LOGGER_HOST = (1 << 1),
    AST_PJSIP_LOGGER_METHOD = (1 << 2),
    AST_PJSIP_LOGGER_VERBOSE = (1 << 3),
    AST_PJSIP_LOGGER_PCAP = (1 << 4),
    AST_PJSIP_LOGGER_ALL = (1 << 5),
};

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 781 of file res_pjsip_logger.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 781 of file res_pjsip_logger.c.

apply_method_filter()

static int apply_method_filter ( const struct pjsip_logger_session *  session, const pjsip_method *  method  )

static

Note

Must be called with the pjsip_logger_session lock held

Definition at line 166 of file res_pjsip_logger.c.

{
    size_t size = AST_VECTOR_SIZE(&session->log_methods);
    size_t i;
 
    if (size == 0) {
        /* Nothing in the vector means everything matches */
        return 0;
    }
 
    for (i = 0; i < size; ++i) {
        struct method_logging_info *candidate = AST_VECTOR_GET(&session->log_methods, i);
        if (pjsip_method_cmp(&candidate->method, method) == 0) {
            return 0;
        }
    }
 
    /* Nothing matched */
    return 1;
}

References AST_VECTOR_GET, AST_VECTOR_SIZE, method, method_logging_info::method, and session.

Referenced by pjsip_log_test_filter().

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 781 of file res_pjsip_logger.c.

check_debug()

static void check_debug ( void  )

static

Definition at line 684 of file res_pjsip_logger.c.

{
    RAII_VAR(char *, debug, ast_sip_get_debug(), ast_free);
 
    /* Got directive to disable debug */
    if (ast_false(debug)) {
        /* If the logger was enabled via the CLI instead of through the config file,
         * then we shouldn't disable it on a reload.
         * Only disable logging if logging isn't enabled via the CLI. */
        if (logger_cli_settings == AST_PJSIP_LOGGER_NONE || logger_cli_settings == AST_PJSIP_LOGGER_UNSET) {
            /* Logger not enabled via CLI currently so good to go ahead and disable. */
            pjsip_disable_logger(-1);
        } else {
            ast_debug(3, "Leaving logger enabled since logging settings overridden using CLI\n");
        }
        logger_config_settings = AST_PJSIP_LOGGER_NONE;
        return;
    }
 
    /* Got directive to enable debug */
    if (ast_true(debug)) {
        if (logger_cli_settings != AST_PJSIP_LOGGER_UNSET) {
            /* Logging was modified using the CLI command,
             * and this overrides the default from the config. */
            ast_debug(3, "Leaving logger alone since logging has been overridden using CLI\n");
            return;
        }
        /* If logger already enabled via config, then nothing has changed. */
        if (!(logger_config_settings & AST_PJSIP_LOGGER_ALL)) {
            /* Logging was not previously enabled via config,
             * but has been enabled via CLI. */
            logger_config_settings |= AST_PJSIP_LOGGER_ALL;
            pjsip_enable_logger_all(-1);
        }
        return;
    }
 
    /* Enabling debug, only for specific host */
    logger_config_settings = AST_PJSIP_LOGGER_HOST;
    if (pjsip_enable_logger_host(-1, debug, 0) != CLI_SUCCESS) {
        ast_log(LOG_WARNING, "Could not resolve host %s for debug "
            "logging\n", debug);
    }
}

References ast_debug, ast_false(), ast_free, ast_log, AST_PJSIP_LOGGER_ALL, AST_PJSIP_LOGGER_HOST, AST_PJSIP_LOGGER_NONE, AST_PJSIP_LOGGER_UNSET, ast_sip_get_debug(), ast_true(), CLI_SUCCESS, debug, LOG_WARNING, logger_cli_settings, logger_config_settings, pjsip_disable_logger(), pjsip_enable_logger_all(), pjsip_enable_logger_host(), and RAII_VAR.

Referenced by global_reloaded(), and load_module().

global_reloaded()

static void global_reloaded ( const char *  object_type )

static

Definition at line 729 of file res_pjsip_logger.c.

{
    check_debug();
}

References check_debug().

load_module()

static int load_module ( void  )

static

Definition at line 738 of file res_pjsip_logger.c.

{
    if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "global", &global_observer)) {
        ast_log(LOG_WARNING, "Unable to add global observer\n");
        return AST_MODULE_LOAD_DECLINE;
    }
 
    default_logger = pjsip_logger_session_alloc();
    if (!default_logger) {
        ast_sorcery_observer_remove(
            ast_sip_get_sorcery(), "global", &global_observer);
        ast_log(LOG_WARNING, "Unable to create default logger\n");
        return AST_MODULE_LOAD_DECLINE;
    }
 
    check_debug();
 
    ast_sip_register_service(&logging_module);
    ast_cli_register_multiple(cli_pjsip, ARRAY_LEN(cli_pjsip));
 
    return AST_MODULE_LOAD_SUCCESS;
}

References ARRAY_LEN, ast_cli_register_multiple, ast_log, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, ast_sip_get_sorcery(), ast_sip_register_service(), ast_sorcery_observer_add(), ast_sorcery_observer_remove(), check_debug(), cli_pjsip, default_logger, global_observer, LOG_WARNING, logging_module, and pjsip_logger_session_alloc().

logging_on_rx_msg()

static pj_bool_t logging_on_rx_msg ( pjsip_rx_data *  rdata )

static

Definition at line 338 of file res_pjsip_logger.c.

{
    char buffer[AST_SOCKADDR_BUFLEN];
 
    if (!rdata->msg_info.msg) {
        return PJ_FALSE;
    }
 
    ao2_rdlock(default_logger);
    if (!pjsip_log_test_filter(default_logger, rdata->pkt_info.src_name, rdata->pkt_info.src_port, &rdata->msg_info.msg->line.req.method)) {
        ao2_unlock(default_logger);
        return PJ_FALSE;
    }
    ao2_unlock(default_logger);
 
    if (default_logger->log_to_verbose) {
        ast_verbose("<--- Received SIP %s (%d bytes) from %s:%s --->\n%s\n",
            rdata->msg_info.msg->type == PJSIP_REQUEST_MSG ? "request" : "response",
            rdata->msg_info.len,
            rdata->tp_info.transport->type_name,
            pj_sockaddr_print(&rdata->pkt_info.src_addr, buffer, sizeof(buffer), 3),
            rdata->pkt_info.packet);
    }
 
    if (default_logger->log_to_pcap) {
        pjsip_logger_write_to_pcap(default_logger, rdata->pkt_info.packet, rdata->msg_info.len,
            &rdata->pkt_info.src_addr, NULL);
    }
 
    return PJ_FALSE;
}

References ao2_rdlock, ao2_unlock, AST_SOCKADDR_BUFLEN, ast_verbose(), default_logger, pjsip_logger_session::log_to_pcap, pjsip_logger_session::log_to_verbose, NULL, pjsip_log_test_filter(), and pjsip_logger_write_to_pcap().

logging_on_tx_msg()

static pj_status_t logging_on_tx_msg ( pjsip_tx_data *  tdata )

static

Definition at line 310 of file res_pjsip_logger.c.

{
    char buffer[AST_SOCKADDR_BUFLEN];
 
    ao2_rdlock(default_logger);
    if (!pjsip_log_test_filter(default_logger, tdata->tp_info.dst_name, tdata->tp_info.dst_port, &tdata->msg->line.req.method)) {
        ao2_unlock(default_logger);
        return PJ_SUCCESS;
    }
    ao2_unlock(default_logger);
 
    if (default_logger->log_to_verbose) {
        ast_verbose("<--- Transmitting SIP %s (%d bytes) to %s:%s --->\n%.*s\n",
            tdata->msg->type == PJSIP_REQUEST_MSG ? "request" : "response",
            (int) (tdata->buf.cur - tdata->buf.start),
            tdata->tp_info.transport->type_name,
            pj_sockaddr_print(&tdata->tp_info.dst_addr, buffer, sizeof(buffer), 3),
            (int) (tdata->buf.end - tdata->buf.start), tdata->buf.start);
    }
 
    if (default_logger->log_to_pcap) {
        pjsip_logger_write_to_pcap(default_logger, tdata->buf.start, (int) (tdata->buf.cur - tdata->buf.start),
            NULL, &tdata->tp_info.dst_addr);
    }
 
    return PJ_SUCCESS;
}

References ao2_rdlock, ao2_unlock, AST_SOCKADDR_BUFLEN, ast_verbose(), default_logger, pjsip_logger_session::log_to_pcap, pjsip_logger_session::log_to_verbose, NULL, pjsip_log_test_filter(), and pjsip_logger_write_to_pcap().

method_logging_info_alloc()

static struct method_logging_info * method_logging_info_alloc ( const char *  method )

static

Definition at line 438 of file res_pjsip_logger.c.

{
    size_t method_bytes = strlen(method);
    struct method_logging_info *info;
 
    info = ast_calloc(1, sizeof(struct method_logging_info) + method_bytes + 1);
    if (!info) {
        return NULL;
    }
 
    memcpy(info->name, method, method_bytes + 1);
    pj_strset(&info->pj_name, info->name, method_bytes);
    pjsip_method_init_np(&info->method, &info->pj_name);
 
    return info;
}

References ast_calloc, sip_to_pjsip::info(), method, and NULL.

Referenced by pjsip_enable_logger_method().

method_logging_info_cmp()

static int method_logging_info_cmp ( const struct method_logging_info *  element, const struct method_logging_info *  candidate  )

static

Definition at line 455 of file res_pjsip_logger.c.

{
    return pjsip_method_cmp(&element->method, &candidate->method) == 0
        ? CMP_MATCH | CMP_STOP
        : 0;
}

References CMP_MATCH, CMP_STOP, and method_logging_info::method.

Referenced by pjsip_enable_logger_method().

method_logging_info_sort_cmp()

static int method_logging_info_sort_cmp ( const void *  a, const void *  b  )

static

Definition at line 463 of file res_pjsip_logger.c.

{
    const struct method_logging_info *const *m_a = a;
    const struct method_logging_info *const *m_b = b;
    return strcasecmp((*m_a)->name, (*m_b)->name);
}

References a, and b.

Referenced by pjsip_enable_logger_method().

pjsip_disable_logger()

static char * pjsip_disable_logger ( int  fd )

static

Definition at line 525 of file res_pjsip_logger.c.

{
    ao2_wrlock(default_logger);
 
    /* Default the settings back to the way they were */
    default_logger->enabled = 0;
    default_logger->log_all_traffic = 0;
    default_logger->pcap_filename[0] = '\0';
    default_logger->log_to_verbose = 1;
    default_logger->log_to_pcap = 0;
 
    AST_VECTOR_RESET(&default_logger->log_methods, ast_free);
 
    /* Stop logging to the PCAP file if active */
    if (default_logger->pcap_file) {
        fclose(default_logger->pcap_file);
        default_logger->pcap_file = NULL;
    }
 
    ast_free_ha(default_logger->matches);
    default_logger->matches = NULL;
 
    ao2_unlock(default_logger);
 
    if (fd >= 0) {
        ast_cli(fd, "PJSIP Logging disabled\n");
    }
 
    return CLI_SUCCESS;
}

References ao2_unlock, ao2_wrlock, ast_cli(), ast_free, ast_free_ha(), AST_VECTOR_RESET, CLI_SUCCESS, default_logger, pjsip_logger_session::enabled, pjsip_logger_session::log_all_traffic, pjsip_logger_session::log_methods, pjsip_logger_session::log_to_pcap, pjsip_logger_session::log_to_verbose, pjsip_logger_session::matches, NULL, pjsip_logger_session::pcap_file, and pjsip_logger_session::pcap_filename.

Referenced by check_debug(), and pjsip_set_logger().

pjsip_enable_logger_all()

static char * pjsip_enable_logger_all ( int  fd )

static

Definition at line 379 of file res_pjsip_logger.c.

{
    ao2_wrlock(default_logger);
    default_logger->enabled = 1;
    default_logger->log_all_traffic = 1;
    ao2_unlock(default_logger);
 
    if (fd >= 0) {
        ast_cli(fd, "PJSIP Logging enabled\n");
    }
 
    return CLI_SUCCESS;
}

References ao2_unlock, ao2_wrlock, ast_cli(), CLI_SUCCESS, default_logger, pjsip_logger_session::enabled, and pjsip_logger_session::log_all_traffic.

Referenced by check_debug(), and pjsip_set_logger().

pjsip_enable_logger_host()

static char * pjsip_enable_logger_host ( int  fd, const char *  arg, unsigned int  add_host  )

static

Definition at line 393 of file res_pjsip_logger.c.

{
    const char *host = arg;
    char *mask;
    struct ast_sockaddr address;
    int error = 0;
 
    ao2_wrlock(default_logger);
    default_logger->enabled = 1;
 
    if (!add_host) {
        /* If this is not adding an additional host or subnet then we have to
         * remove what already exists.
         */
        ast_free_ha(default_logger->matches);
        default_logger->matches = NULL;
    }
 
    mask = strrchr(host, '/');
    if (!mask && !ast_sockaddr_parse(&address, arg, 0)) {
        if (ast_sockaddr_resolve_first_af(&address, arg, 0, AST_AF_UNSPEC)) {
            ao2_unlock(default_logger);
            return CLI_SHOWUSAGE;
        }
        host = ast_sockaddr_stringify(&address);
    }
 
    default_logger->matches = ast_append_ha_with_port("d", host, default_logger->matches, &error);
    if (!default_logger->matches || error) {
        if (fd >= 0) {
            ast_cli(fd, "Failed to add address '%s' for logging\n", host);
        }
        ao2_unlock(default_logger);
        return CLI_SUCCESS;
    }
 
    ao2_unlock(default_logger);
 
    if (fd >= 0) {
        ast_cli(fd, "PJSIP Logging Enabled for host: %s\n", ast_sockaddr_stringify_addr(&address));
    }
 
    return CLI_SUCCESS;
}

References ao2_unlock, ao2_wrlock, AST_AF_UNSPEC, ast_append_ha_with_port(), ast_cli(), ast_free_ha(), ast_sockaddr_parse(), ast_sockaddr_resolve_first_af(), ast_sockaddr_stringify(), ast_sockaddr_stringify_addr(), CLI_SHOWUSAGE, CLI_SUCCESS, default_logger, pjsip_logger_session::enabled, error(), pjsip_logger_session::matches, and NULL.

Referenced by check_debug(), and pjsip_set_logger().

pjsip_enable_logger_method()

static char * pjsip_enable_logger_method ( int  fd, const char *  arg, int  add_method  )

static

Add the current or an additional method to match for filtering.

Definition at line 471 of file res_pjsip_logger.c.

{
    struct ast_str *str;
    struct method_logging_info *method;
 
    method = method_logging_info_alloc(arg);
    if (!method) {
        return CLI_FAILURE;
    }
 
    ao2_wrlock(default_logger);
    default_logger->enabled = 1;
 
    if (!add_method) {
        /* Remove what already exists */
        AST_VECTOR_RESET(&default_logger->log_methods, ast_free);
    }
 
    /* Already in the list? */
    if (AST_VECTOR_CALLBACK(&default_logger->log_methods, method_logging_info_cmp, NULL, method) != NULL) {
        ast_cli(fd, "Method '%s' is already enabled\n", method->name);
        ao2_unlock(default_logger);
        ast_free(method);
        return CLI_SUCCESS;
    }
 
    if (AST_VECTOR_APPEND(&default_logger->log_methods, method)) {
        ast_log(LOG_ERROR, "Cannot register logger method '%s'. Unable to append.\n", method->name);
        ao2_unlock(default_logger);
        ast_free(method);
        return CLI_SUCCESS;
    }
 
    AST_VECTOR_SORT(&default_logger->log_methods, method_logging_info_sort_cmp);
 
    str = ast_str_create(256);
    if (str) {
        size_t i;
        for (i = 0; i < AST_VECTOR_SIZE(&default_logger->log_methods); i++) {
            method = AST_VECTOR_GET(&default_logger->log_methods, i);
            ast_str_append(&str, 0, "%s%.*s",
                ast_str_strlen(str) ? ", " : "",
                (int) method->pj_name.slen, method->pj_name.ptr);
        }
 
        ast_cli(fd, "PJSIP Logging Enabled for SIP Methods: %s\n", ast_str_buffer(str));
        ast_free(str);
    }
 
    ao2_unlock(default_logger);
 
    return CLI_SUCCESS;
}

References ao2_unlock, ao2_wrlock, ast_cli(), ast_free, ast_log, ast_str_append(), ast_str_buffer(), ast_str_create, ast_str_strlen(), AST_VECTOR_APPEND, AST_VECTOR_CALLBACK, AST_VECTOR_GET, AST_VECTOR_RESET, AST_VECTOR_SIZE, AST_VECTOR_SORT, CLI_FAILURE, CLI_SUCCESS, default_logger, pjsip_logger_session::enabled, LOG_ERROR, pjsip_logger_session::log_methods, method, method_logging_info_alloc(), method_logging_info_cmp(), method_logging_info_sort_cmp(), NULL, and str.

Referenced by pjsip_set_logger().

pjsip_log_test_filter()

static int pjsip_log_test_filter ( const struct pjsip_logger_session *  session, const char *  address, int  port, const pjsip_method *  method  )

inlinestatic

See if we pass debug filter.

Definition at line 188 of file res_pjsip_logger.c.

{
    struct ast_sockaddr test_addr;
 
    if (!session->enabled) {
        return 0;
    }
 
    if (session->log_all_traffic) {
        return 1;
    }
 
    if (apply_method_filter(session, method)) {
        /* The method filter didn't match anything, so reject. */
        return 0;
    }
 
    /* A null address was passed in or no explicit matches. Just reject it. */
    if (ast_strlen_zero(address) || !session->matches) {
        /* If we matched on method and host is empty, accept, otherwise reject. */
        return AST_VECTOR_SIZE(&session->log_methods) > 0;
    }
 
    ast_sockaddr_parse(&test_addr, address, PARSE_PORT_IGNORE);
    ast_sockaddr_set_port(&test_addr, port);
 
    /* Compare the address against the matches */
    if (ast_apply_ha(session->matches, &test_addr) != AST_SENSE_ALLOW) {
        return 1;
    } else {
        return 0;
    }
}

References apply_method_filter(), ast_apply_ha(), AST_SENSE_ALLOW, ast_sockaddr_parse(), ast_sockaddr_set_port, ast_strlen_zero(), AST_VECTOR_SIZE, method, PARSE_PORT_IGNORE, and session.

Referenced by logging_on_rx_msg(), and logging_on_tx_msg().

pjsip_logger_session_alloc()

static struct pjsip_logger_session * pjsip_logger_session_alloc ( void  )

static

Allocator for logger session.

Definition at line 148 of file res_pjsip_logger.c.

{
    struct pjsip_logger_session *session;
 
    session = ao2_alloc_options(sizeof(struct pjsip_logger_session), pjsip_logger_session_destroy,
        AO2_ALLOC_OPT_LOCK_RWLOCK);
    if (!session) {
        return NULL;
    }
 
    session->log_to_verbose = 1;
 
    AST_VECTOR_INIT(&session->log_methods, 0);
 
    return session;
}

References AO2_ALLOC_OPT_LOCK_RWLOCK, ao2_alloc_options, AST_VECTOR_INIT, NULL, pjsip_logger_session_destroy(), and session.

Referenced by load_module().

pjsip_logger_session_destroy()

static void pjsip_logger_session_destroy ( void *  obj )

static

Destructor for logger session.

Definition at line 133 of file res_pjsip_logger.c.

{
    struct pjsip_logger_session *session = obj;
 
    if (session->pcap_file) {
        fclose(session->pcap_file);
    }
 
    ast_free_ha(session->matches);
 
    AST_VECTOR_RESET(&session->log_methods, ast_free);
    AST_VECTOR_FREE(&session->log_methods);
}

References ast_free, ast_free_ha(), AST_VECTOR_FREE, AST_VECTOR_RESET, and session.

Referenced by pjsip_logger_session_alloc().

pjsip_logger_write_to_pcap()

static void pjsip_logger_write_to_pcap ( struct pjsip_logger_session *  session, const char *  msg, size_t  msg_len, pj_sockaddr *  source, pj_sockaddr *  destination  )

static

Definition at line 222 of file res_pjsip_logger.c.

{
    struct timeval now = ast_tvnow();
    struct pcap_record_header pcap_record_header = {
        .ts_sec = now.tv_sec,
        .ts_usec = now.tv_usec,
    };
    struct pcap_ethernet_header pcap_ethernet_header = {
        .type = 0,
    };
    struct pcap_ipv4_header pcap_ipv4_header = {
        .ver_ihl = 0x45, /* IPv4 + 20 bytes of header */
        .ip_ttl = 128, /* We always put a TTL of 128 to keep Wireshark less blue */
    };
    struct pcap_ipv6_header pcap_ipv6_header = {
        .ip6_ctlun.ip6_un2_vfc = 0x60,
    };
    void *pcap_ip_header;
    size_t pcap_ip_header_len;
    struct pcap_udp_header pcap_udp_header;
 
    /* Packets are always stored as UDP to simplify this logic */
    if (source) {
        pcap_udp_header.src = ntohs(pj_sockaddr_get_port(source));
    } else {
        pcap_udp_header.src = ntohs(0);
    }
    if (destination) {
        pcap_udp_header.dst = ntohs(pj_sockaddr_get_port(destination));
    } else {
        pcap_udp_header.dst = ntohs(0);
    }
    pcap_udp_header.length = ntohs(sizeof(struct pcap_udp_header) + msg_len);
 
    /* Construct the appropriate IP header */
    if ((source && source->addr.sa_family == pj_AF_INET()) ||
        (destination && destination->addr.sa_family == pj_AF_INET())) {
        pcap_ethernet_header.type = htons(0x0800); /* We are providing an IPv4 packet */
        pcap_ip_header = &pcap_ipv4_header;
        pcap_ip_header_len = sizeof(struct pcap_ipv4_header);
        if (source) {
            memcpy(&pcap_ipv4_header.ip_src, pj_sockaddr_get_addr(source), pj_sockaddr_get_addr_len(source));
        }
        if (destination) {
            memcpy(&pcap_ipv4_header.ip_dst, pj_sockaddr_get_addr(destination), pj_sockaddr_get_addr_len(destination));
        }
        pcap_ipv4_header.ip_len = htons(sizeof(struct pcap_udp_header) + sizeof(struct pcap_ipv4_header) + msg_len);
        pcap_ipv4_header.ip_protocol = IPPROTO_UDP; /* We always provide UDP */
    } else {
        pcap_ethernet_header.type = htons(0x86DD); /* We are providing an IPv6 packet */
        pcap_ip_header = &pcap_ipv6_header;
        pcap_ip_header_len = sizeof(struct pcap_ipv6_header);
        if (source) {
            memcpy(&pcap_ipv6_header.ip6_src, pj_sockaddr_get_addr(source), pj_sockaddr_get_addr_len(source));
        }
        if (destination) {
            memcpy(&pcap_ipv6_header.ip6_dst, pj_sockaddr_get_addr(destination), pj_sockaddr_get_addr_len(destination));
        }
        pcap_ipv6_header.ip6_ctlun.ip6_un1.ip6_un1_plen = htons(sizeof(struct pcap_udp_header) + msg_len);
        pcap_ipv6_header.ip6_ctlun.ip6_un1.ip6_un1_nxt = IPPROTO_UDP;
    }
 
    /* Add up all the sizes for this record */
    pcap_record_header.incl_len = pcap_record_header.orig_len = sizeof(pcap_ethernet_header) + pcap_ip_header_len + sizeof(pcap_udp_header) + msg_len;
 
    /* We lock the logger session since we're writing these out in parts */
    ao2_wrlock(session);
    if (session->pcap_file) {
        if (fwrite(&pcap_record_header, sizeof(struct pcap_record_header), 1, session->pcap_file) != 1) {
            ast_log(LOG_WARNING, "Writing PCAP header failed: %s\n", strerror(errno));
        }
        if (fwrite(&pcap_ethernet_header, sizeof(struct pcap_ethernet_header), 1, session->pcap_file) != 1) {
            ast_log(LOG_WARNING, "Writing ethernet header to pcap failed: %s\n", strerror(errno));
        }
        if (fwrite(pcap_ip_header, pcap_ip_header_len, 1, session->pcap_file) != 1) {
            ast_log(LOG_WARNING, "Writing IP header to pcap failed: %s\n", strerror(errno));
        }
        if (fwrite(&pcap_udp_header, sizeof(struct pcap_udp_header), 1, session->pcap_file) != 1) {
            ast_log(LOG_WARNING, "Writing UDP header to pcap failed: %s\n", strerror(errno));
        }
        if (fwrite(msg, msg_len, 1, session->pcap_file) != 1) {
            ast_log(LOG_WARNING, "Writing UDP payload to pcap failed: %s\n", strerror(errno));
        }
    }
    ao2_unlock(session);
}

References ao2_unlock, ao2_wrlock, ast_log, ast_tvnow(), pcap_udp_header::dst, errno, pcap_record_header::incl_len, pcap_ipv6_header::ip6_ctlun, pcap_ipv6_header::ip6_dst, pcap_ipv6_header::ip6_src, pcap_ipv6_header::ip6_un1, pcap_ipv6_header::ip6_un2_vfc, pcap_ipv4_header::ip_dst, pcap_ipv4_header::ip_len, pcap_ipv4_header::ip_protocol, pcap_ipv4_header::ip_src, pcap_udp_header::length, LOG_WARNING, pcap_record_header::orig_len, session, pcap_udp_header::src, pcap_record_header::ts_sec, pcap_ethernet_header::type, and pcap_ipv4_header::ver_ihl.

Referenced by logging_on_rx_msg(), and logging_on_tx_msg().

pjsip_set_logger()

static char * pjsip_set_logger ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Definition at line 614 of file res_pjsip_logger.c.

{
    static const char * const method_choices[] = {
        "INVITE", "CANCEL", "ACK",
        "BYE", "REGISTER", "OPTIONS",
        "SUBSCRIBE", "NOTIFY", "PUBLISH",
        "INFO", "MESSAGE",
        NULL
    };
 
    const char *what;
 
    if (cmd == CLI_INIT) {
        e->command = "pjsip set logger {on|off|host|add|method|methodadd|verbose|pcap}";
        e->usage =
            "Usage: pjsip set logger {on|off|host <name/subnet>|add <name/subnet>|method <method>|methodadd <method>|verbose <on/off>|pcap <filename>}\n"
            "       Enables or disabling logging of SIP packets\n"
            "       read on ports bound to PJSIP transports either\n"
            "       globally or enables logging for an individual\n"
            "       host or particular SIP method(s).\n"
            "       Messages can be filtered by SIP request methods\n"
            "       INVITE, CANCEL, ACK, BYE, REGISTER, OPTIONS,\n"
            "       SUBSCRIBE, NOTIFY, PUBLISH, INFO, and MESSAGE\n";
        return NULL;
    } else if (cmd == CLI_GENERATE) {
        if (a->argc && !strncasecmp(a->argv[e->args - 1], "method", 6)) {
            return ast_cli_complete(a->word, method_choices, a->n);
        }
        return NULL;
    }
 
    what = a->argv[e->args - 1];     /* Guaranteed to exist */
 
    if (a->argc == e->args) {        /* on/off */
        if (!strcasecmp(what, "on")) {
            logger_cli_settings |= AST_PJSIP_LOGGER_ALL;
            return pjsip_enable_logger_all(a->fd);
        } else if (!strcasecmp(what, "off")) {
            logger_cli_settings = AST_PJSIP_LOGGER_NONE;
            return pjsip_disable_logger(a->fd);
        }
    } else if (a->argc == e->args + 1) {
        if (!strcasecmp(what, "host")) {
            logger_cli_settings |= AST_PJSIP_LOGGER_HOST;
            return pjsip_enable_logger_host(a->fd, a->argv[e->args], 0);
        } else if (!strcasecmp(what, "add")) {
            logger_cli_settings |= AST_PJSIP_LOGGER_HOST;
            return pjsip_enable_logger_host(a->fd, a->argv[e->args], 1);
        } else if (!strcasecmp(what, "method")) {
            logger_cli_settings |= AST_PJSIP_LOGGER_METHOD;
            return pjsip_enable_logger_method(a->fd, a->argv[e->args], 0);
        } else if (!strcasecmp(what, "methodadd")) {
            logger_cli_settings |= AST_PJSIP_LOGGER_METHOD;
            return pjsip_enable_logger_method(a->fd, a->argv[e->args], 1);
        } else if (!strcasecmp(what, "verbose")) {
            logger_cli_settings |= AST_PJSIP_LOGGER_VERBOSE;
            return pjsip_set_logger_verbose(a->fd, a->argv[e->args]);
        } else if (!strcasecmp(what, "pcap")) {
            logger_cli_settings |= AST_PJSIP_LOGGER_PCAP;
            return pjsip_set_logger_pcap(a->fd, a->argv[e->args]);
        }
    }
 
    return CLI_SHOWUSAGE;
}

References a, ast_cli_entry::args, ast_cli_complete(), AST_PJSIP_LOGGER_ALL, AST_PJSIP_LOGGER_HOST, AST_PJSIP_LOGGER_METHOD, AST_PJSIP_LOGGER_NONE, AST_PJSIP_LOGGER_PCAP, AST_PJSIP_LOGGER_VERBOSE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, ast_cli_entry::command, logger_cli_settings, NULL, pjsip_disable_logger(), pjsip_enable_logger_all(), pjsip_enable_logger_host(), pjsip_enable_logger_method(), pjsip_set_logger_pcap(), pjsip_set_logger_verbose(), and ast_cli_entry::usage.

pjsip_set_logger_pcap()

static char * pjsip_set_logger_pcap ( int  fd, const char *  arg  )

static

Definition at line 567 of file res_pjsip_logger.c.

{
    struct pcap_header pcap_header = {
        .magic_number = 0xa1b2c3d4,
        .version_major = 2,
        .version_minor = 4,
        .snaplen = 65535,
        .network = 1, /* We always use ethernet so we can combine IPv4 and IPv6 in same pcap */
    };
 
    ao2_wrlock(default_logger);
    ast_copy_string(default_logger->pcap_filename, arg, sizeof(default_logger->pcap_filename));
 
    if (default_logger->pcap_file) {
        fclose(default_logger->pcap_file);
        default_logger->pcap_file = NULL;
    }
 
    default_logger->pcap_file = fopen(arg, "wb");
    if (!default_logger->pcap_file) {
        ao2_unlock(default_logger);
        ast_cli(fd, "Failed to open file '%s' for pcap writing\n", arg);
        return CLI_SUCCESS;
    }
    fwrite(&pcap_header, 1, sizeof(struct pcap_header), default_logger->pcap_file);
 
    default_logger->log_to_pcap = 1;
    ao2_unlock(default_logger);
 
    ast_cli(fd, "PJSIP logging to pcap file '%s'\n", arg);
 
    return CLI_SUCCESS;
}

References ao2_unlock, ao2_wrlock, ast_cli(), ast_copy_string(), CLI_SUCCESS, default_logger, pjsip_logger_session::log_to_pcap, pcap_header::magic_number, NULL, pjsip_logger_session::pcap_file, and pjsip_logger_session::pcap_filename.

Referenced by pjsip_set_logger().

pjsip_set_logger_verbose()

static char * pjsip_set_logger_verbose ( int  fd, const char *  arg  )

static

Definition at line 556 of file res_pjsip_logger.c.

{
    ao2_wrlock(default_logger);
    default_logger->log_to_verbose = ast_true(arg);
    ao2_unlock(default_logger);
 
    ast_cli(fd, "PJSIP Logging to verbose has been %s\n", ast_true(arg) ? "enabled" : "disabled");
 
    return CLI_SUCCESS;
}

References ao2_unlock, ao2_wrlock, ast_cli(), ast_true(), CLI_SUCCESS, default_logger, and pjsip_logger_session::log_to_verbose.

Referenced by pjsip_set_logger().

unload_module()

static int unload_module ( void  )

static

Definition at line 761 of file res_pjsip_logger.c.

{
    ast_cli_unregister_multiple(cli_pjsip, ARRAY_LEN(cli_pjsip));
    ast_sip_unregister_service(&logging_module);
 
    ast_sorcery_observer_remove(
        ast_sip_get_sorcery(), "global", &global_observer);
 
    ao2_cleanup(default_logger);
    default_logger = NULL;
 
    return 0;
}

References ao2_cleanup, ARRAY_LEN, ast_cli_unregister_multiple(), ast_sip_get_sorcery(), ast_sip_unregister_service(), ast_sorcery_observer_remove(), cli_pjsip, default_logger, global_observer, logging_module, and NULL.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "PJSIP Packet Logger" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .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", }

static

Definition at line 781 of file res_pjsip_logger.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 781 of file res_pjsip_logger.c.

cli_pjsip

struct ast_cli_entry cli_pjsip[]

static

Initial value:

= {
    { .handler =  pjsip_set_logger , .summary =  "Enable/Disable PJSIP Logger Output" ,}
}

Definition at line 680 of file res_pjsip_logger.c.

Referenced by load_module(), and unload_module().

default_logger

struct pjsip_logger_session* default_logger

static

The default logger session.

Definition at line 130 of file res_pjsip_logger.c.

Referenced by load_module(), logging_on_rx_msg(), logging_on_tx_msg(), pjsip_disable_logger(), pjsip_enable_logger_all(), pjsip_enable_logger_host(), pjsip_enable_logger_method(), pjsip_set_logger_pcap(), pjsip_set_logger_verbose(), and unload_module().

global_observer

const struct ast_sorcery_observer global_observer

static

Initial value:

= {
    .loaded = global_reloaded
}

Definition at line 734 of file res_pjsip_logger.c.

Referenced by load_module(), and unload_module().

logger_cli_settings

enum pjsip_logger_mask logger_cli_settings = AST_PJSIP_LOGGER_UNSET

static

Definition at line 611 of file res_pjsip_logger.c.

Referenced by check_debug(), and pjsip_set_logger().

logger_config_settings

enum pjsip_logger_mask logger_config_settings = AST_PJSIP_LOGGER_UNSET

static

Definition at line 612 of file res_pjsip_logger.c.

Referenced by check_debug().

logging_module

pjsip_module logging_module

static

Definition at line 370 of file res_pjsip_logger.c.

Referenced by load_module(), and unload_module().