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

FWPM_PROVIDER_CONTEXT2

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

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

フィールド

フィールドサイズx64x86説明
providerContextKeyGUID16+0+0プロバイダーコンテキストを一意に識別します。FwpmProviderContextAdd2 の呼び出し時にこの GUID が 0 で初期化されている場合は、ベースフィルタリングエンジン (BFE) が生成します。
displayDataFWPM_DISPLAY_DATA016/8+16+16プロバイダーコンテキストに、人間が読める形式の注釈を付けられるようにします。FWPM_DISPLAY_DATA0 構造体は必須です。
flagsDWORD4+32+24

指定できる値:

プロバイダーコンテキストフラグ 意味
FWPM_PROVIDER_CONTEXT_FLAG_PERSISTENT オブジェクトは永続的です。つまり、BFE の停止/開始をまたいで保持されます。
FWPM_PROVIDER_CONTEXT_FLAG_DOWNLEVEL 内部使用のために予約済みです。
providerKeyGUID*8/4+40+28このオブジェクトを管理するポリシープロバイダーの GUID です。
providerDataFWP_BYTE_BLOB16/8+48+32省略可能なプロバイダー固有のデータです。プロバイダーは、これを使用して追加のコンテキスト情報をオブジェクトとともに格納できます。
typeFWPM_PROVIDER_CONTEXT_TYPE4+64+40プロバイダーコンテキストの種類です。
Anonymous_Anonymous_e__Union8/4+72+44コンテキスト種別に応じた具体データを保持する共用体。
providerContextIdULONGLONG8+80+48コンテキストを識別する LUID です。これは、プロバイダーコンテキストを参照するフィルターについて FWPS_FILTER1 構造体に格納されるコンテキスト値です。FWPS_FILTER1 構造体は WDK で説明されています。

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

フィールドサイズx64x86説明
keyingPolicyIPSEC_KEYING_POLICY1*8/4+0+0typeFWPM_IPSEC_KEYING_CONTEXT の場合に使用できます。
ikeQmTransportPolicyIPSEC_TRANSPORT_POLICY2*8/4+0+0typeFWPM_IPSEC_IKE_QM_TRANSPORT_CONTEXT の場合に使用できます。
ikeQmTunnelPolicyIPSEC_TUNNEL_POLICY2*8/4+0+0typeFWPM_IPSEC_IKE_QM_TUNNEL_CONTEXT の場合に使用できます。
authipQmTransportPolicyIPSEC_TRANSPORT_POLICY2*8/4+0+0 [case()][unique]
authipQmTunnelPolicyIPSEC_TUNNEL_POLICY2*8/4+0+0typeFWPM_IPSEC_AUTHIP_QM_TRANSPORT_CONTEXT の場合に使用できます。
ikeMmPolicyIKEEXT_POLICY2*8/4+0+0typeFWPM_IPSEC_IKE_MM_CONTEXT の場合に使用できます。
authIpMmPolicyIKEEXT_POLICY2*8/4+0+0typeFWPM_IPSEC_AUTHIP_MM_CONTEXT の場合に使用できます。
dataBufferFWP_BYTE_BLOB*8/4+0+0typeFWPM_GENERAL_CONTEXT の場合に使用できます。
classifyOptionsFWPM_CLASSIFY_OPTIONS0*8/4+0+0typeFWPM_CLASSIFY_OPTIONS_CONTEXT の場合に使用できます。
ikeV2QmTunnelPolicyIPSEC_TUNNEL_POLICY2*8/4+0+0typeFWPM_IPSEC_IKEV2_QM_TUNNEL_CONTEXT の場合に使用できます。
ikeV2QmTransportPolicyIPSEC_TRANSPORT_POLICY2*8/4+0+0typeFWPM_IPSEC_IKEV2_QM_TRANSPORT_CONTEXT の場合に使用できます。
ikeV2MmPolicyIKEEXT_POLICY2*8/4+0+0typeFWPM_IPSEC_IKEV2_MM_CONTEXT の場合に使用できます。
idpOptionsIPSEC_DOSP_OPTIONS0*8/4+0+0typeFWPM_IPSEC_DOSP_CONTEXT の場合に使用できます。

公式ドキュメント

FWPM_PROVIDER_CONTEXT2 構造体は、プロバイダーコンテキストに関連付けられた状態を格納します。FWPM_PROVIDER_CONTEXT0 が利用可能です。

解説(Remarks)

共用体の最初の 7 つの要素は、オブジェクトを追加するときに指定する情報です。

最後の要素は、オブジェクトの取得または列挙を行うときに返される追加情報です。

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

各言語での定義

#include <windows.h>

// FWPM_DISPLAY_DATA0  (x64 16 / x86 8 バイト)
typedef struct FWPM_DISPLAY_DATA0 {
    LPWSTR name;
    LPWSTR description;
} FWPM_DISPLAY_DATA0;

