Win32 API 日本語リファレンス
ホームSecurity.Cryptography › BCryptGenerateKeyPair

BCryptGenerateKeyPair

関数
指定アルゴリズムの公開鍵・秘密鍵ペアを生成する。
DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// bcrypt.dll
#include <windows.h>

NTSTATUS BCryptGenerateKeyPair(
    BCRYPT_ALG_HANDLE hAlgorithm,
    BCRYPT_KEY_HANDLE* phKey,
    DWORD dwLength,
    DWORD dwFlags
);

パラメーター

名前方向説明
hAlgorithmBCRYPT_ALG_HANDLEinout非対称鍵ペアを使用するアルゴリズムプロバイダーのハンドル。アルゴリズムの種類の例としては、署名 (Signing)、非対称暗号化 (Asymmetric encryption)、鍵共有 (Key agreement)、鍵カプセル化メカニズム (Key encapsulation mechanism) などがあります。このハンドルは BCryptOpenAlgorithmProvider 関数を呼び出して取得します。または CNG Algorithm Pseudo-handle の場合もあります。
phKeyBCRYPT_KEY_HANDLE*out鍵のハンドルを受け取る BCRYPT_KEY_HANDLE へのポインター。このハンドルは、BCryptEncrypt のように鍵を必要とする後続の関数で使用されます。このハンドルは不要になったら、BCryptDestroyKey 関数に渡して解放する必要があります。
dwLengthDWORDin

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

アルゴリズム識別子 意味
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_MLDSA_ALGORITHM 鍵サイズは 0 でなければなりません。

ML-DSA では、BCryptSetPropertyBCRYPT_PARAMETER_SET_NAME とともに使用して、鍵のパラメーターセットを指定します。これは BCryptFinalizeKeyPair で鍵を確定する前に行う必要があります。

Windows Insiders (build 27843): ML-DSA のサポートが開始されます。
BCRYPT_MLKEM_ALGORITHM 鍵サイズは 0 でなければなりません。

ML-KEM では、BCryptSetPropertyBCRYPT_PARAMETER_SET_NAME とともに使用して、鍵のパラメーターセットを指定します。これは BCryptFinalizeKeyPair で鍵を確定する前に行う必要があります。

Windows Insiders (build 27843): ML-KEM のサポートが開始されます。
BCRYPT_RSA_ALGORITHM 鍵サイズは 512 ビット以上 16384 ビット以下で、64 の倍数でなければなりません。
dwFlagsDWORDin

この関数の動作を変更するフラグのセット。指定できるフラグのセットは、hAlgorithm パラメーターで指定されたアルゴリズムに依存します。

ゼロ、または次の値を指定できます。

意味
BCRYPT_NO_KEY_VALIDATION 鍵生成時に適用される FIPS 自己テストをオプトアウトします。

注: 現在は ML-KEM でのみサポートされています。

Windows Insiders (build 27843): ML-KEM のサポートが開始されます。

戻り値の型: NTSTATUS

公式ドキュメント

空の公開鍵/秘密鍵ペアを作成します。

戻り値

関数の成功または失敗を示すステータスコードを返します。

返される可能性があるコードには、次のものが含まれますが、これらに限定されません。

戻り値 説明
STATUS_SUCCESS 関数は成功しました。
STATUS_INVALID_HANDLE hAlgorithm パラメーターのアルゴリズムハンドルが無効です。
STATUS_INVALID_PARAMETER 1 つ以上のパラメーターが無効です。
STATUS_NOT_SUPPORTED 指定されたアルゴリズムは非対称鍵ペアを使用しません。

解説(Remarks)

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

呼び出し元は、鍵が使用されなくなったら BCryptDestroyKeyphKey を解放する必要があります。

この関数をカーネルモードで呼び出すには、Driver Development Kit (DDK) の一部である Cng.lib を使用します。Windows Server 2008 および Windows Vista: この関数をカーネルモードで呼び出すには、Ksecdd.lib を使用します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// bcrypt.dll
#include <windows.h>

