ホーム › Security.Cryptography › NCryptGetProperty

NCryptGetProperty

関数

CNGオブジェクトの指定プロパティ値を取得する。

DLLncrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT NCryptGetProperty(
    NCRYPT_HANDLE hObject,
    LPCWSTR pszProperty,
    BYTE* pbOutput,   // optional
    DWORD cbOutput,
    DWORD* pcbResult,
    OBJECT_SECURITY_INFORMATION dwFlags
);

パラメーター

名前

型

方向

説明

hObject

NCRYPT_HANDLE

プロパティを取得する対象オブジェクトのハンドル。これはプロバイダーハンドル(NCRYPT_PROV_HANDLE)またはキーハンドル(NCRYPT_KEY_HANDLE)のいずれかです。

pszProperty

LPCWSTR

取得するプロパティの名前を格納した、NULL 終端の Unicode 文字列へのポインター。これは定義済みの Key Storage Property Identifiers のいずれか、またはカスタムプロパティ識別子を指定できます。

pbOutput

BYTE*

outoptional

プロパティ値を受け取るバッファーのアドレス。cbOutput パラメーターにはこのバッファーのサイズを指定します。

バッファーに必要なサイズを計算するには、このパラメーターを NULL に設定します。必要なサイズ(バイト単位)が pcbResult パラメーターが指す場所に返されます。

cbOutput

DWORD

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

pcbResult

DWORD*

out

pbOutput バッファーにコピーされたバイト数を受け取る DWORD 変数へのポインター。

pbOutput パラメーターが NULL の場合、バッファーに必要なサイズ(バイト単位)がこのパラメーターが指す場所に格納されます。

dwFlags

OBJECT_SECURITY_INFORMATION

関数の動作を変更するフラグ。ゼロ、または次の値を指定できます。

値	意味
NCRYPT_PERSIST_ONLY_FLAG	このプロパティの組み込み値を無視し、キーのユーザー永続化プロパティのみを取得します。永続化された任意のプロパティのデータの最大サイズは NCRYPT_MAX_PROPERTY_DATA バイトです。
NCRYPT_SILENT_FLAG	キーストレージプロバイダー(KSP)がユーザーインターフェイスを一切表示しないように要求します。プロバイダーが動作のために UI を表示する必要がある場合、呼び出しは失敗し、KSP は最後のエラーとして NTE_SILENT_CONTEXT エラーコードを設定する必要があります。

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

値	意味
OWNER_SECURITY_INFORMATION	オブジェクトの所有者のセキュリティ識別子(SID)を取得します。GetSecurityDescriptorOwner 関数を使用して、SECURITY_DESCRIPTOR 構造体から所有者の SID を取得します。
GROUP_SECURITY_INFORMATION	オブジェクトのプライマリグループの SID を取得します。GetSecurityDescriptorGroup 関数を使用して、SECURITY_DESCRIPTOR 構造体からグループの SID を取得します。
DACL_SECURITY_INFORMATION	随意アクセス制御リスト(DACL)を取得します。GetSecurityDescriptorSacl 関数を使用して、SECURITY_DESCRIPTOR 構造体から DACL を取得します。
SACL_SECURITY_INFORMATION	システムアクセス制御リスト(SACL)を取得します。GetSecurityDescriptorDacl 関数を使用して、SECURITY_DESCRIPTOR 構造体から SACL を取得します。

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

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

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

