ホーム › System.Com › CoQueryProxyBlanket

CoQueryProxyBlanket

関数

プロキシに設定された認証情報や認証レベルを取得する。

DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoQueryProxyBlanket(
    IUnknown* pProxy,
    DWORD* pwAuthnSvc,   // optional
    DWORD* pAuthzSvc,   // optional
    LPWSTR* pServerPrincName,   // optional
    DWORD* pAuthnLevel,   // optional
    DWORD* pImpLevel,   // optional
    void** pAuthInfo,   // optional
    DWORD* pCapabilites   // optional
);

パラメーター

名前	型	方向	説明
pProxy	IUnknown*	in	照会対象のプロキシを示すポインター。このパラメーターを NULL にすることはできません。詳細については、解説のセクションを参照してください。
pwAuthnSvc	DWORD*	outoptional	現在の認証サービスを受け取る変数へのポインター。これは認証サービス定数から取られる単一の値です。このパラメーターを NULL にすることはできません。
pAuthzSvc	DWORD*	outoptional	現在の承認サービスを受け取る変数へのポインター。これは承認定数から取られる単一の値です。呼び出し元が NULL を指定した場合、現在の承認サービスは取得されません。
pServerPrincName	LPWSTR*	outoptional	現在のプリンシパル名。文字列は呼び出される側が CoTaskMemAlloc を使用して割り当て、呼び出し元が CoTaskMemFree を使用して解放する必要があります。EOAC_MAKE_FULLSIC フラグは pCapabilities パラメーターでは受け付けられません。msstd 形式および fullsic 形式の詳細については、Principal Names を参照してください。呼び出し元が NULL を指定した場合、現在のプリンシパル名は取得されません。
pAuthnLevel	DWORD*	outoptional	現在の認証レベルを受け取る変数へのポインター。これは認証レベル定数から取られる単一の値です。呼び出し元が NULL を指定した場合、現在の認証レベルは取得されません。
pImpLevel	DWORD*	outoptional	現在の偽装レベルを受け取る変数へのポインター。これは偽装レベル定数から取られる単一の値です。呼び出し元が NULL を指定した場合、現在の偽装レベルは取得されません。
pAuthInfo	void**	outoptional	直近の IClientSecurity::SetBlanket の呼び出しに渡されたクライアントの ID(または既定値)を受け取るハンドルへのポインター。既定値はプロキシが解放されるまでの間のみ有効です。呼び出し元が NULL を指定した場合、クライアント ID は取得されません。ハンドルが参照する構造体の形式は認証サービスによって異なります。アプリケーションはそのメモリーへの書き込みや解放を行ってはいけません。NTLMSSP および Kerberos の場合、クライアントが CoInitializeSecurity の pAuthInfo パラメーターで構造体を指定していれば、その値が返されます。Schannel の場合、クライアントの証明書を証明書マネージャーから取得できれば、その値がここに返されます。それ以外の場合は NULL が返されます。RPC_AUTH_IDENTITY_HANDLE を参照してください。
pCapabilites	DWORD*	outoptional	プロキシの機能を受け取る変数へのポインター。呼び出し元が NULL を指定した場合、現在の機能フラグは取得されません。

戻り値の型: HRESULT

公式ドキュメント

指定したプロキシ上で呼び出しを行う際にクライアントが使用する認証情報を取得します。

戻り値

この関数は、標準の戻り値である E_INVALIDARG、E_OUTOFMEMORY、および S_OK を返すことがあります。

解説(Remarks)

CoQueryProxyBlanket は、指定したプロキシから行われる呼び出しで COM が使用する認証情報を取得するために、クライアントによって呼び出されます。この関数は、次の一連の一般的な呼び出しをカプセル化します(エラー処理は省略)。

pProxy->QueryInterface(IID_IClientSecurity, (void**)&pcs);
pcs->QueryBlanket(
    pProxy, pAuthnSvc, pAuthzSvc, pServerPrincName, pAuthnLevel, pImpLevel, ppAuthInfo, pCapabilities
  );
