Objecte objecte incorporat

ObjectEd25519Clau

Objecte d'algoritme de xifratge de corba el·líptica

L'exemple següent mostra l'ús d'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ó hereditària

funció estàtica

recover

Recupereu la clau pública de la signatura recuperable, només admet secp256k1

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

Paràmetres de trucada:

  • data:Buffer, les dades originals de la signatura
  • sig:Buffer, signatura recuperable

Resultats de retorn:

  • ECKey, retorna un objecte que conté la clau pública

from

Carregueu una clau en format DER

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

Paràmetres de trucada:

  • DerKey:Buffer, clau en format DER
  • password: Cadena, contrasenya de desxifrat

Resultats de retorn:

  • PKey, retorna un objecte que conté la clau

Carregueu una clau en format PEM

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

Paràmetres de trucada:

  • pemKey: Cadena, clau en format PEM
  • password: Cadena, contrasenya de desxifrat

Resultats de retorn:

  • PKey, retorna un objecte que conté la clau

Carregueu una clau en format JSON

1
static PKey Ed25519Key.from(Object jsonKey);

Paràmetres de trucada:

  • jsonKey: Objecte, clau en format JSON

Resultats de retorn:

  • PKey, retorna un objecte que conté la clau

El format de jsonKey admet els quatre tipus de claus privades RSA següents:

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

Clau pública RSA:

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

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

Clau pública EC:

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

propietats dels membres

curve

Cadena, retorna el nom de la corba el·líptica de l'algorisme actual

1
readonly String Ed25519Key.curve;

name

String, retorna el nom de l'algorisme actual

1
readonly String Ed25519Key.name;

keySize

Enter, retorna la longitud actual de la contrasenya de l'algorisme en bits

1
readonly Integer Ed25519Key.keySize;

alg

String, retorna i estableix l'algoritme de signatura de l'objecte actual

1
readonly String Ed25519Key.alg;

publicKey

PKey, retorna la clau pública de la clau actual

1
readonly PKey Ed25519Key.publicKey;

Resultats de retorn:

  • la clau pública de la clau actual

funció de membre

toX25519

Converteix el parell de claus pública-privada X25519 des de l'objecte actual, només admet Ed25519

1
ECKey Ed25519Key.toX25519() async;

Resultats de retorn:

  • ECKey, retorna l'objecte de clau pública X25519 corresponent

computeSecret

Calcula la clau compartida de la corba el·líptica Diffie-Hellman (ECDH) utilitzant l'algoritme actual

1
Buffer Ed25519Key.computeSecret(ECKey publicKey) async;

Paràmetres de trucada:

  • publicKey:ECKey, especifiqueu la clau pública de l'altra part

Resultats de retorn:

  • Buffer, retorna la clau secreta compartida calculada

isPrivate

Consulta si la clau actual és una clau privada

1
Boolean Ed25519Key.isPrivate();

Resultats de retorn:

  • Boolean, és True i representa la clau privada

clone

copiar la clau actual

1
PKey Ed25519Key.clone();

Resultats de retorn:

  • PKey, l'objecte de còpia de la clau actual

pem

Retorna la codificació en format PEM de la clau actual

1
String Ed25519Key.pem();

Resultats de retorn:

  • String, codificació en format PEM de la clau actual

der

Retorna la codificació en format DER de la clau actual

1
Buffer Ed25519Key.der();

Resultats de retorn:

  • Buffer, la codificació en format DER de la clau actual

json

Retorna la codificació en format jwt de la clau actual

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

Paràmetres de trucada:

  • opts: Objecte, especifiqueu les opcions d'exportació

Resultats de retorn:

  • Object, la codificació en format jwt de la clau actual

opts admet els paràmetres següents:

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

Les corbes que admeten la compressió són: secp192r1, secp192k1, secp256r1, secp256k1, brainpoolP256r1, secp384r1, brainpoolP384r1, brainpoolP512r1, secp521r1, sm2


equals

Compareu dues claus públiques/privades per veure si són iguals

1
Boolean Ed25519Key.equals(object key);

Paràmetres de trucada:

  • key:object, especifiqueu la clau pública/privada de l'altra part

Resultats de retorn:

  • Boolean, si són iguals, retorna true

encrypt

Xifra les dades amb la clau pública de xifrat de l'algoritme actual

1
Buffer Ed25519Key.encrypt(Buffer data) async;

Paràmetres de trucada:

  • data:Buffer, especifiqueu les dades que voleu xifrar

Resultats de retorn:

  • Buffer, retorna les dades xifrades

decrypt

Desxifra les dades amb la clau privada de la contrasenya actual de l'algoritme

1
Buffer Ed25519Key.decrypt(Buffer data) async;

Paràmetres de trucada:

  • data:Buffer, especifiqueu les dades a desxifrar

Resultats de retorn:

  • Buffer, retorna les dades desxifrades

sign

Signeu les dades amb la clau privada criptogràfica actual de l'algoritme

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

Paràmetres de trucada:

  • data:Buffer, especifiqueu les dades a signar. Quan l'algorisme és RSA, el paràmetre d'entrada s'ha d'executar amb l'algorisme especificat per alg.hash
  • opts: Objecte, especifica les opcions de signatura

Resultats de retorn:

  • Buffer, retorneu les dades signades

opts admet els paràmetres següents:

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

Verifiqueu les dades mitjançant la clau pública criptogràfica de l'algoritme actual

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

Paràmetres de trucada:

  • data:Buffer, especifiqueu les dades a verificar
  • sign:Buffer, especifiqueu la signatura a verificar
  • opts: Objecte, especifiqueu opcions de verificació

Resultats de retorn:

  • Boolean, retorna el resultat verificat

opts admet els paràmetres següents:

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

Retorna la representació de cadena de l'objecte. En general, es retorna "[Objecte natiu]". L'objecte es pot tornar a implementar segons les seves pròpies característiques.

1
String Ed25519Key.toString();

Resultats de retorn:

  • String, retorna la representació de cadena de l'objecte

toJSON

Retorna una representació en format JSON de l'objecte, generalment retornant una col·lecció de propietats llegibles definides per l'objecte.

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

Paràmetres de trucada:

  • key: Corda, no utilitzada

Resultats de retorn:

  • Value, retorna un valor que conté JSON serializable