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, secp521r1, sm2

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 | 支持我们