Win32 API 日本語リファレンス
ホームSecurity › CheckTokenCapability

CheckTokenCapability

関数
トークンが指定の機能SIDを持つかどうかを判定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSwindows8.0

シグネチャ

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

BOOL CheckTokenCapability(
    HANDLE TokenHandle,   // optional
    PSID CapabilitySidToCheck,
    BOOL* HasCapability
);

パラメーター

名前方向説明
TokenHandleHANDLEinoptional

アクセストークンへのハンドル。このハンドルはトークンに対する TOKEN_QUERY アクセス権を持っている必要があります。トークンは偽装トークンでなければなりません。

TokenHandleNULL の場合、CheckTokenCapability は呼び出し元スレッドの偽装トークンを使用します。スレッドが偽装を行っていない場合、この関数はスレッドのプライマリトークンを複製して偽装トークンを作成します。

CapabilitySidToCheckPSIDin機能 (capability) を表す SID 構造体へのポインター。CheckTokenCapability 関数は、このアクセストークンの機能を確認します。
HasCapabilityBOOL*out確認の結果を受け取ります。アクセストークンがその機能を持っている場合は TRUE を、持っていない場合は FALSE を返します。

戻り値の型: BOOL

公式ドキュメント

指定されたトークンの機能 (capability) を確認します。

戻り値

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

関数が失敗した場合、戻り値は 0 になります。詳細なエラー情報を取得するには、GetLastError を呼び出してください。

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

各言語での呼び出し定義

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

