Встроенный объект объекта
  1. титульная страница
  2. встроенный объект
  3. объектPKey

объектPKey

PKey встроенcryptoОбъект, предоставленный модулем, представляющий пару ключей: открытый ключ и закрытый ключ. PKey поддерживает генерацию ключей, загрузку ключей, хранение ключей и управление процессом шифрования в JS.

Объект PKey поддерживает несколько алгоритмов шифрования, таких как RSA, EC или Ed25519, и каждый алгоритм шифрования имеет свои собственные уникальные методы создания ключей и управления ими. Объект PKey также содержит такие атрибуты, как имя алгоритма, которому принадлежит ключ, и длина ключа.

Ниже приведены распространенные методы PKey и их примеры:

  1. generateKey(alg | bits): генерирует пару ключей, alg указывает алгоритм ключа, bits указывает длину ключа, по умолчанию 2048.
1
2
3
var crypto = require('crypto');

var pkey = crypto.generateKey(2048);
  1. from(value[, password]): загрузить ключ в формате DER или PEM в объект PKey.
1
2
3
var crypto = require('crypto');

var pkey = crypto.PKey.from(fs.readFile('rsa.private.pem'));
  1. publicKey: получить открытый ключ текущего ключа.
1
2
3
4
var crypto = require('crypto');

var pkey = crypto.PKey.from(fs.readFile('rsa.private.pem'));
var pubkey = pkey.publicKey;
  1. equals(other): Определите, равны ли два открытых и закрытых ключа.
1
2
3
4
5
var crypto = require('crypto');

var pkey1 = crypto.PKey.from(fs.readFile('rsa.private.pem'));
var pkey2 = crypto.PKey.from(fs.readFile('rsa.public.pem'));
console.log(pkey1.equals(pkey2)); // output: true

отношения наследования

%0 object object toString() toJSON() PKey PKey new PKey() from() name keySize alg publicKey isPrivate() clone() pem() der() json() equals() encrypt() decrypt() sign() verify() object->PKey ECKey ECKey PKey->ECKey BlsKey BlsKey ECKey->BlsKey Ed25519Key Ed25519Key ECKey->Ed25519Key

Конструктор

PKey

Создайте PKey из ключа в формате DER

1
2
new PKey(Buffer DerKey,
    String password = "");

Параметры вызова:

  • DerKey:Buffer, ключ в формате DER
  • password: Строка, расшифрованный пароль

Создайте PKey из ключа в формате PEM

1
2
new PKey(String pemKey,
    String password = "");

Параметры вызова:

  • pemKey: Строка, ключ в формате PEM
  • password: Строка, расшифрованный пароль

Создайте PKey из ключа в формате JSON

1
new PKey(Object jsonKey);

Параметры вызова:

  • jsonKey: Объект, ключ в формате JSON

Формат jsonKey поддерживает следующие четыре типа закрытого ключа RSA:

1
2
3
4
5
6
7
8
9
10
11
{
    "kty": "RSA",
    "n": "0m5lvKpWqy9JS7tV2HIPqHCYHLquSuxIC3F8strIQLJKO3rZmTT96KTnhsOfBO7Y1bI7mnT0PB3_vcHd9ekWMEoZJQw7MuB8KeM_Wn54-elJr5DNLk5bMppSGxX7ZnumiXGG51_X3Yp-_EbGtDG80GxXXix7Mucyo7K25uE0uW8=",
    "e": "AQAB",
    "d": "agN2O9NxMHL1MTMi75WfL9Pxvl-KWXKqZSF6mjzAsF9iKI8euyHIXYFepzU8kual1RsjDhCnzvWqFvZplW8lXqrHf_P-rS_9Y4gBUw6pjnI_DnFIRwWHRvrUHHSCfWOdTCIKdOTkgLZuGFuhEY3RMIW0WSYejjLtftwy0RVxAzk=",
    "p": "6a4G1qmfwWmn1biigN7IVFlkbLf9oVe6g7rOmHxI-hn1GRxKDSVuAUrmR1IhuAnca9M0y7SD-7TUs6wjOxWxaw==",
    "q": "5ofkxFKdPBD0CQHMb9q13AMHUVe0rJ-hSjqqIBrmqApUOneyAcMV76M0QyIQnI2p3POa4Qu_7XChDwRVl7LlDQ==",
    "dp": "2mXGiGwCHl8j-FBWuID-1C6z-BRB3MBEVoeKPOOzxOPruatB3mWEGXsqG7A8SWgV9URxTI2K6P3J6Z7RUpBkvw==",
    "dq": "oagn5vfb5NQqnOpS9xkSsD67cfIj821ZSFlNFYhnuOzNVda7z_qCtnHm4zDPH0lEFXoKYMfBhfqWJpaugttjPQ==",
    "qi": "dqEQgxNmOVFrF4s776hTqeC6oEDila8EvpVb2F2ZvwAOLjCQ66OiAZK1BiYGHqUy0NeqNmtlsLSuBEZQZvqZwg=="
}

