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

IsTokenRestricted

関数
アクセストークンが制限付きトークンかどうかを判定する。
DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL IsTokenRestricted(
    HANDLE TokenHandle
);

パラメーター

名前方向説明
TokenHandleHANDLEinテスト対象のアクセス トークンへのハンドル。

戻り値の型: BOOL

公式ドキュメント

トークンが制限付きセキュリティ識別子 (SID) のリストを含むかどうかを示します。

戻り値

トークンが制限付き SID のリストを含む場合、戻り値は 0 以外になります。

トークンが制限付き SID のリストを含まない場合、戻り値は 0 になります。

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

解説(Remarks)

CreateRestrictedToken 関数は、SID を無効化し、特権を削除し、制限付き SID のリストを指定することでトークンを制限できます。IsTokenRestricted 関数は、制限付き SID のリストのみをチェックします。トークンが制限付き SID を一切持たない場合、そのトークンが CreateRestrictedToken の呼び出しによって作成されたものであっても、IsTokenRestrictedFALSE を返します。

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

各言語での呼び出し定義

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

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

IsTokenRestricted = ctypes.windll.advapi32.IsTokenRestricted
IsTokenRestricted.restype = wintypes.BOOL
IsTokenRestricted.argtypes = [
    wintypes.HANDLE,  # TokenHandle : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
IsTokenRestricted = Fiddle::Function.new(
  lib['IsTokenRestricted'],
  [
    Fiddle::TYPE_VOIDP,  # TokenHandle : HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn IsTokenRestricted(
        TokenHandle: *mut core::ffi::c_void  // HANDLE
    ) -> 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 IsTokenRestricted(IntPtr TokenHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_IsTokenRestricted' -Namespace Win32 -PassThru
# $api::IsTokenRestricted(TokenHandle)
#uselib "ADVAPI32.dll"
#func global IsTokenRestricted "IsTokenRestricted" sptr
; IsTokenRestricted TokenHandle   ; 戻り値は stat
; TokenHandle : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global IsTokenRestricted "IsTokenRestricted" sptr
; res = IsTokenRestricted(TokenHandle)
; TokenHandle : HANDLE -> "sptr"
; BOOL IsTokenRestricted(HANDLE TokenHandle)
#uselib "ADVAPI32.dll"
#cfunc global IsTokenRestricted "IsTokenRestricted" intptr
; res = IsTokenRestricted(TokenHandle)
; TokenHandle : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procIsTokenRestricted = advapi32.NewProc("IsTokenRestricted")
)

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

extern "advapi32" fn IsTokenRestricted(
    TokenHandle: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) i32;
proc IsTokenRestricted(
    TokenHandle: pointer  # HANDLE
): int32 {.importc: "IsTokenRestricted", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
int IsTokenRestricted(
    void* TokenHandle   // HANDLE
);
ccall((:IsTokenRestricted, "ADVAPI32.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      TokenHandle)
# TokenHandle : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t IsTokenRestricted(
    void* TokenHandle);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.IsTokenRestricted(TokenHandle)
-- TokenHandle : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const IsTokenRestricted = lib.func('__stdcall', 'IsTokenRestricted', 'int32_t', ['void *']);
// IsTokenRestricted(TokenHandle)
// TokenHandle : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  IsTokenRestricted: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.IsTokenRestricted(TokenHandle)
// TokenHandle : HANDLE -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t IsTokenRestricted(
    void* TokenHandle);
C, "ADVAPI32.dll");
// $ffi->IsTokenRestricted(TokenHandle);
// TokenHandle : HANDLE
// 構造体/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 Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class);
    boolean IsTokenRestricted(
        Pointer TokenHandle   // HANDLE
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun IsTokenRestricted = IsTokenRestricted(
    TokenHandle : Void*   # HANDLE
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

let istokenrestricted =
  foreign "IsTokenRestricted"
    ((ptr void) @-> returning int32_t)
(* TokenHandle : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("IsTokenRestricted" is-token-restricted :convention :stdcall) :int32
  (token-handle :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IsTokenRestricted = Win32::API::More->new('ADVAPI32',
    'BOOL IsTokenRestricted(HANDLE TokenHandle)');
# my $ret = $IsTokenRestricted->Call($TokenHandle);
# TokenHandle : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目