AuthenticateRadiusUser Method of the IFWXRadiusAuthenticator Interface

The AuthenticateRadiusUser method performs RADIUS authentication of the specified user in an asynchronous operation.

Syntax

HRESULT AuthenticateRadiusUser(
  [in]  BSTR bstrUsername,
  [in]  BSTR bstrUserPassword,
  [in]  IFWXAuthenticationCompletion* pIFWXAuthenticationCompletion,
  [in]  UserContextType UserData
);

Parameters

bstrUsername

String value that specifies the user name with which to perform authentication.

bstrUserPassword

String value that specifies the user password with which to perform authentication.

pIFWXAuthenticationCompletion

Pointer to an IFWXAuthenticationCompletion interface.

UserData

An opaque value that can be used to differentiate between authentication operations. This value will be passed in the UserData parameter of the CompleteAsyncAuthentication method on the IFWXAuthenticationCompletion interface specified in the pIFWXAuthenticationCompletion parameter when this authentication operation completes.

Return Value

This method returns S_OK if the call is successful; otherwise, it returns a Windows error code, in which case the authentication operation is not initiated and the completion function will not be called.

Remarks

An application filter can use IFWXFirewall2::CreateRadiusAuthenticator to get the IFWXRadiusAuthenticator interface. When a request is received on a listener that has RADIUS authentication enabled, and the application filter needs to perform RADIUS authentication, it calls IFWXRadiusAuthenticator::AuthenticateRadiusUser and gives it the pointer to its IFWXAuthenticationCompletion interface.

Requirements

Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
Header

Declared in Wspfwext.idl.

DLL

Requires Wspsrv.exe.

See Also

IFWXRadiusAuthenticator


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.