ホーム › Networking.WinSock › WSASetSocketSecurity

WSASetSocketSecurity

関数

ソケットにIPsec等のセキュリティ設定を適用する。

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

シグネチャ

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

INT WSASetSocketSecurity(
    SOCKET Socket,
    const SOCKET_SECURITY_SETTINGS* SecuritySettings,   // optional
    DWORD SecuritySettingsLen,
    OVERLAPPED* Overlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE CompletionRoutine   // optional
);

パラメーター

名前	型	方向	説明
Socket	SOCKET	in	セキュリティ設定を適用するソケットを識別する記述子です。
SecuritySettings	SOCKET_SECURITY_SETTINGS*	inoptional	ソケットのトラフィックに適用するセキュリティ設定を指定する SOCKET_SECURITY_SETTINGS 構造体へのポインターです。このパラメーターが NULL の場合、既定の設定がソケットに適用されます。
SecuritySettingsLen	DWORD	in	SecuritySettings パラメーターのサイズ(バイト単位)です。
Overlapped	OVERLAPPED*	inoptional	WSAOVERLAPPED 構造体へのポインターです。このパラメーターは、非オーバーラップソケットでは無視されます。
CompletionRoutine	LPWSAOVERLAPPED_COMPLETION_ROUTINE	inoptional	操作が完了したときに呼び出される完了ルーチンへのポインターです。このパラメーターは、非オーバーラップソケットでは無視されます。

戻り値の型: INT

公式ドキュメント

ソケットのセキュリティを有効化し、適用します。

戻り値

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

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

エラーコード	意味
WSAEAFNOSUPPORT	指定されたアドレスファミリはサポートされていません。
WSAEINVAL	無効なパラメーターが渡されました。このエラーは、Socket パラメーターに渡されたソケットが、AF_INET または AF_INET6 のアドレスファミリと SOCK_DGRAM または SOCK_STREAM のソケット型で作成されていない場合に返されます。また、SecuritySettings パラメーターが指す SOCKET_SECURITY_SETTINGS 構造体に不正な値が含まれている場合にも、このエラーが返されます。
WSAEISCONN	ソケットが接続されています。この関数は、接続済みのソケットでは使用できません。これはソケットがコネクション指向か非コネクション型かに関わらず適用されます。
WSAEMSGSIZE	渡されたバッファーが小さすぎます。
WSAENOTSOCK	Socket パラメーターに渡された記述子は、有効なソケットではありません。

解説(Remarks)

WSASetSocketSecurity 関数の主な目的は、管理ポリシーによってまだ有効化されていない場合に、ソケットのセキュリティを有効にすることです。IPsec の場合、これはこのソケットの保護に使用される適切な IPsec フィルターおよびポリシーがインスタンス化されることを意味します。WSASetSocketSecurity 関数は、ソケットに対する特定のセキュリティ要件を設定するためにも使用できます。

この関数は、dwIoControlCode パラメーターを SIO_SET_SECURITY に設定して WSAIoctl 関数を呼び出す処理を簡略化します。

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

コネクション指向ソケット(プロトコルが IPPROTO_TCP)を使用するクライアントアプリケーションでは、WSASetSocketSecurity 関数を connect、ConnectEx、または WSAConnect 関数を呼び出す前に呼び出す必要があります。WSASetSocketSecurity 関数を connect、ConnectEx、または WSAConnect 関数の後に呼び出した場合、WSASetSocketSecurity は失敗します。

コネクション指向ソケット(プロトコルが IPPROTO_TCP)を使用するサーバーアプリケーションでは、WSASetSocketSecurity 関数を bind 関数を呼び出す前に呼び出す必要があります。WSASetSocketSecurity 関数を bind 関数の後に呼び出した場合、WSASetSocketSecurity は失敗します。

非コネクション型ソケット(プロトコルが IPPROTO_UDP)では、アプリケーションは socket または WSASocket 呼び出しが戻った直後に WSASetSocketSecurity 関数を呼び出す必要があります。

サーバーアプリケーションは、setsockopt 関数を呼び出して、ソケットが使用するポートへの排他的アクセスを取得する必要があります。これにより、他のアプリケーションが同じポートを使用できなくなります。setsockopt 関数は、level パラメーターを SOL_SOCKET、optname パラメーターを SO_EXCLUSIVEADDRUSE、value パラメーターを 0 以外の値に設定して呼び出します。WSASetSocketSecurity 関数は、ポートへの排他的アクセスを取得するために、内部で SO_EXCLUSIVEADDRUSE を指定して setsockopt を呼び出します。これは、ソケットがローカルコンピューター上で実行されている他のアプリケーションによる攻撃に対して脆弱にならないようにするためです。

WSASetSocketSecurity を使用して設定されないセキュリティ設定は、システムの既定のポリシー、または管理者が構成したポリシーから導出されます。ほとんどのアプリケーションでは、SecuritySettings パラメーターが指す SOCKET_SECURITY_PROTOCOL の SecurityProtocol メンバーに対して、SOCKET_SECURITY_PROTOCOL 列挙の値として SOCKET_SECURITY_PROTOCOL_DEFAULT を指定することが推奨されます。これにより、アプリケーションはセキュリティプロトコルに対して中立となり、異なるシステム間での展開が容易になります。

