ホーム › Security › GetUserObjectSecurity

GetUserObjectSecurity

関数

ユーザーオブジェクトのセキュリティ記述子を取得する。

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

シグネチャ

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

BOOL GetUserObjectSecurity(
    HANDLE hObj,
    DWORD* pSIRequested,
    PSECURITY_DESCRIPTOR pSID,   // optional
    DWORD nLength,
    DWORD* lpnLengthNeeded
);

パラメーター

名前	型	方向	説明
hObj	HANDLE	in	セキュリティ情報を返す対象のユーザーオブジェクトへのハンドル。
pSIRequested	DWORD*	in	要求するセキュリティ情報を指定する SECURITY_INFORMATION 値へのポインター。
pSID	PSECURITY_DESCRIPTOR	outoptional	関数が返るときに、要求された情報を格納する self-relative 形式の SECURITY_DESCRIPTOR 構造体へのポインター。このバッファーは 4 バイト境界にアラインされている必要があります。
nLength	DWORD	in	pSD パラメーターが指すバッファーの長さ(バイト単位)。
lpnLengthNeeded	DWORD*	out	完全な security descriptor を格納するのに必要なバイト数を受け取る変数へのポインター。関数が返るときにこの変数の値が nLength パラメーターの値より大きい場合、関数は FALSE を返し、security descriptor はバッファーにまったくコピーされません。そうでない場合は、security descriptor 全体がコピーされます。

戻り値の型: BOOL

公式ドキュメント

指定したユーザーオブジェクトのセキュリティ情報を取得します。

戻り値

関数が成功した場合は、0 以外の値を返します。

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

解説(Remarks)

ユーザーオブジェクトの security descriptor から所有者、グループ、または discretionary access control list(DACL)を読み取るには、呼び出し元の process がハンドルを開いたときに READ_CONTROL アクセスが付与されている必要があります。

security descriptor から system access control list(SACL)を読み取るには、呼び出し元プロセスがハンドルを開いたときに ACCESS_SYSTEM_SECURITY アクセスが付与されている必要があります。このアクセスを取得する正しい方法は、呼び出し元の現在のトークンで SE_SECURITY_NAME 特権を有効にし、ACCESS_SYSTEM_SECURITY アクセスでハンドルを開き、その後に特権を無効にすることです。

Examples

この関数を使用する例については、Starting an Interactive Client Process を参照してください。

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

各言語での呼び出し定義

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

BOOL GetUserObjectSecurity(
    HANDLE hObj,
    DWORD* pSIRequested,
    PSECURITY_DESCRIPTOR pSID,   // optional
    DWORD nLength,
    DWORD* lpnLengthNeeded
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetUserObjectSecurity(
    IntPtr hObj,   // HANDLE
    ref uint pSIRequested,   // DWORD*
    IntPtr pSID,   // PSECURITY_DESCRIPTOR optional, out
    uint nLength,   // DWORD
    out uint lpnLengthNeeded   // DWORD* out
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetUserObjectSecurity(
    hObj As IntPtr,   ' HANDLE
    ByRef pSIRequested As UInteger,   ' DWORD*
    pSID As IntPtr,   ' PSECURITY_DESCRIPTOR optional, out
    nLength As UInteger,   ' DWORD
    <Out> ByRef lpnLengthNeeded As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hObj : HANDLE
' pSIRequested : DWORD*
' pSID : PSECURITY_DESCRIPTOR optional, out
' nLength : DWORD
' lpnLengthNeeded : DWORD* out
Declare PtrSafe Function GetUserObjectSecurity Lib "user32" ( _
    ByVal hObj As LongPtr, _
    ByRef pSIRequested As Long, _
    ByVal pSID As LongPtr, _
    ByVal nLength As Long, _
    ByRef lpnLengthNeeded As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetUserObjectSecurity = ctypes.windll.user32.GetUserObjectSecurity
GetUserObjectSecurity.restype = wintypes.BOOL
GetUserObjectSecurity.argtypes = [
    wintypes.HANDLE,  # hObj : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # pSIRequested : DWORD*
    wintypes.HANDLE,  # pSID : PSECURITY_DESCRIPTOR optional, out
    wintypes.DWORD,  # nLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpnLengthNeeded : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetUserObjectSecurity = Fiddle::Function.new(
  lib['GetUserObjectSecurity'],
  [
    Fiddle::TYPE_VOIDP,  # hObj : HANDLE
    Fiddle::TYPE_VOIDP,  # pSIRequested : DWORD*
    Fiddle::TYPE_VOIDP,  # pSID : PSECURITY_DESCRIPTOR optional, out
    -Fiddle::TYPE_INT,  # nLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpnLengthNeeded : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetUserObjectSecurity(
        hObj: *mut core::ffi::c_void,  // HANDLE
        pSIRequested: *mut u32,  // DWORD*
        pSID: *mut core::ffi::c_void,  // PSECURITY_DESCRIPTOR optional, out
        nLength: u32,  // DWORD
        lpnLengthNeeded: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool GetUserObjectSecurity(IntPtr hObj, ref uint pSIRequested, IntPtr pSID, uint nLength, out uint lpnLengthNeeded);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetUserObjectSecurity' -Namespace Win32 -PassThru
# $api::GetUserObjectSecurity(hObj, pSIRequested, pSID, nLength, lpnLengthNeeded)

#uselib "USER32.dll"
#func global GetUserObjectSecurity "GetUserObjectSecurity" sptr, sptr, sptr, sptr, sptr
; GetUserObjectSecurity hObj, varptr(pSIRequested), pSID, nLength, varptr(lpnLengthNeeded)   ; 戻り値は stat
; hObj : HANDLE -> "sptr"
; pSIRequested : DWORD* -> "sptr"
; pSID : PSECURITY_DESCRIPTOR optional, out -> "sptr"
; nLength : DWORD -> "sptr"
; lpnLengthNeeded : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetUserObjectSecurity "GetUserObjectSecurity" sptr, var, sptr, int, var
; res = GetUserObjectSecurity(hObj, pSIRequested, pSID, nLength, lpnLengthNeeded)
; hObj : HANDLE -> "sptr"
; pSIRequested : DWORD* -> "var"
; pSID : PSECURITY_DESCRIPTOR optional, out -> "sptr"
; nLength : DWORD -> "int"
; lpnLengthNeeded : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetUserObjectSecurity "GetUserObjectSecurity" sptr, sptr, sptr, int, sptr
; res = GetUserObjectSecurity(hObj, varptr(pSIRequested), pSID, nLength, varptr(lpnLengthNeeded))
; hObj : HANDLE -> "sptr"
; pSIRequested : DWORD* -> "sptr"
; pSID : PSECURITY_DESCRIPTOR optional, out -> "sptr"
; nLength : DWORD -> "int"
; lpnLengthNeeded : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。