Node.js crypto.generateKeyPair(type, options, callback)用法及代碼示例

crypto.generateKeyPair(type, options, callback)

參數

• type : <string> 必須是 'rsa' , 'rsa-pss' , 'dsa' , 'ec' , 'ed25519' , 'ed448' , 'x25519' , 'x448' , 或 'dh' .
• options：<Object>
  • modulusLength : <number> key 大小(以位為單位)(RSA、DSA)。
  • publicExponent : <number> 公共 index (RSA)。 默認： 0x10001 。
  • hashAlgorithm : <string> 消息摘要的名稱 (RSA-PSS)。
  • mgf1HashAlgorithm : <string> MGF1 使用的消息摘要的名稱 (RSA-PSS)。
  • saltLength : <number> 以字節為單位的最小鹽長度 (RSA-PSS)。
  • divisorLength : <number> q 的大小(以位 (DSA) 為單位)。
  • namedCurve : <string> 要使用的曲線的名稱 (EC)。
  • prime : <Buffer> 主要參數 (DH)。
  • primeLength : <number> 以比特為單位的素數長度 (DH)。
  • generator : <number> 自定義生成器 (DH)。 默認： 2 。
  • groupName : <string> Diffie-Hellman 組名 (DH)。請參閱 crypto.getDiffieHellman() 。
  • publicKeyEncoding： <Object> 參見 keyObject.export() 。
  • privateKeyEncoding： <Object> 參見 keyObject.export() 。
• callback：<Function>
  • err： <Error>
  • publicKey : <string> | <Buffer> | <KeyObject>
  • privateKey : <string> | <Buffer> | <KeyObject>

生成給定 type 的新非對稱 key 對。目前支持 RSA、RSA-PSS、DSA、EC、Ed25519、Ed448、X25519、X448 和 DH。

如果指定了 publicKeyEncoding 或 privateKeyEncoding，則此函數的行為就像在其結果上調用了 keyObject.export() 。否則， key 的相應部分將作為 KeyObject 返回。

建議將公鑰編碼為'spki'，將私鑰編碼為'pkcs8'，並對long-term 存儲進行加密：

const {
  generateKeyPair
} = await import('node:crypto');

generateKeyPair('rsa', {
  modulusLength: 4096,
  publicKeyEncoding: {
    type: 'spki',
    format: 'pem'
  },
  privateKeyEncoding: {
    type: 'pkcs8',
    format: 'pem',
    cipher: 'aes-256-cbc',
    passphrase: 'top secret'
  }
}, (err, publicKey, privateKey) => {
  // Handle errors and use the generated key pair.
});const {
  generateKeyPair,
} = require('node:crypto');

generateKeyPair('rsa', {
  modulusLength: 4096,
  publicKeyEncoding: {
    type: 'spki',
    format: 'pem'
  },
  privateKeyEncoding: {
    type: 'pkcs8',
    format: 'pem',
    cipher: 'aes-256-cbc',
    passphrase: 'top secret'
  }
}, (err, publicKey, privateKey) => {
  // Handle errors and use the generated key pair.
});

完成後，將調用 callback，並將 err 設置為 undefined 和 publicKey /privateKey 表示生成的 key 對。

如果此方法作為其 util.promisify() ed 版本調用，它會為具有 publicKey 和 privateKey 屬性的 Object 返回 Promise。