ホーム › Networking.WinSock › WSAImpersonateSocketPeer

WSAImpersonateSocketPeer

関数

ソケットの通信相手のセキュリティコンテキストを偽装する。

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

シグネチャ

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

INT WSAImpersonateSocketPeer(
    SOCKET Socket,
    const SOCKADDR* PeerAddr,   // optional
    DWORD PeerAddrLen
);

パラメーター

名前	型	方向	説明
Socket	SOCKET	in	アプリケーションのソケットを指定します。
PeerAddr	SOCKADDR*	inoptional	なりすまし対象となるピアの IP アドレスです。コネクション指向のソケットでは、接続済みのソケットがピアを一意に識別します。この場合、このパラメーターは無視されます。
PeerAddrLen	DWORD	in	PeerAddress パラメーターのサイズ(バイト単位)です。

戻り値の型: INT

公式ドキュメント

アプリケーションレベルの認可を実行するために、ソケットピアに対応するセキュリティプリンシパルになりすますために使用します。

戻り値

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

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

エラーコード	意味
WSAEFAULT	呼び出しのポインター引数を使用しようとした際に、システムが無効なアドレスポインターを検出しました。このエラーは、PeerAddr パラメーターが NULL ポインターであった場合に返されます。
WSAEAFNOSUPPORT	指定されたアドレスファミリはサポートされていません。
WSAEMSGSIZE	渡されたバッファが小さすぎました。
WSAENOTSOCK	Socket パラメーターに渡された記述子が有効なソケットではありません。

解説(Remarks)

WSAImpersonateSocketPeer 関数は、アプリケーションレベルの認可を実行するために、ソケットピアに対応するセキュリティプリンシパルになりすます機能をアプリケーションに提供します。ピアのユーザー(なりすまし)トークンが利用可能であればそれがなりすましに使用され、そうでない場合はピアのコンピューターートークンが使用されます。WSAImpersonateSocketPeer 関数は、ブロッキングかつ非オーバーラップのソケットに対してのみ呼び出すことができます。認可チェックを実行した後、アプリケーションはなりすましを終了するために WSARevertImpersonation 関数を呼び出す必要があります。

コネクション指向のソケットでは、WSAImpersonateSocketPeer 関数は接続が確立された後に呼び出す必要があります。コネクション指向のソケットを使用するサーバーアプリケーションでは、WSAImpersonateSocketPeer は accept、AcceptEx、または WSAAccept 関数が返った後に呼び出す必要があります。

コネクションレスのソケットでは、新しいピアアドレスについて recv、recvfrom、WSARecv、WSARecvEx、WSARecvFrom、または LPFN_WSARECVMSG (WSARecvMsg) 関数が返った直後に、アプリケーションは WSAImpersonateSocketPeer 関数を呼び出す必要があります。

WSAImpersonateSocketPeer 関数は、単一のソケットに対して複数回呼び出すことができます。

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

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

なりすましを終了するには、WSARevertImpersonation 関数を呼び出す必要があります。

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

各言語での呼び出し定義

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

INT WSAImpersonateSocketPeer(
    SOCKET Socket,
    const SOCKADDR* PeerAddr,   // optional
    DWORD PeerAddrLen
);

[DllImport("fwpuclnt.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSAImpersonateSocketPeer(
    UIntPtr Socket,   // SOCKET
    IntPtr PeerAddr,   // SOCKADDR* optional
    uint PeerAddrLen   // DWORD
);

<DllImport("fwpuclnt.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAImpersonateSocketPeer(
    Socket As UIntPtr,   ' SOCKET
    PeerAddr As IntPtr,   ' SOCKADDR* optional
    PeerAddrLen As UInteger   ' DWORD
) As Integer
End Function

' Socket : SOCKET
' PeerAddr : SOCKADDR* optional
' PeerAddrLen : DWORD
Declare PtrSafe Function WSAImpersonateSocketPeer Lib "fwpuclnt" ( _
    ByVal Socket As LongPtr, _
    ByVal PeerAddr As LongPtr, _
    ByVal PeerAddrLen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSAImpersonateSocketPeer = ctypes.windll.fwpuclnt.WSAImpersonateSocketPeer
WSAImpersonateSocketPeer.restype = ctypes.c_int
WSAImpersonateSocketPeer.argtypes = [
    ctypes.c_size_t,  # Socket : SOCKET
    ctypes.c_void_p,  # PeerAddr : SOCKADDR* optional
    wintypes.DWORD,  # PeerAddrLen : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('fwpuclnt.dll')
WSAImpersonateSocketPeer = Fiddle::Function.new(
  lib['WSAImpersonateSocketPeer'],
  [
    Fiddle::TYPE_UINTPTR_T,  # Socket : SOCKET
    Fiddle::TYPE_VOIDP,  # PeerAddr : SOCKADDR* optional
    -Fiddle::TYPE_INT,  # PeerAddrLen : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "fwpuclnt")]
extern "system" {
    fn WSAImpersonateSocketPeer(
        Socket: usize,  // SOCKET
        PeerAddr: *const SOCKADDR,  // SOCKADDR* optional
        PeerAddrLen: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("fwpuclnt.dll", SetLastError = true)]
public static extern int WSAImpersonateSocketPeer(UIntPtr Socket, IntPtr PeerAddr, uint PeerAddrLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'fwpuclnt_WSAImpersonateSocketPeer' -Namespace Win32 -PassThru
# $api::WSAImpersonateSocketPeer(Socket, PeerAddr, PeerAddrLen)

#uselib "fwpuclnt.dll"
#func global WSAImpersonateSocketPeer "WSAImpersonateSocketPeer" sptr, sptr, sptr
; WSAImpersonateSocketPeer Socket, varptr(PeerAddr), PeerAddrLen   ; 戻り値は stat
; Socket : SOCKET -> "sptr"
; PeerAddr : SOCKADDR* optional -> "sptr"
; PeerAddrLen : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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