FwpmIPsecTunnelAdd1 - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers 
// fwpmk.h

NTSTATUS FwpmIPsecTunnelAdd1(
  [in]           HANDLE                       engineHandle,
  [in]           UINT32                       flags,
  [in, optional] const FWPM_PROVIDER_CONTEXT1 *mainModePolicy,
  [in]           const FWPM_PROVIDER_CONTEXT1 *tunnelPolicy,
  [in]           UINT32                       numFilterConditions,
  [in]           const FWPM_FILTER_CONDITION0 *filterConditions,
  [in, optional] const GUID                   *keyModKey,
  [in, optional] PSECURITY_DESCRIPTOR         sd
);
View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Edit description on GitHub

Windows Driver Kit DDI reference (nf-fwpmk-fwpmipsectunneladd1)

Description

The FwpmIPsecTunnelAdd1 function adds a new Internet Protocol Security (IPsec) tunnel mode policy to the system.

Parameters

engineHandle [in]

Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

flags [in]

Possible values:

IPsec tunnel flag Meaning
FWPM_TUNNEL_FLAG_POINT_TO_POINT Adds a point-to-point tunnel to the system.
FWPM_TUNNEL_FLAG_ENABLE_VIRTUAL_IF_TUNNELING Enables virtual interface-based IPsec tunnel mode.

mainModePolicy [in, optional]

The Main Mode policy for the IPsec tunnel.

tunnelPolicy [in]

The Quick Mode policy for the IPsec tunnel.

numFilterConditions [in]

Number of filter conditions present in the filterConditions parameter.

filterConditions [in]

Array of filter conditions that describe the traffic which should be tunneled by IPsec.

keyModKey [in, optional]

Pointer to a GUID that uniquely identifies the keying module key.

If the caller supplies this parameter, only that keying module will be used for the tunnel. Otherwise, the default keying policy applies.

sd [in, optional]

The security information associated with the IPsec tunnel.

Return value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0		 The IPsec tunnel mode policy was successfully added.
FWP_E_INVALID_PARAMETER
0x80320035		 FWPM_TUNNEL_FLAG_POINT_TO_POINT was not set and conditions other than local/remote address were specified.
FWP_E_* error code
0x80320001—0x80320039		 A Windows Filtering Platform (WFP) specific error. See WFP Error Codes for details.
RPC_* error code
0x80010001—0x80010122		 Failure to communicate with the remote or local firewall engine.
Other NTSTATUS codes An error occurred.

Remarks

This function cannot be called from within a read-only transaction, it fails with FWP_E_INCOMPATIBLE_TXN. See Object Management for more information about transactions.

FwpmIPsecTunnelAdd1 is a specific implementation of FwpmIPsecTunnelAdd. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

See also

View the official Windows Driver Kit DDI reference

Edit description on GitHub