Defender 5.11 - Administration Guide

Authenticate method

Submits a RADIUS request to the Defender Security Server and waits for a response. Typically, the Authenticate method would be invoked in a loop, whereby the current value of challengeMessage is displayed to the user, and the response from the user is supplied as the authData parameter on the next call to the Authenticate method. This would continue until the user chooses to cancel, or until the return code is not 1. If any request takes more than timeout seconds to complete, the method returns code -106.

C++ syntax
public : HRESULT Authenticate(BSTR userID, BSTR authData, LONG timeout, BSTR ipAddress, LONG port, BSTR sharedSecret, LONG* returnCode );

C# syntax
int Authenticate(string userID, string authData, int timeout, string ipAddress, int port, string sharedSecret);

Parameters

• userID  The username of the user to be authenticated. Maximum length is 255 characters.
• authData  The information which authenticates this user, such as a password or token response, typically entered by the user. You should set the value of this parameter in response to the current value of challengeMessage. Maximum length is 64 characters.
• timeout  The number of seconds before the request should be abandoned.
• ipAddress  The IP address of the Defender Security Server in “dotted decimal” format.
• port  The port number which the Defender Security Server is listening on for this client (Access Node).
• sharedSecret  This value is used to encrypt communications between the client program and the Defender Security Server. The value supplied here must match that defined in the Defender Access Node object for this client. See the Defender Installation and Administration Guide for further information on configuring Defender. Maximum length is 64 characters.

Return value

• 0  Authentication successful.
• 1  More information required to complete authentication.
• 2  Access denied.
• -102  Unable to establish communications environment.
• -103  API not supported on this platform.
• -105  Unable to establish session with Defender Security Server.
• -106  Unable to send request to Defender Security Server.
• -107  Defender Security Server did not respond.

challengeMessage property

Displays the value of the challenge message to the user after each invocation of the Authenticate method.

C++ syntax
public : HRESULT get_challengeMessage(BSTR * bstrDefenderMessage);

C# syntax
public string challengeMessage { get; }

sessionID property

Holds the session attribute for the current session. Defender handles up to 255 concurrent sessions. This value is for information only and should not be set by the calling program.

C++ syntax
public : HRESULT get_sessionID(LONG * sessionID);

C# syntax
public int sessionID { get; }

timeout property

Holds the timeout value for the current session. This value is for information only and should not be set by the calling program. the timeout value is set using the timeout parameter on each call to the Authenticate method.

C++ syntax
public : HRESULT get_timeout(LONG timeoutValue);

C# syntax
public int timeout { get; }