Share via

3.1.4.6 RRPC_FWAddFirewallRule (Opnum 5)

  • Article

The RRPC_FWAddFirewallRule method requests the server to add the specified firewall rule in the policy contained in the policy store that is referenced by the handle specified in the hPolicyStore parameter.

 ULONG RRPC_FWAddFirewallRule(
   [in] FW_CONN_HANDLE rpcConnHandle,
   [in] FW_POLICY_STORE_HANDLE hPolicyStore,
   [in] PFW_RULE2_0 pRule
 );

rpcConnHandle: This parameter is an RPC binding handle that connects to the RPC interface of the Firewall and Advanced Security Protocol.

hPolicyStore: This input parameter is an FW_POLICY_STORE_HANDLE data type. The data type MUST contain an opened policy store handle that is successfully opened by using the RRPC_FWOpenPolicyStore (Opnum 0) method. The handle MUST have read/write access rights.

pRule: This parameter represents the firewall rule that the client wants to add to the store. The rule MUST be a valid rule, as specified in the definition of the FW_RULE2_0 data type.

Return Values: The method returns 0 if successful; if it fails, it returns a nonzero error code. The field can take any specific error code value, as specified in [MS-ERREF]. The following return values are common.

Return value/code

Description

0x000000B7

ERROR_ALREADY_EXISTS

The specified rule has a rule ID that already exists in the specified store.

0x00000032

ERROR_NOT_SUPPORTED

The specified store does not support this method; the store might be read-only.

0x00000005

ERROR_ACCESS_DENIED

The hPolicyStore handle was not opened with read/write access rights. The error is also returned if the client does not have the required credentials to call the method.

0x00000057

ERROR_INVALID_PARAMETER

A parameter of this method is incorrect or is required and not specified. This error can be returned because:

  • The pRule object did not pass the firewall rule validations that are specified in the definition of the FW_RULE data type.

  • One of the required values is not specified.

  • A policy store does not support rules with profile conditions other than ALL profiles.

  • The wszLocalApplication field of the rule contains a string that was determined to be an invalid path.<33>

Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying RPC protocol, as specified in [MS-RPCE]. If any lower-layer errors are reported by RPC exception, this exception is converted to an error code and reported to higher-layer protocols via the return value.

This method adds a firewall rule to the firewall linked list of the memory representation of the store being modified. It also writes through and saves the rule in disk. If called on an online store, the firewall rule is also enforced.

The server MUST validate that the client is authorized to perform the requested operation (as defined in section 3.1.4) before executing this method.