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_LEVEL IRQL または IRQL DISPATCH_LEVELで実行できます。 現在の 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 アプリ]
対象プラットフォーム Windows
ヘッダー bcrypt.h
Library Bcrypt.lib
[DLL] Bcrypt.dll

こちらもご覧ください

BCryptDestroyKey