HID APPROVE SDK  5.7.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 {
41 } HIDLockType;
42 
46 @protocol HIDLockPolicy
47 
53 
54 @end
55 
60 
65 - (int)counter;
66 
67 @end
68 
100 
105 - (int)counter;
106 
111 - (int)delay;
112 
113 @end
114 
118 typedef enum
119 {
123 
124 } HIDPolicyType;
125 
129 @protocol HIDProtectionPolicy <NSObject>
130 
136 
142 
148 
149 @end
150 
190 - (BOOL)changePassword:(NSString*)oldPassword new:(NSString*)newPassword error:(NSError**)error;
191 
207 - (BOOL)verifyPassword:(NSString*)password error:(NSError**)error;
208 
213 - (int)minLength;
214 
219 - (int)maxLength;
220 
225 - (int)minUpperCase;
226 
231 - (int)minLowerCase;
232 
237 - (int)minNumeric;
238 
243 - (int)minNonAlpha;
244 
249 - (int)minAlpha;
250 
255 - (int)maxUpperCase;
256 
261 - (int)maxLowerCase;
262 
267 - (int)maxNumeric;
268 
273 - (int)maxNonAlpha;
274 
279 - (int)maxAlpha;
280 
288 - (int)minAge;
289 
296 - (int)maxAge;
297 
302 - (int)currentAge;
303 
310 - (int)maxHistory;
311 
316 - (BOOL)isCacheEnabled;
317 
322 - (int)getCacheTimeout;
323 @end
324 
328 typedef enum
329 {
335 
340 
347 - (BOOL)enableBioAuthentication:(NSString*)sPassword error:(NSError**)error;
348 
354 
355 @end
356 
361 
362 @end
363 
The credential never locks.
Definition: HIDProtectionPolicy.h:37
The device has no biometric sensor, authentication with biometrics is not possible.
Definition: HIDProtectionPolicy.h:332
Lock Policy with specific access constraints.
Definition: HIDProtectionPolicy.h:46
int maxAge()
Get maximum age for a password. This determines how long (in days) users can keep a password before t...
int maxAlpha()
Get maximum number of alphabetical characters.
Authentication with biometrics is enabled, the SDK will accept password as nil in authentication meth...
Definition: HIDProtectionPolicy.h:330
int minLowerCase()
Get minimum number of lower case letters.
int maxNonAlpha()
Get maximum number of special characters (non alphanumeric).
The protection policy defines the security parameters associated with a key or data item...
Definition: HIDProtectionPolicy.h:129
The user did not enrolled biometric features at the device level, authentication with biometrics cann...
Definition: HIDProtectionPolicy.h:333
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()
Get maximum number of upper case letters.
id< HIDLockPolicy > lockPolicy()
Returns the lock policy.
int maxLength()
Get maximum password length.
The access to the credential will be limited by applying an exponential delay for each failed attempt...
Definition: HIDProtectionPolicy.h:99
Protection Policy with password specific constraints.
Definition: HIDProtectionPolicy.h:172
Protection Policy with device derived key protection.
Definition: HIDProtectionPolicy.h:360
int minNumeric()
Get the minimum number of numeric characters.
HIDLockType lockType()
returns the lock policy type.
HIDBioAuthenticationState
Working state of authentication with biometrics.
Definition: HIDProtectionPolicy.h:328
Protection policy with authentication with biometrics or password.
Definition: HIDProtectionPolicy.h:339
int currentAge()
Get current password age since last change.
The credential access is limited by delegating validation and blocking to server-side controls...
Definition: HIDProtectionPolicy.h:40
int maxNumeric()
Get maximum number of numeric characters.
int maxHistory()
Get max password history limit. This security setting determines the number of unique new passwords t...
int counter()
Returns the maximum counter value after which exponential delay is fixed.
HIDPolicyType
Protection policy types.
Definition: HIDProtectionPolicy.h:118
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:120
int maxLowerCase()
Get maximum number of lower case letters.
Item is protected by device-specific information.
Definition: HIDProtectionPolicy.h:121
int getCacheTimeout()
Gets password cache timeout.
Item is protected by external biometric policy.
Definition: HIDProtectionPolicy.h:122
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:331
int minLength()
Get minimum password length.
Object reference.
int delay()
Returns the initial delay in seconds.
int minNonAlpha()
Get minimum number of special characters (non alphanumeric).
int minUpperCase()
Get minimum number of upper case letters.
BOOL isCacheEnabled()
Gets password cache flag.
The access to the credential will be locked after a configurable number of failed attempts...
Definition: HIDProtectionPolicy.h:59
int minAlpha()
Get minimum number of alphabetical characters.
int minAge()
Get minimum age for a password change. This security setting determines the period of time (in days) ...