Kamailio 3.3.x and FreeSWITCH 1.2.x for Media Services and SBC

Author:
    Daniel-Constantin Mierla

Overview

The scope of this tutorial is to show how you can use Kamailio (former OpenSER) and FreeSWITCH to build a complete SIP/VoIP platform for large number of subscribers.

Kamailio is an open source SIP server, forked from SIP Express Router (SER) in 2005 under the name OpenSER. In July 2008, OpenSER was renamed to Kamailio because of trademark issues. Starting with November 2008, Kamailio and SER teams restarted development collaboration, resulting in version 3.0.0 being the first that allow to run Kamailio and SER modules (extensions) in same SIP server instance - practically it is the same source code, the differences are the database structure used to store SIP user profiles and default enabled modules. The latest stable release series is 3.3.x, out on June 18, 2012.

One of outstanding features of Kamailio is ability of hosting large number of active users in a single instance (depending of hardware it can be 100 000+). Long development life ensures the stability required in real-time tele-communications and a broad set of features in handling SIP signaling.

FreeSWITCH is an open source multi-protocol softswitch, supporting SIP as well. It is a very attractive project from features and extensibility point of view. Its media processing capabilities makes FreeSWITCH a perfect fit for providing media services to Kamailio based platforms.

Any Kamailio version 3.3.x can be used (series started on Jun 18, 2012, right now last released is 3.3.1). For FreeSWITCH I used the latest version from GIT branch v1.2.stable (corresponding more or less to the v1.2.3 released on Sep 20, 2012).

Following services are handled in the scenario built within document:

kamailio
- user authentication
- user registration
- user location
- call routing
- instant messaging and presence
freeswitch
- voicemail
- conference
- SBC - this can be used for topology hiding, transcoding, prepaid or playing audio messages within calls
- other media services (announcement, ivr, a.s.o)

Local users have 3 digit IDs (we will use users 101 102, and 103 for testing). Voice box ID is the same as user ID. Extensions for media services start with 4.

Kamailio and FreeSWITCH are installed on the same physical server (ip 192.168.178.23), using different ports:

kamailio: port 5060
freeswitch: port 5090 for internal profile and 5092 for external profile

Updates

This is a new release of this tutorial, some from the past were using previous major stable release of Kamailio. You can read them at:

Besides upgrade to Kamailio v3.3.x and FreeSwitch 1.2.x, this version of tutorial includes new features:

in Kamailio
- new features brought by the default configuration of Kamailio, such as: speed dial, GRUU support, blocking 3XX responses
- all detail of the user profiles are stored in Kamailio database, inside subscriber table, including voicemail pin
- FreeSwitch is executing a Lua script to build on the fly the XML directory file for the user
- send email notification for new voice messages

Call Initiation

Call authentication is handled by Kamailio. When a new call arrives and it is authenticated, then:

if the destination user is not online, it is sent to FreeSwitch directly to voicemail box
if the destination user is online, Kamailio forwards it to FreeSwitch. There you can apply FreeSwitch specific functionality, like playing audio during early session, set a maximum call duration, enforce specific codecs, etc.
FreeSwitch sends the call back to Kamailio, which based on location service, will deliver the call to callee
if the callee does not answer, FreeSwitch will redirect it to voicemail box

Kamailio Configuration

Installation

A step by step installation tutorial for Kamailio 3.3.x is available at:

Install Kamailio 3.3.x from GIT

It is no special tunning needed for this tutorial, just install it as usual. You can use MySQL or your preferred database server, has no relevance here. But if you choose another database type, be sure you update the Kamailio config file, the one provided here uses MySQL.

We try to keep FreeSWITCH and Kamailio installations as much as possible independent one from the other.

Config File

Kamailio has one config file by default, named kamailio.cfg. Starting with 3.0.0, you can split it in several files and use include_file to merge the pieces in main config file.

