Protection Policy with password specific constraints. More...

#import <HIDProtectionPolicy.h>

Inheritance diagram for <HIDPasswordPolicy>:

Instance Methods
(BOOL)	- changePassword:new:error:
	Changes the password bound to the protection policy identified by the protection policyId parameter. New password must respect the defined protection policy restrictions. More...

(int)	- currentAge
	Returns the current password age since last change. More...

(int)	- getCacheTimeout
	Gets password cache timeout. More...

(BOOL)	- isCacheEnabled
	Gets password cache flag. More...

(int)	- maxAge
	Returns the maximum age for a password. This detmines how long users can keep a password before they have to change it. If 0, indicates that the password never expires. More...

(int)	- maxAlpha
	Returns the maximum number of alphabetical characters. More...

(int)	- maxHistory
	Returns the max password history limit. This security setting determines the number of unique new passwords that have to be associated with the the key before an old password can be reused. More...

(int)	- maxLength
	Returns the maximum password length. More...

(int)	- maxLowerCase
	Returns the maximum number of lower case letters. More...

(int)	- maxNonAlpha
	Returns the maximum number of special characters. More...

(int)	- maxNumeric
	Returns the maximum number of numbers. More...

(int)	- maxUpperCase
	Returns the maximum number of upper case letters. More...

(int)	- minAge
	Returns the minimum age for a password change. 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. More...

(int)	- minAlpha
	Returns the minimum number of alphabetical characters. More...

(int)	- minLength
	Returns the minimum password length. More...

(int)	- minLowerCase
	Returns the minimum number of lower case letters. More...

(int)	- minNonAlpha
	Returns the minimum number of special characters. More...

(int)	- minNumeric
	Returns the minimum number of numbers. More...

(int)	- minUpperCase
	Returns the minimum number of upper case letters. More...

(BOOL)	- verifyPassword:error:
	Verifies whether password protecting the key is correct (RSA keys ONLY). More...

Instance Methods inherited from <HIDProtectionPolicy>
(id< HIDLockPolicy >)	- lockPolicy
	Returns the lock policy. More...

(HIDIdentifier *)	- policyId
	Returns the protection policy identifier. More...

(HIDPolicyType)	- policyType
	Returns the protection policy type. More...

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 symbol (non alphanumeric) characters
Max number of uppercase characters
Max number of lowercase characters
Max number of numeric characters
Max number of letter characters
Max number of symbol (non alphanumeric) characters
Min and Max age
Max password history

Method Documentation

- (BOOL) changePassword:	(NSString *)	oldPassword
new:	(NSString *)	newPassword
error:	(NSError **)	error

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

Parameters

oldPassword	old key password.
newPassword	new key password.
error	error details. It may be nil.

Possible error codes are:

HIDAuthentication if old key password is incorrect
HIDInternal if unexpected error occurs
HIDInvalidPassword if new key password is not accepted by protection policy
HIDPasswordNotYetUpdatable if too early for password change according to protection policy
HIDInvalidArgument if invalid parameter is given

Returns: YES if password was successfully changed.

- (int) currentAge

Returns the current password age since last change.

Returns: the current password age.

- (int) getCacheTimeout

Gets password cache timeout.

Returns: timeout

- (BOOL) isCacheEnabled

Gets password cache flag.

Returns: whether password cache is enabled.

- (int) maxAge

Returns the maximum age for a password. This detmines how long users can keep a password before they have to change it. If 0, indicates that the password never expires.

Returns: the maximum password age.

- (int) maxAlpha

Returns the maximum number of alphabetical characters.

Returns: the maximum number of alphabetical characters.

- (int) maxHistory

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

Returns: the maximum password history size.

- (int) maxLength

Returns the maximum password length.

Returns: the maximum password length.

- (int) maxLowerCase

Returns the maximum number of lower case letters.

Returns: the maximum number of lower case letters.

- (int) maxNonAlpha

Returns the maximum number of special characters.

Returns: the maximum number of special characters.

- (int) maxNumeric

Returns the maximum number of numbers.

Returns: the maximum number of numbers.

- (int) maxUpperCase

Returns the maximum number of upper case letters.

Returns: the maximum number of upper case letters.

- (int) minAge

Returns the minimum age for a password change. 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.

- (int) minAlpha

Returns the minimum number of alphabetical characters.

Returns: the minimum number of alphabetical characters.

- (int) minLength

Returns the minimum password length.

Returns: the minimum password length.

- (int) minLowerCase

Returns the minimum number of lower case letters.

Returns: the minimum number of lower case letters.

- (int) minNonAlpha

Returns the minimum number of special characters.

Returns: the minimum number of special characters.

- (int) minNumeric

Returns the minimum number of numbers.

Returns: the minimum number of numbers.

- (int) minUpperCase

Returns the minimum number of upper case letters.

Returns: the minimum number of upper case letters.

- (BOOL) verifyPassword:	(NSString *)	password
error:	(NSError **)	error

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

Parameters

password	the key password.
error	error details. It may be nil.

Possible error codes are:

HIDAuthentication if invalid password is given
HIDInvalidArgument if invalid parameter is given

Returns: The key in its primary encoding format, or nil if an error occurred.

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

HIDProtectionPolicy.h

Instance Methods

Detailed Description

Method Documentation