HID APPROVE SDK  5.9
HID Approve SDK for Android
com.hidglobal.ia.service.protectionpolicy.PasswordPolicy Interface Reference

Protection Policy with password specific constraints More...

Inheritance diagram for com.hidglobal.ia.service.protectionpolicy.PasswordPolicy:
com.hidglobal.ia.service.protectionpolicy.ProtectionPolicy com.hidglobal.ia.service.protectionpolicy.BioPasswordPolicy

Public Member Functions

boolean changePassword (char[] oldpwdvalue, char[] newpwdvalue) throws AuthenticationException, PasswordNotYetUpdatableException, InvalidPasswordException, LostCredentialsException, InternalException, FingerprintAuthenticationRequiredException, UnsupportedDeviceException, FingerprintNotEnrolledException, PasswordRequiredException, InvalidParameterException
 
int getCacheTimeout ()
 
long getCurrentAge ()
 
int getMaxAge ()
 
int getMaxAlpha ()
 
int getMaxHistory ()
 
int getMaxLength ()
 
int getMaxLowerCase ()
 
int getMaxNonAlpha ()
 
int getMaxNumeric ()
 
int getMaxUpperCase ()
 
int getMinAge ()
 
int getMinAlpha ()
 
int getMinLength ()
 
int getMinLowerCase ()
 
int getMinNonAlpha ()
 
int getMinNumeric ()
 
int getMinUpperCase ()
 
boolean isCacheEnabled ()
 
boolean isSequenceAllowed ()
 
void verifyPassword (char[] password) throws InternalException, UnsupportedDeviceException, LostCredentialsException, AuthenticationException, PasswordExpiredException, FingerprintAuthenticationRequiredException, FingerprintNotEnrolledException, PasswordRequiredException, InvalidParameterException
 
- Public Member Functions inherited from com.hidglobal.ia.service.protectionpolicy.ProtectionPolicy
ProtectionPolicyId getId ()
 
LockPolicy getLockPolicy ()
 
String getType ()
 

Detailed Description

Protection Policy with password specific constraints

Protection Policy with password specific constraints.

The restrictions may be any or all of the following:

  • Min and max character length
  • Min number of uppercase characters
  • Min number of lowercase characters
  • Min number of numeric characters
  • Min number of letter characters
  • Min number of special characters (non alphanumeric)
  • Max number of uppercase characters
  • Max number of lowercase characters
  • Max number of numeric characters
  • Max number of letter characters
  • Max number of special characters (non alphanumeric)
  • Min and max password age
  • Max password history

Member Function Documentation

◆ changePassword()

Changes the password bound to the protection policy identified by the protection policyId parameter. New password must respect the defined protection policy restrictions.

Parameters
oldpwdvalueold key password.
newpwdvaluenew key password.
Returns
true if password was successfully changed.
Exceptions
AuthenticationExceptionif old key password is incorrect.
PasswordNotYetUpdatableExceptionif the policy indicates that it is too early to update the password.
InvalidPasswordExceptionif new key password is not accepted by the protection policy.
LostCredentialsExceptionif provisioning key data has been corrupted or lost.
InternalExceptionif an unexpected error occurred.
FingerprintAuthenticationRequiredExceptionif fingerprint authentication is required by policy.
FingerprintNotEnrolledExceptionif fingerprint enrollment is required.
UnsupportedDeviceExceptionif device is not supported by policy.
PasswordRequiredExceptionif required password was not provided and cached password is not available.
InvalidParameterExceptionif the given parameters are invalid or required parameters are missing.

◆ getCacheTimeout()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getCacheTimeout ( )

Gets password cache timeout.

Returns
the cache timeout in seconds.

◆ getCurrentAge()

long com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getCurrentAge ( )

Get current password age since last change.

Returns
the current password age in days.

◆ getMaxAge()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMaxAge ( )

Get maximum age for a password. This determines how long (in days) users can keep a password before they have to change it. If 0, indicates that the password never expires.

Returns
the maximum password age in days.

◆ getMaxAlpha()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMaxAlpha ( )

Get maximum number of letter characters

Returns
the maximum number of alphabetical characters.

◆ getMaxHistory()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMaxHistory ( )

Get max password history limit. This security setting determines the number of unique new passwords that have to be associated with the key before an old password can be reused.

Returns
the maximum password history size.

◆ getMaxLength()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMaxLength ( )

Get maximum password length.

Returns
the maximum password length.

◆ getMaxLowerCase()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMaxLowerCase ( )

Get maximum number of lower case letters.

Returns
the maxLowerCase

◆ getMaxNonAlpha()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMaxNonAlpha ( )

Get maximum number of special characters (non alphanumeric)

Returns
the maximum number of special characters.

◆ getMaxNumeric()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMaxNumeric ( )

Get maximum number of numeric characters

Returns
the maximum number of digits.

◆ getMaxUpperCase()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMaxUpperCase ( )

Get maximum number of upper case letters.

Returns
the maxUpperCase

◆ getMinAge()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMinAge ( )

Get minimum age for password. This security setting determines the period of time (in days) that a password must be used before the user can change it. It must be less than the maximum password age. If 0, indicates to allow changes immediately.

Returns
the minimum password age in days.

◆ getMinAlpha()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMinAlpha ( )

Get minimum number of alphabetical characters.

Returns
the minimum number of alphabetical characters.

◆ getMinLength()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMinLength ( )

Get minimum password length.

Returns
the minimum password length.

◆ getMinLowerCase()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMinLowerCase ( )

Get the minimum number of lower case letters.

Returns
the minimum number of lower case letters.

◆ getMinNonAlpha()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMinNonAlpha ( )

Get minimum number of special characters (non alphanumeric)

Returns
the minimum number of special characters.

◆ getMinNumeric()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMinNumeric ( )

Get minimum number of numeric characters.

Returns
the minimum number of digits.

◆ getMinUpperCase()

int com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.getMinUpperCase ( )

Get minimum number of upper case letters.

Returns
the minimum number of upper case letters.

◆ isCacheEnabled()

boolean com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.isCacheEnabled ( )

Gets password cache flag.

Returns
whether password cache is enabled.

◆ isSequenceAllowed()

boolean com.hidglobal.ia.service.protectionpolicy.PasswordPolicy.isSequenceAllowed ( )

Returns is Sequence Allowed

Returns
Sequence Allowed

◆ verifyPassword()

When password caching is enabled, will verify and cache the password protecting the key for transaction signing. The cache is deleted when cache timeout is reached or cached password is used.

Parameters
passwordthe key password.
Exceptions
InternalExceptionif an unexpected error occurred.
UnsupportedDeviceExceptionif device is not supported by policy.
LostCredentialsExceptionif provisioning key data has been corrupted or lost.
AuthenticationExceptionif password is incorrect.
PasswordExpiredExceptionif expired password is given (changePassword required).
FingerprintAuthenticationRequiredExceptionif fingerprint authentication is required by policy.
FingerprintNotEnrolledExceptionif fingerprint enrollment is required.
PasswordRequiredExceptionif required password was not provided and cached password is not available.
InvalidParameterExceptionif the given parameters are invalid or required parameters are missing.
See also
PasswordPolicy::getCacheTimeout()
PasswordPolcy::isCacheEnabled()