Интеграция Kamailio v.5 с Asterisk 13 на Debian 8

Интеграция Kamailio v.5 с Asterisk 13 на Debian 8

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

Модуль аутентификации в Kamailio может быть настроен для подключения к любой базе данных и получения пароля из пользовательской таблицы и столбца, поэтому создание представления базы данных действительно не требуется, если вы не хотите использовать его для других целей.
Мы будем производить установку из исходных кодов, а MySQL будет использоваться как сервер базы данных и unixodbc для Asterisk для обработки событий в реальном времени.
Используемые версии являются последними стабильными версиями обоих проектов на момент написания этой статьи, соответственно Kamailio v5.2.x и Asterisk v13.

Архитектура

  • проверка подлинности в Kamailio
  • управление местоположением пользователя в Kamailio
  • маршрутизация вызовов между локальными телефонами управляется Asterisk
  • медиасервисы обрабатываются Asterisk в соответствии с диалпланом Asterisk
  • маршрутизация других сообщений SIP, не связанных с вызовами, обрабатывается Kamailio напрямую

Постановка задачи

Kamailio делает аутентификацию при регистрации. В случае успеха он уведомляет Asterisk с новым REGISTER, что телефон доступен на IP-адресе.
Kamailio обрабатывает аутентификацию. Когда поступают новые звонки они аутентифицируются, Kamailio отправляет его в Asterisk. Если номер пункта назначения находится в сети, Asterisk отправит звонок обратно в Kamailio, так как контакт назначения – Kamailio IP. Затем Kamailio проведет поиск местоположения и отправит IP-адрес получателя.
Поскольку для многих команд требуются привилегии root, я предполагаю, что вы либо знаете, как использовать sudo для запуска команды, либо выполните su для root и запустите все команды с правами root:
sudo su -

Установка MySQL

Сервер MySQL и клиент включены во все основные дистрибутивы Linux. Так же в Debian 8 Чтобы установить сервер и клиент, откройте терминал и выполните:
apt-get install mysql-server
Для установки клиентской библиотеки MySQL выполните:
apt-get install libmysqlclient-dev

Установка UnixODBC

Чтобы установить библиотеки Devel для UnixODBC, запустите:
apt-get install unixodbc-dev
Если ваша операционная система не предоставляет пакет для этого, загрузите источники из http://www.unixodbc.org/, скомпилируйте и установите. Затем настройте систему компиляции Asterisk, если unixodbc не будет обнаружен автоматически.
Чтобы MySQL ODBC коннектор, запустите:
apt-get install libmyodbc

Установка Asterisk

Подробная инструкция по установке Asteriak 13 описана в этой статье
На этапе выбора устанавливаемых модулей (makemenuselect) выберите опцию Voicemail Build Options и включите опцию ODBC_STORAGE.

Установка Kamailio

Пошаговое руководство по установке последней версии Kamailio 5.x.x из git доступно в предыдущей статье

База данных Kamailio

Эта база данных требуется для хранения записей регистрация (адресов телефонов).
Используйте kamdbctl для создания базы данных:
/usr/local/sbin/kamdbctl create
Никаких других изменений в структуре базы данных Kamailio не требуется. Сервер SIP выберет пароль из базы данных Asterisk.

База данных Asterisk

