Object 內置對象

對象PKey

不對稱加密算法對象

PKey 對象屬於 crypto 模塊,創建:

1
var k = new crypto.PKey();

繼承關係

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<this>PKey|new PKey()|name;keySize;publicKey|genRsaKey();genEcKey();genSm2Key();isPrivate();clone();importKey();importFile();exportPem();exportDer();exportJson();encrypt();decrypt();sign();verify()] [object] <:- [PKey] PKey new PKey() name keySize publicKey genRsaKey() genEcKey() genSm2Key() isPrivate() clone() importKey() importFile() exportPem() exportDer() exportJson() encrypt() decrypt() sign() verify() object toString() toJSON()

構造函數

PKey

PKey 構造函數

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

成員屬性

name

String, 返回當前算法名稱

1
readonly String PKey.name;

keySize

Integer, 返回當前算法密碼長度,以位為單位

1
readonly Integer PKey.keySize;

publicKey

PKey, 返回當前密鑰的公鑰

1
readonly PKey PKey.publicKey;

返回結果:

  • 當前密鑰的公鑰

成員函數

genRsaKey

生成一個RSA 私鑰

1
PKey.genRsaKey(Integer size) async;

調用參數:

  • size: Integer, 指定RSA 密鑰長度,bit 為單位

genEcKey

生成一個EC 私鑰

1
PKey.genEcKey(String curve = "secp521r1") async;

調用參數:

  • curve: String, 指定預置橢圓曲線,可選值為:"secp521r1", "brainpoolP512r1", "secp384r1", "brainpoolP384r1", "secp256r1", "secp256k1", "brainpoolP256r1", "secp224r1", "secp224k1", "secp192r1", "secp192k1"

genSm2Key

生成一個SM2 私鑰

1
PKey.genSm2Key() async;

isPrivate

查詢當前密鑰是否為私鑰

1
Boolean PKey.isPrivate();

返回結果:

  • Boolean, 為True 表示為私鑰

clone

複製當前密鑰

1
PKey PKey.clone();

返回結果:

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

importKey

加載一個DER 格式的密鑰

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

調用參數:

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

加載一個PEM 格式的密鑰

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

調用參數:

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

加載一個JSON 格式的密鑰

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

importFile

加載一個PEM/DER 格式的密鑰文件

1 2
PKey.importFile(String filename, String password = "");

調用參數:

  • filename: String, 密鑰文件名
  • password: String, 解密密碼

exportPem

返回當前key 的PEM 格式編碼

1
String PKey.exportPem();

返回結果:

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

exportDer

返回當前key 的DER 格式編碼

1
Buffer PKey.exportDer();

返回結果:

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

exportJson

返回當前key 的DER 格式編碼

1
Object PKey.exportJson();

返回結果:

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

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, Integer alg = 0) async;

調用參數:

  • data: Buffer, 指定要簽名的數據
  • alg: Integer, 指定要簽名的算法, 默認0. 支持算法: 0=NONE,1=MD2,2=MD4,3=MD5,4=SHA1,5=SHA224,6=SHA256,7=SHA384,8=SHA512 ,9=RIPEMD160

返回結果:

  • Buffer, 返回簽名後的數據

verify

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

1 2 3
Boolean PKey.verify(Buffer data, Buffer sign, Integer alg = 0) async;

調用參數:

  • data: Buffer, 指定要驗證的數據
  • sign: Buffer, 指定要驗證的簽名
  • alg: Integer, 指定要簽名的算法, 默認0. 支持算法: 0=NONE,1=MD2,2=MD4,3=MD5,4=SHA1,5=SHA224,6=SHA256,7=SHA384,8=SHA512 ,9=RIPEMD160

返回結果:

  • Boolean, 返回驗證後的結果

toString

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

1
String PKey.toString();

返回結果:

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

toJSON

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

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

調用參數:

  • key: String, 未使用

返回結果:

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