Открытый ключ RSA:

1
2
3
4
5
{
    "kty": "RSA",
    "n": "0m5lvKpWqy9JS7tV2HIPqHCYHLquSuxIC3F8strIQLJKO3rZmTT96KTnhsOfBO7Y1bI7mnT0PB3_vcHd9ekWMEoZJQw7MuB8KeM_Wn54-elJr5DNLk5bMppSGxX7ZnumiXGG51_X3Yp-_EbGtDG80GxXXix7Mucyo7K25uE0uW8=",
    "e": "AQAB"
}

Закрытый ключ ЕС:

1
2
3
4
5
6
7
{
    "kty": "EC",
    "crv": "P-521",
    "x": "ATfNNFuuvlGxrTGoXgyfSAGgRNNDnO3rN3k74urKJdVS14RYhdnSwm91Bm-F1l-T1XKlAY2yRnzG9w1Ukvo8c0wL",
    "y": "ASBHqrruB6kdkEUB3vlW3-UIkk4HtKdUeTwN-7m3j2rgZvYR1ffRAapDvWqKGiBjomqWafxokBkbDI0c95f6f4XU",
    "d": "AfkIbUHXfW41njdpoKuqqKludcoLJS8D_oMEwkj-GVaXFNKccIoF5iKGu2c69kNDjo83R_7wyGlfRczsklkik1ST"
}

Открытый ключ ЕС:

1
2
3
4
5
6
{
    "kty": "EC",
    "crv": "P-521",
    "x": "ATfNNFuuvlGxrTGoXgyfSAGgRNNDnO3rN3k74urKJdVS14RYhdnSwm91Bm-F1l-T1XKlAY2yRnzG9w1Ukvo8c0wL",
    "y": "ASBHqrruB6kdkEUB3vlW3-UIkk4HtKdUeTwN-7m3j2rgZvYR1ffRAapDvWqKGiBjomqWafxokBkbDI0c95f6f4XU"
}

статическая функция

from

Загрузить ключ в формате DER

1
2
static PKey PKey.from(Buffer DerKey,
    String password = "");

Параметры вызова:

  • DerKey:Buffer, ключ в формате DER
  • password: Строка, расшифрованный пароль

возвращаемый результат:

  • PKey, возвращает объект, содержащий ключ

Загрузить ключ в формате PEM

1
2
static PKey PKey.from(String pemKey,
    String password = "");

Параметры вызова:

  • pemKey: Строка, ключ в формате PEM
  • password: Строка, расшифрованный пароль

возвращаемый результат:

  • PKey, возвращает объект, содержащий ключ

Загрузить ключ в формате JSON

1
static PKey PKey.from(Object jsonKey);

Параметры вызова:

  • jsonKey: Объект, ключ в формате JSON

возвращаемый результат:

  • PKey, возвращает объект, содержащий ключ

Формат jsonKey поддерживает следующие четыре типа закрытого ключа RSA:

1
2
3
4
5
6
7
8
9
10
11
{
    "kty": "RSA",
    "n": "0m5lvKpWqy9JS7tV2HIPqHCYHLquSuxIC3F8strIQLJKO3rZmTT96KTnhsOfBO7Y1bI7mnT0PB3_vcHd9ekWMEoZJQw7MuB8KeM_Wn54-elJr5DNLk5bMppSGxX7ZnumiXGG51_X3Yp-_EbGtDG80GxXXix7Mucyo7K25uE0uW8=",
    "e": "AQAB",
    "d": "agN2O9NxMHL1MTMi75WfL9Pxvl-KWXKqZSF6mjzAsF9iKI8euyHIXYFepzU8kual1RsjDhCnzvWqFvZplW8lXqrHf_P-rS_9Y4gBUw6pjnI_DnFIRwWHRvrUHHSCfWOdTCIKdOTkgLZuGFuhEY3RMIW0WSYejjLtftwy0RVxAzk=",
    "p": "6a4G1qmfwWmn1biigN7IVFlkbLf9oVe6g7rOmHxI-hn1GRxKDSVuAUrmR1IhuAnca9M0y7SD-7TUs6wjOxWxaw==",
    "q": "5ofkxFKdPBD0CQHMb9q13AMHUVe0rJ-hSjqqIBrmqApUOneyAcMV76M0QyIQnI2p3POa4Qu_7XChDwRVl7LlDQ==",
    "dp": "2mXGiGwCHl8j-FBWuID-1C6z-BRB3MBEVoeKPOOzxOPruatB3mWEGXsqG7A8SWgV9URxTI2K6P3J6Z7RUpBkvw==",
    "dq": "oagn5vfb5NQqnOpS9xkSsD67cfIj821ZSFlNFYhnuOzNVda7z_qCtnHm4zDPH0lEFXoKYMfBhfqWJpaugttjPQ==",
    "qi": "dqEQgxNmOVFrF4s776hTqeC6oEDila8EvpVb2F2ZvwAOLjCQ66OiAZK1BiYGHqUy0NeqNmtlsLSuBEZQZvqZwg=="
}

Открытый ключ RSA:

1
2
3
4
5
{
    "kty": "RSA",
    "n": "0m5lvKpWqy9JS7tV2HIPqHCYHLquSuxIC3F8strIQLJKO3rZmTT96KTnhsOfBO7Y1bI7mnT0PB3_vcHd9ekWMEoZJQw7MuB8KeM_Wn54-elJr5DNLk5bMppSGxX7ZnumiXGG51_X3Yp-_EbGtDG80GxXXix7Mucyo7K25uE0uW8=",
    "e": "AQAB"
}

Закрытый ключ ЕС:

1
2
3
4
5
6
7
{
    "kty": "EC",
    "crv": "P-521",
    "x": "ATfNNFuuvlGxrTGoXgyfSAGgRNNDnO3rN3k74urKJdVS14RYhdnSwm91Bm-F1l-T1XKlAY2yRnzG9w1Ukvo8c0wL",
    "y": "ASBHqrruB6kdkEUB3vlW3-UIkk4HtKdUeTwN-7m3j2rgZvYR1ffRAapDvWqKGiBjomqWafxokBkbDI0c95f6f4XU",
    "d": "AfkIbUHXfW41njdpoKuqqKludcoLJS8D_oMEwkj-GVaXFNKccIoF5iKGu2c69kNDjo83R_7wyGlfRczsklkik1ST"
}

Открытый ключ ЕС:

1
2
3
4
5
6
{
    "kty": "EC",
    "crv": "P-521",
    "x": "ATfNNFuuvlGxrTGoXgyfSAGgRNNDnO3rN3k74urKJdVS14RYhdnSwm91Bm-F1l-T1XKlAY2yRnzG9w1Ukvo8c0wL",
    "y": "ASBHqrruB6kdkEUB3vlW3-UIkk4HtKdUeTwN-7m3j2rgZvYR1ffRAapDvWqKGiBjomqWafxokBkbDI0c95f6f4XU"
}

атрибут члена

name

Строка, возвращает имя текущего алгоритма

1
readonly String PKey.name;

keySize

Integer, возвращает текущую длину пароля алгоритма в битах

1
readonly Integer PKey.keySize;

alg

Строка, возвращает и устанавливает алгоритм подписи текущего объекта

1
String PKey.alg;

publicKey

PKey, возвращает открытый ключ текущего ключа

1
readonly PKey PKey.publicKey;

возвращаемый результат:

  • открытый ключ текущего ключа

функция-член

isPrivate

Запросить, является ли текущий ключ закрытым ключом

1
Boolean PKey.isPrivate();

возвращаемый результат:

  • Boolean, если True означает закрытый ключ

clone

скопировать текущий ключ

1
PKey PKey.clone();

