25 KiB
title, description, ms.author, ms.topic, ms.prod, ms.technology, author, ms.date
| title | description | ms.author | ms.topic | ms.prod | ms.technology | author | ms.date |
|---|---|---|---|---|---|---|---|
| Firewall CSP | Firewall CSP | maricia | article | w10 | windows | nickbrower | 06/19/2017 |
Firewall CSP
Warning
Some information relates to prereleased product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The Firewall configuration service provider (CSP) allows the mobile device management (MDM) server to configure the Windows Defender Firewall global settings, per profile settings, as well as the desired set of custom rules to be enforced on the device. Using the Firewall CSP the IT admin can now manage non-domain devices, and reduce the risk of network security threats across all systems connecting to the corporate network. This CSP is new in the next major update to Windows 10.
Firewall configuration commands must be wrapped in an Atomic block in SyncML.
For detailed information on some of the fields below see [MS-FASP]: Firewall and Advanced Security Protocol documentation.
The following diagram shows the Firewall configuration service provider in tree format.
Root node for the Firewall configuration service provider.
Interior node.
Supported operation is Get.
Interior node.
Supported operations are Get and Replace.
MdmStore/Global/PolicyVersionSupported
DWORD value that contains the maximum policy version that the server host can accept. The version number is two octets in size. The lowest-order octet is the minor version; the second-to-lowest octet is the major version. This value is not merged and is always a fixed value for a particular firewall and advanced security components software build.
Value type in integer. Supported operation is Get.
MdmStore/Global/CurrentProfiles
DWORD value that contains a bitmask of the current enforced profiles that are maintained by the server firewall host. See FW_PROFILE_TYPE for the bitmasks that are used to identify profile types. This value is available only in the dynamic store; therefore, it is not merged and has no merge law.
Value type in integer. Supported operation is Get.
MdmStore/Global/DisableStatefulFtp
This value is an on/off switch. If off, the firewall performs stateful File Transfer Protocol (FTP) filtering to allow secondary connections. The value is a DWORD; 0x00000000 means off; 0x00000001 means on. The merge law for this option is to let "on" values win.
Boolean value. Supported operations are Get and Replace.
This value configures the security association idle time, in seconds. Security associations are deleted after network traffic is not seen for this specified period of time. The value is a DWORD and MUST be a value in the range of 300 to 3,600 inclusive. The merge law for this option is to let the value of the GroupPolicyRSoPStore win if it is configured; otherwise, use the local store value.<
Value type is integer. Supported operations are Get and Replace.
MdmStore/Global/TPresharedKeyEncodingBD
Specifies the preshared key encoding that is used. The value is a DWORD and MUST be a valid value from the PRESHARED_KEY_ENCODING_VALUES enumeration. The merge law for this option is to let the value of the GroupPolicyRSoPStore win if it is configured; otherwise, use the local store value.
Value type is integer. Supported operations are Get and Replace.
This configuration value configures IPsec exceptions. The value is a DWORD and MUST be a combination of the valid flags that are defined in IPSEC_EXEMPT_VALUES; therefore, the maximum value MUST always be IPSEC_EXEMPT_MAX-1 for servers supporting a schema version of 0x0201 and IPSEC_EXEMPT_MAX_V2_0-1 for servers supporting a schema version of 0x0200. If the maximum value is exceeded when the method RRPC_FWSetGlobalConfig (Opnum 4) is called, the method returns ERROR_INVALID_PARAMETER. This error code is returned if no other preceding error is discovered. The merge law for this option is to let the value of the GroupPolicyRSoPStore win if it is configured; otherwise, use the local store value.
Value type is integer. Supported operations are Get and Replace.
This value specifies how certificate revocation list (CRL) verification is enforced. The value is a DWORD and MUST be 0, 1, or 2. A value of 0 disables CRL checking. A value of 1 specifies that CRL checking is attempted and that certificate validation fails only if the certificate is revoked. Other failures that are encountered during CRL checking (such as the revocation URL being unreachable) do not cause certificate validation to fail. A value of 2 means that checking is required and that certificate validation fails if any error is encountered during CRL processing. The merge law for this option is to let the value of the GroupPolicyRSoPStore win if it is configured; otherwise, use the local store value.
Value type is integer. Supported operations are Get and Replace.
This value contains the policy version of the policy store being managed. This value is not merged and therefore, has no merge law.
Value type is string. Supported operation is Get.
MdmStore/Global/BinaryVersionSupported
This value contains the binary version of the structures and data types that are supported by the server. This value is not merged. In addition, this value is always a fixed value for a specific firewall and advanced security component's software build. This value identifies a policy configuration option that is supported only on servers that have a schema version of 0x0201.
Value type is string. Supported operation is Get.
MdmStore/Global/OpportunisticallyMatchAuthSetPerKM
This value is a DWORD used as an on/off switch. When this option is off, keying modules MUST ignore the entire authentication set if they do not support all of the authentication suites specified in the set. When this option is on, keying modules MUST ignore only the authentication suites that they don’t support. For schema versions 0x0200, 0x0201, and 0x020A, this value is invalid and MUST NOT be used.
Boolean value. Supported operations are Get and Replace.
MdmStore/Global/EnablePacketQueue
This value specifies how scaling for the software on the receive side is enabled for both the encrypted receive and clear text forward path for the IPsec tunnel gateway scenario. Use of this option also ensures that the packet order is preserved. The data type for this option value is a DWORD and is a combination of flags. A value of 0x00 indicates that all queuing is to be disabled. A value of 0x01 specifies that inbound encrypted packets are to be queued. A value of 0x02 specifies that packets are to be queued after decryption is performed for forwarding.
Value type is integer. Supported operations are Get and Replace.
Interior node. Supported operation is Get.
Interior node. Supported operation is Get.
Interior node. Supported operation is Get.
This value is an on/off switch for the firewall and advanced security enforcement. It is a DWORD type value; 0x00000000 is off; 0x00000001 is on. If this value is off, the server MUST NOT block any network traffic, regardless of other policy settings. The merge law for this option is to let the value of the GroupPolicyRSoPStore win if it is configured; otherwise, the local store value is used.
Value type is integer. Supported operations are Get and Replace.
This value is a DWORD used as an on/off switch. When this option is off, the server operates in stealth mode. The firewall rules used to enforce stealth mode are implementation-specific. The merge law for this option is to let the value of the GroupPolicyRSoPStore win if it is configured; otherwise, the local store value is used.
Value type is integer. Supported operations are Get and Replace.
This value is a DWORD used as an on/off switch. If this value is on and EnableFirewall is on, the server MUST block all incoming traffic regardless of other policy settings. The merge law for this option is to let "on" values win.
Value type is integer. Supported operations are Get and Replace.
/DisableUnicastResponsesToMulticastBroadcast
This value is a DWORD used as an on/off switch. If it is on, unicast responses to multicast broadcast traffic is blocked. The merge law for this option is to let the value of the GroupPolicyRSoPStore win if it is configured; otherwise, the local store value is used.
Value type is integer. Supported operations are Get and Replace.
This value is a DWORD used as an on/off switch. If this value is off, the firewall MAY display a notification to the user when an application is blocked from listening on a port. If this value is on, the firewall MUST NOT display such a notification. The merge law for this option is to let the value of the GroupPolicyRSoPStore win if it is configured; otherwise, the local store value is used.
Value type is integer. Supported operations are Get and Replace.
This value is a DWORD used as an on/off switch. If this value is off, authorized application firewall rules in the local store are ignored and not enforced. The merge law for this option is to let the value of the GroupPolicyRSoPStore win if it is configured; otherwise, the local store value is used.
Value type is integer. Supported operations are Get and Replace.
/GlobalPortsAllowUserPrefMerge
This value is a DWORD used as an on/off switch. If this value is off, global port firewall rules in the local store are ignored and not enforced. The setting only has meaning if it is set or enumerated in the Group Policy store or if it is enumerated from the GroupPolicyRSoPStore. The merge law for this option is to let the value GroupPolicyRSoPStore win if it is configured; otherwise, the local store value is used.
Value type is integer. Supported operations are Get and Replace.
This value is a DWORD used as an on/off switch. If this value is off, firewall rules from the local store are ignored and not enforced. The merge law for this option is to always use the value of the GroupPolicyRSoPStore. This value is valid for all schema versions.
Value type is integer. Supported operations are Get and Replace.
This value is a DWORD; it is an on/off switch. If this value is off, connection security rules from the local store are ignored and not enforced, regardless of the schema version and connection security rule version. The merge law for this option is to always use the value of the GroupPolicyRSoPStore.
Value type is integer. Supported operations are Get and Replace.
This value is the action that the firewall does by default (and evaluates at the very end) on outbound connections. The allow action is represented by 0x00000000; 0x00000001 represents a block action. The merge law for this option is to let the value of the GroupPolicyRSoPStore win if it is configured; otherwise, the local store value is used.
Value type is integer. Supported operations are Get and Replace.
This value is the action that the firewall does by default (and evaluates at the very end) on inbound connections. The allow action is represented by 0x00000000; 0x00000001 represents a block action. The merge law for this option is to let the value of the GroupPolicyRSoPStore.win if it is configured; otherwise, the local store value is used.
Value type is integer. Supported operations are Get and Replace.
/DisableStealthModeIpsecSecuredPacketExemption
This value is a DWORD used as an on/off switch. This option is ignored if DisableStealthMode is on. Otherwise, when this option is on, the firewall's stealth mode rules MUST NOT prevent the host computer from responding to unsolicited network traffic if that traffic is secured by IPsec. The merge law for this option is to let the value of the GroupPolicyRSoPStore win if it is configured; otherwise, the local store value is used. For schema versions 0x0200, 0x0201, and 0x020A, this value is invalid and MUST NOT be used.
Value type is integer. Supported operations are Get and Replace.
A list of rules controlling traffic through the Windows Firewall. Each Rule ID is OR'ed. Within each rule ID each Filter type is AND'ed.
FirewallRules/FirewallRuleName
Unique alpha numeric identifier for the rule. The rule name must not include a forward slash (/).
FirewallRules/FirewallRuleName/App
Rules that control connections for an app, program, or service. Specified based on the intersection of the following nodes:
- PackageFamilyName
- FilePath
- FQBN
- ServiceName
Supported operation is Get.
FirewallRules/FirewallRuleName/App/PackageFamilyName
This App/Id value represents the PackageFamilyName of the app. The PackageFamilyName is the unique name of a Windows Store application.
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/App/FilePath
This App/Id value represents the full file path of the app. For example, C:\Windows\System\Notepad.exe.
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/App/Fqbn
Fully Qualified Binary Name
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/App/ServiceName
This is a service name used in cases when a service, not an application, is sending or receiving traffic.
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/Protocol
0-255 number representing the ip protocol (TCP = 6, UDP = 17)
Value type is integer. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/LocalPortRanges
Comma separated list of ranges. For example, 100-120,200,300-320.
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/RemotePortRanges
Comma separated list of ranges, For example, 100-120,200,300-320.
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/LocalAddressRanges
Comma separated list of local addresses covered by the rule. The default value is "\*". Valid tokens include:
- "\*" indicates any local address. If present, this must be the only token included.
- A subnet can be specified using either the subnet mask or network prefix notation. If neither a subnet mask not a network prefix is specified, the subnet mask defaults to 255.255.255.255.
- A valid IPv6 address.
- An IPv4 address range in the format of "start address - end address" with no spaces included.
- An IPv6 address range in the format of "start address - end address" with no spaces included.
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/RemoteAddressRanges
List of comma separated tokens specifying the remote addresses covered by the rule. The default value is "\*". Valid tokens include:
- "\*" indicates any remote address. If present, this must be the only token included.
- "Defaultgateway"
- "DHCP"
- "DNS"
- "WINS"
- "Intranet"
- "RemoteCorpNetwork"
- "Internet"
- "PlayToRenderers"
- "LocalSubnet" indicates any local address on the local subnet. This token is not case-sensitive.
- A subnet can be specified using either the subnet mask or network prefix notation. If neither a subnet mask not a network prefix is specified, the subnet mask defaults to 255.255.255.255.
- A valid IPv6 address.
- An IPv4 address range in the format of "start address - end address" with no spaces included.
- An IPv6 address range in the format of "start address - end address" with no spaces included.
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/Description
Specifies the description of the rule.
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/Enabled
Indicates whether the rule is enabled or disabled. If the rule must be enabled, this value must be set to true. If not specified - a new rule is disabled by default.
Boolean value. Supported operations are Add, Get, Replace, and Delete.
FirewallRules_FirewallRuleName_/Profiles
Specifies the profiles to which the rule belongs: Domain, Private, Public. . See FW_PROFILE_TYPE for the bitmasks that are used to identify profile types.
Value type is integer. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/Action
Specifies the action for the rule.
Supported operation is Get.
FirewallRules/FirewallRuleName/Action/Type
Specifies the action the rule enforces. Supported values:
- 0 - Block
- 1 - Allow
Value type is integer. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/Direction
Comma separated list. The rule is enabled based on the traffic direction as following. Supported values:
- IN - the rule applies to inbound traffic.
- OUT - the rule applies to outbound traffic.
- If not specified, the default is IN.
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/InterfaceTypes
Comma separated list of interface types. Valid values:
- RemoteAccess
- Wireless
- MobileBroadband
- All
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/IcmpTypesAndCodes
List of ICMP types and codes separated by semicolon. "\*" indicates all ICMP types and codes.<
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/EdgeTraversal
Indicates whether edge traversal is enabled or disabled for this rule.
The EdgeTraversal setting indicates that specific inbound traffic is allowed to tunnel through NATs and other edge devices using the Teredo tunneling technology. In order for this setting to work correctly, the application or service with the inbound firewall rule needs to support IPv6. The primary application of this setting allows listeners on the host to be globally addressable through a Teredo IPv6 address.
New rules have the EdgeTraversal property disabled by default.
Boolean value. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/LocalUserAuthorizedList
Specifies the list of authorized local users for the app container. This is a string in Security Descriptor Definition Language (SDDL) format.
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/Status
Provides information about the specific verrsion of the rule in deployment for monitoring purposes.
Value type is string. Supported operation is Get.
FirewallRules/FirewallRuleName/FriendlyName
Specifies the friendly name of the rule. The string must not contain the "|" character.
Value type is string. Supported operations are Add, Get, Replace, and Delete.
FirewallRules/FirewallRuleName/Name
Name of the rule.
Value type is string. Supported operations are Add, Get, Replace, and Delete.