BOOL CheckTokenCapability(
    HANDLE TokenHandle,   // optional
    PSID CapabilitySidToCheck,
    BOOL* HasCapability
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CheckTokenCapability(
    IntPtr TokenHandle,   // HANDLE optional
    IntPtr CapabilitySidToCheck,   // PSID
    out bool HasCapability   // BOOL* out
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CheckTokenCapability(
    TokenHandle As IntPtr,   ' HANDLE optional
    CapabilitySidToCheck As IntPtr,   ' PSID
    <Out> ByRef HasCapability As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' TokenHandle : HANDLE optional
' CapabilitySidToCheck : PSID
' HasCapability : BOOL* out
Declare PtrSafe Function CheckTokenCapability Lib "kernel32" ( _
    ByVal TokenHandle As LongPtr, _
    ByVal CapabilitySidToCheck As LongPtr, _
    ByRef HasCapability As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CheckTokenCapability = ctypes.windll.kernel32.CheckTokenCapability
CheckTokenCapability.restype = wintypes.BOOL
CheckTokenCapability.argtypes = [
    wintypes.HANDLE,  # TokenHandle : HANDLE optional
    wintypes.HANDLE,  # CapabilitySidToCheck : PSID
    ctypes.c_void_p,  # HasCapability : BOOL* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CheckTokenCapability = Fiddle::Function.new(
  lib['CheckTokenCapability'],
  [
    Fiddle::TYPE_VOIDP,  # TokenHandle : HANDLE optional
    Fiddle::TYPE_VOIDP,  # CapabilitySidToCheck : PSID
    Fiddle::TYPE_VOIDP,  # HasCapability : BOOL* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn CheckTokenCapability(
        TokenHandle: *mut core::ffi::c_void,  // HANDLE optional
        CapabilitySidToCheck: *mut core::ffi::c_void,  // PSID
        HasCapability: *mut i32  // BOOL* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool CheckTokenCapability(IntPtr TokenHandle, IntPtr CapabilitySidToCheck, out bool HasCapability);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CheckTokenCapability' -Namespace Win32 -PassThru
# $api::CheckTokenCapability(TokenHandle, CapabilitySidToCheck, HasCapability)
#uselib "KERNEL32.dll"
#func global CheckTokenCapability "CheckTokenCapability" sptr, sptr, sptr
; CheckTokenCapability TokenHandle, CapabilitySidToCheck, varptr(HasCapability)   ; 戻り値は stat
; TokenHandle : HANDLE optional -> "sptr"
; CapabilitySidToCheck : PSID -> "sptr"
; HasCapability : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global CheckTokenCapability "CheckTokenCapability" sptr, sptr, var
; res = CheckTokenCapability(TokenHandle, CapabilitySidToCheck, HasCapability)
; TokenHandle : HANDLE optional -> "sptr"
; CapabilitySidToCheck : PSID -> "sptr"
; HasCapability : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL CheckTokenCapability(HANDLE TokenHandle, PSID CapabilitySidToCheck, BOOL* HasCapability)
#uselib "KERNEL32.dll"
#cfunc global CheckTokenCapability "CheckTokenCapability" intptr, intptr, var
; res = CheckTokenCapability(TokenHandle, CapabilitySidToCheck, HasCapability)
; TokenHandle : HANDLE optional -> "intptr"
; CapabilitySidToCheck : PSID -> "intptr"
; HasCapability : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCheckTokenCapability = kernel32.NewProc("CheckTokenCapability")
)

// TokenHandle (HANDLE optional), CapabilitySidToCheck (PSID), HasCapability (BOOL* out)
r1, _, err := procCheckTokenCapability.Call(
	uintptr(TokenHandle),
	uintptr(CapabilitySidToCheck),
	uintptr(HasCapability),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CheckTokenCapability(
  TokenHandle: THandle;   // HANDLE optional
  CapabilitySidToCheck: THandle;   // PSID
  HasCapability: Pointer   // BOOL* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CheckTokenCapability';
result := DllCall("KERNEL32\CheckTokenCapability"
    , "Ptr", TokenHandle   ; HANDLE optional
    , "Ptr", CapabilitySidToCheck   ; PSID
    , "Ptr", HasCapability   ; BOOL* out
    , "Int")   ; return: BOOL
●CheckTokenCapability(TokenHandle, CapabilitySidToCheck, HasCapability) = DLL("KERNEL32.dll", "bool CheckTokenCapability(void*, void*, void*)")
# 呼び出し: CheckTokenCapability(TokenHandle, CapabilitySidToCheck, HasCapability)
# TokenHandle : HANDLE optional -> "void*"
# CapabilitySidToCheck : PSID -> "void*"
# HasCapability : BOOL* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn CheckTokenCapability(
    TokenHandle: ?*anyopaque, // HANDLE optional
    CapabilitySidToCheck: ?*anyopaque, // PSID
    HasCapability: [*c]i32 // BOOL* out
) callconv(std.os.windows.WINAPI) i32;
proc CheckTokenCapability(
    TokenHandle: pointer,  # HANDLE optional
    CapabilitySidToCheck: pointer,  # PSID
    HasCapability: ptr int32  # BOOL* out
): int32 {.importc: "CheckTokenCapability", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int CheckTokenCapability(
    void* TokenHandle,   // HANDLE optional
    void* CapabilitySidToCheck,   // PSID
    int* HasCapability   // BOOL* out
);
ccall((:CheckTokenCapability, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Int32}),
      TokenHandle, CapabilitySidToCheck, HasCapability)
# TokenHandle : HANDLE optional -> Ptr{Cvoid}
# CapabilitySidToCheck : PSID -> Ptr{Cvoid}
# HasCapability : BOOL* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CheckTokenCapability(
    void* TokenHandle,
    void* CapabilitySidToCheck,
    int32_t* HasCapability);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CheckTokenCapability(TokenHandle, CapabilitySidToCheck, HasCapability)
-- TokenHandle : HANDLE optional
-- CapabilitySidToCheck : PSID
-- HasCapability : BOOL* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CheckTokenCapability = lib.func('__stdcall', 'CheckTokenCapability', 'int32_t', ['void *', 'void *', 'int32_t *']);
// CheckTokenCapability(TokenHandle, CapabilitySidToCheck, HasCapability)
// TokenHandle : HANDLE optional -> 'void *'
// CapabilitySidToCheck : PSID -> 'void *'
// HasCapability : BOOL* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CheckTokenCapability: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.CheckTokenCapability(TokenHandle, CapabilitySidToCheck, HasCapability)
// TokenHandle : HANDLE optional -> "pointer"
// CapabilitySidToCheck : PSID -> "pointer"
// HasCapability : BOOL* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CheckTokenCapability(
    void* TokenHandle,
    void* CapabilitySidToCheck,
    int32_t* HasCapability);
C, "KERNEL32.dll");
// $ffi->CheckTokenCapability(TokenHandle, CapabilitySidToCheck, HasCapability);
// TokenHandle : HANDLE optional
// CapabilitySidToCheck : PSID
// HasCapability : BOOL* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean CheckTokenCapability(
        Pointer TokenHandle,   // HANDLE optional
        Pointer CapabilitySidToCheck,   // PSID
        IntByReference HasCapability   // BOOL* out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun CheckTokenCapability = CheckTokenCapability(
    TokenHandle : Void*,   # HANDLE optional
    CapabilitySidToCheck : Void*,   # PSID
    HasCapability : Int32*   # BOOL* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CheckTokenCapabilityNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Int32>);
typedef CheckTokenCapabilityDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Int32>);
final CheckTokenCapability = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CheckTokenCapabilityNative, CheckTokenCapabilityDart>('CheckTokenCapability');
// TokenHandle : HANDLE optional -> Pointer<Void>
// CapabilitySidToCheck : PSID -> Pointer<Void>
// HasCapability : BOOL* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CheckTokenCapability(
  TokenHandle: THandle;   // HANDLE optional
  CapabilitySidToCheck: THandle;   // PSID
  HasCapability: Pointer   // BOOL* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CheckTokenCapability';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CheckTokenCapability"
  c_CheckTokenCapability :: Ptr () -> Ptr () -> Ptr CInt -> IO CInt
-- TokenHandle : HANDLE optional -> Ptr ()
-- CapabilitySidToCheck : PSID -> Ptr ()
-- HasCapability : BOOL* out -> Ptr CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let checktokencapability =
  foreign "CheckTokenCapability"
    ((ptr void) @-> (ptr void) @-> (ptr int32_t) @-> returning int32_t)
(* TokenHandle : HANDLE optional -> (ptr void) *)
(* CapabilitySidToCheck : PSID -> (ptr void) *)
(* HasCapability : BOOL* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CheckTokenCapability" check-token-capability :convention :stdcall) :int32
  (token-handle :pointer)   ; HANDLE optional
  (capability-sid-to-check :pointer)   ; PSID
  (has-capability :pointer))   ; BOOL* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CheckTokenCapability = Win32::API::More->new('KERNEL32',
    'BOOL CheckTokenCapability(HANDLE TokenHandle, HANDLE CapabilitySidToCheck, LPVOID HasCapability)');
# my $ret = $CheckTokenCapability->Call($TokenHandle, $CapabilitySidToCheck, $HasCapability);
# TokenHandle : HANDLE optional -> HANDLE
# CapabilitySidToCheck : PSID -> HANDLE
# HasCapability : BOOL* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。