Skip navigation links

com.bharosa.vcrypt.auth.intf
Interface VCryptAuth

public interface VCryptAuth

Provides various methods for authenticating PIN/passwords using VCrypt system

Field Summary

static String	IMAGE_STATUS
static String	PHRASE_STATUS
static String	QUESTION_STATUS
static String	REQ_ADD_QUESTIONS
static String	REQ_AUTH_QUESTION
static String	REQ_AUTH_QUESTION_CSR
static String	REQ_GET_CAPTION
static String	REQ_GET_IMAGE
static String	REQ_GET_IMAGE_AND_CAPTION
static String	REQ_GET_IMAGE_AND_LOCALIZED_CAPTION
static String	REQ_GET_LOCALIZED_CAPTION
static String	REQ_GET_PREF_DELIVERY_CHANNEL
static String	REQ_GET_USER
static String	REQ_SET_GROUP_AUTH_MODE
static String	REQ_SET_IMAGE_AND_CAPTION

Method Summary

VCryptResponse	addQuestion(String requestId, String customerId, VCryptQuestion question) Adds a new question for the specified user
VCryptResponse	addQuestion(String customerId, VCryptQuestion question) Adds a new question for the specified user
VCryptResponse	addQuestions(String requestId, String customerId, VCryptQuestion[] questions) Add questions to the customer Expects the number of questions to be exactly equal to the required number of questions Calling this method will delete any previously existing quesions Success indicates adding all questions, failure means none of the questions are added.
VCryptResponse	addQuestions(String customerId, VCryptQuestion[] questions) Add questions to the customer Expects the number of questions to be exactly equal to the required number of questions Calling this method will delete any previously existing quesions Success indicates adding all questions, failure means none of the questions are added.
VCryptAuthResult	authenticatePassword(String customerId, String password, int authSessionType, int clientType, String clientVersion, String ipAddress, int fingerPrintType, String fingerPrint) Method to athenticate password
VCryptAuthResult	authenticatePin(String customerId, String pin, Long authSessionId, int authSessionType, int clientType, String clientVersion, String ipAddress, int fingerPrintType, String fingerPrint) Method to athenticate pin
VCryptAuthResult	authenticateQuestion(String requestId, Integer challengeChannel, String customerId, String answer) Method for authenticate question/answer
VCryptAuthResult	authenticateQuestion(String customerId, String answer) Method for authenticate question/answer
VCryptAuthResult	authenticateQuestionForCSR(String requestId, Integer challengeChannel, String customerId, String answer) Method for authenticate question/answer for customer care
VCryptAuthResult	authenticateQuestionForCSR(String customerId, String answer) Method for authenticate question/answer for CSR policy
VCryptAuthResult	authenticateSlider(String customerId, String pin, Vector displacements, Map authStats, Long authSessionId, String ipAddress, int fingerPrintType, String fingerPrint) This method authenticates the PIN entered by the user using the slider.
VCryptAuthResult	authenticateSlider(String customerId, Vector displacements, Map authStats, Long authSessionId, String ipAddress, int fingerPrintType, String fingerPrint) This method authenticates the PIN entered by the user using the slider.
VCryptAuthUser	createUser(VCryptAuthUser user) This creates an user in the Authentication database.
boolean	deleteAllSignOnQuestions(String customerId) Delete all sign on questions for the given user
boolean	deleteQuestion(String customerId, VCryptQuestion question) Deletes the question for the specified user
VCryptWheel	genWheel(int length, int sets, Long previousAuthSessionId, int authSessionType, int clientType, String clientVersion, String ipAddress, int fingerPrintType, String fingerPrint) This method generates a new wheel with creating the VCryptAuthSession object.
VCryptQuestion[]	getAllMappedSignOnQuestions(String customerId) Get user questions
String	getCaption(String customerId) Gets the caption for the user
String	getImage(String customerId) Gets the imagePath for the user
String[]	getImageAndCaption(String customerId) Gets the image path and caption for the user
Object[]	getImageAndLocalizedCaption(String customerId)
VCryptLocalizedString	getLocalizedCaption(String customerId)
VCryptQuestion	getSecretQuestion(String customerId) Gets a secret question for the user
VCryptQuestion	getSecretQuestionForCSR(String customerId) Gets a secret question for the user for CSR policy
VCryptQuestion[][]	getSignOnQuestions(String customerId) Gets all the secret questions available for the user.
VCryptQuestion[][]	getSignOnQuestions(String customerId, VCryptLocale aLocale)
VCryptAuthUser	getUser(String customerId) Return the user details without the password and pin for the given customer and group
int	getUserAuthMode(String customerId) Gets the authMode for the user
VCryptAuthUser	getUserByLoginId(String loginId) This returns the user details without the password and pin.
VCryptAuthUser	getUserByLoginId(String loginId, String groupName) Return the user details without the password and pin for the given customer and group
int	getUserStatus(String customerId) Gets the status for the user
VCryptQuestion	moveToNextSecretQuestion(String customerId) Move the current secret question for the user to next
boolean	setCaption(String customerId, String caption) Sets a new caption for the specified user If caption is null, A caption with default locale is set.
boolean	setCaption(String customerId, VCryptLocalizedString caption) Sets a new caption for the specified user If caption is null, A caption with default locale and default text is set.
boolean	setGroupUsersAuthMode(String groupName, int authMode) Set authmode of customerGroupId users to authMode Uses batch updates and failure is not guaranteed to leave the system in old auth mode as failure may occur in later batch, after initial batches are saved.
boolean	setImage(String customerId, String imagePath) Sets a new image for the specified user
boolean	setImageAndCaption(String customerId, String imagePath, String caption) This sets the Image and caption for the user.
boolean	setImageAndCaption(String customerId, String imagePath, VCryptLocalizedString caption) This sets the Image and caption for the user.
boolean	setPassword(String customerId, String password, int passwordStatus) Sets a new password for the specified user
boolean	setPIN(String customerId, String PIN, int pinStatus) Sets a new PIN for the specified user
VCryptAuthUser	setUser(VCryptAuthUser user) This updates the AuthUser Returns null if user is null or the customerId attribute in user is invalid.
boolean	setUserAuthMode(String customerId, int authMode) Sets a authMode for the specified user
boolean	setUserStatus(String customerId, int status) Sets a status for the specified user

