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

BCryptSetProperty

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

シグネチャ

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

NTSTATUS BCryptSetProperty(
    BCRYPT_HANDLE hObject,
    LPCWSTR pszProperty,
    BYTE* pbInput,
    DWORD cbInput,
    DWORD dwFlags
);

パラメーター

名前方向説明
hObjectBCRYPT_HANDLEinoutプロパティ値を設定する対象の CNG オブジェクトを表すハンドル。
pszPropertyLPCWSTRin設定するプロパティの名前を含む、null で終端された Unicode 文字列へのポインター。事前定義された Cryptography Primitive Property Identifiers のいずれか、またはカスタムのプロパティ識別子を指定できます。
pbInputBYTE*in新しいプロパティ値を含むバッファーのアドレス。cbInput パラメーターにはこのバッファーのサイズを指定します。
cbInputDWORDinpbInput バッファーのサイズ (バイト単位)。
dwFlagsDWORDinこの関数の動作を変更するフラグのセット。この関数に対して定義されているフラグはありません。

戻り値の型: NTSTATUS

公式ドキュメント

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

戻り値

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

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

戻り値コード 説明
STATUS_SUCCESS 関数は成功しました。
STATUS_INVALID_HANDLE hObject パラメーターのハンドルが無効です。
STATUS_INVALID_PARAMETER 1 つ以上のパラメーターが無効です。
STATUS_NOT_SUPPORTED pszProperty パラメーターで指定された名前付きプロパティがサポートされていないか、読み取り専用です。

解説(Remarks)

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

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

ML-DSA および ML-KEM のキーを生成する場合、キーをファイナライズする前に、キーハンドルに BCRYPT_PARAMETER_SET_NAME プロパティを設定する必要があります。

プロパティ BCRYPT_CHAINING_MODE の値を設定する場合、pbInput パラメーターは cbInput による境界制限を受けません。呼び出し元は、有効な null で終端された Unicode 文字列が提供されることを保証する必要があります。

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

各言語での呼び出し定義

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

NTSTATUS BCryptSetProperty(
    BCRYPT_HANDLE hObject,
    LPCWSTR pszProperty,
    BYTE* pbInput,
    DWORD cbInput,
    DWORD dwFlags
);
[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptSetProperty(
    IntPtr hObject,   // BCRYPT_HANDLE in/out
    [MarshalAs(UnmanagedType.LPWStr)] string pszProperty,   // LPCWSTR
    IntPtr pbInput,   // BYTE*
    uint cbInput,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptSetProperty(
    hObject As IntPtr,   ' BCRYPT_HANDLE in/out
    <MarshalAs(UnmanagedType.LPWStr)> pszProperty As String,   ' LPCWSTR
    pbInput As IntPtr,   ' BYTE*
    cbInput As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hObject : BCRYPT_HANDLE in/out
' pszProperty : LPCWSTR
' pbInput : BYTE*
' cbInput : DWORD
' dwFlags : DWORD
Declare PtrSafe Function BCryptSetProperty Lib "bcrypt" ( _
    ByVal hObject As LongPtr, _
    ByVal pszProperty As LongPtr, _
    ByVal pbInput As LongPtr, _
    ByVal cbInput 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

BCryptSetProperty = ctypes.windll.bcrypt.BCryptSetProperty
BCryptSetProperty.restype = ctypes.c_int
BCryptSetProperty.argtypes = [
    wintypes.HANDLE,  # hObject : BCRYPT_HANDLE in/out
    wintypes.LPCWSTR,  # pszProperty : LPCWSTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbInput : BYTE*
    wintypes.DWORD,  # cbInput : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
	procBCryptSetProperty = bcrypt.NewProc("BCryptSetProperty")
)

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

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

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

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