Провижининг телефонов Grandstream с помощью модуля FreePBX «OSS PBX End Point Manager»

Зачем использовать конфиги

Зачем использовать XML-конфиги

XML-конфиги для телефонов Grandstream проще создавать и редактировать, т.к., в отличие от не-XML-конфигов Grandstream, они не содержат бинарных данных и представляют из себя обычные текстовые файлы. Впрочем, алгоритм создания не-XML-конфигов Grandstream уже реализован в модуле «OSS PBX End Point Manager», настоящая причина использования XML-конфигов для телефонов Grandstream — возможность шифрования XML-конфигов.

Зачем использовать шифрованные конфиги

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

Установка «OSS PBX End Point Manager»

Как уже упоминалось выше, для провижининга телефонов Grandstream можно использовать модуль FreePBX «OSS PBX End Point Manager». Для того, чтобы этот модуль делал XML-конфиги для телефонов Grandstream, требуется доработка модуля.
Для начала установим модуль «OSS PBX End Point Manager». Для этого в web-интерфейсе FreePBX заходим в раздел настроек Admin -> Module Admin

Включаем установку неподдерживаемых модулей и нажимаем «Check Online» для проверки доступных для установки модулей.

Находим в списке модуль «OSS PBX End Point Manager», нажимаем на названии модуля для отображения доступных действий, нажимаем «Install»

Нажимаем кнопку «Process» в правом верхнем или правом нижнем углу страницы для установки модуля «OSS PBX End Point Manager»

После завершения установке применяем изменения в FreePBX нажатием «Apply Config».

Базовая настройка «OSS PBX End Point Manager»

Заходим в раздел настроек Connectivity -> OSS Endpoint Advanced Settings, заполняем там поля:

IP address of phone server — IP-адрес сервера Asterisk, к которому должны подключаться IP-телефоны (в данном примере — 192.168.1.100)
Configuration Type — выбираем «File (TFTP/FTP)» (провижининг всё равно можно будет делать и по TFTP и по HTTP/HTTPS)
Global Final Config & Firmware Directory — указываем корень TFTP-сервера (обычно /tftpboot/)
Time Zone (like USA-5) — выбираем свой часовой пояс
Time Server (NTP Server) — указываем NTP-сервер, который будут использовать IP-телефоны (в данном примере это IP-адрес сервера Asterisk, т.к. на нём запущен и NTP-сервер)
Disable TFTP Server Check — отмечаем, чтобы отключить проверку TFTP-сервера

Завершаем настройку нажатием кнопки «Update Globals»

Переходим в раздел настроек Connectivity -> OSS Endpoint Configuration, нажимаем «Check for Updates», через некоторое время должен отобразиться список всех доступных модулей для «OSS PBX End Point Manager».

Устанавливаем модуль Grandstream и включаем любую модель из раздела «GXP Enterprise HD series», например GXP1400 (не имеет значения, т.к. их конфиги идентичны).

На данном этапе уже можно делать провижининг телефонов Grandstream, но мы пойдём дальше и изменим код модуля таким образом, чтобы он создавал шифрованные XML-конфиги.

Модификация модуля «OSS PBX End Point Manager» под свои нужды

Редактирование шаблона конфигов

Для начала, сменим имя шаблона конфигов для телефонов Grandstream с cfg$mac на cfg$mac.xml. Для этого нужно переименовать файл шаблона и поменять имя шаблона в таблице MySQL endpointman_product_list

cd /var/www/html/admin/modules/_ep_phone_modules/endpoint/grandstream/gxphd
mv cfg$mac cfg$mac.xml

имя пользователя, пароль и имя базы данных для выполнения следующего запроса можно посмотреть в файле /etc/freepbx.conf

mysql -u freepbxuser -p asterisk -e ‘UPDATE ‘endpointman_product_list’ SET ‘config_files’=»cfg$mac.xml» WHERE ‘cfg_dir’=»gxphd»‘

Заходим в раздел FreePBX Connectivity -> OSS Endpoint Advanced Settings, далее в подраздел «Product Options/Configuration Editor», выбираем из списка «Select Product» значение «GXP Enterprise HD Series [2100,2110,2120]», нажимаем кнопку Select. В списке «Local File Configs» должен быть шаблон cfg$mac.xml, кликните на имя шаблона для редактирования.