Field Detail

REQ_GET_CAPTION

static final String REQ_GET_CAPTION

See Also:

Constant Field Values

REQ_GET_PREF_DELIVERY_CHANNEL

static final String REQ_GET_PREF_DELIVERY_CHANNEL

See Also:

Constant Field Values

REQ_GET_IMAGE

static final String REQ_GET_IMAGE

See Also:

Constant Field Values

REQ_GET_IMAGE_AND_CAPTION

static final String REQ_GET_IMAGE_AND_CAPTION

See Also:

Constant Field Values

REQ_SET_IMAGE_AND_CAPTION

static final String REQ_SET_IMAGE_AND_CAPTION

See Also:

Constant Field Values

REQ_SET_GROUP_AUTH_MODE

static final String REQ_SET_GROUP_AUTH_MODE

See Also:

Constant Field Values

REQ_ADD_QUESTIONS

static final String REQ_ADD_QUESTIONS

See Also:

Constant Field Values

REQ_GET_USER

static final String REQ_GET_USER

See Also:

Constant Field Values

REQ_AUTH_QUESTION_CSR

static final String REQ_AUTH_QUESTION_CSR

See Also:

Constant Field Values

REQ_AUTH_QUESTION

static final String REQ_AUTH_QUESTION

See Also:

Constant Field Values

REQ_GET_LOCALIZED_CAPTION

static final String REQ_GET_LOCALIZED_CAPTION

See Also:

Constant Field Values

REQ_GET_IMAGE_AND_LOCALIZED_CAPTION

static final String REQ_GET_IMAGE_AND_LOCALIZED_CAPTION

See Also:

Constant Field Values

QUESTION_STATUS

static final String QUESTION_STATUS

See Also:

Constant Field Values

IMAGE_STATUS

static final String IMAGE_STATUS

See Also:

Constant Field Values

PHRASE_STATUS

static final String PHRASE_STATUS

See Also:

Constant Field Values

Method Detail

getUser

VCryptAuthUser getUser(String customerId)

Return the user details without the password and pin for the given customer and group

Parameters:

customerId - of the user.

Returns:

a VCryptAuthUser value. If the user is not valid, then all the values in the object is is null. Any unexpected error, Null is returned.

getUserByLoginId

VCryptAuthUser getUserByLoginId(String loginId,
                                String groupName)

Return the user details without the password and pin for the given customer and group

Parameters:

loginId - of the user.

groupName - groupName

Returns:

