3.1.4.63 RRPC_FWAddAuthenticationSet2_20 (Opnum 62)

  • Article

The RRPC_FWAddAuthenticationSet2_20 method requests the server to add the authentication set in the policy contained in the policy store referenced by the handle specified in the hPolicy parameter. The method is only supported for binary version 0x0214.

 unsigned long RRPC_FWAddAuthenticationSet2_20(
   [in] FW_CONN_HANDLE rpcConnHandle,
   [in] FW_POLICY_STORE_HANDLE hPolicy,
   [in] PFW_AUTH_SET pAuth,
   [out] FW_RULE_STATUS* pStatus
 );

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

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

pAuth: This parameter represents the authentication set the client wants to add to the store. The set MUST be valid, as specified in the definition of the FW_AUTH_SET data type.

pStatus: This output parameter is the status code of the rule as specified by the FW_RULE_STATUS enumeration. This field is filled out on return.

Return Values: The method returns 0 if successful; if failed, 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 set has a set 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 hPolicy 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

One of the parameters of this method is incorrect, or is required and not specified. This error can be returned because:

  • The pAuth object did not pass the firewall rule validations specified in the definition of the FW_AUTH_SET data type.

  • One of the required values is not specified.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol, as specified in [MS-RPCE].

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

The server MUST validate the client credentials to the administrator or network operator before executing this method.