Win32 API 日本語リファレンス
ホームNetworking.WinSock › SOCKET_SECURITY_SETTINGS_IPSEC

SOCKET_SECURITY_SETTINGS_IPSEC

構造体
サイズx64: 88 バイト / x86: 88 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
SecurityProtocolSOCKET_SECURITY_PROTOCOL4+0+0ソケットで使用するセキュリティプロトコルの種類を識別する SOCKET_SECURITY_PROTOCOL 値です。このメンバーは SOCKET_SECURITY_PROTOCOL_IPSEC に設定しなければなりません。
SecurityFlagsDWORD4+4+4

アプリケーションがソケットに対して固有のセキュリティ要件を設定できるようにするフラグの集合です。指定可能な値は Mstcpip.h ヘッダーファイルで定義されています。

意味
SOCKET_SETTINGS_GUARANTEE_ENCRYPTION
0x00000001
トラフィックの暗号化が保証されている必要があることを示します。既定のポリシーが暗号化を使用しない保護方法を優先する場合は、このフラグを設定してください。このフラグが設定されていて、何らかの理由で暗号化ができない場合、パケットは送信されず、接続も確立されません。
SOCKET_SETTINGS_ALLOW_INSECURE
0x00000002
平文の接続が許可されることを示します。このフラグが設定されている場合、特にピアとのセキュリティをネゴシエートできなかったときには、送信されるパケットの一部またはすべてが平文で送信されます。
注意 このフラグが設定されていない場合は、セキュリティのネゴシエーションに失敗しても、パケットが平文で送信されることは決してないことが保証されます。
IpsecFlagsDWORD4+8+8

IPsec セキュリティ設定のフラグです。指定可能な値は Mstcpip.h ヘッダーファイルで定義されています。

意味
SOCKET_SETTINGS_IPSEC_SKIP_FILTER_INSTANTIATION
0x00000001
このフラグが設定されている場合、そのソケットでは IPsec フィルターのインスタンス化が省略されます。自身のトラフィックに対する IPsec フィルターとポリシーが既に存在することをアプリケーションが把握している場合は、このフラグを設定してください。IPsec ポリシーが適用されているドメイン上で実行されるアプリケーションも、このフラグを設定できます。
AuthipMMPolicyKeyGUID16+12+12AuthIP メインモードプロバイダーコンテキストの Windows フィルタリングプラットフォームキーの GUID です。カスタムのメインモードポリシーを使用したい場合、アプリケーションはまず FwpmProviderContextAdd0 関数を使用して対応するプロバイダーコンテキストを追加し、返されたキーをこのメンバーに指定してください。GUID が 0 の場合、このフィールドは無視されます。
AuthipQMPolicyKeyGUID16+28+28AuthIP クイックモードプロバイダーコンテキストの Windows フィルタリングプラットフォームキーです。カスタムのクイックモードポリシーを使用したい場合、アプリケーションはまず FwpmProviderContextAdd0 関数を使用して対応するプロバイダーコンテキストを追加し、返されたキーをこのフィールドに指定してください。GUID が 0 の場合、このフィールドは無視されます。
ReservedGUID16+44+44将来の使用のために予約済みです。
Reserved2ULONGLONG8+64+64将来の使用のために予約済みです。
UserNameStringLenDWORD4+72+72AllStrings メンバー内のユーザー名の長さ (バイト単位) です。
DomainNameStringLenDWORD4+76+76AllStrings メンバー内のドメイン名の長さ (バイト単位) です。
PasswordStringLenDWORD4+80+80AllStrings メンバー内のパスワードの長さ (バイト単位) です。
AllStringsWCHAR2+84+84ユーザー名、ドメイン名、パスワードをこの順序で連結した文字列です。

公式ドキュメント

SOCKET_SECURITY_SETTINGS_IPSEC 構造体は、IPsec に固有のさまざまなセキュリティ要件と設定を指定します。

解説(Remarks)

SOCKET_SECURITY_SETTINGS_IPSEC 構造体は、Windows Vista 以降でサポートされます。

SOCKET_SECURITY_SETTINGS_IPSEC 構造体は、より高い柔軟性を必要とし、自身のトラフィックに対する IPsec ポリシーをカスタマイズしたい高度なアプリケーションでの使用を想定しています。ソケットでセキュリティを有効化して適用するために WSASetSocketSecurity 関数を呼び出す際には、SOCKET_SECURITY_SETTINGS_IPSEC 構造体へのポインターを SOCKET_SECURITY_SETTINGS 構造体の型にキャストする必要があります。

