Win32 API 日本語リファレンス
ホームNetworkManagement.WindowsFilteringPlatform › IPSEC_SA_BUNDLE1

IPSEC_SA_BUNDLE1

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

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

フィールド

フィールドサイズx64x86説明
flagsIPSEC_SA_BUNDLE_FLAGS4+0+0

次の値の組み合わせです。

IPsec SA バンドル フラグ 意味
IPSEC_SA_BUNDLE_FLAG_ND_SECURE
セキュア リングでネゴシエーション ディスカバリーが有効です。
IPSEC_SA_BUNDLE_FLAG_ND_BOUNDARY
信頼されていない境界ゾーンでネゴシエーション ディスカバリーが有効です。
IPSEC_SA_BUNDLE_FLAG_ND_PEER_NAT_BOUNDARY
ピアが信頼されていない境界ゾーンのリングにあり、途中にネットワーク アドレス変換 (NAT) が存在します。ネゴシエーション ディスカバリーと共に使用されます。
IPSEC_SA_BUNDLE_FLAG_GUARANTEE_ENCRYPTION
これが、暗号化の保証を必要とする接続用の SA であることを示します。
IPSEC_SA_BUNDLE_FLAG_NLB
これが、NLB サーバーへの SA であることを示します。
IPSEC_SA_BUNDLE_FLAG_NO_MACHINE_LUID_VERIFY
この SA がコンピューター LUID の検証をバイパスすることを示します。
IPSEC_SA_BUNDLE_FLAG_NO_IMPERSONATION_LUID_VERIFY
この SA が偽装 LUID の検証をバイパスすることを示します。
IPSEC_SA_BUNDLE_FLAG_NO_EXPLICIT_CRED_MATCH
この SA が明示的な資格情報ハンドルの照合をバイパスすることを示します。
IPSEC_SA_BUNDLE_FLAG_ALLOW_NULL_TARGET_NAME_MATCH
ピア名を指定して確立された SA が、関連付けられたピア ターゲットを持たないトラフィックを伝送できるようにします。
IPSEC_SA_BUNDLE_FLAG_CLEAR_DF_ON_TUNNEL
IPsec でトンネリングされたパケットの外側 IP ヘッダーにある DontFragment ビットをクリアします。このフラグはトンネル モードの SA にのみ適用されます。
IPSEC_SA_BUNDLE_FLAG_ASSUME_UDP_CONTEXT_OUTBOUND
関連付けられた IPsec-NAT-shim コンテキストを持たない送信接続のパケットとこの SA を照合する際に、既定のカプセル化ポート (4500 および 4000) を使用できます。
IPSEC_SA_BUNDLE_FLAG_ND_PEER_BOUNDARY
ピアではネゴシエーション ディスカバリーが有効になっており、境界ネットワーク上に存在します。
IPSEC_SA_BUNDLE_FLAG_SUPPRESS_DUPLICATE_DELETION
重複した SA を削除するロジックを抑制します。このロジックは、不要な重複 SA を防ぐために、送信 SA が追加されたときにカーネルによって実行されます。
IPSEC_SA_BUNDLE_FLAG_PEER_SUPPORTS_GUARANTEE_ENCRYPTION
暗号化の保証を必要とする接続に対して別個の SA をネゴシエートすることを、ピア コンピューターがサポートしていることを示します。
lifetimeIPSEC_SA_LIFETIME012+4+4IPSEC_SA_LIFETIME0 で指定される、バンドル内のすべての SA の有効期間です。
idleTimeoutSecondsDWORD4+16+16バンドル内の SA が (トラフィックが発生しないことにより) アイドル状態となって期限切れになるまでのタイムアウト (秒単位) です。
ndAllowClearTimeoutSecondsDWORD4+20+20

IPsec SA が平文で着信するパケットの受け入れを停止するまでの タイムアウト (秒単位) です。

ネゴシエーション ディスカバリーで使用されます。

