ホーム › Security.Authorization › GetNamedSecurityInfoW

GetNamedSecurityInfoW

関数

名前付きオブジェクトのセキュリティ情報を取得する(Unicode版)。

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

シグネチャ

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

WIN32_ERROR GetNamedSecurityInfoW(
    LPCWSTR pObjectName,
    SE_OBJECT_TYPE ObjectType,
    OBJECT_SECURITY_INFORMATION SecurityInfo,
    PSID* ppsidOwner,   // optional
    PSID* ppsidGroup,   // optional
    ACL** ppDacl,   // optional
    ACL** ppSacl,   // optional
    PSECURITY_DESCRIPTOR* ppSecurityDescriptor
);

パラメーター

名前	型	方向	説明
pObjectName	LPCWSTR	in	セキュリティ情報を取得する対象オブジェクトの名前を指定する、null で終わる文字列へのポインターです。各オブジェクト型における文字列形式の説明については、 SE_OBJECT_TYPE を参照してください。
ObjectType	SE_OBJECT_TYPE	in	pObjectName パラメーターで指定されたオブジェクトの型を示す、SE_OBJECT_TYPE 列挙体の値を指定します。
SecurityInfo	OBJECT_SECURITY_INFORMATION	in	取得するセキュリティ情報の種類を示すビットフラグのセットです。このパラメーターには、 SECURITY_INFORMATION ビットフラグの組み合わせを指定できます。
ppsidOwner	PSID*	outoptional	ppSecurityDescriptor に返されるセキュリティ記述子内の所有者 SID へのポインターを受け取る変数へのポインターです。セキュリティ記述子に所有者 SID がない場合は NULL を受け取ります。返されるポインターは、OWNER_SECURITY_INFORMATION フラグを設定した場合にのみ有効です。また、所有者 SID が不要な場合、このパラメーターには NULL を指定できます。
ppsidGroup	PSID*	outoptional	返されたセキュリティ記述子内のプライマリグループ SID へのポインターを受け取る変数へのポインターです。セキュリティ記述子にグループ SID がない場合は NULL を受け取ります。返されるポインターは、GROUP_SECURITY_INFORMATION フラグを設定した場合にのみ有効です。また、グループ SID が不要な場合、このパラメーターには NULL を指定できます。
ppDacl	ACL**	outoptional	返されたセキュリティ記述子内の DACL へのポインターを受け取る変数へのポインターです。セキュリティ記述子に DACL がない場合は NULL を受け取ります。返されるポインターは、DACL_SECURITY_INFORMATION フラグを設定した場合にのみ有効です。また、DACL が不要な場合、このパラメーターには NULL を指定できます。
ppSacl	ACL**	outoptional	返されたセキュリティ記述子内の SACL へのポインターを受け取る変数へのポインターです。セキュリティ記述子に SACL がない場合は NULL を受け取ります。返されるポインターは、SACL_SECURITY_INFORMATION フラグを設定した場合にのみ有効です。また、SACL が不要な場合、このパラメーターには NULL を指定できます。
ppSecurityDescriptor	PSECURITY_DESCRIPTOR*	out	オブジェクトのセキュリティ記述子へのポインターを受け取る変数へのポインターです。ポインターの使用が終わったら、 LocalFree 関数を呼び出して、返されたバッファーを解放してください。このパラメーターは、ppsidOwner、ppsidGroup、ppDacl、ppSacl のいずれかのパラメーターが NULL 以外である場合に必須です。

戻り値の型: WIN32_ERROR

公式ドキュメント

名前で指定されたオブジェクトのセキュリティ記述子のコピーを取得します。(Unicode)

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

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

解説(Remarks)

ppsidOwner、ppsidGroup、ppDacl、ppSacl のいずれかのパラメーターが NULL 以外で、かつ SecurityInfo パラメーターでそれらをオブジェクトから取得するよう指定した場合、それらのパラメーターは ppSecurityDescriptor に返されるセキュリティ記述子内の対応する要素を指します。セキュリティ記述子に要求された情報が含まれていない場合、対応するパラメーターには NULL が設定されます。

オブジェクトのセキュリティ記述子から所有者、グループ、または DACL を読み取るには、オブジェクトの DACL が呼び出し元に READ_CONTROL アクセスを許可しているか、呼び出し元がオブジェクトの所有者である必要があります。

オブジェクトのシステムアクセス制御リスト (SACL) を読み取るには、呼び出し元のプロセスで SE_SECURITY_NAME 特権が有効になっている必要があります。特権を有効にすることのセキュリティ上の影響については、Running with Special Privileges を参照してください。

GetNamedSecurityInfo 関数は、次の種類のオブジェクトで使用できます。

