Войти

Описание набора «toolset»

З.1. Состав набора

Набор «toolset» поставляется в следующей комплектации:

  • Набор утилит с расширением *.bat для запуска в среде Windows:
    • transactiontool (осуществляет запуск файла transactiontool-3.4.14.0.jar из директории lib, который предоставляет код транзакции из системы генерации кодов транзакций);
    • identitytool (осуществляет запуск файла identitytool-3.4.14.0.jar из директории lib, который предоставляет сгенерированные идентификаторы сообщений либо файлов вложений);
    • signertool (осуществляет запуск файла signertool-3.4.14.0.jar из директории lib, который предоставляет ЭП-СП содержательной части сообщения или файлов вложений);
    • messagetool (осуществляет запуск файла messagetool-3.4.14.0.jar из директории lib, который формирует и отправляет сообщения в СМЭВ3.х);
    • adminservtool (осуществляет запуск файла adminservtool-3.4.14.0.jar из директории lib, который формирует и отправляет сообщения в административный сервис СМЭВ3.х для переключения на резервный ГРУ).
  • Набор утилит с расширением *.sh для запуска в среде Linux:
    • transactiontool (осуществляет запуск файла transactiontool-3.4.14.0.jar из директории lib, который предоставляет код транзакции из системы генерации кодов транзакций);
    • identitytool (осуществляет запуск файла identitytool-3.4.14.0.jar из директории lib, который предоставляет сгенерированные идентификаторы сообщений либо файлов вложений);
    • signertool (осуществляет запуск файла signertool-3.4.14.0.jar из директории lib, который предоставляет ЭП-СП содержательной части сообщения или файлов вложений);
    • messagetool (осуществляет запуск файла messagetool-3.4.14.0.jar из директории lib, который формирует и отправляет сообщения в СМЭВ3.х);
    • adminservtool (осуществляет запуск файла adminservtool-3.4.14.0.jar из директории lib, который формирует и отправляет сообщения в административный сервис СМЭВ3.х для переключения на резервный ГРУ).
  • Набор конфигурационных файлов с расширением *. properties:
    • сonfig (содержит настройки перечисленных выше файлов);
    • log4j (содержит настройки встроенного сервиса логирования функционирования НИК).
  • Директория lib (содержит файлы расширения *.jar, обеспечивающих функционирование НИК).

З.2. Требования к ПО для запуска набора

Для обеспечения функционирования набора «toolset» предварительно должно быть развёрнуто ПО, приведённое в таблице 1.

Таблица 1 – ПО необходимое для функционирования набора «toolset»

Категории ПО

Наименование

Версия

Характеристики

1

Виртуальная машина java

Java JRE

1.7.0.5 – 1.7.0.21

ПО исполнения файлов расширения *.jar, находящихся в директории lib.

2

Средство криптозащиты информации

КриптоПро CSP

либо

КриптоПро JCP

3.6.1

1.0.54

ПО, необходимое для функционирования signertool, adminservtool и messagetool.

3

Библиотека криптоалгоритмов

Trusted Java

2.0

ПО, необходимое для функционирования signertool, adminservtool и messagetool, только в случае использования КриптоПро CSP.

З.3. Порядок запуска утилит набора

При запуске любой утилиты, кроме adminservtool, без входных данных либо с неверными входными данными в консоли выведется описание требований к входным данным для запущенной утилиты.

При запуске утилит в среде Windows либо Linux входные данные можно указать:

  • либо в командной строке в соответствии с шаблоном: <наименование утилиты> -<параметр 1> -<параметр 2> … -<параметр n>, например: transactiontool.bat -serviceCode 11111111111111111111 -participantCode 11111111111111111111 -of output/trans.out;
  • либо в файле, например: создать файл trans.args (возможно создание текстового файла с любым расширением: например, *.args, *.txt, *.in и т.д.) с содержанием, приведенным на рисунке 53, и запустить следующим образом: transactiontool.bat -argsFile input/trans.args.

Рисунок 53 – Содержимое файла trans.args с входными данными.

В приведенном выше примере необязательный параметр «of output/trans.out» указывает на место, название и расширение создаваемого файла с выходными данными. Без указания данного параметра выходные данные будут выведены в консоль.

