Skip to content
Snippets Groups Projects
config_parser.c 29.6 KiB
Newer Older
  • Learn to ignore specific revisions
  • David Vossel's avatar
    David Vossel committed
    /*
     * Asterisk -- An open source telephony toolkit.
     *
     * Copyright (C) 2010, Digium, Inc.
     *
     * 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.
     */
    
    /*!
     * \file
     * \brief sip config parsing functions and unit tests
     */
    
    
    /*** MODULEINFO
    
    	<support_level>extended</support_level>
    
    David Vossel's avatar
    David Vossel committed
    #include "asterisk.h"
    
    ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
    
    #include "include/sip.h"
    #include "include/config_parser.h"
    #include "include/sip_utils.h"
    
    /*! \brief Parse register=> line in sip.conf
     *
     * \retval 0 on success
     * \retval -1 on failure
     */
    
    int sip_parse_register_line(struct sip_registry *reg, int default_expiry, const char *value, int lineno)
    
    David Vossel's avatar
    David Vossel committed
    {
    	int portnum = 0;
    
    	enum ast_transport transport = AST_TRANSPORT_UDP;
    
    David Vossel's avatar
    David Vossel committed
    	char buf[256] = "";
    	char *userpart = NULL, *hostpart = NULL;
    	/* register => [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry] */
    	AST_DECLARE_APP_ARGS(pre1,
    		AST_APP_ARG(peer);
    		AST_APP_ARG(userpart);
    	);
    	AST_DECLARE_APP_ARGS(pre2,
    		AST_APP_ARG(transport);
    		AST_APP_ARG(blank);
    		AST_APP_ARG(userpart);
    	);
    	AST_DECLARE_APP_ARGS(user1,
    		AST_APP_ARG(userpart);
    		AST_APP_ARG(secret);
    		AST_APP_ARG(authuser);
    	);
    
    	AST_DECLARE_APP_ARGS(user2,
    		AST_APP_ARG(user);
    		AST_APP_ARG(domain);
    	);
    	AST_DECLARE_APP_ARGS(user3,
    		AST_APP_ARG(authuser);
    		AST_APP_ARG(domainport);
    	);
    
    David Vossel's avatar
    David Vossel committed
    	AST_DECLARE_APP_ARGS(host1,
    		AST_APP_ARG(hostpart);
    		AST_APP_ARG(expiry);
    	);
    	AST_DECLARE_APP_ARGS(host2,
    		AST_APP_ARG(hostpart);
    		AST_APP_ARG(extension);
    	);
    	AST_DECLARE_APP_ARGS(host3,
    		AST_APP_ARG(host);
    		AST_APP_ARG(port);
    	);
    
    
    David Vossel's avatar
    David Vossel committed
    		return -1;
    	}
    
    
    	reg->expire = -1;
    	reg->timeout = -1;
    
    	if (!value) {
    
    David Vossel's avatar
    David Vossel committed
    		return -1;
    	}
    
    David Vossel's avatar
    David Vossel committed
    	ast_copy_string(buf, value, sizeof(buf));
    
    	/*! register => [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry]
    	 * becomes
    	 *   userpart => [peer?][transport://]user[@domain][:secret[:authuser]]
    	 *   hostpart => host[:port][/extension][~expiry]
    	 */
    	if ((hostpart = strrchr(buf, '@'))) {
    		*hostpart++ = '\0';
    		userpart = buf;
    	}
    
    	if (ast_strlen_zero(userpart) || ast_strlen_zero(hostpart)) {
    		ast_log(LOG_WARNING, "Format for registration is [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry] at line %d\n", lineno);
    		return -1;
    	}
    
    	/*!
    	 * pre1.peer => peer
    	 * pre1.userpart => [transport://]user[@domain][:secret[:authuser]]
    	 * hostpart => host[:port][/extension][~expiry]
    	 */
    	AST_NONSTANDARD_RAW_ARGS(pre1, userpart, '?');
    	if (ast_strlen_zero(pre1.userpart)) {
    		pre1.userpart = pre1.peer;
    		pre1.peer = NULL;
    	}
    
    	/*!
    	 * pre1.peer => peer
    	 * pre2.transport = transport
    	 * pre2.userpart => user[@domain][:secret[:authuser]]
    	 * hostpart => host[:port][/extension][~expiry]
    	 */
    	AST_NONSTANDARD_RAW_ARGS(pre2, pre1.userpart, '/');
    	if (ast_strlen_zero(pre2.userpart)) {
    		pre2.userpart = pre2.transport;
    		pre2.transport = NULL;
    	} else {
    		pre2.transport[strlen(pre2.transport) - 1] = '\0'; /* Remove trailing : */
    	}
    
    	if (!ast_strlen_zero(pre2.blank)) {
    		ast_log(LOG_WARNING, "Format for registration is [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry] at line %d\n", lineno);
    		return -1;
    	}
    
    	/*!
    	 * pre1.peer => peer
    	 * pre2.transport = transport
    	 * user1.userpart => user[@domain]
    	 * user1.secret => secret
    	 * user1.authuser => authuser
    	 * hostpart => host[:port][/extension][~expiry]
    	 */
    	AST_NONSTANDARD_RAW_ARGS(user1, pre2.userpart, ':');
    
    	/*!
    	 * pre1.peer => peer
    	 * pre2.transport = transport
    	 * user1.userpart => user[@domain]
    	 * user1.secret => secret
    	 * user1.authuser => authuser
    	 * host1.hostpart => host[:port][/extension]
    	 * host1.expiry => [expiry]
    	 */
    	AST_NONSTANDARD_RAW_ARGS(host1, hostpart, '~');
    
    	/*!
    	 * pre1.peer => peer
    	 * pre2.transport = transport
    	 * user1.userpart => user[@domain]
    	 * user1.secret => secret
    	 * user1.authuser => authuser
    	 * host2.hostpart => host[:port]
    	 * host2.extension => [extension]
    	 * host1.expiry => [expiry]
    	 */
    	AST_NONSTANDARD_RAW_ARGS(host2, host1.hostpart, '/');
    
    	/*!
    	 * pre1.peer => peer
    	 * pre2.transport = transport
    	 * user1.userpart => user[@domain]
    	 * user1.secret => secret
    	 * user1.authuser => authuser
    	 * host3.host => host
    	 * host3.port => port
    	 * host2.extension => extension
    	 * host1.expiry => expiry
    	 */
    	AST_NONSTANDARD_RAW_ARGS(host3, host2.hostpart, ':');
    
    
    	/*!
    	  * pre1.peer => peer
    	  * pre2.transport = transport
    	  * user2.user => user
    	  * user2.domain => domain
    	  * user1.secret => secret
    	  * user1.authuser => authuser
    	  * host3.host => host
    	  * host3.port => port
    	  * host2.extension => extension
    	  * host1.expiry => expiry
    	 */
    	AST_NONSTANDARD_RAW_ARGS(user2, user1.userpart, '@');
    
    	/*!
    	  * pre1.peer => peer
    	  * pre2.transport = transport
    	  * user2.user => user
    	  * user2.domain => domain
    	  * user1.secret => secret
    	  * user3.authuser => authuser
    	  * user3.domainport => domainport
    	  * host3.host => host
    	  * host3.port => port
    	  * host2.extension => extension
    	  * host1.expiry => expiry
    	 */
    	AST_NONSTANDARD_RAW_ARGS(user3, user1.authuser, ':');
    
    	/* Reordering needed due to fields being [(:secret[:username])|(:regdomainport:secret:username)]
    	   but parsing being [secret[:username[:regdomainport]]] */
    	if (user3.argc == 2) {
    		char *reorder = user3.domainport;
    		user3.domainport = user1.secret;
    		user1.secret = user3.authuser;
    		user3.authuser = reorder;
    	}
    
    
    David Vossel's avatar
    David Vossel committed
    	if (host3.port) {
    		if (!(portnum = port_str2int(host3.port, 0))) {
    			ast_log(LOG_NOTICE, "'%s' is not a valid port number on line %d of sip.conf. using default.\n", host3.port, lineno);
    		}
    	}
    
    	if (user3.domainport) {
    		if (!(domainport = port_str2int(user3.domainport, 0))) {
    			ast_log(LOG_NOTICE, "'%s' is not a valid domain port number on line %d of sip.conf. using default.\n", user3.domainport, lineno);
    		}
    	}
    
    David Vossel's avatar
    David Vossel committed
    
    	/* set transport type */
    	if (!pre2.transport) {
    
    		transport = AST_TRANSPORT_UDP;
    
    David Vossel's avatar
    David Vossel committed
    	} else if (!strncasecmp(pre2.transport, "tcp", 3)) {
    
    		transport = AST_TRANSPORT_TCP;
    
    David Vossel's avatar
    David Vossel committed
    	} else if (!strncasecmp(pre2.transport, "tls", 3)) {
    
    		transport = AST_TRANSPORT_TLS;
    
    David Vossel's avatar
    David Vossel committed
    	} else if (!strncasecmp(pre2.transport, "udp", 3)) {
    
    		transport = AST_TRANSPORT_UDP;
    
    David Vossel's avatar
    David Vossel committed
    	} else {
    
    		transport = AST_TRANSPORT_UDP;
    
    David Vossel's avatar
    David Vossel committed
    		ast_log(LOG_NOTICE, "'%.3s' is not a valid transport type on line %d of sip.conf. defaulting to udp.\n", pre2.transport, lineno);
    	}
    
    	/* if no portnum specified, set default for transport */
    	if (!portnum) {
    
    		if (transport == AST_TRANSPORT_TLS) {
    
    David Vossel's avatar
    David Vossel committed
    			portnum = STANDARD_TLS_PORT;
    		} else {
    			portnum = STANDARD_SIP_PORT;
    		}
    	}
    
    	/* copy into sip_registry object */
    	ast_string_field_set(reg, callback, ast_strip_quoted(S_OR(host2.extension, "s"), "\"", "\""));
    
    	ast_string_field_set(reg, username, ast_strip_quoted(S_OR(user2.user, ""), "\"", "\""));
    
    David Vossel's avatar
    David Vossel committed
    	ast_string_field_set(reg, hostname, ast_strip_quoted(S_OR(host3.host, ""), "\"", "\""));
    
    	ast_string_field_set(reg, authuser, ast_strip_quoted(S_OR(user3.authuser, ""), "\"", "\""));
    
    David Vossel's avatar
    David Vossel committed
    	ast_string_field_set(reg, secret, ast_strip_quoted(S_OR(user1.secret, ""), "\"", "\""));
    	ast_string_field_set(reg, peername, ast_strip_quoted(S_OR(pre1.peer, ""), "\"", "\""));
    
    	ast_string_field_set(reg, regdomain, ast_strip_quoted(S_OR(user2.domain, ""), "\"", "\""));
    
    David Vossel's avatar
    David Vossel committed
    
    	reg->transport = transport;
    	reg->portno = portnum;
    
    	reg->regdomainport = domainport;
    
    David Vossel's avatar
    David Vossel committed
    	reg->callid_valid = FALSE;
    	reg->ocseq = INITIAL_CSEQ;
    
    	reg->refresh = reg->expiry = reg->configured_expiry = (host1.expiry ? atoi(ast_strip_quoted(host1.expiry, "\"", "\"")) : default_expiry);
    
    David Vossel's avatar
    David Vossel committed
    
    	return 0;
    }
    
    
    David Vossel's avatar
    David Vossel committed
    AST_TEST_DEFINE(sip_parse_register_line_test)
    {
    	int res = AST_TEST_PASS;
    	struct sip_registry *reg;
    
    David Vossel's avatar
    David Vossel committed
    	const char *reg1 = "name@domain";
    	const char *reg2 = "name:pass@domain";
    	const char *reg3 = "name@namedomain:pass:authuser@domain";
    	const char *reg4 = "name@namedomain:pass:authuser@domain/extension";
    	const char *reg5 = "tcp://name@namedomain:pass:authuser@domain/extension";
    	const char *reg6 = "tls://name@namedomain:pass:authuser@domain/extension~111";
    	const char *reg7 = "peer?tcp://name@namedomain:pass:authuser@domain:1234/extension~111";
    	const char *reg8 = "peer?name@namedomain:pass:authuser@domain:1234/extension~111";
    	const char *reg9 = "peer?name:pass:authuser:1234/extension~111";
    	const char *reg10 = "@domin:1234";
    
    	const char *reg12 = "name@namedomain:4321:pass:authuser@domain";
    	const char *reg13 = "name@namedomain:4321::@domain";
    
    David Vossel's avatar
    David Vossel committed
    
    	switch (cmd) {
    	case TEST_INIT:
    		info->name = "sip_parse_register_line_test";
    
    David Vossel's avatar
    David Vossel committed
    		info->summary = "tests sip register line parsing";
    		info->description =
    
    							"Tests parsing of various register line configurations. "
    							"Verifies output matches expected behavior.";
    
    David Vossel's avatar
    David Vossel committed
    		return AST_TEST_NOT_RUN;
    	case TEST_EXECUTE:
    		break;
    	}
    
    	/* ---Test reg 1, simple config --- */
    	if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
    		goto alloc_fail;
    	} else if (
    
    	    sip_parse_register_line(reg, default_expiry, reg1, 1) ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->callback, "s")           ||
    		strcmp(reg->username, "name")       ||
    
    		strcmp(reg->regdomain, "")          ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->hostname, "domain")     ||
    		strcmp(reg->authuser, "")           ||
    		strcmp(reg->secret, "")             ||
    		strcmp(reg->peername, "")           ||
    
    		reg->transport != AST_TRANSPORT_UDP ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->timeout != -1                  ||
    		reg->expire != -1                   ||
    
    		reg->refresh != default_expiry ||
    		reg->expiry != default_expiry ||
    		reg->configured_expiry != default_expiry ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->portno != STANDARD_SIP_PORT    ||
    
    		(reg->regdomainport)                ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->callid_valid != FALSE          ||
    		reg->ocseq != INITIAL_CSEQ) {
    
    
    		ast_test_status_update(test, "Test 1: simple config failed\n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    	ast_string_field_free_memory(reg);
    	ast_free(reg);
    
    	/* ---Test reg 2, add secret --- */
    	if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
    		goto alloc_fail;
    	} else if (
    
    	    sip_parse_register_line(reg, default_expiry, reg2, 1) ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->callback, "s")           ||
    		strcmp(reg->username, "name")       ||
    
    		strcmp(reg->regdomain, "")          ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->hostname, "domain")     ||
    		strcmp(reg->authuser, "")           ||
    		strcmp(reg->secret, "pass")         ||
    		strcmp(reg->peername, "")           ||
    
    		reg->transport != AST_TRANSPORT_UDP ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->timeout != -1                  ||
    		reg->expire != -1                   ||
    
    		reg->refresh != default_expiry ||
    		reg->expiry != default_expiry ||
    		reg->configured_expiry != default_expiry ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->portno != STANDARD_SIP_PORT    ||
    
    		(reg->regdomainport)                ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->callid_valid != FALSE          ||
    		reg->ocseq != INITIAL_CSEQ) {
    
    
    		ast_test_status_update(test,  "Test 2: add secret failed\n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    	ast_string_field_free_memory(reg);
    	ast_free(reg);
    
    	/* ---Test reg 3, add userdomain and authuser --- */
    	if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
    		goto alloc_fail;
    	} else if (
    
    	    sip_parse_register_line(reg, default_expiry, reg3, 1) ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->callback, "s")           ||
    
    		strcmp(reg->username, "name") ||
    		strcmp(reg->regdomain, "namedomain") ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->hostname, "domain")     ||
    		strcmp(reg->authuser, "authuser")           ||
    		strcmp(reg->secret, "pass")         ||
    		strcmp(reg->peername, "")           ||
    
    		reg->transport != AST_TRANSPORT_UDP ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->timeout != -1                  ||
    		reg->expire != -1                   ||
    
    		reg->refresh != default_expiry ||
    		reg->expiry != default_expiry ||
    		reg->configured_expiry != default_expiry ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->portno != STANDARD_SIP_PORT    ||
    
    		(reg->regdomainport)                ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->callid_valid != FALSE          ||
    		reg->ocseq != INITIAL_CSEQ) {
    
    
    		ast_test_status_update(test, "Test 3: add userdomain and authuser failed\n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    	ast_string_field_free_memory(reg);
    	ast_free(reg);
    
    	/* ---Test reg 4, add callback extension --- */
    	if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
    		goto alloc_fail;
    	} else if (
    
    	    sip_parse_register_line(reg, default_expiry, reg4, 1) ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->callback, "extension")           ||
    
    		strcmp(reg->username, "name") ||
    		strcmp(reg->regdomain, "namedomain") ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->hostname, "domain")     ||
    		strcmp(reg->authuser, "authuser")           ||
    		strcmp(reg->secret, "pass")         ||
    		strcmp(reg->peername, "")           ||
    
    		reg->transport != AST_TRANSPORT_UDP ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->timeout != -1                  ||
    		reg->expire != -1                   ||
    
    		reg->refresh != default_expiry ||
    		reg->expiry != default_expiry ||
    		reg->configured_expiry != default_expiry ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->portno != STANDARD_SIP_PORT    ||
    
    		(reg->regdomainport)                ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->callid_valid != FALSE          ||
    		reg->ocseq != INITIAL_CSEQ) {
    
    
    		ast_test_status_update(test, "Test 4: add callback extension failed\n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    	ast_string_field_free_memory(reg);
    	ast_free(reg);
    
    	/* ---Test reg 5, add transport --- */
    	if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
    		goto alloc_fail;
    	} else if (
    
    	    sip_parse_register_line(reg, default_expiry, reg5, 1) ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->callback, "extension")           ||
    
    		strcmp(reg->username, "name") ||
    		strcmp(reg->regdomain, "namedomain") ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->hostname, "domain")     ||
    		strcmp(reg->authuser, "authuser")           ||
    		strcmp(reg->secret, "pass")         ||
    		strcmp(reg->peername, "")           ||
    
    		reg->transport != AST_TRANSPORT_TCP ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->timeout != -1                  ||
    		reg->expire != -1                   ||
    
    		reg->refresh != default_expiry ||
    		reg->expiry != default_expiry ||
    		reg->configured_expiry != default_expiry ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->portno != STANDARD_SIP_PORT    ||
    
    		(reg->regdomainport)                ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->callid_valid != FALSE          ||
    		reg->ocseq != INITIAL_CSEQ) {
    
    
    		ast_test_status_update(test, "Test 5: add transport failed\n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    	ast_string_field_free_memory(reg);
    	ast_free(reg);
    
    	/* ---Test reg 6, change to tls transport, add expiry  --- */
    	if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
    		goto alloc_fail;
    	} else if (
    
    	    sip_parse_register_line(reg, default_expiry, reg6, 1) ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->callback, "extension")           ||
    
    		strcmp(reg->username, "name") ||
    		strcmp(reg->regdomain, "namedomain") ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->hostname, "domain")     ||
    		strcmp(reg->authuser, "authuser")           ||
    		strcmp(reg->secret, "pass")         ||
    		strcmp(reg->peername, "")           ||
    
    		reg->transport != AST_TRANSPORT_TLS ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->timeout != -1                  ||
    		reg->expire != -1                   ||
    		reg->refresh != 111 ||
    		reg->expiry != 111 ||
    		reg->configured_expiry != 111 ||
    		reg->portno != STANDARD_TLS_PORT    ||
    
    		(reg->regdomainport)                ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->callid_valid != FALSE          ||
    		reg->ocseq != INITIAL_CSEQ) {
    
    
    		ast_test_status_update(test, "Test 6: change to tls transport and add expiry failed\n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    	ast_string_field_free_memory(reg);
    	ast_free(reg);
    
    	/* ---Test reg 7, change transport to tcp, add custom port, and add peer --- */
    	if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
    		goto alloc_fail;
    	} else if (
    
    	    sip_parse_register_line(reg, default_expiry, reg7, 1) ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->callback, "extension")           ||
    
    		strcmp(reg->username, "name") ||
    		strcmp(reg->regdomain, "namedomain") ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->hostname, "domain")     ||
    		strcmp(reg->authuser, "authuser")           ||
    		strcmp(reg->secret, "pass")         ||
    		strcmp(reg->peername, "peer")           ||
    
    		reg->transport != AST_TRANSPORT_TCP ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->timeout != -1                  ||
    		reg->expire != -1                   ||
    		reg->refresh != 111 ||
    		reg->expiry != 111 ||
    		reg->configured_expiry != 111 ||
    		reg->portno != 1234    ||
    
    		(reg->regdomainport)                ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->callid_valid != FALSE          ||
    		reg->ocseq != INITIAL_CSEQ) {
    
    
    		ast_test_status_update(test, "Test 7, change transport to tcp, add custom port, and add peer failed.\n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    	ast_string_field_free_memory(reg);
    	ast_free(reg);
    
    	/* ---Test reg 8, remove transport --- */
    	if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
    		goto alloc_fail;
    	} else if (
    
    	    sip_parse_register_line(reg, default_expiry, reg8, 1) ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->callback, "extension")           ||
    
    		strcmp(reg->username, "name") ||
    		strcmp(reg->regdomain, "namedomain") ||
    
    David Vossel's avatar
    David Vossel committed
    		strcmp(reg->hostname, "domain")     ||
    		strcmp(reg->authuser, "authuser")           ||
    		strcmp(reg->secret, "pass")         ||
    		strcmp(reg->peername, "peer")           ||
    
    		reg->transport != AST_TRANSPORT_UDP ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->timeout != -1                  ||
    		reg->expire != -1                   ||
    		reg->refresh != 111 ||
    		reg->expiry != 111 ||
    		reg->configured_expiry != 111 ||
    		reg->portno != 1234    ||
    
    		(reg->regdomainport)                ||
    
    David Vossel's avatar
    David Vossel committed
    		reg->callid_valid != FALSE          ||
    		reg->ocseq != INITIAL_CSEQ) {
    
    
    		ast_test_status_update(test, "Test 8, remove transport failed.\n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    	ast_string_field_free_memory(reg);
    	ast_free(reg);
    
    
    	/* ---Test reg 9, missing domain, expected to fail --- */
    	if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
    		goto alloc_fail;
    	} else if (!sip_parse_register_line(reg, default_expiry, reg9, 1)) {
    		ast_test_status_update(test,
    				"Test 9, missing domain, expected to fail but did not.\n");
    		res = AST_TEST_FAIL;
    	}
    	ast_string_field_free_memory(reg);
    	ast_free(reg);
    
    	/* ---Test reg 10,  missing user, expected to fail --- */
    	if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
    		goto alloc_fail;
    	} else if (!sip_parse_register_line(reg, default_expiry, reg10, 1)) {
    		ast_test_status_update(test,
    				"Test 10, missing user expected to fail but did not\n");
    		res = AST_TEST_FAIL;
    	}
    	ast_string_field_free_memory(reg);
    	ast_free(reg);
    
    	/* ---Test reg 11, no registry object, expected to fail--- */
    	if (!sip_parse_register_line(NULL, default_expiry, reg1, 1)) {
    		ast_test_status_update(test,
    				"Test 11, no registry object, expected to fail but did not.\n");
    		res = AST_TEST_FAIL;
    	}
    
    	/* ---Test reg 12,  no registry line, expected to fail --- */
    	if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
    		goto alloc_fail;
    	} else if (!sip_parse_register_line(reg, default_expiry, NULL, 1)) {
    
    		ast_test_status_update(test,
    				"Test 12, NULL register line expected to fail but did not.\n");
    		res = AST_TEST_FAIL;
    	}
    	ast_string_field_free_memory(reg);
    	ast_free(reg);
    
    	/* ---Test reg13, add domain port --- */
    
    	if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
    		goto alloc_fail;
    	} else if (
    	   sip_parse_register_line(reg, default_expiry, reg12, 1) ||
    		strcmp(reg->callback, "s")           ||
    		strcmp(reg->username, "name") ||
    		strcmp(reg->regdomain, "namedomain") ||
    		strcmp(reg->hostname, "domain")     ||
    		strcmp(reg->authuser, "authuser")           ||
    		strcmp(reg->secret, "pass")         ||
    		strcmp(reg->peername, "")           ||
    
    		reg->transport != AST_TRANSPORT_UDP ||
    
    		reg->timeout != -1                  ||
    		reg->expire != -1                   ||
    		reg->refresh != default_expiry ||
    		reg->expiry != default_expiry ||
    		reg->configured_expiry != default_expiry ||
    		reg->portno != STANDARD_SIP_PORT    ||
    		reg->regdomainport != 4321          ||
    		reg->callid_valid != FALSE          ||
    		reg->ocseq != INITIAL_CSEQ) {
    
    
    		ast_test_status_update(test, "Test 13, add domain port failed.\n");
    
    	ast_string_field_free_memory(reg);
    	ast_free(reg);
    
    	/* ---Test reg14, domain port without secret --- */
    
    	if (!(reg = ast_calloc_with_stringfields(1, struct sip_registry, 256))) {
    		goto alloc_fail;
    	} else if (
    	   sip_parse_register_line(reg, default_expiry, reg13, 1) ||
    		strcmp(reg->callback, "s")           ||
    		strcmp(reg->username, "name") ||
    		strcmp(reg->regdomain, "namedomain") ||
    		strcmp(reg->hostname, "domain")     ||
    		strcmp(reg->authuser, "")           ||
    		strcmp(reg->secret, "")         ||
    		strcmp(reg->peername, "")           ||
    
    		reg->transport != AST_TRANSPORT_UDP ||
    
    		reg->timeout != -1                  ||
    		reg->expire != -1                   ||
    		reg->refresh != default_expiry ||
    		reg->expiry != default_expiry ||
    		reg->configured_expiry != default_expiry ||
    		reg->portno != STANDARD_SIP_PORT    ||
    		reg->regdomainport != 4321          ||
    		reg->callid_valid != FALSE          ||
    		reg->ocseq != INITIAL_CSEQ) {
    
    
    		ast_test_status_update(test, "Test 14, domain port without secret failed.\n");
    
    	}
    	ast_string_field_free_memory(reg);
    	ast_free(reg);
    
    David Vossel's avatar
    David Vossel committed
    
    	return res;
    
    alloc_fail:
    
    	ast_test_status_update(test, "Out of memory. \n");
    
    David Vossel's avatar
    David Vossel committed
    	return res;
    }
    
    David Vossel's avatar
    David Vossel committed
    
    
    int sip_parse_host(char *line, int lineno, char **hostname, int *portnum, enum ast_transport *transport)
    
    David Vossel's avatar
    David Vossel committed
    {
    	char *port;
    
    	if (ast_strlen_zero(line)) {
    
    David Vossel's avatar
    David Vossel committed
    		return -1;
    	}
    	if ((*hostname = strstr(line, "://"))) {
    		*hostname += 3;
    
    
    		if (!strncasecmp(line, "tcp", 3)) {
    
    			*transport = AST_TRANSPORT_TCP;
    
    		} else if (!strncasecmp(line, "tls", 3)) {
    
    			*transport = AST_TRANSPORT_TLS;
    
    		} else if (!strncasecmp(line, "udp", 3)) {
    
    			*transport = AST_TRANSPORT_UDP;
    
    		} else if (lineno) {
    
    David Vossel's avatar
    David Vossel committed
    			ast_log(LOG_NOTICE, "'%.3s' is not a valid transport type on line %d of sip.conf. defaulting to udp.\n", line, lineno);
    
    		} else {
    			ast_log(LOG_NOTICE, "'%.3s' is not a valid transport type in sip config. defaulting to udp.\n", line);
    		}
    
    David Vossel's avatar
    David Vossel committed
    	} else {
    		*hostname = line;
    
    		*transport = AST_TRANSPORT_UDP;
    
    David Vossel's avatar
    David Vossel committed
    	}
    
    	if ((line = strrchr(*hostname, '@')))
    		line++;
    	else
    		line = *hostname;
    
    
    	if (ast_sockaddr_split_hostport(line, hostname, &port, 0) == 0) {
    
    		if (lineno) {
    			ast_log(LOG_WARNING, "Cannot parse host '%s' on line %d of sip.conf.\n",
    				line, lineno);
    		} else {
    			ast_log(LOG_WARNING, "Cannot parse host '%s' in sip config.\n", line);
    		}
    
    		return -1;
    	}
    
    David Vossel's avatar
    David Vossel committed
    
    
    	if (port) {
    
    		if (!sscanf(port, "%5d", portnum)) {
    
    			if (lineno) {
    				ast_log(LOG_NOTICE, "'%s' is not a valid port number on line %d of sip.conf. using default.\n", port, lineno);
    			} else {
    				ast_log(LOG_NOTICE, "'%s' is not a valid port number in sip config. using default.\n", port);
    			}
    
    David Vossel's avatar
    David Vossel committed
    			port = NULL;
    		}
    
    		if (*transport & AST_TRANSPORT_TLS) {
    
    David Vossel's avatar
    David Vossel committed
    			*portnum = STANDARD_TLS_PORT;
    		} else {
    			*portnum = STANDARD_SIP_PORT;
    		}
    	}
    
    	return 0;
    }
    
    
    David Vossel's avatar
    David Vossel committed
    AST_TEST_DEFINE(sip_parse_host_line_test)
    {
    	int res = AST_TEST_PASS;
    	char *host;
    	int port;
    
    	enum ast_transport transport;
    
    David Vossel's avatar
    David Vossel committed
    	char host1[] = "www.blah.com";
    	char host2[] = "tcp://www.blah.com";
    	char host3[] = "tls://10.10.10.10";
    	char host4[] = "tls://10.10.10.10:1234";
    	char host5[] = "10.10.10.10:1234";
    
    	switch (cmd) {
    	case TEST_INIT:
    		info->name = "sip_parse_host_line_test";
    
    David Vossel's avatar
    David Vossel committed
    		info->summary = "tests sip.conf host line parsing";
    		info->description =
    
    							"Tests parsing of various host line configurations. "
    							"Verifies output matches expected behavior.";
    
    David Vossel's avatar
    David Vossel committed
    		return AST_TEST_NOT_RUN;
    	case TEST_EXECUTE:
    		break;
    	}
    
    	/* test 1, simple host */
    	sip_parse_host(host1, 1, &host, &port, &transport);
    	if (port != STANDARD_SIP_PORT ||
    
    			ast_strlen_zero(host) || strcmp(host, "www.blah.com") ||
    
    			transport != AST_TRANSPORT_UDP) {
    
    		ast_test_status_update(test, "Test 1: simple host failed.\n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    
    	/* test 2, add tcp transport */
    	sip_parse_host(host2, 1, &host, &port, &transport);
    	if (port != STANDARD_SIP_PORT ||
    
    			ast_strlen_zero(host) || strcmp(host, "www.blah.com") ||
    
    			transport != AST_TRANSPORT_TCP) {
    
    		ast_test_status_update(test, "Test 2: tcp host failed.\n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    
    	/* test 3, add tls transport */
    	sip_parse_host(host3, 1, &host, &port, &transport);
    	if (port != STANDARD_TLS_PORT ||
    
    			ast_strlen_zero(host) || strcmp(host, "10.10.10.10") ||
    
    			transport != AST_TRANSPORT_TLS) {
    
    		ast_test_status_update(test, "Test 3: tls host failed. \n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    
    	/* test 4, add custom port with tls */
    	sip_parse_host(host4, 1, &host, &port, &transport);
    
    	if (port != 1234 || ast_strlen_zero(host) ||
    			strcmp(host, "10.10.10.10") ||
    
    			transport != AST_TRANSPORT_TLS) {
    
    		ast_test_status_update(test, "Test 4: tls host with custom port failed.\n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    
    	/* test 5, simple host with custom port */
    	sip_parse_host(host5, 1, &host, &port, &transport);
    
    	if (port != 1234 || ast_strlen_zero(host) ||
    			strcmp(host, "10.10.10.10") ||
    
    			transport != AST_TRANSPORT_UDP) {
    
    		ast_test_status_update(test, "Test 5: simple host with custom port failed.\n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    
    	/* test 6, expected failure with NULL input */
    
    	if (!sip_parse_host(NULL, 1, &host, &port, &transport)) {
    		ast_test_status_update(test, "Test 6: expected error on NULL input did not occur.\n");
    
    David Vossel's avatar
    David Vossel committed
    		res = AST_TEST_FAIL;
    	}
    
    David Vossel's avatar
    David Vossel committed
    	return res;
    
    }
    
    David Vossel's avatar
    David Vossel committed
    
    
    /*! \brief Parse the comma-separated nat= option values */
    void sip_parse_nat_option(const char *value, struct ast_flags *mask, struct ast_flags *flags)
    {
    	char *parse, *this;
    
    	if (!(parse = ast_strdupa(value))) {
    		return;
    	}
    
    	/* Since we need to completely override the general settings if we are being called
    	 * later for a peer, always set the flags for all options on the mask */
    	ast_set_flag(&mask[0], SIP_NAT_FORCE_RPORT);
    	ast_set_flag(&mask[1], SIP_PAGE2_SYMMETRICRTP);
    	ast_set_flag(&mask[2], SIP_PAGE3_NAT_AUTO_RPORT);
    	ast_set_flag(&mask[2], SIP_PAGE3_NAT_AUTO_COMEDIA);
    
    	while ((this = strsep(&parse, ","))) {
    		if (ast_false(this)) {
    			ast_clear_flag(&flags[0], SIP_NAT_FORCE_RPORT);
    			ast_clear_flag(&flags[1], SIP_PAGE2_SYMMETRICRTP);
    			ast_clear_flag(&flags[2], SIP_PAGE3_NAT_AUTO_RPORT);
    			ast_clear_flag(&flags[2], SIP_PAGE3_NAT_AUTO_COMEDIA);
    			break; /* It doesn't make sense to have no + something else */
    		} else if (!strcasecmp(this, "yes")) {
    			ast_log(LOG_WARNING, "nat=yes is deprecated, use nat=force_rport,comedia instead\n");
    			ast_set_flag(&flags[0], SIP_NAT_FORCE_RPORT);
    			ast_set_flag(&flags[1], SIP_PAGE2_SYMMETRICRTP);
    			ast_clear_flag(&flags[2], SIP_PAGE3_NAT_AUTO_RPORT);
    			ast_clear_flag(&flags[2], SIP_PAGE3_NAT_AUTO_COMEDIA);
    			break; /* It doesn't make sense to have yes + something else */
    		} else if (!strcasecmp(this, "force_rport") && !ast_test_flag(&flags[2], SIP_PAGE3_NAT_AUTO_RPORT)) {
    			ast_set_flag(&flags[0], SIP_NAT_FORCE_RPORT);
    		} else if (!strcasecmp(this, "comedia") && !ast_test_flag(&flags[2], SIP_PAGE3_NAT_AUTO_COMEDIA)) {
    			ast_set_flag(&flags[1], SIP_PAGE2_SYMMETRICRTP);
    		} else if (!strcasecmp(this, "auto_force_rport")) {
    			ast_set_flag(&flags[2], SIP_PAGE3_NAT_AUTO_RPORT);
    			/* In case someone did something dumb like nat=force_rport,auto_force_rport */
    			ast_clear_flag(&flags[0], SIP_NAT_FORCE_RPORT);
    		} else if (!strcasecmp(this, "auto_comedia")) {
    			ast_set_flag(&flags[2], SIP_PAGE3_NAT_AUTO_COMEDIA);
    			/* In case someone did something dumb like nat=comedia,auto_comedia*/
    			ast_clear_flag(&flags[1], SIP_PAGE2_SYMMETRICRTP);
    		}
    	}
    }
    
    
    #define TEST_FORCE_RPORT      1 << 0
    #define TEST_COMEDIA          1 << 1
    #define TEST_AUTO_FORCE_RPORT 1 << 2
    #define TEST_AUTO_COMEDIA     1 << 3
    static int match_nat_options(int val, struct ast_flags *flags)
    {
    	if ((!ast_test_flag(&flags[0], SIP_NAT_FORCE_RPORT)) != !(val & TEST_FORCE_RPORT)) {
    		return 0;
    	}
    	if (!ast_test_flag(&flags[1], SIP_PAGE2_SYMMETRICRTP) != !(val & TEST_COMEDIA)) {
    		return 0;
    	}
    	if (!ast_test_flag(&flags[2], SIP_PAGE3_NAT_AUTO_RPORT) != !(val & TEST_AUTO_FORCE_RPORT)) {
    		return 0;
    	}
    	if (!ast_test_flag(&flags[2], SIP_PAGE3_NAT_AUTO_COMEDIA) != !(val & TEST_AUTO_COMEDIA)) {
    	   return 0;
    	}
    	return 1;
    }
    
    AST_TEST_DEFINE(sip_parse_nat_test)
    {
    	int i, res = AST_TEST_PASS;
    	struct ast_flags mask[3] = {{0}}, flags[3] = {{0}};
    	struct {
    		const char *str;
    		int i;
    	} options[] = {
    		{ "yes", TEST_FORCE_RPORT | TEST_COMEDIA },
    		{ "no", 0 },
    		{ "force_rport", TEST_FORCE_RPORT },
    		{ "comedia", TEST_COMEDIA },
    		{ "auto_force_rport", TEST_AUTO_FORCE_RPORT },
    		{ "auto_comedia", TEST_AUTO_COMEDIA },
    		{ "force_rport,auto_force_rport", TEST_AUTO_FORCE_RPORT },
    		{ "auto_force_rport,force_rport", TEST_AUTO_FORCE_RPORT },
    		{ "comedia,auto_comedia", TEST_AUTO_COMEDIA },
    		{ "auto_comedia,comedia", TEST_AUTO_COMEDIA },
    		{ "force_rport,comedia", TEST_FORCE_RPORT | TEST_COMEDIA },
    		{ "force_rport,auto_comedia", TEST_FORCE_RPORT | TEST_AUTO_COMEDIA },
    		{ "force_rport,yes,no", TEST_FORCE_RPORT | TEST_COMEDIA },
    		{ "auto_comedia,no,yes", 0 },
    	};
    
    	switch (cmd) {
    	case TEST_INIT:
    		info->name = "sip_parse_nat_test";
    		info->category = "/channels/chan_sip/";
    		info->summary = "tests sip.conf nat line parsing";
    		info->description =
    							"Tests parsing of various nat line configurations. "
    							"Verifies output matches expected behavior.";
    		return AST_TEST_NOT_RUN;
    	case TEST_EXECUTE:
    		break;
    	}
    
    	for (i = 0; i < ARRAY_LEN(options); i++) {
    		sip_parse_nat_option(options[i].str, mask, flags);
    		if (!match_nat_options(options[i].i, flags)) {
    			ast_test_status_update(test, "Failed nat=%s\n", options[i].str);
    			res = AST_TEST_FAIL;
    		}
    		memset(flags, 0, sizeof(flags));
    		memset(mask, 0, sizeof(mask));
    	}
    
    	return res;
    }
    
    David Vossel's avatar
    David Vossel committed
    /*! \brief SIP test registration */
    void sip_config_parser_register_tests(void)
    {
    	AST_TEST_REGISTER(sip_parse_register_line_test);
    	AST_TEST_REGISTER(sip_parse_host_line_test);
    
    	AST_TEST_REGISTER(sip_parse_nat_test);
    
    David Vossel's avatar
    David Vossel committed
    }
    
    /*! \brief SIP test registration */
    void sip_config_parser_unregister_tests(void)
    {
    	AST_TEST_UNREGISTER(sip_parse_register_line_test);
    	AST_TEST_UNREGISTER(sip_parse_host_line_test);
    
    	AST_TEST_UNREGISTER(sip_parse_nat_test);
    
    David Vossel's avatar
    David Vossel committed
    }