BCryptGenerateKeyPair 関数 (bcrypt.h)

BCryptGenerateKeyPair 関数は、空の公開キーと秘密キーのペアを作成します。 この関数を使用してキーを作成した後は、BCryptSetProperty 関数を使用してそのプロパティを設定できます。ただし、BCryptFinalizeKeyPair 関数が呼び出されるまで、キーを使用することはできません。

構文

NTSTATUS BCryptGenerateKeyPair(
  [in, out] BCRYPT_ALG_HANDLE hAlgorithm,
  [out]     BCRYPT_KEY_HANDLE *phKey,
  [in]      ULONG             dwLength,
  [in]      ULONG             dwFlags
);

パラメーター

[in, out] hAlgorithm

署名、非対称暗号化、またはキーアグリーメントをサポートするアルゴリズム プロバイダーのハンドル。 このハンドルは、BCryptOpenAlgorithmProvider 関数を使用して作成されている必要があります。

[out] phKey

キーのハンドルを受け取る BCRYPT_KEY_HANDLE へのポインター。 このハンドルは、BCryptEncryptなど、キーを必要とする後続の関数で使用されます。 このハンドルは、BCryptDestroyKey 関数に渡すことによって不要になった場合に解放する必要があります。

[in] dwLength

キーの長さ (ビット単位)。 アルゴリズム プロバイダーには、標準の非対称アルゴリズムごとに異なるキー サイズ制限があります。

アルゴリズム識別子 意味
BCRYPT_DH_ALGORITHM
キー サイズは、512 ビット以上 4096 ビット以下で、64 の倍数である必要があります。
BCRYPT_DSA_ALGORITHM
Windows 8 より前のキー サイズは、512 ビット以上 1024 ビット以下で、64 の倍数である必要があります。

Windows 8 以降では、キー サイズは 512 ビット以上、3072 ビット以下で、64 の倍数である必要があります。 1024 ビット以下のキー サイズの処理は、FIPS 186-2 に準拠します。 1024 より大きく、3072 以下のキー サイズの処理は、FIPS 186-3 に準拠します。

BCRYPT_ECDH_P256_ALGORITHM
キー サイズは 256 ビットである必要があります。
BCRYPT_ECDH_P384_ALGORITHM
キー サイズは 384 ビットである必要があります。
BCRYPT_ECDH_P521_ALGORITHM
キー サイズは 521 ビットである必要があります。
BCRYPT_ECDSA_P256_ALGORITHM
キー サイズは 256 ビットである必要があります。
BCRYPT_ECDSA_P384_ALGORITHM
キー サイズは 384 ビットである必要があります。
BCRYPT_ECDSA_P521_ALGORITHM
キー サイズは 521 ビットである必要があります。
BCRYPT_RSA_ALGORITHM
キー サイズは 512 ビット以上、16384 ビット以下で、64 の倍数である必要があります。

[in] dwFlags

この関数の動作を変更するフラグのセット。 フラグは現在定義されていないため、このパラメーターは 0 にする必要があります。

戻り値

関数の成功または失敗を示す状態コードを返します。

可能な戻りコードには、以下が含まれますが、これらに限定されません。

リターン コード 形容
STATUS_SUCCESS
関数が成功しました。
STATUS_INVALID_HANDLE
hAlgorithm パラメーターのアルゴリズム ハンドルが無効です。
STATUS_INVALID_PARAMETER
1 つ以上のパラメーターが無効です。
STATUS_NOT_SUPPORTED
指定されたプロバイダーは、非対称キー暗号化をサポートしていません。

備考

プロバイダーがサポートするプロセッサ モードに応じて、BCryptGenerateKeyPair は、ユーザー モードまたはカーネル モードから呼び出すことができます。 カーネル モードの呼び出し元は、PASSIVE_LEVELIRQL または DISPATCH_LEVEL IRQL で実行できます。 現在の IRQL レベルが DISPATCH_LEVELされている場合、hAlgorithm パラメーターで指定されたハンドルは、BCRYPT_PROV_DISPATCH フラグを使用して開かれている必要があります。また、BCryptGenerateKeyPair 関数に渡されるすべてのポインターは、非ページ (またはロックされた) メモリを参照する必要があります。

カーネル モードでこの関数を呼び出すには、ドライバー開発キット (DDK) の一部である Cng.lib を使用します。 Windows Server 2008 および Windows Vista: カーネル モードでこの関数を呼び出すには、Ksecdd.lib を使用します。

必要条件

要件 価値
サポートされる最小クライアント Windows Vista [デスクトップ アプリ |UWP アプリ]
サポートされる最小サーバー Windows Server 2008 [デスクトップ アプリ |UWP アプリ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー bcrypt.h
ライブラリ Bcrypt.lib
DLL Bcrypt.dll

関連項目

BCryptDestroyKey