ホーム › Networking.WinSock › WSAQuerySocketSecurity

WSAQuerySocketSecurity

関数

ソケットに適用されたセキュリティ情報を照会する。

DLLfwpuclnt.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

INT WSAQuerySocketSecurity(
    SOCKET Socket,
    const SOCKET_SECURITY_QUERY_TEMPLATE* SecurityQueryTemplate,   // optional
    DWORD SecurityQueryTemplateLen,
    SOCKET_SECURITY_QUERY_INFO* SecurityQueryInfo,   // optional
    DWORD* SecurityQueryInfoLen,
    OVERLAPPED* Overlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE CompletionRoutine   // optional
);

パラメーター

名前	型	方向	説明
Socket	SOCKET	in	セキュリティ情報を照会する socket を識別する記述子。
SecurityQueryTemplate	SOCKET_SECURITY_QUERY_TEMPLATE*	inoptional	返す照会情報の種類を指定する SOCKET_SECURITY_QUERY_TEMPLATE 構造体へのポインター。このパラメーターが指す SOCKET_SECURITY_QUERY_TEMPLATE 構造体は、既定のセキュリティ情報を要求するために、すべてのメンバーをゼロにすることができます。正常に返された場合、返される SecurityQueryInfo パラメーター内の SOCKET_SECURITY_QUERY_INFO では Flags メンバーのみが設定されます。 Socket パラメーターが IPPROTO_TCP プロトコルで作成された場合、このパラメーターは NULL ポインターにすることができます。この場合、返される情報は、すべての値をゼロに設定した SOCKET_SECURITY_QUERY_TEMPLATE 構造体を渡した場合と同じになります。IPPROTO_TCP プロトコルの socket で既定のセキュリティ情報を超える情報が必要な場合は、このパラメーターを指定する必要があります。 SOCKET_SECURITY_QUERY_TEMPLATE 構造体で PeerTokenAccessMask メンバーが指定されていない (ゼロに設定された) 場合、WSAQuerySocketSecurity 関数は SOCKET_SECURITY_QUERY_INFO 構造体の PeerApplicationAccessTokenHandle および PeerMachineAccessTokenHandle メンバーを返しません。 Socket パラメーターが IPPROTO_TCP 以外のプロトコルで作成された場合は、SecurityQueryTemplate パラメーターを指定する必要があります。これらの場合、SOCKET_SECURITY_QUERY_TEMPLATE 構造体の PeerAddress メンバーで、AF_INET または AF_INET6 のアドレスファミリと、ピアの IP アドレスおよびポート番号を指定する必要があります。
SecurityQueryTemplateLen	DWORD	in	SecurityQueryTemplate パラメーターのサイズ (バイト単位)。 Socket パラメーターが IPPROTO_TCP プロトコルで作成された場合、このパラメーターはゼロにすることができます。それ以外の場合、このパラメーターは SOCKET_SECURITY_QUERY_TEMPLATE 構造体のサイズである必要があります。
SecurityQueryInfo	SOCKET_SECURITY_QUERY_INFO*	outoptional	照会された情報を格納する SOCKET_SECURITY_QUERY_INFO 構造体を受け取るバッファーへのポインター。この値を NULL に設定すると、出力バッファーのサイズを照会できます。
SecurityQueryInfoLen	DWORD*	inout	入力時には、SecurityQueryInfo パラメーターのサイズ (バイト単位) へのポインター。バッファーが小さすぎて照会された情報を受け取れない場合、呼び出しは SOCKET_ERROR を返し、照会された情報を返すために必要なバイト数がこのパラメーターが指す値に設定されます。呼び出しが成功した場合は、コピーされたバイト数が返されます。
Overlapped	OVERLAPPED*	inoptional	WSAOVERLAPPED 構造体へのポインター。このパラメーターは、オーバーラップしない socket では無視されます。
CompletionRoutine	LPWSAOVERLAPPED_COMPLETION_ROUTINE	inoptional	操作が完了したときに呼び出される完了ルーチンへのポインター。このパラメーターは、オーバーラップしない socket では無視されます。

戻り値の型: INT