NTSTATUS BCryptGenerateKeyPair(
    BCRYPT_ALG_HANDLE hAlgorithm,
    BCRYPT_KEY_HANDLE* phKey,
    DWORD dwLength,
    DWORD dwFlags
);
[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptGenerateKeyPair(
    IntPtr hAlgorithm,   // BCRYPT_ALG_HANDLE in/out
    IntPtr phKey,   // BCRYPT_KEY_HANDLE* out
    uint dwLength,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptGenerateKeyPair(
    hAlgorithm As IntPtr,   ' BCRYPT_ALG_HANDLE in/out
    phKey As IntPtr,   ' BCRYPT_KEY_HANDLE* out
    dwLength As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hAlgorithm : BCRYPT_ALG_HANDLE in/out
' phKey : BCRYPT_KEY_HANDLE* out
' dwLength : DWORD
' dwFlags : DWORD
Declare PtrSafe Function BCryptGenerateKeyPair Lib "bcrypt" ( _
    ByVal hAlgorithm As LongPtr, _
    ByVal phKey As LongPtr, _
    ByVal dwLength As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BCryptGenerateKeyPair = ctypes.windll.bcrypt.BCryptGenerateKeyPair
BCryptGenerateKeyPair.restype = ctypes.c_int
BCryptGenerateKeyPair.argtypes = [
    wintypes.HANDLE,  # hAlgorithm : BCRYPT_ALG_HANDLE in/out
    ctypes.c_void_p,  # phKey : BCRYPT_KEY_HANDLE* out
    wintypes.DWORD,  # dwLength : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('bcrypt.dll')
BCryptGenerateKeyPair = Fiddle::Function.new(
  lib['BCryptGenerateKeyPair'],
  [
    Fiddle::TYPE_VOIDP,  # hAlgorithm : BCRYPT_ALG_HANDLE in/out
    Fiddle::TYPE_VOIDP,  # phKey : BCRYPT_KEY_HANDLE* out
    -Fiddle::TYPE_INT,  # dwLength : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "bcrypt")]
extern "system" {
    fn BCryptGenerateKeyPair(
        hAlgorithm: *mut core::ffi::c_void,  // BCRYPT_ALG_HANDLE in/out
        phKey: *mut *mut core::ffi::c_void,  // BCRYPT_KEY_HANDLE* out
        dwLength: u32,  // DWORD
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptGenerateKeyPair(IntPtr hAlgorithm, IntPtr phKey, uint dwLength, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptGenerateKeyPair' -Namespace Win32 -PassThru
# $api::BCryptGenerateKeyPair(hAlgorithm, phKey, dwLength, dwFlags)
#uselib "bcrypt.dll"
#func global BCryptGenerateKeyPair "BCryptGenerateKeyPair" sptr, sptr, sptr, sptr
; BCryptGenerateKeyPair hAlgorithm, phKey, dwLength, dwFlags   ; 戻り値は stat
; hAlgorithm : BCRYPT_ALG_HANDLE in/out -> "sptr"
; phKey : BCRYPT_KEY_HANDLE* out -> "sptr"
; dwLength : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "bcrypt.dll"
#cfunc global BCryptGenerateKeyPair "BCryptGenerateKeyPair" sptr, sptr, int, int
; res = BCryptGenerateKeyPair(hAlgorithm, phKey, dwLength, dwFlags)
; hAlgorithm : BCRYPT_ALG_HANDLE in/out -> "sptr"
; phKey : BCRYPT_KEY_HANDLE* out -> "sptr"
; dwLength : DWORD -> "int"
; dwFlags : DWORD -> "int"
; NTSTATUS BCryptGenerateKeyPair(BCRYPT_ALG_HANDLE hAlgorithm, BCRYPT_KEY_HANDLE* phKey, DWORD dwLength, DWORD dwFlags)
#uselib "bcrypt.dll"
#cfunc global BCryptGenerateKeyPair "BCryptGenerateKeyPair" intptr, intptr, int, int
; res = BCryptGenerateKeyPair(hAlgorithm, phKey, dwLength, dwFlags)
; hAlgorithm : BCRYPT_ALG_HANDLE in/out -> "intptr"
; phKey : BCRYPT_KEY_HANDLE* out -> "intptr"
; dwLength : DWORD -> "int"
; dwFlags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
	procBCryptGenerateKeyPair = bcrypt.NewProc("BCryptGenerateKeyPair")
)

// hAlgorithm (BCRYPT_ALG_HANDLE in/out), phKey (BCRYPT_KEY_HANDLE* out), dwLength (DWORD), dwFlags (DWORD)
r1, _, err := procBCryptGenerateKeyPair.Call(
	uintptr(hAlgorithm),
	uintptr(phKey),
	uintptr(dwLength),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // NTSTATUS
function BCryptGenerateKeyPair(
  hAlgorithm: THandle;   // BCRYPT_ALG_HANDLE in/out
  phKey: Pointer;   // BCRYPT_KEY_HANDLE* out
  dwLength: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'bcrypt.dll' name 'BCryptGenerateKeyPair';
result := DllCall("bcrypt\BCryptGenerateKeyPair"
    , "Ptr", hAlgorithm   ; BCRYPT_ALG_HANDLE in/out
    , "Ptr", phKey   ; BCRYPT_KEY_HANDLE* out
    , "UInt", dwLength   ; DWORD
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: NTSTATUS
●BCryptGenerateKeyPair(hAlgorithm, phKey, dwLength, dwFlags) = DLL("bcrypt.dll", "int BCryptGenerateKeyPair(void*, void*, dword, dword)")
# 呼び出し: BCryptGenerateKeyPair(hAlgorithm, phKey, dwLength, dwFlags)
# hAlgorithm : BCRYPT_ALG_HANDLE in/out -> "void*"
# phKey : BCRYPT_KEY_HANDLE* out -> "void*"
# dwLength : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "bcrypt" fn BCryptGenerateKeyPair(
    hAlgorithm: ?*anyopaque, // BCRYPT_ALG_HANDLE in/out
    phKey: ?*anyopaque, // BCRYPT_KEY_HANDLE* out
    dwLength: u32, // DWORD
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc BCryptGenerateKeyPair(
    hAlgorithm: pointer,  # BCRYPT_ALG_HANDLE in/out
    phKey: pointer,  # BCRYPT_KEY_HANDLE* out
    dwLength: uint32,  # DWORD
    dwFlags: uint32  # DWORD
): int32 {.importc: "BCryptGenerateKeyPair", stdcall, dynlib: "bcrypt.dll".}
pragma(lib, "bcrypt");
extern(Windows)
int BCryptGenerateKeyPair(
    void* hAlgorithm,   // BCRYPT_ALG_HANDLE in/out
    void* phKey,   // BCRYPT_KEY_HANDLE* out
    uint dwLength,   // DWORD
    uint dwFlags   // DWORD
);
ccall((:BCryptGenerateKeyPair, "bcrypt.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, UInt32, UInt32),
      hAlgorithm, phKey, dwLength, dwFlags)
# hAlgorithm : BCRYPT_ALG_HANDLE in/out -> Ptr{Cvoid}
# phKey : BCRYPT_KEY_HANDLE* out -> Ptr{Cvoid}
# dwLength : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t BCryptGenerateKeyPair(
    void* hAlgorithm,
    void* phKey,
    uint32_t dwLength,
    uint32_t dwFlags);
]]
local bcrypt = ffi.load("bcrypt")
-- bcrypt.BCryptGenerateKeyPair(hAlgorithm, phKey, dwLength, dwFlags)
-- hAlgorithm : BCRYPT_ALG_HANDLE in/out
-- phKey : BCRYPT_KEY_HANDLE* out
-- dwLength : DWORD
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('bcrypt.dll');
const BCryptGenerateKeyPair = lib.func('__stdcall', 'BCryptGenerateKeyPair', 'int32_t', ['void *', 'void *', 'uint32_t', 'uint32_t']);
// BCryptGenerateKeyPair(hAlgorithm, phKey, dwLength, dwFlags)
// hAlgorithm : BCRYPT_ALG_HANDLE in/out -> 'void *'
// phKey : BCRYPT_KEY_HANDLE* out -> 'void *'
// dwLength : DWORD -> 'uint32_t'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("bcrypt.dll", {
  BCryptGenerateKeyPair: { parameters: ["pointer", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.BCryptGenerateKeyPair(hAlgorithm, phKey, dwLength, dwFlags)
// hAlgorithm : BCRYPT_ALG_HANDLE in/out -> "pointer"
// phKey : BCRYPT_KEY_HANDLE* out -> "pointer"
// dwLength : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BCryptGenerateKeyPair(
    void* hAlgorithm,
    void* phKey,
    uint32_t dwLength,
    uint32_t dwFlags);
C, "bcrypt.dll");
// $ffi->BCryptGenerateKeyPair(hAlgorithm, phKey, dwLength, dwFlags);
// hAlgorithm : BCRYPT_ALG_HANDLE in/out
// phKey : BCRYPT_KEY_HANDLE* out
// dwLength : DWORD
// dwFlags : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Bcrypt extends StdCallLibrary {
    Bcrypt INSTANCE = Native.load("bcrypt", Bcrypt.class);
    int BCryptGenerateKeyPair(
        Pointer hAlgorithm,   // BCRYPT_ALG_HANDLE in/out
        Pointer phKey,   // BCRYPT_KEY_HANDLE* out
        int dwLength,   // DWORD
        int dwFlags   // DWORD
    );
}
@[Link("bcrypt")]
lib Libbcrypt
  fun BCryptGenerateKeyPair = BCryptGenerateKeyPair(
    hAlgorithm : Void*,   # BCRYPT_ALG_HANDLE in/out
    phKey : Void*,   # BCRYPT_KEY_HANDLE* out
    dwLength : UInt32,   # DWORD
    dwFlags : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef BCryptGenerateKeyPairNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Uint32);
typedef BCryptGenerateKeyPairDart = int Function(Pointer<Void>, Pointer<Void>, int, int);
final BCryptGenerateKeyPair = DynamicLibrary.open('bcrypt.dll')
    .lookupFunction<BCryptGenerateKeyPairNative, BCryptGenerateKeyPairDart>('BCryptGenerateKeyPair');
// hAlgorithm : BCRYPT_ALG_HANDLE in/out -> Pointer<Void>
// phKey : BCRYPT_KEY_HANDLE* out -> Pointer<Void>
// dwLength : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BCryptGenerateKeyPair(
  hAlgorithm: THandle;   // BCRYPT_ALG_HANDLE in/out
  phKey: Pointer;   // BCRYPT_KEY_HANDLE* out
  dwLength: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'bcrypt.dll' name 'BCryptGenerateKeyPair';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BCryptGenerateKeyPair"
  c_BCryptGenerateKeyPair :: Ptr () -> Ptr () -> Word32 -> Word32 -> IO Int32
-- hAlgorithm : BCRYPT_ALG_HANDLE in/out -> Ptr ()
-- phKey : BCRYPT_KEY_HANDLE* out -> Ptr ()
-- dwLength : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let bcryptgeneratekeypair =
  foreign "BCryptGenerateKeyPair"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hAlgorithm : BCRYPT_ALG_HANDLE in/out -> (ptr void) *)
(* phKey : BCRYPT_KEY_HANDLE* out -> (ptr void) *)
(* dwLength : DWORD -> uint32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library bcrypt (t "bcrypt.dll"))
(cffi:use-foreign-library bcrypt)

(cffi:defcfun ("BCryptGenerateKeyPair" bcrypt-generate-key-pair :convention :stdcall) :int32
  (h-algorithm :pointer)   ; BCRYPT_ALG_HANDLE in/out
  (ph-key :pointer)   ; BCRYPT_KEY_HANDLE* out
  (dw-length :uint32)   ; DWORD
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BCryptGenerateKeyPair = Win32::API::More->new('bcrypt',
    'int BCryptGenerateKeyPair(HANDLE hAlgorithm, HANDLE phKey, DWORD dwLength, DWORD dwFlags)');
# my $ret = $BCryptGenerateKeyPair->Call($hAlgorithm, $phKey, $dwLength, $dwFlags);
# hAlgorithm : BCRYPT_ALG_HANDLE in/out -> HANDLE
# phKey : BCRYPT_KEY_HANDLE* out -> HANDLE
# dwLength : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。