HID APPROVE SDK  5.5
HID APPROVE SDK for Android
com.hidglobal.ia.service.protectionpolicy.PasswordPolicy Interface Reference
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
 
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 ()
 
void verifyPassword (char[] password) throws InternalException, UnsupportedDeviceException, LostCredentialsException, AuthenticationException, PasswordExpiredException, FingerprintAuthenticationRequiredException, FingerprintNotEnrolledException, PasswordRequiredException
 
- 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. 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 password is incorrect.
PasswordNotYetUpdatableExceptionif the policy indicates that it is too early to update the password.
InvalidPasswordExceptionif password validation fails.
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.
IllegalArgumentExceptionif the given parameters are invalid or required parameters are missing. (RuntimeException)

◆ getCacheTimeout()

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

Returns timeout of cached memory in seconds

Returns
the cache timeout

◆ getCurrentAge()

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

Current password age since last change.

Returns
the currentAge

◆ getMaxAge()

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

Returns the maximum age for a password. This determines how long users can keep a password before they have to change it. 0 means password never expires.

Returns
the maxAge

◆ getMaxAlpha()

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

Get maximum number of letter characters

Returns
the maxAlpha

◆ getMaxHistory()

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

"Returns the 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 maxHistory

◆ getMaxLength()

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

Get maximum password length

Returns
the maxLength

◆ getMaxLowerCase()

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

Get maximum number of lowercase 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 minNumeric

◆ getMaxUpperCase()

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

Get maximum number of uppercase 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. 0 allow changes immediately.

Returns
the minAge

◆ getMinAlpha()

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

Get minimum number of letter characters

Returns
the minAlpha

◆ getMinLength()

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

Get minimum password length

Returns
the minLength

◆ getMinLowerCase()

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

Get minimum number of lowercase letters

Returns
the minLowerCase

◆ getMinNonAlpha()

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

Get minimum number of special characters (non alphanumeric)

Returns
the minNonAlpha

◆ getMinNumeric()

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

Get minimum number of numeric characters

Returns
the minNumeric

◆ getMinUpperCase()

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

Get minimum number of uppercase letters

Returns
the minUpperCase

◆ isCacheEnabled()

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

Returns true if password cache is enabled

Returns
the true if cache is enabled

◆ verifyPassword()

Verifies whether password protecting the key is correct (RSA keys ONLY).

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.
IllegalArgumentExceptionif the given parameters are invalid or required parameters are missing. (RuntimeException)

The documentation for this interface was generated from the following file: