Kamailio 5.2.x и FreeSWITCH 1.8.x как Media Server и SBC

Перевод и адаптация к актуальным версиям Kamailio 5.2.x и FreeSWITCH 1.8.x
Оригинальный текст: http://kb.asipto.com/freeswitch:kamailio-3.3.x-freeswitch-1.2.x-sbc

Ключевые изменения:

  • из kamailio.cfg удалена загрузка модулей mi_fifo и mi_rpc, т.к. они не используются с версии 4.0.х.
  • lua скрипт для FS переписан с использованием lua DBh вместо luasql. (оригинальный скрипт под катом)

Цель данного руководства - создание полноценной SIP/VoIP платформы для обслуживания большого кол-ва вызовов, при помощи Kamailio и Freeswitch.

Kamailio это open source SIP сервер отделившийся от SIP Express Router (SER) в 2005-м году, под именем OpenSER. В июле 2008, OpenSER был переименован в Kamailio потому что торговая марка была занята.
Начиная с ноября 2008 года, Kamailio и SER объединили разработку, в результате чего появилясь версия 3.0.0.

Одно из главных достоинств Kamailio, это возможность обслуживания большого кол-ва пользователей на одном сервере (в зависимости от железа, это может быть 100 000+ активных регистраций).
Длительный срок разработки обеспечивает необходимую стабильность для телекоммуникаций в реальном времени и широкий набор функций при обработке SIP сигнализации.

Freeswitch это open source softswitch с поддержкой множества протоколов, в том числе и SIP. Это очень привлекательный проект с точки зрения обработки медиа, что делает его прекрасным выбором для предоставления медиа сервисов в платформах основанных на Kamailio.

Следующие сценарии могут быть реализованы при помощи данного руководства:

  • kamailio
    • user authentication
    • user registration
    • user location
    • call routing
    • instant messaging and presence
  • freeswitch
    • voicemail
    • conference
    • SBC - используется для сокрытия топологии сети, перекодирования, предоплаты или восроизвединия аудио сообщения при обработке вызовов.
    • другие медиа сервисы (announcement, ivr, и тд)

Локальные пользователи имеют 3-х значные ID ( 101, 102 и 103 и тд).
ID голосовых ящиков такие же, как ID пользователей.
Расширения медиа сервисов 4-х значные.

Kamailio и FreeSWITCH установлены на одном физическом сервере (ip 192.168.178.23), используют разные порты:

  • kamailio: порт 5060 SIP сигнализации
  • freeswitch: порт 5090 для профиля internal и 5092 для профиля external.

Инициация вызовов

Аутентификация пользователей выполняется Kamailio. Когда вызов пришел и аутентифицирован то:

  • если вызываемый пользователь офлайн, то вызов перенаправляется на голосовую почту Freeswitch.
  • если пользователь онлайн, то Kamailio также отравляет его на Freeswitch для реализации специфических медиа функций, таких как, воспроизведение аудио во время вызова, ограничение продолжительности вызова, согласования и перекодировки кодеков и тд.

Установка

Пошаговая инструкция по установке Kamailio 5.2.x:

Kamailio v5.2 - Install Guide

Вы можете использовать MySQL, как в приведенном примере или другой более предпочтительной для вас базой данных, это не принципиально. Но если вы выберете другой тип бд, позаботьтесь о его настройке в конфигурационном файле Kamailio.

FreeSWITCH и Kamailio в данной инсталяции, сделаны, как можно более независимыми друг от друга.

Конфигурационный файл

Kamailio имеет один конфигурационный файл по умолчанию - kamailio.cfg. Начиная с версии 3.0.0 возможно распределять настройки по разным файлам и при помощи директивы include_file объединять их в главном конфигурационном файле.

Другая важная фича введенная с версии 3.0.0 это директива define позволяющая запросто включать и выключать функции.
Данная концепция используется и в этом руководстве для интеграции с Freeswitch - WITH_FREESWITCH, т.е. часть настроек между #!ifdef WITH_FREESWITCH … #!endif.

kamailio.cfg

kamailio.cfg

#!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 "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 "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 ---------------
 
# ----- 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

Задайте SIP_DOMAIN и DBENGINE опции в /usr/local/etc/kamailio/kamctlrc

...
SIP_DOMAIN=192.168.178.23      # IP address или hostname для Kamailio
...
DBENGINE=MYSQL
...

Добавьте пользователей (subscribers) Kamailio при помощи 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

Пояснения по конфигу

Общие изменения

Включенные по умолчанию failure_route, branch_route и onreply_route обусловлены !ifdef CFGEXAMPLES т.к. вызовы теперь направляются на Freeswitch, но вы можете включить их, если будете уверены, что они корректно скомбинированы с failure_route добавленным для freeswitch.

!ifdef WITH_FREESWITCH

!ifdef WITH_FREESWITCH

#!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

