HID APPROVE SDK  5.12
HID Approve SDK for iOS/macOS
 All Classes Files Functions Variables Enumerations Enumerator Properties Pages
HIDConstants.h File Reference

Common Transaction Signing SDK Constants. More...

#import <Foundation/Foundation.h>

Go to the source code of this file.

Variables

NSString *const HID_CONTAINER_ID
 Container unique id.
 
NSString *const HID_CONTAINER_NAME
 Container friendly name.
 
NSString *const HID_CONTAINER_URL
 URL of server managing this container.
 
NSString *const HID_CONTAINER_USERID
 User id.
 
NSString *const HID_DEVICE_INFO_BRAND
 Device Info: Device brand name.
 
NSString *const HID_DEVICE_INFO_ISROOTED
 Device Info: Device is rooted.
 
NSString *const HID_DEVICE_INFO_KEYSTORE
 Device Info: Keystore type. ("soft" or "hw")
 
NSString *const HID_DEVICE_INFO_LOCALE
 Device Info: Device locale charset.
 
NSString *const HID_DEVICE_INFO_MANUFACTURER
 Device Info: Device manufacturer name.
 
NSString *const HID_DEVICE_INFO_MODEL
 Device Info: Device model name.
 
NSString *const HID_DEVICE_INFO_NAME
 Device Info: User-assigned device name for iOS15 and earlier. Generic device name for iOS16 and later. *. More...
 
NSString *const HID_DEVICE_INFO_OS
 Device Info: Operating System Name.
 
NSString *const HID_DEVICE_INFO_OS_NAME
 Device Info: Operating System platform name.
 
NSString *const HID_DEVICE_INFO_OS_VERSION
 Device Info: Operating System platform version.
 
NSString *const HID_DEVICE_INFO_PRODUCT
 Device Info: Device product name.
 
NSString *const HID_DEVICE_INFO_PUSHID
 Device Info: Base64 representation of Apple Push Notification (APN) device token identifier.
 
NSString *const HID_ERROR_AUTH_REMAINING_TRIES
 Custom error in NSError userInfo: number of remaining tries in case of authentication failure.
 
NSString *const HID_ERROR_MESSAGE
 Custom error in NSError userInfo: internal message.
 
NSString *const HID_ERROR_PARAMETERS
 Custom error in NSError userInfo: list of user identifiers suitable for this transaction.
 
NSString *const HID_KEY_PROPERTY_CREATE
 Key Creation Date as long.
 
NSString *const HID_KEY_PROPERTY_EXPIRY
 Key Expiration Date as long.
 
NSString *const HID_KEY_PROPERTY_LABEL
 Key Label.
 
NSString *const HID_KEY_PROPERTY_USAGE
 Key Usage.
 
NSString *const HID_KEY_PROPERTY_USAGE_AUTH
 Key Usage Value of authentication.
 
NSString *const HID_KEY_PROPERTY_USAGE_ENCRYPT
 Key Usage Value of encryption keys.
 
NSString *const HID_KEY_PROPERTY_USAGE_OPPRO
 Key Usage Value of oppro.
 
NSString *const HID_KEY_PROPERTY_USAGE_OTP
 Key Usage Value of OTP keys.
 
NSString *const HID_KEY_PROPERTY_USAGE_SIGN
 Key Usage Value of signing private keys.
 
NSString *const HID_KEY_PROPERTY_USAGE_TXPROTECT
 Key Usage Value of transaction protection session keys.
 
NSString *const HID_OCRASUITE_CHALLENGE_FORMAT_ALPHANUM
 OCRA challenge format is alphanumeric.
 
NSString *const HID_OCRASUITE_CHALLENGE_FORMAT_HEX
 OCRA challenge format is hex.
 
NSString *const HID_OCRASUITE_CHALLENGE_FORMAT_NUMERIC
 OCRA challenge format is numeric.
 
NSString *const HID_OTP_AUTHMODE_CHALLENGE_RESPONSE
 OTP key can be used in One-Way Challenge-Response mode.
 
NSString *const HID_OTP_AUTHMODE_MUTUAL_CHALLENGE_RESPONSE
 OTP key can be used in Challenge-Response mode with server authentication.
 
NSString *const HID_OTP_AUTHMODE_SIGNATURE
 OTP key can be used in signature mode.
 
NSString *const HID_OTP_AUTHMODE_SIGNATURE_SERVER_AUTH
 OTP key can be used in signature mode with server authentication.
 
NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_KEY_LABEL
 password event key label
 
NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_KEY_USAGE
 password event key usage
 
NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE
 password event type
 
NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE_CONTAINER
 password event type container
 
NSString *const HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE_KEY
 password event type key
 
NSString *const HID_PARAM_PROGRESSEVENT_LEVEL
 Sync Event Level.
 
NSString *const HID_PARAM_PROGRESSEVENT_MESSAGE
 Sync Event Message.
 
NSString *const HID_PARAM_PROGRESSEVENT_PERCENT
 Sync Event Percent.
 
NSString *const HID_PARAM_SYNC_DEVICE_NAME
 SyncManager Parameter: Server device friendly name (optional)
 
NSString *const HID_PARAM_SYNC_DEVICE_TYPECODE
 SyncManager Parameter: Server Device Type Code.
 
NSString *const HID_PARAM_SYNC_DEVICEID
 SyncManager Parameter: Server device identifier.
 
NSString *const HID_PARAM_SYNC_PROTOCOL_VERSION
 SyncManager Config: Requested protocol version.
 
NSString *const HID_PARAM_SYNC_PROV_AUTHPOLICYID
 SyncManager Parameter: End-user Provisioning Authentication Policy configured on server.
 
NSString *const HID_PARAM_SYNC_PSS
 SyncManager Parameter: Pre-Shared Secret.
 
NSString *const HID_PARAM_SYNC_PUSHID
 SyncManager Parameter: APN device token identifier.
 
NSString *const HID_PARAM_SYNC_PWD_ENCRYPT
 SyncManager Parameter: Encryption key password.
 
NSString *const HID_PARAM_SYNC_PWD_SIGN
 SyncManager Parameter: Signature key password.
 
NSString *const HID_PARAM_SYNC_PWD_TXPROTECT
 SyncManager Parameter: Transaction Protection Session key password.
 
NSString *const HID_PARAM_SYNC_SECRET
 SyncManager Parameter: Authentication secret (otp/password/challenge/etc)
 
NSString *const HID_PARAM_SYNC_SERVER_CHANNEL
 SyncManager Config: SyncManager server channel.
 
NSString *const HID_PARAM_SYNC_SERVER_CONTEXT
 SyncManager Config: Server context (optional)
 
NSString *const HID_PARAM_SYNC_SERVER_DOMAIN
 SyncManager Config: Server domain.
 
NSString *const HID_PARAM_SYNC_SERVER_RETRY
 SyncManager Config: Connection retry.
 
NSString *const HID_PARAM_SYNC_SERVER_TIMEOUT
 SyncManager Config: Connection timeout.
 
NSString *const HID_PARAM_SYNC_SERVER_URL
 SyncManager Config: provisioning URL.
 
NSString *const HID_PARAM_SYNC_TDS_AUTHPOLICYID
 SyncManager Parameter: End-user Transaction Signing Authentication Policy configured on server.
 
NSString *const HID_PARAM_SYNC_USERID
 SyncManager Parameter: Server user identifier.
 
NSString *const HID_PARAM_TX_MOBILE_CONTEXT
 Transaction Parameter: mobile context data.
 
NSString *const HID_PLATFORM_CLASS_SOFTTOKEN
 The class name of the soft token.
 
NSString *const HID_PROPERTY_APPCUSTOMIZATION
 Property: Application customization.
 
NSString *const HID_PROPERTY_CHANNEL
 Property: Server provisioning channel.
 
NSString *const HID_PROPERTY_CREATION_DATE
 Property: container creation date.
 
NSString *const HID_PROPERTY_DOMAIN
 Property: Server domain.
 
NSString *const HID_PROPERTY_EXPIRY_DATE
 Property: container expiry date.
 
NSString *const HID_PROPERTY_EXTERNALID
 Property: Device ID.
 
NSString *const HID_PROPERTY_ORIGINAL_CREATION_DATE
 Property: container original creation date.
 
NSString *const HID_PROPERTY_PROTOCOL_VERSION
 Property: current protocol version.
 
NSString *const HID_PROPERTY_RENEWAL_DATE
 Property: container renewal date.
 
NSString *const HID_PROPERTY_SERIALNUMBER
 Property: Device Serial number.
 
NSString *const HID_PROPERTY_TXURI
 Property: Transaction gateway URL.
 

Detailed Description

Common Transaction Signing SDK Constants.

Variable Documentation

NSString* const HID_DEVICE_INFO_NAME

Device Info: User-assigned device name for iOS15 and earlier. Generic device name for iOS16 and later. *.

See also
https://developer.apple.com/documentation/uikit/uidevice/1620015-name