PRADIUS_EXTENSION_PROCESS_EX callback function (authif.h)

  • Article
Note  Internet Authentication Service (IAS) was renamed Network Policy Server (NPS) starting with Windows Server 2008. The content of this topic applies to both IAS and NPS. Throughout the text, NPS is used to refer to all versions of the service, including the versions originally referred to as IAS.
 
The RadiusExtensionProcessEx function is an application-defined function and is called by NPS for each authentication or accounting packet that NPS receives from the network access server (NAS). This function is similar to RadiusExtensionProcess. However, RadiusExtensionProcessEx enables the Extension DLL to append attributes to the authentication response.

Syntax

PRADIUS_EXTENSION_PROCESS_EX PradiusExtensionProcessEx;

DWORD PradiusExtensionProcessEx(
  [in]  const RADIUS_ATTRIBUTE *pInAttrs,
  [out] PRADIUS_ATTRIBUTE *pOutAttrs,
  [out] PRADIUS_ACTION pfAction
)
{...}

Parameters

[in] pInAttrs

Pointer to an array of attributes from the request. The array is terminated by an attribute with dwAttrType set to ratMinimum. These attributes should be treated as read-only; they should not be modified by RadiusExtensionProcessEx. Also, these attributes should not be referenced in any way after RadiusExtensionProcessEx returns.

[out] pOutAttrs

Pointer to an array of attributes provided by the NPS Extension DLL. The array is terminated by an attribute with dwAttrType set to ratMinimum. NPS adds these attributes to the authentication response.

The NPS Extension DLL allocates the memory for the array of attributes. NPS calls RadiusExtensionFreeAttributes to free the memory occupied by the array of attributes.

[out] pfAction

Pointer to a value of type RADIUS_ACTION, initially set to raContinue. This parameter specifies the action that NPS should take in response to an Access-Request.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value should be an appropriate error code from WinError.h.

Remarks

If the return value is anything other than NO_ERROR, NPS discards the request.

NPS supports multiple Extension DLLs. NPS calls RadiusExtensionProcessEx for each of the DLLs listed in the registry. For more information see Setting Up the Extension DLLs.

NPS calls RadiusExtensionFreeAttributes to free the memory occupied by the array of attributes returned by RadiusExtensionProcessEx. For this reason, if you implement RadiusExtensionProcessEx, you must also implement RadiusExtensionFreeAttributes.

For more information on the use of this function, see NPS Extensions Process.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008
Target Platform Windows
Header authif.h

See also

About NPS Extensions

NPS Extensions Functions

NPS Extensions Reference

RADIUS_ACTION

RADIUS_ATTRIBUTE

RADIUS_ATTRIBUTE_TYPE

RadiusExtensionProcess