ホーム › System.Rpc › RpcGetAuthorizationContextForClient

RpcGetAuthorizationContextForClient

関数

クライアントの認可コンテキストを取得する。

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

シグネチャ

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

RPC_STATUS RpcGetAuthorizationContextForClient(
    void* ClientBinding,   // optional
    BOOL ImpersonateOnReturn,
    void* Reserved1,   // optional
    LONGLONG* pExpirationTime,   // optional
    LUID Reserved2,
    DWORD Reserved3,
    void* Reserved4,   // optional
    void** pAuthzClientContext
);

パラメーター

名前	型	方向	説明
ClientBinding	void*	inoptional	クライアントへのバインドを表す、サーバー側のバインディングハンドル。サーバーは、このハンドルが示すクライアントを偽装します。値に 0 を指定した場合、サーバーは、このサーバースレッドが処理しているクライアントを偽装します。
ImpersonateOnReturn	BOOL	in	リターン時にクライアントを偽装してから AUTHZ_CLIENT_CONTEXT_HANDLE 構造体を返すように、関数に指示します。クライアントを偽装するには、このパラメーターに 0 以外の値を設定します。「解説」を参照してください。
Reserved1	void*	inoptional	予約されています。null でなければなりません。
pExpirationTime	LONGLONG*	inoptional	トークンの有効期限の日時へのポインター。値を渡さない場合、トークンの有効期限は切れません。有効期限は現在のところ強制されません。
Reserved2	LUID	in	予約されています。各メンバーを 0 に設定した LUID 構造体でなければなりません。
Reserved3	DWORD	in	予約されています。0 でなければなりません。
Reserved4	void*	inoptional	予約されています。null でなければなりません。
pAuthzClientContext	void**	out	Authz 関数に直接渡すことができる AUTHZ_CLIENT_CONTEXT_HANDLE 構造体へのポインター。関数が失敗した場合、このパラメーターの内容は未定義です。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcGetAuthorizationContextForClient 関数は、高パフォーマンスな認証のために Authz 関数と共に使用できる、RPC クライアント用の Authz コンテキストを返します。ncalrpc および ncacn_* プロトコルシーケンスでのみサポートされます。

戻り値

値	説明
RPC_S_OK	呼び出しに成功しました。
RERROR_INVALID_PARAMETER	予約済みパラメーターの値が、規定された値と異なります。
RPC_S_NO_CONTEXT_AVAILABLE	RPC クライアントの認証に成功していません。

失敗した場合は、RPC_S_* エラーコードまたは Windows エラーコードが返されます。拡張エラー情報は、標準的な RPC または Windows のエラーコード取得メカニズムを通じて取得できます。有効なエラーコードの一覧については、 RPC Return Values を参照してください。

解説(Remarks)

RpcGetAuthorizationContextForClient 関数は、 RpcImpersonateClient 関数と同じコンテキストで呼び出すことができます。偽装を行うすべての関数は、呼び出し元が SeImpersonatePrivilege 特権を持っているかどうかを確認します。呼び出し元が SeImpersonatePrivilege を持っている場合、または認証された ID が呼び出し元と同一である場合、要求された偽装が許可されます。それ以外の場合、偽装は Identify レベルでのみ成功します。

メモ SeImpersonatePrivilege 特権は、Windows XP Service Pack 2 (SP2) より前ではサポートされません。

RpcGetAuthorizationContextForClient 関数は ncalrpc および ncacn_* プロトコルシーケンスでのみサポートされ、トランスポートセキュリティのみを実装する名前付きパイプではサポートされません。

RpcGetAuthorizationContextForClient 関数はスレッドセーフであり、複数のスレッドから呼び出すことができます。pAuthzClientContext に返されるコンテキストは関数呼び出しから独立しており、呼び出しの完了後も使用できます。呼び出し元は、 RpcFreeAuthorizationContext 関数を呼び出してコンテキストを解放する責任があります。

従来の偽装、アクセスチェック、または自己への復帰の方法と比較した場合の、 RpcGetAuthorizationContextForClient 関数の使用によって得られるパフォーマンスの向上は、次の要素に依存します。

