ホーム › Security › AddAuditAccessObjectAce

AddAuditAccessObjectAce

関数

SACLにオブジェクト型の監査用ACEを追加する。

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

シグネチャ

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

BOOL AddAuditAccessObjectAce(
    ACL* pAcl,
    ACE_REVISION dwAceRevision,
    ACE_FLAGS AceFlags,
    DWORD AccessMask,
    GUID* ObjectTypeGuid,   // optional
    GUID* InheritedObjectTypeGuid,   // optional
    PSID pSid,
    BOOL bAuditSuccess,
    BOOL bAuditFailure
);

パラメーター

名前

型

方向

説明

pAcl

ACL*

inout

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

dwAceRevision

ACE_REVISION

変更する SACL のリビジョンレベルを指定します。この値は ACL_REVISION_DS でなければなりません。SACL のリビジョンレベルが ACL_REVISION_DS より低い場合、関数はそれを 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 を指定すると、指定したアクセス権の使用に成功したときに、システムがセキュリティイベントログに監査レコードを生成します。

AccessMask

DWORD

新しい ACE が指定したセキュリティ識別子 (SID) に対して監査するアクセス権を指定する ACCESS_MASK です。

ObjectTypeGuid

GUID*

inoptional

新しい ACE によって保護されるオブジェクト、プロパティセット、またはプロパティの種類を識別する GUID 構造体へのポインターです。このパラメーターが NULL の場合、新しい ACE は ACL が割り当てられているオブジェクトを保護します。

InheritedObjectTypeGuid

GUID*

inoptional

新しい ACE を継承できるオブジェクトの種類を識別する GUID 構造体へのポインターです。このパラメーターが NULL 以外の場合、指定したオブジェクトの種類のみが ACE を継承できます。NULL の場合は、任意の種類の子オブジェクトが ACE を継承できます。いずれの場合も、継承は AceFlags パラメーターの値、および子オブジェクトに設定された継承防止によっても制御されます。

pSid

PSID

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

bAuditSuccess

BOOL

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

bAuditFailure

BOOL

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功すると、戻り値は 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 が正常に追加されました。

解説(Remarks)

ObjectTypeGuid と InheritedObjectTypeGuid の両方が NULL の場合は、AddAuditAccessObjectAce ではなく AddAuditAccessAceEx 関数を使用してください。これは、 SYSTEM_AUDIT_ACE の方が SYSTEM_AUDIT_OBJECT_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 AddAuditAccessObjectAce(
    ACL* pAcl,
    ACE_REVISION dwAceRevision,
    ACE_FLAGS AceFlags,
    DWORD AccessMask,
    GUID* ObjectTypeGuid,   // optional
    GUID* InheritedObjectTypeGuid,   // optional
    PSID pSid,
    BOOL bAuditSuccess,
    BOOL bAuditFailure
);

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

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AddAuditAccessObjectAce(
    pAcl As IntPtr,   ' ACL* in/out
    dwAceRevision As UInteger,   ' ACE_REVISION
    AceFlags As UInteger,   ' ACE_FLAGS
    AccessMask As UInteger,   ' DWORD
    ObjectTypeGuid As IntPtr,   ' GUID* optional
    InheritedObjectTypeGuid As IntPtr,   ' GUID* optional
    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
' AccessMask : DWORD
' ObjectTypeGuid : GUID* optional
' InheritedObjectTypeGuid : GUID* optional
' pSid : PSID
' bAuditSuccess : BOOL
' bAuditFailure : BOOL
Declare PtrSafe Function AddAuditAccessObjectAce Lib "advapi32" ( _
    ByVal pAcl As LongPtr, _
    ByVal dwAceRevision As Long, _
    ByVal AceFlags As Long, _
    ByVal AccessMask As Long, _
    ByVal ObjectTypeGuid As LongPtr, _
    ByVal InheritedObjectTypeGuid As LongPtr, _
    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

AddAuditAccessObjectAce = ctypes.windll.advapi32.AddAuditAccessObjectAce
AddAuditAccessObjectAce.restype = wintypes.BOOL
AddAuditAccessObjectAce.argtypes = [
    ctypes.c_void_p,  # pAcl : ACL* in/out
    wintypes.DWORD,  # dwAceRevision : ACE_REVISION
    wintypes.DWORD,  # AceFlags : ACE_FLAGS
    wintypes.DWORD,  # AccessMask : DWORD
    ctypes.c_void_p,  # ObjectTypeGuid : GUID* optional
    ctypes.c_void_p,  # InheritedObjectTypeGuid : GUID* optional
    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')
AddAuditAccessObjectAce = Fiddle::Function.new(
  lib['AddAuditAccessObjectAce'],
  [
    Fiddle::TYPE_VOIDP,  # pAcl : ACL* in/out
    -Fiddle::TYPE_INT,  # dwAceRevision : ACE_REVISION
    -Fiddle::TYPE_INT,  # AceFlags : ACE_FLAGS
    -Fiddle::TYPE_INT,  # AccessMask : DWORD
    Fiddle::TYPE_VOIDP,  # ObjectTypeGuid : GUID* optional
    Fiddle::TYPE_VOIDP,  # InheritedObjectTypeGuid : GUID* optional
    Fiddle::TYPE_VOIDP,  # pSid : PSID
    Fiddle::TYPE_INT,  # bAuditSuccess : BOOL
    Fiddle::TYPE_INT,  # bAuditFailure : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn AddAuditAccessObjectAce(
        pAcl: *mut ACL,  // ACL* in/out
        dwAceRevision: u32,  // ACE_REVISION
        AceFlags: u32,  // ACE_FLAGS
        AccessMask: u32,  // DWORD
        ObjectTypeGuid: *mut GUID,  // GUID* optional
        InheritedObjectTypeGuid: *mut GUID,  // GUID* optional
        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 AddAuditAccessObjectAce(IntPtr pAcl, uint dwAceRevision, uint AceFlags, uint AccessMask, IntPtr ObjectTypeGuid, IntPtr InheritedObjectTypeGuid, IntPtr pSid, bool bAuditSuccess, bool bAuditFailure);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_AddAuditAccessObjectAce' -Namespace Win32 -PassThru
# $api::AddAuditAccessObjectAce(pAcl, dwAceRevision, AceFlags, AccessMask, ObjectTypeGuid, InheritedObjectTypeGuid, pSid, bAuditSuccess, bAuditFailure)

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

出力引数:

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