Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:sdk_api [2018/04/16 17:03] yjjung [SDK API] |
en:sdk_api [2024/02/27 13:57] (current) |
||
|---|---|---|---|
| Line 8: | Line 8: | ||
| * [[BS2_Initialize]]: Initializes the device management Context. | * [[BS2_Initialize]]: Initializes the device management Context. | ||
| * [[BS2_ReleaseObject]]: Releases dynamic memory. | * [[BS2_ReleaseObject]]: Releases dynamic memory. | ||
| - | * [[BS2_MakePinCode]]: Encrypts the PIN. | + | * [[BS2_MakePinCode]]: Encrypts the PIN. |
| + | * [[BS2_MakePinCodeWithKey]]: Encryptes PIN code with the user-defined PIN encryption key. [+ 2.7.1] | ||
| * [[BS2_SetMaxThreadCount]]: Specifies the maximum thread count. | * [[BS2_SetMaxThreadCount]]: Specifies the maximum thread count. | ||
| * [[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_GetDataEncryptKey]]: Gets the encryption key for the device. | + | * [[BS2_SetDataEncryptKey]]: Changes the user defined PIN encryption key. [+ 2.7.1] |
| - | * [[BS2_SetDataEncryptKey]]: Sets the encryption key for the device. | + | |
| * [[BS2_RemoveDataEncryptKey]]: Removes the encryption key for the device. | * [[BS2_RemoveDataEncryptKey]]: Removes the encryption key for the device. | ||
| + | * [[BS2_SetDeviceSearchingTimeout]] : Specifies the device searching time. | ||
| + | * [[BS2_SetDebugFileLog]] : Retrieves debugging file log. | ||
| + | * [[BS2_EnableDeviceLicense]]: [+ 2.9.1] Activate the device license. | ||
| + | * [[BS2_DisableDeviceLicense]]: [+ 2.9.1] Deactivate the device license. | ||
| + | * [[BS2_QueryDeviceLicense]]: [+ 2.9.1] Check device license information. | ||
| + | * [[BS2_InitializeEx]]: [+ 2.9.6] Initializes the device management context. | ||
| ===== Structure ===== | ===== Structure ===== | ||
| - | ==== BS2CredentialKeyInfo ==== | + | ==== BS2EncryptKey ==== |
| <code cpp> | <code cpp> | ||
| - | /** | ||
| - | * BS2_CRED_KEY_REQ | ||
| - | */ | ||
| enum | enum | ||
| { | { | ||
| - | BS2_CRED_KEY_REQ_COMM = 0, | + | BS2_ENC_KEY_SIZE = 32, |
| - | BS2_CRED_KEY_REQ_DATA = 1, | + | |
| }; | }; | ||
| - | enum | ||
| - | { | ||
| - | BS2_CRED_KEY_SIZE = 32, | ||
| - | }; | ||
| - | |||
| - | /** | ||
| - | * BS2CredentialKeyInfo | ||
| - | */ | ||
| typedef struct | typedef struct | ||
| { | { | ||
| - | uint32_t maxPacketSize; ///< 4 bytes | + | uint8_t key[BS2_ENC_KEY_SIZE]; |
| - | uint8_t key[BS2_CRED_KEY_SIZE]; ///< 32 bytes | + | uint8_t reserved[32]; |
| - | uint8_t dualIDSupported; ///< 1 byte | + | } BS2EncryptKey; |
| - | uint8_t useAlphanumericID; ///< 1 byte | + | |
| - | uint8_t credentialKeySupported; ///< 1 byte | + | |
| - | uint8_t credentialKeyRequest; ///< 1 byte | + | |
| - | uint8_t reserved[28]; ///< 28 bytes (reserved) | + | |
| - | } BS2CredentialKeyInfo; | + | |
| </code> | </code> | ||
| - | 1. //maxPacketSize// \\ | + | 1. //key// \\ |
| - | The maximum TCP packet size allowed by the device. \\ | + | |
| - | + | ||
| - | 2. //key// \\ | + | |
| The key value used by the device. \\ | 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// \\ | + | 2. //reserved// \\ |
| - | Indicates whether the device's userID format (number, character) is allowed to change. \\ | + | Reserved space. \\ \\ |
| - | 4. //useAlphanumericID// \\ | ||
| - | A flag indicating whether the device uses an alphanumeric userID. \\ | ||
| - | 5. //credentialKeySupported// \\ | + | ==== BS2LicenseBlob ==== |
| - | Indicates whether data key changes are allowed. \\ | + | <code cpp> |
| - | Device supports data credential key changes when the release date of FW for each device is later than 30 Mar 2018, \\ | + | typedef struct { |
| - | So it indicates whether the currently connected device supports the modification of these keys. \\ | + | BS2_LICENSE_TYPE licenseType; |
| - | + | uint16_t numOfDevices; | |
| - | 6. //credentialKeyRequest// \\ | + | BS2_DEVICE_ID* deviceIDObjs; |
| - | You can use this setting to request a key for the device. \\ | + | uint32_t licenseLen; |
| - | This setting is applicable only when the release date of FW for each device is later than 30 Mar 2018.\\ | + | uint8_t* licenseObj; |
| - | In the case of the previous FW, only the communication key is returned regardless of whether this is set or not. | + | } BS2LicenseBlob; |
| + | </code> | ||
| + | 1. //licenseType// \\ | ||
| + | The type of license. \\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^Value ^Description ^ | ^Value ^Description ^ | ||
| - | |BS2_CRED_KEY_REQ_COMM |Communication credential key request | | + | |0x0000 |None | |
| - | |BS2_CRED_KEY_REQ_DATA |Data credential key reuqest | | + | |0x0001 |Visual QR | |
| </WRAP> | </WRAP> | ||
| + | 2. //numOfDevices// \\ | ||
| + | Number of licenses activated devices. \\ \\ | ||
| + | 3. //deviceIDObjs// \\ | ||
| + | Slave devices for which license information will be issued. \\ \\ | ||
| + | 4. //licenseLen// \\ | ||
| + | license activation file size. \\ \\ | ||
| + | 5. //licenseObj// \\ | ||
| + | License activation data block. \\ \\ | ||
| - | 7. //reserved// \\ | + | |
| - | Reserved space. \\ | + | ==== BS2LicenseResult ==== |
| + | <code cpp> | ||
| + | typedef struct { | ||
| + | BS2_DEVICE_ID deviceID; | ||
| + | BS2_LICENSE_STATUS status; | ||
| + | } BS2LicenseResult; | ||
| + | </code> | ||
| + | 1. //deviceID// \\ | ||
| + | Device identifier. \\ \\ | ||
| + | 2. //status// \\ | ||
| + | License status information. \\ \\ | ||
| + | <WRAP group 50%> | ||
| + | ^Value ^Description ^ | ||
| + | |0 |Not supported | | ||
| + | |1 |Disable | | ||
| + | |2 |Enable | | ||
| + | |3 |Expired | | ||
| + | </WRAP> | ||