AccessCheck

関数

セキュリティ記述子に対しトークンのアクセス権を検査する。

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

シグネチャ

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

BOOL AccessCheck(
    PSECURITY_DESCRIPTOR pSecurityDescriptor,
    HANDLE ClientToken,
    DWORD DesiredAccess,
    GENERIC_MAPPING* GenericMapping,
    PRIVILEGE_SET* PrivilegeSet,   // optional
    DWORD* PrivilegeSetLength,
    DWORD* GrantedAccess,
    BOOL* AccessStatus
);

パラメーター

名前	型	方向	説明
pSecurityDescriptor	PSECURITY_DESCRIPTOR	in	アクセスのチェック対象となる SECURITY_DESCRIPTOR 構造体へのポインターです。
ClientToken	HANDLE	in	アクセスを取得しようとしているクライアントを表す偽装トークンへのハンドルです。このハンドルにはトークンに対する TOKEN_QUERY アクセスが必要です。そうでない場合、関数は ERROR_ACCESS_DENIED で失敗します。
DesiredAccess	DWORD	in	チェックするアクセス権を指定するアクセスマスクです。このマスクは、汎用アクセス権を含まないように MapGenericMask 関数によってマッピングされている必要があります。このパラメーターが MAXIMUM_ALLOWED の場合、関数は GrantedAccess アクセスマスクを設定し、セキュリティ記述子がクライアントに許可する最大のアクセス権を示します。
GenericMapping	GENERIC_MAPPING*	in	アクセスのチェック対象となるオブジェクトに関連付けられた GENERIC_MAPPING 構造体へのポインターです。
PrivilegeSet	PRIVILEGE_SET*	outoptional	アクセス検証の実行に使用された特権を受け取る PRIVILEGE_SET 構造体へのポインターです。特権が使用されなかった場合、関数は PrivilegeCount メンバーを 0 に設定します。
PrivilegeSetLength	DWORD*	inout	PrivilegeSet パラメーターが指すバッファーのサイズをバイト単位で指定します。
GrantedAccess	DWORD*	out	付与されたアクセス権を受け取るアクセスマスクへのポインターです。AccessStatus が FALSE に設定された場合、関数はアクセスマスクを 0 に設定します。関数が失敗した場合、アクセスマスクは設定されません。
AccessStatus	BOOL*	out	アクセスチェックの結果を受け取る変数へのポインターです。セキュリティ記述子が、アクセストークンによって識別されるクライアントに対して要求されたアクセス権を許可する場合、AccessStatus は TRUE に設定されます。それ以外の場合、AccessStatus は FALSE に設定され、 GetLastError を呼び出して拡張エラー情報を取得できます。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

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

AccessCheck 関数は、指定されたセキュリティ記述子を指定されたアクセストークンと比較し、アクセスが付与されるか拒否されるかを AccessStatus パラメーターで示します。アクセスが付与された場合、要求されたアクセスマスクがオブジェクトの付与済みアクセスマスクになります。

セキュリティ記述子の DACL が NULL の場合、AccessStatus パラメーターは TRUE を返し、クライアントが要求されたアクセス権を持つことを示します。

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

AccessCheck 関数は監査を生成しません。アプリケーションでアクセスチェックの監査が必要な場合は、AccessCheck の代わりに AccessCheckAndAuditAlarm、AccessCheckByTypeAndAuditAlarm、AccessCheckByTypeResultListAndAuditAlarm、AccessCheckByTypeResultListAndAuditAlarmByHandle などの関数を使用してください。

例

この関数を使用する例については、 Verifying Client Access with ACLs を参照してください。

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

各言語での呼び出し定義

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

BOOL AccessCheck(
    PSECURITY_DESCRIPTOR pSecurityDescriptor,
    HANDLE ClientToken,
    DWORD DesiredAccess,
    GENERIC_MAPPING* GenericMapping,
    PRIVILEGE_SET* PrivilegeSet,   // optional
    DWORD* PrivilegeSetLength,
    DWORD* GrantedAccess,
    BOOL* AccessStatus
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool AccessCheck(
    IntPtr pSecurityDescriptor,   // PSECURITY_DESCRIPTOR
    IntPtr ClientToken,   // HANDLE
    uint DesiredAccess,   // DWORD
    IntPtr GenericMapping,   // GENERIC_MAPPING*
    IntPtr PrivilegeSet,   // PRIVILEGE_SET* optional, out
    ref uint PrivilegeSetLength,   // DWORD* in/out
    out uint GrantedAccess,   // DWORD* out
    out bool AccessStatus   // BOOL* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AccessCheck(
    pSecurityDescriptor As IntPtr,   ' PSECURITY_DESCRIPTOR
    ClientToken As IntPtr,   ' HANDLE
    DesiredAccess As UInteger,   ' DWORD
    GenericMapping As IntPtr,   ' GENERIC_MAPPING*
    PrivilegeSet As IntPtr,   ' PRIVILEGE_SET* optional, out
    ByRef PrivilegeSetLength As UInteger,   ' DWORD* in/out
    <Out> ByRef GrantedAccess As UInteger,   ' DWORD* out
    <Out> ByRef AccessStatus As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

AccessCheck = ctypes.windll.advapi32.AccessCheck
AccessCheck.restype = wintypes.BOOL
AccessCheck.argtypes = [
    wintypes.HANDLE,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR
    wintypes.HANDLE,  # ClientToken : HANDLE
    wintypes.DWORD,  # DesiredAccess : 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),  # GrantedAccess : DWORD* out
    ctypes.c_void_p,  # AccessStatus : BOOL* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
AccessCheck = Fiddle::Function.new(
  lib['AccessCheck'],
  [
    Fiddle::TYPE_VOIDP,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR
    Fiddle::TYPE_VOIDP,  # ClientToken : HANDLE
    -Fiddle::TYPE_INT,  # DesiredAccess : 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,  # GrantedAccess : DWORD* out
    Fiddle::TYPE_VOIDP,  # AccessStatus : BOOL* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn AccessCheck(
        pSecurityDescriptor: *mut core::ffi::c_void,  // PSECURITY_DESCRIPTOR
        ClientToken: *mut core::ffi::c_void,  // HANDLE
        DesiredAccess: u32,  // DWORD
        GenericMapping: *mut GENERIC_MAPPING,  // GENERIC_MAPPING*
        PrivilegeSet: *mut PRIVILEGE_SET,  // PRIVILEGE_SET* optional, out
        PrivilegeSetLength: *mut u32,  // DWORD* in/out
        GrantedAccess: *mut u32,  // DWORD* out
        AccessStatus: *mut i32  // BOOL* 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 AccessCheck(IntPtr pSecurityDescriptor, IntPtr ClientToken, uint DesiredAccess, IntPtr GenericMapping, IntPtr PrivilegeSet, ref uint PrivilegeSetLength, out uint GrantedAccess, out bool AccessStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_AccessCheck' -Namespace Win32 -PassThru
# $api::AccessCheck(pSecurityDescriptor, ClientToken, DesiredAccess, GenericMapping, PrivilegeSet, PrivilegeSetLength, GrantedAccess, AccessStatus)

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

出力引数:

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