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

BCryptGetProperty

関数
CNGオブジェクトの指定プロパティ値を取得する。
DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

NTSTATUS BCryptGetProperty(
    BCRYPT_HANDLE hObject,
    LPCWSTR pszProperty,
    BYTE* pbOutput,   // optional
    DWORD cbOutput,
    DWORD* pcbResult,
    DWORD dwFlags
);

パラメーター

名前方向説明
hObjectBCRYPT_HANDLEinプロパティ値を取得する対象の CNG オブジェクトを表すハンドル。
pszPropertyLPCWSTRin取得するプロパティの名前を含む、null 終端の Unicode 文字列へのポインター。事前定義された Cryptography Primitive Property Identifiers のいずれか、またはカスタムのプロパティ識別子を指定できます。
pbOutputBYTE*outoptionalプロパティ値を受け取るバッファーのアドレス。cbOutput パラメーターにはこのバッファーのサイズを指定します。
cbOutputDWORDinpbOutput バッファーのサイズ(バイト単位)。
pcbResultDWORD*outpbOutput バッファーにコピーされたバイト数を受け取る ULONG 変数へのポインター。pbOutput パラメーターが NULL の場合、この関数はこのパラメーターが指す場所に必要なサイズ(バイト単位)を格納します。
dwFlagsDWORDinこの関数の動作を変更するフラグのセット。この関数に対して定義されているフラグはありません。

戻り値の型: NTSTATUS

公式ドキュメント

CNG オブジェクトの名前付きプロパティの値を取得します。

戻り値

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

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

戻り値 説明
STATUS_SUCCESS 関数は成功しました。
STATUS_BUFFER_TOO_SMALL cbOutput パラメーターで指定したバッファーサイズが、プロパティ値を保持するのに十分な大きさではありません。
STATUS_INVALID_HANDLE hObject パラメーターのハンドルが有効ではありません。
STATUS_INVALID_PARAMETER 1 つ以上のパラメーターが有効ではありません。
STATUS_NOT_SUPPORTED pszProperty パラメーターで指定したプロパティはサポートされていません。

解説(Remarks)

プロパティに必要なサイズを取得するには、pbOutput パラメーターに NULL を渡します。この関数は、必要なサイズ(バイト単位)を pcbResult パラメーターが指す値に格納します。

サポートされているアルゴリズムプロバイダーを使用する場合、BCryptGetProperty はユーザーモードまたはカーネルモードのいずれからも呼び出すことができます。カーネルモードの呼び出し元は、PASSIVE_LEVEL IRQL または DISPATCH_LEVEL IRQL のいずれかで実行できます。現在の IRQL レベルが DISPATCH_LEVEL の場合、BCryptGetProperty 関数に渡すすべてのポインターは、ページング不可(またはロックされた)メモリを参照している必要があります。hObject パラメーターで指定したオブジェクトがハンドルである場合、それは 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 BCryptGetProperty(
    BCRYPT_HANDLE hObject,
    LPCWSTR pszProperty,
    BYTE* pbOutput,   // optional
    DWORD cbOutput,
    DWORD* pcbResult,
    DWORD dwFlags
);
[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptGetProperty(
    IntPtr hObject,   // BCRYPT_HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string pszProperty,   // LPCWSTR
    IntPtr pbOutput,   // BYTE* optional, out
    uint cbOutput,   // DWORD
    out uint pcbResult,   // DWORD* out
    uint dwFlags   // DWORD
);
<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptGetProperty(
    hObject As IntPtr,   ' BCRYPT_HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> pszProperty As String,   ' LPCWSTR
    pbOutput As IntPtr,   ' BYTE* optional, out
    cbOutput As UInteger,   ' DWORD
    <Out> ByRef pcbResult As UInteger,   ' DWORD* out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hObject : BCRYPT_HANDLE
' pszProperty : LPCWSTR
' pbOutput : BYTE* optional, out
' cbOutput : DWORD
' pcbResult : DWORD* out
' dwFlags : DWORD
Declare PtrSafe Function BCryptGetProperty Lib "bcrypt" ( _
    ByVal hObject As LongPtr, _
    ByVal pszProperty As LongPtr, _
    ByVal pbOutput As LongPtr, _
    ByVal cbOutput As Long, _
    ByRef pcbResult 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

BCryptGetProperty = ctypes.windll.bcrypt.BCryptGetProperty
BCryptGetProperty.restype = ctypes.c_int
BCryptGetProperty.argtypes = [
    wintypes.HANDLE,  # hObject : BCRYPT_HANDLE
    wintypes.LPCWSTR,  # pszProperty : LPCWSTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbOutput : BYTE* optional, out
    wintypes.DWORD,  # cbOutput : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbResult : DWORD* out
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
	procBCryptGetProperty = bcrypt.NewProc("BCryptGetProperty")
)

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

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

foreign import stdcall safe "BCryptGetProperty"
  c_BCryptGetProperty :: Ptr () -> CWString -> Ptr Word8 -> Word32 -> Ptr Word32 -> Word32 -> IO Int32
-- hObject : BCRYPT_HANDLE -> Ptr ()
-- pszProperty : LPCWSTR -> CWString
-- pbOutput : BYTE* optional, out -> Ptr Word8
-- cbOutput : DWORD -> Word32
-- pcbResult : DWORD* out -> Ptr Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let bcryptgetproperty =
  foreign "BCryptGetProperty"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* hObject : BCRYPT_HANDLE -> (ptr void) *)
(* pszProperty : LPCWSTR -> (ptr uint16_t) *)
(* pbOutput : BYTE* optional, out -> (ptr uint8_t) *)
(* cbOutput : DWORD -> uint32_t *)
(* pcbResult : DWORD* out -> (ptr 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 ("BCryptGetProperty" bcrypt-get-property :convention :stdcall) :int32
  (h-object :pointer)   ; BCRYPT_HANDLE
  (psz-property (:string :encoding :utf-16le))   ; LPCWSTR
  (pb-output :pointer)   ; BYTE* optional, out
  (cb-output :uint32)   ; DWORD
  (pcb-result :pointer)   ; DWORD* out
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BCryptGetProperty = Win32::API::More->new('bcrypt',
    'int BCryptGetProperty(HANDLE hObject, LPCWSTR pszProperty, LPVOID pbOutput, DWORD cbOutput, LPVOID pcbResult, DWORD dwFlags)');
# my $ret = $BCryptGetProperty->Call($hObject, $pszProperty, $pbOutput, $cbOutput, $pcbResult, $dwFlags);
# hObject : BCRYPT_HANDLE -> HANDLE
# pszProperty : LPCWSTR -> LPCWSTR
# pbOutput : BYTE* optional, out -> LPVOID
# cbOutput : DWORD -> DWORD
# pcbResult : DWORD* out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。