ホーム › Security › AddAuditAccessAceEx

AddAuditAccessAceEx

関数

継承フラグ付きでSACLに監査用ACEを追加する。

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

シグネチャ

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

BOOL AddAuditAccessAceEx(
    ACL* pAcl,
    ACE_REVISION dwAceRevision,
    ACE_FLAGS AceFlags,
    DWORD dwAccessMask,
    PSID pSid,
    BOOL bAuditSuccess,
    BOOL bAuditFailure
);

パラメーター

名前

型

方向

説明

pAcl

ACL*

inout

SACL へのポインター。AddAuditAccessAceEx 関数は、この SACL にシステム監査 ACE を追加します。ACE は SYSTEM_AUDIT_ACE 構造体の形式です。

dwAceRevision

ACE_REVISION

変更対象の SACL のリビジョンレベルを指定します。この値は ACL_REVISION または ACL_REVISION_DS を指定できます。SACL にオブジェクト固有の ACE が含まれる場合は ACL_REVISION_DS を使用します。

AceFlags

ACE_FLAGS

ACE の継承と監査するアクセス試行の種類を制御するビットフラグのセット。関数はこれらのフラグを新しい ACE の ACE_HEADER 構造体の AceFlags メンバーに設定します。このパラメーターには、次の値の組み合わせを指定できます。

値	意味
CONTAINER_INHERIT_ACE	ACE はコンテナーオブジェクトによって継承されます。
FAILED_ACCESS_ACE_FLAG	このフラグを設定するか、bAuditFailure パラメーターに TRUE を指定すると、指定したアクセス権の使用に失敗した試行により、システムはセキュリティイベントログに監査レコードを生成します。
INHERIT_ONLY_ACE	ACE は、アクセス制御リスト (ACL) が割り当てられているオブジェクトには適用されませんが、子オブジェクトによって継承される可能性があります。
INHERITED_ACE	継承された ACE を示します。このフラグにより、オブジェクトのツリーのセキュリティを変更する操作で、継承された ACE を変更できる一方、オブジェクトに直接適用された ACE は変更されません。
NO_PROPAGATE_INHERIT_ACE	OBJECT_INHERIT_ACE および CONTAINER_INHERIT_ACE ビットは、継承された ACE に伝播されません。
OBJECT_INHERIT_ACE	ACE は非コンテナーオブジェクトによって継承されます。
SUCCESSFUL_ACCESS_ACE_FLAG	このフラグを設定するか、bAuditSuccess パラメーターに TRUE を指定すると、指定したアクセス権の使用に成功したことにより、システムはセキュリティイベントログに監査レコードを生成します。

dwAccessMask

DWORD

ACCESS_MASK 形式を使用するビットフラグのセットで、新しい ACE が指定のセキュリティ識別子 (SID) について監査するアクセス権を指定します。

pSid

PSID

新しい ACE がアクセスを監査するユーザー、グループ、またはログオンセッションを識別する SID へのポインター。

bAuditSuccess

BOOL

指定したアクセス権の使用に成功した場合に、システムがセキュリティイベントログに監査レコードを生成するかどうかを指定します。このフラグが TRUE の場合、または AceFlags パラメーターで SUCCESSFUL_ACCESS_ACE_FLAG フラグを指定した場合、システムは成功したアクセス試行を記録します。それ以外の場合は記録しません。

bAuditFailure

BOOL

指定したアクセス権の使用に失敗した試行について、システムがセキュリティイベントログに監査レコードを生成するかどうかを指定します。このフラグが TRUE の場合、または AceFlags パラメーターで FAILED_ACCESS_ACE_FLAG フラグを指定した場合、システムは失敗したアクセス試行を記録します。それ以外の場合は記録しません。

戻り値の型: BOOL

公式ドキュメント

システム監査アクセス制御エントリ (ACE) をシステムアクセス制御リスト (SACL) の末尾に追加します。(AddAuditAccessAceEx)

戻り値

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

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

戻り値	説明
ERROR_ALLOTTED_SPACE_EXCEEDED	新しい ACE が ACL に収まりません。より大きな ACL バッファーが必要です。
ERROR_INVALID_ACL	指定した ACL が正しく形成されていません。
ERROR_INVALID_FLAGS	AceFlags パラメーターが無効です。
ERROR_INVALID_SID	指定した SID は構造的に無効です。
ERROR_REVISION_MISMATCH	指定したリビジョンが不明であるか、ACL のリビジョンと互換性がありません。
ERROR_SUCCESS	ACE が正常に追加されました。

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

各言語での呼び出し定義

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

