ホーム › Security.Authorization › LookupSecurityDescriptorPartsA

LookupSecurityDescriptorPartsA

関数

セキュリティ記述子を所有者やアクセスエントリなどの構成要素に分解する(ANSI版)。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR LookupSecurityDescriptorPartsA(
    TRUSTEE_A** ppOwner,   // optional
    TRUSTEE_A** ppGroup,   // optional
    DWORD* pcCountOfAccessEntries,   // optional
    EXPLICIT_ACCESS_A** ppListOfAccessEntries,
    DWORD* pcCountOfAuditEntries,   // optional
    EXPLICIT_ACCESS_A** ppListOfAuditEntries,
    PSECURITY_DESCRIPTOR pSD
);

パラメーター

名前	型	方向	説明
ppOwner	TRUSTEE_A**	outoptional	TRUSTEE 構造体へのポインターを受け取る変数へのポインターです。この関数は、pSD セキュリティ記述子内の所有者のセキュリティ識別子 (SID) に関連付けられた名前を検索し、その名前へのポインターを TRUSTEE 構造体の ptstrName メンバーに返します。この関数は TrusteeForm メンバーを TRUSTEE_IS_NAME に設定します。所有者の名前が不要な場合、このパラメーターは NULL にできます。
ppGroup	TRUSTEE_A**	outoptional	TRUSTEE 構造体へのポインターを受け取る変数へのポインターです。この関数は、セキュリティ記述子のプライマリグループ SID に関連付けられた名前を検索し、その名前へのポインターを TRUSTEE 構造体の ptstrName メンバーに返します。この関数は TrusteeForm メンバーを TRUSTEE_IS_NAME に設定します。グループの名前が不要な場合、このパラメーターは NULL にできます。
pcCountOfAccessEntries	DWORD*	outoptional	pListOfAccessEntries 配列に返される EXPLICIT_ACCESS 構造体の数を受け取る ULONG へのポインターです。このパラメーターは、pListOfAccessEntries パラメーターも NULL である場合に限り NULL にできます。
ppListOfAccessEntries	EXPLICIT_ACCESS_A**	out	セキュリティ記述子の随意アクセス制御リスト (DACL) 内のアクセス制御エントリ (ACE) を記述する EXPLICIT_ACCESS 構造体の配列へのポインターを受け取る変数へのポインターです。これらの EXPLICIT_ACCESS 構造体内の TRUSTEE 構造体は TRUSTEE_IS_NAME 形式を使用します。EXPLICIT_ACCESS 構造体の配列がアクセス制御リスト (ACL) 内の ACE をどのように記述するかについては、GetExplicitEntriesFromAcl 関数を参照してください。このパラメーターが NULL の場合、cCountOfAccessEntries パラメーターも NULL でなければなりません。
pcCountOfAuditEntries	DWORD*	outoptional	pListOfAuditEntries 配列に返される EXPLICIT_ACCESS 構造体の数を受け取る ULONG へのポインターです。このパラメーターは、pListOfAuditEntries パラメーターも NULL である場合に限り NULL にできます。
ppListOfAuditEntries	EXPLICIT_ACCESS_A**	out	セキュリティ記述子のシステムアクセス制御リスト (SACL) 内の ACE を記述する EXPLICIT_ACCESS 構造体の配列へのポインターを受け取る変数へのポインターです。これらの EXPLICIT_ACCESS 構造体内の TRUSTEE 構造体は TRUSTEE_IS_NAME 形式を使用します。このパラメーターが NULL の場合、cCountOfAuditEntries パラメーターも NULL でなければなりません。
pSD	PSECURITY_DESCRIPTOR	in	関数がセキュリティ情報を取得する元となる既存の自己相対形式のセキュリティ記述子へのポインターです。

戻り値の型: WIN32_ERROR

公式ドキュメント

自己相対形式のセキュリティ記述子からセキュリティ情報を取得します。(ANSI)

戻り値

関数が成功した場合、ERROR_SUCCESS を返します。

関数が失敗した場合、WinError.h で定義されている 0 以外のエラーコードを返します。

解説(Remarks)

LookupSecurityDescriptorParts 関数は、セキュリティ記述子の所有者およびプライマリグループの名前を取得します。また、この関数はセキュリティ記述子の DACL 内の ACE と SACL 内の監査制御エントリの説明も返します。

pSD 以外のパラメーターは、その情報が不要な場合は NULL にできます。DACL に関する情報が不要な場合は、pListOfAccessEntries と cCountOfAuditEntries の両方を NULL にする必要があります。SACL に関する情報が不要な場合は、pListOfAuditEntries と cCountOfAuditEntries の両方を NULL にする必要があります。同様に、DACL または SACL の情報が必要な場合は、対応する両方のパラメーターを NULL 以外にする必要があります。

