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

BCryptFinalizeKeyPair

関数
生成したCNGキーペアを確定して使用可能にする。
DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

NTSTATUS BCryptFinalizeKeyPair(
    BCRYPT_KEY_HANDLE hKey,
    DWORD dwFlags
);

パラメーター

名前方向説明
hKeyBCRYPT_KEY_HANDLEinout完成させる鍵のハンドル。このハンドルは BCryptGenerateKeyPair 関数を呼び出すことで取得します。
dwFlagsDWORDinこの関数の動作を変更するフラグのセット。現在定義されているフラグはないため、このパラメーターはゼロにする必要があります。

戻り値の型: NTSTATUS

公式ドキュメント

公開鍵/秘密鍵のペアを完成させます。

戻り値

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

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

戻り値 説明
STATUS_SUCCESS
関数は成功しました。
STATUS_INVALID_HANDLE
hKey パラメーターの鍵ハンドルが無効です。
STATUS_INVALID_PARAMETER
1 つ以上のパラメーターが無効です。
STATUS_NOT_SUPPORTED
指定されたプロバイダーは非対称鍵による暗号化をサポートしていません。

解説(Remarks)

サポートされているアルゴリズムプロバイダーを使用する場合、BCryptFinalizeKeyPair はユーザーモードまたはカーネルモードのいずれからでも呼び出すことができます。カーネルモードの呼び出し元は、PASSIVE_LEVEL IRQL または DISPATCH_LEVEL IRQL のいずれかで実行できます。現在の IRQL レベルが DISPATCH_LEVEL である場合、hKey パラメーターで指定されるハンドルは、BCRYPT_PROV_DISPATCH フラグを指定して開かれたプロバイダーが返すアルゴリズムハンドルから派生したものである必要があります。

この関数をカーネルモードで呼び出すには、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 BCryptFinalizeKeyPair(
    BCRYPT_KEY_HANDLE hKey,
    DWORD dwFlags
);
[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptFinalizeKeyPair(
    IntPtr hKey,   // BCRYPT_KEY_HANDLE in/out
    uint dwFlags   // DWORD
);
<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptFinalizeKeyPair(
    hKey As IntPtr,   ' BCRYPT_KEY_HANDLE in/out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hKey : BCRYPT_KEY_HANDLE in/out
' dwFlags : DWORD
Declare PtrSafe Function BCryptFinalizeKeyPair Lib "bcrypt" ( _
    ByVal hKey As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BCryptFinalizeKeyPair = ctypes.windll.bcrypt.BCryptFinalizeKeyPair
BCryptFinalizeKeyPair.restype = ctypes.c_int
BCryptFinalizeKeyPair.argtypes = [
    wintypes.HANDLE,  # hKey : BCRYPT_KEY_HANDLE in/out
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
	procBCryptFinalizeKeyPair = bcrypt.NewProc("BCryptFinalizeKeyPair")
)

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

extern "bcrypt" fn BCryptFinalizeKeyPair(
    hKey: ?*anyopaque, // BCRYPT_KEY_HANDLE in/out
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc BCryptFinalizeKeyPair(
    hKey: pointer,  # BCRYPT_KEY_HANDLE in/out
    dwFlags: uint32  # DWORD
): int32 {.importc: "BCryptFinalizeKeyPair", stdcall, dynlib: "bcrypt.dll".}
pragma(lib, "bcrypt");
extern(Windows)
int BCryptFinalizeKeyPair(
    void* hKey,   // BCRYPT_KEY_HANDLE in/out
    uint dwFlags   // DWORD
);
ccall((:BCryptFinalizeKeyPair, "bcrypt.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32),
      hKey, dwFlags)
# hKey : BCRYPT_KEY_HANDLE in/out -> Ptr{Cvoid}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t BCryptFinalizeKeyPair(
    void* hKey,
    uint32_t dwFlags);
]]
local bcrypt = ffi.load("bcrypt")
-- bcrypt.BCryptFinalizeKeyPair(hKey, dwFlags)
-- hKey : BCRYPT_KEY_HANDLE in/out
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('bcrypt.dll');
const BCryptFinalizeKeyPair = lib.func('__stdcall', 'BCryptFinalizeKeyPair', 'int32_t', ['void *', 'uint32_t']);
// BCryptFinalizeKeyPair(hKey, dwFlags)
// hKey : BCRYPT_KEY_HANDLE in/out -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("bcrypt.dll", {
  BCryptFinalizeKeyPair: { parameters: ["pointer", "u32"], result: "i32" },
});
// lib.symbols.BCryptFinalizeKeyPair(hKey, dwFlags)
// hKey : BCRYPT_KEY_HANDLE in/out -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BCryptFinalizeKeyPair(
    void* hKey,
    uint32_t dwFlags);
C, "bcrypt.dll");
// $ffi->BCryptFinalizeKeyPair(hKey, dwFlags);
// hKey : BCRYPT_KEY_HANDLE in/out
// 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 BCryptFinalizeKeyPair(
        Pointer hKey,   // BCRYPT_KEY_HANDLE in/out
        int dwFlags   // DWORD
    );
}
@[Link("bcrypt")]
lib Libbcrypt
  fun BCryptFinalizeKeyPair = BCryptFinalizeKeyPair(
    hKey : Void*,   # BCRYPT_KEY_HANDLE in/out
    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 BCryptFinalizeKeyPairNative = Int32 Function(Pointer<Void>, Uint32);
typedef BCryptFinalizeKeyPairDart = int Function(Pointer<Void>, int);
final BCryptFinalizeKeyPair = DynamicLibrary.open('bcrypt.dll')
    .lookupFunction<BCryptFinalizeKeyPairNative, BCryptFinalizeKeyPairDart>('BCryptFinalizeKeyPair');
// hKey : BCRYPT_KEY_HANDLE in/out -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BCryptFinalizeKeyPair(
  hKey: THandle;   // BCRYPT_KEY_HANDLE in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'bcrypt.dll' name 'BCryptFinalizeKeyPair';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let bcryptfinalizekeypair =
  foreign "BCryptFinalizeKeyPair"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* hKey : BCRYPT_KEY_HANDLE in/out -> (ptr void) *)
(* 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 ("BCryptFinalizeKeyPair" bcrypt-finalize-key-pair :convention :stdcall) :int32
  (h-key :pointer)   ; BCRYPT_KEY_HANDLE in/out
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BCryptFinalizeKeyPair = Win32::API::More->new('bcrypt',
    'int BCryptFinalizeKeyPair(HANDLE hKey, DWORD dwFlags)');
# my $ret = $BCryptFinalizeKeyPair->Call($hKey, $dwFlags);
# hKey : BCRYPT_KEY_HANDLE in/out -> HANDLE
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目