SOCKET_SECURITY_SETTINGS_IPSEC 構造体の SecurityProtocol メンバーは、SOCKET_SECURITY_PROTOCOL_DEFAULT ではなく SOCKET_SECURITY_PROTOCOL_IPSEC に設定しなければなりません。

インターネットプロトコルセキュリティ (IPsec) の展開を簡素化するために、Windows Vista 以降では、Authenticated Internet Protocol (AuthIP) と呼ばれるインターネットキー交換 (IKE) プロトコルの拡張版がサポートされています。AuthIP は、多くの構成において IPsec ポリシーの設定と保守を簡素化し、IPsec ピア認証にさらなる柔軟性をもたらします。

SOCKET_SECURITY_SETTINGS_IPSEC 構造体で指定した IPsec 設定の一部が、ソケット上のネットワークトラフィックに実際に適用される設定と異なる結果になる可能性があります。たとえば、アプリケーションがカスタムのメインモードポリシーやクイックモードポリシーを指定していても、より優先度の高い別のポリシー (ドメインポリシーなど) が同じトラフィックに対して競合する設定を指定している場合に、このようなことが起こり得ます。こうした競合を把握するために、アプリケーションは Windows フィルタリングプラットフォーム API を使用して、適用されているポリシーを照会したり、通知を購読したりできます。

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

各言語での定義

#include <windows.h>

// SOCKET_SECURITY_SETTINGS_IPSEC  (x64 88 / x86 88 バイト)
typedef struct SOCKET_SECURITY_SETTINGS_IPSEC {
    SOCKET_SECURITY_PROTOCOL SecurityProtocol;
    DWORD SecurityFlags;
    DWORD IpsecFlags;
    GUID AuthipMMPolicyKey;
    GUID AuthipQMPolicyKey;
    GUID Reserved;
    ULONGLONG Reserved2;
    DWORD UserNameStringLen;
    DWORD DomainNameStringLen;
    DWORD PasswordStringLen;
    WCHAR AllStrings[1];
} SOCKET_SECURITY_SETTINGS_IPSEC;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct SOCKET_SECURITY_SETTINGS_IPSEC
{
    public int SecurityProtocol;
    public uint SecurityFlags;
    public uint IpsecFlags;
    public Guid AuthipMMPolicyKey;
    public Guid AuthipQMPolicyKey;
    public Guid Reserved;
    public ulong Reserved2;
    public uint UserNameStringLen;
    public uint DomainNameStringLen;
    public uint PasswordStringLen;
    [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 1)] public string AllStrings;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure SOCKET_SECURITY_SETTINGS_IPSEC
    Public SecurityProtocol As Integer
    Public SecurityFlags As UInteger
    Public IpsecFlags As UInteger
    Public AuthipMMPolicyKey As Guid
    Public AuthipQMPolicyKey As Guid
    Public Reserved As Guid
    Public Reserved2 As ULong
    Public UserNameStringLen As UInteger
    Public DomainNameStringLen As UInteger
    Public PasswordStringLen As UInteger
    <MarshalAs(UnmanagedType.ByValTStr, SizeConst:=1)> Public AllStrings As String
End Structure
import ctypes
from ctypes import wintypes

class SOCKET_SECURITY_SETTINGS_IPSEC(ctypes.Structure):
    _fields_ = [
        ("SecurityProtocol", ctypes.c_int),
        ("SecurityFlags", wintypes.DWORD),
        ("IpsecFlags", wintypes.DWORD),
        ("AuthipMMPolicyKey", GUID),
        ("AuthipQMPolicyKey", GUID),
        ("Reserved", GUID),
        ("Reserved2", ctypes.c_ulonglong),
        ("UserNameStringLen", wintypes.DWORD),
        ("DomainNameStringLen", wintypes.DWORD),
        ("PasswordStringLen", wintypes.DWORD),
        ("AllStrings", ctypes.c_wchar * 1),
    ]
#[repr(C)]
pub struct SOCKET_SECURITY_SETTINGS_IPSEC {
    pub SecurityProtocol: i32,
    pub SecurityFlags: u32,
    pub IpsecFlags: u32,
    pub AuthipMMPolicyKey: GUID,
    pub AuthipQMPolicyKey: GUID,
    pub Reserved: GUID,
    pub Reserved2: u64,
    pub UserNameStringLen: u32,
    pub DomainNameStringLen: u32,
    pub PasswordStringLen: u32,
    pub AllStrings: [u16; 1],
}
import "golang.org/x/sys/windows"

