ホーム › Security › AccessCheckByTypeResultList

AccessCheckByTypeResultList

関数

オブジェクトタイプ一覧ごとにアクセス権を検査し結果リストを返す。

DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL AccessCheckByTypeResultList(
    PSECURITY_DESCRIPTOR pSecurityDescriptor,
    PSID PrincipalSelfSid,   // optional
    HANDLE ClientToken,
    DWORD DesiredAccess,
    OBJECT_TYPE_LIST* ObjectTypeList,   // optional
    DWORD ObjectTypeListLength,
    GENERIC_MAPPING* GenericMapping,
    PRIVILEGE_SET* PrivilegeSet,   // optional
    DWORD* PrivilegeSetLength,
    DWORD* GrantedAccessList,
    DWORD* AccessStatusList
);

パラメーター

名前	型	方向	説明
pSecurityDescriptor	PSECURITY_DESCRIPTOR	in	アクセスをチェックする対象の SECURITY_DESCRIPTOR 構造体へのポインターです。
PrincipalSelfSid	PSID	inoptional	セキュリティ識別子 (SID) へのポインターです。セキュリティ記述子がプリンシパルを表すオブジェクト (たとえばユーザーオブジェクト) に関連付けられている場合、PrincipalSelfSid パラメーターにはそのオブジェクトの SID を指定する必要があります。アクセスを評価する際、この SID は、よく知られた PRINCIPAL_SELF SID (S-1-5-10) を含むアクセス制御エントリ (ACE) 内の SID を論理的に置き換えます。よく知られた SID については、Well-known SIDs を参照してください。保護対象オブジェクトがプリンシパルを表さない場合は、このパラメーターを NULL に設定します。
ClientToken	HANDLE	in	アクセスを取得しようとしているクライアントを表す偽装トークンへのハンドルです。このハンドルはトークンに対する TOKEN_QUERY アクセス権を持っている必要があります。持っていない場合、関数は ERROR_ACCESS_DENIED で失敗します。
DesiredAccess	DWORD	in	チェックするアクセス権を指定するアクセスマスクです。このマスクは、汎用アクセス権を含まないように MapGenericMask 関数によってマッピングされている必要があります。このパラメーターが MAXIMUM_ALLOWED の場合、関数は GrantedAccess 配列内のアクセスマスクを設定し、オブジェクト型リストの各要素に対するクライアントの最大アクセス権を示します。
ObjectTypeList	OBJECT_TYPE_LIST*	inoutoptional	アクセスをチェックするオブジェクト型の階層を識別する OBJECT_TYPE_LIST 構造体の配列へのポインターです。配列の各要素は、オブジェクト型を識別する GUID と、オブジェクト型の階層内におけるそのオブジェクト型のレベルを示す値を指定します。配列内に同じ GUID を持つ要素が 2 つ存在してはなりません。配列には少なくとも 1 つの要素が必要です。配列の最初の要素はレベル 0 であり、オブジェクト自体を識別する必要があります。配列に含めることができるレベル 0 の要素は 1 つだけです。2 番目の要素はレベル 1 のサブオブジェクト (プロパティセットなど) です。各レベル 1 エントリの後には、レベル 2 から 4 のサブオブジェクトに対応する従属エントリが続きます。したがって、配列内の要素のレベルは {0, 1, 2, 2, 1, 2, 3} のようになります。オブジェクト型リストが順序どおりでない場合、AccessCheckByTypeResultList は失敗し、 GetLastError は ERROR_INVALID_PARAMETER を返します。
ObjectTypeListLength	DWORD	in	ObjectTypeList 配列内の要素数です。これは、GrantedAccessList および AccessStatusList パラメーターが指す配列内の要素数でもあります。
GenericMapping	GENERIC_MAPPING*	in	アクセスをチェックする対象のオブジェクトに関連付けられた GENERIC_MAPPING 構造体へのポインターです。
PrivilegeSet	PRIVILEGE_SET*	outoptional	アクセス検証の実行に使用された特権を受け取る PRIVILEGE_SET 構造体へのポインターです。特権が使用されなかった場合、関数は PrivilegeCount メンバーをゼロに設定します。
PrivilegeSetLength	DWORD*	inout	PrivilegeSet パラメーターが指すバッファーのサイズ (バイト単位) です。
GrantedAccessList	DWORD*	out	アクセスマスクの配列へのポインターです。関数は各アクセスマスクを設定し、オブジェクト型リストの対応する要素に付与されたアクセス権を示します。関数が失敗した場合、アクセスマスクは設定されません。
AccessStatusList	DWORD*	out	オブジェクト型リストの対応する要素に対するステータスコードの配列へのポインターです。関数は、成功を示すために要素をゼロに設定し、アクセスチェック中の特定のエラーを示すために 0 以外の値を設定します。関数が失敗した場合、配列内の要素はいずれも設定されません。

