ホーム › Security.Authorization › BuildSecurityDescriptorW

BuildSecurityDescriptorW

関数

所有者やアクセスエントリから新しいセキュリティ記述子を構築する(Unicode版)。

DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR BuildSecurityDescriptorW(
    TRUSTEE_W* pOwner,   // optional
    TRUSTEE_W* pGroup,   // optional
    DWORD cCountOfAccessEntries,
    EXPLICIT_ACCESS_W* pListOfAccessEntries,   // optional
    DWORD cCountOfAuditEntries,
    EXPLICIT_ACCESS_W* pListOfAuditEntries,   // optional
    PSECURITY_DESCRIPTOR pOldSD,   // optional
    DWORD* pSizeNewSD,
    PSECURITY_DESCRIPTOR* pNewSD
);

パラメーター

名前	型	方向	説明
pOwner	TRUSTEE_W*	inoptional	新しいセキュリティ記述子の所有者を識別する TRUSTEE 構造体へのポインターです。この構造体が TRUSTEE_IS_NAME 形式を使用している場合、BuildSecurityDescriptor は指定されたトラスティ名に関連付けられたセキュリティ識別子 (SID) を検索します。このパラメーターが NULL の場合、関数は pOldSD が指す元のセキュリティ記述子の所有者 SID を使用します。pOldSD が NULL の場合、または pOldSD の所有者 SID が NULL の場合、新しいセキュリティ記述子の所有者 SID は NULL になります。
pGroup	TRUSTEE_W*	inoptional	新しいセキュリティ記述子のプライマリグループ SID を識別する TRUSTEE 構造体へのポインターです。この構造体が TRUSTEE_IS_NAME 形式を使用している場合、BuildSecurityDescriptor は指定されたトラスティ名に関連付けられた SID を検索します。このパラメーターが NULL の場合、関数は pOldSD が指す元のセキュリティ記述子のグループ SID を使用します。pOldSD が NULL の場合、または pOldSD のグループ SID が NULL の場合、新しいセキュリティ記述子のグループ SID は NULL になります。
cCountOfAccessEntries	DWORD	in	pListOfAccessEntries 配列に含まれる EXPLICIT_ACCESS 構造体の数です。
pListOfAccessEntries	EXPLICIT_ACCESS_W*	inoptional	新しいセキュリティ記述子の任意アクセス制御リスト (DACL) に対するアクセス制御情報を記述した EXPLICIT_ACCESS 構造体の配列へのポインターです。関数は、この配列の情報を pOldSD の DACL (存在する場合) とマージして新しい DACL を作成します。pOldSD が NULL の場合、または pOldSD の DACL が NULL の場合、関数は配列内の情報のみに基づいて新しい DACL を作成します。EXPLICIT_ACCESS 構造体の配列から ACL を作成する際の規則については、 SetEntriesInAcl 関数を参照してください。 pListOfAccessEntries が NULL の場合、新しいセキュリティ記述子は pOldSD から DACL を取得します。この場合、pOldSD が NULL の場合、または pOldSD の DACL が NULL の場合、新しい DACL は NULL になります。
cCountOfAuditEntries	DWORD	in	pListOfAuditEntries 配列に含まれる EXPLICIT_ACCESS 構造体の数です。
pListOfAuditEntries	EXPLICIT_ACCESS_W*	inoptional	新しいセキュリティ記述子の SACL に対する監査制御情報を記述した EXPLICIT_ACCESS 構造体の配列へのポインターです。関数は、この配列の情報を pOldSD の SACL (存在する場合) とマージして新しい SACL を作成します。pOldSD が NULL の場合、または pOldSD の SACL が NULL の場合、関数は配列内の情報のみに基づいて新しい SACL を作成します。 pListOfAuditEntries が NULL の場合、新しいセキュリティ記述子は pOldSD から SACL を取得します。この場合、pOldSD が NULL の場合、または pOldSD の SACL が NULL の場合、新しい SACL は NULL になります。
pOldSD	PSECURITY_DESCRIPTOR	inoptional	既存の自己相対形式の SECURITY_DESCRIPTOR 構造体およびそれに関連付けられたセキュリティ情報へのポインターです。関数は、指定された所有者、グループ、アクセス制御、および監査制御の情報をこのセキュリティ記述子の情報とマージして、新しいセキュリティ記述子を構築します。このパラメーターは NULL にすることができます。
pSizeNewSD	DWORD*	out	セキュリティ記述子のサイズ (バイト単位) を受け取る変数へのポインターです。
pNewSD	PSECURITY_DESCRIPTOR*	out	新しいセキュリティ記述子へのポインターを受け取る変数へのポインターです。関数は新しいセキュリティ記述子のためにメモリを割り当てます。返されたバッファーを解放するには、 LocalFree 関数を呼び出す必要があります。

戻り値の型: WIN32_ERROR

公式ドキュメント

新しいセキュリティ記述子を割り当てて初期化します。(Unicode)

戻り値

関数が成功した場合、ERROR_SUCCESS を返します。

関数が失敗した場合、WinError.h で定義されている 0 以外のエラーコードを返します。

解説(Remarks)

