ホーム › Security.Authorization › AuthzCachedAccessCheck

AuthzCachedAccessCheck

関数

キャッシュ済みの結果を用いて高速にアクセスチェックを行う。

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

シグネチャ

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

BOOL AuthzCachedAccessCheck(
    DWORD Flags,
    AUTHZ_ACCESS_CHECK_RESULTS_HANDLE hAccessCheckResults,
    AUTHZ_ACCESS_REQUEST* pRequest,
    AUTHZ_AUDIT_EVENT_HANDLE hAuditEvent,   // optional
    AUTHZ_ACCESS_REPLY* pReply
);

パラメーター

名前	型	方向	説明
Flags	DWORD	in	将来の使用のために予約されています。
hAccessCheckResults	AUTHZ_ACCESS_CHECK_RESULTS_HANDLE	in	キャッシュされたアクセスチェック結果へのハンドルです。
pRequest	AUTHZ_ACCESS_REQUEST*	in	必要な access mask、プリンシパル self SID、およびオブジェクト型リスト構造体 (存在する場合) を指定するアクセス要求ハンドルです。
hAuditEvent	AUTHZ_AUDIT_EVENT_HANDLE	inoptional	オブジェクト固有の監査情報を含む構造体です。このパラメーターの値が null でない場合、監査が自動的に要求されます。静的な監査情報はリソースマネージャー構造体から読み取られます。
pReply	AUTHZ_ACCESS_REPLY*	inout	アクセスチェックの結果を GrantedAccessMask/ErrorValue のペアの配列として返す AUTHZ_ACCESS_REPLY ハンドルへのポインターです。返されるペアの数は、AUTHZ_ACCESS_REPLY 構造体の ResultListLength メンバーで呼び出し元が指定します。

戻り値の型: BOOL

公式ドキュメント

以前の AuthzAccessCheck 呼び出しで得られた静的な許可ビットを保持するキャッシュ済みハンドルに基づいて、高速なアクセスチェックを実行します。

戻り値

関数が成功した場合は TRUE を返します。

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

返される配列要素の Error メンバーに想定される値を次の表に示します。

戻り値	説明
ERROR_SUCCESS	MAXIMUM_ALLOWED を除くすべてのアクセスビットが許可され、pReply パラメーターの GrantedAccessMask メンバーが 0 ではありません。
ERROR_PRIVILEGE_NOT_HELD	pRequest パラメーターの DesiredAccess メンバーに ACCESS_SYSTEM_SECURITY が含まれており、クライアントが SeSecurityPrivilege 特権を保持していません。
ERROR_ACCESS_DENIED	次のいずれかが該当します。要求されたビットが許可されていません。 MaximumAllowed ビットがオンで、許可されたアクセスが 0 です。 pRequest パラメーターの DesiredAccess メンバーが 0 です。

解説(Remarks)

クライアントコンテキストポインターは AuthzHandle パラメーターに格納されます。クライアントコンテキストの構造は、AuthzHandle が作成された時点とまったく同じである必要があります。この制約は次のフィールドに適用されます。

SIDs
RestrictedSids
Privileges

プライマリ security descriptor およびオプションのセキュリティ記述子配列へのポインターは、ハンドル作成時に AuthzHandle に格納されます。これらのポインターは引き続き有効である必要があります。

AuthzCachedAccessCheck 関数は、AUTHZ_RM_FLAG_NO_CENTRAL_ACCESS_POLICIES フラグが使用される場合などのように中央アクセスポリシー (CAP) が無視される場合を除き、オブジェクトに対する中央アクセスポリシーの評価結果としてキャッシュを保持します。クライアントは AuthzFreeCentralAccessPolicyCache 関数を呼び出してこのキャッシュを解放できます。これを行うと、必要に応じてキャッシュを再構築するために、以後の AuthzCachedAccessCheck 呼び出しが必要になることに注意してください。

詳細については、How AccessCheck Works および Centralized Authorization Policy の概要を参照してください。

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

各言語での呼び出し定義

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

BOOL AuthzCachedAccessCheck(
    DWORD Flags,
    AUTHZ_ACCESS_CHECK_RESULTS_HANDLE hAccessCheckResults,
    AUTHZ_ACCESS_REQUEST* pRequest,
    AUTHZ_AUDIT_EVENT_HANDLE hAuditEvent,   // optional
    AUTHZ_ACCESS_REPLY* pReply
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("AUTHZ.dll", SetLastError = true, ExactSpelling = true)]
static extern bool AuthzCachedAccessCheck(
    uint Flags,   // DWORD
    IntPtr hAccessCheckResults,   // AUTHZ_ACCESS_CHECK_RESULTS_HANDLE
    IntPtr pRequest,   // AUTHZ_ACCESS_REQUEST*
    IntPtr hAuditEvent,   // AUTHZ_AUDIT_EVENT_HANDLE optional
    IntPtr pReply   // AUTHZ_ACCESS_REPLY* in/out
);

