AuthVerify Event

Requests the application to validate an authentication token.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
virtual int FireAuthVerify(AuthenticatorAuthVerifyEventParams *e);

typedef struct {
  const char *UserID;
  const char *AuthMethod;
  const char *AuthToken;
  const char *AuthMethodData;
  int Valid;
  int reserved;
} AuthenticatorAuthVerifyEventParams;

Unicode (Windows)
virtual INT FireAuthVerify(AuthenticatorAuthVerifyEventParams *e);

typedef struct {
  LPCWSTR UserID;
  LPCWSTR AuthMethod;
  LPCWSTR AuthToken;
  LPCWSTR AuthMethodData;
  BOOL Valid;
  INT reserved;
} AuthenticatorAuthVerifyEventParams;

- (void)onAuthVerify:(NSString*)userID :(NSString*)authMethod :(NSString*)authToken :(NSString*)authMethodData :(int*)valid;

#define EID_AUTHENTICATOR_AUTHVERIFY 4

virtual INT SECUREBLACKBOX_CALL FireAuthVerify(LPSTR &lpszUserID, LPSTR &lpszAuthMethod, LPSTR &lpszAuthToken, LPSTR &lpszAuthMethodData, BOOL &bValid);

Remarks

Class fires this event to ask the application to validate an authentication token that it can't validate automatically. This can happen if UserID was not found in the user database or a custom authentication method is used.

AuthMethod and AuthToken specify the authentication method being used and the authentication token provided by the user. AuthMethodData contains an application-specific data provided by the application at the beginning of the authentication step.

An event handler subscribed to this event should validate the authentication token provided by the user and set the Valid parameter accordingly.