З.4. Установочная конфигурация

Установочная конфигурация набора «toolset» определяется обязательными настройками, приведёнными в таблице 2.

Таблица 2 – Настройки утилит набора «toolset»

Наименование настройки

Усл. обозн.

Ед. изм.

Пример

1

Настройки файла сonfig.props

1.1

Настройки transactiontool

1.1.1

Адрес веб-сервиса системы генерации кодов транзакций

transaction.service.url

-

http://10.215.0.77:8580/tm/Marker?wsdl[1]

1.1.2

Таймаут соединения с веб-сервисом системы генерации кодов транзакций

transaction.service.timeout

мс

10000

1.2

Настройки messagetool

1.2.1

Перечень идентификаторов ГРУ СМЭВ3.х

transport.list

-

main, reserve, где:

-  main – это идентификатор основного ГРУ СМЭВ3.х

-  reserve – это идентификатор резервного ГРУ СМЭВ3.х

1.2.2

Адрес веб-сервиса основного ГРУ СМЭВ3.х

transport.main.url, где main – это идентификатор основного ГРУ СМЭВ3.х

-

http://10.215.0.62:7500/ws?wsdl[2]

1.2.3

Время, через которое произойдет переключение на резервный ГРУ при условии разрыва установленного соединения с основным ГРУ

transport.main.timeout, где main – это идентификатор основного ГРУ СМЭВ3.х

мс

100000

1.2.4

Адрес веб-сервиса резервного ГРУ СМЭВ3.х

transport.reserve.url, где reserve – это идентификатор резервного ГРУ СМЭВ3.х

-

http://10.215.0.63:7500/ws?wsdl[3]

1.2.5

Время, через которое произойдет переключение на резервный ГРУ при условии разрыва установленного соединения с основным ГРУ.

transport.reserve.timeout, где reserve – это идентификатор резервного ГРУ СМЭВ3.х

мс

100000

1.2.6

Адрес FTP-сервера ФХ СМЭВ3.х

large.attachment.transport.address

-

10.215.0.136[4]

1.2.7

Логин доступа в FTP-сервер ФХ СМЭВ3.х

large.attachment.transport.login

-

anonymous

1.2.8

Пароль доступа в FTP-сервер ФХ СМЭВ3.х

large.attachment.transport.password

-

smev

1.2.9

Количество попыток переотправки файла вложения сообщения

large.attachment.transport.retries

шт.

3

1.2.10

Таймаут соединения с FTP-сервером ФХ СМЭВ3.х

large.attachment.transport.timeout

мс

10000

1.2.11

Контрольная проверка сообщения, отправляемого в СМЭВ3.х (если =0, то проверка отключена; если =1, то проверка включена)

template.validate.input

-

1

1.2.12

Контрольная проверка сообщения, принятого из СМЭВ3.х (если =0, то проверка отключена; если =1, то проверка включена)

template.validate.output

-

1

1.2.13

Переключатель логирования событий контрольной проверки сообщения, отправляемого в СМЭВ3.х (если =0, то логирование отключено; если =1, то логирование включено)

template.log.input

-

1

1.2.14

Переключатель логирования событий контрольной проверки сообщения, принятого из СМЭВ3.х (если =0, то логирование отключено; если =1, то логирование включено)

template.log.output

-

1

1.2.15

Контрольная проверка ЭП-СМЭВ (если =0, то проверка отключена; если =1, то проверка включена)

template.validate.smev.signature

-

1

1.2.16

Параметр сохранения принимаемых вложений сообщений (путь сохранения файлов вложений)

template.local.storage

-

output/client

1.3

Настройки signertool

1.3.1

Имя криптопровайдера

signer.provider

-

JCP

1.3.2

Алиас сертификата

signer.certificate.alias

-

dev2

1.3.3

Алиас ключа

signer.private.key.alias

-

dev2

1.3.4

Пароль

signer.private.key.password

-

123456

1.3.5

Место нахождения сертификата

signer.smev.certificate.store

-

C:/docs/smev/client_2015/testData/cert

1.4

Настройки adminservtool

1.4.1

Адрес административного сервиса

adminservice.url

-

http://localhost:7070/admserv/AdministrativeService?wsdl

1.4.2

