ホーム › Security › ObjectOpenAuditAlarmA

ObjectOpenAuditAlarmA

関数

オブジェクトを開く際に監査アラームを生成する(ANSI版)。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL ObjectOpenAuditAlarmA(
    LPCSTR SubsystemName,
    void* HandleId,
    LPSTR ObjectTypeName,
    LPSTR ObjectName,   // optional
    PSECURITY_DESCRIPTOR pSecurityDescriptor,
    HANDLE ClientToken,
    DWORD DesiredAccess,
    DWORD GrantedAccess,
    PRIVILEGE_SET* Privileges,   // optional
    BOOL ObjectCreation,
    BOOL AccessGranted,
    BOOL* GenerateOnClose
);

パラメーター

名前	型	方向	説明
SubsystemName	LPCSTR	in	この関数を呼び出すサブシステムの名前を指定する null 終端文字列へのポインターです。この文字列は、関数が生成するすべての監査メッセージに表示されます。
HandleId	void*	in	オブジェクトに対するクライアントのハンドルを表す一意の値へのポインターです。アクセスが拒否された場合、このパラメーターは無視されます。クロスプラットフォームの互換性のため、このポインターが指す値は sizeof(LPVOID) バイトの長さでなければなりません。
ObjectTypeName	LPSTR	in	クライアントがアクセスを要求しているオブジェクトの種類を指定する null 終端文字列へのポインターです。この文字列は、関数が生成するすべての監査メッセージに表示されます。
ObjectName	LPSTR	inoptional	クライアントがアクセスを要求しているオブジェクトの名前を指定する null 終端文字列へのポインターです。この文字列は、関数が生成するすべての監査メッセージに表示されます。
pSecurityDescriptor	PSECURITY_DESCRIPTOR	in	アクセス対象のオブジェクトの SECURITY_DESCRIPTOR 構造体へのポインターです。
ClientToken	HANDLE	in	操作を要求しているクライアントを表すアクセストークンを識別します。このハンドルは、クライアントを偽装しているスレッドのトークンを開くことで取得する必要があります。トークンは TOKEN_QUERY アクセスで開かれている必要があります。
DesiredAccess	DWORD	in	要求するアクセスマスクを指定します。このマスクは、事前に MapGenericMask 関数によってマップされ、汎用アクセス権を含まないようにしておく必要があります。
GrantedAccess	DWORD	in	付与されるアクセス権を示すアクセスマスクを指定します。このアクセスマスクは、いずれかのアクセスチェック関数が GrantedAccess パラメーターに設定したものと同じ値であることが想定されています。アクセスチェック関数の例としては、AccessCheckAndAuditAlarm や AccessCheck があります。
Privileges	PRIVILEGE_SET*	inoptional	アクセス試行に必要な特権のセットを指定する PRIVILEGE_SET 構造体へのポインターです。このパラメーターは NULL にすることができます。
ObjectCreation	BOOL	in	アクセスが許可されたときにアプリケーションが新しいオブジェクトを作成するかどうかを決定するフラグを指定します。この値が TRUE の場合、アプリケーションは新しいオブジェクトを作成します。FALSE の場合、アプリケーションは既存のオブジェクトを開きます。
AccessGranted	BOOL	in	AccessCheck などのアクセスチェック関数の以前の呼び出しでアクセスが許可されたか拒否されたかを示すフラグを指定します。アクセスが許可された場合、この値は TRUE です。許可されなかった場合は FALSE です。
GenerateOnClose	BOOL*	out	関数が戻るときに監査生成ルーチンによって設定されるフラグへのポインターです。この値は、オブジェクトハンドルを閉じるときに ObjectCloseAuditAlarm 関数に渡す必要があります。

戻り値の型: BOOL

公式ドキュメント

クライアントアプリケーションがオブジェクトへのアクセスを試みたとき、または新しいオブジェクトの作成を試みたときに、監査メッセージを生成します。(ObjectOpenAuditAlarmA)

戻り値

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

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

解説(Remarks)

