External SIP Gate (esg)

Описание

Точка доступа в кластер по SIP для внешних устройств – провайдеров телефонии, шлюзов и вышестоящими и одноранговыми АТС, находящихся во внешнем номерном плане, не управляемом системой. Вся работа происходит на основе учетных записей SIP-провайдеров. Для стыковки внутреннего номерного плана с одноранговыми и вышестоящими АТС и провайдерами применяются правила преобразования CallerId и CalledId (provider_callerid).

Обрабатывает запросы в режиме user-agent. Одним плечом всегда выступает внешний абонент, другим плечом всегда выступает внутренний сервер с ролью b2bua.
Медиа-шлюз применяется в случае, если звонок связан с учетной записью provider, имеющей включенную опцию "media".

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

Резервируется и масштабируется в режиме Active-Active.
Каждая учетная запись провайдера закрепляется за конкретным экземпляром роли esg, работающей на одном из сайтов, где обслуживается домен.

Подробнее о работе с провайдерами телефонии.

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

Код

esg

Режим работы

Сервис

Режим резервирования

Active-Active

Типы сайтов

Любые

Слой

Бизнес-логика

Размещение

Пограничный

Сохранение и восстановление состояния при перезагрузке

Нет

Приложение

era_sip

Ограничения

  • Запросы REFER и INVITE+Replaces всегда обрабатываются зеркально, то есть в рамках того направления, откуда получен запрос.

  • Является пограничной ролью, использует сертификат TLS для HTTPS и WSS подключений.

Параметры

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

Table 2. Параметры
Имя Тип Умолчание Описание

name

str

required

Имя. Может состоять из латинских букв и цифр, должно начинаться с буквы.

roletype

str

required

Тип роли. Возможные значения: "esg".

iface

str

required

Алиас сетевого интерфейса сервера, на котором будет происходить внутреннее взаимодействие ролей между собой.

ext

json

empty

Дополнительные опции роли. Содержит json объект или список.

enabled

bool

empty

Флаг активности роли. При установке в false роль не участвует в валидации и не запускается.

roleid

int

required

Идентификатор роли.
Уникален для всей системы, независимо от сайта или сервера. Не подлежит изменению.
Целое число от 1 до 9999.

separate

bool

required

Признак выделения роли в отдельную ноду.

udp

int

required

Локальный порт UDP для SIP. Этот же порт одновременно обрабатывает и TCP.
Например: 5080.
Поднимает слушателя UDP на групповом интерфейсе '0.0.0.0', либо интерфейсах, указанных параметром 'sip_ifaces'.

tcp

int

required

Локальный порт TCP для SIP. Если указано значение, отличное от UDP, то будет поднят дополнительно.
Например: 5080.
Поднимает слушателя TCP на групповом интерфейсе '0.0.0.0', либо интерфейсах, указанных параметром 'sip_ifaces'.

tls

int

empty

Локальный порт для соединений по tls. По умолчанию не открывается.
Например: 5081.
Поднимает слушателя TLS на групповом интерфейсе '0.0.0.0', либо интерфейсах, указанных параметром 'sip_ifaces'.

sip_internal_port

int

empty

Локальный порт для SIP-взаимодействия с другими микросервисами системы (UDP/TCP).
Например: 6180.
Используется для внутреннего взаимодействия с другими микросервисами системы по протоколу SIP.
Применяется в том случае, если для микросервиса задан список конкретных интерфейсов слушателя портов ('sip_ifaces').
Поднимается только на локальном интерфейсе ноды.
Не должен использоваться другими микросервисами, исполняемыми на том же самом сервере.

sip_ifaces

array<str>

[]

Список интерфейсов сервера, на которых поднимаются слушатели портов.
Указываются алиасы интерфейсов сервера.
Если не указано ни одного интерфейса, то заданные порты слушаются на всех интерфейсах (0.0.0.0).

Для ролей sg, esg, redirect, исполняемых на одном и том же сервере, в качестве внешних портов (udp,tcp,tls,wss) могут быть указаны одинаковые значения, если их списки прослушиваемых интерфейсов не пересекаются.

К списку прослушиваемых интерфейсов всегда добавляется оригинальный интерфейс текущей ноды с портом 'sip_internal_port', который не должен использоваться другими микросервисами на этом же сервере.

Если в момент запуска сервера какой-либо указанный из сетевых интерфейсов не поднят, то слушатель не запускается. После его появления для запуска слушателя необходимо перезагрузить ноду микросервиса.

log_cdr

bool

true

Выключатель логирования событий в лог cdr.

log_media

bool

true

Выключатель логирования медиа-функций media.

log_mgct

bool

true

Выключатель логирования протокола взаимодействия с MGC-контроллером в лог mgct.

log_sip

bool

true

Выключатель логирования трейса машины состояний диалога в лог sip.

log_trn

bool

true

Выключатель логирования SIP-трафика в лог trn.

use_srtp

bool

false

По умолчанию при инициации звонков на адреса, подключенные по TLS, отправляется SDP-offer для нешифрованного медиа потока (rtp). С помощью параметра можно для TLS адресов включить режим инициации отправки SDP-offerа с шифрованным медиа-потоком.
Применяется только для звонков, использующих пограничный медиагейт (media=1).

certdir

str

empty

Алиас каталога на сервере для хранения сертификатов (файлы server.crt и server.key).
Если путь не указан, то поиск сертификатов осуществляется в каталоге "/usr/lib/era/era_sip/priv/ssl"

keypass

str

empty

Пароль для расшифровки файла секретного ключа сертификата.

payloads_audio_offer

array<str>

`["PCMA/8000", "PCMU/8000"

"telephone-event/8000"]`

