SubtleCrypto: generateKey() メソッド

構文

generateKey(algorithm, extractable, keyUsages)

引数

algorithm

生成する鍵の種類を指定し、アルゴリズム固有の追加パラメータを与えるオブジェクトです。

• RSASSA-PKCS1-v1_5, RSA-PSS, RSA-OAEP: RsaHashedKeyGenParams オブジェクトを渡します。
• ECDSA, ECDH: EcKeyGenParams オブジェクトを渡します。
• HMAC: HmacKeyGenParams オブジェクトを渡します。
• AES-CTR, AES-CBC, AES-GCM, AES-KW: AesKeyGenParams オブジェクトを渡します。

extractable

論理値で、 SubtleCrypto.exportKey() や SubtleCrypto.wrapKey() を用いて鍵を取り出すことができるかを表します。

keyUsages

新しく生成する鍵で何ができるかを表す Array 。 配列の要素として使用可能な値は以下の通りです。

• encrypt: 鍵をメッセージの 暗号化 に用いてよい。
• decrypt: 鍵をメッセージの 復号 に用いてよい。
• sign: 鍵をメッセージの 署名 に用いてよい。
• verify: 鍵を署名の 検証 に用いてよい。
• deriveKey: 鍵を 新しい鍵の導出 に用いてよい。
• deriveBits: 鍵を ビット列の導出 に用いてよい。
• wrapKey: 鍵を 鍵のラップ に用いてよい。
• unwrapKey: 鍵を ラップされた鍵の取り出し に用いてよい。

返値

CryptoKey （対称鍵アルゴリズムの場合）または CryptoKeyPair （公開鍵アルゴリズムの場合）で解決される Promise を返します。

例外

以下の例外が発生した時、プロミスは拒否されます。

SyntaxError DOMException

結果が、種類が secret または private である CryptoKey であるが、 keyUsages が空である時発生します。

SyntaxError DOMException

結果が CryptoKeyPair であり、 その privateKey.usages 属性が空である時発生します。

例

RSA 鍵ペアの生成

このコードは、RSA-OAEP の暗号化用鍵ペアを生成します。 GitHub でコード全体を見る

let keyPair = await window.crypto.subtle.generateKey(
  {
    name: "RSA-OAEP",
    modulusLength: 4096,
    publicExponent: new Uint8Array([1, 0, 1]),
    hash: "SHA-256",
  },
  true,
  ["encrypt", "decrypt"],
);

楕円曲線鍵ペアの生成

このコードは、ECDSA の署名用鍵ペアを生成します。 GitHub でコード全体を見る

let keyPair = await window.crypto.subtle.generateKey(
  {
    name: "ECDSA",
    namedCurve: "P-384",
  },
  true,
  ["sign", "verify"],
);

HMAC 鍵の生成

このコードは、HMAC の署名用鍵を生成します。 GitHub でコード全体を見る

let key = await window.crypto.subtle.generateKey(
  {
    name: "HMAC",
    hash: { name: "SHA-512" },
  },
  true,
  ["sign", "verify"],
);

AES 鍵の生成

このコードは、AES-GCM の暗号化用鍵を生成します。 GitHub でコード全体を見る

let key = await window.crypto.subtle.generateKey(
  {
    name: "AES-GCM",
    length: 256,
  },
  true,
  ["encrypt", "decrypt"],
);

仕様書

ブラウザーの互換性

関連情報

• Cryptographic key length recommendations
• NIST Transitioning the Use of Cryptographic Algorithms and Key Lengths
• 暗号鍵設定ガイダンス～暗号鍵の鍵長選択方法と運用方法～：IPA 独立行政法人 情報処理推進機構