Obxecto obxecto incorporado

ObxectoECKey

A clase ECKey está encryptoImplementado no módulo, podes usar esta clase para xerar pares de claves ECDSA, mensaxes de sinatura e verificación, etc.

Aquí tes un exemplo:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
const crypto = require("crypto"); // generate a secp256k1 key const key = crypto.generateKey("secp256k1"); console.log("Private key:", key.pem()); console.log("Public key:", key.publicKey.pem()); const message = "Hello, fibjs!"; // sign a message const sig = key.sign(message); console.log("Signature:", sig.hex()); // very the signature const verify = key.verify(message, sig); console.log("Verify result:", verify);

Neste exemplo, primeiro xeramos un obxecto ECKey secp256k1 e despois imprimimos as claves públicas e privadas xeradas. A continuación, asinamos a mensaxe "Ola, fibjs!" e imprimimos o resultado da sinatura e, finalmente, verificamos a sinatura usando o mesmo obxecto clave e imprimimos o resultado da verificación.

relación de herdanza

Construtor

ECKey

Constrúe ECKey a partir dunha clave en formato DER

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

Parámetros de chamada:

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

Constrúe ECKey a partir da clave en formato PEM

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

Parámetros de chamada:

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

Constrúe ECKey a partir da clave en formato JSON

1
new ECKey(Object jsonKey);

Parámetros de chamada:

  • jsonKey: Obxecto, clave en formato JSON

O formato de jsonKey admite os dous tipos seguintes, a 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

recover

recuperar a chave pública da sinatura recuperable, só é compatible con secp256k1

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

Parámetros de chamada:

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

devolver resultado:

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

from

Cargar unha chave en formato DER

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

Parámetros de chamada:

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

devolver resultado:

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

Cargar unha chave en formato PEM

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

Parámetros de chamada:

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

devolver resultado:

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

Cargar unha clave en formato JSON

1
static PKey ECKey.from(Object jsonKey);

Parámetros de chamada:

  • jsonKey: Obxecto, clave en formato JSON

devolver resultado:

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

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

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

atributo de membro

curve

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

1
readonly String ECKey.curve;

name

String, devolve o nome do algoritmo actual

1
readonly String ECKey.name;

keySize

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

1
readonly Integer ECKey.keySize;

alg

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

1
String ECKey.alg;

publicKey

PKey, devolve a chave pública da chave actual

1
readonly PKey ECKey.publicKey;

devolver resultado:

  • a chave pública da chave actual

función de membro

computeSecret

Calcula un segredo compartido de curva elíptica Diffie-Hellman (ECDH) usando o algoritmo actual

1
Buffer ECKey.computeSecret(ECKey publicKey) async;

Parámetros de chamada:

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

devolver resultado:

  • Buffer, devolve o segredo compartido calculado

isPrivate

Consulta se a clave actual é unha clave privada

1
Boolean ECKey.isPrivate();

devolver resultado:

  • Boolean, se True significa clave privada

clone

copiar a chave actual

1
PKey ECKey.clone();

devolver resultado:

  • PKey, o obxecto de copia da clave actual

pem

Devolve a codificación do formato PEM da clave actual

1
String ECKey.pem();

devolver resultado:

  • String, a codificación do formato PEM da clave actual

der

Devolve a codificación do formato DER da clave actual

1
Buffer ECKey.der();

devolver resultado:

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

json

Devolve a codificación do formato jwt da clave actual

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

Parámetros de chamada:

  • opts: Obxecto, especifica opcións de exportación

devolver resultado:

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

opts admite os seguintes parámetros:

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

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


equals

Compare se dúas chaves públicas/privadas son iguais

1
Boolean ECKey.equals(PKey key);

Parámetros de chamada:

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

devolver resultado:

  • Boolean, devolve verdadeiro se é o mesmo

encrypt

Cifra datos usando a clave pública criptográfica do algoritmo actual

1
Buffer ECKey.encrypt(Buffer data) async;

Parámetros de chamada:

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

devolver resultado:

  • Buffer, devolve os datos cifrados

decrypt

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

1
Buffer ECKey.decrypt(Buffer data) async;

Parámetros de chamada:

  • data:Buffer, especifica os datos a descifrar

devolver resultado:

  • Buffer, devolve os datos descifrados

sign

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

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

Parámetros de chamada:

  • data:Buffer, especifica os datos a asinar
  • opts: Obxecto, especifica opcións de sinatura

devolver resultado:

  • Buffer, devolve os datos asinados

opts admite os seguintes 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 os datos utilizando a clave pública criptográfica do algoritmo actual

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

Parámetros de chamada:

  • data:Buffer, especificando os datos a validar
  • sign:Buffer, especificando a sinatura a verificar
  • opts: Obxecto, especifica as opcións de autenticación

devolver resultado:

  • Boolean, devolve o resultado verificado

opts admite os seguintes 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

Devolve a representación en cadea do obxecto, xeralmente devolve "[Obxecto nativo]", o obxecto pódese reimplementar segundo as súas propias características

1
String ECKey.toString();

devolver resultado:

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

toJSON

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

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

Parámetros de chamada:

  • key: Cadena, non usada

devolver resultado:

  • Value, que devolve un valor serializable por JSON