Маршрутизация на Freeswitch:

  • 41 - прослушить свою голосовую почту
  • 44XYZ – (например 44101) оставить голосовое сообщение XYZ
  • 4330XY или 4331XY вызов телеконференций 30XY или 31XY на FreeSWITCH
  • 45EXTEN вызов расширения (extension) на FreeSWITCH (например, 459995 вызовет 9995 на FreeSWITCH (код эхо сервиса в диалплане по умолчанию)
  • если вызываемый пользователь офлайн вызов перенаправляется на его голосовую почту FreeSWITCH
  • если вызываемый пользователь онлайн, то вызов получает префикс kb- и тоже отправляется на FS,который в свою очередь возвращает его Kamailio, выполнив свои функции, такие как SBC и медиа ретранслятора.
  • вызовы возвращенные FS не аутентифицируются опять. Они обрабатываются при помощи службы location и отправляются адресатам
  • если же вызываемый не отвечает или занят, то вызов отправляется на голосовую почту FreeSWITCH

Назначение IP адреса и порта в пользовательских глобальных параметрах класса freeswitch

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

Установка

Установите Lua и библиотеки разработчика lua.
Они также устанавливаются при инсталяции Freeswitch
когда выполняется команда:

 apt-get build-dep freeswitch

В Debian вы можете установить их:

apt-get install lua5.2 liblua5.2-dev

Конфигурационные файлы

SIP

Назначим уникальные порты для SIP профилей FS:

Internal profile:

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

External profile:

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

Также для профиля internal выключим аутентификацию вызовов. SIP трафик из Kamailio будет проверяться по ACL.

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

ACL

Разрешим трафик из Kamailio без аутентификации при помощи ACL в conf/autoload_configs/acl.conf.xml добавив в domains список (list):

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

Что в итоге будет выглядеть так:

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

Dialplan

Сперва направим трафик принимаемый FS от Kamailio из контекста public в контекст default, отредактировав для этого дефолтный публичный контекст (например, ../conf/dialplan/public.xml)следующим образом:

    <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>

А в ../conf/dialplan/default.xml, добавим новый екстеншен для обработки вызовов на голосовую почту и возврата на 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>
  • Екстеншен vbox - для отправления сообщений.
  • vmenu - для проверки сообщений.
  • kbridge - это петля возвращающая вызовы в Kamailio. Также это важная часть обеспечивающая прохождение NAT через симметричные маршруты. Если вызов не отвечен в течении 50 секунд он переводится на голосовую почту. Также в данной части вы можете реализовать SBC-подобные функции, такие как согласование кодеков, приложения предоплаченных вызовов или воспроизведение аудио.

Данные пользователей (Directory)

Используем Lua скрипт для получения данных из таблицы пользователей (subscriber) Kamailio и генерации XML конфига пользователя FS на лету по заросу. Подробнее тема хранения FS User Directory в базе данных рассматривается в другой нашей статье - Freeswitch: Аккаунты пользователей в базе данных MySQL / Postgresql.

Добавим новую колонку в таблицу пользователей Kamailio

Сперва добавим колонку с пином для доступа у голосовому почтовому ящику на FS в таблицу subscriber Kamailio.

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

Также, если требуется оповещение пользователей по email, задайте требуемое значение для каждого пользователя в колонке email_address

Скрипт Lua

Скрипт Lua для создания XML directory файла пользователя FS:

-- directory_xml.lua
-- freeswitch.consoleLog("notice", "Debug from directory_xml.lua, provided params:\n" .. params:serialize() .. "\n")
 
local req_domain = params:getHeader("domain")
local req_key    = params:getHeader("key")
local req_user   = params:getHeader("user")
 
assert (req_domain and req_key and req_user,
  "This example script only supports generating directory xml for a single user !\n")
 
--"odbc://db:user:pass"
local dbh = freeswitch.Dbh("odbc://kamailio:kamailio:kamailiorw")
if dbh:connected() == false then
  freeswitch.consoleLog("notice", "directory_xml.lua cannot connect to database" .. dsn .. "\n")
  return
end
 
local dir_query = "select username, domain, email_address, vmpin from subscriber where username = '" .. req_user ..  "' limit 1"
 
assert (dbh:query(dir_query, function(row)
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>]]
 
  -- закомментируйте для продакшн:
  freeswitch.consoleLog("notice", "Debug from directory_xml.lua, generated XML:\n" .. XML_STRING .. "\n")
end))

Нажмите, чтобы отобразить

Нажмите, чтобы скрыть

-- 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", "kamailio", "kamailiorw"))
 
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()

Сохраните содержимое скрипта в /usr/local/freeswitch/directory_xml.lua . Измените параметр vm-mailfrom на требуемые вам данные.

Данный скрипт просто создает профиль пользователя FS на основании данных Kamailio. Как дополнение вы можете разрешить пользователям менять pin из голосового меню (IVR) или в веб-интерфейсе.

Настройка модуля Lua

В конфиге /usr/local/freeswitch/config/autoload_configs/lua.conf.xml , установите:

    <param name="xml-handler-script" value="/usr/local/freeswitch/scripts/directory_xml.lua"/>
    <param name="xml-handler-bindings" value="directory"/>

Voicebox Email Notifications

Теперь мы имеем установленные и настроенные Kamailio и Freeswitch с несколькими телефонами зарегистрированными на kamailio.

При вызове между ними:

  • Если отвечено, устанавливается голосовой тракт.
  • Если отвергнуто, перенаправляется на голосовой почтовый ящик.
  • Если не отвечено, перенаправляется на голосовой почтовый ящик.
  • kamailio/fs_sbc.txt
  • Последние изменения: 2019/10/04