com.gemalto.idp.mobile.core.passwordmanager

Interface PasswordManager

public interface PasswordManager

PasswordManager interface: login to unlock the secret data used by different modules

Since:

4.0

Method Summary

Modifier and Type	Method and Description
void	changePassword(SecureString oldPassword, SecureString newPassword) Changes the password after the password was set.
boolean	isLoggedIn() Checks if the password manager is logged in.
boolean	isMigrationFromSDK2xNeeded() Determines whether or not the SDK needs a migration from version 2.x to current version.
boolean	isPasswordSet() Checks if the password is set.
void	login() Unlocks all password domain(s) without the need to use a password.
void	login(SecureString password) Unlocks all password domain(s).
void	logout() Logs out of the password manager.
void	migrateTokenPasswordFromSDK2x(SecureString oldTokenPassword, SecureString password) Migrate the SDK from a 2.x version to current version.
void	removePassword(SecureString oldPassword) Removes the password.
boolean	reset() The reset of the password manager, will delete all files related to password manager.
void	setPassword(SecureString password) Sets the password.

Method Detail

isPasswordSet

boolean isPasswordSet()
               throws PasswordManagerException

Checks if the password is set.

Warning:

This method can block the calling thread for a short amount of time.

Returns:

a boolean value that indicates if password has been set.

Throws:

PasswordManagerException - exception that contains the information of the error.

setPassword

void setPassword(SecureString password)
          throws PasswordManagerException

Sets the password. If the password was already set, this operation will fail ( changePassword(SecureString, SecureString) should be used instead).

Warning:

This method can block the calling thread for a significant amount of time (up-to one second; longer on slow devices).

Actionable reasons for failure:

• IdpResultCode.PASSWORD_MANAGER_INVALID_PASSWORD

Parameters:

password - The global password value to set. Cannot be null.

Throws:

PasswordManagerException - exception that contains the information of the error.

changePassword

void changePassword(SecureString oldPassword,
                    SecureString newPassword)
             throws PasswordManagerException

Changes the password after the password was set. If the password is not yet set, use setPassword(SecureString) instead.

Warning:

This method can block the calling thread for a significant amount of time (up-to one second; longer on slow devices).

Actionable reasons for failure:

• IdpResultCode.PASSWORD_MANAGER_INVALID_PASSWORD

Parameters:

oldPassword - The previously set password. Cannot be null.

newPassword - The new password to be applied. Cannot be null.

Throws:

PasswordManagerException - exception that contains the information of the error.

removePassword

void removePassword(SecureString oldPassword)
             throws PasswordManagerException

Removes the password. This means that it is now possible to login to the password manager with no password, by using the login() method. This is considered unsafe.

Warning:

It is strongly discouraged to use this option as it introduces a security weakness in the SDK. When possible, always use a secret password.

Warning:

This method can block the calling thread for a significant amount of time (up-to one second; longer on slow devices).

Actionable reasons for failure:

• IdpResultCode.PASSWORD_MANAGER_INVALID_PASSWORD

Parameters:

oldPassword - The previously set password. Cannot be null.

Throws:

PasswordManagerException - exception that contains the information of the error.

isLoggedIn

boolean isLoggedIn()
            throws PasswordManagerException

Checks if the password manager is logged in.

Warning:

This method can block the calling thread for a short amount of time.

Returns:

a boolean value that indicates if it is logged in.

Throws:

PasswordManagerException - exception that contains the information of the error.

login

void login()
    throws PasswordManagerException

Unlocks all password domain(s) without the need to use a password. This operation will fail if a password was already set.

Warning:

It is strongly discouraged to use this option as it introduces a security weakness in the SDK. When possible, always use a secret password.

Warning:

This method can block the calling thread for a significant amount of time (up-to one second; longer on slow devices).

Throws:

PasswordManagerException - exception that contains the information of the error.

login

void login(SecureString password)
    throws PasswordManagerException

Unlocks all password domain(s). This operation will fail if no password was previously set.

Warning:

This method can block the calling thread for a significant amount of time (up-to one second; longer on slow devices).

Actionable reasons for failure:

• IdpResultCode.PASSWORD_MANAGER_INVALID_PASSWORD

Parameters:

password - The previously set password. Cannot be null.

Throws:

PasswordManagerException - exception that contains the information of the error.

logout

void logout()
     throws PasswordManagerException

Logs out of the password manager. While logged out, trying to use any functionality represented by password domain type will generate errors..

Warning:

This method can block the calling thread for a significant amount of time (up-to one second; longer on slow devices).

Throws:

PasswordManagerException - exception that contains the information of the error.

migrateTokenPasswordFromSDK2x

void migrateTokenPasswordFromSDK2x(SecureString oldTokenPassword,
                                   SecureString password)
                            throws PasswordManagerException

Migrate the SDK from a 2.x version to current version. If the application is being updated from a previous version, this method may need to be called to enable the password manager to manage passwords for the TOKEN functionalities.

Until this method is call, an SDK that requires a migration will be unable to generate or verify any kind of OTP. The method isMigrationFromSDK2xNeeded() can be called to determine if the migration is needed.

The method only needs to be called once, preferable on first startup after update of an application.

Parameters:

oldTokenPassword - The password used in the previous version of the application to secure the Token. Use null if no password was set in the previous version.

password - The password used for login in the PasswordManager. Use null if you are not using any password.

Throws:

PasswordManagerException - exception that contains the information of the error.

isMigrationFromSDK2xNeeded

boolean isMigrationFromSDK2xNeeded()
                            throws PasswordManagerException

Determines whether or not the SDK needs a migration from version 2.x to current version. If the migration is needed, method migrateTokenPasswordFromSDK2x(com.gemalto.idp.mobile.core.util.SecureString, com.gemalto.idp.mobile.core.util.SecureString) should be called.

Returns:

True if the SDK needs a migration, false otherwise.

Throws:

PasswordManagerException - exception that contains the information of the error.

reset

boolean reset()
       throws PasswordManagerException

The reset of the password manager, will delete all files related to password manager. Dangerous Operation! Calling this method will invalidate the data of following features:

SecureStorage : data no longer retrievable. Out-Of-Band functionality: re-registration required. FaceAuthentication: re-enrollment needed. Token: existing tokens are no longer usable. Re-provisioning required. Before calling this method, you need to call reset from above modules/services if you have existing data associated with them. After calling this method, user must set again the password and perform login.

Returns:

The result of the operation.

Throws:

PasswordManagerException - exception that contains the information of the error.

Since:

4.9.0

See Also:

IdpCore.reset()