特定のクライアント ID に対して関数が呼び出される回数。
その関数呼び出しで有効なプロトコルシーケンスと ID 追跡。

同じクライアント ID に対する 2 回目以降の RpcGetAuthorizationContextForClient 関数の呼び出しは、コストが極めて低くなります。この効率は、以前の問い合わせの結果がキャッシュされ、可能な限りキャッシュから応答が返されることによって実現されています。

静的な ID 追跡を使用する ncalrpc 経由の呼び出しは、動的な ID 追跡を使用する ncalrpc 経由の呼び出しよりも RpcGetAuthorizationContextForClient 関数の実行が高速です。ncacn_* 経由の呼び出しは、ID 追跡が静的か動的かにかかわらず、特定のプロトコルシーケンスに対してほぼ同じ速度で実行されます。

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

各言語での呼び出し定義

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

RPC_STATUS RpcGetAuthorizationContextForClient(
    void* ClientBinding,   // optional
    BOOL ImpersonateOnReturn,
    void* Reserved1,   // optional
    LONGLONG* pExpirationTime,   // optional
    LUID Reserved2,
    DWORD Reserved3,
    void* Reserved4,   // optional
    void** pAuthzClientContext
);

[DllImport("RPCRT4.dll", ExactSpelling = true)]
static extern int RpcGetAuthorizationContextForClient(
    IntPtr ClientBinding,   // void* optional
    bool ImpersonateOnReturn,   // BOOL
    IntPtr Reserved1,   // void* optional
    IntPtr pExpirationTime,   // LONGLONG* optional
    LUID Reserved2,   // LUID
    uint Reserved3,   // DWORD
    IntPtr Reserved4,   // void* optional
    IntPtr pAuthzClientContext   // void** out
);

<DllImport("RPCRT4.dll", ExactSpelling:=True)>
Public Shared Function RpcGetAuthorizationContextForClient(
    ClientBinding As IntPtr,   ' void* optional
    ImpersonateOnReturn As Boolean,   ' BOOL
    Reserved1 As IntPtr,   ' void* optional
    pExpirationTime As IntPtr,   ' LONGLONG* optional
    Reserved2 As LUID,   ' LUID
    Reserved3 As UInteger,   ' DWORD
    Reserved4 As IntPtr,   ' void* optional
    pAuthzClientContext As IntPtr   ' void** out
) As Integer
End Function

