【Node.js24.x】Object::generateKeyPairSync()メソッドの使い方

generateKeyPairSyncメソッドは、公開鍵と秘密鍵のペアを同期的に生成するメソッドです。Node.jsのcryptoモジュールに属し、セキュアな通信やデータ保護機能に貢献します。

このメソッドは、鍵生成アルゴリズム、鍵の長さ、エンコーディング形式などのオプションを指定して呼び出し、公開鍵と秘密鍵を含むオブジェクトを返します。生成される鍵ペアは、データの暗号化・復号やデジタル署名に利用され、秘密鍵の厳重な管理が不可欠です。

メソッド名の「Sync」が示す通り、この操作は同期的に実行され、鍵生成が完了するまでプログラムの実行をブロックします。そのため、アプリケーションの初期設定など、処理完了を待つ必要がある場面で特に適しています。

セキュリティが求められるシステム開発において、認証、データ暗号化、セキュアな通信プロトコル構築などに貢献する重要な機能です。システムエンジニアが安全なアプリケーションを設計・実装する上で、本メソッドは欠かせない要素の一つです。

Copy
1const crypto = require('crypto');
2
3const { publicKey, privateKey } = crypto.generateKeyPairSync('rsa', {
4  modulusLength: 2048,
5  publicKeyEncoding: {
6    type: 'spki',
7    format: 'pem'
8  },
9  privateKeyEncoding: {
10    type: 'pkcs8',
11    format: 'pem'
12  }
13});

type, options

• type: string: 生成するキーペアのタイプを指定します。例: 'rsa', 'ec', 'dsa'
• options: object: キーペア生成に関する追加オプションを指定します。

{ publicKey: crypto.KeyObject | Buffer | string; privateKey: crypto.KeyObject | Buffer | string; }

このメソッドは、指定されたアルゴリズムで公開鍵と秘密鍵のペアを同期的に生成し、そのペアを格納したオブジェクトを返します。返されるオブジェクトは、publicKey（公開鍵）とprivateKey（秘密鍵）という2つのプロパティを持ち、それぞれの値はcrypto.KeyObject、Buffer、またはstringのいずれかの型です。