a VCryptAuthUser value. If the user is not valid, then all the values in the object is is null. Any unexpected error, Null is returned.

getUserByLoginId

VCryptAuthUser getUserByLoginId(String loginId)

This returns the user details without the password and pin.

Parameters:

loginId - of the user.

Returns:

a VCryptAuthUser value. If the user is not valid, then all the values in the object is is null

createUser

VCryptAuthUser createUser(VCryptAuthUser user)

This creates an user in the Authentication database. Returns null if user is null.

Parameters:

user - Auth user

Returns:

The newly created AuthUser

setUser

VCryptAuthUser setUser(VCryptAuthUser user)

This updates the AuthUser Returns null if user is null or the customerId attribute in user is invalid.

Parameters:

user - From the attributes in the map, it will only update the name/values which are given in this list.

Returns:

The updated AuthUser

authenticatePassword

VCryptAuthResult authenticatePassword(String customerId,
                                      String password,
                                      int authSessionType,
                                      int clientType,
                                      String clientVersion,
                                      String ipAddress,
                                      int fingerPrintType,
                                      String fingerPrint)

Method to athenticate password

Parameters:

customerId - The customerId used by the user.

password - The raw password entered by the user.If null is passed,"system_error" would be returned.

authSessionType - Reason for authentication

clientType - Client type used.

clientVersion - Client version

ipAddress - IP address of the user device.

fingerPrintType - Type of finger printing

fingerPrint - Finger print

Returns:

The VCryptAuthResult object

authenticatePin

VCryptAuthResult authenticatePin(String customerId,
                                 String pin,
                                 Long authSessionId,
                                 int authSessionType,
                                 int clientType,
                                 String clientVersion,
                                 String ipAddress,
                                 int fingerPrintType,
                                 String fingerPrint)

Method to athenticate pin

Parameters:

customerId - The customerId used by the user.

pin - The raw pin entered by the user.

authSessionId - Authentication sessionId

authSessionType - Reason for authentication

clientType - Client type used.

clientVersion - Client version

ipAddress - IP address of the user device.

fingerPrintType - Type of finger printing

fingerPrint - Finger print

Returns:

The VCryptAuthResult object

genWheel

VCryptWheel genWheel(int length,
                     int sets,
                     Long previousAuthSessionId,
                     int authSessionType,
                     int clientType,
                     String clientVersion,
                     String ipAddress,
                     int fingerPrintType,
                     String fingerPrint)

This method generates a new wheel with creating the VCryptAuthSession object.

Parameters:

length - of the wheel

sets - number of sets

previousAuthSessionId - previous authentication session id (if available)

authSessionType - What type of authentication session this is. It could be login, in-session, pin reset, etc.

clientType - what type of client is used for authentication

clientVersion - what is the version of the client

ipAddress - IP address of the user device.

fingerPrintType - Type of finger printing

fingerPrint - Finger print

Returns:

a VCryptWheel value

authenticateSlider

VCryptAuthResult authenticateSlider(String customerId,
                                    Vector displacements,
                                    Map authStats,
                                    Long authSessionId,
                                    String ipAddress,
                                    int fingerPrintType,
                                    String fingerPrint)

This method authenticates the PIN entered by the user using the slider.

Parameters:

customerId - CustomerId used by the user

displacements - Displacement of the marker

authStats - Hash map of user input metrics, like time taken, etc.

authSessionId - The Id of the auth session

ipAddress - IP address of the user device.

fingerPrintType - Type of finger printing

fingerPrint - Finger print

Returns:

a VCryptAuthResult value

authenticateSlider

VCryptAuthResult authenticateSlider(String customerId,
                                    String pin,
                                    Vector displacements,
                                    Map authStats,
                                    Long authSessionId,
                                    String ipAddress,
                                    int fingerPrintType,
                                    String fingerPrint)

This method authenticates the PIN entered by the user using the slider. This passess the PIN to be used for authentication. This method is usually used for PIN reset utility program.

Parameters:

customerId - CustomerId used by the user

pin - a String value

displacements - Displacement of the marker

authStats - Hash map of user input metrics, like time taken, etc.

authSessionId - The session Id for this authentication

ipAddress - IP address of the user device.

fingerPrintType - Type of finger printing

fingerPrint - Finger print

Returns:

a VCryptAuthResult value

setPIN

boolean setPIN(String customerId,
               String PIN,
               int pinStatus)

Sets a new PIN for the specified user

Parameters:

