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

BCryptDuplicateKey

関数
CNGの鍵オブジェクトを複製する。
DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

NTSTATUS BCryptDuplicateKey(
    BCRYPT_KEY_HANDLE hKey,
    BCRYPT_KEY_HANDLE* phNewKey,
    BYTE* pbKeyObject,   // optional
    DWORD cbKeyObject,
    DWORD dwFlags
);

パラメーター

名前方向説明
hKeyBCRYPT_KEY_HANDLEin複製する鍵のハンドル。これは対称鍵のハンドルである必要があります。
phNewKeyBCRYPT_KEY_HANDLE*out複製された鍵のハンドルを受け取る BCRYPT_KEY_HANDLE 変数へのポインター。このハンドルは、BCryptEncrypt など、鍵を必要とする後続の関数で使用されます。このハンドルが不要になったら、BCryptDestroyKey 関数に渡して解放する必要があります。
pbKeyObjectBYTE*outoptional

複製された鍵オブジェクトを受け取るバッファーへの 省略可能な ポインター。cbKeyObject パラメーターにはこのバッファーのサイズが格納されます。このバッファーに必要なサイズは、BCryptGetProperty 関数を呼び出して BCRYPT_OBJECT_LENGTH プロパティを取得することで得られます。これにより、指定したアルゴリズムの鍵オブジェクトのサイズが得られます。

このメモリは、phNewKey 鍵ハンドルが破棄された後でのみ解放できます。

このパラメーターの値が NULL で、cbKeyObject パラメーターの値が 0 の場合、複製された鍵オブジェクトのメモリはこの関数によって割り当てられ、BCryptDestroyKey によって解放されます。Windows 7: このメモリ管理機能は Windows 7 以降で利用できます。

cbKeyObjectDWORDin

pbKeyObject バッファーのサイズ (バイト単位)。

このパラメーターの値が 0 で、pbKeyObject パラメーターの値が NULL の場合、複製された鍵オブジェクトのメモリはこの関数によって割り当てられ、BCryptDestroyKey によって解放されます。Windows 7: このメモリ管理機能は Windows 7 以降で利用できます。

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

戻り値の型: NTSTATUS

公式ドキュメント

対称鍵の複製を作成します。

戻り値

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

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

戻り値 説明
STATUS_SUCCESS
関数は成功しました。
STATUS_BUFFER_TOO_SMALL
cbKeyObject パラメーターで指定された鍵オブジェクトのサイズが、鍵オブジェクトを保持するのに十分な大きさではありません。
STATUS_INVALID_HANDLE
hKey パラメーターの鍵ハンドルが無効です。複製する鍵が対称鍵でない場合にもこの値が返されます。
STATUS_INVALID_PARAMETER
1 つ以上のパラメーターが無効です。

解説(Remarks)

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

