crypto.generateKeyPairSync

関数の概要

crypto.generateKeyPairSyncは、Node.jsの暗号モジュールで提供される関数で、非同期ではなく同期的に鍵ペアを生成するためのものです。公開鍵と秘密鍵を一度に生成することができ、主にデジタル署名や暗号化などのセキュリティ関連の目的で使用されます。

パラメータの説明

引数 用途
type string 鍵の種類を指定する(’rsa’または’dsa’)
options Object 鍵のサイズやアルゴリズムなどの設定を指定する

戻り値

この関数の戻り値はObject型で、生成された公開鍵と秘密鍵のペアを含んでいます。同期的に処理されるため、関数の実行が完了すると直ちに戻り値が返されます。

使用例

以下は、RSA鍵ペアを生成する例です。


const crypto = require('crypto');
const keyPair = crypto.generateKeyPairSync('rsa', {
  modulusLength: 4096,
  publicKeyEncoding: {
    type: 'spki',
    format: 'pem'
  },
  privateKeyEncoding: {
    type: 'pkcs8',
    format: 'pem'
  }
});
console.log(keyPair);

関連する関数

crypto.generateKeyPairとcrypto.createSignなどの関数が、同様に暗号関連の処理を提供しています。

まとめ

crypto.generateKeyPairSyncは、同期的に鍵ペアを生成するための便利な関数です。セキュリティ関連の処理において、簡単に鍵の生成を行うことができますが、鍵の安全な管理には十分な注意が必要です。