<DllImport("AUTHZ.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AuthzCachedAccessCheck(
    Flags As UInteger,   ' DWORD
    hAccessCheckResults As IntPtr,   ' AUTHZ_ACCESS_CHECK_RESULTS_HANDLE
    pRequest As IntPtr,   ' AUTHZ_ACCESS_REQUEST*
    hAuditEvent As IntPtr,   ' AUTHZ_AUDIT_EVENT_HANDLE optional
    pReply As IntPtr   ' AUTHZ_ACCESS_REPLY* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Flags : DWORD
' hAccessCheckResults : AUTHZ_ACCESS_CHECK_RESULTS_HANDLE
' pRequest : AUTHZ_ACCESS_REQUEST*
' hAuditEvent : AUTHZ_AUDIT_EVENT_HANDLE optional
' pReply : AUTHZ_ACCESS_REPLY* in/out
Declare PtrSafe Function AuthzCachedAccessCheck Lib "authz" ( _
    ByVal Flags As Long, _
    ByVal hAccessCheckResults As LongPtr, _
    ByVal pRequest As LongPtr, _
    ByVal hAuditEvent As LongPtr, _
    ByVal pReply As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AuthzCachedAccessCheck = ctypes.windll.authz.AuthzCachedAccessCheck
AuthzCachedAccessCheck.restype = wintypes.BOOL
AuthzCachedAccessCheck.argtypes = [
    wintypes.DWORD,  # Flags : DWORD
    wintypes.HANDLE,  # hAccessCheckResults : AUTHZ_ACCESS_CHECK_RESULTS_HANDLE
    ctypes.c_void_p,  # pRequest : AUTHZ_ACCESS_REQUEST*
    wintypes.HANDLE,  # hAuditEvent : AUTHZ_AUDIT_EVENT_HANDLE optional
    ctypes.c_void_p,  # pReply : AUTHZ_ACCESS_REPLY* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('AUTHZ.dll')
AuthzCachedAccessCheck = Fiddle::Function.new(
  lib['AuthzCachedAccessCheck'],
  [
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # hAccessCheckResults : AUTHZ_ACCESS_CHECK_RESULTS_HANDLE
    Fiddle::TYPE_VOIDP,  # pRequest : AUTHZ_ACCESS_REQUEST*
    Fiddle::TYPE_VOIDP,  # hAuditEvent : AUTHZ_AUDIT_EVENT_HANDLE optional
    Fiddle::TYPE_VOIDP,  # pReply : AUTHZ_ACCESS_REPLY* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "authz")]
extern "system" {
    fn AuthzCachedAccessCheck(
        Flags: u32,  // DWORD
        hAccessCheckResults: *mut core::ffi::c_void,  // AUTHZ_ACCESS_CHECK_RESULTS_HANDLE
        pRequest: *mut AUTHZ_ACCESS_REQUEST,  // AUTHZ_ACCESS_REQUEST*
        hAuditEvent: *mut core::ffi::c_void,  // AUTHZ_AUDIT_EVENT_HANDLE optional
        pReply: *mut AUTHZ_ACCESS_REPLY  // AUTHZ_ACCESS_REPLY* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("AUTHZ.dll", SetLastError = true)]
public static extern bool AuthzCachedAccessCheck(uint Flags, IntPtr hAccessCheckResults, IntPtr pRequest, IntPtr hAuditEvent, IntPtr pReply);
"@
$api = Add-Type -MemberDefinition $sig -Name 'AUTHZ_AuthzCachedAccessCheck' -Namespace Win32 -PassThru
# $api::AuthzCachedAccessCheck(Flags, hAccessCheckResults, pRequest, hAuditEvent, pReply)

#uselib "AUTHZ.dll"
#func global AuthzCachedAccessCheck "AuthzCachedAccessCheck" sptr, sptr, sptr, sptr, sptr
; AuthzCachedAccessCheck Flags, hAccessCheckResults, varptr(pRequest), hAuditEvent, varptr(pReply)   ; 戻り値は stat
; Flags : DWORD -> "sptr"
; hAccessCheckResults : AUTHZ_ACCESS_CHECK_RESULTS_HANDLE -> "sptr"
; pRequest : AUTHZ_ACCESS_REQUEST* -> "sptr"
; hAuditEvent : AUTHZ_AUDIT_EVENT_HANDLE optional -> "sptr"
; pReply : AUTHZ_ACCESS_REPLY* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "AUTHZ.dll"
#cfunc global AuthzCachedAccessCheck "AuthzCachedAccessCheck" int, sptr, var, sptr, var
; res = AuthzCachedAccessCheck(Flags, hAccessCheckResults, pRequest, hAuditEvent, pReply)
; Flags : DWORD -> "int"
; hAccessCheckResults : AUTHZ_ACCESS_CHECK_RESULTS_HANDLE -> "sptr"
; pRequest : AUTHZ_ACCESS_REQUEST* -> "var"
; hAuditEvent : AUTHZ_AUDIT_EVENT_HANDLE optional -> "sptr"
; pReply : AUTHZ_ACCESS_REPLY* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "AUTHZ.dll"
#cfunc global AuthzCachedAccessCheck "AuthzCachedAccessCheck" int, sptr, sptr, sptr, sptr
; res = AuthzCachedAccessCheck(Flags, hAccessCheckResults, varptr(pRequest), hAuditEvent, varptr(pReply))
; Flags : DWORD -> "int"
; hAccessCheckResults : AUTHZ_ACCESS_CHECK_RESULTS_HANDLE -> "sptr"
; pRequest : AUTHZ_ACCESS_REQUEST* -> "sptr"
; hAuditEvent : AUTHZ_AUDIT_EVENT_HANDLE optional -> "sptr"
; pReply : AUTHZ_ACCESS_REPLY* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。