ipsecIdIPSEC_ID0*8/4+24+24省略可能な IPsec ID 情報を格納する IPSEC_ID0 構造体へのポインターです。
napContextDWORD4+32+28ネットワーク アクセス ポイント (NAP) のピア資格情報に関する情報です。
qmSaIdDWORD4+36+32IPsec が期限切れにする SA を選択する際に使用する SA 識別子です。IPsec SA のペアでは、qmSaId はイニシエーター側とレスポンダー側のコンピューター間、および受信 SA バンドルと送信 SA バンドルの間で同一でなければなりません。異なる IPsec ペアでは、qmSaId は異なっていなければなりません。
numSAsDWORD4+40+36バンドル内の SA の数です。指定できる値は 1 と 2 のみです。2 は AH と ESP の SA を指定する場合にのみ使用します。
saListIPSEC_SA0*8/4+48+40

バンドル内の IPsec SA の配列です。AH と ESP の SA の場合、インデックス 0 を ESP SA に、インデックス 1 を AH SA に使用します。

詳細については IPSEC_SA0 を参照してください。

keyModuleStateIPSEC_KEYMODULE_STATE0*8/4+56+44IPSEC_KEYMODULE_STATE0 で指定される、省略可能なキー モジュール固有の情報です。
ipVersionFWP_IP_VERSION4+64+48FWP_IP_VERSION で指定される IP バージョンです。
Anonymous_Anonymous_e__Union4+68+52IPバージョンに応じた送信先アドレスを保持する共用体。
mmSaIdULONGLONG8+72+56この ID を使用して、この IPsec SA とそれを生成した IKE SA を関連付けます。
pfsGroupIPSEC_PFS_GROUP4+80+64

この SA でクイック モードの Perfect Forward Secrecy (PFS) が有効であったかどうかを指定します。有効であった場合は、 PFS に使用された Diffie-Hellman グループを格納します。

詳細については IPSEC_PFS_GROUP を参照してください。

saLookupContextGUID16+84+68SA からその SA 上を流れるデータ接続へ伝播される SA ルックアップ コンテキストです。Winsock API の WSAQuerySocketSecurity 関数を使用してソケットのセキュリティ プロパティを照会するアプリケーションから利用でき、アプリケーションは自身の接続に関する詳細な IPsec 認証情報を取得できます。
qmFilterIdULONGLONG8+104+88クイックモードフィルターを識別するID。バージョン1で追加。

共用体: _Anonymous_e__Union x64 4B / x86 4B

フィールドサイズx64x86説明
peerV4PrivateAddressDWORD4+0+0ipVersionFWP_IP_VERSION_V4 の場合に利用できます。ピアが NAT デバイスの背後にある場合、このメンバーはピアの プライベート アドレスを格納します。

公式ドキュメント

IPSEC_SA_BUNDLE1 構造体は、IPsec セキュリティ アソシエーション (SA) バンドルに関する情報を格納するために使用されます。 IPSEC_SA_BUNDLE0 も利用できます。

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

各言語での定義

#include <windows.h>

// IPSEC_SA_LIFETIME0  (x64 12 / x86 12 バイト)
typedef struct IPSEC_SA_LIFETIME0 {
    DWORD lifetimeSeconds;
    DWORD lifetimeKilobytes;
    DWORD lifetimePackets;
} IPSEC_SA_LIFETIME0;

