Obxecto obxecto incorporado

ObxectoEd25519Clave

Obxecto de algoritmo de cifrado de curva elíptica

O seguinte exemplo demostra o uso de Ed25519Key:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
const crypto = require('crypto'); // generate a ed25519 key const key = crypto.generateKey('ed25519'); // output key in PEM format console.log('PrivateKey:', key.pem()); console.log('PublicKey:', key.publicKey.pem()); // sign a message const message = 'Hello, World!'; const sig = key.sign(message); console.log('Sig:', sig.hex()); // verify the signature const verifyResult = key.verify(message, sig); console.log('Verify Result:', verifyResult);

relación de herdanza

función estática

recover

Recupere a chave pública da sinatura recuperable, só admite secp256k1

1 2
static ECKey Ed25519Key.recover(Buffer data, Buffer sig) async;

Parámetros de chamada:

  • data:Buffer, os datos orixinais da sinatura
  • sig:Buffer, sinatura recuperable

Resultados de devolución:

  • ECKey, devolve un obxecto que contén a chave pública

from

Cargar unha chave en formato DER

1 2
static PKey Ed25519Key.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 Ed25519Key.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 Ed25519Key.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

curve

Cadea, devolve o nome da curva elíptica do algoritmo actual

1
readonly String Ed25519Key.curve;

name

String, devolve o nome do algoritmo actual

1
readonly String Ed25519Key.name;

keySize

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

1
readonly Integer Ed25519Key.keySize;

alg

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

1
readonly String Ed25519Key.alg;

publicKey

PKey, devolve a chave pública da chave actual

1
readonly PKey Ed25519Key.publicKey;

Resultados de devolución:

  • a chave pública da chave actual

función de membro

toX25519

Converte o par de chaves público-privado X25519 do obxecto actual, só admite Ed25519

1
ECKey Ed25519Key.toX25519() async;

Resultados de devolución:

  • ECKey, devolve o obxecto de chave pública X25519 correspondente

computeSecret

Calcula a clave compartida de Diffie-Hellman (ECDH) de curva elíptica usando o algoritmo actual

1
Buffer Ed25519Key.computeSecret(ECKey publicKey) async;

Parámetros de chamada:

  • publicKey:ECKey, especifique a chave pública da outra parte

Resultados de devolución:

  • Buffer, devolve a clave secreta compartida calculada

isPrivate

Consulta se a clave actual é unha clave privada

1
Boolean Ed25519Key.isPrivate();

Resultados de devolución:

  • Boolean, é verdadeiro e representa a clave privada

clone

copiar a chave actual

1
PKey Ed25519Key.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 Ed25519Key.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 Ed25519Key.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 Ed25519Key.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 Ed25519Key.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 Ed25519Key.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 Ed25519Key.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 Ed25519Key.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 Ed25519Key.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 Ed25519Key.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 Ed25519Key.toJSON(String key = "");

Parámetros de chamada:

  • key: Cadena, non usada

Resultados de devolución:

  • Value, devolve un valor que contén JSON serializable