Сервис обслуживания ЭП

Данный раздел описывает работу Сервис обслуживания ЭП и Криптосервиса, отличия и функциональные возможности двух сервисов в системе Docsvision 6 (Платформа 6.1 и выше + Web-клиент 18 и выше).

Функциональные возможности сервисов

Сервис обслуживания ЭП — расширение, входящее в стандартную поставку модуля Базовые объекты, не следует путать его с Криптосервисом. Криптосервис поставляется и настраивается отдельно.
Назначение сервиса обслуживания ЭП:
  • Если срок действия сертификата не истёк, Сервис обслуживания ЭП указывает в журнале подписей Web-клиента актуальный статус подписи, её тип и дату окончания срока действия сертификата, даёт возможность просматривать дополнительную информацию о подписи в журнале подписей Web-клиента.

  • Функциональность Сервиса обслуживания ЭП может быть дополнена отдельным компонентом — Криптосервисом.

Криптосервис дополняет функции сервиса по обслуживанию следующими возможностями:
  • Если сервер Docsvision работает под управлением Linux:

    • Криптосервис используется для формирования и проверки подписей, включая подписи с нестандартными для .NET алгоритмами в сертификатах, например, с сертификатами КриптоПро.

    • Криптосервис указывает в журнале подписей Web-клиента актуальный статус подписи, её тип и дату окончания срока действия сертификата, делает доступной расширенную информацию о подписи.

    • Криптосервис улучшает подпись до CAdES-A.

  • Если сервер Docsvision работает под управлением Windows:

    • Проверка и формирование подписи не требуют криптосервис и соответствующие лицензии, но в таком случае отображение штампа времени и улучшение подписи до CAdES-A будет недоступно.

Требования для использования Криптосервиса

Для использования криптосервиса потребуется:
  • Модуль Служба фоновых операций версии 6.1 и выше.

  • Docker актуальной версии, если криптосервис планируется разворачивать в контейнере. Криптосервис может быть получен из общего реестра образов Docker Hub — docsvision/cryptoservice или реестра образов Docsvision — packages.docsvision.com/cryptoservice.

  • Опция лицензии Docsvision Сервис обслуживания электронной подписи.

  • Из-за использования библиотеки tspcom.dll Криптосервис требует быть развернут минимум в 32-битном процессе Службы рабочих процессов.

  • Сборки, входящие в состав Java CSP версии 5.0.45559, и лицензия на право использования ПО "КриптоПро Java CSP" на одном сервере.

  • Лицензия на право использования СКЗИ "КриптоПро CSP" версии 5.0 и выше на сервере.

