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

NCryptSetProperty

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

シグネチャ

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

HRESULT NCryptSetProperty(
    NCRYPT_HANDLE hObject,
    LPCWSTR pszProperty,
    BYTE* pbInput,
    DWORD cbInput,
    NCRYPT_FLAGS dwFlags
);

パラメーター

名前方向説明
hObjectNCRYPT_HANDLEinプロパティを設定するキー ストレージ オブジェクトのハンドル。
pszPropertyLPCWSTRin設定するプロパティの名前を含む、null で終わる Unicode 文字列へのポインター。これは定義済みの Key Storage Property Identifiers のいずれか、またはカスタム プロパティ識別子です。
pbInputBYTE*in新しいプロパティ値を含むバッファーのアドレス。cbInput パラメーターにこのバッファーのサイズが含まれます。
cbInputDWORDinpbInput バッファーのサイズ (バイト単位)。
dwFlagsNCRYPT_FLAGSin

関数の動作を変更するフラグ。これはゼロ、または次の値のうち 1 つ以上の組み合わせを指定できます。

意味
NCRYPT_PERSIST_FLAG
プロパティをキー マテリアルとともにキー ストレージに格納します。このフラグは、hObject パラメーターが永続化されたキーのハンドルである場合にのみ使用できます。永続化されるプロパティのデータの最大サイズは NCRYPT_MAX_PROPERTY_DATA バイトです。
NCRYPT_PERSIST_ONLY_FLAG
このプロパティの組み込みの値を上書きせず、キーのユーザー永続化プロパティのみを設定します。永続化されるプロパティのデータの最大サイズは NCRYPT_MAX_PROPERTY_DATA バイトです。このフラグは NCRYPT_SECURITY_DESCR_PROPERTY プロパティとともには使用できません。
NCRYPT_SILENT_FLAG
キー ストレージ プロバイダー (KSP) がユーザー インターフェイスを表示しないように要求します。プロバイダーが動作するために UI を表示する必要がある場合、呼び出しは失敗し、KSP は最後のエラーとして NTE_SILENT_CONTEXT エラー コードを設定します。

NCRYPT_SECURITY_DESCR_PROPERTY プロパティの場合、このパラメーターには、設定するセキュリティ記述子の部分を識別する次の値のいずれかも含める必要があります。

意味
OWNER_SECURITY_INFORMATION
オブジェクトの所有者のセキュリティ識別子 (SID) を設定します。SetSecurityDescriptorOwner 関数を使用して、SECURITY_DESCRIPTOR 構造体に所有者 SID を設定します。
GROUP_SECURITY_INFORMATION
オブジェクトのプライマリ グループの SID を設定します。SetSecurityDescriptorGroup 関数を使用して、SECURITY_DESCRIPTOR 構造体にグループ SID を設定します。
DACL_SECURITY_INFORMATION
随意アクセス制御リスト (DACL) を設定します。SetSecurityDescriptorDacl 関数を使用して、SECURITY_DESCRIPTOR 構造体に DACL を設定します。
SACL_SECURITY_INFORMATION
システム アクセス制御リスト (SACL) を設定します。SetSecurityDescriptorSacl 関数を使用して、SECURITY_DESCRIPTOR 構造体に SACL を設定します。
LABEL_SECURITY_INFORMATION
オブジェクトの SACL に必須ラベル アクセス制御エントリを設定します。SetSecurityDescriptorSacl 関数を使用して、SECURITY_DESCRIPTOR 構造体に SACL を設定します。必須ラベル アクセス制御エントリの詳細については、Windows Integrity Mechanism Design を参照してください。

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

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

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

戻り値 説明
ERROR_SUCCESS
関数は成功しました。
NTE_BAD_FLAGS
dwFlags パラメーターに無効な値が含まれています。
NTE_INVALID_HANDLE
hObject パラメーターが無効です。
NTE_INVALID_PARAMETER
1 つ以上のパラメーターが無効です。
NTE_NO_MEMORY
メモリ割り当ての失敗が発生しました。
NTE_NOT_SUPPORTED
指定されたプロパティはこのオブジェクトではサポートされていません。

解説(Remarks)

サービスは、その StartService 関数からこの関数を呼び出してはなりません。サービスが StartService 関数からこの関数を呼び出すと、デッドロックが発生し、サービスが応答を停止する可能性があります。

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

各言語での呼び出し定義

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