戻りコード	説明
`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 NCryptGetProperty(
    NCRYPT_HANDLE hObject,
    LPCWSTR pszProperty,
    BYTE* pbOutput,   // optional
    DWORD cbOutput,
    DWORD* pcbResult,
    OBJECT_SECURITY_INFORMATION dwFlags
);

[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptGetProperty(
    UIntPtr hObject,   // NCRYPT_HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string pszProperty,   // LPCWSTR
    IntPtr pbOutput,   // BYTE* optional, out
    uint cbOutput,   // DWORD
    out uint pcbResult,   // DWORD* out
    uint dwFlags   // OBJECT_SECURITY_INFORMATION
);

<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptGetProperty(
    hObject As UIntPtr,   ' NCRYPT_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   ' OBJECT_SECURITY_INFORMATION
) As Integer
End Function

' hObject : NCRYPT_HANDLE
' pszProperty : LPCWSTR
' pbOutput : BYTE* optional, out
' cbOutput : DWORD
' pcbResult : DWORD* out
' dwFlags : OBJECT_SECURITY_INFORMATION
Declare PtrSafe Function NCryptGetProperty Lib "ncrypt" ( _
    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

NCryptGetProperty = ctypes.windll.ncrypt.NCryptGetProperty
NCryptGetProperty.restype = ctypes.c_int
NCryptGetProperty.argtypes = [
    ctypes.c_size_t,  # hObject : NCRYPT_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 : OBJECT_SECURITY_INFORMATION
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptGetProperty = Fiddle::Function.new(
  lib['NCryptGetProperty'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hObject : NCRYPT_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 : OBJECT_SECURITY_INFORMATION
  ],
  Fiddle::TYPE_INT)

#[link(name = "ncrypt")]
extern "system" {
    fn NCryptGetProperty(
        hObject: usize,  // NCRYPT_HANDLE
        pszProperty: *const u16,  // LPCWSTR
        pbOutput: *mut u8,  // BYTE* optional, out
        cbOutput: u32,  // DWORD
        pcbResult: *mut u32,  // DWORD* out
        dwFlags: u32  // OBJECT_SECURITY_INFORMATION
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptGetProperty(UIntPtr hObject, [MarshalAs(UnmanagedType.LPWStr)] string pszProperty, IntPtr pbOutput, uint cbOutput, out uint pcbResult, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptGetProperty' -Namespace Win32 -PassThru
# $api::NCryptGetProperty(hObject, pszProperty, pbOutput, cbOutput, pcbResult, dwFlags)

#uselib "ncrypt.dll"
#func global NCryptGetProperty "NCryptGetProperty" sptr, sptr, sptr, sptr, sptr, sptr
; NCryptGetProperty hObject, pszProperty, varptr(pbOutput), cbOutput, varptr(pcbResult), dwFlags   ; 戻り値は stat
; hObject : NCRYPT_HANDLE -> "sptr"
; pszProperty : LPCWSTR -> "sptr"
; pbOutput : BYTE* optional, out -> "sptr"
; cbOutput : DWORD -> "sptr"
; pcbResult : DWORD* out -> "sptr"
; dwFlags : OBJECT_SECURITY_INFORMATION -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ncrypt.dll"
#cfunc global NCryptGetProperty "NCryptGetProperty" sptr, wstr, var, int, var, int
; res = NCryptGetProperty(hObject, pszProperty, pbOutput, cbOutput, pcbResult, dwFlags)
; hObject : NCRYPT_HANDLE -> "sptr"
; pszProperty : LPCWSTR -> "wstr"
; pbOutput : BYTE* optional, out -> "var"
; cbOutput : DWORD -> "int"
; pcbResult : DWORD* out -> "var"
; dwFlags : OBJECT_SECURITY_INFORMATION -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ncrypt.dll"
#cfunc global NCryptGetProperty "NCryptGetProperty" sptr, wstr, sptr, int, sptr, int
; res = NCryptGetProperty(hObject, pszProperty, varptr(pbOutput), cbOutput, varptr(pcbResult), dwFlags)
; hObject : NCRYPT_HANDLE -> "sptr"
; pszProperty : LPCWSTR -> "wstr"
; pbOutput : BYTE* optional, out -> "sptr"
; cbOutput : DWORD -> "int"
; pcbResult : DWORD* out -> "sptr"
; dwFlags : OBJECT_SECURITY_INFORMATION -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。