Установка Криптосервиса в Docsvision 6.1 с помощью Docker

  1. Получите сборки КриптоПро Java CSP необходимой версии и поместите их в локальный каталог хоста ./java-csp-5.0.45559-A-b34f3a2f.

  2. Смонтируйте каталог со сборками КриптоПро Java CSP и каталог для сохранения данных лицензии. Активируйте лицензию:

    docker run \
      -v ./java-csp-5.0.45559-A-b34f3a2f:/app/BOOT-INF/lib/java-csp \
      -v ./data:/root/.java/.userPrefs \
      packages.docsvision.com/cryptoservice \
      java -cp "/app/BOOT-INF/lib/java-csp/*" ru.CryptoPro.JCSP.JCSPLicense -serial "serial_number" -company "company_name" -store (1)
    1 Замените serial_number на серийный номер лицензии, а company_name — на название организации.

    В примере название организации передаётся обычным текстом через параметр -company. Для передачи названия в Base64 используйте вместо него параметр -combase "company_name_in_base64".

    Данные лицензии сохраняются в каталоге ./data на хосте. Для последующего запуска Криптосервиса используйте следующую команду, подключив тот же каталог:

    docker run \
      -v ./java-csp-5.0.45559-A-b34f3a2f:/app/BOOT-INF/lib/java-csp \
      -v ./data:/root/.java/.userPrefs \
      -p 8100:8094 -d \
      packages.docsvision.com/cryptoservice (1)
    1 Если используется Docker Hub, замените packages.docsvision.com/cryptoservice на docsvision/cryptoservice.

    При запуске контейнера всё содержимое папки будет импортировано в хранилище.

    Настройки криптосервиса задаются в командной строке. При запуске контейнера необходимо связать порт хоста с портом контейнера, например, -p 8100:8094. В примере 8100 — порт хоста, 8094 — порт контейнера. Для работы функций проверки и формирования подписи сервер Docsvision должен подключаться к контейнеру через порт хоста.

  3. Выполните настройки в Консоли управления Docsvision, см. подробнее в разделе Настройка Криптосервиса.

  4. Если требуется настроить защищённое подключение, проследуйте инструкции в разделе Настройка подключения к криптосервису по HTTPS.

  5. По умолчанию Криптосервис использует TSP-службу с адресом http://cryptopro.ru/tsp/tsp.srf. При необходимости адрес используемой TSP-службы можно переопределить с помощью переменной окружения TSP_SERVICE_ADDRESS. Ниже приведён пример переопределения адреса TSP-сервиса:

    При запуске с другим адресом TSP-службы также подключайте каталог ./data с данными лицензии, сохранёнными при активации.

    docker run \
      -v ./java-csp-5.0.45559-A-b34f3a2f:/app/BOOT-INF/lib/java-csp \
      -v ./data:/root/.java/.userPrefs \
      -e TSP_SERVICE_ADDRESS=http://testca2012.cryptopro.ru/tsp/tsp.srf \
      -p 8100:8094 -d \
      packages.docsvision.com/cryptoservice
  6. Контейнер поставляется с набором сертификатов, перечисленных далее:

    Если требуется использовать дополнительные сертификаты, выполните одну из следующих настроек:

    В обоих вариантах при запуске контейнера подключайте каталог ./data с данными лицензии КриптоПро Java CSP, сохранёнными при активации по инструкции выше.

    1. Укажите путь к папке сертификатов:

      1. Смонтируйте сертификаты и сборки КриптоПро Java CSP необходимой версии в соответствующие каталоги Docker-контейнера и запустите контейнер:

        docker run \
          -v ./java-csp-5.0.45559-A-b34f3a2f:/app/BOOT-INF/lib/java-csp \
          -v ./data:/root/.java/.userPrefs \
          -v ./Cert:/var/cryptoservice/cacerts \
          -p 8100:8094 -d \
          packages.docsvision.com/cryptoservice (1)
        1 Если используется Docker Hub, замените packages.docsvision.com/cryptoservice на docsvision/cryptoservice.

        При запуске контейнера всё содержимое папки будет импортировано в хранилище.

    2. Заново соберите образ:

      1. Создайте Dockerfile. Если используется Docker Hub, замените packages.docsvision.com/cryptoservice на docsvision/cryptoservice:

        FROM packages.docsvision.com/cryptoservice
        
        COPY ./java-csp-5.0.45559-A-b34f3a2f/ /app/BOOT-INF/lib/java-csp/ (1)
        COPY ./your/cacerts/ /var/cryptoservice/cacerts/ (2)
        1 Смонтируйте сборки КриптоПро Java CSP необходимой версии.
        2 Смонтируйте сертификаты.
      2. Соберите собственный образ:

        $ docker build . -t cryptoservice
      3. Запустите контейнер:

        docker run \
          -v ./data:/root/.java/.userPrefs \
          -p 8100:8094 -d \
          cryptoservice
  7. При необходимости ознакомьтесь с журналом Криптосервиса, развёрнутого в контейнере:

    sudo docker ps (1)
    sudo docker logs идентификатор-контейнера (2)
1 Узнать идентификатор контейнера.
2 Посмотреть журнал Криптосервиса.

