Obxecto obxecto incorporado

ObxectoBlsKey

Obxecto de algoritmo de cifrado de curva elíptica

O obxecto BlsKey é un obxecto usado en fibjs para representar unha chave BLS. Pódese usar para construír, importar, exportar e manipular chaves BLS. A clave BLS é un método de cifrado de clave pública que se usa habitualmente para a autenticación e a sinatura de datos, e ten as características de proporcionar unha alta velocidade de execución ao tempo que se garante a seguridade.

O obxecto BlsKey proporciona varios métodos de construtor para cargar claves de diferentes formatos de clave. Tamén ofrece algunhas propiedades e métodos públicos como toString(), clone(), name, publicKey(), etc., así como algúns métodos estáticos, como from(), etc. Podes usar estes métodos para manipular obxectos BlsKey.

Ademais, o obxecto BlsKey ten atributos de membro como isPrivate() e toJSON(key = ""), que se poden usar para consultar se a chave é unha clave privada e exportar a representación en formato JSON do obxecto.

O obxecto BlsKey ofrece un conxunto de API flexibles e potentes para xestionar facilmente as chaves BLS e implementar requisitos de seguranza como a autenticación e a sinatura de datos.

A continuación usamos un exemplo sinxelo para demostrar como usar o obxecto BlsKey para asinar e verificar:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
var crypto = require('crypto'); // create a private key var privateKey = new crypto.BlsKey({ 'kty': 'EC', 'crv': 'BLS12-381-G1', 'x': 'TPk62yDxSISkoSBRPYkpO%tJmm0tZd4tJeLuCKVFv4UmBPfOQ2aDWrCifANam2wj', 'd': 'zE-pf24p-l0IT_lMcrX0gStTcsx_k1f7DnJmrN8V7ZU', }); // sign a message var message = '这是一条需要签名的消息'; var signature = privateKey.sign(message); // verify the signature var publicKey = privateKey.publicKey; var verify = publicKey.verify(message, signature); console.log('verification result:', verify);

relación de herdanza

Construtor

BlsKey

Construír BlsKey a partir da clave en formato JSON

1
new BlsKey(Object jsonKey);

Parámetros de chamada:

  • jsonKey: Obxecto, clave en formato JSON

O formato de jsonKey admite os seguintes dous tipos de claves privadas:

1 2 3 4 5 6
{ "kty": "EC", "crv": "BLS12381_G1", "x": "tCgCNuUYQotPEsrljWi-lIRIPpzhqsnJV1NPnE7je6glUb-FJm9IYkuv2hbHw22i", "d": "TXNvJBBG3h23H5hFJcnRZmYd_j1TqpwtJOllYGU3yyw" }

Chave pública Bls:

1 2 3 4 5
{ "kty": "EC", "crv": "BLS12381_G1", "x": "tCgCNuUYQotPEsrljWi-lIRIPpzhqsnJV1NPnE7je6glUb-FJm9IYkuv2hbHw22i" }

función estática

aggregateSignature

Combina un conxunto de sinaturas nunha única sinatura

1
static Buffer BlsKey.aggregateSignature(Array sigs);

Parámetros de chamada:

  • sigs: Matriz, un conxunto de sinaturas que se van combinar

Resultados de devolución:

  • Buffer, devolve a sinatura única combinada

aggregatePublicKey

Combina un conxunto de chaves públicas nunha única chave pública

1
static BlsKey BlsKey.aggregatePublicKey(Array keys);

Parámetros de chamada:

  • keys: Matriz, un conxunto de chaves públicas que se van combinar

Resultados de devolución:

  • BlsKey, devolve a clave pública única combinada

recover

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

1 2
static ECKey BlsKey.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 BlsKey.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 BlsKey.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 BlsKey.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

bbs_suite

Cadea, paquete de cifrado asinado por BBS, o predeterminado é Bls12381Sha256, pódese modificar a Bls12381Shake256, só admite a curva BLS12-381-G2

1
String BlsKey.bbs_suite;

curve

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

1
readonly String BlsKey.curve;

name

String, devolve o nome do algoritmo actual

1
readonly String BlsKey.name;

keySize

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

1
readonly Integer BlsKey.keySize;

alg

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

1
readonly String BlsKey.alg;

publicKey

PKey, devolve a chave pública da chave actual

1
readonly PKey BlsKey.publicKey;

Resultados de devolución:

  • a chave pública da chave actual

función de membro

bbsSign

Asina un conxunto de mensaxes usando a clave privada actual, só admite a curva BLS12-381-G2

1 2
Buffer BlsKey.bbsSign(Array messages, Object opts = {}) async;

Parámetros de chamada:

  • messages: Matriz, especifica a matriz de mensaxes que se vai asinar
  • opts: Obxecto, especifique as opcións de sinatura

Resultados de devolución:

  • Buffer, devolve a mensaxe asinada

opts admite os seguintes parámetros:

1 2 3
{ header: Buffer | string // specified header for signature, default is empty }

bbsVerify

Verifica a sinatura usando a chave pública actual, só admite a curva BLS12-381-G2

1 2 3
Boolean BlsKey.bbsVerify(Array messages, Buffer sig, Object opts = {}) async;

Parámetros de chamada:

  • messages: Matriz, especifica a matriz de mensaxes completa
  • sig: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
{ header: Buffer | string // specified header for signature, default is empty }

proofGen

Xera un certificado usando a clave pública e a sinatura actual, só admite a curva BLS12-381-G2

1 2 3 4
Buffer BlsKey.proofGen(Buffer sig, Array messages, Array idx, Object opts = {}) async;

Parámetros de chamada:

  • sig:Buffer, especifica a sinatura utilizada ao xerar o certificado
  • messages: Matriz, especifica a matriz de mensaxes completa
  • idx: Matriz, especifica o índice de mensaxes usado ao xerar probas, o índice baséase en 1
  • opts: Obxecto, especifique as opcións de proba

Resultados de devolución:

  • Buffer, devolve a proba xerada

opts admite os seguintes parámetros:

1 2 3 4
{ header: Buffer | string, // specified header for signature, default is empty proof_header: Buffer | string // specified header for proof, default is empty }

proofVerify

Use a clave pública actual para verificar o certificado, só admite a curva BLS12-381-G2

1 2 3 4
Boolean BlsKey.proofVerify(Array messages, Array idx, Buffer proof, Object opts = {}) async;

Parámetros de chamada:

  • messages: Matriz, especifica unha matriz de mensaxes filtradas en función do índice
  • idx: Matriz, especifica o índice de mensaxes usado na proba, o índice baséase en 1
  • proof:Buffer, especifique a proba xerada
  • opts: Obxecto, especifique as opcións de proba

Resultados de devolución:

  • Boolean, devolve o resultado verificado

opts admite os seguintes parámetros:

1 2 3 4
{ header: Buffer | string, // specified header for signature, default is empty proof_header: Buffer | string // specified header for proof, default is empty }

computeSecret

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

1
Buffer BlsKey.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 BlsKey.isPrivate();

Resultados de devolución:

  • Boolean, é verdadeiro e representa a clave privada

clone

copiar a chave actual

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

Parámetros de chamada:

  • key: Cadena, non usada

Resultados de devolución:

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