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

BCryptGenerateSymmetricKey

関数
秘密値から共通鍵(対称鍵)オブジェクトを生成する。
DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

NTSTATUS BCryptGenerateSymmetricKey(
    BCRYPT_ALG_HANDLE hAlgorithm,
    BCRYPT_KEY_HANDLE* phKey,
    BYTE* pbKeyObject,   // optional
    DWORD cbKeyObject,
    BYTE* pbSecret,
    DWORD cbSecret,
    DWORD dwFlags
);

パラメーター

名前方向
hAlgorithmBCRYPT_ALG_HANDLEinout
phKeyBCRYPT_KEY_HANDLE*out
pbKeyObjectBYTE*outoptional
cbKeyObjectDWORDin
pbSecretBYTE*in
cbSecretDWORDin
dwFlagsDWORDin

戻り値の型: NTSTATUS

各言語での呼び出し定義

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

NTSTATUS BCryptGenerateSymmetricKey(
    BCRYPT_ALG_HANDLE hAlgorithm,
    BCRYPT_KEY_HANDLE* phKey,
    BYTE* pbKeyObject,   // optional
    DWORD cbKeyObject,
    BYTE* pbSecret,
    DWORD cbSecret,
    DWORD dwFlags
);
[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptGenerateSymmetricKey(
    IntPtr hAlgorithm,   // BCRYPT_ALG_HANDLE in/out
    IntPtr phKey,   // BCRYPT_KEY_HANDLE* out
    IntPtr pbKeyObject,   // BYTE* optional, out
    uint cbKeyObject,   // DWORD
    IntPtr pbSecret,   // BYTE*
    uint cbSecret,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptGenerateSymmetricKey(
    hAlgorithm As IntPtr,   ' BCRYPT_ALG_HANDLE in/out
    phKey As IntPtr,   ' BCRYPT_KEY_HANDLE* out
    pbKeyObject As IntPtr,   ' BYTE* optional, out
    cbKeyObject As UInteger,   ' DWORD
    pbSecret As IntPtr,   ' BYTE*
    cbSecret As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hAlgorithm : BCRYPT_ALG_HANDLE in/out
' phKey : BCRYPT_KEY_HANDLE* out
' pbKeyObject : BYTE* optional, out
' cbKeyObject : DWORD
' pbSecret : BYTE*
' cbSecret : DWORD
' dwFlags : DWORD
Declare PtrSafe Function BCryptGenerateSymmetricKey Lib "bcrypt" ( _
    ByVal hAlgorithm As LongPtr, _
    ByVal phKey As LongPtr, _
    ByVal pbKeyObject As LongPtr, _
    ByVal cbKeyObject As Long, _
    ByVal pbSecret As LongPtr, _
    ByVal cbSecret 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

BCryptGenerateSymmetricKey = ctypes.windll.bcrypt.BCryptGenerateSymmetricKey
BCryptGenerateSymmetricKey.restype = ctypes.c_int
BCryptGenerateSymmetricKey.argtypes = [
    wintypes.HANDLE,  # hAlgorithm : BCRYPT_ALG_HANDLE in/out
    ctypes.c_void_p,  # phKey : BCRYPT_KEY_HANDLE* out
    ctypes.POINTER(ctypes.c_ubyte),  # pbKeyObject : BYTE* optional, out
    wintypes.DWORD,  # cbKeyObject : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbSecret : BYTE*
    wintypes.DWORD,  # cbSecret : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
	procBCryptGenerateSymmetricKey = bcrypt.NewProc("BCryptGenerateSymmetricKey")
)

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