NTFS ファイルシステム上のローカルまたはリモートのファイルおよびディレクトリ
ローカルまたはリモートのプリンター
ローカルまたはリモートの Windows サービス
ネットワーク共有
レジストリキー
セマフォ、イベント、ミューテックス、待機可能タイマー
ファイルマッピングオブジェクト
ディレクトリサービスオブジェクト

この関数は競合状態 (race condition) を処理しません。あるスレッドがこの関数を呼び出すのとほぼ同時に、別のスレッドがオブジェクトのセキュリティ記述子を変更した場合、この関数は失敗する可能性があります。

この関数は情報を平文 (plaintext) で転送します。システムで署名が無効化されていない限り、この関数が転送する情報には署名が施されますが、暗号化は行われません。

ユーザーアカウント、グループアカウント、またはログオンセッションを通じてオブジェクトへのアクセスを制御する方法の詳細については、How DACLs Control Access to an Object を参照してください。

使用例

GetNamedSecurityInfo を使用する例については、Modifying the ACLs of an Object を参照してください。

メモ

aclapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetNamedSecurityInfo を定義しています。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetNamedSecurityInfoW(
    LPCWSTR pObjectName,
    SE_OBJECT_TYPE ObjectType,
    OBJECT_SECURITY_INFORMATION SecurityInfo,
    PSID* ppsidOwner,   // optional
    PSID* ppsidGroup,   // optional
    ACL** ppDacl,   // optional
    ACL** ppSacl,   // optional
    PSECURITY_DESCRIPTOR* ppSecurityDescriptor
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint GetNamedSecurityInfoW(
    [MarshalAs(UnmanagedType.LPWStr)] string pObjectName,   // LPCWSTR
    int ObjectType,   // SE_OBJECT_TYPE
    uint SecurityInfo,   // OBJECT_SECURITY_INFORMATION
    IntPtr ppsidOwner,   // PSID* optional, out
    IntPtr ppsidGroup,   // PSID* optional, out
    IntPtr ppDacl,   // ACL** optional, out
    IntPtr ppSacl,   // ACL** optional, out
    IntPtr ppSecurityDescriptor   // PSECURITY_DESCRIPTOR* out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetNamedSecurityInfoW(
    <MarshalAs(UnmanagedType.LPWStr)> pObjectName As String,   ' LPCWSTR
    ObjectType As Integer,   ' SE_OBJECT_TYPE
    SecurityInfo As UInteger,   ' OBJECT_SECURITY_INFORMATION
    ppsidOwner As IntPtr,   ' PSID* optional, out
    ppsidGroup As IntPtr,   ' PSID* optional, out
    ppDacl As IntPtr,   ' ACL** optional, out
    ppSacl As IntPtr,   ' ACL** optional, out
    ppSecurityDescriptor As IntPtr   ' PSECURITY_DESCRIPTOR* out
) As UInteger
End Function

' pObjectName : LPCWSTR
' ObjectType : SE_OBJECT_TYPE
' SecurityInfo : OBJECT_SECURITY_INFORMATION
' ppsidOwner : PSID* optional, out
' ppsidGroup : PSID* optional, out
' ppDacl : ACL** optional, out
' ppSacl : ACL** optional, out
' ppSecurityDescriptor : PSECURITY_DESCRIPTOR* out
Declare PtrSafe Function GetNamedSecurityInfoW Lib "advapi32" ( _
    ByVal pObjectName As LongPtr, _
    ByVal ObjectType As Long, _
    ByVal SecurityInfo As Long, _
    ByVal ppsidOwner As LongPtr, _
    ByVal ppsidGroup As LongPtr, _
    ByVal ppDacl As LongPtr, _
    ByVal ppSacl As LongPtr, _
    ByVal ppSecurityDescriptor 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

GetNamedSecurityInfoW = ctypes.windll.advapi32.GetNamedSecurityInfoW
GetNamedSecurityInfoW.restype = wintypes.DWORD
GetNamedSecurityInfoW.argtypes = [
    wintypes.LPCWSTR,  # pObjectName : LPCWSTR
    ctypes.c_int,  # ObjectType : SE_OBJECT_TYPE
    wintypes.DWORD,  # SecurityInfo : OBJECT_SECURITY_INFORMATION
    ctypes.c_void_p,  # ppsidOwner : PSID* optional, out
    ctypes.c_void_p,  # ppsidGroup : PSID* optional, out
    ctypes.c_void_p,  # ppDacl : ACL** optional, out
    ctypes.c_void_p,  # ppSacl : ACL** optional, out
    ctypes.c_void_p,  # ppSecurityDescriptor : PSECURITY_DESCRIPTOR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
GetNamedSecurityInfoW = Fiddle::Function.new(
  lib['GetNamedSecurityInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # pObjectName : LPCWSTR
    Fiddle::TYPE_INT,  # ObjectType : SE_OBJECT_TYPE
    -Fiddle::TYPE_INT,  # SecurityInfo : OBJECT_SECURITY_INFORMATION
    Fiddle::TYPE_VOIDP,  # ppsidOwner : PSID* optional, out
    Fiddle::TYPE_VOIDP,  # ppsidGroup : PSID* optional, out
    Fiddle::TYPE_VOIDP,  # ppDacl : ACL** optional, out
    Fiddle::TYPE_VOIDP,  # ppSacl : ACL** optional, out
    Fiddle::TYPE_VOIDP,  # ppSecurityDescriptor : PSECURITY_DESCRIPTOR* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn GetNamedSecurityInfoW(
        pObjectName: *const u16,  // LPCWSTR
        ObjectType: i32,  // SE_OBJECT_TYPE
        SecurityInfo: u32,  // OBJECT_SECURITY_INFORMATION
        ppsidOwner: *mut *mut core::ffi::c_void,  // PSID* optional, out
        ppsidGroup: *mut *mut core::ffi::c_void,  // PSID* optional, out
        ppDacl: *mut *mut ACL,  // ACL** optional, out
        ppSacl: *mut *mut ACL,  // ACL** optional, out
        ppSecurityDescriptor: *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 GetNamedSecurityInfoW([MarshalAs(UnmanagedType.LPWStr)] string pObjectName, int ObjectType, uint SecurityInfo, IntPtr ppsidOwner, IntPtr ppsidGroup, IntPtr ppDacl, IntPtr ppSacl, IntPtr ppSecurityDescriptor);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetNamedSecurityInfoW' -Namespace Win32 -PassThru
# $api::GetNamedSecurityInfoW(pObjectName, ObjectType, SecurityInfo, ppsidOwner, ppsidGroup, ppDacl, ppSacl, ppSecurityDescriptor)

#uselib "ADVAPI32.dll"
#func global GetNamedSecurityInfoW "GetNamedSecurityInfoW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; GetNamedSecurityInfoW pObjectName, ObjectType, SecurityInfo, ppsidOwner, ppsidGroup, varptr(ppDacl), varptr(ppSacl), ppSecurityDescriptor   ; 戻り値は stat
; pObjectName : LPCWSTR -> "wptr"
; ObjectType : SE_OBJECT_TYPE -> "wptr"
; SecurityInfo : OBJECT_SECURITY_INFORMATION -> "wptr"
; ppsidOwner : PSID* optional, out -> "wptr"
; ppsidGroup : PSID* optional, out -> "wptr"
; ppDacl : ACL** optional, out -> "wptr"
; ppSacl : ACL** optional, out -> "wptr"
; ppSecurityDescriptor : PSECURITY_DESCRIPTOR* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global GetNamedSecurityInfoW "GetNamedSecurityInfoW" wstr, int, int, sptr, sptr, var, var, sptr
; res = GetNamedSecurityInfoW(pObjectName, ObjectType, SecurityInfo, ppsidOwner, ppsidGroup, ppDacl, ppSacl, ppSecurityDescriptor)
; pObjectName : LPCWSTR -> "wstr"
; ObjectType : SE_OBJECT_TYPE -> "int"
; SecurityInfo : OBJECT_SECURITY_INFORMATION -> "int"
; ppsidOwner : PSID* optional, out -> "sptr"
; ppsidGroup : PSID* optional, out -> "sptr"
; ppDacl : ACL** optional, out -> "var"
; ppSacl : ACL** optional, out -> "var"
; ppSecurityDescriptor : PSECURITY_DESCRIPTOR* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global GetNamedSecurityInfoW "GetNamedSecurityInfoW" wstr, int, int, sptr, sptr, sptr, sptr, sptr
; res = GetNamedSecurityInfoW(pObjectName, ObjectType, SecurityInfo, ppsidOwner, ppsidGroup, varptr(ppDacl), varptr(ppSacl), ppSecurityDescriptor)
; pObjectName : LPCWSTR -> "wstr"
; ObjectType : SE_OBJECT_TYPE -> "int"
; SecurityInfo : OBJECT_SECURITY_INFORMATION -> "int"
; ppsidOwner : PSID* optional, out -> "sptr"
; ppsidGroup : PSID* optional, out -> "sptr"
; ppDacl : ACL** optional, out -> "sptr"
; ppSacl : ACL** optional, out -> "sptr"
; ppSecurityDescriptor : PSECURITY_DESCRIPTOR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。