ホーム › Security › AddAccessAllowedAce

AddAccessAllowedAce

関数

ACLにアクセス許可ACEを追加する。

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

シグネチャ

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

BOOL AddAccessAllowedAce(
    ACL* pAcl,
    ACE_REVISION dwAceRevision,
    DWORD AccessMask,
    PSID pSid
);

パラメーター

名前	型	方向	説明
pAcl	ACL*	inout	ACL へのポインターです。この関数は、この ACL の末尾にアクセス許可型 ACE を追加します。この ACE は ACCESS_ALLOWED_ACE 構造体の形式です。
dwAceRevision	ACE_REVISION	in	変更対象の ACL のリビジョンレベルを指定します。この値には ACL_REVISION または ACL_REVISION_DS を指定できます。ACL にオブジェクト固有の ACE が含まれる場合は ACL_REVISION_DS を使用します。
AccessMask	DWORD	in	指定された SID に許可するアクセス権のマスクを指定します。
pSid	PSID	in	アクセスを許可するユーザー、グループ、またはログオンアカウントを表す SID へのポインターです。

戻り値の型: BOOL

公式ドキュメント

アクセス制御リスト (ACL) にアクセス許可型のアクセス制御エントリ (ACE) を追加します。アクセスは、指定されたセキュリティ識別子 (SID) に対して許可されます。

戻り値

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

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

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

解説(Remarks)

ACL へのアクセス許可型 ACE の追加は、最も一般的な ACL 変更の形態です。

AddAccessAllowedAce 関数と AddAccessDeniedAce 関数は、ACL の ACE リストの末尾に新しい ACE を追加します。これらの関数は、新しい ACE を適切な正規順序に自動的に配置しません。ACE を適切な順序で追加することにより ACL が正規順序になっていることを保証するのは、呼び出し側の責任です。

AddAccessAllowedAce 関数によって ACE に配置される ACE_HEADER 構造体は、種類とサイズを指定しますが、継承や 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 AddAccessAllowedAce(
    ACL* pAcl,
    ACE_REVISION dwAceRevision,
    DWORD AccessMask,
    PSID pSid
);

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

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

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

import ctypes
from ctypes import wintypes

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

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

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

出力引数:

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