HID APPROVE SDK  4.8
HID Approve SDK for Windows .NET
HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy Interface Reference

The data/key is protected by password. More...

Inheritance diagram for HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy:
HIDIA.Transaction.ProtectionPolicy.IProtectionPolicy

Public Member Functions

Task< bool > ChangePassword (char[] oldpwdvalue, char[] newpwdvalue)
 Changes the password bound to the protection policy identified by the protection policyId parameter. More...
 
Task VerifyPassword (char[] password)
 Verifies whether password protecting the key is correct (RSA keys ONLY). More...
 

Properties

int CacheTimeout [get]
 The timeout of password cache in seconds. More...
 
long CurrentAge [get]
 Current age of the password. More...
 
bool IsCacheEnabled [get]
 Whether password cache is enabled. More...
 
int MaxAge [get]
 Maximum age in days of the password. More...
 
int MaxAlpha [get]
 Maximum number of alphanumeric characters in password. More...
 
int MaxHistory [get]
 Maximum number of passwords remembered. More...
 
int MaxLength [get]
 Maximum password length. More...
 
int MaxLowerCase [get]
 Maximum number of lower case letters in password. More...
 
int MaxNonAlpha [get]
 Maximum number of non-alphanumeric characters in password. More...
 
int MaxNumeric [get]
 Maximum number of numeric characters in password. More...
 
int MaxUpperCase [get]
 Maximum number of upper case letters in password. More...
 
int MinAge [get]
 Minimum age in days of the password before it can be changed. More...
 
int MinAlpha [get]
 Minimum number of alphanumeric characters in password. More...
 
int MinLength [get]
 Minimum password length. More...
 
int MinLowerCase [get]
 Minimum number of lower case letters in password. More...
 
int MinNonAlpha [get]
 Minimum number of non-alphanumeric characters in password. More...
 
int MinNumeric [get]
 Minimum number of numeric characters in password. More...
 
int MinUpperCase [get]
 Minimum number of upper case letters in password. More...
 
- Properties inherited from HIDIA.Transaction.ProtectionPolicy.IProtectionPolicy
ProtectionPolicyId Id [get]
 The identifier of that policy. More...
 
LockPolicy LockPolicy [get]
 The lock policy associated to that protection policy. More...
 
ProtectionPolicyType Type [get]
 The type of policy. More...
 

Detailed Description

The data/key is protected by password.

Member Function Documentation

◆ ChangePassword()

Task<bool> HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.ChangePassword ( char []  oldpwdvalue,
char []  newpwdvalue 
)

Changes the password bound to the protection policy identified by the protection policyId parameter.

New password must respect the defined protection policy restrictions.

Parameters
oldpwdvalueThe old password.
newpwdvalueThe new password.
Returns
true if password was successfully changed.
Exceptions
AuthenticationException
PasswordNotYetUpdatableException
InvalidPasswordException
LostCredentialsException
InternalException
UnsupportedDeviceException
PasswordRequiredException

◆ VerifyPassword()

Task HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.VerifyPassword ( char []  password)

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

Parameters
passwordThe key password.
Returns
Exceptions
InternalException
UnsupportedDeviceException
LostCredentialsException
PasswordExpiredException
AuthenticationException

Property Documentation

◆ CacheTimeout

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.CacheTimeout
get

The timeout of password cache in seconds.

◆ CurrentAge

long HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.CurrentAge
get

Current age of the password.

◆ IsCacheEnabled

bool HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.IsCacheEnabled
get

Whether password cache is enabled.

◆ MaxAge

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MaxAge
get

Maximum age in days of the password.

◆ MaxAlpha

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MaxAlpha
get

Maximum number of alphanumeric characters in password.

◆ MaxHistory

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MaxHistory
get

Maximum number of passwords remembered.

◆ MaxLength

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MaxLength
get

Maximum password length.

◆ MaxLowerCase

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MaxLowerCase
get

Maximum number of lower case letters in password.

◆ MaxNonAlpha

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MaxNonAlpha
get

Maximum number of non-alphanumeric characters in password.

◆ MaxNumeric

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MaxNumeric
get

Maximum number of numeric characters in password.

◆ MaxUpperCase

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MaxUpperCase
get

Maximum number of upper case letters in password.

◆ MinAge

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MinAge
get

Minimum age in days of the password before it can be changed.

◆ MinAlpha

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MinAlpha
get

Minimum number of alphanumeric characters in password.

◆ MinLength

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MinLength
get

Minimum password length.

◆ MinLowerCase

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MinLowerCase
get

Minimum number of lower case letters in password.

◆ MinNonAlpha

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MinNonAlpha
get

Minimum number of non-alphanumeric characters in password.

◆ MinNumeric

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MinNumeric
get

Minimum number of numeric characters in password.

◆ MinUpperCase

int HIDIA.Transaction.ProtectionPolicy.IPasswordPolicy.MinUpperCase
get

Minimum number of upper case letters in password.