CustomAuthStart Event

Reports the beginning of a custom authentication method.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
virtual int FireCustomAuthStart(AuthenticatorCustomAuthStartEventParams *e);

typedef struct {
  const char *UserID;
  const char *AuthMethod;
  char *AuthMethodPars;
  char *AuthMethodData;
  int reserved;
} AuthenticatorCustomAuthStartEventParams;

Unicode (Windows)
virtual INT FireCustomAuthStart(AuthenticatorCustomAuthStartEventParams *e);

typedef struct {
  LPCWSTR UserID;
  LPCWSTR AuthMethod;
  LPWSTR AuthMethodPars;
  LPWSTR AuthMethodData;
  INT reserved;
} AuthenticatorCustomAuthStartEventParams;

- (void)onCustomAuthStart:(NSString*)userID :(NSString*)authMethod :(NSString**)authMethodPars :(NSString**)authMethodData;

#define EID_AUTHENTICATOR_CUSTOMAUTHSTART 5

virtual INT SECUREBLACKBOX_CALL FireCustomAuthStart(LPSTR &lpszUserID, LPSTR &lpszAuthMethod, LPSTR &lpszAuthMethodPars, LPSTR &lpszAuthMethodData);

Remarks

This event marks the start of an authentication method not supported by class internally and requests authentication parameters from the application.

Class currently supports the following authentication methods:

• password
• otp-h
• otp-t
• dcauth

The application may also use any number of custom authentication method it wants. Each such method is identified by a unique string name (such as 'pin', 'fingerprint', or 'fingerprint-v2'). It may specify them in DefaultAuthMethods property, or provide on the fly via AuthStart event.

The event handler may return authentication parameters and application-specific data to be associated with the authentication attempt via AuthMethodPars and AuthMethodData parameters.