pOwner、pGroup、pListOfAccessEntries、または pListOfAuditEntries の各パラメーターによって返されたバッファーの使用を終えたら、LocalFree 関数を呼び出して解放してください。

LookupSecurityDescriptorParts 関数は、自身のオブジェクトに対するセキュリティを実装または公開する信頼されたサーバーを対象としています。この関数は、信頼されたサーバーが必要とするような、ストリームへのシリアル化やディスクへの保存に適した自己相対形式のセキュリティ記述子を処理します。

メモ

aclapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして LookupSecurityDescriptorParts を定義します。エンコードニュートラルなエイリアスの使用を、エンコードニュートラルでないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致につながる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR LookupSecurityDescriptorPartsA(
    TRUSTEE_A** ppOwner,   // optional
    TRUSTEE_A** ppGroup,   // optional
    DWORD* pcCountOfAccessEntries,   // optional
    EXPLICIT_ACCESS_A** ppListOfAccessEntries,
    DWORD* pcCountOfAuditEntries,   // optional
    EXPLICIT_ACCESS_A** ppListOfAuditEntries,
    PSECURITY_DESCRIPTOR pSD
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint LookupSecurityDescriptorPartsA(
    IntPtr ppOwner,   // TRUSTEE_A** optional, out
    IntPtr ppGroup,   // TRUSTEE_A** optional, out
    IntPtr pcCountOfAccessEntries,   // DWORD* optional, out
    IntPtr ppListOfAccessEntries,   // EXPLICIT_ACCESS_A** out
    IntPtr pcCountOfAuditEntries,   // DWORD* optional, out
    IntPtr ppListOfAuditEntries,   // EXPLICIT_ACCESS_A** out
    IntPtr pSD   // PSECURITY_DESCRIPTOR
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function LookupSecurityDescriptorPartsA(
    ppOwner As IntPtr,   ' TRUSTEE_A** optional, out
    ppGroup As IntPtr,   ' TRUSTEE_A** optional, out
    pcCountOfAccessEntries As IntPtr,   ' DWORD* optional, out
    ppListOfAccessEntries As IntPtr,   ' EXPLICIT_ACCESS_A** out
    pcCountOfAuditEntries As IntPtr,   ' DWORD* optional, out
    ppListOfAuditEntries As IntPtr,   ' EXPLICIT_ACCESS_A** out
    pSD As IntPtr   ' PSECURITY_DESCRIPTOR
) As UInteger
End Function

' ppOwner : TRUSTEE_A** optional, out
' ppGroup : TRUSTEE_A** optional, out
' pcCountOfAccessEntries : DWORD* optional, out
' ppListOfAccessEntries : EXPLICIT_ACCESS_A** out
' pcCountOfAuditEntries : DWORD* optional, out
' ppListOfAuditEntries : EXPLICIT_ACCESS_A** out
' pSD : PSECURITY_DESCRIPTOR
Declare PtrSafe Function LookupSecurityDescriptorPartsA Lib "advapi32" ( _
    ByVal ppOwner As LongPtr, _
    ByVal ppGroup As LongPtr, _
    ByVal pcCountOfAccessEntries As LongPtr, _
    ByVal ppListOfAccessEntries As LongPtr, _
    ByVal pcCountOfAuditEntries As LongPtr, _
    ByVal ppListOfAuditEntries As LongPtr, _
    ByVal pSD As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

LookupSecurityDescriptorPartsA = ctypes.windll.advapi32.LookupSecurityDescriptorPartsA
LookupSecurityDescriptorPartsA.restype = wintypes.DWORD
LookupSecurityDescriptorPartsA.argtypes = [
    ctypes.c_void_p,  # ppOwner : TRUSTEE_A** optional, out
    ctypes.c_void_p,  # ppGroup : TRUSTEE_A** optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcCountOfAccessEntries : DWORD* optional, out
    ctypes.c_void_p,  # ppListOfAccessEntries : EXPLICIT_ACCESS_A** out
    ctypes.POINTER(wintypes.DWORD),  # pcCountOfAuditEntries : DWORD* optional, out
    ctypes.c_void_p,  # ppListOfAuditEntries : EXPLICIT_ACCESS_A** out
    wintypes.HANDLE,  # pSD : PSECURITY_DESCRIPTOR
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
LookupSecurityDescriptorPartsA = Fiddle::Function.new(
  lib['LookupSecurityDescriptorPartsA'],
  [
    Fiddle::TYPE_VOIDP,  # ppOwner : TRUSTEE_A** optional, out
    Fiddle::TYPE_VOIDP,  # ppGroup : TRUSTEE_A** optional, out
    Fiddle::TYPE_VOIDP,  # pcCountOfAccessEntries : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # ppListOfAccessEntries : EXPLICIT_ACCESS_A** out
    Fiddle::TYPE_VOIDP,  # pcCountOfAuditEntries : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # ppListOfAuditEntries : EXPLICIT_ACCESS_A** out
    Fiddle::TYPE_VOIDP,  # pSD : PSECURITY_DESCRIPTOR
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn LookupSecurityDescriptorPartsA(
        ppOwner: *mut *mut TRUSTEE_A,  // TRUSTEE_A** optional, out
        ppGroup: *mut *mut TRUSTEE_A,  // TRUSTEE_A** optional, out
        pcCountOfAccessEntries: *mut u32,  // DWORD* optional, out
        ppListOfAccessEntries: *mut *mut EXPLICIT_ACCESS_A,  // EXPLICIT_ACCESS_A** out
        pcCountOfAuditEntries: *mut u32,  // DWORD* optional, out
        ppListOfAuditEntries: *mut *mut EXPLICIT_ACCESS_A,  // EXPLICIT_ACCESS_A** out
        pSD: *mut core::ffi::c_void  // PSECURITY_DESCRIPTOR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint LookupSecurityDescriptorPartsA(IntPtr ppOwner, IntPtr ppGroup, IntPtr pcCountOfAccessEntries, IntPtr ppListOfAccessEntries, IntPtr pcCountOfAuditEntries, IntPtr ppListOfAuditEntries, IntPtr pSD);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_LookupSecurityDescriptorPartsA' -Namespace Win32 -PassThru
# $api::LookupSecurityDescriptorPartsA(ppOwner, ppGroup, pcCountOfAccessEntries, ppListOfAccessEntries, pcCountOfAuditEntries, ppListOfAuditEntries, pSD)

#uselib "ADVAPI32.dll"
#func global LookupSecurityDescriptorPartsA "LookupSecurityDescriptorPartsA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; LookupSecurityDescriptorPartsA varptr(ppOwner), varptr(ppGroup), varptr(pcCountOfAccessEntries), varptr(ppListOfAccessEntries), varptr(pcCountOfAuditEntries), varptr(ppListOfAuditEntries), pSD   ; 戻り値は stat
; ppOwner : TRUSTEE_A** optional, out -> "sptr"
; ppGroup : TRUSTEE_A** optional, out -> "sptr"
; pcCountOfAccessEntries : DWORD* optional, out -> "sptr"
; ppListOfAccessEntries : EXPLICIT_ACCESS_A** out -> "sptr"
; pcCountOfAuditEntries : DWORD* optional, out -> "sptr"
; ppListOfAuditEntries : EXPLICIT_ACCESS_A** out -> "sptr"
; pSD : PSECURITY_DESCRIPTOR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global LookupSecurityDescriptorPartsA "LookupSecurityDescriptorPartsA" var, var, var, var, var, var, sptr
; res = LookupSecurityDescriptorPartsA(ppOwner, ppGroup, pcCountOfAccessEntries, ppListOfAccessEntries, pcCountOfAuditEntries, ppListOfAuditEntries, pSD)
; ppOwner : TRUSTEE_A** optional, out -> "var"
; ppGroup : TRUSTEE_A** optional, out -> "var"
; pcCountOfAccessEntries : DWORD* optional, out -> "var"
; ppListOfAccessEntries : EXPLICIT_ACCESS_A** out -> "var"
; pcCountOfAuditEntries : DWORD* optional, out -> "var"
; ppListOfAuditEntries : EXPLICIT_ACCESS_A** out -> "var"
; pSD : PSECURITY_DESCRIPTOR -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global LookupSecurityDescriptorPartsA "LookupSecurityDescriptorPartsA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; res = LookupSecurityDescriptorPartsA(varptr(ppOwner), varptr(ppGroup), varptr(pcCountOfAccessEntries), varptr(ppListOfAccessEntries), varptr(pcCountOfAuditEntries), varptr(ppListOfAuditEntries), pSD)
; ppOwner : TRUSTEE_A** optional, out -> "sptr"
; ppGroup : TRUSTEE_A** optional, out -> "sptr"
; pcCountOfAccessEntries : DWORD* optional, out -> "sptr"
; ppListOfAccessEntries : EXPLICIT_ACCESS_A** out -> "sptr"
; pcCountOfAuditEntries : DWORD* optional, out -> "sptr"
; ppListOfAuditEntries : EXPLICIT_ACCESS_A** out -> "sptr"
; pSD : PSECURITY_DESCRIPTOR -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。