npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@n3/crypto

v0.1.8

Published

Comfortable api over cadesplugin from cryptopro

Downloads

327

Readme

@n3/crypto

Установка

npm install @n3/crypto

API

Получение списка доступных сертификатов

import { getValidCertificates } from '@n3/crypto';

getValidCertificates()
    .then((certificates) => {
        ...
    }, (err) => {
        ...
    });

certificates - массив, содержащий объекты с полями:

  • certificate - объект сертификата, используемый для подписания; долежн передаваться в функции signHash и signString
  • name - описание сертификата вида STREET="ул. Проверочная, д. 1, лит. А", SNILS=12345678901, OGRN=1234567890123, INN=001234567890, [email protected], C=RU, S=78 Санкт-Петербург, L=Санкт-Петербург, O=Тестовая организация, OU=Отдел тестирования, G=Тест Тестович, SN=Тестов, T=Инженер-программист, CN=Тестовая организация
  • print - Thumbprint сертификата вида CC1A530EC972A18FF5A9CD5D5EF319FD86B9E6CF
  • params - представление name в виде {key: value}
  • objid - уникальный id сертификата
  • validFromDate - дата, с которой сертификат валиден, например, 2017-04-06T05:53:47.000Z
  • 2017-04-06T05:53:47.000Z - дата, по которую сертификат валиден, например, 2018-04-06T05:53:47.000Z

Подписание хеша

import { signHash } from '@n3/crypto';

signHash(hash, certificate)
    .then((signedHash) => {
        ...
    }, (errorMessage) => {
        ...
    });
  • hash - hex-строка
  • certificate - сертификат из результата вызова getValidCertificates

Добавление подписи к подписанному сообщению

import { coSignHash } from '@n3/crypto';

coSignHash(hash, certificate, signedMessage)
    .then((signedHash) => {
        ...
    }, (errorMessage) => {
        ...
    });
  • hash - hex-строка
  • certificate - сертификат из результата вызова getValidCertificates
  • signedMessage - подписанное сообщение

Подписание строки

import { signString } from '@n3/crypto';

signHash(stringToSign, certificate)
    .then((signedString) => {
        ...
    }, (errorMessage) => {
        ...
    });
  • stringToSign - base64-строка
  • certificate - сертификат из результата вызова getValidCertificates

Валидация подписи строки

import { verifySignString } from '@n3/crypto';

verifySignString(singedMessage, dataToSign, isDetached)
    .then((signedString) => {
        ...
    }, (errorMessage) => {
        ...
    });
  • singedMessage - проверяемое подписанное сообщение
  • dataToSign - содержимое объекта CAdESCOM.CadesSignedData, подписанное с помощью цифровой подписи
  • isDetached - вид подписи: отделенная (true) или совмещенная (false)

Получение версии плагина

import { getVersion } from '@n3/crypto';

getVersion()
    .then(({
      plugin,
      provider,
    }) => {
        ...
    }, (errorMessage) => {
        ...
    });
  • plugin - версия плагина
    • BuildVersion - Возвращает номер сборки
    • MajorVersion - Возвращает старший компонент версии.
    • MinorVersion - Возвращает младший компонент версии.
    • Version - Возвращает строковое представление версии.
  • provider - версия криптопровайдера
    • BuildVersion - Возвращает номер сборки криптопровайдера
    • MajorVersion - Возвращает старший компонент версии криптопровайдера
    • MinorVersion - Возвращает младший компонент версии криптопровайдера
    • Version - Возвращает строковое представление версии криптопровайдера
    • Name - Возвращает наименование криптопровайдера

Получение информации об алгоритме хэширования

import { getAlgorithm } from '@n3/crypto';

getAlgorithm(certificate)
    .then(({
      algorithmOid,
      signMethod,
      digestMethod,
      hashMethod
    }) => {
        ...
    }, (errorMessage) => {
        ...
    });
  • certificate - сертификат из результата вызова getValidCertificates
  • algorithmOid - OID алгоритма хэширования
  • signMethod - URI алгоритма подписи
  • digestMethod - URI метода дайджеста
  • hashMethod - алгоритм хэширования

Включение мока

import { mock } from '@n3/crypto';

import mockJSON from 'cryptopro-mock.json';

mock(mockJSON);

После этого все вышеперечисленные методы будут возвращать фейковые данные, сгенерированные с помощью mockJSON.

Формат json для мока

  certificates: [{
      ValidFromDate: #String
      ValidToDate: #String
      SubjectName: #String
      Thumbprint: #String
  }]
  plugin: {
      BuildVersion: #Number
      MajorVersion: #Number
      MinorVersion: #Number
      Version: #String
  }
  provider: {
      BuildVersion: #Number
      MajorVersion: #Number
      MinorVersion: #Number
      Version: #String
      Name: #String
  }

Пример json для мока

{
  "certificates": [
    {
      "ValidFromDate": "2017-04-06T05:53:47.000Z",
      "ValidToDate": "2018-04-06T05:53:47.000Z",
      "SubjectName": "STREET=\"ул. Проверочная, д. 1, лит. А\", SNILS=12345678901, OGRN=1234567890123, INN=001234567890, [email protected], C=RU, S=78 Санкт-Петербург, L=Санкт-Петербург, O=Тестовая организация, OU=Отдел тестирования, G=Тест Тестович, SN=Тестов, T=Инженер-программист, CN=Тестовая организация",
      "Thumbprint": "CC1A530EC972A18FF5A9CD5D5EF319FD86B9E6CF"
    },
    {
      "ValidFromDate": "2017-01-24T07:51:47.000Z",
      "ValidToDate": "2017-03-24T07:51:47.000Z",
      "SubjectName": "STREET=\"ул. Проверочная, д. 1, лит. А\", SNILS=12345678901, OGRN=1234567890123, INN=001234567890, [email protected], C=RU, S=78 Санкт-Петербург, L=Санкт-Петербург, O=Тестовая организация, OU=Отдел тестирования, G=Тест Тестович, SN=Тестов, T=Инженер-программист, CN=Тестовая организация",
      "Thumbprint": "DA572D0784DB9C95DEAD44D3E2A7D6288CF7A42E"
    }
  ],
  "plugin": {
      "BuildVersion": 2,
      "MajorVersion": 0,
      "MinorVersion": 12619,
      "Version": "2.0.12619"
  },
  "provider": {
      "BuildVersion": 3,
      "MajorVersion": 1,
      "MinorVersion": 101,
      "Version": "3.1.101",
      "Name": "Microsoft RSA/Schannel Cryptographic Provide"
  }
}