В теле шаблона содержится конфиг в старом формате, нужно удалить оттуда всё, вписать текст конфига в формате XML и нажать кнопку Save. Ниже общий пример конфига для телефонов Grandstream (расшифровку параметров конфига, а также полный список параметров для конкретных моделей телефонов можно узнать из шаблонов, предоставляемых производителем [[http://www.grandstream.com/sites/default/files/Resources/config-template.zip]]).

?xml version=»1.0″ encoding=»UTF-8″ ?>
<!— BroadSoft XML Provisioning Configuration —>
<gs_provision version=»1″>
<mac>{$mac}</mac>
     <config version=»1″>

<!—##############################################################################—>
<!—## Advanced/System-wide Options #—>
<!—##############################################################################—>
<!—# Admin password for web interface—>
<P2>admin</P2>
<!—# User password for web interface—>
<P196></P196>

<!—# Firmware Upgrade and Provisioning—>
<!—# 0 — Always Check For New Firmware—>
<!—# 1 — Check New Firmware only when F/W pre/suffix changes—>
<!—# 2 — Always Skip the Firmware Check—>
<P238>0</P238>

<!—# Firmware Upgrade Via. 0 — TFTP Upgrade, 1 — HTTP Upgrade, 2 — HTTPS Upgrade—>
<P212>1</P212>

<!—# Firmware Server Path—>
<P192></P192>

<!—# Config Server Path—>
<P237>{$firmware_srv_path}</P237>

<!—# Allow DHCP Option 43 and Option 66 to override server: 0 — No, 1 — Yes. Default is Yes.—>
<!—# When set to Yes(1), it will override the configured provision path and method.—>
<P145>1</P145>

<P1362>ru</P1362>

<!—### Account 1—>

<!—# Account Active (In Use). 0 — No, 1 — Yes—>
<P271>1</P271>

<!—# Account Name—>
<P270>{$username.line.1}</P270>

<!—# Symmetric RTP—>
<P291>1</P291>

<!—# SIP Transport—>
<P130>{$transport.line.1}</P130>

<!—# Use Actual Ephemeral Port in Contact with TCP/TLS. 0 — No, 1 — Yes. Default is 0—>
<P2331>1</P2331>

<!—# SRTP Mode. 0 — Disabled, 1 — Enabled but not forced, 2 — Enabled and forced, 3 — Optional. Default is 0—>
<P183>0</P183>

<!—# Register Expiration (in minutes). Default is 60. Max about 45 days—>
<P32>3</P32>

<!—# Reregister Before Expiration (in seconds). Default is 0 second—>
<P2330>120</P2330>

<!—# SIP Server—>
<P47>{$server_host.line.1}:{$server_port.line.1}</P47>

<!—# SIP User ID—>
<P35>{$username.line.1}</P35>

<!—# Authenticate ID—>
<P36>{$username.line.1}</P36>

<!—# Authenticate password—>
<P34>{$secret.line.1}</P34>

<!—# Display Name—>
<P3>{$username.line.1}</P3>

<!—# Enable Call Features. 0 — No, 1 — Yes—>
<P191>0</P191>

<!—# Dial Plan—>
<P290>{$dialplan}</P290>

<!—#Voice mail—>
<P33>*97</P33>

<!—#Send DTMF. 8 — in audio, 1 — via RTP(RFC2833), 2 — via SIP INFO—>
<P73>1</P73>

<!—# Time Zone—>
<P64>TZQ-3</P64>

<!—# NTP server—>
<P30>{$network_time_server}</P30>

<!—# Allow DHCP Option 2 to override Time Zone setting. 0 — No, 1 — Yes.—>
<!—# When set to Yes(1), it will override the configured Time Zone setting if available. —>
<P143>1</P143>

<!—# Weather Update—>
<!—# Enable weather update. 0 — No, 1 — Yes. Default is 1—>
<P1402>0</P1402>

<!—# Date Display Format.—>
<!—# 0: yyyy-mm-dd   eg. 2011-10-31—>
<!—# 1: mm-dd-yyyy   eg. 10-31-2011—>
<!—# 2: dd-mm-yyyy   eg. 31-10-2011—>
<!—# (some options might not fit for the screen layout)—>
<P102>2</P102>

<!—# Time Display Format. 0 — 12 Hour, 1 — 24 Hour—>
<P122>1</P122>

<!—# Lock Keyboard—>
<P1382>0</P1382>

<!—# Hold Method. 0 — Auto, 1 — RFC3264. Default is 0—>
<P2361>1</P2361>
      </config>
</gs_provision>

Рекомендуется поменять пароли администратора и пользователя (параметры P2 и P196), также обратите внимание на часовой пояс (параметр P64), пояс TZQ-3 совместим с московским временем (GMT+3), полный список часовых поясов можно посмотреть в шаблах предоставляемых производителем.

Редактирование кода модуля

1. Редактируем файл /var/www/html/admin/modules/_ep_phone_modules/endpoint/grandstream/gxphd/phone.php
Нужно закомментировать отрывок, заменяющий «+» на «%2B» (в XML-конфиге не нужно заменять «+» в строке диалплана) и добавить код для правильной кодировки используемого транспорта для SIP (0 — UDP, 1 — TCP, 2 — TLS).

if (isset($this->settings[‘dialplan’]))
{
$this->settings[‘dialplan’] = str_replace(«+», «%2B», $this->settings[‘dialplan’]);
}

должно стать

/*if (isset($this->settings[‘dialplan’]))
{
$this->settings[‘dialplan’] = str_replace(«+», «%2B», $this->settings[‘dialplan’]);
}*/

foreach ($this->settings[‘line’] as $key => $data)
{
      if (isset($this->settings[‘line’][$key][‘transport’]))
        {
            if($this->settings[‘line’][$key][‘transport’] == ‘UDP’)
{ $this->settings[‘line’][$key][‘transport’] = ‘0’; }
            if($this->settings[‘line’][$key][‘transport’] == ‘TCP’)
{ $this->settings[‘line’][$key][‘transport’] = ‘1’; }
            if($this->settings[‘line’][$key][‘transport’] == ‘TLS’)
{ $this->settings[‘line’][$key][‘transport’] = ‘2’; }
        }
}

2. Редактируем файл /var/www/html/admin/modules/_ep_phone_modules/endpoint/grandstream/base.php
В этом файле нужно полностью закомментировать функции parse_gs_config и gs_config_out (они нужны для создания старых конфигов Grandstream) и отредактировать функцию create_encrypted_file
изначальная версия create_encrypted_file

function create_encrypted_file($list)
{
   $temporary_directory_location = function_exists(‘sys_get_temp_dir’) ? sys_get_temp_dir() : ‘/tmp’;
   foreach ($list as $key => $data)
   {
     file_put_contents($temporary_directory_location . «/» . $key, $data);
     if (file_exists(«/usr/src/GS_CFG_GEN/bin/encode.sh»))
     {
       exec(«/usr/src/GS_CFG_GEN/bin/encode.sh » . $this->mac . » » . $temporary_directory_location . «/» . $this->mac . «.cfg » . $temporary_directory_location . «/cfg» . $this->mac);
       $contents = file_get_contents($temporary_directory_location . «/cfg» . $this->mac);
       unlink($temporary_directory_location . «/cfg» . $this->mac);
     } else
       {
         $params = $this->parse_gs_config($temporary_directory_location . «/» . $key);
         $contents = $this->gs_config_out($this->mac, $params);
       }
       $files[«cfg» . $this->mac] = $contents;
       unlink($temporary_directory_location . «/» . $key);
   }
   return($files);
}

отредактированная версия

function create_encrypted_file($list)
{
  $temporary_directory_location = function_exists(‘sys_get_temp_dir’) ? sys_get_temp_dir() : ‘/tmp’;      foreach ($list as $key => $data)
  {
    file_put_contents($temporary_directory_location . «/» . $key, $data);
    exec(‘/usr/bin/dos2unix ‘ . $temporary_directory_location . «/» . $key);
    exec(‘/usr/bin/openssl enc -e -aes-256-cbc -k encryption_password -in ‘ . $temporary_directory_location . «/» . $key . ‘ -out ‘ . $temporary_directory_location . «/cfg» . $this->mac);
    $contents = file_get_contents($temporary_directory_location . «/cfg» . $this->mac);
    $files[«cfg» . $this->mac] = $contents;
  }
return($files);
}

Сгенерированный файл будет зашифрован с помощью алгоритма AES-256-CBC и пароля encryption_password (замените на свой). Также обратите внимание на то, что в коде указан абсолютный путь к приложениям dos2unix и openssl, путь верен для дистрибутива CentOS 6, если используете другой дистрибутив, скорректируйте пути, если они не верны (также указанные приложения должны быть установлены в системе).

Настройка завершена, можно создавать конфиги для телефонов Grandstream. Для тестирования рекомендуется сперва закомментировать строку, вызывающую openssl для шифрования и убедиться, что модуль генерирует правильные XML-конфиги, альтернативно можно расшифровать и прочитать конфиг-файл с помощью команды:

openssl enc -d -aes-256-cbc -k encryption_password -in cfg000b82001122.xml -out cfg000b82001122_dec.xml

Создание конфигов Grandstream, настройка на стороне телефонов

Для создания конфигов, нужно зайти в раздел FreePBX Connectivity -> OSS Endpoint Device List. Далее нужно вписать MAC-адрес телефона в поле «Mac Address», выбрать Grandstream в списке «Brand», выбрать модель GXP1400 в списке «Model», выбрать внутренний номер в списке «Extension Number» и нажать кнопку «Add».

После этого конфиг для телефона с соответствующим MAC-адресом будет создан, осталось заставить телефон скачать этот конфиг. Провижининг будет осуществляться по HTTP, а не по TFTP, т.к. у протокола HTTP нет проблем с NAT. Для того, чтобы конфиг-файлы были доступны по HTTP, достаточно создать символьную ссылку в корне HTTP-сервера на корень TFTP-сервера. Пример для CentOS 6:

ln -s /tftpboot /var/www/html/prov

Файлы для провижининга будут доступны по адресу http://192.168.1.100/prov

ПРИМЕЧАНИЕ: Можно указать в DHCP-опции 66 значение «http://192.168.1.100/prov» без кавычек, чтобы телефоны использовали HTTP, а не TFTP для провижининга.

Для провижининга телефона можно использовать либо DHCP-опцию 66, либо указать путь для скачивания конфиг-файла в настройках телефона и перезагрузить телефон. Мы воспользуемся вторым способом, т.к. заходить в настройки телефона всё равно придётся, чтобы указать пароль для расшифровки конфиг-файла.

Заходим в раздел настроек Maintenance -> Upgrade and Provisioning, вводим пароль для расшифровки конфиг файла в поле «XML Config File Password» (тот же, который используется для шифрования конфига в файле base.php, в этом примере — encryption_password), выбираем HTTP в поле «Upgrade via» и вписываем путь для скачивания конфига в поле «Config Server Path» (не нужно добавлять «http://», так работать не будет).

Обновление прошивки можно настроить здесь же, достаточно указать в поле «Firmware Server Path» то же значение, что и в «Config Server Path», перед этим нужно распаковать в корень TFTP-сервера архив с файлами прошивки для соответствующих моделей телефонов (скачать их можно с сайта производителя [[http://www.grandstream.com/support/firmware]]).

После завершения настроек нажимаем кнопку «Save and Apply» внизу страницы для применения настроек, затем «Reboot» в правом верхнем углу для перезагрузки.

После перезагрузки телефон должен скачать файл настроек, для контроля этого процесса можно проверить лог web-сервера, пример для сервера Apache и телефона с IP-адресом 192.168.1.23:

tailf /var/log/httpd/access_log | grep 192.168.1.23

Если с настройками сети, файрвола и web-сервера всё в порядке, то в логах сервера должен появиться запрос файла cfg<MAC>.xml (где <MAC> — MAC-адрес телефона), код ответа сервера должен быть 200. После загрузки телефона можно будет проверить правильность его настроек. И напоследок замечание о том, что телефоны Grandstream перезагружаются очень долго, 3-4 минуты — с применением новых настроек, 6-7 минут — с обновлением и применением новых настроек.