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

對象PKey

PKey 是內建的crypto模組提供的對象，它表示一對金鑰：公鑰和私鑰。PKey 支援在JS 中產生金鑰、載入金鑰、儲存金鑰以及對加密過程進行管理

PKey 物件支援多種加密演算法，如RSA、EC 或Ed25519 等，每種加密演算法都有其獨特的金鑰產生和管理方式。PKey 物件還包含了該金鑰所屬的演算法名稱以及金鑰長度等屬性。

以下是PKey 的常用方法及其舉例說明：

  1. generateKey(alg | bits)：產生一對金鑰，alg 指定金鑰演算法，bits 指定金鑰長度，預設為2048。
1
2
3
var crypto = require('crypto');

var pkey = crypto.generateKey(2048);
  1. from(value[, password])：將DER 或PEM 格式的金鑰載入到PKey 物件中。
1
2
3
var crypto = require('crypto');

var pkey = crypto.PKey.from(fs.readFile('rsa.private.pem'));
  1. publicKey：取得目前密鑰的公鑰。
1
2
3
4
var crypto = require('crypto');

var pkey = crypto.PKey.from(fs.readFile('rsa.private.pem'));
var pubkey = pkey.publicKey;
  1. equals(other)：判斷兩個公、私鑰是否相等。
1
2
3
4
5
var crypto = require('crypto');

var pkey1 = crypto.PKey.from(fs.readFile('rsa.private.pem'));
var pkey2 = crypto.PKey.from(fs.readFile('rsa.public.pem'));
console.log(pkey1.equals(pkey2)); // output: true

繼承關係

%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 PKey->ECKey BlsKey BlsKey ECKey->BlsKey Ed25519Key Ed25519Key ECKey->Ed25519Key

建構函數

PKey

透過DER 格式的密鑰建構PKey

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

呼叫參數:

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

透過PEM 格式的密鑰建構PKey

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

呼叫參數:

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

透過JSON 格式的金鑰建構PKey

1
new PKey(Object jsonKey);

呼叫參數:

  • jsonKey: Object, JSON 格式的金鑰

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

靜態函數

from

載入一個DER 格式的金鑰

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

呼叫參數:

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

回傳結果:

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

載入一個PEM 格式的金鑰

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

呼叫參數:

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

回傳結果:

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

載入一個JSON 格式的金鑰

1
static PKey PKey.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"
}

成員屬性

name

String, 傳回目前演算法名稱

1
readonly String PKey.name;

keySize

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

1
readonly Integer PKey.keySize;

alg

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

1
readonly String PKey.alg;

publicKey

PKey, 傳回目前金鑰的公鑰

1
readonly PKey PKey.publicKey;

回傳結果:

  • 目前密鑰的公鑰

成員函數

isPrivate

查詢目前密鑰是否為私鑰

1
Boolean PKey.isPrivate();

回傳結果:

  • Boolean, 為True 表示為私鑰

clone

複製當前密鑰

1
PKey PKey.clone();

回傳結果:

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

pem

傳回目前key 的PEM 格式編碼

1
String PKey.pem();

回傳結果:

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

der

傳回目前key 的DER 格式編碼

1
Buffer PKey.der();

回傳結果:

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

json

傳回目前key 的jwt 格式編碼

1
Object PKey.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 PKey.equals(object key);

呼叫參數:

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

回傳結果:

  • Boolean, 相同則回傳true

encrypt

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

1
Buffer PKey.encrypt(Buffer data) async;

呼叫參數:

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

回傳結果:

  • Buffer, 返回加密後的數據

decrypt

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

1
Buffer PKey.decrypt(Buffer data) async;

呼叫參數:

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

回傳結果:

  • Buffer, 返回解密後的數據

sign

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

1
2
Buffer PKey.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 PKey.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 PKey.toString();

回傳結果:

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

toJSON

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

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

呼叫參數:

  • key: String, 未使用

回傳結果:

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