戻り値の型: BOOL

公式ドキュメント

セキュリティ記述子が、アクセストークンによって識別されるクライアントに対して、指定された一連のアクセス権を付与するかどうかを判定します。(AccessCheckByTypeResultList)

戻り値

関数が成功した場合、0 以外の値を返します。

関数が失敗した場合、0 を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

詳細については、How AccessCheck Works の概要を参照してください。

AccessCheckByTypeResultList 関数は、指定されたセキュリティ記述子を指定されたアクセストークンと比較し、オブジェクト型リスト内の各要素についてアクセスが許可されるか拒否されるかを AccessStatusList パラメーターで示します。

ObjectTypeList 配列は、必ずしも定義済みのオブジェクト全体を表すわけではありません。むしろ、アクセスをチェックする対象となるオブジェクトのサブセットを表します。たとえば、プロパティセット内の 2 つのプロパティへのアクセスをチェックするには、4 つの要素を持つオブジェクト型リストを指定します。すなわち、レベル 0 のオブジェクト自体、レベル 1 のプロパティセット、そしてレベル 2 の 2 つのプロパティです。

AccessCheckByTypeResultList 関数は、オブジェクト自体に適用される ACE と、ObjectTypeList 配列に列挙されたオブジェクト型に対するオブジェクト固有の ACE を評価します。この関数は、ObjectTypeList 配列に列挙されていないオブジェクト型に対するオブジェクト固有の ACE を無視します。したがって、AccessStatusList パラメーターの要素 0 に対して返される結果は、オブジェクト全体ではなく、ObjectTypeList パラメーターによって定義されたオブジェクトのサブセットに対して許可されるアクセスを示します。

ACE の階層がオブジェクトおよびそのサブオブジェクトへのアクセスをどのように制御するかの詳細については、 ACEs to Control Access to an Object's Properties を参照してください。

セキュリティ記述子の随意アクセス制御リスト (DACL) が NULL の場合、関数はオブジェクト型リスト内のすべての要素に対して要求されたアクセスを付与します。

セキュリティ記述子に所有者およびグループ SID が含まれていない場合、AccessCheckByTypeResultList は ERROR_INVALID_SECURITY_DESCR で失敗します。

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

各言語での呼び出し定義

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