SecuritySettings パラメーターが SOCKET_SECURITY_SETTINGS_IPSEC 構造体を指す場合、構造体の SecurityProtocol メンバーは SOCKET_SECURITY_PROTOCOL_DEFAULT ではなく SOCKET_SECURITY_PROTOCOL_IPSEC に設定する必要があります。

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

Socket パラメーターのアドレスファミリは、AF_INET または AF_INET6 のいずれかである必要があります。
ソケット型は、SOCK_STREAM または SOCK_DGRAM のいずれかである必要があります。
アプリケーションは、bind、connect、ConnectEx、または WSAConnect 関数を呼び出す前に、セキュリティ設定を行う必要があります。
WSASetSocketSecurity 関数は、ソケットごとに 1 回だけ呼び出すことができます。

既定のセキュアソケット IPsec ポリシー

SecuritySettings パラメーターが NULL に設定されており、コンピューター上に管理者が指定した他の IPsec ポリシーが存在しない場合、IPsec に基づく既定のセキュリティポリシーが使用され、アプリケーションのトラフィックが保護されます。既定のポリシーで IPsec を成功させるには、何らかの認証資格情報(例えばユーザー証明書やドメインメンバーシップ)が存在している必要があります。

既定の IPsec ポリシーは、できるだけ多くのシナリオで IPsec セキュリティをネゴシエートできるように設計されています。

Authip MM policy = 
{
 Auth methods = {IKE_ANONYMOUS}
 No impersonation
 Proposals = 
 {
   {
     Crypto algos = 
     IKE_CIPHER_AES_128,
     IKE_INTEGRITY_SHA1, 
     IKE_DH_ECP_256
     MM lifetime = 2 hrs
     QM = 0 (infinite)
   }
   {
     Crypto algos = 
     IKE_CIPHER_3DES, 
     IKE_INTEGRITY_SHA1, 
     IKE_DH_GROUP_2
     MM lifetime = 2 hrs
     QM = 0 (infinite)
   }
 }
}

Authip QM policy =
{
 QM proposals = 
 {
   QM lifetime = 1 hr, 55GB,
   Crypto algos = 
   IPSEC_TRANSFORM_ESP_AUTH, 
   IPSEC_AUTH_TRANSFORM_ID_HMAC_SHA_1_96
   No PFS
 }
 {
   QM lifetime = 1 hr, 55GB,
   Crypto algos = 
   IPSEC_TRANSFORM_ESP_AUTH_AND_CIPHER,
   IPSEC_AUTH_TRANSFORM_ID_HMAC_SHA_1_96,
   IPSEC_CIPHER_TRANSFORM_ID_AES_128
   No PFS
 }
 {
   QM lifetime = 1 hr, 55GB,
   Crypto algos = 
   IPSEC_TRANSFORM_ESP_AUTH_AND_CIPHER,
   IPSEC_AUTH_TRANSFORM_ID_HMAC_SHA_1_96,
   IPSEC_CIPHER_TRANSFORM_ID_CBC_3DES
   No PFS
 }
 {
   QM lifetime = 1 hr, 55GB,
   Crypto algos = 
   IPSEC_TRANSFORM_AH,
   IPSEC_AUTH_TRANSFORM_ID_HMAC_SHA_1_96
   No PFS
 }
 IPSEC_POLICY_FLAG_ND_BOUNDARY
 ndAllowClearTimeoutSeconds = 10
 saIdleTimeout = {5mins, 1min}
 UM policy = 
 {
   {IKE_SSL, Null-Root-Config}
   {IKE_KERBEROS}
   {IKE_SSL, Null-Root-Config}
   No impersonation
 } 
}

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

各言語での呼び出し定義

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

INT WSASetSocketSecurity(
    SOCKET Socket,
    const SOCKET_SECURITY_SETTINGS* SecuritySettings,   // optional
    DWORD SecuritySettingsLen,
    OVERLAPPED* Overlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE CompletionRoutine   // optional
);

[DllImport("fwpuclnt.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSASetSocketSecurity(
    UIntPtr Socket,   // SOCKET
    IntPtr SecuritySettings,   // SOCKET_SECURITY_SETTINGS* optional
    uint SecuritySettingsLen,   // DWORD
    IntPtr Overlapped,   // OVERLAPPED* optional
    IntPtr CompletionRoutine   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
);

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

' Socket : SOCKET
' SecuritySettings : SOCKET_SECURITY_SETTINGS* optional
' SecuritySettingsLen : DWORD
' Overlapped : OVERLAPPED* optional
' CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
Declare PtrSafe Function WSASetSocketSecurity Lib "fwpuclnt" ( _
    ByVal Socket As LongPtr, _
    ByVal SecuritySettings As LongPtr, _
    ByVal SecuritySettingsLen 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

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

#[link(name = "fwpuclnt")]
extern "system" {
    fn WSASetSocketSecurity(
        Socket: usize,  // SOCKET
        SecuritySettings: *const SOCKET_SECURITY_SETTINGS,  // SOCKET_SECURITY_SETTINGS* optional
        SecuritySettingsLen: 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 WSASetSocketSecurity(UIntPtr Socket, IntPtr SecuritySettings, uint SecuritySettingsLen, IntPtr Overlapped, IntPtr CompletionRoutine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'fwpuclnt_WSASetSocketSecurity' -Namespace Win32 -PassThru
# $api::WSASetSocketSecurity(Socket, SecuritySettings, SecuritySettingsLen, Overlapped, CompletionRoutine)

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

出力引数:

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