Summary of OPSEC API Functions

We recommend that you use Version 2 API. If you have legacy clients that use Version 1, include Version 1 API functions for backward compatibility.

To understand the advantages of Version 2, see the legacy Secure Authentication API Specification.

Note - The function prototypes are defined in the file authplugin.h which can be found on the OPSEC Desktop SDK.

API Function

Version (Ver)

Summary of Functionality

PickVersion

Optional for Ver 1.

Required for Ver 2

Supplies the lower and higher API versions that the client supports. From these versions, the Authentication Agent chooses which it prefers, and the client uses that selection.

If PickVersion is not in the DLL, the Client assumes you are using Version1.

RegisterAgent or RegisterAgentVer2

RegisterAgent - Ver 1 RegisterAgentVer2 - Ver 2

Supplies the client with the functions required to work with the Authentication Agent.

Username

For Ver 1 and Ver 2

Supplies the username to be used by the client to authenticate with the Security Gateway for SAA Challenge/Response authentication.

UserNameAndPassword or UserNameAndPasswordVer2

UserNameAndPassword - Ver 1 UserNameAndPasswordVer2 - Ver 2

Supplies the username and password to be used by the client to authenticate with the Security Gateway for SAA Username/Password authentication.

Response

For Ver 1 and Ver 2

The client gives the Authentication Agent the challenge that it gets from the Security Gateway. The Authentication Agent returns a response that the client sends back to the gateway the Security Gateway.

AuthCompleted or Terminate

Terminate - Ver 1

AuthCompleted - Ver 2

The client tells the Authentication Agent when authentication has completed and its result. The Authentication Agent can notify the user of the authentication's results.

ReleaseContext

Only for Ver 2

Is called when the client wants to delete context, for example, when a password is expired or has been erased.

VendorDescription

For Ver 1 and Ver 2

Returns a meaningful name that the client can display to the user.

GoingDown

For Ver 1 and Ver 2

Is called when the client session is going to terminate.

InvalidateProcCB

For Ver 1 and Ver 2

Instructs the client to invalidate previous authentications.