ホーム › Security › AddConditionalAce

AddConditionalAce

関数

ACLに条件式付きのアクセス制御エントリを追加する。

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

シグネチャ

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

BOOL AddConditionalAce(
    ACL* pAcl,
    ACE_REVISION dwAceRevision,
    ACE_FLAGS AceFlags,
    BYTE AceType,
    DWORD AccessMask,
    PSID pSid,
    LPWSTR ConditionStr,
    DWORD* ReturnLength
);

パラメーター

名前

型

方向

説明

pAcl

ACL*

inout

ACL へのポインター。この関数は、この ACL に ACE を追加します。

このパラメーターの値を NULL にすることはできません。

dwAceRevision

ACE_REVISION

変更対象の ACL のリビジョンレベルを指定します。この値には ACL_REVISION または ACL_REVISION_DS を指定できます。 ACL にオブジェクト固有の ACE が含まれている場合は 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 は非コンテナーオブジェクトに継承されます。

AceType

BYTE

ACE の種類です。

次のいずれかの値を指定できます。

値	意味
ACCESS_ALLOWED_CALLBACK_ACE_TYPE 0x9	ACCESS_ALLOWED_CALLBACK_ACE 構造体を使用する、アクセス許可コールバック ACE です。
ACCESS_DENIED_CALLBACK_ACE_TYPE 0xA	ACCESS_DENIED_CALLBACK_ACE 構造体を使用する、アクセス拒否コールバック ACE です。
SYSTEM_AUDIT_CALLBACK_ACE_TYPE 0xD	SYSTEM_AUDIT_CALLBACK_ACE 構造体を使用する、システム監査コールバック ACE です。

AccessMask

DWORD

指定した SID に付与するアクセス権のマスクを指定します。

pSid

PSID

アクセスを許可される対象のユーザー、グループ、またはログオンアカウントを表す SID へのポインター。

ConditionStr

LPWSTR

この ACE に対して評価される条件文を指定する文字列です。

ReturnLength

DWORD*

out

ACL のサイズ (バイト単位)。pACL パラメーターで指定したバッファーのサイズが不足している場合、このパラメーターの値は必要なサイズを示します。

戻り値の型: BOOL

公式ドキュメント

指定したアクセス制御リスト (ACL) に条件付きアクセス制御エントリ (ACE) を追加します。

戻り値

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

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

戻り値	説明
ERROR_INSUFFICIENT_BUFFER	新しい ACE が pAcl バッファーに収まりません。

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

各言語での呼び出し定義

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

BOOL AddConditionalAce(
    ACL* pAcl,
    ACE_REVISION dwAceRevision,
    ACE_FLAGS AceFlags,
    BYTE AceType,
    DWORD AccessMask,
    PSID pSid,
    LPWSTR ConditionStr,
    DWORD* ReturnLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool AddConditionalAce(
    IntPtr pAcl,   // ACL* in/out
    uint dwAceRevision,   // ACE_REVISION
    uint AceFlags,   // ACE_FLAGS
    byte AceType,   // BYTE
    uint AccessMask,   // DWORD
    IntPtr pSid,   // PSID
    [MarshalAs(UnmanagedType.LPWStr)] string ConditionStr,   // LPWSTR
    out uint ReturnLength   // DWORD* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AddConditionalAce(
    pAcl As IntPtr,   ' ACL* in/out
    dwAceRevision As UInteger,   ' ACE_REVISION
    AceFlags As UInteger,   ' ACE_FLAGS
    AceType As Byte,   ' BYTE
    AccessMask As UInteger,   ' DWORD
    pSid As IntPtr,   ' PSID
    <MarshalAs(UnmanagedType.LPWStr)> ConditionStr As String,   ' LPWSTR
    <Out> ByRef ReturnLength As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pAcl : ACL* in/out
' dwAceRevision : ACE_REVISION
' AceFlags : ACE_FLAGS
' AceType : BYTE
' AccessMask : DWORD
' pSid : PSID
' ConditionStr : LPWSTR
' ReturnLength : DWORD* out
Declare PtrSafe Function AddConditionalAce Lib "advapi32" ( _
    ByVal pAcl As LongPtr, _
    ByVal dwAceRevision As Long, _
    ByVal AceFlags As Long, _
    ByVal AceType As Byte, _
    ByVal AccessMask As Long, _
    ByVal pSid As LongPtr, _
    ByVal ConditionStr As LongPtr, _
    ByRef ReturnLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AddConditionalAce = ctypes.windll.advapi32.AddConditionalAce
AddConditionalAce.restype = wintypes.BOOL
AddConditionalAce.argtypes = [
    ctypes.c_void_p,  # pAcl : ACL* in/out
    wintypes.DWORD,  # dwAceRevision : ACE_REVISION
    wintypes.DWORD,  # AceFlags : ACE_FLAGS
    ctypes.c_ubyte,  # AceType : BYTE
    wintypes.DWORD,  # AccessMask : DWORD
    wintypes.HANDLE,  # pSid : PSID
    wintypes.LPCWSTR,  # ConditionStr : LPWSTR
    ctypes.POINTER(wintypes.DWORD),  # ReturnLength : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
AddConditionalAce = Fiddle::Function.new(
  lib['AddConditionalAce'],
  [
    Fiddle::TYPE_VOIDP,  # pAcl : ACL* in/out
    -Fiddle::TYPE_INT,  # dwAceRevision : ACE_REVISION
    -Fiddle::TYPE_INT,  # AceFlags : ACE_FLAGS
    -Fiddle::TYPE_CHAR,  # AceType : BYTE
    -Fiddle::TYPE_INT,  # AccessMask : DWORD
    Fiddle::TYPE_VOIDP,  # pSid : PSID
    Fiddle::TYPE_VOIDP,  # ConditionStr : LPWSTR
    Fiddle::TYPE_VOIDP,  # ReturnLength : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn AddConditionalAce(
        pAcl: *mut ACL,  // ACL* in/out
        dwAceRevision: u32,  // ACE_REVISION
        AceFlags: u32,  // ACE_FLAGS
        AceType: u8,  // BYTE
        AccessMask: u32,  // DWORD
        pSid: *mut core::ffi::c_void,  // PSID
        ConditionStr: *mut u16,  // LPWSTR
        ReturnLength: *mut u32  // DWORD* out
    ) -> 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 AddConditionalAce(IntPtr pAcl, uint dwAceRevision, uint AceFlags, byte AceType, uint AccessMask, IntPtr pSid, [MarshalAs(UnmanagedType.LPWStr)] string ConditionStr, out uint ReturnLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_AddConditionalAce' -Namespace Win32 -PassThru
# $api::AddConditionalAce(pAcl, dwAceRevision, AceFlags, AceType, AccessMask, pSid, ConditionStr, ReturnLength)

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

出力引数:

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