ホーム › System.Com › CoQueryAuthenticationServices

CoQueryAuthenticationServices

関数

プロセスに登録済みの認証サービス一覧を取得する。

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

シグネチャ

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

HRESULT CoQueryAuthenticationServices(
    DWORD* pcAuthSvc,
    SOLE_AUTHENTICATION_SERVICE** asAuthSvc
);

パラメーター

名前	型	方向	説明
pcAuthSvc	DWORD*	out	asAuthSvc 配列で返されるエントリ数を受け取る変数へのポインター。
asAuthSvc	SOLE_AUTHENTICATION_SERVICE**	out	SOLE_AUTHENTICATION_SERVICE 構造体の配列へのポインター。この一覧は CoTaskMemAlloc 関数の呼び出しによって割り当てられます。呼び出し側は、使用し終えたら CoTaskMemFree 関数を呼び出して一覧を解放する必要があります。

戻り値の型: HRESULT

公式ドキュメント

プロセスが CoInitializeSecurity を呼び出した際に登録された認証サービスの一覧を取得します。

戻り値

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

解説(Remarks)

CoQueryAuthenticationServices は、現在登録されている認証サービスの一覧を取得します。プロセスが CoInitializeSecurity を呼び出している場合は、その呼び出しによって登録されたサービスが返されます。アプリケーションがこれを呼び出さない場合は、最初にインターフェイスがマーシャリングまたはアンマーシャリングされる際に COM によって CoInitializeSecurity が自動的に呼び出され、既定のセキュリティパッケージが登録されます。

この関数は、CoInitializeSecurity で登録された認証サービスのみを返します。コンピューターにインストールされているすべての認証サービスを返すわけではありませんが、EnumerateSecurityPackages はそれらすべてを返します。CoQueryAuthenticationServices は主に、カスタムマーシャラーがアプリケーションで使用できるプリンシパル名を判別するために役立ちます。

認証サービスごとにサポートするセキュリティのレベルは異なります。たとえば、NTLMSSP は委任や相互認証をサポートしませんが、Kerberos はサポートします。アプリケーションは、自身が必要とする機能を提供する認証サービスのみを登録する責任を負います。この関数は、CoInitializeSecurity でどのサービスが登録されたかを確認する手段を提供します。

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

各言語での呼び出し定義

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

HRESULT CoQueryAuthenticationServices(
    DWORD* pcAuthSvc,
    SOLE_AUTHENTICATION_SERVICE** asAuthSvc
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoQueryAuthenticationServices(
    out uint pcAuthSvc,   // DWORD* out
    IntPtr asAuthSvc   // SOLE_AUTHENTICATION_SERVICE** out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoQueryAuthenticationServices(
    <Out> ByRef pcAuthSvc As UInteger,   ' DWORD* out
    asAuthSvc As IntPtr   ' SOLE_AUTHENTICATION_SERVICE** out
) As Integer
End Function

' pcAuthSvc : DWORD* out
' asAuthSvc : SOLE_AUTHENTICATION_SERVICE** out
Declare PtrSafe Function CoQueryAuthenticationServices Lib "ole32" ( _
    ByRef pcAuthSvc As Long, _
    ByVal asAuthSvc As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CoQueryAuthenticationServices = ctypes.windll.ole32.CoQueryAuthenticationServices
CoQueryAuthenticationServices.restype = ctypes.c_int
CoQueryAuthenticationServices.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # pcAuthSvc : DWORD* out
    ctypes.c_void_p,  # asAuthSvc : SOLE_AUTHENTICATION_SERVICE** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoQueryAuthenticationServices = Fiddle::Function.new(
  lib['CoQueryAuthenticationServices'],
  [
    Fiddle::TYPE_VOIDP,  # pcAuthSvc : DWORD* out
    Fiddle::TYPE_VOIDP,  # asAuthSvc : SOLE_AUTHENTICATION_SERVICE** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn CoQueryAuthenticationServices(
        pcAuthSvc: *mut u32,  // DWORD* out
        asAuthSvc: *mut *mut SOLE_AUTHENTICATION_SERVICE  // SOLE_AUTHENTICATION_SERVICE** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoQueryAuthenticationServices(out uint pcAuthSvc, IntPtr asAuthSvc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoQueryAuthenticationServices' -Namespace Win32 -PassThru
# $api::CoQueryAuthenticationServices(pcAuthSvc, asAuthSvc)

#uselib "OLE32.dll"
#func global CoQueryAuthenticationServices "CoQueryAuthenticationServices" sptr, sptr
; CoQueryAuthenticationServices varptr(pcAuthSvc), varptr(asAuthSvc)   ; 戻り値は stat
; pcAuthSvc : DWORD* out -> "sptr"
; asAuthSvc : SOLE_AUTHENTICATION_SERVICE** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global CoQueryAuthenticationServices "CoQueryAuthenticationServices" var, var
; res = CoQueryAuthenticationServices(pcAuthSvc, asAuthSvc)
; pcAuthSvc : DWORD* out -> "var"
; asAuthSvc : SOLE_AUTHENTICATION_SERVICE** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global CoQueryAuthenticationServices "CoQueryAuthenticationServices" sptr, sptr
; res = CoQueryAuthenticationServices(varptr(pcAuthSvc), varptr(asAuthSvc))
; pcAuthSvc : DWORD* out -> "sptr"
; asAuthSvc : SOLE_AUTHENTICATION_SERVICE** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。