Internal SIP Gate (sg)

Содержание

Описание
Ограничения
Параметры
Пример конфигурации
См. также

Описание

Точка входа в кластер по SIP для внутренних устройств, определяемых учетными записями SIP-пользователей.

Проксирует запросы в режиме stateless на внутренние серверы с функциональными ролями b2b. Имеет адрес, через который подключены телефоны внутренних абонентов соответствующего сайта. Любой запрос от системы к пользователю идет через соответствующий экземпляр функциональной роли sg.
Не делает различий между разными типами запросов – пропускает все насквозь, добавляя себя в заголовки "Via" всех запросов и "Record-Route" INVITE-запросов.

Является пограничной функциональной ролью для интерфейса SIP.
Защищает кластер от нежелательных запросов извне, используя пограничные фильтры на основе статических правил и динамических списков временно забаненных адресов.
Может использовать функциональную роль bgmg для решения вопроса стыковки разных сетей. Медиа-шлюз посредством функциональной роли bgmg применяется автоматически при обнаружении нескольких сетевых интерфейсов и при проксировании запроса из одной подсети в другую. Для корректного функционирования режима на сервере с функциональной ролью sg должен находиться один или несколько экземпляров функциональной роли bgmg с непересекающимися настройками для портов.

Резервируется и масштабируется в режиме Active-Active.

При запуске функциональной роли проверяется сертификат указанный в параметре *certdir*. Если валидация не пройдена, функциональная роль запускается с неизменяемым сертификатом. Сертификат может быть переопределен через настройки домена.

Table 1. Системные характеристики

Код	`sg`
Режим работы	`Сервис`
Режим резервирования	`Active-Active`
Типы сайтов	`Любые`
Слой	`Бизнес-логика`
Размещение	`Пограничный`
Сохранение и восстановление состояния при перезагрузке	`Нет`
Приложение	`rostell_sip`

Ограничения

Не более 3000 SIP-пакетов на один экземпляр функциональной роли в секунду.
Является пограничной функциональной ролью, использует сертификат TLS для HTTPS и WSS подключений.

Параметры

Описание столбцов в таблице

Table 2. Параметры
Имя	Тип	Умолчание	Описание
`name`	`str`	required	Имя. Может состоять из латинских букв и цифр, должно начинаться с буквы.
`roletype`	`str`	required	Тип функциональной роли. Возможные значения: `"sg"`.
`iface`	`str`	required	Алиас сетевого интерфейса сервера, на котором будет происходить внутреннее взаимодействие функциональных ролей между собой.
`roleid`	`int`	required	Идентификатор функциональной роли. Уникален для всей системы, независимо от сайта или сервера. Не подлежит изменению. Целое число от `1` до `9999`.
`separate`	`bool`	required	Признак выделения функциональной роли в отдельную ноду.
`tcp`	`int`	required	Локальный порт TCP для SIP (`1` - `65535`). Если указано значение, отличное от UDP, то будет поднят дополнительно. Например: `5060`
`udp`	`int`	required	Локальный порт UDP для SIP (`1` - `65535`). Этот же порт одновременно обрабатывает и TCP. Например: `5060`
`tls`	`int`	empty	Локальный порт TLS для SIP (`1` - `65535`). По умолчанию не открывается. Например: `5061`
`wss`	`int`	empty	Локальный порт WebSocketSecure для SIP (`1` - `65535`). По умолчанию не открывается. Например: `5063`
`trn`	`bool`	`true`	Выключатель логирования SIP-протокола в лог `trn`.
`use_srtp`	`bool`	`false`	По умолчанию при инициации звонков на адреса, подключенные по TLS, отправляется SDP-offer для нешифрованного медиа потока (rtp). С помощью параметра можно для TLS адресов включить режим инициации отправки SDP-offerа с шифрованным медиа-потоком. Применяется только для звонков, использующих пограничный медиагейт.
`certdir`	`str`	empty	Алиас каталога на сервере для хранения сертификатов (файлы server.crt и server.key), в случае необходимости указания цепочки сертификатов до центра сертификации (CA - Certification Authority) его необходимо разместить в конце файла сертификата. Если путь не указан, то поиск сертификатов осуществляется в каталоге `"/usr/lib/rostell/rostell_sip/priv/ssl"`
`keypass`	`str`	empty	Пароль для расшифровки файла секретного ключа сертификата.
`tls_ciphers`	`array<str>`	`default`	Список алгоритмов шифрования, используются при установке tls соединения. Необходимо указывать RFC или openssl имена алгоритмов. При указании `` будут выбраны все доступные алгоритмы. По умолчанию используется default - список актуальных алгоритмов шифрования для протоколов tlsv1.1, tlsv1.2, tlsv1.3. Например: [""] [<<"TLS_RSA_WITH_AES_256_GCM_SHA384">>, <<"AES256-GCM-SHA384">>]
`payloads_audio_offer`	`array<str>`	`"G729/8000"`	Список применяемых аудио кодеков. В качестве значения - список, содержащий имена кодеков в формате `"Name/Freq"`.
`payloads_video_offer`	`array<str>`	empty	Список используемых для инициации звонка имен видеокодеков case-sensitive.
`use_video_transcoding`	`bool`	`false`	Выключатель транскодинга видео. Применяется при использовании bgmg. `false` – все видео-кодеки из SDP INVITE-запроса, полученного от инициатора, транслируются без изменений в SDP INVITE-запросов на вызываемые устройства. В этом случае система не применяет ни свои знания о кодеках, ни транскодинг, икодек неизвестен системе, то прямая трансляция тем не менее остается возможной. `true` – все видео-кодеки приводятся в соответствии с известными системе видео-кодеками, система предлагает вызываемой стороне все известные ей кодеки (с фильтром из payloads_video_offer), и при несовпадении выбранных устройствами кодеков осуществляется транскодинг на видео-стриме.
`aliases`	`array<object>`	empty	Алиасы сетевых интерфейсов для применения bgmg. Распределение алиасов по сетевым интерфейсам обязано совпадать с аналогичным распределением у функциональной роли bgmg. Формат: `{"key":"Alias", "value":"Interface"}` Достижимость конечных адресов через сетевые интерфейсы, чьи адреса принадлежат разным алиасам, означает необходимость применения медиа-шлюза, управляемого функциональной ролью bgmg. Здесь должны быть указаны адреса всех сетевых интерфейсов IPv4 (исключая loopback), которые могут быть определены системой как наилучшие для достижения удаленных адресов.
`sipalg`	`array<object>`	empty	Маппинги SIP ALG для применения в SDP на исходящих запросах INVITE и ответах OK. Формат: `{"key":"IpAddr1", "value":"IpAddr2"}` Ключом выступает IP-адрес подлежащий подмене, а значением - IP-адрес, на который будет подменяться адрес в исходящем SDP. IP-адрес подлежащий подмене должен совпадать с адресом на сервере с функциональной ролью MG/BGMG. IP-адрес на который будет подменяться может быть любым и обычно не принадлежит серверу.
`b2bmedia`	`bool`	`true`	Выключатель применения медиа-шлюза функциональной ролью b2b для звонков, перенаправляемых текущим экземпляром функциональной роли sg.
`max_udp_size`	`int`	`1500`	Максимальный размер udp пакета, отправляемый системой, в байтах. Минимальное значение: `1500`. (Реализовано в задаче #182). При превышении отправляемым пакетом установленного размера происходит автоматическая отправка через TCP. При превышении отправляемым пакетом размера `1500` но до установленного в поле значения, происходит автоматическое разбиение пакета на фреймы и сборка их при получении на нижнем сетевом уровне. Не все устройства поддерживают такой режим. В то же время не все устройства держат TCP открытым.
`reregister`	`bool`	`false`	Выключатель режима отправки запросов NOTIFY для перерегистрации UA при падении экземпляра функциональной роли sg, обслуживающего устройство. `true` – при обнаружении внезапной недоступности экземпляра функциональной роли sg, другие экземпляры функциональной роли осуществляют отправку запроса NOTIFY со специальным содержимым, призванным инициировать перезапуск операции регистрации на устройстве. Применяется в случае, если устройства поддерживают указание нескольких адресов Outbound-proxy и обработку этого NOTIFY.
`translit`	`bool`	`false`	Выключатель режима автоматического транслита DisplayName в запросах, перенаправляемых в сторону от системы к подключенным устройствам.
`substitute_domains`	`array<object>`	empty	Подстановка доменов вместо ip-адресов в заголовки To и From SIP-пакетов. Применяется при работе с телефонами, которые не могут подставлять символьные доменные имена. При активации режима микросервис SG подменяет пакеты при пересылке в обе стороны следующим образом: * Принимаемые от устройств пакеты, содержащие IP-адрес сервера в качестве имени домена в заголовках To и From, подменяют IP-адрес в этих заголовках на сопоставленный ему домен. * Отправляемые устройствам пакеты, содержащие в заголовках To и From один из доменов, указанных в опции, подменяют домен в этих заголовках на сопоставленный ему IP-адрес. Формат: `[{"addr":"IpAddr", "domain":"DOMAIN"}, ...]`

Пример конфигурации

Управление конфигурацией производится в приложении, доступном для администраторов мастер-домена. Приложение скрывает полное содержание конфигурации, однако тем не менее оно доступно через API.

Конфигурация содержит раздел для описания всех экземпляров всех функциональных ролей. Параметры определяются для каждого конкретного экземпляра функциональной роли.

Пример узла

{
  "name": "lwmgate32",
  "roletype": "sg",
  "iface": "eth0",

  "roleid": 330,
  "separate": true,
  "tcp": 5060,
  "udp": 5060,
  "tls": 5061,
  "wss": 5063,

  "certdir": "/var/lib/rostell/certificates",
  "keypass": "eb9c4458016d3f1e378d02004c4f4f50",
  "max_udp_size": 10000,
  "reregister": false,
  "translit": true
}

См. также

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