公式ドキュメント

socket 上の接続に適用されているセキュリティに関する情報を照会します。

戻り値

関数が成功した場合、戻り値はゼロです。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで具体的なエラーコードを取得できます。

発生し得るエラーコードの一部を以下に示します。

エラーコード	意味
WSAEAFNOSUPPORT	指定されたアドレスファミリはサポートされていません。
WSAECONNRESET	ストリーム socket の場合、仮想回線がリモート側によってリセットされました。アプリケーションはその socket が使用できなくなるため、socket を閉じる必要があります。UDP データグラム socket の場合、このエラーは以前の送信操作が ICMP の "Port Unreachable" メッセージを引き起こしたことを示します。
WSAEFAULT	パラメーターを使用しようとした際に、システムが無効なポインターアドレスを検出しました。このエラーは、SecurityQueryInfoLen パラメーターが NULL ポインターであった場合に返されます。
WSAEINVAL	無効なパラメーターが渡されました。このエラーは、Socket パラメーターで渡された socket が、AF_INET または AF_INET6 のアドレスファミリと、SOCK_DGRAM または SOCK_STREAM の socket 型で作成されていなかった場合に返されます。
WSAEMSGSIZE	渡されたバッファーが小さすぎました。このエラーは、プロトコルが IPPROTO_TCP でない Socket パラメーターに対して、SecurityQueryInfo パラメーターが NULL ポインターであるか、SecurityQueryTemplateLen パラメーターが SOCKET_SECURITY_QUERY_TEMPLATE 構造体のサイズより小さい場合に返されます。
WSAENOTSOCK	Socket パラメーターで渡された記述子が有効な socket ではありません。

解説(Remarks)

WSAQuerySocketSecurity 関数は、socket における現在のセキュリティ設定を照会する方法を提供します。接続が確立された後、WSAQuerySocketSecurity 関数を使用すると、アプリケーションは接続のセキュリティプロパティを照会でき、これにはピアアクセストークンに関する情報を含めることができます。

コネクション指向の socket の場合、接続が確立された直後に WSAQuerySocketSecurity 関数を呼び出すことが推奨されます。コネクションレスの socket の場合、新しいピアアドレスへデータが送信された直後、または新しいピアアドレスから受信された直後に WSAQuerySocketSecurity 関数を呼び出すことが推奨されます。WSAQuerySocketSecurity 関数は、単一の socket に対して複数回呼び出すことができます。

この関数は、dwIoControlCode パラメーターを SIO_QUERY_SECURITY に設定して WSAIoctl 関数を呼び出す必要がある処理を簡素化します。

WSAQuerySocketSecurity 関数は、AF_INET または AF_INET6 のアドレスファミリで作成された Socket パラメーターに対して呼び出すことができます。

Socket パラメーターが IPPROTO_TCP プロトコルで作成された場合、SecurityQueryTemplate パラメーターは NULL に、SecurityQueryTemplateLen パラメーターはゼロにすることができます。それ以外の場合、SecurityQueryTemplate パラメーターは SOCKET_SECURITY_QUERY_TEMPLATE 構造体を指している必要があります。

コネクション指向の socket (IPPROTO_TCP プロトコルで作成された socket) を使用するクライアントアプリケーションの場合、WSAQuerySocketSecurity 関数は connect、ConnectEx、または WSAConnect 関数が返った後に呼び出す必要があります。コネクション指向の socket (IPPROTO_TCP プロトコル) を使用するサーバーアプリケーションの場合、WSAQuerySocketSecurity 関数は accept、AcceptEx、または WSAAccept 関数が返った後に呼び出す必要があります。

コネクションレスの socket (IPPROTO_UDP プロトコルで作成された socket) の場合、アプリケーションは新しいピアアドレスに対する WSASendTo または WSARecvFrom の呼び出しが返った直後に WSAQuerySocketSecurity 関数を呼び出す必要があります。

次の条件が満たされない場合、エラーが返されます。

Socket パラメーターのアドレスファミリは AF_INET または AF_INET6 のいずれかである必要があります。
socket 型は SOCK_STREAM または SOCK_DGRAM のいずれかである必要があります。

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

