HID APPROVE SDK  5.13
HID Approve SDK for iOS/macOS
 All Classes Files Functions Variables Enumerations Enumerator Properties Pages
HIDKey.h
Go to the documentation of this file.
1 /* ---------------------------------------------------------------------------
2  (c) 2015-2024, HID Global Corporation, part of ASSA ABLOY.
3  All rights reserved.
4 
5  Redistribution and use in source and binary forms, with or without modification,
6  are permitted provided that the following conditions are met:
7  - Redistributions of source code must retain the above copyright notice,
8  this list of conditions and the following disclaimer.
9  - Redistributions in binary form must reproduce the above copyright notice,
10  this list of conditions and the following disclaimer in the documentation
11  and/or other materials provided with the distribution.
12 
13  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
14  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
17  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
20  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 --------------------------------------------------------------------------- */
24 
25 #import <Foundation/Foundation.h>
26 #import "HIDIdentifier.h"
27 #import "HIDProtectionPolicy.h"
28 #import "HIDOTPGenerator.h"
29 
39 @protocol HIDKey
56 - (id<HIDProtectionPolicy>)getProtectionPolicy:(NSError**)error;
78 - (NSString*)getProperty:(NSString*)propertyId error:(NSError**)error;
84 - (id<HIDOTPGenerator>)getDefaultOTPGenerator:(NSError**)error;
85 
91 - (BOOL)isExtractable:(NSError**)error;
97 - (NSString*)getAlgorithm:(NSError**)error;
103 - (NSString*)getFormat:(NSError**)error;
116 - (NSData*)getEncoded:(NSError**)error;
130 - (NSData*)getEncoded:(NSString*)password error:(NSError**)error;
131 @end
The protection policy defines the security parameters associated with a key or data item...
Definition: HIDProtectionPolicy.h:131
HIDIdentifier * getId()
Gets the keyId associated with key.
A base protocol for OTP generators.
Definition: HIDOTPGenerator.h:53
OTP Generator Base.
Security policy for the protection of sensitive data.
object identifier.
Definition: HIDIdentifier.h:36
Object reference.
Key instance.
Definition: HIDKey.h:39