HID APPROVE SDK 6.1
HID Approve SDK for iOS/macOS
Loading...
Searching...
No Matches
HIDConstants.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
32extern NSString *const HID_DEVICE_INFO_BRAND;
33extern NSString *const HID_DEVICE_INFO_KEYSTORE;
34extern NSString *const HID_DEVICE_INFO_MANUFACTURER;
35extern NSString *const HID_DEVICE_INFO_MODEL;
36extern NSString *const HID_DEVICE_INFO_NAME;
37extern NSString *const HID_DEVICE_INFO_OS;
38extern NSString *const HID_DEVICE_INFO_OS_NAME;
39extern NSString *const HID_DEVICE_INFO_OS_VERSION;
40extern NSString *const HID_DEVICE_INFO_PUSHID;
41extern NSString *const HID_DEVICE_INFO_PRODUCT;
42extern NSString *const HID_DEVICE_INFO_LOCALE;
43extern NSString *const HID_DEVICE_INFO_ISROOTED;
44
45extern NSString *const HID_KEY_PROPERTY_CREATE;
46extern NSString *const HID_KEY_PROPERTY_EXPIRY;
47extern NSString *const HID_KEY_PROPERTY_LABEL;
48extern NSString *const HID_KEY_PROPERTY_USAGE;
49
50extern NSString *const HID_KEY_PROPERTY_USAGE_ENCRYPT;
51extern NSString *const HID_KEY_PROPERTY_USAGE_SIGN;
52extern NSString *const HID_KEY_PROPERTY_USAGE_TXPROTECT;
53extern NSString *const HID_KEY_PROPERTY_USAGE_OTP;
54extern NSString *const HID_KEY_PROPERTY_USAGE_AUTH;
55extern NSString *const HID_KEY_PROPERTY_USAGE_OPPRO;
56
57extern NSString *const HID_CONTAINER_NAME;
58extern NSString *const HID_CONTAINER_URL;
59extern NSString *const HID_CONTAINER_ID;
60extern NSString *const HID_CONTAINER_USERID;
61
62extern NSString *const HID_PARAM_TX_MOBILE_CONTEXT;
63
64extern NSString *const HID_PARAM_PROGRESSEVENT_LEVEL;
65extern NSString *const HID_PARAM_PROGRESSEVENT_MESSAGE;
66extern NSString *const HID_PARAM_PROGRESSEVENT_PERCENT;
67
68//new for 5.5
69extern NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE;
70extern NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_KEY_LABEL;
71extern NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_KEY_USAGE;
72extern NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE_CONTAINER;
73extern NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE_KEY;
74//
75
76extern NSString *const HID_PLATFORM_CLASS_SOFTTOKEN;
77
78extern NSString *const HID_PARAM_SYNC_PROV_AUTHPOLICYID;
79extern NSString *const HID_PARAM_SYNC_TDS_AUTHPOLICYID;
80extern NSString *const HID_PARAM_SYNC_DEVICE_NAME;
81extern NSString *const HID_PARAM_SYNC_DEVICE_TYPECODE;
82extern NSString *const HID_PARAM_SYNC_DEVICEID;
83extern NSString *const HID_PARAM_SYNC_PSS;
84extern NSString *const HID_PARAM_SYNC_PUSHID;
85extern NSString *const HID_PARAM_SYNC_PWD_ENCRYPT;
86extern NSString *const HID_PARAM_SYNC_PWD_SIGN;
87extern NSString *const HID_PARAM_SYNC_PWD_TXPROTECT;
88extern NSString *const HID_PARAM_SYNC_SECRET;
89extern NSString *const HID_PARAM_SYNC_PROTOCOL_VERSION;
90extern NSString *const HID_PARAM_SYNC_SERVER_CHANNEL;
91extern NSString *const HID_PARAM_SYNC_SERVER_CONTEXT;
92extern NSString *const HID_PARAM_SYNC_SERVER_DOMAIN;
93extern NSString *const HID_PARAM_SYNC_SERVER_RETRY;
94extern NSString *const HID_PARAM_SYNC_SERVER_TIMEOUT;
95extern NSString *const HID_PARAM_SYNC_SERVER_URL;
96extern NSString *const HID_PARAM_SYNC_USERID;
97
98extern NSString *const HID_PROPERTY_APPCUSTOMIZATION;
99extern NSString *const HID_PROPERTY_CHANNEL;
100extern NSString *const HID_PROPERTY_DOMAIN;
101extern NSString *const HID_PROPERTY_SERIALNUMBER;
102extern NSString *const HID_PROPERTY_EXTERNALID;
103
104extern NSString *const HID_ERROR_MESSAGE;
105extern NSString *const HID_ERROR_AUTH_REMAINING_TRIES;
106extern NSString *const HID_ERROR_PARAMETERS;
107
108extern NSString *const HID_OTP_AUTHMODE_CHALLENGE_RESPONSE;
109extern NSString *const HID_OTP_AUTHMODE_MUTUAL_CHALLENGE_RESPONSE;
110extern NSString *const HID_OTP_AUTHMODE_SIGNATURE;
111extern NSString *const HID_OTP_AUTHMODE_SIGNATURE_SERVER_AUTH;
112
113extern NSString *const HID_OCRASUITE_CHALLENGE_FORMAT_ALPHANUM;
114extern NSString *const HID_OCRASUITE_CHALLENGE_FORMAT_NUMERIC;
115extern NSString *const HID_OCRASUITE_CHALLENGE_FORMAT_HEX;
116
117extern NSString *const HID_PROPERTY_PROTOCOL_VERSION;
118extern NSString *const HID_PROPERTY_ORIGINAL_CREATION_DATE;
119extern NSString *const HID_PROPERTY_CREATION_DATE;
120extern NSString *const HID_PROPERTY_RENEWAL_DATE;
121extern NSString *const HID_PROPERTY_EXPIRY_DATE;
122extern NSString* const HID_PROPERTY_SHARE_DATE;
123
HID_OCRASUITE_CHALLENGE_FORMAT_HEX
NSString *const HID_OCRASUITE_CHALLENGE_FORMAT_HEX
OCRA challenge format is hex.
HID_KEY_PROPERTY_USAGE_OPPRO
NSString *const HID_KEY_PROPERTY_USAGE_OPPRO
Key Usage Value of oppro.
HID_PROPERTY_EXPIRY_DATE
NSString *const HID_PROPERTY_EXPIRY_DATE
Property: container expiry date.
HID_KEY_PROPERTY_LABEL
NSString *const HID_KEY_PROPERTY_LABEL
Key Label.
HID_PARAM_PASSWORD_PROGRESS_EVENT_KEY_LABEL
NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_KEY_LABEL
password event key label
HID_DEVICE_INFO_ISROOTED
NSString *const HID_DEVICE_INFO_ISROOTED
Device Info: Device is rooted.
HID_PARAM_SYNC_PUSHID
NSString *const HID_PARAM_SYNC_PUSHID
SyncManager Parameter: APN device token identifier.
HID_PARAM_SYNC_PWD_SIGN
NSString *const HID_PARAM_SYNC_PWD_SIGN
SyncManager Parameter: Signature key password.
HID_KEY_PROPERTY_USAGE_AUTH
NSString *const HID_KEY_PROPERTY_USAGE_AUTH
Key Usage Value of authentication.
HID_PARAM_SYNC_PROV_AUTHPOLICYID
NSString *const HID_PARAM_SYNC_PROV_AUTHPOLICYID
SyncManager Parameter: End-user Provisioning Authentication Policy configured on server.
HID_DEVICE_INFO_MODEL
NSString *const HID_DEVICE_INFO_MODEL
Device Info: Device model name.
HID_DEVICE_INFO_NAME
NSString *const HID_DEVICE_INFO_NAME
Device Info: User-assigned device name for iOS15 and earlier. Generic device name for iOS16 and later...
HID_ERROR_AUTH_REMAINING_TRIES
NSString *const HID_ERROR_AUTH_REMAINING_TRIES
Custom error in NSError userInfo: number of remaining tries in case of authentication failure.
HID_KEY_PROPERTY_USAGE_TXPROTECT
NSString *const HID_KEY_PROPERTY_USAGE_TXPROTECT
Key Usage Value of transaction protection session keys.
HID_PARAM_SYNC_PSS
NSString *const HID_PARAM_SYNC_PSS
SyncManager Parameter: Pre-Shared Secret.
HID_PARAM_PASSWORD_PROGRESS_EVENT_KEY_USAGE
NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_KEY_USAGE
password event key usage
HID_PROPERTY_RENEWAL_DATE
NSString *const HID_PROPERTY_RENEWAL_DATE
Property: container renewal date.
HID_CONTAINER_NAME
NSString *const HID_CONTAINER_NAME
Container friendly name.
HID_PROPERTY_SHARE_DATE
NSString *const HID_PROPERTY_SHARE_DATE
Property: container share date.
HID_PROPERTY_EXTERNALID
NSString *const HID_PROPERTY_EXTERNALID
Property: Device ID.
HID_OTP_AUTHMODE_SIGNATURE
NSString *const HID_OTP_AUTHMODE_SIGNATURE
OTP key can be used in signature mode.
HID_PARAM_SYNC_USERID
NSString *const HID_PARAM_SYNC_USERID
SyncManager Parameter: Server user identifier.
HID_OTP_AUTHMODE_MUTUAL_CHALLENGE_RESPONSE
NSString *const HID_OTP_AUTHMODE_MUTUAL_CHALLENGE_RESPONSE
OTP key can be used in Challenge-Response mode with server authentication.
HID_CONTAINER_USERID
NSString *const HID_CONTAINER_USERID
User id.
HID_PARAM_SYNC_TDS_AUTHPOLICYID
NSString *const HID_PARAM_SYNC_TDS_AUTHPOLICYID
SyncManager Parameter: End-user Transaction Signing Authentication Policy configured on server.
HID_PROPERTY_PROTOCOL_VERSION
NSString *const HID_PROPERTY_PROTOCOL_VERSION
Property: current protocol version.
HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE
NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE
password event type
HID_PARAM_SYNC_SERVER_TIMEOUT
NSString *const HID_PARAM_SYNC_SERVER_TIMEOUT
SyncManager Config: Connection timeout.
HID_OTP_AUTHMODE_CHALLENGE_RESPONSE
NSString *const HID_OTP_AUTHMODE_CHALLENGE_RESPONSE
OTP key can be used in One-Way Challenge-Response mode.
HID_PROPERTY_SERIALNUMBER
NSString *const HID_PROPERTY_SERIALNUMBER
Property: Device Serial number.
HID_CONTAINER_ID
NSString *const HID_CONTAINER_ID
Container unique id.
HID_PARAM_PROGRESSEVENT_PERCENT
NSString *const HID_PARAM_PROGRESSEVENT_PERCENT
Sync Event Percent.
HID_CONTAINER_URL
NSString *const HID_CONTAINER_URL
URL of server managing this container.
HID_PROPERTY_APPCUSTOMIZATION
NSString *const HID_PROPERTY_APPCUSTOMIZATION
Property: Application customization.
HID_KEY_PROPERTY_USAGE
NSString *const HID_KEY_PROPERTY_USAGE
Key Usage.
HID_OCRASUITE_CHALLENGE_FORMAT_ALPHANUM
NSString *const HID_OCRASUITE_CHALLENGE_FORMAT_ALPHANUM
OCRA challenge format is alphanumeric.
HID_KEY_PROPERTY_EXPIRY
NSString *const HID_KEY_PROPERTY_EXPIRY
Key Expiration Date as long.
HID_KEY_PROPERTY_USAGE_SIGN
NSString *const HID_KEY_PROPERTY_USAGE_SIGN
Key Usage Value of signing private keys.
HID_PARAM_SYNC_SERVER_CHANNEL
NSString *const HID_PARAM_SYNC_SERVER_CHANNEL
SyncManager Config: SyncManager server channel.
HID_KEY_PROPERTY_USAGE_ENCRYPT
NSString *const HID_KEY_PROPERTY_USAGE_ENCRYPT
Key Usage Value of encryption keys.
HID_PARAM_SYNC_PROTOCOL_VERSION
NSString *const HID_PARAM_SYNC_PROTOCOL_VERSION
SyncManager Config: Requested protocol version.
HID_PARAM_SYNC_SERVER_URL
NSString *const HID_PARAM_SYNC_SERVER_URL
SyncManager Config: provisioning URL.
HID_PROPERTY_CREATION_DATE
NSString *const HID_PROPERTY_CREATION_DATE
Property: container creation date.
HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE_KEY
NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE_KEY
password event type key
HID_DEVICE_INFO_BRAND
NSString *const HID_DEVICE_INFO_BRAND
Device Info: Device brand name.
HID_PARAM_SYNC_PWD_TXPROTECT
NSString *const HID_PARAM_SYNC_PWD_TXPROTECT
SyncManager Parameter: Transaction Protection Session key password.
HID_DEVICE_INFO_LOCALE
NSString *const HID_DEVICE_INFO_LOCALE
Device Info: Device locale charset.
HID_PARAM_SYNC_SERVER_DOMAIN
NSString *const HID_PARAM_SYNC_SERVER_DOMAIN
SyncManager Config: Server domain.
HID_DEVICE_INFO_OS_VERSION
NSString *const HID_DEVICE_INFO_OS_VERSION
Device Info: Operating System platform version.
HID_OTP_AUTHMODE_SIGNATURE_SERVER_AUTH
NSString *const HID_OTP_AUTHMODE_SIGNATURE_SERVER_AUTH
OTP key can be used in signature mode with server authentication.
HID_DEVICE_INFO_MANUFACTURER
NSString *const HID_DEVICE_INFO_MANUFACTURER
Device Info: Device manufacturer name.
HID_PLATFORM_CLASS_SOFTTOKEN
NSString *const HID_PLATFORM_CLASS_SOFTTOKEN
The class name of the soft token.
HID_PARAM_SYNC_DEVICEID
NSString *const HID_PARAM_SYNC_DEVICEID
SyncManager Parameter: Server device identifier.
HID_PARAM_SYNC_SERVER_CONTEXT
NSString *const HID_PARAM_SYNC_SERVER_CONTEXT
SyncManager Config: Server context (optional).
HID_PARAM_PROGRESSEVENT_MESSAGE
NSString *const HID_PARAM_PROGRESSEVENT_MESSAGE
Sync Event Message.
HID_PARAM_SYNC_SERVER_RETRY
NSString *const HID_PARAM_SYNC_SERVER_RETRY
SyncManager Config: Connection retry.
HID_PROPERTY_ORIGINAL_CREATION_DATE
NSString *const HID_PROPERTY_ORIGINAL_CREATION_DATE
Property: container original creation date.
HID_ERROR_PARAMETERS
NSString *const HID_ERROR_PARAMETERS
Custom error in NSError userInfo: list of user identifiers suitable for this transaction.
HID_PROPERTY_DOMAIN
NSString *const HID_PROPERTY_DOMAIN
Property: Server domain.
HID_PARAM_SYNC_SECRET
NSString *const HID_PARAM_SYNC_SECRET
SyncManager Parameter: Authentication secret (otp/password/challenge/etc).
HID_PARAM_TX_MOBILE_CONTEXT
NSString *const HID_PARAM_TX_MOBILE_CONTEXT
Transaction Parameter: mobile context data.
HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE_CONTAINER
NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE_CONTAINER
password event type container
HID_ERROR_MESSAGE
NSString *const HID_ERROR_MESSAGE
Custom error in NSError userInfo: internal message.
HID_KEY_PROPERTY_CREATE
NSString *const HID_KEY_PROPERTY_CREATE
Key Creation Date as long.
HID_PROPERTY_CHANNEL
NSString *const HID_PROPERTY_CHANNEL
Property: Server provisioning channel.
HID_PARAM_SYNC_DEVICE_NAME
NSString *const HID_PARAM_SYNC_DEVICE_NAME
SyncManager Parameter: Server device friendly name (optional).
HID_OCRASUITE_CHALLENGE_FORMAT_NUMERIC
NSString *const HID_OCRASUITE_CHALLENGE_FORMAT_NUMERIC
OCRA challenge format is numeric.
HID_DEVICE_INFO_OS
NSString *const HID_DEVICE_INFO_OS
Device Info: Operating System Name.
HID_KEY_PROPERTY_USAGE_OTP
NSString *const HID_KEY_PROPERTY_USAGE_OTP
Key Usage Value of OTP keys.
HID_DEVICE_INFO_KEYSTORE
NSString *const HID_DEVICE_INFO_KEYSTORE
Device Info: Keystore type. ("soft" or "hw").
HID_PARAM_SYNC_DEVICE_TYPECODE
NSString *const HID_PARAM_SYNC_DEVICE_TYPECODE
SyncManager Parameter: Server Device Type Code.
HID_PARAM_SYNC_PWD_ENCRYPT
NSString *const HID_PARAM_SYNC_PWD_ENCRYPT
SyncManager Parameter: Encryption key password.
HID_DEVICE_INFO_PRODUCT
NSString *const HID_DEVICE_INFO_PRODUCT
Device Info: Device product name.
HID_DEVICE_INFO_PUSHID
NSString *const HID_DEVICE_INFO_PUSHID
Device Info: Base64 representation of Apple Push Notification (APN) device token identifier.
HID_DEVICE_INFO_OS_NAME
NSString *const HID_DEVICE_INFO_OS_NAME
Device Info: Operating System platform name.
HID_PARAM_PROGRESSEVENT_LEVEL
NSString *const HID_PARAM_PROGRESSEVENT_LEVEL
Sync Event Level.