ホーム › Security › CheckTokenMembership

CheckTokenMembership

関数

トークンに指定SIDが有効なメンバーとして含まれるか判定する。

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

シグネチャ

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

BOOL CheckTokenMembership(
    HANDLE TokenHandle,   // optional
    PSID SidToCheck,
    BOOL* IsMember
);

パラメーター

名前	型	方向	説明
TokenHandle	HANDLE	inoptional	アクセストークンへのハンドル。このハンドルには、トークンに対する TOKEN_QUERY アクセス権が必要です。トークンは偽装トークン (impersonation token) である必要があります。 TokenHandle が NULL の場合、CheckTokenMembership は呼び出し元スレッドの偽装トークンを使用します。スレッドが偽装を行っていない場合、この関数はスレッドのプライマリトークン (primary token) を複製して偽装トークンを作成します。
SidToCheck	PSID	in	SID 構造体へのポインター。CheckTokenMembership 関数は、アクセストークンのユーザー SID およびグループ SID の中にこの SID が存在するかどうかを確認します。
IsMember	BOOL*	out	確認結果を受け取る変数へのポインター。SID が存在し、かつ SE_GROUP_ENABLED 属性を持つ場合、IsMember には TRUE が返されます。それ以外の場合は FALSE が返されます。

名前

型

方向

説明

TokenHandle

HANDLE

inoptional

アクセストークンへのハンドル。このハンドルには、トークンに対する TOKEN_QUERY アクセス権が必要です。トークンは偽装トークン (impersonation token) である必要があります。

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

SidToCheck

PSID

SID 構造体へのポインター。CheckTokenMembership 関数は、アクセストークンのユーザー SID およびグループ SID の中にこの SID が存在するかどうかを確認します。

IsMember

BOOL*

out

確認結果を受け取る変数へのポインター。SID が存在し、かつ SE_GROUP_ENABLED 属性を持つ場合、IsMember には TRUE が返されます。それ以外の場合は FALSE が返されます。

戻り値の型: BOOL

公式ドキュメント

指定したセキュリティ識別子 (SID) がアクセストークン内で有効になっているかどうかを判定します。

戻り値

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

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

解説(Remarks)

CheckTokenMembership 関数は、ある SID がアクセストークン内に存在し、かつ有効になっているかどうかを判定する処理を簡略化します。

SID がトークン内に存在していても、システムがアクセスチェックでその SID を使用しない場合があります。SID は無効化されているか、SE_GROUP_USE_FOR_DENY_ONLY 属性を持っている可能性があります。システムは、アクセスチェックの実行時に有効な SID のみを使用してアクセスを許可します。詳細については、 SID Attributes in an Access Token を参照してください。

TokenHandle が制限付きトークンである場合、または TokenHandle が NULL で呼び出し元スレッドの現在の実効トークンが制限付きトークンである場合、CheckTokenMembership は、その SID が制限 SID のリスト内に存在するかどうかも確認します。

例

次の例は、トークンが Administrators ローカルグループのメンバーであるかどうかを確認する方法を示しています。

BOOL IsUserAdmin(VOID)
/*++ 
Routine Description: This routine returns TRUE if the caller's
process is a member of the Administrators local group. Caller is NOT
expected to be impersonating anyone and is expected to be able to
open its own process and process token. 
Arguments: None. 
Return Value: 
   TRUE - Caller has Administrators local group. 
   FALSE - Caller does not have Administrators local group. --
*/ 
{
    BOOL b;
    SID_IDENTIFIER_AUTHORITY NtAuthority = SECURITY_NT_AUTHORITY;
    PSID AdministratorsGroup;
    b = AllocateAndInitializeSid(
        &NtAuthority,
        2,
        SECURITY_BUILTIN_DOMAIN_RID,
        DOMAIN_ALIAS_RID_ADMINS,
        0, 0, 0, 0, 0, 0,
        &AdministratorsGroup );

    if(b)
    {
        if (!CheckTokenMembership( NULL, AdministratorsGroup, &b))
        {
             b = FALSE;
        }
        FreeSid(AdministratorsGroup);
    }

    return(b);
}

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

各言語での呼び出し定義

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

BOOL CheckTokenMembership(
    HANDLE TokenHandle,   // optional
    PSID SidToCheck,
    BOOL* IsMember
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CheckTokenMembership(
    IntPtr TokenHandle,   // HANDLE optional
    IntPtr SidToCheck,   // PSID
    out bool IsMember   // BOOL* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CheckTokenMembership(
    TokenHandle As IntPtr,   ' HANDLE optional
    SidToCheck As IntPtr,   ' PSID
    <Out> ByRef IsMember As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' TokenHandle : HANDLE optional
' SidToCheck : PSID
' IsMember : BOOL* out
Declare PtrSafe Function CheckTokenMembership Lib "advapi32" ( _
    ByVal TokenHandle As LongPtr, _
    ByVal SidToCheck As LongPtr, _
    ByRef IsMember As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CheckTokenMembership = ctypes.windll.advapi32.CheckTokenMembership
CheckTokenMembership.restype = wintypes.BOOL
CheckTokenMembership.argtypes = [
    wintypes.HANDLE,  # TokenHandle : HANDLE optional
    wintypes.HANDLE,  # SidToCheck : PSID
    ctypes.c_void_p,  # IsMember : BOOL* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CheckTokenMembership = Fiddle::Function.new(
  lib['CheckTokenMembership'],
  [
    Fiddle::TYPE_VOIDP,  # TokenHandle : HANDLE optional
    Fiddle::TYPE_VOIDP,  # SidToCheck : PSID
    Fiddle::TYPE_VOIDP,  # IsMember : BOOL* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CheckTokenMembership(
        TokenHandle: *mut core::ffi::c_void,  // HANDLE optional
        SidToCheck: *mut core::ffi::c_void,  // PSID
        IsMember: *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 CheckTokenMembership(IntPtr TokenHandle, IntPtr SidToCheck, out bool IsMember);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CheckTokenMembership' -Namespace Win32 -PassThru
# $api::CheckTokenMembership(TokenHandle, SidToCheck, IsMember)

#uselib "ADVAPI32.dll"
#func global CheckTokenMembership "CheckTokenMembership" sptr, sptr, sptr
; CheckTokenMembership TokenHandle, SidToCheck, varptr(IsMember)   ; 戻り値は stat
; TokenHandle : HANDLE optional -> "sptr"
; SidToCheck : PSID -> "sptr"
; IsMember : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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