customerId - user login Id

PIN - New PIN to set

pinStatus - Status of the PIN, like one time, etc.

Returns:

whether the operation was success or failure

setPassword

boolean setPassword(String customerId,
                    String password,
                    int passwordStatus)

Sets a new password for the specified user

Parameters:

customerId - user login Id

password - New password to set

passwordStatus - Status of the Password, like one time, etc.

Returns:

whether the operation was success or failure

setImage

boolean setImage(String customerId,
                 String imagePath)

Sets a new image for the specified user

Parameters:

customerId - user login Id

imagePath - Path to the image file

Returns:

whether the operation was success or failure

setCaption

boolean setCaption(String customerId,
                   String caption)

Sets a new caption for the specified user If caption is null, A caption with default locale is set.

Parameters:

customerId - user login Id

caption - New caption to set

Returns:

whether the operation was success or failure

setCaption

boolean setCaption(String customerId,
                   VCryptLocalizedString caption)

Sets a new caption for the specified user If caption is null, A caption with default locale and default text is set.

Parameters:

customerId - user login Id

caption - New caption to set

Returns:

whether the operation was success or failure

setImageAndCaption

boolean setImageAndCaption(String customerId,
                           String imagePath,
                           String caption)

This sets the Image and caption for the user. If caption is null, A caption with default locale is set.

Parameters:

customerId - user customerId

imagePath - Path to the image file

caption - Caption to set for user

Returns:

a boolean value

setImageAndCaption

boolean setImageAndCaption(String customerId,
                           String imagePath,
                           VCryptLocalizedString caption)

This sets the Image and caption for the user. If caption is null, A caption with default locale and a default text is set.

Parameters:

customerId - user customerId

imagePath - Path to the image file

caption - Caption to set for user

Returns:

a boolean value

setUserAuthMode

boolean setUserAuthMode(String customerId,
                        int authMode)

Sets a authMode for the specified user

Parameters:

customerId - user login Id

authMode - New authMode to set

Returns:

whether the operation was success or failure

setGroupUsersAuthMode

boolean setGroupUsersAuthMode(String groupName,
                              int authMode)

Set authmode of customerGroupId users to authMode

Uses batch updates and failure is not guaranteed to leave the system in old auth mode as failure may occur in later batch, after initial batches are saved.

Parameters:

groupName - customerGroupId of the users

authMode - new Auth mode

Returns:

true if update is successful

setUserStatus

boolean setUserStatus(String customerId,
                      int status)

Sets a status for the specified user

Parameters:

customerId - user login Id

status - New status to set

Returns:

whether the operation was success or failure

getImage

String getImage(String customerId)

Gets the imagePath for the user

Parameters:

customerId - user login Id

Returns:

Path to the image, null for invalid users and unexpected errors

getCaption

String getCaption(String customerId)

Gets the caption for the user

Parameters:

customerId - user login Id

Returns:

Caption string, null for invalid users and unexpected errors

getLocalizedCaption

VCryptLocalizedString getLocalizedCaption(String customerId)

getImageAndCaption

String[] getImageAndCaption(String customerId)

Gets the image path and caption for the user

Parameters:

customerId - user login Id

Returns:

String[0]= Image path, String[1] is Caption

getImageAndLocalizedCaption

Object[] getImageAndLocalizedCaption(String customerId)

getUserAuthMode

int getUserAuthMode(String customerId)

Gets the authMode for the user

Parameters:

customerId - user login Id

Returns:

authMode int

getUserStatus

int getUserStatus(String customerId)

Gets the status for the user

Parameters:

customerId - user login Id

Returns:

status int, 0 is returned for invalid user and unexpcted errors

getSignOnQuestions

VCryptQuestion[][] getSignOnQuestions(String customerId)

Gets all the secret questions available for the user.

Parameters:

customerId - The login id of the user to authenticate

Returns:

The 2-D array object containing the questions to ask. First dimension denotes the number of (configurable) question pick sets to display to user and the second dimension denotes the number of questions in each pick set.

getSignOnQuestions

VCryptQuestion[][] getSignOnQuestions(String customerId,
                                      VCryptLocale aLocale)

Parameters:

customerId - The login id of the user to authenticate

aLocale - The Locale to return in. If passed null, null is returned. Use getSignOnQuestions(String > customerId), if default locale is to be used.

Returns:

The 2-D array object containing the questions to ask. First dimension denotes the number of (configurable) question pick sets to display to user and the second dimension denotes the number of questions in each pick set.

