Object 內建對象
  1. 首頁
  2. 內建對象
  3. 對象BlsKey

對象BlsKey

橢圓曲線加密演算法對象

BlsKey 物件是fibjs 中用來表示BLS 金鑰的物件。它可以用於建置、匯入、匯出和操作BLS 金鑰。 BLS 金鑰是一種公鑰加密方式，通常用於身份驗證和資料簽名，具有在保證安全性的同時提供較高執行速度的特性。

BlsKey 物件提供了多種建構方法，可以從不同的金鑰格式載入金鑰。它也提供了一些類似於toString()、clone()、name、publicKey() 等公共屬性和方法，以及一些靜態方法，例如from() 等。可以用這些方法操作BlsKey 物件。

此外，BlsKey 物件具有isPrivate()、toJSON(key = "") 等成員屬性，可用於查詢金鑰是否為私鑰以及匯出物件的JSON 格式表示等操作。

BlsKey 物件提供了一組靈活且強大的API，可以輕鬆管理BLS 金鑰，實現身份驗證和資料簽章等安全需求。

下面我們以一個簡單的範例來示範如何使用BlsKey 物件進行簽章和驗簽：

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);

繼承關係

%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 new ECKey() recover() curve computeSecret() PKey->ECKey BlsKey BlsKey new BlsKey() aggregateSignature() aggregatePublicKey() bbs_suite bbsSign() bbsVerify() proofGen() proofVerify() ECKey->BlsKey

建構函數

BlsKey

透過JSON 格式的金鑰建構BlsKey

1
new BlsKey(Object jsonKey);

呼叫參數:

  • jsonKey: Object, JSON 格式的金鑰

jsonKey 的格式支援以下兩種，私鑰：

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

Bls 公鑰：

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

靜態函數

aggregateSignature

合併一組簽名為單一簽名

1
static Buffer BlsKey.aggregateSignature(Array sigs);

呼叫參數:

  • sigs: Array, 待合併的一組簽名

回傳結果:

  • Buffer, 回傳合併的單一簽名

aggregatePublicKey

合併一組公鑰為一個單一公鑰

1
static BlsKey BlsKey.aggregatePublicKey(Array keys);

呼叫參數:

  • keys: Array, 待合併的一組公鑰

回傳結果:

  • BlsKey, 傳回合併的單一公鑰

recover

從可恢復簽章中恢復公鑰，僅支援secp256k1

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

呼叫參數:

  • data:Buffer, 簽署的原始數據
  • sig:Buffer, 可恢復簽名

回傳結果:

  • ECKey, 傳回包含公鑰的對象

from

載入一個DER 格式的金鑰

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

呼叫參數:

  • DerKey:Buffer, DER 格式的金鑰
  • password: String, 解密密碼

回傳結果:

  • PKey, 傳回包含密鑰的對象

載入一個PEM 格式的金鑰

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

呼叫參數:

  • pemKey: String, PEM 格式的金鑰
  • password: String, 解密密碼

回傳結果:

  • PKey, 傳回包含密鑰的對象

載入一個JSON 格式的金鑰

1
static PKey BlsKey.from(Object jsonKey);

呼叫參數:

  • jsonKey: Object, JSON 格式的金鑰

回傳結果:

  • PKey, 傳回包含密鑰的對象

jsonKey 的格式支援以下四種，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=="
}

RSA 公鑰：

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

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

EC 公鑰：

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

成員屬性

bbs_suite

String, BBS 簽署的加密套件，預設為Bls12381Sha256，可修改為Bls12381Shake256，僅支援BLS12-381-G2 曲線

1
String BlsKey.bbs_suite;

curve

String, 傳回目前演算法的橢圓曲線名稱

1
readonly String BlsKey.curve;

name

String, 傳回目前演算法名稱

1
readonly String BlsKey.name;

keySize

Integer, 傳回目前演算法密碼長度，以位元為單位

1
readonly Integer BlsKey.keySize;

alg

String, 傳回並設定目前物件簽名演算法

1
readonly String BlsKey.alg;

publicKey

PKey, 傳回目前密鑰的公鑰

1
readonly PKey BlsKey.publicKey;

回傳結果:

  • 目前密鑰的公鑰

成員函數

bbsSign

使用目前私鑰簽署一組訊息，僅支援BLS12-381-G2 曲線

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

呼叫參數:

  • messages: Array, 指定待簽署的訊息數組
  • opts: Object, 指定簽名選項

回傳結果:

  • Buffer, 返回簽署的訊息

opts 支援以下參數:

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

