Objeto objeto incorporado
  1. página delantera
  2. objeto incorporado
  3. clavePobjeto

clavePobjeto

PKey está integradocryptoObjeto proporcionado por el módulo que representa un par de claves: una clave pública y una clave privada. PKey admite la generación de claves, la carga de claves, el almacenamiento de claves y la gestión del proceso de cifrado en JS

El objeto PKey admite varios algoritmos de cifrado, como RSA, EC o Ed25519, y cada algoritmo de cifrado tiene sus propios métodos únicos de generación y gestión de claves. El objeto PKey también contiene atributos como el nombre del algoritmo al que pertenece la clave y la longitud de la clave.

Los siguientes son métodos comunes de PKey y sus ejemplos:

  1. generateKey(alg | bits): genera un par de claves, alg especifica el algoritmo de la clave, bits especifica la longitud de la clave, el valor predeterminado es 2048.
1
2
3
var crypto = require('crypto');

var pkey = crypto.generateKey(2048);
  1. from(valor[, contraseña]): Cargue una clave en formato DER o PEM en un objeto PKey.
1
2
3
var crypto = require('crypto');

var pkey = crypto.PKey.from(fs.readFile('rsa.private.pem'));
  1. publicKey: Obtiene la clave pública de la clave actual.
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): determina si las dos claves pública y privada son iguales.
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

relación de herencia

%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

Constructor

PKey

Construya una PKey a partir de una clave en formato DER

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

Parámetros de llamada:

  • DerKey:Buffer, la clave en formato DER
  • password: Cadena, contraseña descifrada

Construya una PKey a partir de una clave en formato PEM

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

Parámetros de llamada:

  • pemKey: Cadena, clave en formato PEM
  • password: Cadena, contraseña descifrada

Construya una PKey a partir de una clave en formato JSON

1
new PKey(Object jsonKey);

Parámetros de llamada:

  • jsonKey: Objeto, clave en formato JSON

El formato de jsonKey admite los siguientes cuatro tipos de clave privada 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=="
}

Clave pública RSA:

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

Clave privada CE:

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"
}

Clave pública CE:

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

función estática

from

Cargar una clave en formato DER

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

Parámetros de llamada:

  • DerKey:Buffer, la clave en formato DER
  • password: Cadena, contraseña descifrada

resultado devuelto:

  • PKey, devuelve un objeto que contiene la clave

Cargar una clave en formato PEM

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

Parámetros de llamada:

  • pemKey: Cadena, clave en formato PEM
  • password: Cadena, contraseña descifrada

resultado devuelto:

  • PKey, devuelve un objeto que contiene la clave

Cargue una clave en formato JSON

1
static PKey PKey.from(Object jsonKey);

Parámetros de llamada:

  • jsonKey: Objeto, clave en formato JSON

resultado devuelto:

  • PKey, devuelve un objeto que contiene la clave

El formato de jsonKey admite los siguientes cuatro tipos de clave privada 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=="
}

Clave pública RSA:

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

Clave privada CE:

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"
}

Clave pública CE:

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

atributo de miembro

name

Cadena, devuelve el nombre del algoritmo actual

1
readonly String PKey.name;

keySize

Entero, devuelve la longitud de la contraseña del algoritmo actual en bits

1
readonly Integer PKey.keySize;

alg

String, devuelve y establece el algoritmo de firma del objeto actual

1
String PKey.alg;

publicKey

PKey, devuelve la clave pública de la clave actual

1
readonly PKey PKey.publicKey;

resultado devuelto:

  • la clave pública de la clave actual

función miembro

isPrivate

Consultar si la clave actual es una clave privada

1
Boolean PKey.isPrivate();

resultado devuelto:

  • Boolean, si es Verdadero significa clave privada

clone

copiar la clave actual

1
PKey PKey.clone();

resultado devuelto:

  • PKey, el objeto de copia de la clave actual

pem

Devuelve la codificación en formato PEM de la clave actual

1
String PKey.pem();

resultado devuelto:

  • String, la codificación de formato PEM de la clave actual

der

Devuelve la codificación en formato DER de la clave actual

1
Buffer PKey.der();

resultado devuelto:

  • Buffer, la codificación en formato DER de la clave actual

json

Devuelve la codificación de formato jwt de la clave actual

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

Parámetros de llamada:

  • opts: Objeto, especifica las opciones de exportación

resultado devuelto:

  • Object, la codificación en formato jwt de la clave actual

opts admite los siguientes parámetros:

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

Las curvas que soportan compresión son: secp192r1, secp192k1, secp256r1, secp256k1, brainpoolP256r1, secp384r1, brainpoolP384r1, brainpoolP512r1, secp521r1, sm2

equals

Comparar si dos claves públicas/privadas son iguales

1
Boolean PKey.equals(PKey key);

Parámetros de llamada:

  • key: PKey, especifique la clave pública/privada de la otra parte

resultado devuelto:

  • Boolean, devuelve verdadero si es lo mismo

encrypt

Cifrar datos utilizando la clave pública criptográfica del algoritmo actual

1
Buffer PKey.encrypt(Buffer data) async;

Parámetros de llamada:

  • data:Buffer, especifica los datos a cifrar

resultado devuelto:

  • Buffer, devuelve los datos cifrados

decrypt

Descifrar los datos utilizando la clave privada criptográfica del algoritmo actual

1
Buffer PKey.decrypt(Buffer data) async;

Parámetros de llamada:

  • data:Buffer, especifica los datos a descifrar

resultado devuelto:

  • Buffer, devuelve los datos descifrados

sign

Firmar datos utilizando la clave privada criptográfica del algoritmo actual

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

Parámetros de llamada:

  • data:Buffer, especifica los datos a firmar
  • opts: Objeto, especifica opciones de firma

resultado devuelto:

  • Buffer, devuelve los datos firmados

opts admite los siguientes parámetros:

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

Verifique los datos utilizando la clave pública criptográfica del algoritmo actual

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

Parámetros de llamada:

  • data:Buffer, especificando los datos a validar
  • sign:Buffer, especificando la firma a verificar
  • opts: Objeto, especifica las opciones de autenticación

resultado devuelto:

  • Boolean, devuelve el resultado verificado

opts admite los siguientes parámetros:

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

Devuelve la representación de cadena del objeto, generalmente devuelve "[Objeto nativo]", el objeto se puede volver a implementar de acuerdo con sus propias características

1
String PKey.toString();

resultado devuelto:

  • String, devuelve una representación de cadena del objeto

toJSON

Devuelve la representación en formato JSON del objeto, generalmente devuelve una colección de propiedades legibles definidas por el objeto

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

Parámetros de llamada:

  • key: Cadena, no utilizada

resultado devuelto:

  • Value, que devuelve un valor serializable JSON
© Copyright 2012-2021 fibjs.org | Apóyanos