Выполните следующий SQL-скрипт в клиенте mysql:
CREATE DATABASE asterisk;
USE asterisk;
GRANT ALL ON asterisk.* TO asterisk@localhost IDENTIFIED BY 'asterisk_password';
DROP TABLE IF EXISTS sipusers;
CREATE TABLE `sipusers` (
`id` INT(11) NOT NULL AUTO_INCREMENT,
`name` VARCHAR(10) NOT NULL,
`ipaddr` VARCHAR(15) DEFAULT NULL,
`port` INT(5) DEFAULT NULL,
`regseconds` INT(11) DEFAULT NULL,
`defaultuser` VARCHAR(10) DEFAULT NULL,
`fullcontact` VARCHAR(35) DEFAULT NULL,
`regserver` VARCHAR(20) DEFAULT NULL,
`useragent` VARCHAR(20) DEFAULT NULL,
`lastms` INT(11) DEFAULT NULL,
`host` VARCHAR(40) DEFAULT NULL,
`type` enum('friend','user','peer') DEFAULT NULL,
`context` VARCHAR(40) DEFAULT NULL,
`permit` VARCHAR(40) DEFAULT NULL,
`deny` VARCHAR(40) DEFAULT NULL,
`secret` VARCHAR(40) DEFAULT NULL,
`md5secret` VARCHAR(40) DEFAULT NULL,
`remotesecret` VARCHAR(40) DEFAULT NULL,
`transport` enum('udp','tcp','udp,tcp','tcp,udp') DEFAULT NULL,
`dtmfmode` enum('rfc2833','info','shortinfo','inband','auto') DEFAULT NULL,
`directmedia` enum('yes','no','nonat','update') DEFAULT NULL,
`nat` enum('yes','no','never','route') DEFAULT NULL,
`callgroup` VARCHAR(40) DEFAULT NULL,
`pickupgroup` VARCHAR(40) DEFAULT NULL,
`language` VARCHAR(40) DEFAULT NULL,
`disallow` VARCHAR(40) DEFAULT NULL,
`allow` VARCHAR(40) DEFAULT NULL,
`insecure` VARCHAR(40) DEFAULT NULL,
`trustrpid` enum('yes','no') DEFAULT NULL,
`progressinband` enum('yes','no','never') DEFAULT NULL,
`promiscredir` enum('yes','no') DEFAULT NULL,
`useclientcode` enum('yes','no') DEFAULT NULL,
`accountcode` VARCHAR(40) DEFAULT NULL,
`setvar` VARCHAR(40) DEFAULT NULL,
`callerid` VARCHAR(40) DEFAULT NULL,
`amaflags` VARCHAR(40) DEFAULT NULL,
`callcounter` enum('yes','no') DEFAULT NULL,
`busylevel` INT(11) DEFAULT NULL,
`allowoverlap` enum('yes','no') DEFAULT NULL,
`allowsubscribe` enum('yes','no') DEFAULT NULL,
`videosupport` enum('yes','no') DEFAULT NULL,
`maxcallbitrate` INT(11) DEFAULT NULL,
`rfc2833compensate` enum('yes','no') DEFAULT NULL,
`mailbox` VARCHAR(40) DEFAULT NULL,
`session-timers` enum('accept','refuse','originate') DEFAULT NULL,
`session-expires` INT(11) DEFAULT NULL,
`session-minse` INT(11) DEFAULT NULL,
`session-refresher` enum('uac','uas') DEFAULT NULL,
`t38pt_usertpsource` VARCHAR(40) DEFAULT NULL,
`regexten` VARCHAR(40) DEFAULT NULL,
`fromdomain` VARCHAR(40) DEFAULT NULL,
`fromuser` VARCHAR(40) DEFAULT NULL,
`qualify` VARCHAR(40) DEFAULT NULL,
`defaultip` VARCHAR(40) DEFAULT NULL,
`rtptimeout` INT(11) DEFAULT NULL,
`rtpholdtimeout` INT(11) DEFAULT NULL,
`sendrpid` enum('yes','no') DEFAULT NULL,
`outboundproxy` VARCHAR(40) DEFAULT NULL,
`callbackextension` VARCHAR(40) DEFAULT NULL,
`timert1` INT(11) DEFAULT NULL,
`timerb` INT(11) DEFAULT NULL,
`qualifyfreq` INT(11) DEFAULT NULL,
`constantssrc` enum('yes','no') DEFAULT NULL,
`contactpermit` VARCHAR(40) DEFAULT NULL,
`contactdeny` VARCHAR(40) DEFAULT NULL,
`usereqphone` enum('yes','no') DEFAULT NULL,
`textsupport` enum('yes','no') DEFAULT NULL,
`faxdetect` enum('yes','no') DEFAULT NULL,
`buggymwi` enum('yes','no') DEFAULT NULL,
`auth` VARCHAR(40) DEFAULT NULL,
`fullname` VARCHAR(40) DEFAULT NULL,
`trunkname` VARCHAR(40) DEFAULT NULL,
`cid_number` VARCHAR(40) DEFAULT NULL,
`callingpres` enum('allowed_not_screened','allowed_passed_screen','allowed_failed_screen','allowed','prohib_not_screened','prohib_passed_screen','prohib_failed_screen','prohib') DEFAULT NULL,
`mohinterpret` VARCHAR(40) DEFAULT NULL,
`mohsuggest` VARCHAR(40) DEFAULT NULL,
`parkinglot` VARCHAR(40) DEFAULT NULL,
`hasvoicemail` enum('yes','no') DEFAULT NULL,
`subscribemwi` enum('yes','no') DEFAULT NULL,
`vmexten` VARCHAR(40) DEFAULT NULL,
`autoframing` enum('yes','no') DEFAULT NULL,
`rtpkeepalive` INT(11) DEFAULT NULL,
`call-limit` INT(11) DEFAULT NULL,
`g726nonstandard` enum('yes','no') DEFAULT NULL,
`ignoresdpversion` enum('yes','no') DEFAULT NULL,
`allowtransfer` enum('yes','no') DEFAULT NULL,
`dynamic` enum('yes','no') DEFAULT NULL,
`sippasswd` VARCHAR(80) DEFAULT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `name` (`name`),
KEY `ipaddr` (`ipaddr`,`port`),
KEY `host` (`host`,`port`)
) ENGINE=MyISAM;
DROP TABLE IF EXISTS sipregs;
CREATE TABLE `sipregs` (
`id` INT(11) NOT NULL AUTO_INCREMENT,
`name` VARCHAR(80) NOT NULL DEFAULT '',
`fullcontact` VARCHAR(80) NOT NULL DEFAULT '',
`ipaddr` VARCHAR(45) DEFAULT NULL,
`port` mediumint(5) UNSIGNED NOT NULL DEFAULT '0',
`username` VARCHAR(80) NOT NULL DEFAULT '',
`regserver` VARCHAR(100) DEFAULT NULL,
`regseconds` INT(11) NOT NULL DEFAULT '0',
`defaultuser` VARCHAR(80) NOT NULL DEFAULT '',
`useragent` VARCHAR(20) DEFAULT NULL,
`lastms` INT(11) DEFAULT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `name` (`name`)
);
DROP TABLE IF EXISTS voicemail;
CREATE TABLE voicemail (
-- All of these column names are very specific, including "uniqueid". Do not change them if you wish voicemail to work.
uniqueid INT(5) NOT NULL AUTO_INCREMENT PRIMARY KEY,
-- Mailbox context.
context CHAR(80) NOT NULL DEFAULT 'default',
-- Mailbox number. Should be numeric.
mailbox CHAR(80) NOT NULL,
-- Must be numeric. Negative if you don't want it to be changed from VoicemailMain
password CHAR(80) NOT NULL,
-- Used in email and for Directory app
fullname CHAR(80),
-- Email address (will get sound file if attach=yes)
email CHAR(80),
-- Email address (won't get sound file)
pager CHAR(80),
-- Attach sound file to email - YES/no
attach CHAR(3),
-- Which sound format to attach
attachfmt CHAR(10),
-- Send email from this address
serveremail CHAR(80),
-- Prompts in alternative language
LANGUAGE CHAR(20),
-- Alternative timezone, as defined in voicemail.conf
tz CHAR(30),
-- Delete voicemail from server after sending email notification - yes/NO
deletevoicemail CHAR(3),
-- Read back CallerID information during playback - yes/NO
saycid CHAR(3),
-- Allow user to send voicemail from within VoicemailMain - YES/no
sendvoicemail CHAR(3),
-- Listen to voicemail and approve before sending - yes/NO
review CHAR(3),
-- Warn user a temporary greeting exists - yes/NO
tempgreetwarn CHAR(3),
-- Allow '0' to jump out during greeting - yes/NO
operator CHAR(3),
-- Hear date/time of message within VoicemailMain - YES/no
envelope CHAR(3),
-- Hear length of message within VoicemailMain - yes/NO
sayduration CHAR(3),
-- Minimum duration in minutes to say
saydurationm INT(3),
-- Force new user to record name when entering voicemail - yes/NO
forcename CHAR(3),
-- Force new user to record greetings when entering voicemail - yes/NO
forcegreetings CHAR(3),
-- Context in which to dial extension for callback
callback CHAR(80),
-- Context in which to dial extension (from advanced menu)
dialout CHAR(80),
-- Context in which to execute 0 or * escape during greeting
exitcontext CHAR(80),
-- Maximum messages in a folder (100 if not specified)
maxmsg INT(5),
-- Increase DB gain on recorded message by this amount (0.0 means none)
volgain DECIMAL(5,2),
-- IMAP user for authentication (if using IMAP storage)
imapuser VARCHAR(80),
-- IMAP password for authentication (if using IMAP storage)
imappassword VARCHAR(80),
-- IMAP server location (if using IMAP storage)
imapsever VARCHAR(80),
-- IMAP port (if using IMAP storage)
imapport VARCHAR(8),
-- IMAP flags (if using IMAP storage)
imapflags VARCHAR(80),
stamp TIMESTAMP
);
DROP TABLE IF EXISTS voicemail_data;
CREATE TABLE voicemail_data (
-- Path to the recording
filename CHAR(255) NOT NULL PRIMARY KEY,
-- Mailbox number (without context)
origmailbox CHAR(80),
-- Dialplan context
context CHAR(80),
-- Dialplan context, if voicemail was invoked from a macro
macrocontext CHAR(80),
-- Dialplan extension
exten CHAR(80),
-- Dialplan priority
priority INT(5),
-- Name of the channel, when message was left
callerchan CHAR(80),
-- CallerID on the channel, when message was left
callerid CHAR(80),
-- Contrary to the name, origdate is a full datetime, in localized format
origdate CHAR(30),
-- Same date as origdate, but in Unixtime
origtime INT(11),
-- Value of the channel variable VM_CATEGORY, if set
category CHAR(30),
-- Length of the message, in seconds
duration INT(11)
);
DROP TABLE IF EXISTS voicemail_messages;
CREATE TABLE voicemail_messages (
-- Logical directory
dir CHAR(255),
-- Message number within the logical directory
msgnum INT(4),
-- Dialplan context
context CHAR(80),
-- Dialplan context, if Voicemail was invoked from a macro
macrocontext CHAR(80),
-- CallerID, when the message was left
callerid CHAR(80),
-- Date when the message was left, in Unixtime
origtime INT(11),
-- Length of the message, in seconds
duration INT(11),
-- The recording itself
recording BLOB,
-- Text flags indicating urgency of the message
flag CHAR(30),
-- Value of channel variable VM_CATEGORY, if set
category CHAR(30),
-- Owner of the mailbox
mailboxuser CHAR(30),
-- Context of the owner of the mailbox
mailboxcontext CHAR(30),
-- Unique ID of the message,
msg_id CHAR(40),
PRIMARY KEY (dir, msgnum)
);
Если вы сохраните код в файл asterisk.sql, вы можете загрузить его на сервер MySQL с помощью:
mysql -u root -p < asterisk.sql
Перед выполнением SQL-скрипта обязательно измените пароль для пользователя MySQL asterisk, в строке:
GRANT ALL ON asterisk.* TO asterisk@localhost IDENTIFIED BY 'asterisk_password';

Конфигурация UnixODBC

Редактируем файл /etc/odbcinst.ini:
[MySQL]
Description = MySQL driver
Driver = libmyodbc.so
Setup = libodbcmyS.so
CPTimeout =
CPReuse =
UsageCount = 1
Редактируем файл /etc/odbc.ini:
[MySQL-asterisk]
Description = MySQL Asterisk database
Trace = Off
TraceFile = stderr
Driver = MySQL
SERVER = localhost
USER = asterisk
PASSWORD = asterisk_password
PORT = 3306
DATABASE = asterisk

Настройка Asterisk ODBC

Редактируем файл /etc/asterisk/res_odbc.conf:
[asterisk]
enabled => yes
dsn => MySQL-asterisk
username => asterisk
password => asterisk_password
pre-connect => yes
Редактируем файл /etc/asterisk/extconfig.conf:
sipusers => odbc,asterisk,sipusers
sippeers => odbc,asterisk,sipusers
sipregs => odbc,asterisk,sipregs
voicemail => odbc,asterisk,voicemail

Настройка Asterisk

Если вам нужно кэшировать пользователей в реальном времени, отредактируйте файл /etc/asterisk/sip.conf и установите:

rtcachefriends=yes
Убедитесь, что вы также обновили IP-адрес и порт прослушивания, если Asterisk работает в одной системе с Kamailio.
Дополнительные примечания о процессе установки Asterisk можно найти в отдельной главе Asterisk: The Definitive Guide book (хотя она написана для более старой версии Asterisk, она по-прежнему актуальна для версии, используемой в этом учебнике).

Настройка маршрутизации

Использование диалплана у каждого осуществляется по разному. Я приведу просто пример, создав диалплан в /etc/asterisk/extensions.conf. Пример:
; наши телефоны используют 3-значные значения, начиная с 1
exten => _1XX,1,Dial(SIP/${EXTEN})
exten => _1XX,n,Voicemail(${EXTEN},u)
exten => _1XX,n,Hangup
exten => _1XX,101,Voicemail(${EXTEN},b)
exten => _1XX,102,Hangup
Это классический пример, который выполняет следующий алгоритм: если телефон зарегистрирован, вызов попадает на него если телефон недоступен, переадресация на голосовую почту если телефон занят, переадресация на голосовую почту В базе данных Asterisk вы можете вставить следующие записи для создания пользователей 101, 102 и 103 SIP:
INSERT INTO sipusers (name, defaultuser, host, sippasswd, fromuser, fromdomain, mailbox)
  VALUES ('101', '101', 'dynamic', '101', '101', 'yoursip.com', '101');
INSERT INTO sipusers (name, defaultuser, host, sippasswd, fromuser, fromdomain, mailbox)
  VALUES ('102', '102', 'dynamic', '102', '102', 'yoursip.com', '102');
INSERT INTO sipusers (name, defaultuser, host, sippasswd, fromuser, fromdomain, mailbox)
  VALUES ('103', '103', 'dynamic', '103', '103', 'yoursip.com', '103');
INSERT INTO sipregs(name) VALUES('101');
INSERT INTO sipregs(name) VALUES('102');
INSERT INTO sipregs(name) VALUES('103');
INSERT INTO voicemail(context, mailbox, password) VALUES ('default', '101', '1234');
INSERT INTO voicemail(context, mailbox, password) VALUES ('default', '102', '1234');
INSERT INTO voicemail(context, mailbox, password) VALUES ('default', '103', '1234');
Если вы используете sipregs, вам нужно создать запись для каждого расширения(extensions), где установить «name» на значение «name». Измените значение fromdomain (в примерах выше yoursip.com) на реальный домен SIP. Убедитесь, что вы настроили Asterisk, чтобы не аутентифицировать запросы SIP, поступающие от Kamailio.

Конфигурация Kamailio

IP-адреса

Весь файл конфигурации вставляется в следующий подраздел. Не забудьте изменить IP-порт прослушивания, порт для Kamailio и Asterisk. В этом примере Kamailio прослушивает IP 192.168.178.25 порт 5060, а Asterisk прослушивает IP 192.168.178.25 порт 5080. Кроме того, если вы создали базы данных Asterisk или Kamailio с разными именами, как указано выше, или вы изменили имена пользователей и пароли для подключения к серверу MySQL, не забудьте обновить параметры DBURL и DBASTURL.

Файл конфигурации

Файл конфигурации Kamailio находится в /usr/local/etc/kamailio/kamailio.cfg при установке из источников или в /etc/kamailio/kamailio.cfg при установке из пакетов. В зависимости от типа установки и архитектуры процессора вам может потребоваться обновить параметр конфигурации mpath, чтобы отобразить правильные папки, в которых установлены модули.
#!KAMAILIO
#!define WITH_MYSQL
#!define WITH_AUTH
#!define WITH_USRLOCDB
#!define WITH_ASTERISK
#
# Kamailio (OpenSER) SIP Server v4.0 - default configuration script
# - web: http://www.kamailio.org
# - git: http://sip-router.org
#
# Direct your questions about this file to:
#
# 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"
#!ifdef WITH_ASTERISK
#!define DBASTURL "mysql://asterisk:asterisk_password@localhost/asterisk"
#!endif
#!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_ASTERISK
asterisk.bindip = "192.168.178.25" desc "Asterisk IP Address"
asterisk.bindport = "5080" desc "Asterisk Port"
kamailio.bindip = "192.168.178.25" desc "Kamailio IP Address"
kamailio.bindport = "5060" desc "Kamailio 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
#!ifdef WITH_ASTERISK
loadmodule "uac.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)
#!ifdef WITH_ASTERISK
modparam("rr", "append_fromtag", 1)
#!else
modparam("rr", "append_fromtag", 0)
#!endif
# ----- 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", "calculate_ha1", yes)
modparam("auth_db", "load_credentials", "")
#!ifdef WITH_ASTERISK
modparam("auth_db", "user_column", "name")
modparam("auth_db", "password_column", "sippasswd")
modparam("auth_db", "db_url", DBASTURL)
modparam("auth_db", "version_table", 0)
#!else
modparam("auth_db", "db_url", DBURL)
modparam("auth_db", "password_column", "password")
modparam("auth_db", "use_domain", MULTIDOMAIN)
#!endif
# ----- 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);
# handle requests within SIP dialogs route(WITHINDLG);
### only initial requests (no To tag)
# CANCEL processing if (is_method("CANCEL")) { if (t_check_trans()) t_relay(); exit; } 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);
# user location service route(LOCATION);
route(RELAY); } route[RELAY] { # enable additional event routes for forwarded requests # - serial forking, RTP relaying handling, a.s.o. if (is_method("INVITE|SUBSCRIBE")) { t_on_branch("MANAGE_BRANCH"); t_on_reply("MANAGE_REPLY"); } if (is_method("INVITE")) { t_on_failure("MANAGE_FAILURE"); } 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:$spn"); 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()) { if (is_method("BYE")) { setflag(FLT_ACC); # do accounting ... setflag(FLT_ACCFAILED); # ... even if the transaction fails } if ( is_method("ACK") ) { # ACK is forwarded statelessy route(NATMANAGE); } 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(); #!ifdef WITH_ASTERISK route(REGFWD); #!endif 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 #!ifdef WITH_ASTERISK if(is_method("INVITE") && (!route(FROMASTERISK))) { # if new call from out there - send to Asterisk # - non-INVITE request are routed directly by Kamailio # - traffic from Asterisk is routed also directy by Kamailio route(TOASTERISK); exit; } #!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] { # 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; }
#!ifdef WITH_AUTH #!ifdef WITH_ASTERISK # do not auth traffic from Asterisk - trusted! if(route(FROMASTERISK)) return;
#!endif
#!ifdef WITH_IPAUTH if((!is_method("REGISTER")) && allow_source_address()) { # source IP allowed return; } #!endif if (is_method("REGISTER") || from_uri==myself) { # authenticate requests #!ifdef WITH_ASTERISK if (!auth_check("$fd", "sipusers", "1")) { #!else if (!auth_check("$fd", "subscriber", "1")) { #!endif auth_challenge("$fd", "0"); exit; } # user authenticated - remove auth header if(!is_method("REGISTER|PUBLISH")) consume_credentials(); } #!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 { fix_nated_contact(); } 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)) { fix_nated_contact(); } }
#!endif return; }
# Routing to foreign domains route[SIPOUT] { if (!uri==myself) { append_hf("P-hint: outboundrn"); 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 definedn"); 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 definedn"); 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; } # manage outgoing branches branch_route[MANAGE_BRANCH] { xdbg("new branch [$T_branch_idx] to $run"); route(NATMANAGE); } # manage incoming replies onreply_route[MANAGE_REPLY] { xdbg("incoming replyn"); 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_ASTERISK # Test if coming from Asterisk route[FROMASTERISK] { if($si==$sel(cfg_get.asterisk.bindip) && $sp==$sel(cfg_get.asterisk.bindport)) return 1; return -1; } # Send to Asterisk route[TOASTERISK] { $du = "sip:" + $sel(cfg_get.asterisk.bindip) + ":" + $sel(cfg_get.asterisk.bindport); route(RELAY); exit; } # Forward REGISTER to Asterisk route[REGFWD] { if(!is_method("REGISTER")) { return; } $var(rip) = $sel(cfg_get.asterisk.bindip); $uac_req(method)="REGISTER"; $uac_req(ruri)="sip:" + $var(rip) + ":" + $sel(cfg_get.asterisk.bindport); $uac_req(furi)="sip:" + $au + "@" + $var(rip); $uac_req(turi)="sip:" + $au + "@" + $var(rip); $uac_req(hdrs)="Contact: rn"; if($sel(contact.expires) != $null) $uac_req(hdrs)= $uac_req(hdrs) + "Expires: " + $sel(contact.expires) + "rn"; else $uac_req(hdrs)= $uac_req(hdrs) + "Expires: " + $hdr(Expires) + "rn"; uac_req_send(); } #!endif

Примечания

  • Запрос REGISTER, отправленный в Asterisk, запускается с помощью REGISTER, поступающего с телефона, но создается с нуля и отправляется с uac_req_send().
  • IP и порт для Kamailio, заданных с помощью настраиваемых глобальных параметров. Kamailio.bindip и kamailio.bindport используются для создания контакта для запроса REGISTER, отправленного в Asterisk.
  • любой INVITE, полученный от телефонов (не из Asterisk), аутентифицируется, а затем отправляется в Asterisk.
  • Asterisk автоматически отправит обратно в Kamailio INVITE для онлайн-SIP-телефонов (так как контакт в Asterisk sipregs указывает на IP-адрес Kamailio и порт).
  • любой INVITE, полученный от Asterisk, обрабатывается через местоположение пользователя, а затем отправляется на целевой телефон.

Другие преимущества

С такой архитектурой можно добиться нескольких других преимуществ:
  • повышение безопасности – Kamailio, обрабатывающий только SIP-сигнализацию, может легче поглощать атаки, защищая Asterisk;
  • шлюз транспортного уровня – у Kamailio есть готовые реализации для UDP, TCP, TLS и SCTP, поэтому вы можете использовать его перед Asterisk для перевода между этими протоколами;
  • балансировка нагрузки – вы можете использовать несколько экземпляров Asterisk, Kamailio может выполнять балансировку нагрузки между ними;
  • высокая доступность – Kamailio может быть настроен на повторный маршрут вызова, если выбранный Asterisk не реагирует в течение определенного периода времени, например, если один Asterisk не реагирует через 2 секунды, отправил вызов другому Asterisk;