BuildSecurityDescriptor 関数は、独自のオブジェクトに対してセキュリティを実装または公開する信頼されたサーバーを対象としています。この関数は、信頼されたサーバーが必要とするように、ストリームへのシリアル化やディスクへの保存に適した自己相対形式のセキュリティ記述子を使用します。

メモ

aclapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして BuildSecurityDescriptor を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーが発生する可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR BuildSecurityDescriptorW(
    TRUSTEE_W* pOwner,   // optional
    TRUSTEE_W* pGroup,   // optional
    DWORD cCountOfAccessEntries,
    EXPLICIT_ACCESS_W* pListOfAccessEntries,   // optional
    DWORD cCountOfAuditEntries,
    EXPLICIT_ACCESS_W* pListOfAuditEntries,   // optional
    PSECURITY_DESCRIPTOR pOldSD,   // optional
    DWORD* pSizeNewSD,
    PSECURITY_DESCRIPTOR* pNewSD
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint BuildSecurityDescriptorW(
    IntPtr pOwner,   // TRUSTEE_W* optional
    IntPtr pGroup,   // TRUSTEE_W* optional
    uint cCountOfAccessEntries,   // DWORD
    IntPtr pListOfAccessEntries,   // EXPLICIT_ACCESS_W* optional
    uint cCountOfAuditEntries,   // DWORD
    IntPtr pListOfAuditEntries,   // EXPLICIT_ACCESS_W* optional
    IntPtr pOldSD,   // PSECURITY_DESCRIPTOR optional
    out uint pSizeNewSD,   // DWORD* out
    IntPtr pNewSD   // PSECURITY_DESCRIPTOR* out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function BuildSecurityDescriptorW(
    pOwner As IntPtr,   ' TRUSTEE_W* optional
    pGroup As IntPtr,   ' TRUSTEE_W* optional
    cCountOfAccessEntries As UInteger,   ' DWORD
    pListOfAccessEntries As IntPtr,   ' EXPLICIT_ACCESS_W* optional
    cCountOfAuditEntries As UInteger,   ' DWORD
    pListOfAuditEntries As IntPtr,   ' EXPLICIT_ACCESS_W* optional
    pOldSD As IntPtr,   ' PSECURITY_DESCRIPTOR optional
    <Out> ByRef pSizeNewSD As UInteger,   ' DWORD* out
    pNewSD As IntPtr   ' PSECURITY_DESCRIPTOR* out
) As UInteger
End Function

' pOwner : TRUSTEE_W* optional
' pGroup : TRUSTEE_W* optional
' cCountOfAccessEntries : DWORD
' pListOfAccessEntries : EXPLICIT_ACCESS_W* optional
' cCountOfAuditEntries : DWORD
' pListOfAuditEntries : EXPLICIT_ACCESS_W* optional
' pOldSD : PSECURITY_DESCRIPTOR optional
' pSizeNewSD : DWORD* out
' pNewSD : PSECURITY_DESCRIPTOR* out
Declare PtrSafe Function BuildSecurityDescriptorW Lib "advapi32" ( _
    ByVal pOwner As LongPtr, _
    ByVal pGroup As LongPtr, _
    ByVal cCountOfAccessEntries As Long, _
    ByVal pListOfAccessEntries As LongPtr, _
    ByVal cCountOfAuditEntries As Long, _
    ByVal pListOfAuditEntries As LongPtr, _
    ByVal pOldSD As LongPtr, _
    ByRef pSizeNewSD As Long, _
    ByVal pNewSD As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

BuildSecurityDescriptorW = ctypes.windll.advapi32.BuildSecurityDescriptorW
BuildSecurityDescriptorW.restype = wintypes.DWORD
BuildSecurityDescriptorW.argtypes = [
    ctypes.c_void_p,  # pOwner : TRUSTEE_W* optional
    ctypes.c_void_p,  # pGroup : TRUSTEE_W* optional
    wintypes.DWORD,  # cCountOfAccessEntries : DWORD
    ctypes.c_void_p,  # pListOfAccessEntries : EXPLICIT_ACCESS_W* optional
    wintypes.DWORD,  # cCountOfAuditEntries : DWORD
    ctypes.c_void_p,  # pListOfAuditEntries : EXPLICIT_ACCESS_W* optional
    wintypes.HANDLE,  # pOldSD : PSECURITY_DESCRIPTOR optional
    ctypes.POINTER(wintypes.DWORD),  # pSizeNewSD : DWORD* out
    ctypes.c_void_p,  # pNewSD : PSECURITY_DESCRIPTOR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
BuildSecurityDescriptorW = Fiddle::Function.new(
  lib['BuildSecurityDescriptorW'],
  [
    Fiddle::TYPE_VOIDP,  # pOwner : TRUSTEE_W* optional
    Fiddle::TYPE_VOIDP,  # pGroup : TRUSTEE_W* optional
    -Fiddle::TYPE_INT,  # cCountOfAccessEntries : DWORD
    Fiddle::TYPE_VOIDP,  # pListOfAccessEntries : EXPLICIT_ACCESS_W* optional
    -Fiddle::TYPE_INT,  # cCountOfAuditEntries : DWORD
    Fiddle::TYPE_VOIDP,  # pListOfAuditEntries : EXPLICIT_ACCESS_W* optional
    Fiddle::TYPE_VOIDP,  # pOldSD : PSECURITY_DESCRIPTOR optional
    Fiddle::TYPE_VOIDP,  # pSizeNewSD : DWORD* out
    Fiddle::TYPE_VOIDP,  # pNewSD : PSECURITY_DESCRIPTOR* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn BuildSecurityDescriptorW(
        pOwner: *mut TRUSTEE_W,  // TRUSTEE_W* optional
        pGroup: *mut TRUSTEE_W,  // TRUSTEE_W* optional
        cCountOfAccessEntries: u32,  // DWORD
        pListOfAccessEntries: *mut EXPLICIT_ACCESS_W,  // EXPLICIT_ACCESS_W* optional
        cCountOfAuditEntries: u32,  // DWORD
        pListOfAuditEntries: *mut EXPLICIT_ACCESS_W,  // EXPLICIT_ACCESS_W* optional
        pOldSD: *mut core::ffi::c_void,  // PSECURITY_DESCRIPTOR optional
        pSizeNewSD: *mut u32,  // DWORD* out
        pNewSD: *mut *mut core::ffi::c_void  // PSECURITY_DESCRIPTOR* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode)]
public static extern uint BuildSecurityDescriptorW(IntPtr pOwner, IntPtr pGroup, uint cCountOfAccessEntries, IntPtr pListOfAccessEntries, uint cCountOfAuditEntries, IntPtr pListOfAuditEntries, IntPtr pOldSD, out uint pSizeNewSD, IntPtr pNewSD);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_BuildSecurityDescriptorW' -Namespace Win32 -PassThru
# $api::BuildSecurityDescriptorW(pOwner, pGroup, cCountOfAccessEntries, pListOfAccessEntries, cCountOfAuditEntries, pListOfAuditEntries, pOldSD, pSizeNewSD, pNewSD)

#uselib "ADVAPI32.dll"
#func global BuildSecurityDescriptorW "BuildSecurityDescriptorW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; BuildSecurityDescriptorW varptr(pOwner), varptr(pGroup), cCountOfAccessEntries, varptr(pListOfAccessEntries), cCountOfAuditEntries, varptr(pListOfAuditEntries), pOldSD, varptr(pSizeNewSD), pNewSD   ; 戻り値は stat
; pOwner : TRUSTEE_W* optional -> "wptr"
; pGroup : TRUSTEE_W* optional -> "wptr"
; cCountOfAccessEntries : DWORD -> "wptr"
; pListOfAccessEntries : EXPLICIT_ACCESS_W* optional -> "wptr"
; cCountOfAuditEntries : DWORD -> "wptr"
; pListOfAuditEntries : EXPLICIT_ACCESS_W* optional -> "wptr"
; pOldSD : PSECURITY_DESCRIPTOR optional -> "wptr"
; pSizeNewSD : DWORD* out -> "wptr"
; pNewSD : PSECURITY_DESCRIPTOR* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global BuildSecurityDescriptorW "BuildSecurityDescriptorW" var, var, int, var, int, var, sptr, var, sptr
; res = BuildSecurityDescriptorW(pOwner, pGroup, cCountOfAccessEntries, pListOfAccessEntries, cCountOfAuditEntries, pListOfAuditEntries, pOldSD, pSizeNewSD, pNewSD)
; pOwner : TRUSTEE_W* optional -> "var"
; pGroup : TRUSTEE_W* optional -> "var"
; cCountOfAccessEntries : DWORD -> "int"
; pListOfAccessEntries : EXPLICIT_ACCESS_W* optional -> "var"
; cCountOfAuditEntries : DWORD -> "int"
; pListOfAuditEntries : EXPLICIT_ACCESS_W* optional -> "var"
; pOldSD : PSECURITY_DESCRIPTOR optional -> "sptr"
; pSizeNewSD : DWORD* out -> "var"
; pNewSD : PSECURITY_DESCRIPTOR* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global BuildSecurityDescriptorW "BuildSecurityDescriptorW" sptr, sptr, int, sptr, int, sptr, sptr, sptr, sptr
; res = BuildSecurityDescriptorW(varptr(pOwner), varptr(pGroup), cCountOfAccessEntries, varptr(pListOfAccessEntries), cCountOfAuditEntries, varptr(pListOfAuditEntries), pOldSD, varptr(pSizeNewSD), pNewSD)
; pOwner : TRUSTEE_W* optional -> "sptr"
; pGroup : TRUSTEE_W* optional -> "sptr"
; cCountOfAccessEntries : DWORD -> "int"
; pListOfAccessEntries : EXPLICIT_ACCESS_W* optional -> "sptr"
; cCountOfAuditEntries : DWORD -> "int"
; pListOfAuditEntries : EXPLICIT_ACCESS_W* optional -> "sptr"
; pOldSD : PSECURITY_DESCRIPTOR optional -> "sptr"
; pSizeNewSD : DWORD* out -> "sptr"
; pNewSD : PSECURITY_DESCRIPTOR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。