Kamailio часть 11. UAC модуль. Регистрация SIP номера у оператора через Kamailio, Kamailio в роли клиента

В этой статье будет рассмотрено, как взаимодействовать с SIP операторами/провайдерами в качестве клиента через UAC модуль в Kamailio

Теория взаимодействия Kamailio с оператором связи

Для начала кратко вспомним 1 часть (SIP регистрация в Kamailio), где максимально подробно рассматривалась сама регистрация в SIP протоколе.

Kamailio в роли сервера — UAS (User Agent Server)

Здесь, мой компьютер с установленным SIP клиентом (или WebRTC клиентом). Т.е отправляется запрос SIP REGISTER с моего компьютера в сторону Kamailio и далее выполняется обработка этого REGISTER согласно алгоритму:

Как происходит взаимодействие нашего локального абонента (который регистрируется на нашем SIP сервере) я думаю понятно, но как будет происходить взаимодействие, если мы будем выступать в роли клиента (будем локальным абонентом для вышестоящего оператора/провайдера связи)?

Kamailio в роли UAC (User Agent Client)

Мы, как клиент оператора, должны зарегистрироваться для возможности приема входящих вызовов и возможности совершения исходящих.

---

Уточню, что возможность приема входящих и совершения исходящих зависят от настройки вашего оператора. Например, у некоторых операторах не обязательно выполнять регистрацию, чтобы оператор отправлял входящие вызовы (которые поступают на ваш арендованный внешний SIP номер) в сторону Kamailio. Также может быть и не обязательна регистрация для совершения исходящих вызовов.

---

В нашем случае, мы условимся, что оператору требуется предварительная регистрация номера для дальнейшей маршрутизации.

Алгоритм работы ничем не отличается от алгоритма регистрации нашего локального абонента на Kamailio, только при взаимодействии с оператором, мы становимся локальным абонентом, а оператор сервером регистрации.

Обычно, если это какой-то местный провайдер связи, то вам передадут документ с данными вашего арендованного внешнего SIP номера. В этом электронном или физическом документе будут указаны логин (обычно это арендованный номер или его часть, но может быть и другой), пароль, адрес регистрации (в виде dns или IP адреса) и домен (realm).

От нас требуется ввести корректно все предоставленные данные и отправить запрос на регистрацию к провайдеру.

Практическая реализация SIP регистрации у оператора связи с Kamailio UAC

Чтобы Kamailio смог выступать в роли клиента, существует модуль UAC. Загрузим модуль, для этого к другим модулям в конфигурационном файле добавим (но обязательно после загрузки модулей uac, rr):

loadmodule "uac.so"

После чего к остальным modparam добавим:

modparam("uac", "reg_db_url", DBURL)
modparam("uac", "reg_contact_addr", "***.***.***.***:5060")

Первый параметр отвечает за подключение к БД, это также очень подробно рассматривалось в первой части (подключение БД в Kamailio).

Второй параметр более интересный, он опять же очень подробно рассматривался во второй части (Прохождение NAT в Kamailio) . Но кратко напомню, что при регистрации оператор запоминает наш AoR (Address of Record), т.е заголовок Contact из SIP REGISTER сообщения. Поэтому, если в заголовке Contact будет указан некорректный IP адрес, то звонки работать не будут (хотя мы и зарегистрируем номер, но регистрация будет некорректной). Поэтому параметром reg_contact_addr мы указываем наш публичный (или белый) IP адрес, который мы будем отправлять в заголовке Contact.

Давайте посмотрим трассировку SIP REGISTER с Kamailio в сторону оператора связи

И само тело SIP сообщения:

2022/03/12 19:58:39.654610 ***.***.***.***:5060 -> ***.***.***.***:5060
REGISTER sip:******* SIP/2.0
Via: SIP/2.0/UDP ***.***.***.***;branch=z9hG4bK05a8.62653513000000000000000000000000.0
To: <sip:9*****5@***.****.***.**>
From: <sip:9*****5@***.****.***.**>;tag=910ad4f878ce5fa73fee402a3fafb4f9-a0c6f323
CSeq: 10 REGISTER
Call-ID: [email protected]
Max-Forwards: 70
Content-Length: 0
User-Agent: kamailio (5.5.3 (x86_64/linux))
Contact: <sip:number@yourpublicip:5060>
Expires: 60

Т.е reg_contact_addr из параметра модуля отвечает за то, что мы отправляет в заголовке Contact и нам необходимо корректно отправить IP адрес в сторону оператора.

Для ответа на 401 или 407 ответы с требованием авторизации от оператора, нам необходимо добавить failure_route для корректной обработки таких ответов.

В самый низ kamailio.cfg добавляем строки вида:

failure_route[TRUNKAUTH] {
    if (t_is_canceled()) {
        exit;
    }
    if(t_check_status("401|407")) {
        $avp(auser) = "ЛОГИН_ИЛИ_НОМЕР_ОТ_ПРОВАЙДЕРА";
        $avp(apass) = "ПАРОЛЬ_ОТ_ПРОВАЙДЕРА";
        $avp(arealm) = "ДОМЕН_ОТ_ПРОВАЙДЕРА";
        $rd = "ДОМЕН_ОТ_ПРОВАЙДЕРА";
        if (uac_auth()) {
                t_relay();
        }
        exit;
    }
}

И в route[RELAY] сошлемся на failure_route добавив:

route[RELAY] {
        if (has_body("application/sdp") && isflagset(tswitch)) {
                rtpengine_manage("replace-origin external internal");
        } else {
                rtpengine_manage("replace-origin internal external");
        }
        t_on_failure("TRUNKAUTH");
        t_on_reply("REPLY");
        if (isflagset(fswitch)) {
                t_relay();
        }
        if (isflagset(tswitch)) {
                if (is_method("INVITE")) {
                        ds_select_dst("1", "4");
                }
                t_relay();
        }
}

Далее, нам необходимо указать непосредственно данные для регистрации, который сообщил вам ваш провайдер. Для этого мы будем использовать БД (которую ранее подключили через параметр reg_db_url)
По умолчанию используется таблица uacreg, но это можно изменить через параметр:

modparam("uac", "reg_db_table", "uacreg")

Но мы будем использовать таблицу по умолчанию — uacreg.

Сама структура таблицы uacreg следующая:

Table "public.uacreg"
    Column     |          Type          | Collation | Nullable |              Default               
---------------+------------------------+-----------+----------+------------------------------------
 id            | integer                |           | not null | nextval('uacreg_id_seq'::regclass)
 l_uuid        | character varying(64)  |           | not null | ''::character varying
 l_username    | character varying(64)  |           | not null | ''::character varying
 l_domain      | character varying(64)  |           | not null | ''::character varying
 r_username    | character varying(64)  |           | not null | ''::character varying
 r_domain      | character varying(64)  |           | not null | ''::character varying
 realm         | character varying(64)  |           | not null | ''::character varying
 auth_username | character varying(64)  |           | not null | ''::character varying
 auth_password | character varying(64)  |           | not null | ''::character varying
 auth_ha1      | character varying(128) |           | not null | ''::character varying
 auth_proxy    | character varying(255) |           | not null | ''::character varying
 expires       | integer                |           | not null | 0
 flags         | integer                |           | not null | 0
 reg_delay     | integer                |           | not null | 0
 contact_addr  | character varying(255) |           | not null | ''::character varying
 socket        | character varying(128) |           | not null | ''::character varying

Разберем подробно каждый столбец и за что он отвечает (сверху вниз):