HRESULT NCryptSetProperty(
    NCRYPT_HANDLE hObject,
    LPCWSTR pszProperty,
    BYTE* pbInput,
    DWORD cbInput,
    NCRYPT_FLAGS dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptSetProperty(
    UIntPtr hObject,   // NCRYPT_HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string pszProperty,   // LPCWSTR
    IntPtr pbInput,   // BYTE*
    uint cbInput,   // DWORD
    uint dwFlags   // NCRYPT_FLAGS
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptSetProperty(
    hObject As UIntPtr,   ' NCRYPT_HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> pszProperty As String,   ' LPCWSTR
    pbInput As IntPtr,   ' BYTE*
    cbInput As UInteger,   ' DWORD
    dwFlags As UInteger   ' NCRYPT_FLAGS
) As Integer
End Function
' hObject : NCRYPT_HANDLE
' pszProperty : LPCWSTR
' pbInput : BYTE*
' cbInput : DWORD
' dwFlags : NCRYPT_FLAGS
Declare PtrSafe Function NCryptSetProperty Lib "ncrypt" ( _
    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

NCryptSetProperty = ctypes.windll.ncrypt.NCryptSetProperty
NCryptSetProperty.restype = ctypes.c_int
NCryptSetProperty.argtypes = [
    ctypes.c_size_t,  # hObject : NCRYPT_HANDLE
    wintypes.LPCWSTR,  # pszProperty : LPCWSTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbInput : BYTE*
    wintypes.DWORD,  # cbInput : DWORD
    wintypes.DWORD,  # dwFlags : NCRYPT_FLAGS
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procNCryptSetProperty = ncrypt.NewProc("NCryptSetProperty")
)

// hObject (NCRYPT_HANDLE), pszProperty (LPCWSTR), pbInput (BYTE*), cbInput (DWORD), dwFlags (NCRYPT_FLAGS)
r1, _, err := procNCryptSetProperty.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   // HRESULT
function NCryptSetProperty(
  hObject: NativeUInt;   // NCRYPT_HANDLE
  pszProperty: PWideChar;   // LPCWSTR
  pbInput: Pointer;   // BYTE*
  cbInput: DWORD;   // DWORD
  dwFlags: DWORD   // NCRYPT_FLAGS
): Integer; stdcall;
  external 'ncrypt.dll' name 'NCryptSetProperty';
result := DllCall("ncrypt\NCryptSetProperty"
    , "UPtr", hObject   ; NCRYPT_HANDLE
    , "WStr", pszProperty   ; LPCWSTR
    , "Ptr", pbInput   ; BYTE*
    , "UInt", cbInput   ; DWORD
    , "UInt", dwFlags   ; NCRYPT_FLAGS
    , "Int")   ; return: HRESULT
●NCryptSetProperty(hObject, pszProperty, pbInput, cbInput, dwFlags) = DLL("ncrypt.dll", "int NCryptSetProperty(int, char*, void*, dword, dword)")
# 呼び出し: NCryptSetProperty(hObject, pszProperty, pbInput, cbInput, dwFlags)
# hObject : NCRYPT_HANDLE -> "int"
# pszProperty : LPCWSTR -> "char*"
# pbInput : BYTE* -> "void*"
# cbInput : DWORD -> "dword"
# dwFlags : NCRYPT_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ncrypt" fn NCryptSetProperty(
    hObject: usize, // NCRYPT_HANDLE
    pszProperty: [*c]const u16, // LPCWSTR
    pbInput: [*c]u8, // BYTE*
    cbInput: u32, // DWORD
    dwFlags: u32 // NCRYPT_FLAGS
) callconv(std.os.windows.WINAPI) i32;
proc NCryptSetProperty(
    hObject: uint,  # NCRYPT_HANDLE
    pszProperty: WideCString,  # LPCWSTR
    pbInput: ptr uint8,  # BYTE*
    cbInput: uint32,  # DWORD
    dwFlags: uint32  # NCRYPT_FLAGS
): int32 {.importc: "NCryptSetProperty", stdcall, dynlib: "ncrypt.dll".}
pragma(lib, "ncrypt");
extern(Windows)
int NCryptSetProperty(
    size_t hObject,   // NCRYPT_HANDLE
    const(wchar)* pszProperty,   // LPCWSTR
    ubyte* pbInput,   // BYTE*
    uint cbInput,   // DWORD
    uint dwFlags   // NCRYPT_FLAGS
);
ccall((:NCryptSetProperty, "ncrypt.dll"), stdcall, Int32,
      (Csize_t, Cwstring, Ptr{UInt8}, UInt32, UInt32),
      hObject, pszProperty, pbInput, cbInput, dwFlags)
# hObject : NCRYPT_HANDLE -> Csize_t
# pszProperty : LPCWSTR -> Cwstring
# pbInput : BYTE* -> Ptr{UInt8}
# cbInput : DWORD -> UInt32
# dwFlags : NCRYPT_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t NCryptSetProperty(
    uintptr_t hObject,
    const uint16_t* pszProperty,
    uint8_t* pbInput,
    uint32_t cbInput,
    uint32_t dwFlags);
]]
local ncrypt = ffi.load("ncrypt")
-- ncrypt.NCryptSetProperty(hObject, pszProperty, pbInput, cbInput, dwFlags)
-- hObject : NCRYPT_HANDLE
-- pszProperty : LPCWSTR
-- pbInput : BYTE*
-- cbInput : DWORD
-- dwFlags : NCRYPT_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ncrypt.dll');
const NCryptSetProperty = lib.func('__stdcall', 'NCryptSetProperty', 'int32_t', ['uintptr_t', 'str16', 'uint8_t *', 'uint32_t', 'uint32_t']);
// NCryptSetProperty(hObject, pszProperty, pbInput, cbInput, dwFlags)
// hObject : NCRYPT_HANDLE -> 'uintptr_t'
// pszProperty : LPCWSTR -> 'str16'
// pbInput : BYTE* -> 'uint8_t *'
// cbInput : DWORD -> 'uint32_t'
// dwFlags : NCRYPT_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ncrypt.dll", {
  NCryptSetProperty: { parameters: ["usize", "buffer", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.NCryptSetProperty(hObject, pszProperty, pbInput, cbInput, dwFlags)
// hObject : NCRYPT_HANDLE -> "usize"
// pszProperty : LPCWSTR -> "buffer"
// pbInput : BYTE* -> "pointer"
// cbInput : DWORD -> "u32"
// dwFlags : NCRYPT_FLAGS -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t NCryptSetProperty(
    size_t hObject,
    const uint16_t* pszProperty,
    uint8_t* pbInput,
    uint32_t cbInput,
    uint32_t dwFlags);
C, "ncrypt.dll");
// $ffi->NCryptSetProperty(hObject, pszProperty, pbInput, cbInput, dwFlags);
// hObject : NCRYPT_HANDLE
// pszProperty : LPCWSTR
// pbInput : BYTE*
// cbInput : DWORD
// dwFlags : NCRYPT_FLAGS
// 構造体/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 Ncrypt extends StdCallLibrary {
    Ncrypt INSTANCE = Native.load("ncrypt", Ncrypt.class);
    int NCryptSetProperty(
        long hObject,   // NCRYPT_HANDLE
        WString pszProperty,   // LPCWSTR
        byte[] pbInput,   // BYTE*
        int cbInput,   // DWORD
        int dwFlags   // NCRYPT_FLAGS
    );
}
@[Link("ncrypt")]
lib Libncrypt
  fun NCryptSetProperty = NCryptSetProperty(
    hObject : LibC::SizeT,   # NCRYPT_HANDLE
    pszProperty : UInt16*,   # LPCWSTR
    pbInput : UInt8*,   # BYTE*
    cbInput : UInt32,   # DWORD
    dwFlags : UInt32   # NCRYPT_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef NCryptSetPropertyNative = Int32 Function(UintPtr, Pointer<Utf16>, Pointer<Uint8>, Uint32, Uint32);
typedef NCryptSetPropertyDart = int Function(int, Pointer<Utf16>, Pointer<Uint8>, int, int);
final NCryptSetProperty = DynamicLibrary.open('ncrypt.dll')
    .lookupFunction<NCryptSetPropertyNative, NCryptSetPropertyDart>('NCryptSetProperty');
// hObject : NCRYPT_HANDLE -> UintPtr
// pszProperty : LPCWSTR -> Pointer<Utf16>
// pbInput : BYTE* -> Pointer<Uint8>
// cbInput : DWORD -> Uint32
// dwFlags : NCRYPT_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NCryptSetProperty(
  hObject: NativeUInt;   // NCRYPT_HANDLE
  pszProperty: PWideChar;   // LPCWSTR
  pbInput: Pointer;   // BYTE*
  cbInput: DWORD;   // DWORD
  dwFlags: DWORD   // NCRYPT_FLAGS
): Integer; stdcall;
  external 'ncrypt.dll' name 'NCryptSetProperty';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let ncryptsetproperty =
  foreign "NCryptSetProperty"
    (size_t @-> (ptr uint16_t) @-> (ptr uint8_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hObject : NCRYPT_HANDLE -> size_t *)
(* pszProperty : LPCWSTR -> (ptr uint16_t) *)
(* pbInput : BYTE* -> (ptr uint8_t) *)
(* cbInput : DWORD -> uint32_t *)
(* dwFlags : NCRYPT_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ncrypt (t "ncrypt.dll"))
(cffi:use-foreign-library ncrypt)

(cffi:defcfun ("NCryptSetProperty" ncrypt-set-property :convention :stdcall) :int32
  (h-object :uint64)   ; NCRYPT_HANDLE
  (psz-property (:string :encoding :utf-16le))   ; LPCWSTR
  (pb-input :pointer)   ; BYTE*
  (cb-input :uint32)   ; DWORD
  (dw-flags :uint32))   ; NCRYPT_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NCryptSetProperty = Win32::API::More->new('ncrypt',
    'int NCryptSetProperty(WPARAM hObject, LPCWSTR pszProperty, LPVOID pbInput, DWORD cbInput, DWORD dwFlags)');
# my $ret = $NCryptSetProperty->Call($hObject, $pszProperty, $pbInput, $cbInput, $dwFlags);
# hObject : NCRYPT_HANDLE -> WPARAM
# pszProperty : LPCWSTR -> LPCWSTR
# pbInput : BYTE* -> LPVOID
# cbInput : DWORD -> DWORD
# dwFlags : NCRYPT_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型