Главная Документация
Документация
Отменить

Документация

API

Документацию по API можно посмотреть тут: https://v3.ncanode.kz/swagger-ui/

Установка

Последнюю версию NCANode можно получить здесь:

https://github.com/malikzh/NCANode/releases

Запуск NCANode

Для запуска необходимо выполнить команду:

1

java -jar NCANode-3.0.0.jar

Запуск в Docker

У NCANode есть образ в Docker Hub, и запустить его можно следующим образом:

1
2

docker volume create ncanode_cache
docker run -p 14579:14579 -v ncanode_cache:/app/cache -d malikzh/ncanode

Настройки

В отличие, от версий 2.x, 1.x, теперь NCANode настраивается при помощи переменных окружения (os env).

Эти переменные окружения подставляются в конфигурацию в этом файле: https://github.com/malikzh/NCANode/blob/master/src/main/resources/application.yml

Список переменных окружения

  • NCANODE_PORT - Порт (по умолчанию 14579)
  • NCANODE_DEBUG - режим отладки (по умолчанию отключен)
  • NCANODE_CACHE_DIR - путь к папке с кэшем (по умолчанию ./cache)
  • NCANODE_CRL_ENABLED - поддержка CRL (по умолчанию включена)
  • NCANODE_CRL_TTL - Время жизни CRL в кэше (по умолчанию 1440 минут)
  • NCANODE_CRL_URL - URL’ы откуда скачивать списки CRL. По умолчанию они берутся из:
    • https://crl.pki.gov.kz/nca_gost.crl
    • https://crl.pki.gov.kz/nca_rsa.crl
  • NCANODE_CRL_DELTA_URL - URL’ы дельта версий CRL. Они обычно обновляются чаще чем основные. По умолчанию:
    • https://crl.pki.gov.kz/nca_d_gost.crl
    • https://crl.pki.gov.kz/nca_d_rsa.crl
  • NCANODE_CRL_DELTA_TTL - Время жизни Delta-CRL в кэше (по умолчанию 1440 минут)
  • NCANODE_HTTP_CLIENT_CONNECTION_TTL - Время удержания соединения HTTP-клиента (когда скачиваются CRL\OCSP\Корневые сертификаты)
  • NCANODE_HTTP_CLIENT_USER_AGENT - HTTP заголовок User-Agent у клиента
  • NCANODE_PROXY_URL - Прокси для HTTP-клиента. Через этот прокси будут происходить все запросы из NCANode.
  • NCANODE_PROXY_USERNAME - Имя пользователя в прокси
  • NCANODE_PROXY_PASSWORD - Пароль прокси
  • NCANODE_OCSP_URL - OCSP-сервер куда будут происходить запросы. По умолчанию: http://ocsp.pki.gov.kz/
  • NCANODE_CA_URL - URL-ы корневых сертификатов. Они скачиваются автоматически при запуске NCANode. По умолчанию:
    • https://pki.gov.kz/cert/nca_rsa.crt
    • https://pki.gov.kz/cert/nca_gost.crt
    • https://pki.gov.kz/cert/root_gost2015_2022.cer
    • https://pki.gov.kz/cert/nca_gost2015.cer
  • NCANODE_CA_TTL - Время жизни корневых сертификатов CA (по умолчанию 1440 минут)
  • NCANODE_CA_CRL_ENABLED - Проверка корневых сертификатов на отозванность. Если сертификат отозван, NCANode попробует его заново скачать. (По умолчанию: true)
  • NCANODE_CA_CRL_TTL - Время жизни для CRL корневых сертификатов (по умолчанию 1440 минут)
  • NCANODE_CA_CRL_URL - Список URL-ов откуда скачивать CRL. По умолчанию:
    • http://crl.root.gov.kz/gost.crl
    • http://crl.root.gov.kz/rsa.crl
    • http://crl.root.gov.kz/gost2020.crl
    • http://crl.root.gov.kz/rsa2020.crl
  • NCANODE_TSP_URL - URL TSP-сервера. По умолчанию: http://tsp.pki.gov.kz/
  • NCANODE_TSP_RETRIES - Количество неудачных попыток обращения к TSP-серверу, по умолчанию: 3

Запуск с переменными окружения

Например, мы хотим изменить порт и включить отладку. То мы запускаем NCANode так:

1

NCANODE_PORT=8080 NCANODE_DEBUG=true java -jar ./NCANode.jar

Для Docker необходимо использовать параметр -e. Например:

1

docker run -p 8080:8080 -v ncanode_cache:/app/cache -e NCANODE_PORT=8080 -e NCANODE_DEBUG=true -d malikzh/ncanode

Запросы к NCANode

После запуска NCANode можете перейти по адресу:

http://localhost:14579/actuator/health

В ответ придет что-то вроде:

1

{"status":"UP"}

Важно знать

Обратите внимание, что ключи, CMS, и данные в CMS передаются в формате Base64. Это описано в API Reference.

И в каждом запросе не забывайте передавать заголовок Content-Type: application/json.