各言語での呼び出し定義

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

INT WSAQuerySocketSecurity(
    SOCKET Socket,
    const SOCKET_SECURITY_QUERY_TEMPLATE* SecurityQueryTemplate,   // optional
    DWORD SecurityQueryTemplateLen,
    SOCKET_SECURITY_QUERY_INFO* SecurityQueryInfo,   // optional
    DWORD* SecurityQueryInfoLen,
    OVERLAPPED* Overlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE CompletionRoutine   // optional
);

[DllImport("fwpuclnt.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSAQuerySocketSecurity(
    UIntPtr Socket,   // SOCKET
    IntPtr SecurityQueryTemplate,   // SOCKET_SECURITY_QUERY_TEMPLATE* optional
    uint SecurityQueryTemplateLen,   // DWORD
    IntPtr SecurityQueryInfo,   // SOCKET_SECURITY_QUERY_INFO* optional, out
    ref uint SecurityQueryInfoLen,   // DWORD* in/out
    IntPtr Overlapped,   // OVERLAPPED* optional
    IntPtr CompletionRoutine   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
);

<DllImport("fwpuclnt.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAQuerySocketSecurity(
    Socket As UIntPtr,   ' SOCKET
    SecurityQueryTemplate As IntPtr,   ' SOCKET_SECURITY_QUERY_TEMPLATE* optional
    SecurityQueryTemplateLen As UInteger,   ' DWORD
    SecurityQueryInfo As IntPtr,   ' SOCKET_SECURITY_QUERY_INFO* optional, out
    ByRef SecurityQueryInfoLen As UInteger,   ' DWORD* in/out
    Overlapped As IntPtr,   ' OVERLAPPED* optional
    CompletionRoutine As IntPtr   ' LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
) As Integer
End Function

' Socket : SOCKET
' SecurityQueryTemplate : SOCKET_SECURITY_QUERY_TEMPLATE* optional
' SecurityQueryTemplateLen : DWORD
' SecurityQueryInfo : SOCKET_SECURITY_QUERY_INFO* optional, out
' SecurityQueryInfoLen : DWORD* in/out
' Overlapped : OVERLAPPED* optional
' CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
Declare PtrSafe Function WSAQuerySocketSecurity Lib "fwpuclnt" ( _
    ByVal Socket As LongPtr, _
    ByVal SecurityQueryTemplate As LongPtr, _
    ByVal SecurityQueryTemplateLen As Long, _
    ByVal SecurityQueryInfo As LongPtr, _
    ByRef SecurityQueryInfoLen As Long, _
    ByVal Overlapped As LongPtr, _
    ByVal CompletionRoutine As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSAQuerySocketSecurity = ctypes.windll.fwpuclnt.WSAQuerySocketSecurity
WSAQuerySocketSecurity.restype = ctypes.c_int
WSAQuerySocketSecurity.argtypes = [
    ctypes.c_size_t,  # Socket : SOCKET
    ctypes.c_void_p,  # SecurityQueryTemplate : SOCKET_SECURITY_QUERY_TEMPLATE* optional
    wintypes.DWORD,  # SecurityQueryTemplateLen : DWORD
    ctypes.c_void_p,  # SecurityQueryInfo : SOCKET_SECURITY_QUERY_INFO* optional, out
    ctypes.POINTER(wintypes.DWORD),  # SecurityQueryInfoLen : DWORD* in/out
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional
    ctypes.c_void_p,  # CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('fwpuclnt.dll')
WSAQuerySocketSecurity = Fiddle::Function.new(
  lib['WSAQuerySocketSecurity'],
  [
    Fiddle::TYPE_UINTPTR_T,  # Socket : SOCKET
    Fiddle::TYPE_VOIDP,  # SecurityQueryTemplate : SOCKET_SECURITY_QUERY_TEMPLATE* optional
    -Fiddle::TYPE_INT,  # SecurityQueryTemplateLen : DWORD
    Fiddle::TYPE_VOIDP,  # SecurityQueryInfo : SOCKET_SECURITY_QUERY_INFO* optional, out
    Fiddle::TYPE_VOIDP,  # SecurityQueryInfoLen : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional
    Fiddle::TYPE_VOIDP,  # CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "fwpuclnt")]
extern "system" {
    fn WSAQuerySocketSecurity(
        Socket: usize,  // SOCKET
        SecurityQueryTemplate: *const SOCKET_SECURITY_QUERY_TEMPLATE,  // SOCKET_SECURITY_QUERY_TEMPLATE* optional
        SecurityQueryTemplateLen: u32,  // DWORD
        SecurityQueryInfo: *mut SOCKET_SECURITY_QUERY_INFO,  // SOCKET_SECURITY_QUERY_INFO* optional, out
        SecurityQueryInfoLen: *mut u32,  // DWORD* in/out
        Overlapped: *mut OVERLAPPED,  // OVERLAPPED* optional
        CompletionRoutine: *const core::ffi::c_void  // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("fwpuclnt.dll", SetLastError = true)]
public static extern int WSAQuerySocketSecurity(UIntPtr Socket, IntPtr SecurityQueryTemplate, uint SecurityQueryTemplateLen, IntPtr SecurityQueryInfo, ref uint SecurityQueryInfoLen, IntPtr Overlapped, IntPtr CompletionRoutine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'fwpuclnt_WSAQuerySocketSecurity' -Namespace Win32 -PassThru
# $api::WSAQuerySocketSecurity(Socket, SecurityQueryTemplate, SecurityQueryTemplateLen, SecurityQueryInfo, SecurityQueryInfoLen, Overlapped, CompletionRoutine)

#uselib "fwpuclnt.dll"
#func global WSAQuerySocketSecurity "WSAQuerySocketSecurity" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WSAQuerySocketSecurity Socket, varptr(SecurityQueryTemplate), SecurityQueryTemplateLen, varptr(SecurityQueryInfo), varptr(SecurityQueryInfoLen), varptr(Overlapped), CompletionRoutine   ; 戻り値は stat
; Socket : SOCKET -> "sptr"
; SecurityQueryTemplate : SOCKET_SECURITY_QUERY_TEMPLATE* optional -> "sptr"
; SecurityQueryTemplateLen : DWORD -> "sptr"
; SecurityQueryInfo : SOCKET_SECURITY_QUERY_INFO* optional, out -> "sptr"
; SecurityQueryInfoLen : DWORD* in/out -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "fwpuclnt.dll"
#cfunc global WSAQuerySocketSecurity "WSAQuerySocketSecurity" sptr, var, int, var, var, var, sptr
; res = WSAQuerySocketSecurity(Socket, SecurityQueryTemplate, SecurityQueryTemplateLen, SecurityQueryInfo, SecurityQueryInfoLen, Overlapped, CompletionRoutine)
; Socket : SOCKET -> "sptr"
; SecurityQueryTemplate : SOCKET_SECURITY_QUERY_TEMPLATE* optional -> "var"
; SecurityQueryTemplateLen : DWORD -> "int"
; SecurityQueryInfo : SOCKET_SECURITY_QUERY_INFO* optional, out -> "var"
; SecurityQueryInfoLen : DWORD* in/out -> "var"
; Overlapped : OVERLAPPED* optional -> "var"
; CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "fwpuclnt.dll"
#cfunc global WSAQuerySocketSecurity "WSAQuerySocketSecurity" sptr, sptr, int, sptr, sptr, sptr, sptr
; res = WSAQuerySocketSecurity(Socket, varptr(SecurityQueryTemplate), SecurityQueryTemplateLen, varptr(SecurityQueryInfo), varptr(SecurityQueryInfoLen), varptr(Overlapped), CompletionRoutine)
; Socket : SOCKET -> "sptr"
; SecurityQueryTemplate : SOCKET_SECURITY_QUERY_TEMPLATE* optional -> "sptr"
; SecurityQueryTemplateLen : DWORD -> "int"
; SecurityQueryInfo : SOCKET_SECURITY_QUERY_INFO* optional, out -> "sptr"
; SecurityQueryInfoLen : DWORD* in/out -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。