對象PKey

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

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

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

generateKey(alg | bits)：生成一對密鑰，alg 指定密鑰算法，bits 指定密鑰長度，缺省為2048。

1
2
3
var crypto = require('crypto');

var pkey = crypto.generateKey(2048);

from(value[, password])：將DER 或PEM 格式的密鑰加載到PKey 對像中。

1
2
3
var crypto = require('crypto');

var pkey = crypto.PKey.from(fs.readFile('rsa.private.pem'));

publicKey：獲取當前密鑰的公鑰。

1
2
3
4
var crypto = require('crypto');

var pkey = crypto.PKey.from(fs.readFile('rsa.private.pem'));
var pubkey = pkey.publicKey;

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

繼承關係

構造函數

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, 返回當前算法密碼長度，以位為單位

1readonly Integer PKey.keySize;

alg

String, 返回和設置當前對象簽名算法

1
String PKey.alg;

publicKey

PKey, 返回當前密鑰的公鑰

1readonly PKey PKey.publicKey;

返回結果:

當前密鑰的公鑰

成員函數

isPrivate

查詢當前密鑰是否為私鑰

1
Boolean PKey.isPrivate();

返回結果:

Boolean, 為True 表示為私鑰

clone

複製當前密鑰

1PKey PKey.clone();

返回結果:

PKey, 當前密鑰的複制對象

pem

返回當前key 的PEM 格式編碼

1
String PKey.pem();

返回結果:

String, 當前key 的PEM 格式編碼

der

返回當前key 的DER 格式編碼

1Buffer 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， 指定签名以压缩方式输出公钥
}

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

equals

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

1
Boolean PKey.equals(PKey key);

調用參數:

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

返回結果:

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
2Buffer PKey.sign(Buffer data,
    Object opts = {}) async;

調用參數:

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

返回結果:

Buffer, 返回簽名後的數據

opts 支持以下參數:

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

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

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

返回對象的字符串表示，一般返回"[Native Object]"，對象可以根據自己的特性重新實現

1
String PKey.toString();

返回結果:

String, 返回對象的字符串表示

toJSON

返回對象的JSON 格式表示，一般返回對象定義的可讀屬性集合

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

調用參數:

key: String, 未使用

返回結果:

Value, 返回包含可JSON 序列化的值

開髮指南

基礎模塊

內置對象

社區模塊

對象PKey

繼承關係

構造函數

PKey

靜態函數

from

成員屬性

name

keySize

alg

publicKey

成員函數

isPrivate

clone

pem

der

json

equals

encrypt

decrypt

sign

verify

toString

toJSON