ObjectOpenAuditAlarm 関数では、呼び出し側のアプリケーションで SE_AUDIT_NAME 特権が有効になっている必要があります。この特権のテストは常に、スレッドの偽装トークンではなく、呼び出し側のプロセスのプライマリトークンに対して実行されます。これにより、呼び出し側のプロセスは呼び出し中にクライアントを偽装できます。

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL ObjectOpenAuditAlarmA(
    LPCSTR SubsystemName,
    void* HandleId,
    LPSTR ObjectTypeName,
    LPSTR ObjectName,   // optional
    PSECURITY_DESCRIPTOR pSecurityDescriptor,
    HANDLE ClientToken,
    DWORD DesiredAccess,
    DWORD GrantedAccess,
    PRIVILEGE_SET* Privileges,   // optional
    BOOL ObjectCreation,
    BOOL AccessGranted,
    BOOL* GenerateOnClose
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool ObjectOpenAuditAlarmA(
    [MarshalAs(UnmanagedType.LPStr)] string SubsystemName,   // LPCSTR
    IntPtr HandleId,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string ObjectTypeName,   // LPSTR
    [MarshalAs(UnmanagedType.LPStr)] string ObjectName,   // LPSTR optional
    IntPtr pSecurityDescriptor,   // PSECURITY_DESCRIPTOR
    IntPtr ClientToken,   // HANDLE
    uint DesiredAccess,   // DWORD
    uint GrantedAccess,   // DWORD
    IntPtr Privileges,   // PRIVILEGE_SET* optional
    bool ObjectCreation,   // BOOL
    bool AccessGranted,   // BOOL
    out bool GenerateOnClose   // BOOL* out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ObjectOpenAuditAlarmA(
    <MarshalAs(UnmanagedType.LPStr)> SubsystemName As String,   ' LPCSTR
    HandleId As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> ObjectTypeName As String,   ' LPSTR
    <MarshalAs(UnmanagedType.LPStr)> ObjectName As String,   ' LPSTR optional
    pSecurityDescriptor As IntPtr,   ' PSECURITY_DESCRIPTOR
    ClientToken As IntPtr,   ' HANDLE
    DesiredAccess As UInteger,   ' DWORD
    GrantedAccess As UInteger,   ' DWORD
    Privileges As IntPtr,   ' PRIVILEGE_SET* optional
    ObjectCreation As Boolean,   ' BOOL
    AccessGranted As Boolean,   ' BOOL
    <Out> ByRef GenerateOnClose As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' SubsystemName : LPCSTR
' HandleId : void*
' ObjectTypeName : LPSTR
' ObjectName : LPSTR optional
' pSecurityDescriptor : PSECURITY_DESCRIPTOR
' ClientToken : HANDLE
' DesiredAccess : DWORD
' GrantedAccess : DWORD
' Privileges : PRIVILEGE_SET* optional
' ObjectCreation : BOOL
' AccessGranted : BOOL
' GenerateOnClose : BOOL* out
Declare PtrSafe Function ObjectOpenAuditAlarmA Lib "advapi32" ( _
    ByVal SubsystemName As String, _
    ByVal HandleId As LongPtr, _
    ByVal ObjectTypeName As String, _
    ByVal ObjectName As String, _
    ByVal pSecurityDescriptor As LongPtr, _
    ByVal ClientToken As LongPtr, _
    ByVal DesiredAccess As Long, _
    ByVal GrantedAccess As Long, _
    ByVal Privileges As LongPtr, _
    ByVal ObjectCreation As Long, _
    ByVal AccessGranted As Long, _
    ByRef GenerateOnClose As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ObjectOpenAuditAlarmA = ctypes.windll.advapi32.ObjectOpenAuditAlarmA
ObjectOpenAuditAlarmA.restype = wintypes.BOOL
ObjectOpenAuditAlarmA.argtypes = [
    wintypes.LPCSTR,  # SubsystemName : LPCSTR
    ctypes.POINTER(None),  # HandleId : void*
    wintypes.LPCSTR,  # ObjectTypeName : LPSTR
    wintypes.LPCSTR,  # ObjectName : LPSTR optional
    wintypes.HANDLE,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR
    wintypes.HANDLE,  # ClientToken : HANDLE
    wintypes.DWORD,  # DesiredAccess : DWORD
    wintypes.DWORD,  # GrantedAccess : DWORD
    ctypes.c_void_p,  # Privileges : PRIVILEGE_SET* optional
    wintypes.BOOL,  # ObjectCreation : BOOL
    wintypes.BOOL,  # AccessGranted : BOOL
    ctypes.c_void_p,  # GenerateOnClose : BOOL* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
ObjectOpenAuditAlarmA = Fiddle::Function.new(
  lib['ObjectOpenAuditAlarmA'],
  [
    Fiddle::TYPE_VOIDP,  # SubsystemName : LPCSTR
    Fiddle::TYPE_VOIDP,  # HandleId : void*
    Fiddle::TYPE_VOIDP,  # ObjectTypeName : LPSTR
    Fiddle::TYPE_VOIDP,  # ObjectName : LPSTR optional
    Fiddle::TYPE_VOIDP,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR
    Fiddle::TYPE_VOIDP,  # ClientToken : HANDLE
    -Fiddle::TYPE_INT,  # DesiredAccess : DWORD
    -Fiddle::TYPE_INT,  # GrantedAccess : DWORD
    Fiddle::TYPE_VOIDP,  # Privileges : PRIVILEGE_SET* optional
    Fiddle::TYPE_INT,  # ObjectCreation : BOOL
    Fiddle::TYPE_INT,  # AccessGranted : BOOL
    Fiddle::TYPE_VOIDP,  # GenerateOnClose : BOOL* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn ObjectOpenAuditAlarmA(
        SubsystemName: *const u8,  // LPCSTR
        HandleId: *mut (),  // void*
        ObjectTypeName: *mut u8,  // LPSTR
        ObjectName: *mut u8,  // LPSTR optional
        pSecurityDescriptor: *mut core::ffi::c_void,  // PSECURITY_DESCRIPTOR
        ClientToken: *mut core::ffi::c_void,  // HANDLE
        DesiredAccess: u32,  // DWORD
        GrantedAccess: u32,  // DWORD
        Privileges: *mut PRIVILEGE_SET,  // PRIVILEGE_SET* optional
        ObjectCreation: i32,  // BOOL
        AccessGranted: i32,  // BOOL
        GenerateOnClose: *mut i32  // BOOL* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool ObjectOpenAuditAlarmA([MarshalAs(UnmanagedType.LPStr)] string SubsystemName, IntPtr HandleId, [MarshalAs(UnmanagedType.LPStr)] string ObjectTypeName, [MarshalAs(UnmanagedType.LPStr)] string ObjectName, IntPtr pSecurityDescriptor, IntPtr ClientToken, uint DesiredAccess, uint GrantedAccess, IntPtr Privileges, bool ObjectCreation, bool AccessGranted, out bool GenerateOnClose);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_ObjectOpenAuditAlarmA' -Namespace Win32 -PassThru
# $api::ObjectOpenAuditAlarmA(SubsystemName, HandleId, ObjectTypeName, ObjectName, pSecurityDescriptor, ClientToken, DesiredAccess, GrantedAccess, Privileges, ObjectCreation, AccessGranted, GenerateOnClose)

#uselib "ADVAPI32.dll"
#func global ObjectOpenAuditAlarmA "ObjectOpenAuditAlarmA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ObjectOpenAuditAlarmA SubsystemName, HandleId, ObjectTypeName, ObjectName, pSecurityDescriptor, ClientToken, DesiredAccess, GrantedAccess, varptr(Privileges), ObjectCreation, AccessGranted, varptr(GenerateOnClose)   ; 戻り値は stat
; SubsystemName : LPCSTR -> "sptr"
; HandleId : void* -> "sptr"
; ObjectTypeName : LPSTR -> "sptr"
; ObjectName : LPSTR optional -> "sptr"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; ClientToken : HANDLE -> "sptr"
; DesiredAccess : DWORD -> "sptr"
; GrantedAccess : DWORD -> "sptr"
; Privileges : PRIVILEGE_SET* optional -> "sptr"
; ObjectCreation : BOOL -> "sptr"
; AccessGranted : BOOL -> "sptr"
; GenerateOnClose : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global ObjectOpenAuditAlarmA "ObjectOpenAuditAlarmA" str, sptr, str, str, sptr, sptr, int, int, var, int, int, var
; res = ObjectOpenAuditAlarmA(SubsystemName, HandleId, ObjectTypeName, ObjectName, pSecurityDescriptor, ClientToken, DesiredAccess, GrantedAccess, Privileges, ObjectCreation, AccessGranted, GenerateOnClose)
; SubsystemName : LPCSTR -> "str"
; HandleId : void* -> "sptr"
; ObjectTypeName : LPSTR -> "str"
; ObjectName : LPSTR optional -> "str"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; ClientToken : HANDLE -> "sptr"
; DesiredAccess : DWORD -> "int"
; GrantedAccess : DWORD -> "int"
; Privileges : PRIVILEGE_SET* optional -> "var"
; ObjectCreation : BOOL -> "int"
; AccessGranted : BOOL -> "int"
; GenerateOnClose : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global ObjectOpenAuditAlarmA "ObjectOpenAuditAlarmA" str, sptr, str, str, sptr, sptr, int, int, sptr, int, int, sptr
; res = ObjectOpenAuditAlarmA(SubsystemName, HandleId, ObjectTypeName, ObjectName, pSecurityDescriptor, ClientToken, DesiredAccess, GrantedAccess, varptr(Privileges), ObjectCreation, AccessGranted, varptr(GenerateOnClose))
; SubsystemName : LPCSTR -> "str"
; HandleId : void* -> "sptr"
; ObjectTypeName : LPSTR -> "str"
; ObjectName : LPSTR optional -> "str"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; ClientToken : HANDLE -> "sptr"
; DesiredAccess : DWORD -> "int"
; GrantedAccess : DWORD -> "int"
; Privileges : PRIVILEGE_SET* optional -> "sptr"
; ObjectCreation : BOOL -> "int"
; AccessGranted : BOOL -> "int"
; GenerateOnClose : BOOL* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。