ホーム › Networking.HttpServer › HttpReceiveClientCertificate

HttpReceiveClientCertificate

関数

クライアントのSSL証明書情報を受信する。

DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD HttpReceiveClientCertificate(
    HANDLE RequestQueueHandle,
    ULONGLONG ConnectionId,
    DWORD Flags,
    HTTP_SSL_CLIENT_CERT_INFO* SslClientCertInfo,
    DWORD SslClientCertInfoSize,
    DWORD* BytesReceived,   // optional
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前

型

方向

説明

RequestQueueHandle

HANDLE

指定された SSL クライアントまたは CBT が関連付けられているリクエストキューへのハンドルです。リクエストキューは HttpCreateRequestQueue 関数の呼び出しによって作成され、そのハンドルが返されます。

Windows Server 2003 with SP1 および Windows XP with SP2: リクエストキューへのハンドルは HttpCreateHttpHandle 関数によって作成されます。

ConnectionId

ULONGLONG

クライアントへの接続を識別する値です。この値は、 HttpReceiveHttpRequest 関数によって設定された HTTP_REQUEST 構造体の ConnectionId 要素から取得します。

Flags

DWORD

HttpReceiveClientCertificate 関数の動作を変更する値です。

値	意味
HTTP_RECEIVE_SECURE_CHANNEL_TOKEN 0x1	pSslClientCertInfo パラメーターに CBT データが設定されます。この値は Windows 7、Windows Server 2008 R2 以降でサポートされます。

SslClientCertInfo

HTTP_SSL_CLIENT_CERT_INFO*

out

Flags パラメーターが 0 の場合、このパラメーターは HTTP_SSL_CLIENT_CERT_INFO 構造体を指し、関数は要求されたクライアント証明書情報をこの構造体に書き込みます。pSslClientCertInfo が指すバッファーは、HTTP_SSL_CLIENT_CERT_INFO 構造体に加えてこの構造体の CertEncodedSize メンバーの値を保持できる十分な大きさである必要があります。

Flags パラメーターが HTTP_RECEIVE_SECURE_CHANNEL_TOKEN の場合、このパラメーターは HTTP_REQUEST_CHANNEL_BIND_STATUS 構造体を指し、関数は要求された CBT 情報をこの構造体に書き込みます。pSslClientCertInfo が指すバッファーは、HTTP_REQUEST_CHANNEL_BIND_STATUS 構造体に加えてこの構造体の ChannelTokenSize メンバーの値を保持できる十分な大きさである必要があります。

SslClientCertInfoSize

DWORD

pSslClientCertInfo パラメーターが指すバッファーのサイズ (バイト単位) です。

BytesReceived

DWORD*

outoptional

pSslClientCertInfo が指す構造体に書き込まれるバイト数を受け取る変数への省略可能なポインターです。使用しない場合は NULL を設定します。

pOverlapped を使用して非同期呼び出しを行う場合は、pBytesReceived を NULL に設定します。一方、pOverlapped が NULL に設定されている場合は、pBytesReceived は有効なメモリアドレスを含む必要があり、NULL に設定してはなりません。

Overlapped

OVERLAPPED*

inoutoptional

非同期呼び出しの場合は、pOverlapped が OVERLAPPED 構造体を指すように設定します。同期呼び出しの場合は NULL に設定します。

同期呼び出しはクライアント証明書が取得されるまでブロックされますが、非同期呼び出しはただちに ERROR_IO_PENDING を返し、呼び出し側アプリケーションは GetOverlappedResult または I/O 完了ポートを使用して操作の完了を判定します。同期処理のために OVERLAPPED 構造体を使用する方法の詳細については、 Synchronization and Overlapped Input and Output のセクションを参照してください。

戻り値の型: DWORD

公式ドキュメント

HttpReceiveClientCertificate 関数は、サーバーアプリケーションがクライアントの SSL 証明書またはチャネルバインディングトークン (CBT) を取得するために使用します。

戻り値

値	意味
NO_ERROR	関数は成功しました。すべてのデータが pSslClientCertInfo パラメーターが指すバッファーに書き込まれました。NumberOfBytesTransferred は、バッファーに書き込まれたバイト数を示します。
ERROR_IO_PENDING	関数は非同期で使用されています。操作は開始され、通常のオーバーラップ I/O 完了メカニズムを通じて後で完了します。
ERROR_INVALID_PARAMETER	指定されたパラメーターのうち、1 つ以上が無効です。
ERROR_INSUFFICIENT_BUFFER	pSslClientCertInfo パラメーターが指すバッファーがデータを受け取るには小さすぎ、データは書き込まれませんでした。
ERROR_MORE_DATA	pSslClientCertInfo パラメーターが指すバッファーが、すべてのデータを受け取るには十分な大きさではありません。基本構造体のみが書き込まれ、部分的にのみ設定されています。 Flags パラメーターが 0 の場合、HTTP_SSL_CLIENT_CERT_INFO 構造体が書き込まれ、CertEncodedSize メンバーが設定されています。呼び出し側は、少なくとも HTTP_SSL_CLIENT_CERT_INFO 構造体のサイズ (バイト単位) に CertEncodedSize メンバーの値を加えた大きさのバッファーで関数を再度呼び出す必要があります。 Flags パラメーターが HTTP_RECEIVE_SECURE_CHANNEL_TOKEN の場合、HTTP_REQUEST_CHANNEL_BIND_STATUS 構造体が書き込まれ、ChannelTokenSize メンバーが設定されています。呼び出し側は、少なくとも HTTP_REQUEST_CHANNEL_BIND_STATUS のサイズ (バイト単位) に ChannelTokenSize メンバーの値を加えた大きさのバッファーで関数を再度呼び出す必要があります。
ERROR_NOT_FOUND	関数はクライアント証明書または CBT を見つけられません。
その他	WinError.h ヘッダーファイルで定義されているシステムエラーコードです。

解説(Remarks)

HttpReceiveClientCertificate 関数の動作は、クライアント SSL 証明書とチャネルバインディングトークンのどちらが要求されているかによって異なります。

HttpReceiveClientCertificate 関数を同期的に呼び出した場合、受信したバイト数は pBytesReceived パラメーターが指す値に返されます。

HttpReceiveClientCertificate 関数を非同期的に呼び出した場合、受信したバイト数は非同期呼び出しに使用される標準的なメカニズムによって返されます。 GetOverlappedResult 関数によって返される lpNumberOfBytesTransferred パラメーターに、受信したバイト数が格納されます。

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

各言語での呼び出し定義

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

DWORD HttpReceiveClientCertificate(
    HANDLE RequestQueueHandle,
    ULONGLONG ConnectionId,
    DWORD Flags,
    HTTP_SSL_CLIENT_CERT_INFO* SslClientCertInfo,
    DWORD SslClientCertInfoSize,
    DWORD* BytesReceived,   // optional
    OVERLAPPED* Overlapped   // optional
);

[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpReceiveClientCertificate(
    IntPtr RequestQueueHandle,   // HANDLE
    ulong ConnectionId,   // ULONGLONG
    uint Flags,   // DWORD
    IntPtr SslClientCertInfo,   // HTTP_SSL_CLIENT_CERT_INFO* out
    uint SslClientCertInfoSize,   // DWORD
    IntPtr BytesReceived,   // DWORD* optional, out
    IntPtr Overlapped   // OVERLAPPED* optional, in/out
);

<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpReceiveClientCertificate(
    RequestQueueHandle As IntPtr,   ' HANDLE
    ConnectionId As ULong,   ' ULONGLONG
    Flags As UInteger,   ' DWORD
    SslClientCertInfo As IntPtr,   ' HTTP_SSL_CLIENT_CERT_INFO* out
    SslClientCertInfoSize As UInteger,   ' DWORD
    BytesReceived As IntPtr,   ' DWORD* optional, out
    Overlapped As IntPtr   ' OVERLAPPED* optional, in/out
) As UInteger
End Function

' RequestQueueHandle : HANDLE
' ConnectionId : ULONGLONG
' Flags : DWORD
' SslClientCertInfo : HTTP_SSL_CLIENT_CERT_INFO* out
' SslClientCertInfoSize : DWORD
' BytesReceived : DWORD* optional, out
' Overlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function HttpReceiveClientCertificate Lib "httpapi" ( _
    ByVal RequestQueueHandle As LongPtr, _
    ByVal ConnectionId As LongLong, _
    ByVal Flags As Long, _
    ByVal SslClientCertInfo As LongPtr, _
    ByVal SslClientCertInfoSize As Long, _
    ByVal BytesReceived As LongPtr, _
    ByVal Overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

HttpReceiveClientCertificate = ctypes.windll.httpapi.HttpReceiveClientCertificate
HttpReceiveClientCertificate.restype = wintypes.DWORD
HttpReceiveClientCertificate.argtypes = [
    wintypes.HANDLE,  # RequestQueueHandle : HANDLE
    ctypes.c_ulonglong,  # ConnectionId : ULONGLONG
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_void_p,  # SslClientCertInfo : HTTP_SSL_CLIENT_CERT_INFO* out
    wintypes.DWORD,  # SslClientCertInfoSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # BytesReceived : DWORD* optional, out
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpReceiveClientCertificate = Fiddle::Function.new(
  lib['HttpReceiveClientCertificate'],
  [
    Fiddle::TYPE_VOIDP,  # RequestQueueHandle : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # ConnectionId : ULONGLONG
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # SslClientCertInfo : HTTP_SSL_CLIENT_CERT_INFO* out
    -Fiddle::TYPE_INT,  # SslClientCertInfoSize : DWORD
    Fiddle::TYPE_VOIDP,  # BytesReceived : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "httpapi")]
extern "system" {
    fn HttpReceiveClientCertificate(
        RequestQueueHandle: *mut core::ffi::c_void,  // HANDLE
        ConnectionId: u64,  // ULONGLONG
        Flags: u32,  // DWORD
        SslClientCertInfo: *mut HTTP_SSL_CLIENT_CERT_INFO,  // HTTP_SSL_CLIENT_CERT_INFO* out
        SslClientCertInfoSize: u32,  // DWORD
        BytesReceived: *mut u32,  // DWORD* optional, out
        Overlapped: *mut OVERLAPPED  // OVERLAPPED* optional, in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpReceiveClientCertificate(IntPtr RequestQueueHandle, ulong ConnectionId, uint Flags, IntPtr SslClientCertInfo, uint SslClientCertInfoSize, IntPtr BytesReceived, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpReceiveClientCertificate' -Namespace Win32 -PassThru
# $api::HttpReceiveClientCertificate(RequestQueueHandle, ConnectionId, Flags, SslClientCertInfo, SslClientCertInfoSize, BytesReceived, Overlapped)

#uselib "HTTPAPI.dll"
#func global HttpReceiveClientCertificate "HttpReceiveClientCertificate" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; HttpReceiveClientCertificate RequestQueueHandle, ConnectionId, Flags, varptr(SslClientCertInfo), SslClientCertInfoSize, varptr(BytesReceived), varptr(Overlapped)   ; 戻り値は stat
; RequestQueueHandle : HANDLE -> "sptr"
; ConnectionId : ULONGLONG -> "sptr"
; Flags : DWORD -> "sptr"
; SslClientCertInfo : HTTP_SSL_CLIENT_CERT_INFO* out -> "sptr"
; SslClientCertInfoSize : DWORD -> "sptr"
; BytesReceived : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "HTTPAPI.dll"
#cfunc global HttpReceiveClientCertificate "HttpReceiveClientCertificate" sptr, int64, int, var, int, var, var
; res = HttpReceiveClientCertificate(RequestQueueHandle, ConnectionId, Flags, SslClientCertInfo, SslClientCertInfoSize, BytesReceived, Overlapped)
; RequestQueueHandle : HANDLE -> "sptr"
; ConnectionId : ULONGLONG -> "int64"
; Flags : DWORD -> "int"
; SslClientCertInfo : HTTP_SSL_CLIENT_CERT_INFO* out -> "var"
; SslClientCertInfoSize : DWORD -> "int"
; BytesReceived : DWORD* optional, out -> "var"
; Overlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "HTTPAPI.dll"
#cfunc global HttpReceiveClientCertificate "HttpReceiveClientCertificate" sptr, int64, int, sptr, int, sptr, sptr
; res = HttpReceiveClientCertificate(RequestQueueHandle, ConnectionId, Flags, varptr(SslClientCertInfo), SslClientCertInfoSize, varptr(BytesReceived), varptr(Overlapped))
; RequestQueueHandle : HANDLE -> "sptr"
; ConnectionId : ULONGLONG -> "int64"
; Flags : DWORD -> "int"
; SslClientCertInfo : HTTP_SSL_CLIENT_CERT_INFO* out -> "sptr"
; SslClientCertInfoSize : DWORD -> "int"
; BytesReceived : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。