BOOL AddAuditAccessAceEx(
    ACL* pAcl,
    ACE_REVISION dwAceRevision,
    ACE_FLAGS AceFlags,
    DWORD dwAccessMask,
    PSID pSid,
    BOOL bAuditSuccess,
    BOOL bAuditFailure
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool AddAuditAccessAceEx(
    IntPtr pAcl,   // ACL* in/out
    uint dwAceRevision,   // ACE_REVISION
    uint AceFlags,   // ACE_FLAGS
    uint dwAccessMask,   // DWORD
    IntPtr pSid,   // PSID
    bool bAuditSuccess,   // BOOL
    bool bAuditFailure   // BOOL
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AddAuditAccessAceEx(
    pAcl As IntPtr,   ' ACL* in/out
    dwAceRevision As UInteger,   ' ACE_REVISION
    AceFlags As UInteger,   ' ACE_FLAGS
    dwAccessMask As UInteger,   ' DWORD
    pSid As IntPtr,   ' PSID
    bAuditSuccess As Boolean,   ' BOOL
    bAuditFailure As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pAcl : ACL* in/out
' dwAceRevision : ACE_REVISION
' AceFlags : ACE_FLAGS
' dwAccessMask : DWORD
' pSid : PSID
' bAuditSuccess : BOOL
' bAuditFailure : BOOL
Declare PtrSafe Function AddAuditAccessAceEx Lib "advapi32" ( _
    ByVal pAcl As LongPtr, _
    ByVal dwAceRevision As Long, _
    ByVal AceFlags As Long, _
    ByVal dwAccessMask As Long, _
    ByVal pSid As LongPtr, _
    ByVal bAuditSuccess As Long, _
    ByVal bAuditFailure As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AddAuditAccessAceEx = ctypes.windll.advapi32.AddAuditAccessAceEx
AddAuditAccessAceEx.restype = wintypes.BOOL
AddAuditAccessAceEx.argtypes = [
    ctypes.c_void_p,  # pAcl : ACL* in/out
    wintypes.DWORD,  # dwAceRevision : ACE_REVISION
    wintypes.DWORD,  # AceFlags : ACE_FLAGS
    wintypes.DWORD,  # dwAccessMask : DWORD
    wintypes.HANDLE,  # pSid : PSID
    wintypes.BOOL,  # bAuditSuccess : BOOL
    wintypes.BOOL,  # bAuditFailure : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
AddAuditAccessAceEx = Fiddle::Function.new(
  lib['AddAuditAccessAceEx'],
  [
    Fiddle::TYPE_VOIDP,  # pAcl : ACL* in/out
    -Fiddle::TYPE_INT,  # dwAceRevision : ACE_REVISION
    -Fiddle::TYPE_INT,  # AceFlags : ACE_FLAGS
    -Fiddle::TYPE_INT,  # dwAccessMask : DWORD
    Fiddle::TYPE_VOIDP,  # pSid : PSID
    Fiddle::TYPE_INT,  # bAuditSuccess : BOOL
    Fiddle::TYPE_INT,  # bAuditFailure : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn AddAuditAccessAceEx(
        pAcl: *mut ACL,  // ACL* in/out
        dwAceRevision: u32,  // ACE_REVISION
        AceFlags: u32,  // ACE_FLAGS
        dwAccessMask: u32,  // DWORD
        pSid: *mut core::ffi::c_void,  // PSID
        bAuditSuccess: i32,  // BOOL
        bAuditFailure: i32  // BOOL
    ) -> 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 AddAuditAccessAceEx(IntPtr pAcl, uint dwAceRevision, uint AceFlags, uint dwAccessMask, IntPtr pSid, bool bAuditSuccess, bool bAuditFailure);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_AddAuditAccessAceEx' -Namespace Win32 -PassThru
# $api::AddAuditAccessAceEx(pAcl, dwAceRevision, AceFlags, dwAccessMask, pSid, bAuditSuccess, bAuditFailure)

#uselib "ADVAPI32.dll"
#func global AddAuditAccessAceEx "AddAuditAccessAceEx" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; AddAuditAccessAceEx varptr(pAcl), dwAceRevision, AceFlags, dwAccessMask, pSid, bAuditSuccess, bAuditFailure   ; 戻り値は stat
; pAcl : ACL* in/out -> "sptr"
; dwAceRevision : ACE_REVISION -> "sptr"
; AceFlags : ACE_FLAGS -> "sptr"
; dwAccessMask : DWORD -> "sptr"
; pSid : PSID -> "sptr"
; bAuditSuccess : BOOL -> "sptr"
; bAuditFailure : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global AddAuditAccessAceEx "AddAuditAccessAceEx" var, int, int, int, sptr, int, int
; res = AddAuditAccessAceEx(pAcl, dwAceRevision, AceFlags, dwAccessMask, pSid, bAuditSuccess, bAuditFailure)
; pAcl : ACL* in/out -> "var"
; dwAceRevision : ACE_REVISION -> "int"
; AceFlags : ACE_FLAGS -> "int"
; dwAccessMask : DWORD -> "int"
; pSid : PSID -> "sptr"
; bAuditSuccess : BOOL -> "int"
; bAuditFailure : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global AddAuditAccessAceEx "AddAuditAccessAceEx" sptr, int, int, int, sptr, int, int
; res = AddAuditAccessAceEx(varptr(pAcl), dwAceRevision, AceFlags, dwAccessMask, pSid, bAuditSuccess, bAuditFailure)
; pAcl : ACL* in/out -> "sptr"
; dwAceRevision : ACE_REVISION -> "int"
; AceFlags : ACE_FLAGS -> "int"
; dwAccessMask : DWORD -> "int"
; pSid : PSID -> "sptr"
; bAuditSuccess : BOOL -> "int"
; bAuditFailure : BOOL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。