Настройка оповещения по SMS
Для отправки оповещений КриптоПро DSS использует специальные SMS-плагины:
DSS.SmsService.StubPlugin.dll"DSS.SmsService.DevinoSms.dll"DSS.SmsService.MtsSms.dll"DSS.SmsService.SmppPlugin.dll.
Все плагины устанавливаются в папку <Путь установки>\DSS\Plugins\Sms.
Перед использованием плагина Администратор должен зарегистрировать плагин, как это описано в сценарии
настройки системы оповещения.
Внимание!
В профиле Пользователя/Оператора должна быть заполнена соответствующая контактная информация (Email).
Плагин DSS.SmsService.StubPlugin
Данный плагин предназначен для использования в тестовых целях. Тестовый плагин записывает содержимое
SMS-сообщения в текстовые файлы без их отправки. Папка, в которую сохраняются файлы, задаётся
параметром WorkingDirectory. Предварительно необходимо дать права на запись в данную директорию для
Пользователя IIS AppPool\CryptoProDSS-1-STS.
Параметры, задаваемые при регистрации, перечислены в таблице ниже.
| Наименование параметра | Описание | Значение по умолчанию | Обязательный |
|---|---|---|---|
| WorkingDirectory | Путь к папке для сохранения файлов с текстом SMS сообщений. | <Путь установки>\DSS\<StsAppName>\fakesms |
Нет |
Тип плагина, указываемый при регистрации в командлете Add-DssStsPlugin
в параметре -PluginTypeName "CryptoPro.DSS.SmsService.StubPlugin.SmsStub,DSS.SmsService.StubPlugin".
Плагин DSS.SmsService.DevinoSms
Данный плагин предназначен для работы со службой рассылки SMS http://ws.devinosms.com/SmsService.asmx. Параметры, задаваемые при регистрации, перечислены в таблице ниже.
Примечание
Названия параметров регистрозависимы.
| Наименование параметра | Описание | Значение по умолчанию | Обязательный |
|---|---|---|---|
| login | Логин для доступа к услуге. | Нет | Да |
| password | Пароль для доступа к услуге. | Нет | Да |
| sourceaddress | Подпись отправителя. Данное значение будет подставлено вместо номера отправителя. | Null | Да |
Тип плагина, указываемый при регистрации в командлете Add-DssStsPlugin
в параметре -PluginTypeName "CryptoPro.DSS.SmsService.DevinoSms.DevinoSmsPlugin,DevinoSmsPlugin".
Плагин DSS.SmsService.MtsSms
Данный плагин предназначен для работы со службой рассылки SMS http://mcommunicator.ru. Параметры, задаваемые при регистрации, перечислены в таблице ниже.
| Наименование параметра | Описание | Значение по умолчанию | Обязательный |
|---|---|---|---|
| login | Логин для доступа к услуге (представляет из себя номер телефона в формате 7XXXXXXXXXX). |
Нет | Да |
| password | Пароль для доступа к услуге. В качестве значения можно указать пароль в открытом виде, либо MD5-хэш от пароля (определяется параметром passwordFormat). |
Нет | Да |
| passwordFormat | Параметр определяет вид пароля, указанного в качестве значения параметра password. Может принимать два значения: raw – пароль указан в открытом виде, hashed – указано значение MD5функции хэширования от пароля. |
Raw | Нет |
| sourceAddress | Подпись отправителя. Данное значение будет подставлено вместо номера отправителя. При использовании «Подписи отправителя» необходимо указывать подпись в точности как она была подключена (с учетом регистра). | Null | Нет |
| serviceAddress | Адрес сервиса отправки SMS (необходим для задания адреса для доступа к сервису отличного от http://www.mcommunicator.ru/m2m/m2m_api.asmx) |
http://www.mcommunicator.ru/m2m/m2m_api.asmx |
Нет |
Если параметр необязательный, то его можно не указывать, в этом случае будет использоваться значение по умолчанию.
Если не указывать параметр sourceAddress, то сообщения будут приходить с номера 4938 (сообщения
будут приходить с указанного номера, даже если параметр задан, но не подключена соответствующая услуга).
Если задать параметр sourceAddress равным 79857707575, то сообщения будут отправлены с
федерального номера.
Тип плагина, указываемый при регистрации в командлете Add-DssStsPlugin
в параметре -PluginTypeName "CryptoPro.DSS.SmsService.MtsSms.MtsSmsPlugin,DSS.SmsService.MtsSms".
Плагин DSS.SmsService.SmppPlugin
Данный плагин предназначен для работы со службой рассылки SMS по протоколу SMPP. Параметры, задаваемые при регистрации, перечислены в таблице ниже.
| Наименование параметра | Описание | Значение по умолчанию | Обязательный |
|---|---|---|---|
| ServiceAddress | Адрес сервера SMPP. | Нет | Да |
| ServicePort | Порт доступа к серверу SMPP. | Нет | Да |
| SystemId | Логин для доступа к сервису. | Нет | Да |
| SystemPassword | Пароль для доступа к сервису. | Нет | Да |
| Source | Адрес отправителя. | Null | Нет |
Тип плагина, указываемый при регистрации в командлете Add-DssStsPlugin
в параметре -PluginTypeName "CryptoPro.DSS.SmsService.SmppPlugin.SmppPlugin,DSS.SmsService.SmppPlugin".
Настройка плагина для формирования SMS-сообщений
При формировании SMS-сообщения используется специальный плагин – его задача состоит в создании текста
сообщения на основе информации о выполняемом действии, подписываемом документе, одноразовом пароле и
т.п. Для регистрации и настройки плагина используется командлет Add-DssStsPlugin.
Параметры, задаваемые при регистрации, перечислены в таблице ниже.
| Наименование параметра | Описание | Значение по умолчанию | Обязательный |
|---|---|---|---|
| HEADER | Заголовок сообщения. Общая часть всех SMS сообщений. | Null | Нет |
| XSLT | XSLT-преобразование, которое следует применить над форматированным текстом, содержащим информацию о документе. | Преобразование по умолчанию | Нет |
| XSLT_FILE | Имя файла, содержащего XSLT-преобразование. | Null | Нет |
Плагин формирует текст SMS-сообщения на основе информации о документе. Информация о документе может представлять собой форматированный и неформатированный текст. Под форматированным тестом подразумевается некоторое XML-представление документа, к которому можно применить XSLT-преобразование.
По умолчанию используется следующее преобразование:
<?xml version='1.0'?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output method="text"/>
<xsl:template match="/">
<xsl:apply-templates select="//row"/>
</xsl:template>
<xsl:template match="row">
<xsl:value-of select="name"/>
<xsl:text>: </xsl:text>
<xsl:value-of select="value"/>
<xsl:if test="position()!=last()">
<xsl:text>, </xsl:text>
</xsl:if>
<xsl:if test="position()=last()">
<xsl:text>.</xsl:text>
</xsl:if>
</xsl:template>
</xsl:stylesheet>
Неформатированный текст добавляется в SMS-сообщение без изменений.
Тип плагина, указываемый при регистрации в командлете Add-DssStsPlugin
в параметре -PluginTypeName "CryptoPro.DSS.MessageFormatter.SMSFormatter,DSS.DSS.MessageFormatter".
Пример настройки оповещения по SMS
Пример демонстрирует настройку компонента оповещения через тестовый SMS плагин. Сообщения, отправляемые через тестовый плагин, будут сохранятся в файлы в указанной при настройке директории.
# Директория для сохранения файлов с сообщениями
$SMSBaseDir = "C:\tempsms\"
Write-Host "Добавление плагина для отправки СМС-сообщений"
Add-DSSStsPlugin -PluginTypeName "CryptoPro.DSS.SmsService.StubPlugin.SmsStub,DSS.SmsService.StubPlugin" -PluginType SMS -Settings @{"WorkingDirectory" = $SMSBaseDir}
Write-Host "Добавление плагина для форматирования СМС-сообщений"
Add-DSSStsPlugin -PluginTypeName "CryptoPro.DSS.MessageFormatter.SMSFormatter,DSS.MessageFormatter" -PluginType Formatter -Settings @{Header="КриптоПро DSS."}
Write-Host "Добавление модуля оповещения для отправки СМС-сообщений"
Add-DSSInternalNotifier -TransportPluginID 1 -FormatterPluginID 2 -NotifierType SMS -Settings @{"MinQueueSize"="0";"MaxQueueSize"="10000";"TimerInterval"="500";"TTL"="1";"MessageWindow"="50";"ThreadCount"="1";"Enabled"="true"}