Установка криптосервиса в Docsvision 6.1 Linux из пакета

  1. Установите Криптосервис из пакета командой:

    • Astra Linux / Альт Сервер / Ubuntu

    • РЕД ОС

    $ sudo apt install docsvision-cryptoservice
    $ sudo dnf install docsvision-cryptoservice
  2. Получите сборки КриптоПро Java CSP необходимой версии и выполните любое из действий:

    • Поместите сборки в каталог /usr/lib/docsvision/cryptoservice/BOOT-INF/lib

    • Укажите путь к сборкам в /etc/default/dvcryptoservice:

      OPTIONS=-Dloader.path=/home/docsvision/java-csp-5.0.45559-A-b34f3a2f
  3. Выполните скрипт configure.sh из каталога размещённых сборок Java CSP, чтобы проверка подписей в Web-клиенте проходила без ошибок:

    sudo путь-до-сборок-java-csp/configure.sh
  4. Сертификаты для Криптосервиса необходимо поместить в каталог в зависимости от дистрибутива:

    • Astra Linux / Ubuntu

    • РЕД ОС

    1. Поместите сертификаты по пути:

      /usr/local/share/ca-certificates
    2. Обновите список доступных системе сертификатов командой:

      update-ca-certificates
    1. Поместите сертификаты по пути:

      /etc/pki/ca-trust/source/anchors
    2. Обновите список доступных системе сертификатов командой:

      update-ca-trust
  5. Откройте конфигурационный файл по адресу: /usr/lib/docsvision/cryptoservice/application.properties и отредактируйте следующие параметры:

    server.port=8094 (1)
    logging.level.root=ERROR (2)
    ru.CryptoPro.JCP.tools.JCPLogger.level=FINE (3)
    timestampservice.name=http://cryptopro.ru/tsp/tsp.srf (4)
    1 server.port — порт Криптосервиса.
    2 logging.level.root — уровень журналирования Криптосервиса.
    3 Уровень журналирования JCP.
    4 timestampservice.name — адрес TSP сервиса.
  6. Запустите службу dvcryptoservice.

    Служба запускается от имени УЗ Docsvision и не требует ROOT привилегий.

  7. Выполните настройки в Консоли управления Docsvision, см. подробнее в разделе Настройка Криптосервиса.

  8. При необходимости настроить защищённое подключение проследуйте инструкции в разделе Настройка подключения к криптосервису по HTTPS.

Криптосервис в Docsvision 6.1 Windows

Криптосервис в Docsvision 6.1 Windows поддерживает установку как на сервер Docsvision, так и машину без Docsvision.

  1. Запустите Docsvision CryptoService.msi и выполните последовательно шаги мастера установки:

    Запуск мастера установки Криптосервиса
    Рисунок 1. Запуск мастера установки Криптосервиса
  2. Примите условия лицензионного соглашения для продолжения установки.

    Условия лицензионного соглашения
    Рисунок 2. Условия лицензионного соглашения
  3. Если требуется, измените каталог установки Криптосервиса.

    Каталог установки компонентов Криптосервиса
    Рисунок 3. Каталог установки компонентов Криптосервиса
  4. В следующем окне нажмите Установить и дождитесь завершения установки.

    Завершение установки
    Рисунок 4. Завершение установки
  5. По завершению установки нажмите Готово. После установки Криптосервиса его нужно сконфигурировать. Конфигурация после установки с помощью инсталлятора предполагает два альтернативных варианта:

    1. ЛИБО: Откройте файл C:\Program Files (x86)\Docsvision\CryptoService\appsettings.json и укажите следующие параметры:

      {
        "CryptoService": {
          "timestampservice.name": "http://cryptopro.ru/tsp/tsp.srf", (1)
          "logging.file.name": "C:\\ProgramData\\Docsvision\\CryptoService\\CryptoService.log" (2)
        },
        "Java": [
          "-Dloader.path=C:\\Program Files (x86)\\Docsvision\\CryptoService\\jar\\BOOT-INF\\lib\\java-csp-5.0.45559-A-b34f3a2f" (3)
        ]
      }
      1 timestampservice.name — адрес TSP сервиса.
      2 logging.file.name — путь к файлу журнала.
      3 Java — папка, содержащая сборки Java CSP необходимой версии.
    2. ЛИБО: Скопируйте Java CSP необходимой версии в C:\Program Files (x86)\Docsvision\CryptoService\jar\BOOT-INF\lib

  6. Запустите службу Docsvision CryptoService.

  7. Выполните настройки в Консоли управления Docsvision, см. подробнее в разделе Настройка Криптосервиса.

  8. При необходимости настроить защищённое подключение проследуйте инструкции в разделе Настройка подключения к криптосервису по HTTPS.

Настройка Криптосервиса в Docsvision 6.1

