PrivilegeCheck

関数

トークンが必要な特権を有効に持つかどうかを検査する。

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

シグネチャ

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

BOOL PrivilegeCheck(
    HANDLE ClientToken,
    PRIVILEGE_SET* RequiredPrivileges,
    BOOL* pfResult
);

パラメーター

名前	型	方向	説明
ClientToken	HANDLE	in	クライアントプロセスを表すアクセストークンへのハンドル。このハンドルは、クライアントを偽装しているスレッドのトークンを開くことによって取得されている必要があります。トークンは TOKEN_QUERY アクセスで開かれている必要があります。
RequiredPrivileges	PRIVILEGE_SET*	inout	PRIVILEGE_SET 構造体へのポインター。この構造体の Privilege メンバーは、 LUID_AND_ATTRIBUTES 構造体の配列です。PrivilegeCheck を呼び出す前に、Privilege 配列を使用してチェックする特権のセットを指定します。すべての特権が有効である必要がある場合は Control メンバーを PRIVILEGE_SET_ALL_NECESSARY に設定します。いずれか 1 つの特権が有効であれば十分な場合は 0 に設定します。 PrivilegeCheck が戻ると、対応する特権が有効になっている場合、各 LUID_AND_ATTRIBUTES 構造体の Attributes メンバーが SE_PRIVILEGE_USED_FOR_ACCESS に設定されます。
pfResult	BOOL*	out	指定された特権のいずれか、またはすべてがアクセストークンで有効になっているかどうかを示すために、関数が設定する値へのポインター。PRIVILEGE_SET 構造体の Control メンバーが PRIVILEGE_SET_ALL_NECESSARY を指定している場合、この値はすべての特権が有効である場合にのみ TRUE になります。それ以外の場合、この値はいずれかの特権が有効であれば TRUE になります。

名前

型

方向

説明

ClientToken

HANDLE

クライアントプロセスを表すアクセストークンへのハンドル。このハンドルは、クライアントを偽装しているスレッドのトークンを開くことによって取得されている必要があります。トークンは TOKEN_QUERY アクセスで開かれている必要があります。

RequiredPrivileges

PRIVILEGE_SET*

inout

PRIVILEGE_SET 構造体へのポインター。この構造体の Privilege メンバーは、 LUID_AND_ATTRIBUTES 構造体の配列です。PrivilegeCheck を呼び出す前に、Privilege 配列を使用してチェックする特権のセットを指定します。すべての特権が有効である必要がある場合は Control メンバーを PRIVILEGE_SET_ALL_NECESSARY に設定します。いずれか 1 つの特権が有効であれば十分な場合は 0 に設定します。

PrivilegeCheck が戻ると、対応する特権が有効になっている場合、各 LUID_AND_ATTRIBUTES 構造体の Attributes メンバーが SE_PRIVILEGE_USED_FOR_ACCESS に設定されます。

pfResult

BOOL*

out

指定された特権のいずれか、またはすべてがアクセストークンで有効になっているかどうかを示すために、関数が設定する値へのポインター。PRIVILEGE_SET 構造体の Control メンバーが PRIVILEGE_SET_ALL_NECESSARY を指定している場合、この値はすべての特権が有効である場合にのみ TRUE になります。それ以外の場合、この値はいずれかの特権が有効であれば TRUE になります。

戻り値の型: BOOL

公式ドキュメント

指定された特権のセットがアクセストークンで有効になっているかどうかを判定します。

戻り値

関数が成功すると、戻り値は 0 以外になります。

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

解説(Remarks)

アクセストークンには、そのトークンに関連付けられたアカウントが保持する特権の一覧が含まれます。これらの特権は有効または無効にすることができ、ほとんどは既定で無効になっています。PrivilegeCheck 関数は、有効な特権のみをチェックします。アクセストークンが保持する有効および無効なすべての特権の一覧を取得するには、 GetTokenInformation 関数を呼び出します。アクセストークン内の特権のセットを有効または無効にするには、 AdjustTokenPrivileges 関数を呼び出します。

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

各言語での呼び出し定義

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

BOOL PrivilegeCheck(
    HANDLE ClientToken,
    PRIVILEGE_SET* RequiredPrivileges,
    BOOL* pfResult
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool PrivilegeCheck(
    IntPtr ClientToken,   // HANDLE
    IntPtr RequiredPrivileges,   // PRIVILEGE_SET* in/out
    out bool pfResult   // BOOL* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PrivilegeCheck(
    ClientToken As IntPtr,   ' HANDLE
    RequiredPrivileges As IntPtr,   ' PRIVILEGE_SET* in/out
    <Out> ByRef pfResult As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' ClientToken : HANDLE
' RequiredPrivileges : PRIVILEGE_SET* in/out
' pfResult : BOOL* out
Declare PtrSafe Function PrivilegeCheck Lib "advapi32" ( _
    ByVal ClientToken As LongPtr, _
    ByVal RequiredPrivileges As LongPtr, _
    ByRef pfResult As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PrivilegeCheck = ctypes.windll.advapi32.PrivilegeCheck
PrivilegeCheck.restype = wintypes.BOOL
PrivilegeCheck.argtypes = [
    wintypes.HANDLE,  # ClientToken : HANDLE
    ctypes.c_void_p,  # RequiredPrivileges : PRIVILEGE_SET* in/out
    ctypes.c_void_p,  # pfResult : BOOL* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
PrivilegeCheck = Fiddle::Function.new(
  lib['PrivilegeCheck'],
  [
    Fiddle::TYPE_VOIDP,  # ClientToken : HANDLE
    Fiddle::TYPE_VOIDP,  # RequiredPrivileges : PRIVILEGE_SET* in/out
    Fiddle::TYPE_VOIDP,  # pfResult : BOOL* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn PrivilegeCheck(
        ClientToken: *mut core::ffi::c_void,  // HANDLE
        RequiredPrivileges: *mut PRIVILEGE_SET,  // PRIVILEGE_SET* in/out
        pfResult: *mut i32  // BOOL* 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 PrivilegeCheck(IntPtr ClientToken, IntPtr RequiredPrivileges, out bool pfResult);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_PrivilegeCheck' -Namespace Win32 -PassThru
# $api::PrivilegeCheck(ClientToken, RequiredPrivileges, pfResult)

#uselib "ADVAPI32.dll"
#func global PrivilegeCheck "PrivilegeCheck" sptr, sptr, sptr
; PrivilegeCheck ClientToken, varptr(RequiredPrivileges), varptr(pfResult)   ; 戻り値は stat
; ClientToken : HANDLE -> "sptr"
; RequiredPrivileges : PRIVILEGE_SET* in/out -> "sptr"
; pfResult : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global PrivilegeCheck "PrivilegeCheck" sptr, var, var
; res = PrivilegeCheck(ClientToken, RequiredPrivileges, pfResult)
; ClientToken : HANDLE -> "sptr"
; RequiredPrivileges : PRIVILEGE_SET* in/out -> "var"
; pfResult : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global PrivilegeCheck "PrivilegeCheck" sptr, sptr, sptr
; res = PrivilegeCheck(ClientToken, varptr(RequiredPrivileges), varptr(pfResult))
; ClientToken : HANDLE -> "sptr"
; RequiredPrivileges : PRIVILEGE_SET* in/out -> "sptr"
; pfResult : BOOL* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。