type SOCKET_SECURITY_SETTINGS_IPSEC struct {
	SecurityProtocol int32
	SecurityFlags uint32
	IpsecFlags uint32
	AuthipMMPolicyKey windows.GUID
	AuthipQMPolicyKey windows.GUID
	Reserved windows.GUID
	Reserved2 uint64
	UserNameStringLen uint32
	DomainNameStringLen uint32
	PasswordStringLen uint32
	AllStrings [1]uint16
}
type
  SOCKET_SECURITY_SETTINGS_IPSEC = record
    SecurityProtocol: Integer;
    SecurityFlags: DWORD;
    IpsecFlags: DWORD;
    AuthipMMPolicyKey: TGUID;
    AuthipQMPolicyKey: TGUID;
    Reserved: TGUID;
    Reserved2: UInt64;
    UserNameStringLen: DWORD;
    DomainNameStringLen: DWORD;
    PasswordStringLen: DWORD;
    AllStrings: array[0..0] of WideChar;
  end;
const SOCKET_SECURITY_SETTINGS_IPSEC = extern struct {
    SecurityProtocol: i32,
    SecurityFlags: u32,
    IpsecFlags: u32,
    AuthipMMPolicyKey: GUID,
    AuthipQMPolicyKey: GUID,
    Reserved: GUID,
    Reserved2: u64,
    UserNameStringLen: u32,
    DomainNameStringLen: u32,
    PasswordStringLen: u32,
    AllStrings: [1]u16,
};
type
  SOCKET_SECURITY_SETTINGS_IPSEC {.bycopy.} = object
    SecurityProtocol: int32
    SecurityFlags: uint32
    IpsecFlags: uint32
    AuthipMMPolicyKey: GUID
    AuthipQMPolicyKey: GUID
    Reserved: GUID
    Reserved2: uint64
    UserNameStringLen: uint32
    DomainNameStringLen: uint32
    PasswordStringLen: uint32
    AllStrings: array[1, uint16]
struct SOCKET_SECURITY_SETTINGS_IPSEC
{
    int SecurityProtocol;
    uint SecurityFlags;
    uint IpsecFlags;
    GUID AuthipMMPolicyKey;
    GUID AuthipQMPolicyKey;
    GUID Reserved;
    ulong Reserved2;
    uint UserNameStringLen;
    uint DomainNameStringLen;
    uint PasswordStringLen;
    wchar[1] AllStrings;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; SOCKET_SECURITY_SETTINGS_IPSEC サイズ: 88 バイト(x64)
dim st, 22    ; 4byte整数×22(構造体サイズ 88 / 4 切り上げ)
; SecurityProtocol : SOCKET_SECURITY_PROTOCOL (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; SecurityFlags : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; IpsecFlags : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; AuthipMMPolicyKey : GUID (+12, 16byte)  varptr(st)+12 を基点に操作(16byte:入れ子/配列)
; AuthipQMPolicyKey : GUID (+28, 16byte)  varptr(st)+28 を基点に操作(16byte:入れ子/配列)
; Reserved : GUID (+44, 16byte)  varptr(st)+44 を基点に操作(16byte:入れ子/配列)
; Reserved2 : ULONGLONG (+64, 8byte)  qpoke st,64,値 / qpeek(st,64)  ※IronHSPのみ。3.7/3.8は lpoke st,64,下位 : lpoke st,68,上位
; UserNameStringLen : DWORD (+72, 4byte)  st.18 = 値  /  値 = st.18   (lpoke/lpeek も可)
; DomainNameStringLen : DWORD (+76, 4byte)  st.19 = 値  /  値 = st.19   (lpoke/lpeek も可)
; PasswordStringLen : DWORD (+80, 4byte)  st.20 = 値  /  値 = st.20   (lpoke/lpeek も可)
; AllStrings : WCHAR (+84, 2byte)  varptr(st)+84 を基点に操作(2byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global GUID, pack=1
    #field int Data1
    #field short Data2
    #field short Data3
    #field byte Data4 8
#endstruct

#defstruct global SOCKET_SECURITY_SETTINGS_IPSEC
    #field int SecurityProtocol
    #field int SecurityFlags
    #field int IpsecFlags
    #field GUID AuthipMMPolicyKey
    #field GUID AuthipQMPolicyKey
    #field GUID Reserved
    #field int64 Reserved2
    #field int UserNameStringLen
    #field int DomainNameStringLen
    #field int PasswordStringLen
    #field wchar AllStrings 1
#endstruct

stdim st, SOCKET_SECURITY_SETTINGS_IPSEC        ; NSTRUCT 変数を確保
st->SecurityProtocol = 100
mes "SecurityProtocol=" + st->SecurityProtocol