この関数をカーネルモードで呼び出すには、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 BCryptDuplicateKey(
    BCRYPT_KEY_HANDLE hKey,
    BCRYPT_KEY_HANDLE* phNewKey,
    BYTE* pbKeyObject,   // optional
    DWORD cbKeyObject,
    DWORD dwFlags
);
[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptDuplicateKey(
    IntPtr hKey,   // BCRYPT_KEY_HANDLE
    IntPtr phNewKey,   // BCRYPT_KEY_HANDLE* out
    IntPtr pbKeyObject,   // BYTE* optional, out
    uint cbKeyObject,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptDuplicateKey(
    hKey As IntPtr,   ' BCRYPT_KEY_HANDLE
    phNewKey As IntPtr,   ' BCRYPT_KEY_HANDLE* out
    pbKeyObject As IntPtr,   ' BYTE* optional, out
    cbKeyObject As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hKey : BCRYPT_KEY_HANDLE
' phNewKey : BCRYPT_KEY_HANDLE* out
' pbKeyObject : BYTE* optional, out
' cbKeyObject : DWORD
' dwFlags : DWORD
Declare PtrSafe Function BCryptDuplicateKey Lib "bcrypt" ( _
    ByVal hKey As LongPtr, _
    ByVal phNewKey As LongPtr, _
    ByVal pbKeyObject As LongPtr, _
    ByVal cbKeyObject 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

BCryptDuplicateKey = ctypes.windll.bcrypt.BCryptDuplicateKey
BCryptDuplicateKey.restype = ctypes.c_int
BCryptDuplicateKey.argtypes = [
    wintypes.HANDLE,  # hKey : BCRYPT_KEY_HANDLE
    ctypes.c_void_p,  # phNewKey : BCRYPT_KEY_HANDLE* out
    ctypes.POINTER(ctypes.c_ubyte),  # pbKeyObject : BYTE* optional, out
    wintypes.DWORD,  # cbKeyObject : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('bcrypt.dll')
BCryptDuplicateKey = Fiddle::Function.new(
  lib['BCryptDuplicateKey'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : BCRYPT_KEY_HANDLE
    Fiddle::TYPE_VOIDP,  # phNewKey : BCRYPT_KEY_HANDLE* out
    Fiddle::TYPE_VOIDP,  # pbKeyObject : BYTE* optional, out
    -Fiddle::TYPE_INT,  # cbKeyObject : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "bcrypt")]
extern "system" {
    fn BCryptDuplicateKey(
        hKey: *mut core::ffi::c_void,  // BCRYPT_KEY_HANDLE
        phNewKey: *mut *mut core::ffi::c_void,  // BCRYPT_KEY_HANDLE* out
        pbKeyObject: *mut u8,  // BYTE* optional, out
        cbKeyObject: u32,  // DWORD
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptDuplicateKey(IntPtr hKey, IntPtr phNewKey, IntPtr pbKeyObject, uint cbKeyObject, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptDuplicateKey' -Namespace Win32 -PassThru
# $api::BCryptDuplicateKey(hKey, phNewKey, pbKeyObject, cbKeyObject, dwFlags)
#uselib "bcrypt.dll"
#func global BCryptDuplicateKey "BCryptDuplicateKey" sptr, sptr, sptr, sptr, sptr
; BCryptDuplicateKey hKey, phNewKey, varptr(pbKeyObject), cbKeyObject, dwFlags   ; 戻り値は stat
; hKey : BCRYPT_KEY_HANDLE -> "sptr"
; phNewKey : BCRYPT_KEY_HANDLE* out -> "sptr"
; pbKeyObject : BYTE* optional, out -> "sptr"
; cbKeyObject : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "bcrypt.dll"
#cfunc global BCryptDuplicateKey "BCryptDuplicateKey" sptr, sptr, var, int, int
; res = BCryptDuplicateKey(hKey, phNewKey, pbKeyObject, cbKeyObject, dwFlags)
; hKey : BCRYPT_KEY_HANDLE -> "sptr"
; phNewKey : BCRYPT_KEY_HANDLE* out -> "sptr"
; pbKeyObject : BYTE* optional, out -> "var"
; cbKeyObject : DWORD -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; NTSTATUS BCryptDuplicateKey(BCRYPT_KEY_HANDLE hKey, BCRYPT_KEY_HANDLE* phNewKey, BYTE* pbKeyObject, DWORD cbKeyObject, DWORD dwFlags)
#uselib "bcrypt.dll"
#cfunc global BCryptDuplicateKey "BCryptDuplicateKey" intptr, intptr, var, int, int
; res = BCryptDuplicateKey(hKey, phNewKey, pbKeyObject, cbKeyObject, dwFlags)
; hKey : BCRYPT_KEY_HANDLE -> "intptr"
; phNewKey : BCRYPT_KEY_HANDLE* out -> "intptr"
; pbKeyObject : BYTE* optional, out -> "var"
; cbKeyObject : DWORD -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
	procBCryptDuplicateKey = bcrypt.NewProc("BCryptDuplicateKey")
)

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

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

foreign import stdcall safe "BCryptDuplicateKey"
  c_BCryptDuplicateKey :: Ptr () -> Ptr () -> Ptr Word8 -> Word32 -> Word32 -> IO Int32
-- hKey : BCRYPT_KEY_HANDLE -> Ptr ()
-- phNewKey : BCRYPT_KEY_HANDLE* out -> Ptr ()
-- pbKeyObject : BYTE* optional, out -> Ptr Word8
-- cbKeyObject : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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