pcs->Release();

このシーケンスは、プロキシに対して QueryInterface を呼び出して IClientSecurity へのポインターを取得し、得られたポインターを使って IClientSecurity::QueryBlanket を呼び出した後、そのポインターを解放します。

pProxy には、CoCreateInstance や CoUnmarshalInterface の呼び出しによって取得したプロキシなど、任意のプロキシを渡すことができます。また、インターフェイスポインターを渡すこともできます。これは任意のインターフェイスでかまいません。プロキシではないものへのポインターを渡すことはできません。したがって、インターフェイス定義に local キーワードが付いたインターフェイスへのポインターは渡せません。そのようなインターフェイスにはプロキシが作成されないためです。IUnknown はこのルールの例外です。

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

各言語での呼び出し定義

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

HRESULT CoQueryProxyBlanket(
    IUnknown* pProxy,
    DWORD* pwAuthnSvc,   // optional
    DWORD* pAuthzSvc,   // optional
    LPWSTR* pServerPrincName,   // optional
    DWORD* pAuthnLevel,   // optional
    DWORD* pImpLevel,   // optional
    void** pAuthInfo,   // optional
    DWORD* pCapabilites   // optional
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoQueryProxyBlanket(
    IntPtr pProxy,   // IUnknown*
    IntPtr pwAuthnSvc,   // DWORD* optional, out
    IntPtr pAuthzSvc,   // DWORD* optional, out
    IntPtr pServerPrincName,   // LPWSTR* optional, out
    IntPtr pAuthnLevel,   // DWORD* optional, out
    IntPtr pImpLevel,   // DWORD* optional, out
    IntPtr pAuthInfo,   // void** optional, out
    IntPtr pCapabilites   // DWORD* optional, out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoQueryProxyBlanket(
    pProxy As IntPtr,   ' IUnknown*
    pwAuthnSvc As IntPtr,   ' DWORD* optional, out
    pAuthzSvc As IntPtr,   ' DWORD* optional, out
    pServerPrincName As IntPtr,   ' LPWSTR* optional, out
    pAuthnLevel As IntPtr,   ' DWORD* optional, out
    pImpLevel As IntPtr,   ' DWORD* optional, out
    pAuthInfo As IntPtr,   ' void** optional, out
    pCapabilites As IntPtr   ' DWORD* optional, out
) As Integer
End Function

' pProxy : IUnknown*
' pwAuthnSvc : DWORD* optional, out
' pAuthzSvc : DWORD* optional, out
' pServerPrincName : LPWSTR* optional, out
' pAuthnLevel : DWORD* optional, out
' pImpLevel : DWORD* optional, out
' pAuthInfo : void** optional, out
' pCapabilites : DWORD* optional, out
Declare PtrSafe Function CoQueryProxyBlanket Lib "ole32" ( _
    ByVal pProxy As LongPtr, _
    ByVal pwAuthnSvc As LongPtr, _
    ByVal pAuthzSvc As LongPtr, _
    ByVal pServerPrincName As LongPtr, _
    ByVal pAuthnLevel As LongPtr, _
    ByVal pImpLevel As LongPtr, _
    ByVal pAuthInfo As LongPtr, _
    ByVal pCapabilites As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CoQueryProxyBlanket = ctypes.windll.ole32.CoQueryProxyBlanket
CoQueryProxyBlanket.restype = ctypes.c_int
CoQueryProxyBlanket.argtypes = [
    ctypes.c_void_p,  # pProxy : IUnknown*
    ctypes.POINTER(wintypes.DWORD),  # pwAuthnSvc : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pAuthzSvc : DWORD* optional, out
    ctypes.c_void_p,  # pServerPrincName : LPWSTR* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pAuthnLevel : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pImpLevel : DWORD* optional, out
    ctypes.c_void_p,  # pAuthInfo : void** optional, out
    ctypes.POINTER(wintypes.DWORD),  # pCapabilites : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoQueryProxyBlanket = Fiddle::Function.new(
  lib['CoQueryProxyBlanket'],
  [
    Fiddle::TYPE_VOIDP,  # pProxy : IUnknown*
    Fiddle::TYPE_VOIDP,  # pwAuthnSvc : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pAuthzSvc : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pServerPrincName : LPWSTR* optional, out
    Fiddle::TYPE_VOIDP,  # pAuthnLevel : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pImpLevel : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pAuthInfo : void** optional, out
    Fiddle::TYPE_VOIDP,  # pCapabilites : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn CoQueryProxyBlanket(
        pProxy: *mut core::ffi::c_void,  // IUnknown*
        pwAuthnSvc: *mut u32,  // DWORD* optional, out
        pAuthzSvc: *mut u32,  // DWORD* optional, out
        pServerPrincName: *mut *mut u16,  // LPWSTR* optional, out
        pAuthnLevel: *mut u32,  // DWORD* optional, out
        pImpLevel: *mut u32,  // DWORD* optional, out
        pAuthInfo: *mut *mut (),  // void** optional, out
        pCapabilites: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoQueryProxyBlanket(IntPtr pProxy, IntPtr pwAuthnSvc, IntPtr pAuthzSvc, IntPtr pServerPrincName, IntPtr pAuthnLevel, IntPtr pImpLevel, IntPtr pAuthInfo, IntPtr pCapabilites);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoQueryProxyBlanket' -Namespace Win32 -PassThru
# $api::CoQueryProxyBlanket(pProxy, pwAuthnSvc, pAuthzSvc, pServerPrincName, pAuthnLevel, pImpLevel, pAuthInfo, pCapabilites)

#uselib "OLE32.dll"
#func global CoQueryProxyBlanket "CoQueryProxyBlanket" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CoQueryProxyBlanket pProxy, varptr(pwAuthnSvc), varptr(pAuthzSvc), varptr(pServerPrincName), varptr(pAuthnLevel), varptr(pImpLevel), pAuthInfo, varptr(pCapabilites)   ; 戻り値は stat
; pProxy : IUnknown* -> "sptr"
; pwAuthnSvc : DWORD* optional, out -> "sptr"
; pAuthzSvc : DWORD* optional, out -> "sptr"
; pServerPrincName : LPWSTR* optional, out -> "sptr"
; pAuthnLevel : DWORD* optional, out -> "sptr"
; pImpLevel : DWORD* optional, out -> "sptr"
; pAuthInfo : void** optional, out -> "sptr"
; pCapabilites : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global CoQueryProxyBlanket "CoQueryProxyBlanket" sptr, var, var, var, var, var, sptr, var
; res = CoQueryProxyBlanket(pProxy, pwAuthnSvc, pAuthzSvc, pServerPrincName, pAuthnLevel, pImpLevel, pAuthInfo, pCapabilites)
; pProxy : IUnknown* -> "sptr"
; pwAuthnSvc : DWORD* optional, out -> "var"
; pAuthzSvc : DWORD* optional, out -> "var"
; pServerPrincName : LPWSTR* optional, out -> "var"
; pAuthnLevel : DWORD* optional, out -> "var"
; pImpLevel : DWORD* optional, out -> "var"
; pAuthInfo : void** optional, out -> "sptr"
; pCapabilites : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global CoQueryProxyBlanket "CoQueryProxyBlanket" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; res = CoQueryProxyBlanket(pProxy, varptr(pwAuthnSvc), varptr(pAuthzSvc), varptr(pServerPrincName), varptr(pAuthnLevel), varptr(pImpLevel), pAuthInfo, varptr(pCapabilites))
; pProxy : IUnknown* -> "sptr"
; pwAuthnSvc : DWORD* optional, out -> "sptr"
; pAuthzSvc : DWORD* optional, out -> "sptr"
; pServerPrincName : LPWSTR* optional, out -> "sptr"
; pAuthnLevel : DWORD* optional, out -> "sptr"
; pImpLevel : DWORD* optional, out -> "sptr"
; pAuthInfo : void** optional, out -> "sptr"
; pCapabilites : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。