// FWP_BYTE_BLOB  (x64 16 / x86 8 バイト)
typedef struct FWP_BYTE_BLOB {
    DWORD size;
    BYTE* data;
} FWP_BYTE_BLOB;

// FWPM_PROVIDER_CONTEXT2  (x64 88 / x86 56 バイト)
typedef struct FWPM_PROVIDER_CONTEXT2 {
    GUID providerContextKey;
    FWPM_DISPLAY_DATA0 displayData;
    DWORD flags;
    GUID* providerKey;
    FWP_BYTE_BLOB providerData;
    FWPM_PROVIDER_CONTEXT_TYPE type;
    _Anonymous_e__Union Anonymous;
    ULONGLONG providerContextId;
} FWPM_PROVIDER_CONTEXT2;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct FWPM_DISPLAY_DATA0
{
    public IntPtr name;
    public IntPtr description;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct FWP_BYTE_BLOB
{
    public uint size;
    public IntPtr data;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct FWPM_PROVIDER_CONTEXT2
{
    public Guid providerContextKey;
    public FWPM_DISPLAY_DATA0 displayData;
    public uint flags;
    public IntPtr providerKey;
    public FWP_BYTE_BLOB providerData;
    public int type;
    public _Anonymous_e__Union Anonymous;
    public ulong providerContextId;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure FWPM_DISPLAY_DATA0
    Public name As IntPtr
    Public description As IntPtr
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure FWP_BYTE_BLOB
    Public size As UInteger
    Public data As IntPtr
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure FWPM_PROVIDER_CONTEXT2
    Public providerContextKey As Guid
    Public displayData As FWPM_DISPLAY_DATA0
    Public flags As UInteger
    Public providerKey As IntPtr
    Public providerData As FWP_BYTE_BLOB
    Public type As Integer
    Public Anonymous As _Anonymous_e__Union
    Public providerContextId As ULong
End Structure
import ctypes
from ctypes import wintypes

class FWPM_DISPLAY_DATA0(ctypes.Structure):
    _fields_ = [
        ("name", ctypes.c_void_p),
        ("description", ctypes.c_void_p),
    ]

class FWP_BYTE_BLOB(ctypes.Structure):
    _fields_ = [
        ("size", wintypes.DWORD),
        ("data", ctypes.c_void_p),
    ]

class FWPM_PROVIDER_CONTEXT2(ctypes.Structure):
    _fields_ = [
        ("providerContextKey", GUID),
        ("displayData", FWPM_DISPLAY_DATA0),
        ("flags", wintypes.DWORD),
        ("providerKey", ctypes.c_void_p),
        ("providerData", FWP_BYTE_BLOB),
        ("type", ctypes.c_int),
        ("Anonymous", _Anonymous_e__Union),
        ("providerContextId", ctypes.c_ulonglong),
    ]
#[repr(C)]
pub struct FWPM_DISPLAY_DATA0 {
    pub name: *mut core::ffi::c_void,
    pub description: *mut core::ffi::c_void,
}

#[repr(C)]
pub struct FWP_BYTE_BLOB {
    pub size: u32,
    pub data: *mut core::ffi::c_void,
}

#[repr(C)]
pub struct FWPM_PROVIDER_CONTEXT2 {
    pub providerContextKey: GUID,
    pub displayData: FWPM_DISPLAY_DATA0,
    pub flags: u32,
    pub providerKey: *mut core::ffi::c_void,
    pub providerData: FWP_BYTE_BLOB,
    pub type: i32,
    pub Anonymous: _Anonymous_e__Union,
    pub providerContextId: u64,
}
import "golang.org/x/sys/windows"

type FWPM_DISPLAY_DATA0 struct {
	name uintptr
	description uintptr
}

type FWP_BYTE_BLOB struct {
	size uint32
	data uintptr
}

type FWPM_PROVIDER_CONTEXT2 struct {
	providerContextKey windows.GUID
	displayData FWPM_DISPLAY_DATA0
	flags uint32
	providerKey uintptr
	providerData FWP_BYTE_BLOB
	type int32
	Anonymous _Anonymous_e__Union
	providerContextId uint64
}
type
  FWPM_DISPLAY_DATA0 = record
    name: Pointer;
    description: Pointer;
  end;

  FWP_BYTE_BLOB = record
    size: DWORD;
    data: Pointer;
  end;

  FWPM_PROVIDER_CONTEXT2 = record
    providerContextKey: TGUID;
    displayData: FWPM_DISPLAY_DATA0;
    flags: DWORD;
    providerKey: Pointer;
    providerData: FWP_BYTE_BLOB;
    type: Integer;
    Anonymous: _Anonymous_e__Union;
    providerContextId: UInt64;
  end;
const FWPM_DISPLAY_DATA0 = extern struct {
    name: ?*anyopaque,
    description: ?*anyopaque,
};

const FWP_BYTE_BLOB = extern struct {
    size: u32,
    data: ?*anyopaque,
};

const FWPM_PROVIDER_CONTEXT2 = extern struct {
    providerContextKey: GUID,
    displayData: FWPM_DISPLAY_DATA0,
    flags: u32,
    providerKey: ?*anyopaque,
    providerData: FWP_BYTE_BLOB,
    type: i32,
    Anonymous: _Anonymous_e__Union,
    providerContextId: u64,
};
type
  FWPM_DISPLAY_DATA0 {.bycopy.} = object
    name: pointer
    description: pointer

  FWP_BYTE_BLOB {.bycopy.} = object
    size: uint32
    data: pointer

  FWPM_PROVIDER_CONTEXT2 {.bycopy.} = object
    providerContextKey: GUID
    displayData: FWPM_DISPLAY_DATA0
    flags: uint32
    providerKey: pointer
    providerData: FWP_BYTE_BLOB
    type: int32
    Anonymous: _Anonymous_e__Union
    providerContextId: uint64
struct FWPM_DISPLAY_DATA0
{
    void* name;
    void* description;
}

struct FWP_BYTE_BLOB
{
    uint size;
    void* data;
}

struct FWPM_PROVIDER_CONTEXT2
{
    GUID providerContextKey;
    FWPM_DISPLAY_DATA0 displayData;
    uint flags;
    void* providerKey;
    FWP_BYTE_BLOB providerData;
    int type;
    _Anonymous_e__Union Anonymous;
    ulong providerContextId;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; FWPM_PROVIDER_CONTEXT2 サイズ: 56 バイト(x86)
dim st, 14    ; 4byte整数×14(構造体サイズ 56 / 4 切り上げ)
; providerContextKey : GUID (+0, 16byte)  varptr(st)+0 を基点に操作(16byte:入れ子/配列)
; displayData : FWPM_DISPLAY_DATA0 (+16, 8byte)  varptr(st)+16 を基点に操作(8byte:入れ子/配列)
; flags : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; providerKey : GUID* (+28, 4byte)  varptr(st)+28 を基点に操作(4byte:入れ子/配列)
; providerData : FWP_BYTE_BLOB (+32, 8byte)  varptr(st)+32 を基点に操作(8byte:入れ子/配列)
; type : FWPM_PROVIDER_CONTEXT_TYPE (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; Anonymous : _Anonymous_e__Union (+44, 4byte)  varptr(st)+44 を基点に操作(4byte:入れ子/配列)
; providerContextId : ULONGLONG (+48, 8byte)  qpoke st,48,値 / qpeek(st,48)  ※IronHSPのみ。3.7/3.8は lpoke st,48,下位 : lpoke st,52,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; FWPM_PROVIDER_CONTEXT2 サイズ: 88 バイト(x64)
dim st, 22    ; 4byte整数×22(構造体サイズ 88 / 4 切り上げ)
; providerContextKey : GUID (+0, 16byte)  varptr(st)+0 を基点に操作(16byte:入れ子/配列)
; displayData : FWPM_DISPLAY_DATA0 (+16, 16byte)  varptr(st)+16 を基点に操作(16byte:入れ子/配列)
; flags : DWORD (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; providerKey : GUID* (+40, 8byte)  varptr(st)+40 を基点に操作(8byte:入れ子/配列)
; providerData : FWP_BYTE_BLOB (+48, 16byte)  varptr(st)+48 を基点に操作(16byte:入れ子/配列)
; type : FWPM_PROVIDER_CONTEXT_TYPE (+64, 4byte)  st.16 = 値  /  値 = st.16   (lpoke/lpeek も可)
; Anonymous : _Anonymous_e__Union (+72, 8byte)  varptr(st)+72 を基点に操作(8byte:入れ子/配列)
; providerContextId : ULONGLONG (+80, 8byte)  qpoke st,80,値 / qpeek(st,80)  ※IronHSPのみ。3.7/3.8は lpoke st,80,下位 : lpoke st,84,上位
; ※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 FWPM_DISPLAY_DATA0
    #field intptr name
    #field intptr description
#endstruct

#defstruct global FWP_BYTE_BLOB
    #field int size
    #field intptr data
#endstruct

#defstruct global FWPM_PROVIDER_CONTEXT2
    #field GUID providerContextKey
    #field FWPM_DISPLAY_DATA0 displayData
    #field int flags
    #field intptr providerKey
    #field FWP_BYTE_BLOB providerData
    #field int type
    #field byte Anonymous 8
    #field int64 providerContextId
#endstruct

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