// IPSEC_SA_BUNDLE1  (x64 112 / x86 96 バイト)
typedef struct IPSEC_SA_BUNDLE1 {
    IPSEC_SA_BUNDLE_FLAGS flags;
    IPSEC_SA_LIFETIME0 lifetime;
    DWORD idleTimeoutSeconds;
    DWORD ndAllowClearTimeoutSeconds;
    IPSEC_ID0* ipsecId;
    DWORD napContext;
    DWORD qmSaId;
    DWORD numSAs;
    IPSEC_SA0* saList;
    IPSEC_KEYMODULE_STATE0* keyModuleState;
    FWP_IP_VERSION ipVersion;
    _Anonymous_e__Union Anonymous;
    ULONGLONG mmSaId;
    IPSEC_PFS_GROUP pfsGroup;
    GUID saLookupContext;
    ULONGLONG qmFilterId;
} IPSEC_SA_BUNDLE1;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct IPSEC_SA_LIFETIME0
{
    public uint lifetimeSeconds;
    public uint lifetimeKilobytes;
    public uint lifetimePackets;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct IPSEC_SA_BUNDLE1
{
    public uint flags;
    public IPSEC_SA_LIFETIME0 lifetime;
    public uint idleTimeoutSeconds;
    public uint ndAllowClearTimeoutSeconds;
    public IntPtr ipsecId;
    public uint napContext;
    public uint qmSaId;
    public uint numSAs;
    public IntPtr saList;
    public IntPtr keyModuleState;
    public int ipVersion;
    public _Anonymous_e__Union Anonymous;
    public ulong mmSaId;
    public int pfsGroup;
    public Guid saLookupContext;
    public ulong qmFilterId;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure IPSEC_SA_LIFETIME0
    Public lifetimeSeconds As UInteger
    Public lifetimeKilobytes As UInteger
    Public lifetimePackets As UInteger
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure IPSEC_SA_BUNDLE1
    Public flags As UInteger
    Public lifetime As IPSEC_SA_LIFETIME0
    Public idleTimeoutSeconds As UInteger
    Public ndAllowClearTimeoutSeconds As UInteger
    Public ipsecId As IntPtr
    Public napContext As UInteger
    Public qmSaId As UInteger
    Public numSAs As UInteger
    Public saList As IntPtr
    Public keyModuleState As IntPtr
    Public ipVersion As Integer
    Public Anonymous As _Anonymous_e__Union
    Public mmSaId As ULong
    Public pfsGroup As Integer
    Public saLookupContext As Guid
    Public qmFilterId As ULong
End Structure
import ctypes
from ctypes import wintypes

class IPSEC_SA_LIFETIME0(ctypes.Structure):
    _fields_ = [
        ("lifetimeSeconds", wintypes.DWORD),
        ("lifetimeKilobytes", wintypes.DWORD),
        ("lifetimePackets", wintypes.DWORD),
    ]

class IPSEC_SA_BUNDLE1(ctypes.Structure):
    _fields_ = [
        ("flags", wintypes.DWORD),
        ("lifetime", IPSEC_SA_LIFETIME0),
        ("idleTimeoutSeconds", wintypes.DWORD),
        ("ndAllowClearTimeoutSeconds", wintypes.DWORD),
        ("ipsecId", ctypes.c_void_p),
        ("napContext", wintypes.DWORD),
        ("qmSaId", wintypes.DWORD),
        ("numSAs", wintypes.DWORD),
        ("saList", ctypes.c_void_p),
        ("keyModuleState", ctypes.c_void_p),
        ("ipVersion", ctypes.c_int),
        ("Anonymous", _Anonymous_e__Union),
        ("mmSaId", ctypes.c_ulonglong),
        ("pfsGroup", ctypes.c_int),
        ("saLookupContext", GUID),
        ("qmFilterId", ctypes.c_ulonglong),
    ]
#[repr(C)]
pub struct IPSEC_SA_LIFETIME0 {
    pub lifetimeSeconds: u32,
    pub lifetimeKilobytes: u32,
    pub lifetimePackets: u32,
}

#[repr(C)]
pub struct IPSEC_SA_BUNDLE1 {
    pub flags: u32,
    pub lifetime: IPSEC_SA_LIFETIME0,
    pub idleTimeoutSeconds: u32,
    pub ndAllowClearTimeoutSeconds: u32,
    pub ipsecId: *mut core::ffi::c_void,
    pub napContext: u32,
    pub qmSaId: u32,
    pub numSAs: u32,
    pub saList: *mut core::ffi::c_void,
    pub keyModuleState: *mut core::ffi::c_void,
    pub ipVersion: i32,
    pub Anonymous: _Anonymous_e__Union,
    pub mmSaId: u64,
    pub pfsGroup: i32,
    pub saLookupContext: GUID,
    pub qmFilterId: u64,
}
import "golang.org/x/sys/windows"

type IPSEC_SA_LIFETIME0 struct {
	lifetimeSeconds uint32
	lifetimeKilobytes uint32
	lifetimePackets uint32
}

type IPSEC_SA_BUNDLE1 struct {
	flags uint32
	lifetime IPSEC_SA_LIFETIME0
	idleTimeoutSeconds uint32
	ndAllowClearTimeoutSeconds uint32
	ipsecId uintptr
	napContext uint32
	qmSaId uint32
	numSAs uint32
	saList uintptr
	keyModuleState uintptr
	ipVersion int32
	Anonymous _Anonymous_e__Union
	mmSaId uint64
	pfsGroup int32
	saLookupContext windows.GUID
	qmFilterId uint64
}
type
  IPSEC_SA_LIFETIME0 = record
    lifetimeSeconds: DWORD;
    lifetimeKilobytes: DWORD;
    lifetimePackets: DWORD;
  end;

  IPSEC_SA_BUNDLE1 = record
    flags: DWORD;
    lifetime: IPSEC_SA_LIFETIME0;
    idleTimeoutSeconds: DWORD;
    ndAllowClearTimeoutSeconds: DWORD;
    ipsecId: Pointer;
    napContext: DWORD;
    qmSaId: DWORD;
    numSAs: DWORD;
    saList: Pointer;
    keyModuleState: Pointer;
    ipVersion: Integer;
    Anonymous: _Anonymous_e__Union;
    mmSaId: UInt64;
    pfsGroup: Integer;
    saLookupContext: TGUID;
    qmFilterId: UInt64;
  end;
const IPSEC_SA_LIFETIME0 = extern struct {
    lifetimeSeconds: u32,
    lifetimeKilobytes: u32,
    lifetimePackets: u32,
};

const IPSEC_SA_BUNDLE1 = extern struct {
    flags: u32,
    lifetime: IPSEC_SA_LIFETIME0,
    idleTimeoutSeconds: u32,
    ndAllowClearTimeoutSeconds: u32,
    ipsecId: ?*anyopaque,
    napContext: u32,
    qmSaId: u32,
    numSAs: u32,
    saList: ?*anyopaque,
    keyModuleState: ?*anyopaque,
    ipVersion: i32,
    Anonymous: _Anonymous_e__Union,
    mmSaId: u64,
    pfsGroup: i32,
    saLookupContext: GUID,
    qmFilterId: u64,
};
type
  IPSEC_SA_LIFETIME0 {.bycopy.} = object
    lifetimeSeconds: uint32
    lifetimeKilobytes: uint32
    lifetimePackets: uint32

  IPSEC_SA_BUNDLE1 {.bycopy.} = object
    flags: uint32
    lifetime: IPSEC_SA_LIFETIME0
    idleTimeoutSeconds: uint32
    ndAllowClearTimeoutSeconds: uint32
    ipsecId: pointer
    napContext: uint32
    qmSaId: uint32
    numSAs: uint32
    saList: pointer
    keyModuleState: pointer
    ipVersion: int32
    Anonymous: _Anonymous_e__Union
    mmSaId: uint64
    pfsGroup: int32
    saLookupContext: GUID
    qmFilterId: uint64
struct IPSEC_SA_LIFETIME0
{
    uint lifetimeSeconds;
    uint lifetimeKilobytes;
    uint lifetimePackets;
}

struct IPSEC_SA_BUNDLE1
{
    uint flags;
    IPSEC_SA_LIFETIME0 lifetime;
    uint idleTimeoutSeconds;
    uint ndAllowClearTimeoutSeconds;
    void* ipsecId;
    uint napContext;
    uint qmSaId;
    uint numSAs;
    void* saList;
    void* keyModuleState;
    int ipVersion;
    _Anonymous_e__Union Anonymous;
    ulong mmSaId;
    int pfsGroup;
    GUID saLookupContext;
    ulong qmFilterId;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; IPSEC_SA_BUNDLE1 サイズ: 96 バイト(x86)
dim st, 24    ; 4byte整数×24(構造体サイズ 96 / 4 切り上げ)
; flags : IPSEC_SA_BUNDLE_FLAGS (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; lifetime : IPSEC_SA_LIFETIME0 (+4, 12byte)  varptr(st)+4 を基点に操作(12byte:入れ子/配列)
; idleTimeoutSeconds : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; ndAllowClearTimeoutSeconds : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; ipsecId : IPSEC_ID0* (+24, 4byte)  varptr(st)+24 を基点に操作(4byte:入れ子/配列)
; napContext : DWORD (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; qmSaId : DWORD (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; numSAs : DWORD (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; saList : IPSEC_SA0* (+40, 4byte)  varptr(st)+40 を基点に操作(4byte:入れ子/配列)
; keyModuleState : IPSEC_KEYMODULE_STATE0* (+44, 4byte)  varptr(st)+44 を基点に操作(4byte:入れ子/配列)
; ipVersion : FWP_IP_VERSION (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; Anonymous : _Anonymous_e__Union (+52, 4byte)  varptr(st)+52 を基点に操作(4byte:入れ子/配列)
; mmSaId : ULONGLONG (+56, 8byte)  qpoke st,56,値 / qpeek(st,56)  ※IronHSPのみ。3.7/3.8は lpoke st,56,下位 : lpoke st,60,上位
; pfsGroup : IPSEC_PFS_GROUP (+64, 4byte)  st.16 = 値  /  値 = st.16   (lpoke/lpeek も可)
; saLookupContext : GUID (+68, 16byte)  varptr(st)+68 を基点に操作(16byte:入れ子/配列)
; qmFilterId : ULONGLONG (+88, 8byte)  qpoke st,88,値 / qpeek(st,88)  ※IronHSPのみ。3.7/3.8は lpoke st,88,下位 : lpoke st,92,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; IPSEC_SA_BUNDLE1 サイズ: 112 バイト(x64)
dim st, 28    ; 4byte整数×28(構造体サイズ 112 / 4 切り上げ)
; flags : IPSEC_SA_BUNDLE_FLAGS (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; lifetime : IPSEC_SA_LIFETIME0 (+4, 12byte)  varptr(st)+4 を基点に操作(12byte:入れ子/配列)
; idleTimeoutSeconds : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; ndAllowClearTimeoutSeconds : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; ipsecId : IPSEC_ID0* (+24, 8byte)  varptr(st)+24 を基点に操作(8byte:入れ子/配列)
; napContext : DWORD (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; qmSaId : DWORD (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; numSAs : DWORD (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; saList : IPSEC_SA0* (+48, 8byte)  varptr(st)+48 を基点に操作(8byte:入れ子/配列)
; keyModuleState : IPSEC_KEYMODULE_STATE0* (+56, 8byte)  varptr(st)+56 を基点に操作(8byte:入れ子/配列)
; ipVersion : FWP_IP_VERSION (+64, 4byte)  st.16 = 値  /  値 = st.16   (lpoke/lpeek も可)
; Anonymous : _Anonymous_e__Union (+68, 4byte)  varptr(st)+68 を基点に操作(4byte:入れ子/配列)
; mmSaId : ULONGLONG (+72, 8byte)  qpoke st,72,値 / qpeek(st,72)  ※IronHSPのみ。3.7/3.8は lpoke st,72,下位 : lpoke st,76,上位
; pfsGroup : IPSEC_PFS_GROUP (+80, 4byte)  st.20 = 値  /  値 = st.20   (lpoke/lpeek も可)
; saLookupContext : GUID (+84, 16byte)  varptr(st)+84 を基点に操作(16byte:入れ子/配列)
; qmFilterId : ULONGLONG (+104, 8byte)  qpoke st,104,値 / qpeek(st,104)  ※IronHSPのみ。3.7/3.8は lpoke st,104,下位 : lpoke st,108,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global IPSEC_SA_LIFETIME0
    #field int lifetimeSeconds
    #field int lifetimeKilobytes
    #field int lifetimePackets
#endstruct

#defstruct global GUID, pack=1
    #field int Data1
    #field short Data2
    #field short Data3
    #field byte Data4 8
#endstruct

#defstruct global IPSEC_SA_BUNDLE1
    #field int flags
    #field IPSEC_SA_LIFETIME0 lifetime
    #field int idleTimeoutSeconds
    #field int ndAllowClearTimeoutSeconds
    #field intptr ipsecId
    #field int napContext
    #field int qmSaId
    #field int numSAs
    #field intptr saList
    #field intptr keyModuleState
    #field int ipVersion
    #field byte Anonymous 4
    #field int64 mmSaId
    #field int pfsGroup
    #field GUID saLookupContext
    #field int64 qmFilterId
#endstruct

stdim st, IPSEC_SA_BUNDLE1        ; NSTRUCT 変数を確保
st->flags = 100
mes "flags=" + st->flags
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。