getAllMappedSignOnQuestions

VCryptQuestion[] getAllMappedSignOnQuestions(String customerId)

Get user questions

Parameters:

customerId - customer Id

Returns:

Array of VCryptQuestion, null incase of invalid users and unexpected erros

deleteAllSignOnQuestions

boolean deleteAllSignOnQuestions(String customerId)

Delete all sign on questions for the given user

Parameters:

customerId - customer id

Returns:

boolean if success

addQuestion

VCryptResponse addQuestion(String customerId,
                           VCryptQuestion question)

Adds a new question for the specified user

Parameters:

customerId - user login Id

question - New question to be added. Overrides if the same question is already set for this user.

Returns:

whether the operation was success or failure

addQuestion

VCryptResponse addQuestion(String requestId,
                           String customerId,
                           VCryptQuestion question)

Adds a new question for the specified user

Parameters:

requestId - Bharosa Request Id

customerId - user login Id

question - New question to be added. Overrides if the same question is already set for this user.

Returns:

whether the operation was success or failure

addQuestions

VCryptResponse addQuestions(String customerId,
                            VCryptQuestion[] questions)

Add questions to the customer Expects the number of questions to be exactly equal to the required number of questions Calling this method will delete any previously existing quesions Success indicates adding all questions, failure means none of the questions are added.

Parameters:

customerId - user login Id

questions - New questions to be added. Overrides if the same question is already set for this user.

Returns:

whether the operation was success or failure

addQuestions

VCryptResponse addQuestions(String requestId,
                            String customerId,
                            VCryptQuestion[] questions)

Add questions to the customer Expects the number of questions to be exactly equal to the required number of questions Calling this method will delete any previously existing quesions Success indicates adding all questions, failure means none of the questions are added.

Parameters:

requestId - Bharosa Request Id

customerId - customerId

questions - Question

Returns:

VCryptResponse to get response status and message

deleteQuestion

boolean deleteQuestion(String customerId,
                       VCryptQuestion question)

Deletes the question for the specified user

Parameters:

customerId - user login Id

question - The question to be deleted

Returns:

whether the operation was success or failure

getSecretQuestion

VCryptQuestion getSecretQuestion(String customerId)

Gets a secret question for the user

Parameters:

customerId - The login id of the user to authenticate

Returns:

The object containing the question to ask

getSecretQuestionForCSR

VCryptQuestion getSecretQuestionForCSR(String customerId)

Gets a secret question for the user for CSR policy

Parameters:

customerId - The login id of the user to authenticate

Returns:

The object containing the question to ask

moveToNextSecretQuestion

VCryptQuestion moveToNextSecretQuestion(String customerId)

Move the current secret question for the user to next

Parameters:

customerId - The login id of the user to authenticate

Returns:

The object containing the question to ask, null in case of errors

authenticateQuestion

VCryptAuthResult authenticateQuestion(String customerId,
                                      String answer)

Method for authenticate question/answer

Parameters:

customerId - The login id of the user to authenticate

answer - the answer given by the user

Returns:

VCryptAuthResult describing result of authentication attempt

authenticateQuestion

VCryptAuthResult authenticateQuestion(String requestId,
                                      Integer challengeChannel,
                                      String customerId,
                                      String answer)

Method for authenticate question/answer

Parameters:

requestId - requestId

challengeChannel - IBharosaConstants.ENUM_CHALLENGE_CHANNEL

customerId - The login id of the user to authenticate

answer - The answer given by the user

Returns:

VCryptAuthResult describing result of authentication attempt

authenticateQuestionForCSR

VCryptAuthResult authenticateQuestionForCSR(String requestId,
                                            Integer challengeChannel,
                                            String customerId,
                                            String answer)

Method for authenticate question/answer for customer care

Parameters:

requestId - requestId

challengeChannel - IBharosaConstants.ENUM_CHALLENGE_CHANNEL

customerId - The login id of the user to authenticate

answer - The answer given by the user

Returns:

VCryptAuthResult describing result of authentication attempt

authenticateQuestionForCSR

VCryptAuthResult authenticateQuestionForCSR(String customerId,
                                            String answer)

Method for authenticate question/answer for CSR policy

Parameters:

customerId - The login id of the user to authenticate

answer - the answer given by the user

Returns:

VCryptAuthResult describing result of authentication attempt

Skip navigation links