BOOL AccessCheckByTypeResultList(
    PSECURITY_DESCRIPTOR pSecurityDescriptor,
    PSID PrincipalSelfSid,   // optional
    HANDLE ClientToken,
    DWORD DesiredAccess,
    OBJECT_TYPE_LIST* ObjectTypeList,   // optional
    DWORD ObjectTypeListLength,
    GENERIC_MAPPING* GenericMapping,
    PRIVILEGE_SET* PrivilegeSet,   // optional
    DWORD* PrivilegeSetLength,
    DWORD* GrantedAccessList,
    DWORD* AccessStatusList
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool AccessCheckByTypeResultList(
    IntPtr pSecurityDescriptor,   // PSECURITY_DESCRIPTOR
    IntPtr PrincipalSelfSid,   // PSID optional
    IntPtr ClientToken,   // HANDLE
    uint DesiredAccess,   // DWORD
    IntPtr ObjectTypeList,   // OBJECT_TYPE_LIST* optional, in/out
    uint ObjectTypeListLength,   // DWORD
    IntPtr GenericMapping,   // GENERIC_MAPPING*
    IntPtr PrivilegeSet,   // PRIVILEGE_SET* optional, out
    ref uint PrivilegeSetLength,   // DWORD* in/out
    out uint GrantedAccessList,   // DWORD* out
    out uint AccessStatusList   // DWORD* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AccessCheckByTypeResultList(
    pSecurityDescriptor As IntPtr,   ' PSECURITY_DESCRIPTOR
    PrincipalSelfSid As IntPtr,   ' PSID optional
    ClientToken As IntPtr,   ' HANDLE
    DesiredAccess As UInteger,   ' DWORD
    ObjectTypeList As IntPtr,   ' OBJECT_TYPE_LIST* optional, in/out
    ObjectTypeListLength As UInteger,   ' DWORD
    GenericMapping As IntPtr,   ' GENERIC_MAPPING*
    PrivilegeSet As IntPtr,   ' PRIVILEGE_SET* optional, out
    ByRef PrivilegeSetLength As UInteger,   ' DWORD* in/out
    <Out> ByRef GrantedAccessList As UInteger,   ' DWORD* out
    <Out> ByRef AccessStatusList As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pSecurityDescriptor : PSECURITY_DESCRIPTOR
' PrincipalSelfSid : PSID optional
' ClientToken : HANDLE
' DesiredAccess : DWORD
' ObjectTypeList : OBJECT_TYPE_LIST* optional, in/out
' ObjectTypeListLength : DWORD
' GenericMapping : GENERIC_MAPPING*
' PrivilegeSet : PRIVILEGE_SET* optional, out
' PrivilegeSetLength : DWORD* in/out
' GrantedAccessList : DWORD* out
' AccessStatusList : DWORD* out
Declare PtrSafe Function AccessCheckByTypeResultList Lib "advapi32" ( _
    ByVal pSecurityDescriptor As LongPtr, _
    ByVal PrincipalSelfSid As LongPtr, _
    ByVal ClientToken As LongPtr, _
    ByVal DesiredAccess As Long, _
    ByVal ObjectTypeList As LongPtr, _
    ByVal ObjectTypeListLength As Long, _
    ByVal GenericMapping As LongPtr, _
    ByVal PrivilegeSet As LongPtr, _
    ByRef PrivilegeSetLength As Long, _
    ByRef GrantedAccessList As Long, _
    ByRef AccessStatusList As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AccessCheckByTypeResultList = ctypes.windll.advapi32.AccessCheckByTypeResultList
AccessCheckByTypeResultList.restype = wintypes.BOOL
AccessCheckByTypeResultList.argtypes = [
    wintypes.HANDLE,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR
    wintypes.HANDLE,  # PrincipalSelfSid : PSID optional
    wintypes.HANDLE,  # ClientToken : HANDLE
    wintypes.DWORD,  # DesiredAccess : DWORD
    ctypes.c_void_p,  # ObjectTypeList : OBJECT_TYPE_LIST* optional, in/out
    wintypes.DWORD,  # ObjectTypeListLength : DWORD
    ctypes.c_void_p,  # GenericMapping : GENERIC_MAPPING*
    ctypes.c_void_p,  # PrivilegeSet : PRIVILEGE_SET* optional, out
    ctypes.POINTER(wintypes.DWORD),  # PrivilegeSetLength : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # GrantedAccessList : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # AccessStatusList : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
AccessCheckByTypeResultList = Fiddle::Function.new(
  lib['AccessCheckByTypeResultList'],
  [
    Fiddle::TYPE_VOIDP,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR
    Fiddle::TYPE_VOIDP,  # PrincipalSelfSid : PSID optional
    Fiddle::TYPE_VOIDP,  # ClientToken : HANDLE
    -Fiddle::TYPE_INT,  # DesiredAccess : DWORD
    Fiddle::TYPE_VOIDP,  # ObjectTypeList : OBJECT_TYPE_LIST* optional, in/out
    -Fiddle::TYPE_INT,  # ObjectTypeListLength : DWORD
    Fiddle::TYPE_VOIDP,  # GenericMapping : GENERIC_MAPPING*
    Fiddle::TYPE_VOIDP,  # PrivilegeSet : PRIVILEGE_SET* optional, out
    Fiddle::TYPE_VOIDP,  # PrivilegeSetLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # GrantedAccessList : DWORD* out
    Fiddle::TYPE_VOIDP,  # AccessStatusList : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn AccessCheckByTypeResultList(
        pSecurityDescriptor: *mut core::ffi::c_void,  // PSECURITY_DESCRIPTOR
        PrincipalSelfSid: *mut core::ffi::c_void,  // PSID optional
        ClientToken: *mut core::ffi::c_void,  // HANDLE
        DesiredAccess: u32,  // DWORD
        ObjectTypeList: *mut OBJECT_TYPE_LIST,  // OBJECT_TYPE_LIST* optional, in/out
        ObjectTypeListLength: u32,  // DWORD
        GenericMapping: *mut GENERIC_MAPPING,  // GENERIC_MAPPING*
        PrivilegeSet: *mut PRIVILEGE_SET,  // PRIVILEGE_SET* optional, out
        PrivilegeSetLength: *mut u32,  // DWORD* in/out
        GrantedAccessList: *mut u32,  // DWORD* out
        AccessStatusList: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern bool AccessCheckByTypeResultList(IntPtr pSecurityDescriptor, IntPtr PrincipalSelfSid, IntPtr ClientToken, uint DesiredAccess, IntPtr ObjectTypeList, uint ObjectTypeListLength, IntPtr GenericMapping, IntPtr PrivilegeSet, ref uint PrivilegeSetLength, out uint GrantedAccessList, out uint AccessStatusList);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_AccessCheckByTypeResultList' -Namespace Win32 -PassThru
# $api::AccessCheckByTypeResultList(pSecurityDescriptor, PrincipalSelfSid, ClientToken, DesiredAccess, ObjectTypeList, ObjectTypeListLength, GenericMapping, PrivilegeSet, PrivilegeSetLength, GrantedAccessList, AccessStatusList)

#uselib "ADVAPI32.dll"
#func global AccessCheckByTypeResultList "AccessCheckByTypeResultList" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; AccessCheckByTypeResultList pSecurityDescriptor, PrincipalSelfSid, ClientToken, DesiredAccess, varptr(ObjectTypeList), ObjectTypeListLength, varptr(GenericMapping), varptr(PrivilegeSet), varptr(PrivilegeSetLength), varptr(GrantedAccessList), varptr(AccessStatusList)   ; 戻り値は stat
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; PrincipalSelfSid : PSID optional -> "sptr"
; ClientToken : HANDLE -> "sptr"
; DesiredAccess : DWORD -> "sptr"
; ObjectTypeList : OBJECT_TYPE_LIST* optional, in/out -> "sptr"
; ObjectTypeListLength : DWORD -> "sptr"
; GenericMapping : GENERIC_MAPPING* -> "sptr"
; PrivilegeSet : PRIVILEGE_SET* optional, out -> "sptr"
; PrivilegeSetLength : DWORD* in/out -> "sptr"
; GrantedAccessList : DWORD* out -> "sptr"
; AccessStatusList : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global AccessCheckByTypeResultList "AccessCheckByTypeResultList" sptr, sptr, sptr, int, var, int, var, var, var, var, var
; res = AccessCheckByTypeResultList(pSecurityDescriptor, PrincipalSelfSid, ClientToken, DesiredAccess, ObjectTypeList, ObjectTypeListLength, GenericMapping, PrivilegeSet, PrivilegeSetLength, GrantedAccessList, AccessStatusList)
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; PrincipalSelfSid : PSID optional -> "sptr"
; ClientToken : HANDLE -> "sptr"
; DesiredAccess : DWORD -> "int"
; ObjectTypeList : OBJECT_TYPE_LIST* optional, in/out -> "var"
; ObjectTypeListLength : DWORD -> "int"
; GenericMapping : GENERIC_MAPPING* -> "var"
; PrivilegeSet : PRIVILEGE_SET* optional, out -> "var"
; PrivilegeSetLength : DWORD* in/out -> "var"
; GrantedAccessList : DWORD* out -> "var"
; AccessStatusList : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global AccessCheckByTypeResultList "AccessCheckByTypeResultList" sptr, sptr, sptr, int, sptr, int, sptr, sptr, sptr, sptr, sptr
; res = AccessCheckByTypeResultList(pSecurityDescriptor, PrincipalSelfSid, ClientToken, DesiredAccess, varptr(ObjectTypeList), ObjectTypeListLength, varptr(GenericMapping), varptr(PrivilegeSet), varptr(PrivilegeSetLength), varptr(GrantedAccessList), varptr(AccessStatusList))
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; PrincipalSelfSid : PSID optional -> "sptr"
; ClientToken : HANDLE -> "sptr"
; DesiredAccess : DWORD -> "int"
; ObjectTypeList : OBJECT_TYPE_LIST* optional, in/out -> "sptr"
; ObjectTypeListLength : DWORD -> "int"
; GenericMapping : GENERIC_MAPPING* -> "sptr"
; PrivilegeSet : PRIVILEGE_SET* optional, out -> "sptr"
; PrivilegeSetLength : DWORD* in/out -> "sptr"
; GrantedAccessList : DWORD* out -> "sptr"
; AccessStatusList : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。