Таймаут соединения с административным сервисом

adminservice.timeout

мс

100000

2

Настройки файла log4j.props

2.1

Обозначение логгеров

log4j.rootLogger

-

STDOUT, FILE

2.2

Имплементация логгера в файл

log4j.appender.FILE

-

org.apache.log4j.RollingFileAppender

2.3

Наименование и место создания файла логгера

log4j.appender.FILE.File

-

toolset.log

2.4

Максимальный размер файла логгера, при достижении которого создаётся новый файл логгера

log4j.appender.FILE.MaxFileSize

МБ

16МВ

2.5

Максимальное количество файлов логгера, при достижении которого старые файлы заменяются новыми файлами логгера

log4j.appender.FILE.MaxBackupIndex

шт.

256

2.6

Имплементация формата сообщения лога, записывающегося в файл логгера

log4j.appender.FILE.layout

-

org.apache.log4j.PatternLayout

2.7

Регулярное выражение, описывающее формат сообщения лога, записывающегося в файл логгера

log4j.appender.FILE.layout.conversionPattern

-

[%d{dd.MM.YYYY HH:mm:ss.SSS}] %5p [%t] - %m%n

2.8

Имплементация логгера в консоль

log4j.appender.STDOUT

-

org.apache.log4j.ConsoleAppender

2.9

Имплементация формата сообщения лога, выводящего в консоль

og4j.appender.STDOUT.layout

-

org.apache.log4j.PatternLayout

2.10

Регулярное выражение, описывающее формат сообщения лога, выводящего в консоль

og4j.appender.STDOUT.layout.conversionPattern

-

[%d{dd.MM.YYYY HH:mm:ss.SSS}] %5p [%t] - %m%n

2.11

Кодировка сообщения лога, выводящего в консоль

log4j.appender.STDOUT.Encoding

-

windows-1251

З.5. Описание входных и выходных параметров

Описание входных и выходных данных набора «toolset» приведено в таблице 3.

Таблица 3 – Перечень входных и выходных данных набора «toolset»

Наименование данных

Усл. обозн.

Ограничения

Комментарий

1

Утилита transactiontool

1.1

Входные данные

1.1.1

Код ФРГУ госуслуги/признак госфункции

serviceCode

Обязательный параметр, не более 20 символов

Например: 11111111111111111111

1.1.2

Код ФРГУ информационной системы

participantCode

Обязательный параметр, не более 20 символов

Например: 11111111111111111111

1.1.3

Сведения о получателе услуги либо функции

participantDescr

Опциональный параметр, не более 1000 символов

-

1.1.4

Сведения об услуге либо функции

serviceDescr

Опциональный параметр, не более 1000 символов

-

1.2

Выходные данные

1.2.1

Код транзакции

-

-

Например: d02b9d45-cbe0-11e5-a4f5-86958c02569a|11111111111111111111|W94wQVXgoIrcYgReRDzZun+zv62MUTqJG2v7tinVUapvI7cSnXf0jCFcYPEwKGXINzXKQMn0PhEqFwcojnop8OFVBQ9LFfjGGhZko3xJ8Hnl7Ypn/CJgo5MeXyLTSUt6iCHEhSynz764gzorCsXYv4QBql7LwKEx65a7WVT1BB0+nt/Bioy//JHR728nyfFP0ELXvrg41b0Kdc0REtwVfnw2Seg0ELbgaEtrKKN9hQtVDC9x0flotIcZlY4I84IBxGM2SWfF68Yy63dp0XZAINqUx+FgHh04vuXaLfmFrIB73kB32iYexmXwjTBiCEKYgEvo+jlJ9/3+cwVPIn24cQ==

2

Утилита messagetool

2.1

Входные данные

2.1.1

Вид сообщения

cmd


Обязательный параметр, принимает одно из следующих значений:
- sendReq
- sendResp
- getReq
- getResp
- sendRejResp
- sendStatusResp
- ack
- getStatus

