ホーム › Security › GetFileSecurityA

GetFileSecurityA

関数

指定ファイルのセキュリティ記述子を取得する(ANSI版)。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetFileSecurityA(
    LPCSTR lpFileName,
    DWORD RequestedInformation,
    PSECURITY_DESCRIPTOR pSecurityDescriptor,   // optional
    DWORD nLength,
    DWORD* lpnLengthNeeded
);

パラメーター

名前	型	方向	説明
lpFileName	LPCSTR	in	セキュリティ情報を取得する対象のファイルまたはディレクトリを指定する、null で終わる文字列へのポインターです。
RequestedInformation	DWORD	in	要求するセキュリティ情報を識別する SECURITY_INFORMATION 値です。
pSecurityDescriptor	PSECURITY_DESCRIPTOR	outoptional	lpFileName パラメーターで指定されたオブジェクトの security descriptor のコピーを受け取るバッファーへのポインターです。呼び出し元の process は、オブジェクトのセキュリティ状態の指定された要素を参照する権限を持っている必要があります。 SECURITY_DESCRIPTOR 構造体は self-relative security descriptor 形式で返されます。
nLength	DWORD	in	pSecurityDescriptor パラメーターが指すバッファーのサイズをバイト単位で指定します。
lpnLengthNeeded	DWORD*	out	完全な security descriptor を格納するために必要なバイト数を受け取る変数へのポインターです。返されたバイト数が nLength 以下の場合、security descriptor 全体が出力バッファーに返されます。それ以外の場合は、descriptor は一切返されません。

戻り値の型: BOOL

公式ドキュメント

ファイルまたはディレクトリのセキュリティに関する指定された情報を取得します。取得できる情報は、呼び出し元のアクセス権と特権によって制限されます。(GetFileSecurityA)

戻り値

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

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

解説(Remarks)

指定したファイルまたはディレクトリの security descriptor から所有者、グループ、または DACL を読み取るには、そのファイルまたはディレクトリの DACL が呼び出し元に READ_CONTROL アクセスを許可しているか、呼び出し元がそのファイルまたはディレクトリの所有者である必要があります。

ファイルまたはディレクトリの SACL を読み取るには、呼び出し元プロセスで SE_SECURITY_NAME 特権が有効になっている必要があります。

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetFileSecurityA(
    LPCSTR lpFileName,
    DWORD RequestedInformation,
    PSECURITY_DESCRIPTOR pSecurityDescriptor,   // optional
    DWORD nLength,
    DWORD* lpnLengthNeeded
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetFileSecurityA(
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName,   // LPCSTR
    uint RequestedInformation,   // DWORD
    IntPtr pSecurityDescriptor,   // PSECURITY_DESCRIPTOR optional, out
    uint nLength,   // DWORD
    out uint lpnLengthNeeded   // DWORD* out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetFileSecurityA(
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String,   ' LPCSTR
    RequestedInformation As UInteger,   ' DWORD
    pSecurityDescriptor As IntPtr,   ' PSECURITY_DESCRIPTOR optional, out
    nLength As UInteger,   ' DWORD
    <Out> ByRef lpnLengthNeeded As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpFileName : LPCSTR
' RequestedInformation : DWORD
' pSecurityDescriptor : PSECURITY_DESCRIPTOR optional, out
' nLength : DWORD
' lpnLengthNeeded : DWORD* out
Declare PtrSafe Function GetFileSecurityA Lib "advapi32" ( _
    ByVal lpFileName As String, _
    ByVal RequestedInformation As Long, _
    ByVal pSecurityDescriptor 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

GetFileSecurityA = ctypes.windll.advapi32.GetFileSecurityA
GetFileSecurityA.restype = wintypes.BOOL
GetFileSecurityA.argtypes = [
    wintypes.LPCSTR,  # lpFileName : LPCSTR
    wintypes.DWORD,  # RequestedInformation : DWORD
    wintypes.HANDLE,  # pSecurityDescriptor : 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('ADVAPI32.dll')
GetFileSecurityA = Fiddle::Function.new(
  lib['GetFileSecurityA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR
    -Fiddle::TYPE_INT,  # RequestedInformation : DWORD
    Fiddle::TYPE_VOIDP,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR optional, out
    -Fiddle::TYPE_INT,  # nLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpnLengthNeeded : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn GetFileSecurityA(
        lpFileName: *const u8,  // LPCSTR
        RequestedInformation: u32,  // DWORD
        pSecurityDescriptor: *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("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool GetFileSecurityA([MarshalAs(UnmanagedType.LPStr)] string lpFileName, uint RequestedInformation, IntPtr pSecurityDescriptor, uint nLength, out uint lpnLengthNeeded);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetFileSecurityA' -Namespace Win32 -PassThru
# $api::GetFileSecurityA(lpFileName, RequestedInformation, pSecurityDescriptor, nLength, lpnLengthNeeded)

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

出力引数:

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