Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision Next revision Both sides next revision | ||
|
en:sdk_api [2016/02/04 17:23] 127.0.0.1 external edit |
en:sdk_api [2018/03/20 15:17] yjjung |
||
|---|---|---|---|
| Line 12: | Line 12: | ||
| * [[BS2_ComputeCRC16CCITT]]: Calculates the CRC-16 CCITT checksum. | * [[BS2_ComputeCRC16CCITT]]: Calculates the CRC-16 CCITT checksum. | ||
| * [[BS2_GetCardModel]]: Retrieves the supported card models. | * [[BS2_GetCardModel]]: Retrieves the supported card models. | ||
| + | * [[BS2_GetCredentialKeyInfo]]: Gets the credential key for the device. | ||
| + | * [[BS2_SetCredentialKeyInfo]]: Sets the encryption key for the device. | ||
| + | * [[BS2_RemoveCredentialKeyInfo]]: Removes the encryption key for the device. | ||
| + | |||
| + | |||
| + | ===== Structure ===== | ||
| + | ==== BS2CredentialKeyInfo ==== | ||
| + | <code cpp> | ||
| + | /** | ||
| + | * BS2_CRED_KEY_REQ | ||
| + | */ | ||
| + | enum | ||
| + | { | ||
| + | BS2_CRED_KEY_REQ_COMM = false, | ||
| + | BS2_CRED_KEY_REQ_DATA = true, | ||
| + | }; | ||
| + | |||
| + | enum | ||
| + | { | ||
| + | BS2_CRED_KEY_SIZE = 32, | ||
| + | }; | ||
| + | |||
| + | /** | ||
| + | * BS2CredentialKeyInfo | ||
| + | */ | ||
| + | typedef struct | ||
| + | { | ||
| + | uint32_t maxPacketSize; ///< 4 bytes | ||
| + | uint8_t key[BS2_CRED_KEY_SIZE]; ///< 32 bytes | ||
| + | bool dualIDSupported; ///< 1 byte | ||
| + | bool useAlphanumericID; ///< 1 byte | ||
| + | bool credentialKeySupported; ///< 1 byte | ||
| + | bool credentialKeyRequest; ///< 1 byte | ||
| + | uint8_t reserved[28]; ///< 28 bytes (reserved) | ||
| + | } BS2CredentialKeyInfo; | ||
| + | </code> | ||
| + | |||
| + | 1. //maxPacketSize// \\ | ||
| + | The maximum TCP packet size allowed by the device. \\ | ||
| + | |||
| + | 2. //key// \\ | ||
| + | The key value used by the device. \\ | ||
| + | Depending on the credentialKeyRequest setting, you can get a communication encryption key, or a data encryption key.\\ | ||
| + | |||
| + | 3. //dualIDSupported// \\ | ||
| + | Indicates whether the device's userID format (number, character) is allowed to change. \\ | ||
| + | |||
| + | 4. //useAlphanumericID// \\ | ||
| + | A flag indicating whether the device uses an alphanumeric userID. \\ | ||
| + | |||
| + | 5. //credentialKeySupported// \\ | ||
| + | Indicates whether data key changes are allowed. \\ | ||
| + | Device supports data credential key changes when the release date of FW for each device is later than 30 Mar 2018, \\ | ||
| + | So it indicates whether the currently connected device supports the modification of these keys. \\ | ||
| + | |||
| + | 6. //credentialKeyRequest// \\ | ||
| + | You can use this setting to request a key for the device. \\ | ||
| + | This setting is applicable only when the release date of FW for each device is later than 30 Mar 2018.\\ | ||
| + | In the case of the previous FW, only the communication key is returned regardless of whether this is set or not. | ||
| + | <WRAP group 50%> | ||
| + | ^Value ^Description ^ | ||
| + | |BS2_CRED_KEY_REQ_COMM |Communication credential key request | | ||
| + | |BS2_CRED_KEY_REQ_DATA |Data credential key reuqest | | ||
| + | </WRAP> | ||
| + | |||
| + | 7. //reserved// \\ | ||
| + | Reserved space. \\ | ||