сmd sendReq означает сообщение, передаваемое через метод sendRequest сервиса СМЭВ.
сmd sendResp означает сообщение, передаваемое через метод sendResponse сервиса СМЭВ.
сmd getReq означает сообщение, передаваемое через метод getRequest сервиса СМЭВ.
сmd getResp означает сообщение, передаваемое через метод GetResponse сервиса СМЭВ.
сmd sendRejResp
означает сообщение об отклонении запроса, передаваемое через метод sendResponse сервиса СМЭВ.
сmd sendStatusResp
означает статусное сообщение, передаваемое через метод sendResponse сервиса СМЭВ.
сmd ack означает сообщение, передаваемое через метод ack сервиса СМЭВ.
сmd GetStatus означает сообщение, передаваемое через метод GetStatus сервиса СМЭВ.
2.1.2
Блок бизнес-данных сообщения
if
Обязательный параметр для cmd sendReq и cmd sendResp. Принимает путь к файлу формата *.xml с блоком бизнес-данных сообщения.
Например: if=testdata/request.xml
2.1.3
Код транзакции
tid
Обязательный параметр для cmd sendReq.
Принимает код транзакции, полученный из системы генерации кодов транзакций средствами утилиты transactiontool
Например: tid=1bbe12f1-ded5-11e5-a9db-86958c02569a|12345678901234567890|jOW0eLrHN7jyiQ6bsfbuA/NK3R0CEdD7Rqm2smNNgflMgsb8xdOYzExucVQuA3ZhfZ2T4kLUJQGfGgsZZZzYcHR/Zw/ZVQd4sUoifa9xKBtrVOLBR997TLea43rjn1PrGvw8136spSMON9kjzphkgSABLanww+Aeb/TsHg+gdmbi2q8joWg9gKbx5AP2jCNVF4yaUSFUtutMKvN3rAg+km7p88zR1xepzq0+f3jr8jWhsbUnwoNDXcqVY0h0gS1ZayeRL5nndodzGTNeU0WKvt7pCtHltj4zCppG3olArgirk3gkJ7C4di6jnxgSTuHokdoh4g0C9qRU4fFO2mpmjQ==
2.1.4
Файлы вложения, передаваемые вместе с сообщением
mtomAtts
Опциональный параметр для cmd sendReq и cmd sendResp. Принимает пути к файлам, передаваемым вместе с сообщением. Пути к файлам приводятся через «;».
Например: mtomAtts=testdata/mtom1.txt;testdata/mtom2.txt
2.1.5
Файлы вложения, передаваемые отдельно от сообщения
largeAtts
Опциональный параметр для cmd sendReq и cmd sendResp. Принимает пути к файлам, передаваемым отдельно от сообщения. Пути к файлам приводятся через «;».
Например: largeAtts=testdata/large_file1.jpg;testdata/large_file2.jpg
2.1.6
Информация о бизнес-процессе, в рамках которого пересылается данное сообщение.
bpm
Опциональный параметр для cmd sendReq. Принимает путь к файлу формата *.xml с описанием бизнес-процесса.
Например: bpm=testdata/bpm1.xml
2.1.7
Время жизни сообщения
eol
Опциональный параметр для cmd sendReq. Принимает значение даты в формате ДД.ММ.ГГГГ ЧЧ:ММ:СС.
Например: eol=07.10.2015 18:43:00
2.1.8
ЭП-СП файлов вложения или содержательной части сообщения
ps
Опциональный параметр для cmd sendReq и cmd sendResp.
Принимает путь к файлу формата *.xml с ЭП-СП, полученного средствами утилиты signertool
Например: ps=testdata/personal_signature.xml
2.1.9
Обратный адрес
replyTo
Обязательный параметр для cmd sendResp, сmd sendRejResp и сmd sendStatusResp.
Принимает значение обратного адреса.
Например: replyTo=eyJzaWQiOjM3LCJtaWQiOiJjMWNhOGNjNC02Y2RjLTExZTUtOTUxMi1kNGM5ZWZmM2I1OTQiLCJ0Y2QiOiJmNTkyNzc5Ni1lMWFlLTQ4ZmEtYjE0MS1kNzkwYzlhMDZiMTd8MjAxNS0wNC0yNFQwOTozNzo1MS44OTh8ZnJndTJ8VHZjWjF4T2VnTEgrTVpyVXRIdWpBdCtRcHlxWmh6RHVTSHNxbkJPYkkraWJzN3k0MGZjODhlSkxyQy9RSW1hTVYvYmNYcHBsUkh4NWpzS294UVpEREV6UlNmMDNRK1ROa1lCRms0L1FtZW1NNFVHYmpZY2FQOU16YzBXT0QzblIzYXdzZjhzWU96VWpQclV5cTZPenhiZk8rK01Fd0psYmpjdWtXSDZQNUFFWTF4UU0wbHRPdGhZQ2h6Ulk4SWQ0RGFGanBkWEZZMitITzFxOWhsazlFOVZBZndtTHlXMGJ4MTBmTGM2bVBUSUF2ajJ6QjVPV010cW5ydjJobUF1Qm9WQjJWWXI5TE4wT3VEcWZ5MkRpb3NzSjdYVWc1cHhRTnphdWtpb1Nxc2dZSWVNSkhrZ1U2MXBPZlZ5cmdRWXBJZEo3UHM0dXlleFh3SXJJME5WdDFGYXg3YmhDblhSRFZpZ3RxNEYwaVA0Tk9vSTd0L1ppWlFWVDkzQ2FKL2hON2lpcXVFb3piUkRRZ3Ayd1pRbktMai8zRjZuaUlxSFJoZFFTMDFmcEJoV28xbEZkNDhySk1hMkplL2ovemQzeHJDa2RIT2p3NGJySnBlbXZlMzFWODI5SFM5OFZTMk93YVRuL2dTRjY5Yi91S2QzbFlCN3pjMGVtNDQ5OUt3Ym1DcUlVT1BvU1JVWldiL2RCcEczVDBEb2c3MCtIS3JoT3ljY2hCUDdUZU10Q09SZU9nYUFGa0FHdHVicGNBL1VJUEkrdkZDUkpQV1lyK0lMUDRXU3NpektzVi9EQzdZSmdpcmE0dzJ1RHZXOTlUWlY3dm5sOTltUEJiQnloTm9tL3gyN2E2U0toK3MrSitLaXQ0SGV6a1VGMGxUeUdwWkZzU0w0dW43RmVxMTg9IiwicmlkIjoiYzFjYThjYzQtNmNkYy0xMWU1LTk1MTItZDRjOWVmZjNiNTk0IiwiZW9sIjoxNDQ0MjE0MTEwLCJuaWQiOiIxIiwic2xjIjoieC1hcnRlZmFjdHMtc21ldi1nb3YtcnVfdGVzdGluZ19sb2FkIn0=
2.1.10
Идентификатор вида сведений
rts
Опциональный параметр для cmd= getReq и cmd= getResp. Принимает значение идентификатора вида сведений.
Например: rts={urn://x-artefacts-smev-gov-ru/services/message-exchange/1.2}localNameRequest
2.1.11
Код статуса
code
Обязательный параметр для сmd=sendRejResp и сmd=sendStatusResp.
Принимает значение кода статуса.
Например: code=1
2.1.12
Описание статуса
desc
Обязательный параметр для сmd=sendRejResp и сmd=sendStatusResp.
Принимает описание статуса.
Например: desc=Some description
2.1.13
Идентификатор сообщения (запроса либо ответа)
msgId
Обязательный параметр для сmd=ack.
Принимает значение идентификатора сообщения.
Например: msgId=7d2799a4-6cd1-11e5-8561-2c44fd105812
2.2
Выходные данные
2.2.1
Синхронный ответ на запрос, включающий его метаданные и данные сообщений из очередей доставки либо статистики входящих очередей.
-
-

Для сmd sendReq,
сmd sendResp, sendRejResp и сmd sendStatusResp возвращается либо ошибка обработки сообщения, либо уведомление о постановке сообщения в асинхронную обработку.
Для сmd getReq и сmd getResp возвращает сообщение из очереди доставки либо ошибку обработки запроса.
Для сmd ack возвращает ответное сообщение либо ошибку обработки запроса.
Для сmd GetStatus возвращает сообщение из статусной очереди либо ошибку обработки запроса.
2.2.1.1
Данные сообщений из очередей доставки либо статистики входящих очередей.
-

-
Возвращается «NO_MESSAGE» в результате:
- ошибки обработки запроса
- отсутствия сообщений в очередях доставки
- запрос отправлен sendReq, sendResp, ack и sendRejResp
В остальных случаях возвращается xml-строка сообщения.
2.2.1.2
Метаданные в составе:
 
 
 
путь к файлу с дополнительными свойствами
map <имя файла>
-
 
идентификатор сообщения, в ответ на которое отсылается текущее
origMsgId <идентификатор>
В соответствии с RFC-4122
Например: 29f2c3e6-ce71-11e5-bca4-08606ee4e99b
идентификатор исходящего сообщения
refMsgId <идентификатор>
В соответствии с RFC-4122
Например: 29f2c3e6-ce71-11e5-bca4-08606ee4e99b
3
Утилита identitytool
3.1
Входные данные
3.1.1
Вид запроса
cmd
Обязательный параметр, принимает одно из следующих значений:
- msgUuid
- attachUuid
- attachId
Если необходимо запросить идентификатор сообщения, то запрос делается с параметром msgUuid. Например: identitytool.bat -cmd msgUuid
Если необходимо запросить идентификатор файла вложения сообщения, то запрос делается с параметром attachUuid. Например: identitytool.bat -cmd attachUuid.
Если необходимо запросить наименование файла вложения сообщения, то запрос делается с параметрами attachId, mime (mime-тип файла, определяющее его расширение) и num (порядковый номер). Например: identitytool.bat -cmd attachId -mime "text/plain" -num 1.
3.2
Выходные данные
3.2.1
Идентификатор сообщения
-
В соответствии с RFC-4122
Например: 29f2c3e6-ce71-11e5-bca4-08606ee4e99b
3.2.2
Идентификатор файла вложения сообщения
-
В соответствии с RFC-4122
Например: 7caf8c1c-c485-4265-b6f0-4680d7aca4f0
3.2.3
Наименование файла
-
-
Например: __ATT_ID_SMEV_C_AUTOGEN__1.txt
4
Утилита signertool
4.1
Входные данные
4.1.1
Вид запроса
cmd
Обязательный параметр, принимает одно из следующих значений:
- signXml
- signHash
- digest
- validate
сmd signXml означает запрос на получение ЭП-СП блока бизнес данных сообщения.
сmd signHash означает запрос на получение ЭП-СП хэша файла.
cmd digest означает получение хэша файла.
cmd validate означает получение данных результатов проверки целостности блока бизнес-данных сообщения.
4.1.2
Файл ресурса для обработки
if
Обязательный параметр.
Например:
для сmd signXml: signertool.bat -cmd signXml -if testdata/request.xml
для сmd signHash: signertool.bat -cmd signHash -if testdata/hash.file
для cmd digest: signertool.bat -cmd digest -if testdata/binary.file
для cmd validate: signertool.bat -cmd validate -if testdata/request.xml -sig testdata/signature.xml
4.1.3
ЭП-СП блока бизнес данных сообщения
sig
Обязательный параметр для validate
Например: signertool.bat -cmd validate -if testdata/request.xml -sig testdata/signature.xml
4.2
Выходные данные
4.2.1
ЭП-СП блока бизнес данных сообщения
-
-
 
4.2.2
ЭП-СП хэша файла
-
-
 
4.2.3
Хэш файла
-
-
 
4.2.4
Результат проверки целостности блока бизнес данных сообщения
-
-
 
5
Утилита adminservtool
5.1
Входные данные
5.1.1
Отсутствуют
-
-
-
5.2
Выходные данные
5.2.1
Ответ о приеме запроса на переключение
SwitchResponse
-
 
5.2.2
ЭП-ОВ не прошла проверку
SignatureVerificationFault
-
 
5.2.3
ИС отправителя не зарегистрирована в СМЭВ
SenderIsNotRegisteredFault
-
 
5.2.4
ИС отправителя установлена блокировка на переключение
SenderIsSwitchBlockedFault
-
 
5.2.5
Ошибка СМЭВ
SMEVFailure
-
 


[1][2][3][4][5][6][7][8]Актуальные адреса можно найти в Единой системе контекстных справок в разделе "База знаний" блок "СМЭВ3" https://info.gosuslugi.ru/articles/Актуальные_адреса_для_обращений_к_СМЭВ_3/


Авторизуйтесь, чтобы оставить комментарий к статье