Another important features brought since 3.0.0 are 'define' directives, making easy to enable/disable features. This concept is used here as well, therefore you can see the changes done for FreeSWITCH integration by following define WITH_FREESWITCH (i.e., config parts in between #!ifdef WITH_FREESWITCH … #!endif).

#!KAMAILIO
 
#!define WITH_MYSQL
#!define WITH_AUTH
#!define WITH_USRLOCDB
#!define WITH_FREESWITCH
 
#
# Kamailio (OpenSER) SIP Server v3.3 - default configuration script
#     - web: http://www.kamailio.org
#     - git: http://sip-router.org
#
# Direct your questions about this file to: <sr-users@lists.sip-router.org>
#
# Refer to the Core CookBook at http://www.kamailio.org/dokuwiki/doku.php
# for an explanation of possible statements, functions and parameters.
#
# Several features can be enabled using '#!define WITH_FEATURE' directives:
#
# *** To run in debug mode: 
#     - define WITH_DEBUG
#
# *** To enable mysql: 
#     - define WITH_MYSQL
#
# *** To enable authentication execute:
#     - enable mysql
#     - define WITH_AUTH
#     - add users using 'kamctl'
#
# *** To enable IP authentication execute:
#     - enable mysql
#     - enable authentication
#     - define WITH_IPAUTH
#     - add IP addresses with group id '1' to 'address' table
#
# *** To enable persistent user location execute:
#     - enable mysql
#     - define WITH_USRLOCDB
#
# *** To enable presence server execute:
#     - enable mysql
#     - define WITH_PRESENCE
#
# *** To enable nat traversal execute:
#     - define WITH_NAT
#     - install RTPProxy: http://www.rtpproxy.org
#     - start RTPProxy:
#        rtpproxy -l _your_public_ip_ -s udp:localhost:7722
#
# *** To enable PSTN gateway routing execute:
#     - define WITH_PSTN
#     - set the value of pstn.gw_ip
#     - check route[PSTN] for regexp routing condition
#
# *** To enable database aliases lookup execute:
#     - enable mysql
#     - define WITH_ALIASDB
#
# *** To enable speed dial lookup execute:
#     - enable mysql
#     - define WITH_SPEEDDIAL
#
# *** To enable multi-domain support execute:
#     - enable mysql
#     - define WITH_MULTIDOMAIN
#
# *** To enable TLS support execute:
#     - adjust CFGDIR/tls.cfg as needed
#     - define WITH_TLS
#
# *** To enable XMLRPC support execute:
#     - define WITH_XMLRPC
#     - adjust route[XMLRPC] for access policy
#
# *** To enable anti-flood detection execute:
#     - adjust pike and htable=>ipban settings as needed (default is
#       block if more than 16 requests in 2 seconds and ban for 300 seconds)
#     - define WITH_ANTIFLOOD
#
# *** To block 3XX redirect replies execute:
#     - define WITH_BLOCK3XX
#
# *** To enable VoiceMail routing execute:
#     - define WITH_VOICEMAIL
#     - set the value of voicemail.srv_ip
#     - adjust the value of voicemail.srv_port
#
# *** To enhance accounting execute:
#     - enable mysql
#     - define WITH_ACCDB
#     - add following columns to database
#!ifdef ACCDB_COMMENT
  ALTER TABLE acc ADD COLUMN src_user VARCHAR(64) NOT NULL DEFAULT '';
  ALTER TABLE acc ADD COLUMN src_domain VARCHAR(128) NOT NULL DEFAULT '';
  ALTER TABLE acc ADD COLUMN src_ip varchar(64) NOT NULL default '';
  ALTER TABLE acc ADD COLUMN dst_ouser VARCHAR(64) NOT NULL DEFAULT '';
  ALTER TABLE acc ADD COLUMN dst_user VARCHAR(64) NOT NULL DEFAULT '';
  ALTER TABLE acc ADD COLUMN dst_domain VARCHAR(128) NOT NULL DEFAULT '';
  ALTER TABLE missed_calls ADD COLUMN src_user VARCHAR(64) NOT NULL DEFAULT '';
  ALTER TABLE missed_calls ADD COLUMN src_domain VARCHAR(128) NOT NULL DEFAULT '';
  ALTER TABLE missed_calls ADD COLUMN src_ip varchar(64) NOT NULL default '';
  ALTER TABLE missed_calls ADD COLUMN dst_ouser VARCHAR(64) NOT NULL DEFAULT '';
  ALTER TABLE missed_calls ADD COLUMN dst_user VARCHAR(64) NOT NULL DEFAULT '';
  ALTER TABLE missed_calls ADD COLUMN dst_domain VARCHAR(128) NOT NULL DEFAULT '';
#!endif
 
####### Defined Values #########
 
# *** Value defines - IDs used later in config
#!ifdef WITH_MYSQL
# - database URL - used to connect to database server by modules such
#       as: auth_db, acc, usrloc, a.s.o.
#!define DBURL "mysql://openser:openserrw@localhost/openser"
#!endif
#!ifdef WITH_MULTIDOMAIN
# - the value for 'use_domain' parameters
#!define MULTIDOMAIN 1
#!else
#!define MULTIDOMAIN 0
#!endif
 
# - flags
#   FLT_ - per transaction (message) flags
#	FLB_ - per branch flags
#!define FLT_ACC 1
#!define FLT_ACCMISSED 2
#!define FLT_ACCFAILED 3
#!define FLT_NATS 5
 
#!define FLB_NATB 6
#!define FLB_NATSIPPING 7
 
####### Global Parameters #########
 
#!ifdef WITH_DEBUG
debug=4
log_stderror=yes
#!else
debug=2
log_stderror=no
#!endif
 
memdbg=5
memlog=5
 
log_facility=LOG_LOCAL0
 
fork=yes
children=4
 
/* uncomment the next line to disable TCP (default on) */
#disable_tcp=yes
 
/* uncomment the next line to disable the auto discovery of local aliases
   based on reverse DNS on IPs (default on) */
#auto_aliases=no
 
/* add local domain aliases */
#alias="sip.mydomain.com"
 
/* uncomment and configure the following line if you want Kamailio to 
   bind on a specific interface/port/proto (default bind on all available) */
#listen=udp:10.0.0.10:5060
 
/* port to listen to
 * - can be specified more than once if needed to listen on many ports */
port=5060
 
#!ifdef WITH_TLS
enable_tls=yes
#!endif
 
# life time of TCP connection when there is no traffic
# - a bit higher than registration expires to cope with UA behind NAT
tcp_connection_lifetime=3605
 
####### Custom Parameters #########
 
# These parameters can be modified runtime via RPC interface
# - see the documentation of 'cfg_rpc' module.
#
# Format: group.id = value 'desc' description
# Access: $sel(cfg_get.group.id) or @cfg_get.group.id
#
 
#!ifdef WITH_PSTN
# PSTN GW Routing
#
# - pstn.gw_ip: valid IP or hostname as string value, example:
# pstn.gw_ip = "10.0.0.101" desc "My PSTN GW Address"
#
# - by default is empty to avoid misrouting
pstn.gw_ip = "" desc "PSTN GW Address"
#!endif
 
#!ifdef WITH_VOICEMAIL
# VoiceMail Routing on offline, busy or no answer
#
# - by default Voicemail server IP is empty to avoid misrouting
voicemail.srv_ip = "" desc "VoiceMail IP Address"
voicemail.srv_port = "5060" desc "VoiceMail Port"
#!endif
 
#!ifdef WITH_FREESWITCH
freeswitch.bindip = "192.168.178.23" desc "FreeSWITCH IP Address"
freeswitch.bindport = "5090" desc "FreeSWITCH Port"
#!endif
 
####### Modules Section ########
 
# set paths to location of modules (to sources or installation folders)
#!ifdef WITH_SRCPATH
mpath="modules_k:modules"
#!else
mpath="/usr/local/lib/kamailio/modules_k/:/usr/local/lib/kamailio/modules/"
#!endif
 
#!ifdef WITH_MYSQL
loadmodule "db_mysql.so"
#!endif
 
loadmodule "mi_fifo.so"
loadmodule "kex.so"
loadmodule "tm.so"
loadmodule "tmx.so"
loadmodule "sl.so"
loadmodule "rr.so"
loadmodule "pv.so"
loadmodule "maxfwd.so"
loadmodule "usrloc.so"
loadmodule "registrar.so"
loadmodule "textops.so"
loadmodule "siputils.so"
loadmodule "xlog.so"
loadmodule "sanity.so"
loadmodule "ctl.so"
loadmodule "cfg_rpc.so"
loadmodule "mi_rpc.so"
loadmodule "acc.so"
 
#!ifdef WITH_AUTH
loadmodule "auth.so"
loadmodule "auth_db.so"
#!ifdef WITH_IPAUTH
loadmodule "permissions.so"
#!endif
#!endif
 
#!ifdef WITH_ALIASDB
loadmodule "alias_db.so"
#!endif
 
#!ifdef WITH_SPEEDDIAL
loadmodule "speeddial.so"
#!endif
 
#!ifdef WITH_MULTIDOMAIN
loadmodule "domain.so"
#!endif
 
#!ifdef WITH_PRESENCE
loadmodule "presence.so"
loadmodule "presence_xml.so"
#!endif
 
#!ifdef WITH_NAT
loadmodule "nathelper.so"
loadmodule "rtpproxy.so"
#!endif
 
#!ifdef WITH_TLS
loadmodule "tls.so"
#!endif
 
#!ifdef WITH_ANTIFLOOD
loadmodule "htable.so"
loadmodule "pike.so"
#!endif
 
#!ifdef WITH_XMLRPC
loadmodule "xmlrpc.so"
#!endif
 
#!ifdef WITH_DEBUG
loadmodule "debugger.so"
#!endif
 
# ----------------- setting module-specific parameters ---------------
 
 
# ----- mi_fifo params -----
modparam("mi_fifo", "fifo_name", "/tmp/kamailio_fifo")
 
 
# ----- tm params -----
# auto-discard branches from previous serial forking leg
modparam("tm", "failure_reply_mode", 3)
# default retransmission timeout: 30sec
modparam("tm", "fr_timer", 30000)
# default invite retransmission timeout after 1xx: 120sec
modparam("tm", "fr_inv_timer", 120000)
 
 
# ----- rr params -----
# add value to ;lr param to cope with most of the UAs
modparam("rr", "enable_full_lr", 1)
# do not append from tag to the RR (no need for this script)
modparam("rr", "append_fromtag", 0)
 
 
# ----- registrar params -----
modparam("registrar", "method_filtering", 1)
/* uncomment the next line to disable parallel forking via location */
# modparam("registrar", "append_branches", 0)
/* uncomment the next line not to allow more than 10 contacts per AOR */
#modparam("registrar", "max_contacts", 10)
# max value for expires of registrations
modparam("registrar", "max_expires", 3600)
# set it to 1 to enable GRUU
modparam("registrar", "gruu_enabled", 0)
 
 
# ----- acc params -----
/* what special events should be accounted ? */
modparam("acc", "early_media", 0)
modparam("acc", "report_ack", 0)
modparam("acc", "report_cancels", 0)
/* by default ww do not adjust the direct of the sequential requests.
   if you enable this parameter, be sure the enable "append_fromtag"
   in "rr" module */
modparam("acc", "detect_direction", 0)
/* account triggers (flags) */
modparam("acc", "log_flag", FLT_ACC)
modparam("acc", "log_missed_flag", FLT_ACCMISSED)
modparam("acc", "log_extra", 
	"src_user=$fU;src_domain=$fd;src_ip=$si;"
	"dst_ouser=$tU;dst_user=$rU;dst_domain=$rd")
modparam("acc", "failed_transaction_flag", FLT_ACCFAILED)
/* enhanced DB accounting */
#!ifdef WITH_ACCDB
modparam("acc", "db_flag", FLT_ACC)
modparam("acc", "db_missed_flag", FLT_ACCMISSED)
modparam("acc", "db_url", DBURL)
modparam("acc", "db_extra",
	"src_user=$fU;src_domain=$fd;src_ip=$si;"
	"dst_ouser=$tU;dst_user=$rU;dst_domain=$rd")
#!endif
 
 
# ----- usrloc params -----
/* enable DB persistency for location entries */
#!ifdef WITH_USRLOCDB
modparam("usrloc", "db_url", DBURL)
modparam("usrloc", "db_mode", 2)
modparam("usrloc", "use_domain", MULTIDOMAIN)
#!endif
 
 
# ----- auth_db params -----
#!ifdef WITH_AUTH
modparam("auth_db", "db_url", DBURL)
modparam("auth_db", "calculate_ha1", yes)
modparam("auth_db", "password_column", "password")
modparam("auth_db", "load_credentials", "")
modparam("auth_db", "use_domain", MULTIDOMAIN)
 
# ----- permissions params -----
#!ifdef WITH_IPAUTH
modparam("permissions", "db_url", DBURL)
modparam("permissions", "db_mode", 1)
#!endif
 
#!endif
 
 
# ----- alias_db params -----
#!ifdef WITH_ALIASDB
modparam("alias_db", "db_url", DBURL)
modparam("alias_db", "use_domain", MULTIDOMAIN)
#!endif
 
 
# ----- speedial params -----
#!ifdef WITH_SPEEDDIAL
modparam("speeddial", "db_url", DBURL)
modparam("speeddial", "use_domain", MULTIDOMAIN)
#!endif
 
 
# ----- domain params -----
#!ifdef WITH_MULTIDOMAIN
modparam("domain", "db_url", DBURL)
# register callback to match myself condition with domains list
modparam("domain", "register_myself", 1)
#!endif
 
 
#!ifdef WITH_PRESENCE
# ----- presence params -----
modparam("presence", "db_url", DBURL)
 
# ----- presence_xml params -----
modparam("presence_xml", "db_url", DBURL)
modparam("presence_xml", "force_active", 1)
#!endif
 
 
#!ifdef WITH_NAT
# ----- rtpproxy params -----
modparam("rtpproxy", "rtpproxy_sock", "udp:127.0.0.1:7722")
 
# ----- nathelper params -----
modparam("nathelper", "natping_interval", 30)
modparam("nathelper", "ping_nated_only", 1)
modparam("nathelper", "sipping_bflag", FLB_NATSIPPING)
modparam("nathelper", "sipping_from", "sip:pinger@kamailio.org")
 
# params needed for NAT traversal in other modules
modparam("nathelper|registrar", "received_avp", "$avp(RECEIVED)")
modparam("usrloc", "nat_bflag", FLB_NATB)
#!endif
 
 
#!ifdef WITH_TLS
# ----- tls params -----
modparam("tls", "config", "/usr/local/etc/kamailio/tls.cfg")
#!endif
 
#!ifdef WITH_ANTIFLOOD
# ----- pike params -----
modparam("pike", "sampling_time_unit", 2)
modparam("pike", "reqs_density_per_unit", 16)
modparam("pike", "remove_latency", 4)
 
# ----- htable params -----
# ip ban htable with autoexpire after 5 minutes
modparam("htable", "htable", "ipban=>size=8;autoexpire=300;")
#!endif
 
#!ifdef WITH_XMLRPC
# ----- xmlrpc params -----
modparam("xmlrpc", "route", "XMLRPC");
modparam("xmlrpc", "url_match", "^/RPC")
#!endif
 
#!ifdef WITH_DEBUG
# ----- debugger params -----
modparam("debugger", "cfgtrace", 1)
#!endif
 
####### Routing Logic ########
 
 
# Main SIP request routing logic
# - processing of any incoming SIP request starts with this route
# - note: this is the same as route { ... }
request_route {
 
	# per request initial checks
	route(REQINIT);
 
	# NAT detection
	route(NATDETECT);
 
	# CANCEL processing
	if (is_method("CANCEL"))
	{
		if (t_check_trans())
			t_relay();
		exit;
	}
 
	# handle requests within SIP dialogs
	route(WITHINDLG);
 
	### only initial requests (no To tag)
 
	t_check_trans();
 
	# authentication
	route(AUTH);
 
	# record routing for dialog forming requests (in case they are routed)
	# - remove preloaded route headers
	remove_hf("Route");
	if (is_method("INVITE|SUBSCRIBE"))
		record_route();
 
	# account only INVITEs
	if (is_method("INVITE"))
	{
		setflag(FLT_ACC); # do accounting
	}
 
	# dispatch requests to foreign domains
	route(SIPOUT);
 
	### requests for my local domains
 
	# handle presence related requests
	route(PRESENCE);
 
	# handle registrations
	route(REGISTRAR);
 
	if ($rU==$null)
	{
		# request with no Username in RURI
		sl_send_reply("484","Address Incomplete");
		exit;
	}
 
	# dispatch destinations to PSTN
	route(PSTN);
 
	#!ifdef WITH_FREESWITCH
	# save callee ID
	$avp(callee) = $rU;
	route(FSDISPATCH);
	#!endif
 
	# user location service
	route(LOCATION);
 
	route(RELAY);
}
 
 
route[RELAY] {
 
	# enable additional event routes for forwarded requests
	# - serial forking, RTP relaying handling, a.s.o.
#!ifdef WITH_CFGSAMPLES
	if (is_method("INVITE|SUBSCRIBE")) {
		t_on_branch("MANAGE_BRANCH");
		t_on_reply("MANAGE_REPLY");
	}
	if (is_method("INVITE")) {
		t_on_failure("MANAGE_FAILURE");
	}
#!endif
	if (!t_relay()) {
		sl_reply_error();
	}
	exit;
}
 
# Per SIP request initial checks
route[REQINIT] {
#!ifdef WITH_ANTIFLOOD
	# flood dection from same IP and traffic ban for a while
	# be sure you exclude checking trusted peers, such as pstn gateways
	# - local host excluded (e.g., loop to self)
	if(src_ip!=myself)
	{
		if($sht(ipban=>$si)!=$null)
		{
			# ip is already blocked
			xdbg("request from blocked IP - $rm from $fu (IP:$si:$sp)\n");
			exit;
		}
		if (!pike_check_req())
		{
			xlog("L_ALERT","ALERT: pike blocking $rm from $fu (IP:$si:$sp)\n");
			$sht(ipban=>$si) = 1;
			exit;
		}
	}
#!endif
 
	if (!mf_process_maxfwd_header("10")) {
		sl_send_reply("483","Too Many Hops");
		exit;
	}
 
	if(!sanity_check("1511", "7"))
	{
		xlog("Malformed SIP message from $si:$sp\n");
		exit;
	}
}
 
# Handle requests within SIP dialogs
route[WITHINDLG] {
	if (has_totag()) {
		# sequential request withing a dialog should
		# take the path determined by record-routing
		if (loose_route()) {
			route(DLGURI);
			if (is_method("BYE")) {
				setflag(FLT_ACC); # do accounting ...
				setflag(FLT_ACCFAILED); # ... even if the transaction fails
			}
			else if ( is_method("ACK") ) {
				# ACK is forwarded statelessy
				route(NATMANAGE);
			}
			else if ( is_method("NOTIFY") ) {
				# Add Record-Route for in-dialog NOTIFY as per RFC 6665.
				record_route();
			}
			route(RELAY);
		} else {
			if (is_method("SUBSCRIBE") && uri == myself) {
				# in-dialog subscribe requests
				route(PRESENCE);
				exit;
			}
			if ( is_method("ACK") ) {
				if ( t_check_trans() ) {
					# no loose-route, but stateful ACK;
					# must be an ACK after a 487
					# or e.g. 404 from upstream server
					t_relay();
					exit;
				} else {
					# ACK without matching transaction ... ignore and discard
					exit;
				}
			}
			sl_send_reply("404","Not here");
		}
		exit;
	}
}
 
# Handle SIP registrations
route[REGISTRAR] {
	if (is_method("REGISTER"))
	{
		if(isflagset(FLT_NATS))
		{
			setbflag(FLB_NATB);
			# uncomment next line to do SIP NAT pinging 
			## setbflag(FLB_NATSIPPING);
		}
		if (!save("location"))
			sl_reply_error();
 
		exit;
	}
}
 
# USER location service
route[LOCATION] {
 
#!ifdef WITH_SPEEDIAL
	# search for short dialing - 2-digit extension
	if($rU=~"^[0-9][0-9]$")
		if(sd_lookup("speed_dial"))
			route(SIPOUT);
#!endif
 
#!ifdef WITH_ALIASDB
	# search in DB-based aliases
	if(alias_db_lookup("dbaliases"))
		route(SIPOUT);
#!endif
 
	$avp(oexten) = $rU;
	if (!lookup("location")) {
		$var(rc) = $rc;
		route(TOVOICEMAIL);
		t_newtran();
		switch ($var(rc)) {
			case -1:
			case -3:
				send_reply("404", "Not Found");
				exit;
			case -2:
				send_reply("405", "Method Not Allowed");
				exit;
		}
	}
 
	# when routing via usrloc, log the missed calls also
	if (is_method("INVITE"))
	{
		setflag(FLT_ACCMISSED);
	}
}
 
# Presence server route
route[PRESENCE] {
	if(!is_method("PUBLISH|SUBSCRIBE"))
		return;
 
#!ifdef WITH_PRESENCE
	if (!t_newtran())
	{
		sl_reply_error();
		exit;
	};
 
	if(is_method("PUBLISH"))
	{
		handle_publish();
		t_release();
	}
	else
	if( is_method("SUBSCRIBE"))
	{
		handle_subscribe();
		t_release();
	}
	exit;
#!endif
 
	# if presence enabled, this part will not be executed
	if (is_method("PUBLISH") || $rU==$null)
	{
		sl_send_reply("404", "Not here");
		exit;
	}
	return;
}
 
# Authentication route
route[AUTH] {
#!ifdef WITH_AUTH
 
#!ifdef WITH_IPAUTH
	if((!is_method("REGISTER")) && allow_source_address())
	{
		# source IP allowed
		return;
	}
#!endif
 
#!ifdef WITH_FREESWITCH
	if(route(FSINBOUND))
		return;
#!endif
 
	if (is_method("REGISTER") || from_uri==myself)
	{
		# authenticate requests
		if (!auth_check("$fd", "subscriber", "1")) {
			auth_challenge("$fd", "0");
			exit;
		}
		# user authenticated - remove auth header
		if(!is_method("REGISTER|PUBLISH"))
			consume_credentials();
	}
	# if caller is not local subscriber, then check if it calls
	# a local destination, otherwise deny, not an open relay here
	if (from_uri!=myself && uri!=myself)
	{
		sl_send_reply("403","Not relaying");
		exit;
	}
 
#!endif
	return;
}
 
# Caller NAT detection route
route[NATDETECT] {
#!ifdef WITH_NAT
	force_rport();
	if (nat_uac_test("19")) {
		if (is_method("REGISTER")) {
			fix_nated_register();
		} else {
			add_contact_alias();
		}
		setflag(FLT_NATS);
	}
#!endif
	return;
}
 
# RTPProxy control
route[NATMANAGE] {
#!ifdef WITH_NAT
	if (is_request()) {
		if(has_totag()) {
			if(check_route_param("nat=yes")) {
				setbflag(FLB_NATB);
			}
		}
	}
	if (!(isflagset(FLT_NATS) || isbflagset(FLB_NATB)))
		return;
 
	rtpproxy_manage();
 
	if (is_request()) {
		if (!has_totag()) {
			add_rr_param(";nat=yes");
		}
	}
	if (is_reply()) {
		if(isbflagset(FLB_NATB)) {
			add_contact_alias();
		}
	}
#!endif
	return;
}
 
# URI update for dialog requests
route[DLGURI] {
#!ifdef WITH_NAT
	if(!isdsturiset()) {
		handle_ruri_alias();
	}
#!endif
	return;
}
 
# Routing to foreign domains
route[SIPOUT] {
	if (!uri==myself)
	{
		append_hf("P-hint: outbound\r\n");
		route(RELAY);
	}
}
 
# PSTN GW routing
route[PSTN] {
#!ifdef WITH_PSTN
	# check if PSTN GW IP is defined
	if (strempty($sel(cfg_get.pstn.gw_ip))) {
		xlog("SCRIPT: PSTN rotuing enabled but pstn.gw_ip not defined\n");
		return;
	}
 
	# route to PSTN dialed numbers starting with '+' or '00'
	#     (international format)
	# - update the condition to match your dialing rules for PSTN routing
	if(!($rU=~"^(\+|00)[1-9][0-9]{3,20}$"))
		return;
 
	# only local users allowed to call
	if(from_uri!=myself) {
		sl_send_reply("403", "Not Allowed");
		exit;
	}
 
	$ru = "sip:" + $rU + "@" + $sel(cfg_get.pstn.gw_ip);
 
	route(RELAY);
	exit;
#!endif
 
	return;
}
 
# XMLRPC routing
#!ifdef WITH_XMLRPC
route[XMLRPC] {
	# allow XMLRPC from localhost
	if ((method=="POST" || method=="GET")
			&& (src_ip==127.0.0.1)) {
		# close connection only for xmlrpclib user agents (there is a bug in
		# xmlrpclib: it waits for EOF before interpreting the response).
		if ($hdr(User-Agent) =~ "xmlrpclib")
			set_reply_close();
		set_reply_no_connect();
		dispatch_rpc();
		exit;
	}
	send_reply("403", "Forbidden");
	exit;
}
#!endif
 
# route to voicemail server
route[TOVOICEMAIL] {
#!ifdef WITH_VOICEMAIL
	if(!is_method("INVITE"))
		return;
 
	# check if VoiceMail server IP is defined
	if (strempty($sel(cfg_get.voicemail.srv_ip))) {
		xlog("SCRIPT: VoiceMail rotuing enabled but IP not defined\n");
		return;
	}
	if($avp(oexten)==$null)
		return;
 
	$ru = "sip:" + $avp(oexten) + "@" + $sel(cfg_get.voicemail.srv_ip)
				+ ":" + $sel(cfg_get.voicemail.srv_port);
	route(RELAY);
	exit;
#!endif
 
	return;
}
 
#!ifdef WITH_FREESWITCH
# FreeSWITCH routing blocks
route[FSINBOUND] {
	if($si== $sel(cfg_get.freeswitch.bindip)
			&& $sp==$sel(cfg_get.freeswitch.bindport))
		return 1;
	return -1;
}
 
route[FSDISPATCH] {
	if(!is_method("INVITE"))
		return;
	if(route(FSINBOUND))
		return;
 
	# dial number selection
	switch($rU) {
		case /"^41$":
			# 41 - voicebox menu
			# allow only authenticated users
			if($au==$null)
			{
				sl_send_reply("403", "Not allowed");
				exit;
			}
			$rU = "vm-" + $au;
		break;
		case /"^441[0-9][0-9]$":
			# starting with 44 folowed by 1XY - direct call to voice box
			strip(2);
			route(FSVBOX);
		break;
		case /"^433[01][0-9][0-9]$":
			# starting with 433 folowed by (0|1)XY - conference
			strip(2);
		break;
		case /"^45[0-9]+$":
			strip(2);
		break;
		default:
			# offline - send to voicebox
			if (!registered("location"))
			{
				route(FSVBOX);
				exit;
			}
			# online - do bridging
			prefix("kb-");
			if(is_method("INVITE"))
			{
				# in case of failure - re-route to FreeSWITCH VoiceMail
				t_on_failure("FAIL_FSVBOX");
			}
	}
	route(FSRELAY);
	exit;
}
 
route[FSVBOX] {
	if(!($rU=~"^1[0-9][0-9]+$"))
		return;
	prefix("vb-");
	route(FSRELAY);
}
 
# Send to FreeSWITCH
route[FSRELAY] {
	$du = "sip:" + $sel(cfg_get.freeswitch.bindip) + ":"
			+ $sel(cfg_get.freeswitch.bindport);
	route(RELAY);
	exit;
}
 
#!endif
 
 
# manage outgoing branches
branch_route[MANAGE_BRANCH] {
	xdbg("new branch [$T_branch_idx] to $ru\n");
	route(NATMANAGE);
}
 
# manage incoming replies
onreply_route[MANAGE_REPLY] {
	xdbg("incoming reply\n");
	if(status=~"[12][0-9][0-9]")
		route(NATMANAGE);
}
 
# manage failure routing cases
failure_route[MANAGE_FAILURE] {
	route(NATMANAGE);
 
	if (t_is_canceled()) {
		exit;
	}
 
#!ifdef WITH_BLOCK3XX
	# block call redirect based on 3xx replies.
	if (t_check_status("3[0-9][0-9]")) {
		t_reply("404","Not found");
		exit;
	}
#!endif
 
#!ifdef WITH_VOICEMAIL
	# serial forking
	# - route to voicemail on busy or no answer (timeout)
	if (t_check_status("486|408")) {
		route(TOVOICEMAIL);
		exit;
	}
#!endif
}
 
#!ifdef WITH_FREESWITCH
failure_route[FAIL_FSVBOX] {
#!ifdef WITH_NAT
	if (is_method("INVITE")
			&& (isbflagset(FLB_NATB) || isflagset(FLT_NATS))) {
		unforce_rtp_proxy();
	}
#!endif
 
	if (t_is_canceled()) {
		exit;
	}
 
	if (t_check_status("486|408")) {
		# re-route to FreeSWITCH VoiceMail
		$rU = $avp(callee);
		route(FSVBOX);
	}
}
#!endif

SIP Users

Be sure you updated /usr/local/etc/kamailio/kamctlrc and you set properly SIP_DOMAIN and DBENGINE:

...
SIP_DOMAIN=192.168.178.23      # IP address or hostname for Kamailio
...
DBENGINE=MYSQL
...

Create some test users in Kamailio with kamctl:

kamctl add userid password email

kamctl add 101 101 101@mysipserver.com
kamctl add 102 102 102@mysipserver.com
kamctl add 103 103 103@mysipserver.com

Config Remarks

Generic Updates

arming of default failure_route, branch_route and onreply_route in route[RELAY] is wrapped around '#!ifdef CFGEXAMPLES', calls being directed now to FreeSwitch that can do RTP relaying for natted phones, but you can enabled them and be sure you combine the two failure_route blocks (one being added for freeswitch)

Routing to FreeSWITCH:

dial 41 to listen to your voice mail service
dial 44XYZ (e.g., 44101) to leave a message for user XYZ
dial 4330XY or 4331XY to dial in 30XY or 31XY conference rooms on FreeSWITCH
dial 45EXTEN to call extension EXTEN on FreeSWITCH (e.g., 459995 calls to 9995 on FreeSWITCH, which is echo service in default dialplan)
if dialed user is offline, call is sent to callee's voice mail box on FreeSWITCH
if dialed user is online, its extensions is prefixed with kb- and then sent to FreeSwitch, which will send it back to Kamailio after acting as SBC and media relay
calls coming from FreeSwitch are not authenticated again, they are handled via location service and forwarded
if callee does not answer or sends back busy, call is sent to callee's voice mail box on FreeSWITCH

To define the IP address and port, update the custom global parameters in class freeswitch:

#!ifdef WITH_FREESWITCH
freeswitch.bindip = "192.168.178.23" desc "FreeSWITCH IP Address"
freeswitch.bindport = "5090" desc "FreeSWITCH Port"
#!endif

FreeSWITCH Configuration

Installation

First install Lua and its development library packages, then just do the standard FreeSWITCH installation, a tutorial is available at:

http://wiki.freeswitch.org/wiki/Installation_Guide

In Debian stable, installing Lua development library package is done with the command:

apt-get install liblua5.1-0-dev

Config Files

SIP

Since this tutorial uses same IP but different ports, update your SIP profiles setting, setting the port accordingly.

Internal profiles:

<param name="sip-port" value="5090"/>

External profile:

<param name="sip-port" value="5092"/>

Also, for internal profile, disable call authentication. SIP traffic from Kamailio will be trusted and verified by ACL.

<param name="auth-calls" value="false"/>

ACL

Update ACL to allow traffic from Kamailio IP, edit conf/autoload_configs/acl.conf.xml and add to domains list:

       <node type="allow" cidr="192.168.178.23/32"/>

After that should look like:

     <list name="domains" default="deny">
       <node type="allow" domain="$${domain}"/>
       <node type="allow" cidr="192.168.178.23/32"/>
     </list>

Dialplan

First direct the SIP traffic sent by Kamailio from public to default, edit conf/dialplan/public.xml and add:

    <extension name="from_kamailio">
      <condition field="network_addr" expression="^192\.168\.178\.23$" />
      <condition field="destination_number" expression="^(.+)$">
        <action application="transfer" data="$1 XML default"/>
      </condition>
    </extension>

Then in conf/dialplan/default.xml, add new extensions for handling calls to Voice Box services and routing calls back to Kamailio:

    <extension name="vbox">
      <condition field="destination_number" expression="^vb-(1[0-9][0-9])$">
	    <action application="answer"/>
	    <action application="voicemail" data="default ${domain_name} $1"/>
      </condition>
    </extension>
 
    <extension name="vmenu">
      <condition field="destination_number" expression="^vm-(1[0-9][0-9])$">
	    <action application="voicemail" data="check default ${domain_name} $1"/>
      </condition>
    </extension>
 
    <extension name="kbridge">
      <condition field="destination_number" expression="^kb-(.+)$">
		  <action application="set" data="proxy_media=true"/>
		  <action application="set" data="call_timeout=50"/>
		  <action application="set" data="continue_on_fail=true"/>
		  <action application="set" data="hangup_after_bridge=true"/>
		  <action application="set" data="sip_invite_domain=192.168.178.23"/>
		  <action application="export" data="sip_contact_user=ufs"/>
		  <action application="bridge" data="sofia/$${domain}/$1@192.168.178.23"/>
		  <action application="answer"/>
		  <action application="voicemail" data="default ${domain_name} $1"/>
      </condition>
    </extension>

First extension is to leave a voice message to callee. Second is to listen to caller's voice messages.

The third is to loop back calls to Kamailio. This is important at least for NAT traversal over symmetric NAT routes. If the call is not answered, will be directed to voicemail after 50 seconds. This is the part where you can add more SBC-like functions, e.g., enforce specific codecs, call prepaid application, play audio during early session.

User Directory

To generate the directory file with the user profile, this time, comparing with previous tutorials in this series, we use a Lua script that connects to Kamailio database and fetches the attributes from subscriber table.

Adding Columns to Kamailio's Subscriber Table

First we have to add a new column to Kamailio's subscriber table where to store the pin for accessing the voicemail box:

ALTER TABLE subscriber ADD COLUMN vmpin VARCHAR(8) NOT NULL DEFAULT "1234";

Also, if you want voicemail notifications via email, be sure you set the value of the column 'email_address' for each subscriber.

Lua Script

The content of the Lua script to build user's XML directory file is:

-- comment the following line for production:
freeswitch.consoleLog("notice", "===== Provided params:\n" .. params:serialize() .. "\n")
 
local req_user   = params:getHeader("user")
local req_domain = params:getHeader("domain")
local req_key    = params:getHeader("key")
 
if req_domain==nil or req_key==nil or req_user==nil then
  freeswitch.consoleLog("notice","===== Mising headers - not an event we are looking for!\n")
  return
end
 
--MySQL database connection
require "luasql.mysql"
env = assert (luasql.mysql())
con = assert (env:connect("kamailio", "openser", "openserrw"))
 
cur = assert (con:execute ("SELECT username, domain, email_address, vmpin FROM subscriber WHERE username='" .. req_user .. "' LIMIT 1" ))
 
-- print all rows, the rows will be indexed by field names
row = cur:fetch ({}, "a")
 
if not row then
	freeswitch.consoleLog("notice","===== User not found " .. req_user .. "!\n")
	return
end
 
 
XML_STRING =
[[<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<document type="freeswitch/xml">
  <section name="directory">
    <domain name="]] .. req_domain .. [[">
      <user id="]] .. req_user .. [[" mailbox="]] .. req_user .. [[">
        <params>
          <param name="vm-email-all-messages" value="true"/>
          <param name="vm-mailto" value="]] .. row.email_address .. [["/>
          <param name="vm-mailfrom" value="voicemail@myservice.com"/>
          <param name="vm-password" value="]] .. row.vmpin .. [["/>
        </params>
        <variables>
          <variable name="user_context" value="default"/>
        </variables>
      </user>
    </domain>
  </section>
</document>]]
 
-- comment the following line for production:
freeswitch.consoleLog("notice", "===== Generated XML:\n" .. XML_STRING .. "\n")
 
-- close everything
cur:close()
con:close()
env:close()

Save the content in the file '/usr/local/freeswitch/scripts/sqluser.lua'. You have to update the value of the parameter 'vm-mailfrom' to your desired email address to be used by voicemail notification service.

This script uses Lua SQL package to connect to Kamailio's MySQL database server, you have to install it, in Debian stable, the command is:

apt-get install liblua5.1-sql-mysql-2

Note that this script is just for loading user profile, you need to extend it if you want to update back to database the pin code value based on changes done with IVR (planned for next releases of this tutorial). Or have a web management interface that allows the users to change the pin code from there.

Lua Module Configuration

In '/usr/local/freeswitch/config/autoload_configs/lua.conf.xml', set:

    <param name="module-directory" value="/usr/lib/lua/5.1/?.so"/>
 
    <param name="xml-handler-script" value="/usr/local/freeswitch/scripts/sqluser.lua"/>
    <param name="xml-handler-bindings" value="directory"/>

Voicebox Email Notifications

There seems to be a problem with exim4 and FreeSwitch on Debian for voicebox email notifications. See more at:

http://wiki.freeswitch.org/wiki/Mod_voicemail#Exim4_settings

In that wiki page you find some alternatives. My option, as user of Debian stable and exim4, was to install msmtp and use it in FreeSwitch to relay to local exim4.

apt-get install msmtp

The config file in /etc/msmtprc is:

account default
host 127.0.0.1
syslog LOG_MAIL

exim4 is configured to accept emails from localhost without asking for username and password (default on exim4 to allow local processing to send email notifications).

You have to set msmtp as mailer application in 'config/autoload_configs/switch.conf.xml':

<param name="mailer-app" value="msmtp"/>

Testing

Once you have installed and configured kamailio and freeswitch, configure some phones with users 101, 102 and 103 to register with Kamailio.

The start calling between them:

if you answer, call is connected, you should have voice
if you reject, caller should get to callee's voice box
if you don't answer, caller should get to callee's voice bos

Call into a conference: dial 433001 from your phones.

Leave a voice message to user 101: dial 44101

Listen your voice messages: dial 41

Asipto - SIP and VoIP Knowledge Base Site

Sidebar

Table of Contents

Kamailio 3.3.x and FreeSWITCH 1.2.x for Media Services and SBC

Overview

Updates

Call Initiation

Kamailio Configuration

Installation

Config File

SIP Users

Config Remarks

FreeSWITCH Configuration

Installation

Config Files

SIP

ACL

Dialplan

User Directory

Adding Columns to Kamailio's Subscriber Table

Lua Script

Lua Module Configuration

Voicebox Email Notifications

Testing

See Also

Asipto - SIP and VoIP Knowledge Base Site

User Tools

Site Tools

Sidebar

Table of Contents

Kamailio 3.3.x and FreeSWITCH 1.2.x for Media Services and SBC

Overview

Updates

Call Initiation

Kamailio Configuration

Installation

Config File

SIP Users

Config Remarks

FreeSWITCH Configuration

Installation

Config Files

SIP

ACL

Dialplan

User Directory

Adding Columns to Kamailio's Subscriber Table

Lua Script

Lua Module Configuration

Voicebox Email Notifications

Testing

See Also

Page Tools