ホーム › Security › AddAccessAllowedObjectAce

AddAccessAllowedObjectAce

関数

ACLにオブジェクト型のアクセス許可ACEを追加する。

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

pAcl

ACL*

inout

DACL へのポインターです。AddAccessAllowedObjectAce 関数は、この DACL の末尾にアクセス許可の ACE を追加します。ACE は ACCESS_ALLOWED_OBJECT_ACE 構造体の形式です。

dwAceRevision

ACE_REVISION

変更対象の DACL のリビジョンレベルを指定します。この値は ACL_REVISION_DS でなければなりません。DACL のリビジョンレベルが ACL_REVISION_DS より低い場合、関数はこれを ACL_REVISION_DS に変更します。

AceFlags

ACE_FLAGS

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

値	意味
CONTAINER_INHERIT_ACE	ACE はコンテナーオブジェクトに継承されます。
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 は非コンテナーオブジェクトに継承されます。

AccessMask

DWORD

ACCESS_MASK 形式を使用するビットフラグのセットです。これらのフラグは、新しい ACE が指定されたセキュリティ識別子 (SID) に対して許可するアクセス権を指定します。

ObjectTypeGuid

GUID*

inoptional

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

InheritedObjectTypeGuid

GUID*

inoptional

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

pSid

PSID

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

戻り値の型: BOOL

公式ドキュメント

アクセス許可のアクセス制御エントリ (ACE) を、随意アクセス制御リスト (DACL) の末尾に追加します。(AddAccessAllowedObjectAce)

戻り値

関数が成功した場合、戻り値は 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 の場合は、AddAccessAllowedObjectAce ではなく AddAccessAllowedAceEx 関数を使用してください。これは、 ACCESS_ALLOWED_ACE の方が ACCESS_ALLOWED_OBJECT_ACE よりも小さく効率的であるためです。

呼び出し元は、ACE が正しい順序で DACL に追加されるようにする必要があります。詳細については、 Order of ACEs in a DACL を参照してください。

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

各言語での呼び出し定義

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

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

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool AddAccessAllowedObjectAce(
    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
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AddAccessAllowedObjectAce(
    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
) 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
Declare PtrSafe Function AddAccessAllowedObjectAce 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) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AddAccessAllowedObjectAce = ctypes.windll.advapi32.AddAccessAllowedObjectAce
AddAccessAllowedObjectAce.restype = wintypes.BOOL
AddAccessAllowedObjectAce.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
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
AddAccessAllowedObjectAce = Fiddle::Function.new(
  lib['AddAccessAllowedObjectAce'],
  [
    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)

#[link(name = "advapi32")]
extern "system" {
    fn AddAccessAllowedObjectAce(
        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
    ) -> 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 AddAccessAllowedObjectAce(IntPtr pAcl, uint dwAceRevision, uint AceFlags, uint AccessMask, IntPtr ObjectTypeGuid, IntPtr InheritedObjectTypeGuid, IntPtr pSid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_AddAccessAllowedObjectAce' -Namespace Win32 -PassThru
# $api::AddAccessAllowedObjectAce(pAcl, dwAceRevision, AceFlags, AccessMask, ObjectTypeGuid, InheritedObjectTypeGuid, pSid)

#uselib "ADVAPI32.dll"
#func global AddAccessAllowedObjectAce "AddAccessAllowedObjectAce" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; AddAccessAllowedObjectAce varptr(pAcl), dwAceRevision, AceFlags, AccessMask, varptr(ObjectTypeGuid), varptr(InheritedObjectTypeGuid), pSid   ; 戻り値は 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"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global AddAccessAllowedObjectAce "AddAccessAllowedObjectAce" var, int, int, int, var, var, sptr
; res = AddAccessAllowedObjectAce(pAcl, dwAceRevision, AceFlags, AccessMask, ObjectTypeGuid, InheritedObjectTypeGuid, pSid)
; 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"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global AddAccessAllowedObjectAce "AddAccessAllowedObjectAce" sptr, int, int, int, sptr, sptr, sptr
; res = AddAccessAllowedObjectAce(varptr(pAcl), dwAceRevision, AceFlags, AccessMask, varptr(ObjectTypeGuid), varptr(InheritedObjectTypeGuid), pSid)
; 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"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。