ホーム › Security › GetPrivateObjectSecurity

GetPrivateObjectSecurity

関数

プライベートオブジェクトのセキュリティ情報を取得する。

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

シグネチャ

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

BOOL GetPrivateObjectSecurity(
    PSECURITY_DESCRIPTOR ObjectDescriptor,
    OBJECT_SECURITY_INFORMATION SecurityInformation,
    PSECURITY_DESCRIPTOR ResultantDescriptor,   // optional
    DWORD DescriptorLength,
    DWORD* ReturnLength
);

パラメーター

名前	型	方向	説明
ObjectDescriptor	PSECURITY_DESCRIPTOR	in	SECURITY_DESCRIPTOR 構造体へのポインターです。これが照会対象のセキュリティ記述子です。
SecurityInformation	OBJECT_SECURITY_INFORMATION	in	取得するセキュリティ記述子の部分を示すビットフラグの集合です。このパラメーターには、 SECURITY_INFORMATION ビットフラグの組み合わせを指定できます。
ResultantDescriptor	PSECURITY_DESCRIPTOR	outoptional	指定したセキュリティ記述子から要求された情報のコピーを受け取るバッファーへのポインターです。 SECURITY_DESCRIPTOR 構造体は self-relative 形式で返されます。
DescriptorLength	DWORD	in	ResultantDescriptor パラメーターが指すバッファーのサイズ(バイト単位)を指定します。
ReturnLength	DWORD*	out	記述子のコピーが成功した場合に、関数がゼロを設定する変数へのポインターです。バッファーがセキュリティ記述子に対して小さすぎる場合、この変数は必要なバイト数を受け取ります。関数が戻ったときにこの変数の値が DescriptorLength パラメーターの値より大きい場合、関数は FALSE を返し、セキュリティ記述子はバッファーにまったくコピーされません。

戻り値の型: BOOL

公式ドキュメント

プライベートオブジェクトのセキュリティ記述子から情報を取得します。

戻り値

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

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

解説(Remarks)

この関数はリソースマネージャーによる使用のみを想定しています。セキュリティ記述子を更新する際の標準的なアクセス制御セマンティクスを実装するには、リソースマネージャーは GetPrivateObjectSecurity を呼び出す前に、次の条件が満たされていることを確認する必要があります。

オブジェクトの所有者を設定する場合、呼び出し元の process は WRITE_OWNER 権限を持っているか、またはオブジェクトの所有者である必要があります。
オブジェクトの discretionary access control list を設定する場合、呼び出し元プロセスは WRITE_DAC 権限を持っているか、またはオブジェクトの所有者である必要があります。
オブジェクトの system access control list を設定する場合、呼び出し元プロセスに対して SE_SECURITY_NAME 特権が有効になっている必要があります。

上記の条件が満たされていない場合でも、この関数の呼び出しは失敗しませんが、標準のアクセスポリシーは適用されません。

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

各言語での呼び出し定義

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

