Obxecto obxecto incorporado
  1. paxina principal
  2. obxectos incorporados
  3. ObxectoKey

ObxectoKey

Pkey está incorporadocryptoUn obxecto proporcionado polo módulo que representa un par de claves: unha clave pública e unha clave privada. PKey admite a xeración de claves, a carga de claves, o almacenamento de claves e a xestión do proceso de cifrado en JS

O obxecto PKey admite varios algoritmos de cifrado, como RSA, EC ou Ed25519, etc. Cada algoritmo de cifrado ten o seu propio xeito único de xerar e xestionar claves. O obxecto PKey tamén contén atributos como o nome do algoritmo ao que pertence a clave e a lonxitude da clave.

Os seguintes son os métodos comúns de PKey e os seus exemplos:

  1. generateKey(alg | bits): xera un par de claves, alg especifica o algoritmo de chave, bits especifica a lonxitude da chave e o valor predeterminado é 2048.
1
2
3
var crypto = require('crypto');

var pkey = crypto.generateKey(2048);
  1. from(valor[, contrasinal]): carga a chave en formato DER ou PEM no obxecto PKey.
1
2
3
var crypto = require('crypto');

var pkey = crypto.PKey.from(fs.readFile('rsa.private.pem'));
  1. publicKey: obtén a chave pública da chave 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 se dúas claves públicas e privadas son iguais.
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 herdanza

%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

Construtor

PKey

Constrúe PKey a partir da clave en formato DER

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

Parámetros de chamada:

  • DerKey:Buffer, clave en formato DER
  • password: Cadea, contrasinal de descifrado

Constrúe PKey a partir da clave en formato PEM

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

Parámetros de chamada:

  • pemKey: Cadena, clave en formato PEM
  • password: Cadea, contrasinal de descifrado

Constrúe PKey a partir da clave en formato JSON

1
new PKey(Object jsonKey);

Parámetros de chamada:

  • jsonKey: Obxecto, clave en formato JSON

O formato de jsonKey admite os seguintes catro tipos de claves privadas 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=="
}

Chave pública RSA:

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

Clave privada EC:

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 EC:

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 unha chave en formato DER

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

Parámetros de chamada:

  • DerKey:Buffer, clave en formato DER
  • password: Cadea, contrasinal de descifrado

Resultados de devolución:

  • PKey, devolve un obxecto que contén a chave

Cargar unha chave en formato PEM

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

Parámetros de chamada:

  • pemKey: Cadena, clave en formato PEM
  • password: Cadea, contrasinal de descifrado

Resultados de devolución:

  • PKey, devolve un obxecto que contén a chave

Cargar unha clave en formato JSON

1
static PKey PKey.from(Object jsonKey);

Parámetros de chamada:

  • jsonKey: Obxecto, clave en formato JSON

Resultados de devolución:

  • PKey, devolve un obxecto que contén a chave

O formato de jsonKey admite os seguintes catro tipos de claves privadas 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=="
}

Chave pública RSA:

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

Clave privada EC:

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 EC:

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

propiedades dos membros

name

String, devolve o nome do algoritmo actual

1
readonly String PKey.name;

keySize

Enteiro, devolve a lonxitude do contrasinal do algoritmo actual en bits

1
readonly Integer PKey.keySize;

alg

String, devolve e establece o algoritmo de sinatura do obxecto actual

1
readonly String PKey.alg;

publicKey

PKey, devolve a chave pública da chave actual

1
readonly PKey PKey.publicKey;

Resultados de devolución:

  • a chave pública da chave actual

función de membro

isPrivate

Consulta se a clave actual é unha clave privada

1
Boolean PKey.isPrivate();

Resultados de devolución:

  • Boolean, é verdadeiro e representa a clave privada

clone

copiar a chave actual

1
PKey PKey.clone();

Resultados de devolución:

  • PKey, o obxecto de copia da clave actual

pem

Devolve a codificación do formato PEM da clave actual

1
String PKey.pem();

Resultados de devolución:

  • String, codificación en formato PEM da clave actual

der

Devolve a codificación do formato DER da clave actual

1
Buffer PKey.der();

Resultados de devolución:

  • Buffer, a codificación do formato DER da clave actual

json

Devolve a codificación do formato jwt da clave actual

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

Parámetros de chamada:

  • opts: Obxecto, especifique as opcións de exportación

Resultados de devolución:

  • Object, a codificación do formato jwt da clave actual

opts admite os seguintes parámetros:

1
2
3
{
    compress: false // specify whether to output public key in compressed form
}

As curvas que admiten a compresión son: secp192r1, secp192k1, secp256r1, secp256k1, brainpoolP256r1, secp384r1, brainpoolP384r1, brainpoolP512r1, secp521r1, sm2

equals

Compare dúas claves públicas/privadas para ver se son iguais

1
Boolean PKey.equals(object key);

Parámetros de chamada:

  • key:object, especifique a clave pública/privada da outra parte

Resultados de devolución:

  • Boolean, se son iguais, devolve verdadeiro

encrypt

Cifra datos usando a chave pública de cifrado do algoritmo actual

1
Buffer PKey.encrypt(Buffer data) async;

Parámetros de chamada:

  • data:Buffer, especifique os datos que se van cifrar

Resultados de devolución:

  • Buffer, devolve os datos cifrados

decrypt

Descifrar datos usando a clave privada do contrasinal do algoritmo actual

1
Buffer PKey.decrypt(Buffer data) async;

Parámetros de chamada:

  • data:Buffer, especifique os datos a descifrar

Resultados de devolución:

  • Buffer, devolve os datos descifrados

sign

Asina os datos usando a clave privada criptográfica do algoritmo actual

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

Parámetros de chamada:

  • data:Buffer, especifique os datos a asinar. Cando o algoritmo é RSA, o parámetro de entrada debe ser executado co algoritmo especificado por alg.hash
  • opts: Obxecto, especifique as opcións de sinatura

Resultados de devolución:

  • Buffer, devolve os datos asinados

opts admite os seguintes parámetros:

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

Verifique os datos utilizando a clave pública criptográfica do algoritmo actual

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

Parámetros de chamada:

  • data:Buffer, especifique os datos a verificar
  • sign:Buffer, especifique a sinatura que se quere verificar
  • opts: Obxecto, especifique as opcións de verificación

Resultados de devolución:

  • Boolean, devolve o resultado verificado

opts admite os seguintes parámetros:

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

Devolve a representación en cadea do obxecto. Polo xeral, devólvese "[Obxecto nativo]". O obxecto pódese volver implementar segundo as súas propias características.

1
String PKey.toString();

Resultados de devolución:

  • String, devolve a representación en cadea do obxecto

toJSON

Devolve unha representación en formato JSON do obxecto, devolvendo xeralmente unha colección de propiedades lexibles definidas polo obxecto.

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

Parámetros de chamada:

  • key: Cadena, non usada

Resultados de devolución:

  • Value, devolve un valor que contén JSON serializable
© Copyright 2012-2024 fibjs.org | Apóyanos