SecureBlackbox 2020 C++ Edition

Questions / Feedback?

StartAuth Method

Initiates an authentication process.

Syntax

ANSI (Cross Platform)
int StartAuth(const char* lpszUserID);

Unicode (Windows)
INT StartAuth(LPCWSTR lpszUserID);
- (int)startAuth:(NSString*)userID;
#define MID_AUTHENTICATOR_STARTAUTH 4

SECUREBLACKBOX_EXTERNAL int SECUREBLACKBOX_CALL SecureBlackbox_Authenticator_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

Call this method to start an authentication process for UserID.

The authentication process may consist of multiple atomic steps. Each step represents a single authentication transaction, such as provision of a password, a PIN, or a one-time token. The exact authentication step sequence for the user is chosen according to the following rules:

  • If the user is found in the Users database, all authentication methods specified for that user are activated;
  • otherwise, the methods assigned to DefaultAuthMethods are activated;
  • AuthStart event is thrown, allowing the application to tune up the selection of authentication methods if needed.
  • the first method from the list is initiated.

This method may return one of the three results:

arAuthFurtherAuthNeeded0
arAuthSucceeded1
arAuthFailed2

The authentication succeeded result is returned if the authentication method selection procedure completed with an empty method list. A typical result of this method though is further authentication required, which indicates that the next authentication method has kicked off. Use rpAuthInfo; property to find out which authentication method should be used on this step, and solicit the relevant authentication token from the user. Pass the received token to the ContinueAuth method for validation.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 C++ Edition - Version 20.0 [Build 8166]