Список имен аудиокодеков, используемых для инициации звонка (вызове плеча).
Применяется только при использовании режима обслуживания медиа-вызова через bgmg.

В качестве значения - список, содержащий имена аудио-кодеков в формате "Name/Freq".
Поддерживаются следующие кодеки (case-sensitive):

  • telephone-event/8000,

  • PCMU/8000,

  • PCMA/8000,

  • GSM/8000,

  • G722/8000,

  • G729/8000,

  • CN/8000,

  • speex/8000,

  • speex/16000,

  • speex/32000,

  • G726-16/8000,

  • G726-24/8000,

  • G726-32/8000,

  • G726-40/8000,

  • iLBC/8000,

  • opus/48000/2.

Три основных формата: PCMA/8000, PCMU/8000 и telephone-event/8000 автоматически добавляются в инициируемые вызовы при любом значении поля.

payloads_video_offer

array<str>

empty

Список имен видеокодеков, используемых для инициации звонка (вызове плеча).
Применяется только при использовании режима обслуживания медиа-вызова через bgmg.

В качестве значения - список, содержащий имена видео-кодеков в формате "Name/Freq".
Поддерживаются следующие кодеки (case-sensitive):

  • H263/90000,

  • H263-1998/90000,

  • H264/90000,

  • VP8/90000,

  • VP9/90000.

use_video_transcoding

bool

false

Выключатель транскодинга видео.
Применяется при использовании bgmg.

  • false – все видео-кодеки из SDP INVITE-запроса, полученного от инициатора, транслируются без изменений в SDP INVITE-запросов на вызываемые устройства. В этом случае система не применяет ни свои знания о кодеках, ни транскодинг, икодек неизвестен системе, то прямая трансляция тем не менее остается возможной.

  • true – все видео-кодеки приводятся в соответствии с известными системе видео-кодеками, система предлагает вызываемой стороне все известные ей кодеки (с фильтром из payloads_video_offer), и при несовпадении выбранных устройствами кодеков осуществляется транскодинг на видео-стриме.

max_udp_size

int

1500

Максимальный размер udp пакета, отправляемый системой, в байтах.
Минимальное значение: 1500.
При превышении отправляемым пакетом установленного размера происходит автоматическая отправка через TCP.
При превышении отправляемым пакетом размера 1500 но до установленного в поле значения, происходит автоматическое разбиение пакета на фреймы и сборка их при получении на нижнем сетевом уровне.
Не все устройства поддерживают такой режим. В то же время не все устройства держат TCP открытым.

b2bmedia

bool

true

Выключатель применения медиа-шлюза ролью b2b для звонков, инициированных текущим экземпляром роли esg.

extaddrs

array<str>

empty

Список IP-адресов текущего сервера..
Применяется в одном из алгоритмов поиска учетной записи провайдера при получении INVITE-запросов извне, допуская указание в качестве домена в заголовке "To" одного из перечисленных в списке адресов.
Обычно необходимости в использовании этого поля не возникает, поскольку имеется возможность указать необходимое значение в настройках учетной записи провайдера.
Тем не менее в целях оптимизации и снятия потребности указывать в большом количестве учетных записей провайдеров одних и тех же значений, они могут быть указаны в опции роли esg.

stunserver

array<str>

empty

Список внешних STUN-серверов для определения внешнего IP-адреса сервера при работе за NAT.
Применяется в одном из алгоритмов поиска учетной записи провайдера при получении INVITE-запросов извне, допуская указание в качестве домена в заголовке "To" внешнего адреса NAT.
Формат значения - список URI вида 'sip:<DomainOrAddress>:<Port>'

sip_alg

array<object>

empty

Подстановка белых адресов.
В случае, если система установлена за NAT относительно абонентских устройств, то должен использоваться режим sip-alg на NAT.
Sip-alg производит подмену адресов в пакетах, отправляемых наружу, и принимаемых снаружи.
Функцию SIP-ALG можно активировать на пограничных ролях. С помощью данного параметра устанавливается набор локальных адресов кластера, которые требуется подменять на белые внешние адреса.

Формат:
[{"gray":"IpAddr", "white":"IpAddr"}, ...]

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

fwd_headers

array<object>

empty

Проброс заголовков.
ESG обслуживает вызовы в режиме B2BUA (back to back user agent). Для каждого участника создается отдельное плечо с уникальным Call-ID.
Формируя исходящий INVITE-запрос ESG по умолчанию не добавляет в него кастомные заголовки из входящего INVITE-запроса.
Чтобы обеспечить добавление в исходящий INVITE-запрос определенных кастомных заголовков из входящего INVITE-запроса, необходимо сообщить список их имен.

Формат:
["X-Header-1", "header-2", ...]

По умолчанию пусто.

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

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

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

Пример узла
{
  "name": "esg12",
  "roletype": "esg",
  "iface": "eth0",

  "roleid": 11260,
  "separate": true,
  "tcp": 5080,
  "udp": 5080,
  "tls": 5081,

  "log_cdr": true,
  "log_trn": true,
  "log_sip": true,
  "log_media": true,
  "log_mgct": true,

  "certdir": "/var/lib/era/certificates",
  "keypass": "eb9c4458016d3f1e378d02004c4f4f50",
  "max_udp_size": 10000,
  "stunserver": ["sip:stun.sipnet.ru:5060", "sip:demo.era.ru:5060"],

  "sip_alg": [
    {"gray":"172.16.0.14","white":"62.84.126.3"},
    {"gray":"172.16.0.15","white":"62.84.126.6"}
  ],

  "fwd_headers": [
    "X-Header-1",
    "X-Header-2"
  ]
}

См. также

  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт