3.1.4.18 RRPC_FWAddAuthenticationSet (Opnum 17)

  • Article

The RRPC_FWAddAuthenticationSet 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.

 unsigned long RRPC_FWAddAuthenticationSet(
   [in] FW_CONN_HANDLE rpcConnHandle,
   [in] FW_POLICY_STORE_HANDLE hPolicy,
   [in] PFW_AUTH_SET2_10 pAuth
 );

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_SET2_10 data type.

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 authentication set 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]. 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 an authentication set in the authentication linked list of the memory representation of the store being modified. It also writes through and saves the set in disk. If called on an online store and the set is a primary set, the method enumerates the connection security rule list and reapplies each rule referencing this primary set to complete the enforcement of the policy.

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.