ホーム › Networking.WinSock › WSASetSocketPeerTargetName

WSASetSocketPeerTargetName

関数

ソケット通信相手のターゲット名を設定し認証に使用する。

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

シグネチャ

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

INT WSASetSocketPeerTargetName(
    SOCKET Socket,
    const SOCKET_PEER_TARGET_NAME* PeerTargetName,
    DWORD PeerTargetNameLen,
    OVERLAPPED* Overlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE CompletionRoutine   // optional
);

パラメーター

名前	型	方向	説明
Socket	SOCKET	in	ピアのターゲット名を割り当てる対象のソケットを識別する記述子。
PeerTargetName	SOCKET_PEER_TARGET_NAME*	in	ピアのターゲット名を定義する SOCKET_PEER_TARGET_NAME 構造体へのポインター。
PeerTargetNameLen	DWORD	in	PeerTargetName パラメーターのサイズ (バイト単位)。
Overlapped	OVERLAPPED*	inoptional	WSAOVERLAPPED 構造体へのポインター。このパラメーターは、非オーバーラップソケットでは無視されます。
CompletionRoutine	LPWSAOVERLAPPED_COMPLETION_ROUTINE	inoptional	操作が完了したときに呼び出される完了ルーチンへのポインター。このパラメーターは、非オーバーラップソケットでは無視されます。

戻り値の型: INT

公式ドキュメント

ピアの IP アドレスに対応するピアのターゲット名 (SPN) を指定するために使用します。このターゲット名は、認証すべきピアを安全に識別するために、クライアントアプリケーションが指定することを意図しています。

戻り値

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

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

エラーコード	意味
WSAEAFNOSUPPORT	指定されたアドレスファミリはサポートされていません。
WSAEFAULT	呼び出しのポインター引数を使用しようとした際に、システムが無効なアドレスポインターを検出しました。このエラーは、PeerTargetName パラメーターが NULL ポインターであった場合に返されます。
WSAEINVAL	無効なパラメーターが渡されました。このエラーは、Socket パラメーターで渡されたソケットが、AF_INET または AF_INET6 のアドレスファミリと、SOCK_DGRAM または SOCK_STREAM のソケットタイプで作成されていない場合に返されます。また、コネクションレスソケットで、PeerTargetName パラメーターが指す SOCKET_PEER_TARGET_NAME 構造体の PeerAddress メンバーにおいて IP アドレスとポートが 0 の場合にも返されます。
WSAEISCONN	ソケットは接続済みです。この関数は、コネクション指向かコネクションレスかにかかわらず、接続済みのソケットでは許可されていません。
WSAEMSGSIZE	渡されたバッファーが小さすぎます。
WSAENOTSOCK	Socket パラメーターで渡された記述子は有効なソケットではありません。

解説(Remarks)

WSASetSocketPeerTargetName 関数は、ピアのセキュリティプリンシパルに対応するターゲット名を指定する手段を提供します。この関数は、認証すべきピアを識別するためにクライアントアプリケーションが使用することを意図しています。クライアントアプリケーションは、信頼された中間者攻撃 (man-in-the-middle attack) を防ぐために、ピアのターゲット名を指定する必要があります。コネクションレスソケットの場合、アプリケーションは WSASetSocketPeerTargetName 関数を複数回呼び出すことで、異なるピアの IP アドレスに対して異なるターゲット名を指定できます。

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

コネクション指向のソケットの場合、WSASetSocketPeerTargetName 関数は WSAConnect の前に呼び出す必要があります。コネクションレスソケットの場合、この関数は WSAConnect の前、またはピアアドレス宛ての最初の WSASendTo 呼び出しの前に呼び出す必要があります。

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

Socket パラメーターのアドレスファミリは、AF_INET または AF_INET6 のいずれかである必要があります。
ソケットタイプは、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 WSASetSocketPeerTargetName(
    SOCKET Socket,
    const SOCKET_PEER_TARGET_NAME* PeerTargetName,
    DWORD PeerTargetNameLen,
    OVERLAPPED* Overlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE CompletionRoutine   // optional
);

[DllImport("fwpuclnt.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSASetSocketPeerTargetName(
    UIntPtr Socket,   // SOCKET
    IntPtr PeerTargetName,   // SOCKET_PEER_TARGET_NAME*
    uint PeerTargetNameLen,   // DWORD
    IntPtr Overlapped,   // OVERLAPPED* optional
    IntPtr CompletionRoutine   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
);

<DllImport("fwpuclnt.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSASetSocketPeerTargetName(
    Socket As UIntPtr,   ' SOCKET
    PeerTargetName As IntPtr,   ' SOCKET_PEER_TARGET_NAME*
    PeerTargetNameLen As UInteger,   ' DWORD
    Overlapped As IntPtr,   ' OVERLAPPED* optional
    CompletionRoutine As IntPtr   ' LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
) As Integer
End Function

' Socket : SOCKET
' PeerTargetName : SOCKET_PEER_TARGET_NAME*
' PeerTargetNameLen : DWORD
' Overlapped : OVERLAPPED* optional
' CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
Declare PtrSafe Function WSASetSocketPeerTargetName Lib "fwpuclnt" ( _
    ByVal Socket As LongPtr, _
    ByVal PeerTargetName As LongPtr, _
    ByVal PeerTargetNameLen 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

WSASetSocketPeerTargetName = ctypes.windll.fwpuclnt.WSASetSocketPeerTargetName
WSASetSocketPeerTargetName.restype = ctypes.c_int
WSASetSocketPeerTargetName.argtypes = [
    ctypes.c_size_t,  # Socket : SOCKET
    ctypes.c_void_p,  # PeerTargetName : SOCKET_PEER_TARGET_NAME*
    wintypes.DWORD,  # PeerTargetNameLen : DWORD
    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')
WSASetSocketPeerTargetName = Fiddle::Function.new(
  lib['WSASetSocketPeerTargetName'],
  [
    Fiddle::TYPE_UINTPTR_T,  # Socket : SOCKET
    Fiddle::TYPE_VOIDP,  # PeerTargetName : SOCKET_PEER_TARGET_NAME*
    -Fiddle::TYPE_INT,  # PeerTargetNameLen : DWORD
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional
    Fiddle::TYPE_VOIDP,  # CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "fwpuclnt")]
extern "system" {
    fn WSASetSocketPeerTargetName(
        Socket: usize,  // SOCKET
        PeerTargetName: *const SOCKET_PEER_TARGET_NAME,  // SOCKET_PEER_TARGET_NAME*
        PeerTargetNameLen: u32,  // DWORD
        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 WSASetSocketPeerTargetName(UIntPtr Socket, IntPtr PeerTargetName, uint PeerTargetNameLen, IntPtr Overlapped, IntPtr CompletionRoutine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'fwpuclnt_WSASetSocketPeerTargetName' -Namespace Win32 -PassThru
# $api::WSASetSocketPeerTargetName(Socket, PeerTargetName, PeerTargetNameLen, Overlapped, CompletionRoutine)

#uselib "fwpuclnt.dll"
#func global WSASetSocketPeerTargetName "WSASetSocketPeerTargetName" sptr, sptr, sptr, sptr, sptr
; WSASetSocketPeerTargetName Socket, varptr(PeerTargetName), PeerTargetNameLen, varptr(Overlapped), CompletionRoutine   ; 戻り値は stat
; Socket : SOCKET -> "sptr"
; PeerTargetName : SOCKET_PEER_TARGET_NAME* -> "sptr"
; PeerTargetNameLen : DWORD -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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