ホーム › System.Registry › RegGetKeySecurity

RegGetKeySecurity

関数

指定したレジストリキーのセキュリティ記述子を取得する。

DLLADVAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

WIN32_ERROR RegGetKeySecurity(
    HKEY hKey,
    OBJECT_SECURITY_INFORMATION SecurityInformation,
    PSECURITY_DESCRIPTOR pSecurityDescriptor,   // optional
    DWORD* lpcbSecurityDescriptor
);

パラメーター

名前	型	方向	説明
hKey	HKEY	in	セキュリティ記述子を取得する対象の、開いているキーのハンドル。
SecurityInformation	OBJECT_SECURITY_INFORMATION	in	要求するセキュリティ情報を示す SECURITY_INFORMATION 値。
pSecurityDescriptor	PSECURITY_DESCRIPTOR	outoptional	要求されたセキュリティ記述子のコピーを受け取るバッファーへのポインター。
lpcbSecurityDescriptor	DWORD*	inout	pSecurityDescriptor パラメーターが指すバッファーのサイズ(バイト単位)を指定する変数へのポインター。関数が返ると、この変数にはバッファーに書き込まれたバイト数が格納されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定された開いているレジストリキーを保護しているセキュリティ記述子のコピーを取得します。

戻り値

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

関数が失敗した場合、WinError.h で定義されている 0 以外のエラーコードを返します。 FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用すると、エラーの一般的な説明を取得できます。

解説(Remarks)

pSecurityDescriptor パラメーターで指定したバッファーが小さすぎる場合、関数は ERROR_INSUFFICIENT_BUFFER を返し、lpcbSecurityDescriptor パラメーターには要求されたセキュリティ記述子に必要なバイト数が格納されます。

キーのセキュリティ記述子から所有者、グループ、または随意アクセス制御リスト (DACL) を読み取るには、ハンドルを開いた際に呼び出し元のプロセスに READ_CONTROL アクセス権が付与されている必要があります。READ_CONTROL アクセス権を取得するには、呼び出し元がキーの所有者であるか、キーの DACL がそのアクセスを許可している必要があります。

セキュリティ記述子からシステムアクセス制御リスト (SACL) を読み取るには、キーを開いた際に呼び出し元のプロセスに ACCESS_SYSTEM_SECURITY アクセス権が付与されている必要があります。このアクセス権を取得する正しい方法は、呼び出し元の現在のトークンで SE_SECURITY_NAME 特権を有効にし、ACCESS_SYSTEM_SECURITY アクセス権でハンドルを開いた後、特権を無効にすることです。

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

各言語での呼び出し定義

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

WIN32_ERROR RegGetKeySecurity(
    HKEY hKey,
    OBJECT_SECURITY_INFORMATION SecurityInformation,
    PSECURITY_DESCRIPTOR pSecurityDescriptor,   // optional
    DWORD* lpcbSecurityDescriptor
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint RegGetKeySecurity(
    IntPtr hKey,   // HKEY
    uint SecurityInformation,   // OBJECT_SECURITY_INFORMATION
    IntPtr pSecurityDescriptor,   // PSECURITY_DESCRIPTOR optional, out
    ref uint lpcbSecurityDescriptor   // DWORD* in/out
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function RegGetKeySecurity(
    hKey As IntPtr,   ' HKEY
    SecurityInformation As UInteger,   ' OBJECT_SECURITY_INFORMATION
    pSecurityDescriptor As IntPtr,   ' PSECURITY_DESCRIPTOR optional, out
    ByRef lpcbSecurityDescriptor As UInteger   ' DWORD* in/out
) As UInteger
End Function

' hKey : HKEY
' SecurityInformation : OBJECT_SECURITY_INFORMATION
' pSecurityDescriptor : PSECURITY_DESCRIPTOR optional, out
' lpcbSecurityDescriptor : DWORD* in/out
Declare PtrSafe Function RegGetKeySecurity Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal SecurityInformation As Long, _
    ByVal pSecurityDescriptor As LongPtr, _
    ByRef lpcbSecurityDescriptor As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegGetKeySecurity = ctypes.windll.advapi32.RegGetKeySecurity
RegGetKeySecurity.restype = wintypes.DWORD
RegGetKeySecurity.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.DWORD,  # SecurityInformation : OBJECT_SECURITY_INFORMATION
    wintypes.HANDLE,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcbSecurityDescriptor : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegGetKeySecurity = Fiddle::Function.new(
  lib['RegGetKeySecurity'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    -Fiddle::TYPE_INT,  # SecurityInformation : OBJECT_SECURITY_INFORMATION
    Fiddle::TYPE_VOIDP,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR optional, out
    Fiddle::TYPE_VOIDP,  # lpcbSecurityDescriptor : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn RegGetKeySecurity(
        hKey: *mut core::ffi::c_void,  // HKEY
        SecurityInformation: u32,  // OBJECT_SECURITY_INFORMATION
        pSecurityDescriptor: *mut core::ffi::c_void,  // PSECURITY_DESCRIPTOR optional, out
        lpcbSecurityDescriptor: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint RegGetKeySecurity(IntPtr hKey, uint SecurityInformation, IntPtr pSecurityDescriptor, ref uint lpcbSecurityDescriptor);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegGetKeySecurity' -Namespace Win32 -PassThru
# $api::RegGetKeySecurity(hKey, SecurityInformation, pSecurityDescriptor, lpcbSecurityDescriptor)

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

出力引数:

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