bbsVerify

使用目前公鑰驗證簽名，僅支援BLS12-381-G2 曲線

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

呼叫參數:

  • messages: Array, 指定完整的訊息數組
  • sig:Buffer, 指定要驗證的簽名
  • opts: Object, 指定驗證選項

回傳結果:

  • Boolean, 回傳驗證後的結果

opts 支援以下參數:

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

proofGen

使用目前公鑰和簽章產生一個證明，僅支援BLS12-381-G2 曲線

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

呼叫參數:

  • sig:Buffer, 指定產生證明時所使用的簽名
  • messages: Array, 指定完整的訊息數組
  • idx: Array, 指定產生證明時所使用的訊息索引，索引以1 為基數
  • opts: Object, 指定證明選項

回傳結果:

  • Buffer, 返回生成的證明

opts 支援以下參數:

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

使用目前公鑰驗證證明，僅支援BLS12-381-G2 曲線

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

呼叫參數:

  • messages: Array, 指定根據索引過濾的訊息數組
  • idx: Array, 指定證明使用的訊息索引，索引以1 為基數
  • proof:Buffer, 指定生成的證明
  • opts: Object, 指定證明選項

回傳結果:

  • Boolean, 回傳驗證後的結果

opts 支援以下參數:

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

使用目前演算法計算橢圓曲線Diffie-Hellman (ECDH) 共享金鑰

1
Buffer BlsKey.computeSecret(ECKey publicKey) async;

呼叫參數:

  • publicKey:ECKey, 指定對方的公鑰

回傳結果:

  • Buffer, 傳回計算出的共享金鑰

isPrivate

查詢目前密鑰是否為私鑰

1
Boolean BlsKey.isPrivate();

回傳結果:

  • Boolean, 為True 表示為私鑰

clone

複製當前密鑰

1
PKey BlsKey.clone();

回傳結果:

  • PKey, 當前密鑰的複製對象

pem

傳回目前key 的PEM 格式編碼

1
String BlsKey.pem();

回傳結果:

  • String, 目前key 的PEM 格式編碼

der

傳回目前key 的DER 格式編碼

1
Buffer BlsKey.der();

回傳結果:

  • Buffer, 當前key 的DER 格式編碼

json

傳回目前key 的jwt 格式編碼

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

呼叫參數:

  • opts: Object, 指定匯出選項

回傳結果:

  • Object, 當前key 的jwt 格式編碼

opts 支援以下參數:

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

支持壓縮的曲線為：secp192r1, secp192k1, secp256r1, secp256k1, brainpoolP256r1, secp384r1, brainpoolP384r1, brainpoolP512r1, secp5211, secp5211, secp5211, secp5211

equals

比較兩個公/私鑰是否相同

1
Boolean BlsKey.equals(object key);

呼叫參數:

  • key:object, 指定對方的公/私鑰

回傳結果:

  • Boolean, 相同則回傳true

encrypt

使用當前演算法密碼公鑰加密數據

1
Buffer BlsKey.encrypt(Buffer data) async;

呼叫參數:

  • data:Buffer, 指定要加密的數據

回傳結果:

  • Buffer, 返回加密後的數據

decrypt

使用當前演算法密碼私鑰解密數據

1
Buffer BlsKey.decrypt(Buffer data) async;

呼叫參數:

  • data:Buffer, 指定要解密的數據

回傳結果:

  • Buffer, 返回解密後的數據

sign

使用當前演算法密碼私鑰簽署數據

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

呼叫參數:

  • data:Buffer, 指定要簽署的數據，當演算法為RSA，需對入參以alg 指定的演算法做hash
  • opts: Object, 指定簽名選項

回傳結果:

  • Buffer, 回傳簽名後的數據

opts 支援以下參數:

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

使用當前演算法密碼公鑰驗證數據

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

呼叫參數:

  • data:Buffer, 指定要驗證的數據
  • sign:Buffer, 指定要驗證的簽名
  • opts: Object, 指定驗證選項

回傳結果:

  • Boolean, 回傳驗證後的結果

opts 支援以下參數:

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

傳回物件的字串表示，一般回傳"[Native Object]"，物件可以根據自己的特性重新實現

1
String BlsKey.toString();

回傳結果:

  • String, 傳回物件的字串表示

toJSON

傳回物件的JSON 格式表示，一般傳回物件定義的可讀屬性集合

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

呼叫參數:

  • key: String, 未使用

回傳結果:

  • Value, 傳回包含可JSON 序列化的值
© Copyright 2012-2024 fibjs.org |支持我們