' ClientBinding : void* optional
' ImpersonateOnReturn : BOOL
' Reserved1 : void* optional
' pExpirationTime : LONGLONG* optional
' Reserved2 : LUID
' Reserved3 : DWORD
' Reserved4 : void* optional
' pAuthzClientContext : void** out
Declare PtrSafe Function RpcGetAuthorizationContextForClient Lib "rpcrt4" ( _
    ByVal ClientBinding As LongPtr, _
    ByVal ImpersonateOnReturn As Long, _
    ByVal Reserved1 As LongPtr, _
    ByVal pExpirationTime As LongPtr, _
    ByVal Reserved2 As LongPtr, _
    ByVal Reserved3 As Long, _
    ByVal Reserved4 As LongPtr, _
    ByVal pAuthzClientContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RpcGetAuthorizationContextForClient = ctypes.windll.rpcrt4.RpcGetAuthorizationContextForClient
RpcGetAuthorizationContextForClient.restype = ctypes.c_int
RpcGetAuthorizationContextForClient.argtypes = [
    ctypes.POINTER(None),  # ClientBinding : void* optional
    wintypes.BOOL,  # ImpersonateOnReturn : BOOL
    ctypes.POINTER(None),  # Reserved1 : void* optional
    ctypes.POINTER(ctypes.c_longlong),  # pExpirationTime : LONGLONG* optional
    LUID,  # Reserved2 : LUID
    wintypes.DWORD,  # Reserved3 : DWORD
    ctypes.POINTER(None),  # Reserved4 : void* optional
    ctypes.c_void_p,  # pAuthzClientContext : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCRT4.dll')
RpcGetAuthorizationContextForClient = Fiddle::Function.new(
  lib['RpcGetAuthorizationContextForClient'],
  [
    Fiddle::TYPE_VOIDP,  # ClientBinding : void* optional
    Fiddle::TYPE_INT,  # ImpersonateOnReturn : BOOL
    Fiddle::TYPE_VOIDP,  # Reserved1 : void* optional
    Fiddle::TYPE_VOIDP,  # pExpirationTime : LONGLONG* optional
    Fiddle::TYPE_VOIDP,  # Reserved2 : LUID
    -Fiddle::TYPE_INT,  # Reserved3 : DWORD
    Fiddle::TYPE_VOIDP,  # Reserved4 : void* optional
    Fiddle::TYPE_VOIDP,  # pAuthzClientContext : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "rpcrt4")]
extern "system" {
    fn RpcGetAuthorizationContextForClient(
        ClientBinding: *mut (),  // void* optional
        ImpersonateOnReturn: i32,  // BOOL
        Reserved1: *mut (),  // void* optional
        pExpirationTime: *mut i64,  // LONGLONG* optional
        Reserved2: LUID,  // LUID
        Reserved3: u32,  // DWORD
        Reserved4: *mut (),  // void* optional
        pAuthzClientContext: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RPCRT4.dll")]
public static extern int RpcGetAuthorizationContextForClient(IntPtr ClientBinding, bool ImpersonateOnReturn, IntPtr Reserved1, IntPtr pExpirationTime, LUID Reserved2, uint Reserved3, IntPtr Reserved4, IntPtr pAuthzClientContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcGetAuthorizationContextForClient' -Namespace Win32 -PassThru
# $api::RpcGetAuthorizationContextForClient(ClientBinding, ImpersonateOnReturn, Reserved1, pExpirationTime, Reserved2, Reserved3, Reserved4, pAuthzClientContext)

#uselib "RPCRT4.dll"
#func global RpcGetAuthorizationContextForClient "RpcGetAuthorizationContextForClient" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; RpcGetAuthorizationContextForClient ClientBinding, ImpersonateOnReturn, Reserved1, varptr(pExpirationTime), Reserved2, Reserved3, Reserved4, pAuthzClientContext   ; 戻り値は stat
; ClientBinding : void* optional -> "sptr"
; ImpersonateOnReturn : BOOL -> "sptr"
; Reserved1 : void* optional -> "sptr"
; pExpirationTime : LONGLONG* optional -> "sptr"
; Reserved2 : LUID -> "sptr"
; Reserved3 : DWORD -> "sptr"
; Reserved4 : void* optional -> "sptr"
; pAuthzClientContext : void** out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RPCRT4.dll"
#cfunc global RpcGetAuthorizationContextForClient "RpcGetAuthorizationContextForClient" sptr, int, sptr, var, int, int, sptr, sptr
; res = RpcGetAuthorizationContextForClient(ClientBinding, ImpersonateOnReturn, Reserved1, pExpirationTime, Reserved2, Reserved3, Reserved4, pAuthzClientContext)
; ClientBinding : void* optional -> "sptr"
; ImpersonateOnReturn : BOOL -> "int"
; Reserved1 : void* optional -> "sptr"
; pExpirationTime : LONGLONG* optional -> "var"
; Reserved2 : LUID -> "int"
; Reserved3 : DWORD -> "int"
; Reserved4 : void* optional -> "sptr"
; pAuthzClientContext : void** out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RPCRT4.dll"
#cfunc global RpcGetAuthorizationContextForClient "RpcGetAuthorizationContextForClient" sptr, int, sptr, sptr, int, int, sptr, sptr
; res = RpcGetAuthorizationContextForClient(ClientBinding, ImpersonateOnReturn, Reserved1, varptr(pExpirationTime), Reserved2, Reserved3, Reserved4, pAuthzClientContext)
; ClientBinding : void* optional -> "sptr"
; ImpersonateOnReturn : BOOL -> "int"
; Reserved1 : void* optional -> "sptr"
; pExpirationTime : LONGLONG* optional -> "sptr"
; Reserved2 : LUID -> "int"
; Reserved3 : DWORD -> "int"
; Reserved4 : void* optional -> "sptr"
; pAuthzClientContext : void** out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。