BOOL GetPrivateObjectSecurity(
    PSECURITY_DESCRIPTOR ObjectDescriptor,
    OBJECT_SECURITY_INFORMATION SecurityInformation,
    PSECURITY_DESCRIPTOR ResultantDescriptor,   // optional
    DWORD DescriptorLength,
    DWORD* ReturnLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetPrivateObjectSecurity(
    IntPtr ObjectDescriptor,   // PSECURITY_DESCRIPTOR
    uint SecurityInformation,   // OBJECT_SECURITY_INFORMATION
    IntPtr ResultantDescriptor,   // PSECURITY_DESCRIPTOR optional, out
    uint DescriptorLength,   // DWORD
    out uint ReturnLength   // DWORD* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetPrivateObjectSecurity(
    ObjectDescriptor As IntPtr,   ' PSECURITY_DESCRIPTOR
    SecurityInformation As UInteger,   ' OBJECT_SECURITY_INFORMATION
    ResultantDescriptor As IntPtr,   ' PSECURITY_DESCRIPTOR optional, out
    DescriptorLength As UInteger,   ' DWORD
    <Out> ByRef ReturnLength As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' ObjectDescriptor : PSECURITY_DESCRIPTOR
' SecurityInformation : OBJECT_SECURITY_INFORMATION
' ResultantDescriptor : PSECURITY_DESCRIPTOR optional, out
' DescriptorLength : DWORD
' ReturnLength : DWORD* out
Declare PtrSafe Function GetPrivateObjectSecurity Lib "advapi32" ( _
    ByVal ObjectDescriptor As LongPtr, _
    ByVal SecurityInformation As Long, _
    ByVal ResultantDescriptor As LongPtr, _
    ByVal DescriptorLength As Long, _
    ByRef ReturnLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetPrivateObjectSecurity = ctypes.windll.advapi32.GetPrivateObjectSecurity
GetPrivateObjectSecurity.restype = wintypes.BOOL
GetPrivateObjectSecurity.argtypes = [
    wintypes.HANDLE,  # ObjectDescriptor : PSECURITY_DESCRIPTOR
    wintypes.DWORD,  # SecurityInformation : OBJECT_SECURITY_INFORMATION
    wintypes.HANDLE,  # ResultantDescriptor : PSECURITY_DESCRIPTOR optional, out
    wintypes.DWORD,  # DescriptorLength : DWORD
    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')
GetPrivateObjectSecurity = Fiddle::Function.new(
  lib['GetPrivateObjectSecurity'],
  [
    Fiddle::TYPE_VOIDP,  # ObjectDescriptor : PSECURITY_DESCRIPTOR
    -Fiddle::TYPE_INT,  # SecurityInformation : OBJECT_SECURITY_INFORMATION
    Fiddle::TYPE_VOIDP,  # ResultantDescriptor : PSECURITY_DESCRIPTOR optional, out
    -Fiddle::TYPE_INT,  # DescriptorLength : DWORD
    Fiddle::TYPE_VOIDP,  # ReturnLength : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn GetPrivateObjectSecurity(
        ObjectDescriptor: *mut core::ffi::c_void,  // PSECURITY_DESCRIPTOR
        SecurityInformation: u32,  // OBJECT_SECURITY_INFORMATION
        ResultantDescriptor: *mut core::ffi::c_void,  // PSECURITY_DESCRIPTOR optional, out
        DescriptorLength: u32,  // DWORD
        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 GetPrivateObjectSecurity(IntPtr ObjectDescriptor, uint SecurityInformation, IntPtr ResultantDescriptor, uint DescriptorLength, out uint ReturnLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetPrivateObjectSecurity' -Namespace Win32 -PassThru
# $api::GetPrivateObjectSecurity(ObjectDescriptor, SecurityInformation, ResultantDescriptor, DescriptorLength, ReturnLength)

#uselib "ADVAPI32.dll"
#func global GetPrivateObjectSecurity "GetPrivateObjectSecurity" sptr, sptr, sptr, sptr, sptr
; GetPrivateObjectSecurity ObjectDescriptor, SecurityInformation, ResultantDescriptor, DescriptorLength, varptr(ReturnLength)   ; 戻り値は stat
; ObjectDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "sptr"
; ResultantDescriptor : PSECURITY_DESCRIPTOR optional, out -> "sptr"
; DescriptorLength : DWORD -> "sptr"
; ReturnLength : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global GetPrivateObjectSecurity "GetPrivateObjectSecurity" sptr, int, sptr, int, var
; res = GetPrivateObjectSecurity(ObjectDescriptor, SecurityInformation, ResultantDescriptor, DescriptorLength, ReturnLength)
; ObjectDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "int"
; ResultantDescriptor : PSECURITY_DESCRIPTOR optional, out -> "sptr"
; DescriptorLength : DWORD -> "int"
; ReturnLength : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global GetPrivateObjectSecurity "GetPrivateObjectSecurity" sptr, int, sptr, int, sptr
; res = GetPrivateObjectSecurity(ObjectDescriptor, SecurityInformation, ResultantDescriptor, DescriptorLength, varptr(ReturnLength))
; ObjectDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "int"
; ResultantDescriptor : PSECURITY_DESCRIPTOR optional, out -> "sptr"
; DescriptorLength : DWORD -> "int"
; ReturnLength : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。