1. id — уникальный идентификатор записи, автоматически увеличивается при INSERT (autoincrement), заполнять не требуется
2. l_uuid — локальный идентификатор пользователя. Не может быть нулем (not null), необходимо заполнить (обычно, я указываю внешний номер, но вы можете указать любое другое значение)
3. l_username — локальный логин пользователя, не может быть нулем,необходимо заполнить. Можно указать произвольный логин
4. l_domain — локальный домен (realm). В случае, если у вас только один домен (например одна организация), то необходимо указать этот домен. Если настроена мультидоменность (multi tenant), то необходимо указать домен к которому будет привязан этот номер.
5. r_username — указывается логин, который сообщил вам оператор/провайдер для вашего номера.
6. r_domain — указывается домен (realm), который сообщил вам оператор связи. Может быть как IP адресом, так и DNS записью
7. realm — указывается такое же значение, как и в r_domain
8. auth_username — логин для авторизации. Почти всегда указываем такое же значение, как для r_username
9. auth_password — пароль для авторизации, также сообщает оператор
10. auth_ha1 — пароль в зашифрованном виде, заполнять не обязательно, достаточно заполненного столбца auth_password. В этой статье использоваться не будет.
11. auth_proxy — непосредственно сам адрес регистрации, может быть как IP, так и DNS имя. Сообщает также оператор.
12. expires — время истекания регистрации (в секундах). Т.е сколько номер будет зарегистрирован у оператора.
13. flags — состояние регистрации. По умолчанию ставим значение 0.
14. reg_delay — задержка перед отправкой запроса регистрации. Не будет использоваться.
15. contact_addr — адрес, который будет в заголовке Contact, в сообщении REGISTER. В нашем случае не заполняется, т.к мы переопределили глобально IP адрес через параметр reg_contact_addr
16. socket — сокет, который будет использоваться для отправки в сторону провайдера. При наличии нескольких IP адресов, можно указать IP, который будет использоваться для этого номера.

Заполним указанные столбцы, согласно регистрационным данным провайдера. Я это сделаю через SQL запрос (но можно также добавить и через kamcmd uac.reg_add).
Для этого подключаемся к БД, с которой взаимодействует Kamailio (к БД, которая указана в параметре reg_db_url) и выполняем SQL запрос:

INSERT INTO uacreg (l_uuid, l_username, l_domain, r_username, r_domain, realm, auth_username, auth_password, auth_proxy, expires, flags, reg_delay, socket) VALUES ("111111111", "111111111", "operator1", "111111111", "operator1", "operator1", "111111111", "supersecretpwd", "sip:1.2.3.4:5060", 60, 0, 0, 0)

Там, где выделено, необходимо подставить значения, которые передал вам оператор.

После того, как значения добавлены в базу данных, нам необходимо, чтобы Kamailio взял эти значения из БД. Есть два варианта:

1. Перезагрузить демон через systemctl
2. Через kamcmd

Второй вариант предпочтительней, для этого выполним команду (уже в bash консоли):

kamcmd uac.reg_refresh l_uuid

Вместо l_uuid необходимо подставить значение, которое было указано в БД, в столбце l_uuid, т.е как пример:

kamcmd uac.reg_refresh 111111111

После чего посмотрим статус регистрации с помощью команды:

kamcmd uac.reg_dump

В выводе мы увидим:

И нас интересует значение flags в выводе команды. Существуют следующие флаги:

1. Значение 1 — регистрация выключена
2. Значение 2 — регистрация в процессе
3. Значение 4 — регистрация успешна
4. Значение 8 — регистрация в процессе авторизации
5. Значение 16 — данные загружены из БД, регистрация инициализированна

В нашем случае, в flags указано значение 20, что означает, что регистрация прошла успешно. Это значение включает в себя два флага, флаг 16 (данные загруженны из БД, выполняется инциализация) и флаг 4 (регистрация успешна).

Заключение

В этой статье мы рассмотрели модуль UAC и как выполнять регистрацию у оператора связи. В следующей статье мы настроим входящие вызовы со стороны оператора к нам, настроим dialplan (со стороны FreeSWITCH) и примем первый входящий вызов.

Если есть желание сделать пожертвование, то это можно сделать кликнув по ссылке или же нажав на кнопку. Спасибо за поддержку !)