HID APPROVE SDK  5.1
HID APPROVE SDK for iOS
 All Classes Files Functions Variables Enumerations Enumerator Properties Pages
HIDProtectionPolicy.h
Go to the documentation of this file.
1 /* ---------------------------------------------------------------------------
2 © 2017-2020 HID Global Corporation/ASSA ABLOY AB. All rights reserved.
3 
4  Redistribution and use in source and binary forms, with or without modification,
5  are permitted provided that the following conditions are met:
6  - Redistributions of source code must retain the above copyright notice,
7  this list of conditions and the following disclaimer.
8  - Redistributions in binary form must reproduce the above copyright notice,
9  this list of conditions and the following disclaimer in the documentation
10  and/or other materials provided with the distribution.
11  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
12  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
13  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
14  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
15  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
16  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
17  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
18  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
19  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
20  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
21  --------------------------------------------------------------------------- */
22 
23 #import <Foundation/Foundation.h>
24 #import "HIDIdentifier.h"
25 
35 typedef enum
36 {
40 } HIDLockType;
41 
45 @protocol HIDLockPolicy
46 
52 
53 @end
54 
59 
64 - (int)counter;
65 
66 @end
67 
72 
77 - (int)counter;
78 
83 - (int)delay;
84 
85 @end
86 
90 typedef enum
91 {
95 
97 
101 @protocol HIDProtectionPolicy <NSObject>
102 
108 
114 
120 
121 @end
122 
162 - (BOOL)changePassword:(NSString*)oldPassword new:(NSString*)newPassword error:(NSError**)error;
163 
177 - (BOOL)verifyPassword:(NSString*)password error:(NSError**)error;
178 
183 - (int)minLength;
184 
189 - (int)maxLength;
190 
195 - (int)minUpperCase;
196 
201 - (int)minLowerCase;
202 
207 - (int)minNumeric;
208 
213 - (int)minNonAlpha;
214 
219 - (int)minAlpha;
220 
225 - (int)maxUpperCase;
226 
231 - (int)maxLowerCase;
232 
237 - (int)maxNumeric;
238 
243 - (int)maxNonAlpha;
244 
249 - (int)maxAlpha;
250 
258 - (int)minAge;
259 
266 - (int)maxAge;
267 
272 - (int)currentAge;
273 
280 - (int)maxHistory;
281 
286 - (BOOL)isCacheEnabled;
287 
292 - (int)getCacheTimeout;
293 @end
294 
298 typedef enum
299 {
305 
310 
317 - (BOOL)enableBioAuthentication:(NSString*)sPassword error:(NSError**)error;;
318 
324 
325 @end
326 
331 
332 @end
333 
The credential never locks.
Definition: HIDProtectionPolicy.h:37
The device has no biometric sensor, authentication with biometrics is not possible.
Definition: HIDProtectionPolicy.h:302
Lock Policy with specific access constraints.
Definition: HIDProtectionPolicy.h:45
int maxAge()
Returns the maximum age for a password. This detmines how long users can keep a password before they ...
int maxAlpha()
Returns the maximum number of alphabetical characters.
Authentication with biometrics is enabled, the SDK will accept password as nil in authentication meth...
Definition: HIDProtectionPolicy.h:300
int minLowerCase()
Returns the minimum number of lower case letters.
int maxNonAlpha()
Returns the maximum number of special characters.
The protection policy defines the security parameters associated with a key or data item...
Definition: HIDProtectionPolicy.h:101
The user did not enrolled biometric features at the device level, authentication with biometrics cann...
Definition: HIDProtectionPolicy.h:303
An exponential delay is added for each failed authentication attempt using that credential.
Definition: HIDProtectionPolicy.h:39
HIDLockType
Known types of lock policy.
Definition: HIDProtectionPolicy.h:35
int maxUpperCase()
Returns the maximum number of upper case letters.
id< HIDLockPolicy > lockPolicy()
Returns the lock policy.
int maxLength()
Returns the maximum password length.
An exponential delay is added for each failed authentication attempt using that credential.
Definition: HIDProtectionPolicy.h:71
Protection Policy with password specific constraints.
Definition: HIDProtectionPolicy.h:144
Protection Policy with device derived key protection.
Definition: HIDProtectionPolicy.h:330
int minNumeric()
Returns the minimum number of numbers.
HIDLockType lockType()
returns the lock policy type.
HIDBioAuthenticationState
Working state of authentication with biometrics.
Definition: HIDProtectionPolicy.h:298
Represents a protection policy of type BioPasswordPolicy.
Definition: HIDProtectionPolicy.h:309
int currentAge()
Returns the current password age since last change.
int maxNumeric()
Returns the maximum number of numbers.
int maxHistory()
Returns the max password history limit. This security setting determines the number of unique new pas...
int counter()
Returns the maximum counter value after which exponential delay is fixed.
HIDPolicyType
Protection policy types.
Definition: HIDProtectionPolicy.h:90
int counter()
Returns the max counter value of the credential before it gets locked.
HIDIdentifier * policyId()
Returns the protection policy identifier.
HIDPolicyType policyType()
Returns the protection policy type.
object identifier.
Definition: HIDIdentifier.h:34
HIDBioAuthenticationState getBioAuthenticationState()
Returns the current working state of authentication with biometrics.
Item is protected by a password provided by the user.
Definition: HIDProtectionPolicy.h:92
int maxLowerCase()
Returns the maximum number of lower case letters.
Item is protected by device-specific information.
Definition: HIDProtectionPolicy.h:93
int getCacheTimeout()
Gets password cache timeout.
Item is protected by external biometric policy.
Definition: HIDProtectionPolicy.h:94
The credential locks after a certain number of attempts.
Definition: HIDProtectionPolicy.h:38
Authentication with biometrics is not enabled. To enable, a call to HIDBioPasswordPolicy.enableBioAuthentication is required.
Definition: HIDProtectionPolicy.h:301
int minLength()
Returns the minimum password length.
Object reference.
int delay()
Returns the initial delay in seconds.
int minNonAlpha()
Returns the minimum number of special characters.
int minUpperCase()
Returns the minimum number of upper case letters.
BOOL isCacheEnabled()
Gets password cache flag.
The credential locks after a certain number of attempts.
Definition: HIDProtectionPolicy.h:58
int minAlpha()
Returns the minimum number of alphabetical characters.
int minAge()
Returns the minimum age for a password change. This security setting determines the period of time (i...