Начиная с модуля Платформа версии 6.1 сборки 832 и выше, поддерживается два варианта настройки криптосервиса:

  • Из интерфейса Консоли управления Docsvision без необходимости работы с форматом .json, см. раздел "Общие настройки сервера приложений"

  • При помощи настройки в конфигурационном файле модуля, см. подробнее ниже

  1. Зайдите в Консоль управления Docsvision и создайте процесс Службы фоновых операций с типом конфигурации Обслуживание ЭП.

    • Для корректной работы службы фоновых операций с использованием сервиса перештамповки подписей необходимо использовать машину, имеющую как минимум два процессора.

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

  2. Выберите приоритетный вариант настройки (настройки в конфигурационном файле считываются первыми и преобладают над настройками в Консоли управления Docsvision):

    1. Укажите адрес Криптосервиса в конфигурационном файле:

      1. Создайте файл settings.json, скопируйте созданный конфигурационный файл по пути /usr/lib/docsvision/platform/config/settings.json в Linux. Пример содержимого файла приведён ниже:

        {
          "DocsVision": {
            "BackOffice": {
              "Server": {
                "Extension": {
                  "ComplexSignatureServiceAddress": "ConnectAddress=http://server.domain.com:8100/cryptoservice/api/v1" (1)
                }
              }
            }
          }
        }
        1 Адрес Криптосервиса.
      2. Перезапустите службу dvappserver для Linux и Docsvision Platform для Windows.

    2. Задайте настройки Криптосервиса в Консоли управления Docsvision:

      1. Укажите адрес Криптосервиса, для сервера приложений в Консоли управления Docsvision, в параметре "Криптосервис", см. подробнее "Общие настройки сервера приложений".

Улучшение подписи с сертификатом без адреса OCSP сервиса

При улучшении подписи, созданной с помощью сертификата без адреса OCSP сервиса, могут возникать ошибки вида: The signer certificate <…​> must have OCSP evidence but it doesn’t contain any OCSP reference. OCSP evidence is not created.

Исправить ситуацию можно, если известен адрес OCSP сервиса, выдавшего сертификат.

Требования к сертификату:
  • Сертификат, которым выполнялась подпись, должен быть доверенным. Доверенный сертификат — это сертификат, у которого корневой и промежуточные сертификаты добавлены в доверенные в образе Крипто-сервиса.

  • Сертификат OCSP сервиса (для подписания ответов сервиса) должен быть доверенным. Сертификат с большой вероятностью будет недоверенным в случае, если используется неквалифицированная электронная подпись (НЭП).

  • Сертификат OCSP сервиса должен быть выпущен тем же УЦ, что и сертификат, которым выполнялась подпись (поле Issuer в сертификатах должно совпадать). Иными словами, нужно использовать OCSP сервис того же УЦ, который выпустил сертификат, которым выполнялась подпись. Только данный УЦ может контролировать статус отзыва сертификата.

  • Сертификат OCSP сервиса можно уточнить в УЦ.

  • Сертификат TSP сервиса также должен быть доверенным.

  • Получить сертификат TSP сервиса можно также через техподдержку компании, которая предоставляет сервис, либо через утилиту CryptExpert.

Когда адрес сервиса известен, создайте конфигурационный файл settings.json с указанием актуального адреса OCSP серверов следующим образом:

{
  "ocspSettings": [
    {
      "ocspUrl": "http://ocsp-service.ru/ocspn/ocsp.srf", (1)
      "serial": "17192b01038046a1649b8a076964699c4" (2)
    },
    {
      "ocspUrl": "http://ocsp-service.example.ru/ocspn1000000/ocsp.srf",
      "serial": "1f409aa452fd10ee11500ea83ca0f3ce2"
    }
  ]
}
1 "ocspUrl" — адрес OCSP сервиса.
2 "serial" — серийный номер корневого сертификата улучшаемой подписи.
Поместите конфигурационный файл settings.json:
  • В каталог /etc/cryptoservice/ в Linux и контейнере Docker.

  • В каталог C:\ProgramData\Docsvision\Cryptoservice\ в Windows.

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

Серийные номера сертификатов сопоставляются с номером, указанным в конфигурационном файле, при совпадении заданный адрес OCSP будет использоваться для самого близкого родительского сертификата.

Чтобы серийный номер сертификата считывался успешно, поместите его в каталог корневых сертификатов.

Для запуска Криптосервиса с файлом настроек OCSP используйте следующую команду. Подключите каталог ./data с данными лицензии, сохранёнными при активации по инструкции установки с помощью Docker.

docker run \
  -v /path/to/settings.json:/etc/cryptoservice/settings.json \
  -v ./java-csp-5.0.45559-A-b34f3a2f:/app/BOOT-INF/lib/java-csp \
  -v ./data:/root/.java/.userPrefs \
  -p 8100:8094 -d \
  packages.docsvision.com/cryptoservice

Настройка подключения к криптосервису по HTTPS

  1. Создайте PKCS12-файл (.p12 или .pfx) предпочтительным способом. Шаг можно пропустить, если уже есть сертификат в формате .p12 или .pfx. Ниже приведён пример генерации файла при помощи утилиты OpenSSL.

    Для создания PKCS12-файла потребуются закрытый ключ и файл сертификата, содержащий полную цепочку доверия. Файлы предоставляются удостоверяющим центром при выпуске сертификата. Также можно сгенерировать самоподписанный сертификат, см. подробнее: "Создание самоподписанного сертификата".

    openssl pkcs12 -export \
    -in fullchain.pem \ (1)
    -inkey privkey.pem \ (2)
    -out keystore.p12 \ (3)
    -passout pass:MyP@ssw0rd (4)
    1 Промежуточный и конечный сертификат
    2 Приватный ключ
    3 Имя выходного PKCS12-файла
    4 Пароль для защиты PKCS12-файла
  2. Отредактируйте конфигурационный файл:

    • При работе через Docker создайте файл конфигурации.

      cat > application.properties <<EOF
      server.ssl.key-store=/keystore.p12 (1)
      server.ssl.key-store-password=MyP@ssw0rd (2)
      server.ssl.keyStoreType=PKCS12
      EOF
      1 Путь до PKCS12-файла в контейнере
      2 Пароль от PKCS12-файла
    • Если Криптосервис установлен в Linux из пакета, откройте конфигурационный файл по адресу /usr/lib/docsvision/cryptoservice/application.properties и укажите следующие параметры:

      server.ssl.key-store=/keystore.p12 (1)
      server.ssl.key-store-password=MyP@ssw0rd (2)
      server.ssl.keyStoreType=PKCS12
      1 Путь до PKCS12-файла.
      2 Пароль от PKCS12-файла.
    • В Windows откройте файл конфигурации по адресу C:\Program Files (x86)\Docsvision\CryptoService\appsettings.json и укажите следующие параметры:

      {
        "CryptoService": {
          "timestampservice.name": "http://cryptopro.ru/tsp/tsp.srf",
          "logging.file.name": "C:\\ProgramData\\Docsvision\\CryptoService\\CryptoService.log",
          "server.ssl.key-store": "C:\\Program Files (x86)\\Docsvision\\CryptoService\\keystore.p12",  (1)
          "server.ssl.key-store-password": "MyP@ssw0rd", (2)
          "server.ssl.keyStoreType": "PKCS12"
        "Java": [
          "-Dloader.path=C:\\Program Files (x86)\\Docsvision\\CryptoService\\jar\\BOOT-INF\\lib\\java-csp-5.0.45559-A-b34f3a2f" (3)
        ]
        }
      }
      1 Путь до PKCS12-файла
      2 Пароль от PKCS12-файла
      3 Java — папка, содержащая сборки Java CSP необходимой версии.
  3. Запустите криптосервис.

    1. Запустите службу Docsvision CryptoService, если установка была выполнена при помощи инсталлятора.

    2. Перезапустите службу dvcryptoservice, если установка была выполнена из пакета в Linux.

    3. Если криптосеврис работает с использованием Docker, выполните:

      При запуске контейнера подключите каталог ./data с данными лицензии, сохранёнными при активации по инструкции установки с помощью Docker.

      docker run -d -p 8100:8094 \
      -v $(realpath application.properties):/application.properties \ (1)
      -v $(realpath keystore.p12):/keystore.p12 \ (2)
      -v ./java-csp-5.0.45559-A-b34f3a2f:/app/BOOT-INF/lib/java-csp \ (3)
      -v ./data:/root/.java/.userPrefs \
      packages.docsvision.com/cryptoservice \
      java org.springframework.boot.loader.JarLauncher \
      --spring.config.additional-location=/application.properties (4)
      1 Монтирование файла конфигурации хост:контейнер
      2 Монтирование PKCS12-файла хост:контейнер
      3 Монтирование сборки КриптоПро Java CSP необходимой версии.
      4 Путь до файла конфигурации в контейнере