возвращаемый результат:

  • PKey, объект копирования текущего ключа

pem

Возвращает кодировку формата PEM текущего ключа

1
String PKey.pem();

возвращаемый результат:

  • String, кодировка формата PEM текущего ключа

der

Возвращает кодировку формата DER текущего ключа

1
Buffer PKey.der();

возвращаемый результат:

  • Buffer, кодировка формата DER текущего ключа

json

Возвращает кодировку формата jwt текущего ключа

1
Object PKey.json(Object opts = {});

Параметры вызова:

  • opts: Объект, указывает параметры экспорта

возвращаемый результат:

  • Object, кодировка формата jwt текущего ключа

opts поддерживает следующие параметры:

1
2
3
{
    compress: false， 指定签名以压缩方式输出公钥
}

Кривые, поддерживающие сжатие:

equals

Сравните, являются ли два открытых/закрытых ключа одинаковыми

1
Boolean PKey.equals(PKey key);

Параметры вызова:

  • key: PKey, укажите открытый/закрытый ключ другой стороны

возвращаемый результат:

  • Boolean, вернуть true, если то же самое

encrypt

Шифрование данных с использованием криптографического открытого ключа текущего алгоритма

1
Buffer PKey.encrypt(Buffer data) async;

Параметры вызова:

  • data:Buffer, указывает данные для шифрования

возвращаемый результат:

  • Buffer, возвращает зашифрованные данные

decrypt

Расшифруйте данные, используя криптографический закрытый ключ текущего алгоритма.

1
Buffer PKey.decrypt(Buffer data) async;

Параметры вызова:

  • data:Buffer, указывает данные для расшифровки

возвращаемый результат:

  • Buffer, возвращает расшифрованные данные

sign

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

1
2
Buffer PKey.sign(Buffer data,
    Object opts = {}) async;

Параметры вызова:

  • data:Buffer, указывает данные для подписи
  • opts: Объект, указывает параметры подписи.

возвращаемый результат:

  • Buffer, возвращает подписанные данные

opts поддерживает следующие параметры:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    alg: 0， 指定签名的 hash 算法， 仅在 RSA 时有效， 缺省为 0. 支持算法: 0 = NONE,
    1 = MD5,
    2 = SHA1,
    3 = SHA224,
    4 = SHA256,
    5 = SHA384,
    6 = SHA512,
    7 = RIPEMD160
    to: pk,
    指定验证方公钥， 仅在 ecsdsa 或 sm2 时有效
    format: "der",
    指定签名格式， 可选为 der 和 raw， 缺省为 der
    recoverable: false 指定返回可恢复签名， 仅在 secp256k1 有效
}

verify

Проверка данных с использованием открытого криптографического ключа текущего алгоритма

1
2
3
Boolean PKey.verify(Buffer data,
    Buffer sign,
    Object opts = {}) async;

Параметры вызова:

  • data:Buffer, указав данные для проверки
  • sign:Buffer, указав подпись для проверки
  • opts: Объект, указывает параметры аутентификации

возвращаемый результат:

  • Boolean, возвращает проверенный результат

opts поддерживает следующие параметры:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
    alg: 0， 指定签名的 hash 算法， 仅在 RSA 时有效， 缺省为 0. 支持算法: 0 = NONE,
    1 = MD5,
    2 = SHA1,
    3 = SHA224,
    4 = SHA256,
    5 = SHA384,
    6 = SHA512,
    7 = RIPEMD160
    to: pk,
    指定验证方公钥， 仅在 ecsdsa 或 sm2 时有效
    format: "der",
    指定签名格式， 可选为 der 和 raw， 缺省为 der
}

toString

Возвращает строковое представление объекта, как правило, возвращает «[Native Object]», объект может быть переопределен в соответствии с его собственными характеристиками.

1
String PKey.toString();

возвращаемый результат:

  • String, возвращает строковое представление объекта

toJSON

Возвращает представление объекта в формате JSON, обычно возвращает набор читаемых свойств, определенных объектом.

1
Value PKey.toJSON(String key = "");

Параметры вызова:

  • key: Строка, не используется

возвращаемый результат:

  • Value, который возвращает сериализуемое значение JSON
© Copyright 2012-2021 fibjs.org Поддержите нас