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

ОбъектПКей

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

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

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

  1. generKey(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. Равно(другое): Определить, равны ли два открытого и закрытого ключа.
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

Целое число, возвращает длину пароля текущего алгоритма в битах.

1
readonly Integer PKey.keySize;

alg

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

1
readonly 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 // specify whether to output public key in compressed form
}

Кривые, поддерживающие сжатие: secp192r1, secp192k1, secp256r1, secp256k1, BrainpoolP256r1, secp384r1, BrainpoolP384r1, BrainpoolP512r1, secp521r1, sm2.

equals

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

1
Boolean PKey.equals(object key);

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

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

Результаты возврата:

  • 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, укажите данные, которые будут подписаны.Если используется алгоритм RSA, входной параметр должен выполняться с использованием алгоритма, указанного в параметре alg.hash
  • opts: Объект, укажите параметры подписи

Результаты возврата:

  • Buffer, вернуть подписанные данные

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

1
2
3
4
5
{
    alg: 0, // specify the hash algorithm for signing, only valid for RSA, default is 0. Supported algorithms: 0=NONE,1=MD5,2=SHA1,3=SHA224,4=SHA256,5=SHA384,6=SHA512,7=RIPEMD160
    format: "der", // specify the signature format, default is der, supported formats: der, raw
    recoverable: false // specify whether to return a recoverable signature, only valid for 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
{
    alg: 0, // specify the hash algorithm for signing, only valid for RSA, default is 0. Supported algorithms: 0=NONE,1=MD5,2=SHA1,3=SHA224,4=SHA256,5=SHA384,6=SHA512,7=RIPEMD160
    format: "der" // specify the signature format, default is der, supported formats: der, raw
}

toString

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

1
String PKey.toString();

Результаты возврата:

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

toJSON

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

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

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

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

Результаты возврата:

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