Chat now with support
Chat with Support

Defender 5.8 - Administrator Guide

Getting started Managing Defender objects in Active Directory Configuring security tokens Securing VPN access Securing Web sites Securing Windows-based computers Securing PAM-enabled services Defender Management Portal (Web interface) Delegating Defender roles, tasks, and functions Automating administrative tasks Administrative templates Integration with Active Roles Integration with Cloud Access Manager Appendices
Appendix A: Enabling diagnostic logging Appendix B: Troubleshooting common authentication issues Appendix C: Troubleshooting DIGIPASS token issues Appendix D: Defender classes and attributes in Active Directory Appendix E: Defender Event Log messages Appendix F: Defender Client SDK Appendix G: Defender Web Service API

IAuthenticator, IAuthenticator2, and IAuthenticator3 interfaces

Table 12. Methods
Table 13. Properties
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);
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.
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.
C++ syntax
public : HRESULT get_challengeMessage(BSTR * bstrDefenderMessage);
C# syntax
public string challengeMessage { get; }
C++ syntax
public : HRESULT get_sessionID(LONG * sessionID);
C# syntax
public int sessionID { get; }
C++ syntax
public : HRESULT get_timeout(LONG timeoutValue);
C# syntax
public int timeout { get; }

IAuthenticator2 and IAuthenticator3 interfaces

Table 14. Properties
C++ syntax
public : HRESULT get_challengeMessageId(LONG * messageId);
C# syntax
public string challengeMessageId { get; }
C++ syntax
public : HRESULT get_challengeMessageData(BSTR * messageData);
C# syntax
public string challengeMessageData { get; }

IAuthenticator3 interface

Table 15. Methods
Table 16. Properties
C++ syntax
public : HRESULT AddPayload(struct RADIUSPayloadAttribute *payload)
C# syntax
void AddPayload(ref RADIUSPayloadAttribute payload);
payload  Application specific payload data as a struct RADIUSPayloadAttribute.
C++ syntax
public : HRESULT GetGridData(BSTR *grid, VARIANT_BOOL *isRegistrationGrid, VARIANT_BOOL *isGrIDsureOnly, VARIANT_BOOL *hasGrid);
C# syntax
bool GetGridData(out string grid, out bool isRegistrationGrid, out bool isGrIDsureOnly);
grid  A string containing the values for the grid.
isRegistrationGrid  Returns TRUE if the user has not yet registered a PIP.
isGrIDsureOnly  Returns TRUE if the user only has a GrIDsure token.
hasGrid  Returns TRUE if a grid is available.
C++ syntax
public : HRESULT GetAuthenticationImage(VARIANT *imageData);
C# syntax
object GetAuthenticationImage();
imageData  A byte array containing a bitmap of the grid.
C++ syntax
public : HRESULT SetGridResetPIPAttribute(void);
C# syntax
void SetGridResetPIPAttribute();
C++ syntax
public : HRESULT get_payload(SAFEARRAY(struct RADIUSPayloadAttribute) * payload);
C# syntax
public Array payload { get; }
C++ syntax
public : HRESULT get_grIDsureMessage(BSTR *message);
C# syntax
public string grIDsureMessage { get; }
C++ syntax
public : HRESULT get_grIDsureGridType(LONG* gridType);
C# syntax
public int grIDsureGridType { get; }
0x00800000  The user has no grid.
0x01000000  The user has a registered grid.
0x02000000  The user has a grid but no PIP has been registered.
0x04000000  The user has a grid and the PIP has expired.
0x80000000  The user has a grid and they have expired the PIP.

IAuthInfo interface

Table 17. Properties
C++ syntax
public : HRESULT get_userIdType( BSTR accessNode, LONG* pVal);
C# syntax
public virtual int get_userIdType(string accessNode)
0  Defender ID.
1  User Principal Name.
2  SAM Account Name.
3  Proper Name.
-1  Failed to retrieve user ID type.
C++ syntax
public : HRESULT isUserDefenderAuthenticated( BSTR domain, BSTR samAccountName, BSTR accessNode, BSTR dssIpAddress, VARIANT_BOOL* pVal);;
C# syntax
public virtual int get_isUserDefenderAuthenticated(string domain, string samAccountName, string accessNode, string dssIpAddress)
domain  The NetBIOS name of the domain to which the user belongs.
samAccountName  The SAM account name of the user.
accessNode  The common name (cn) of the Defender Access Node through which the user will authenticate.
dssIpAddress  The IP address of the Defender Security Server through which the user will authenticate.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating