Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
en:configuration_api [2019/07/22 17:39] kkshin |
en:configuration_api [2020/02/19 11:03] kkshin |
||
---|---|---|---|
Line 59: | Line 59: | ||
* [[BS2_GetDstConfig]]: Retrieves the device DST information. | * [[BS2_GetDstConfig]]: Retrieves the device DST information. | ||
* [[BS2_SetDstConfig]]: Stores the device DST information. | * [[BS2_SetDstConfig]]: Stores the device DST information. | ||
+ | * [[BS2_GetSupportedConfigMask]]: Retrieves supported configuration of the device. | ||
* [[BS2_GetIPConfigViaUDPEx]]: [+ 2.6.3] Retrieves IP configuration through UDP broadcast with host IP. | * [[BS2_GetIPConfigViaUDPEx]]: [+ 2.6.3] Retrieves IP configuration through UDP broadcast with host IP. | ||
* [[BS2_SetIPConfigViaUDPEx]]: [+ 2.6.3] Stores IP configuration through UDP broadcast with host IP. | * [[BS2_SetIPConfigViaUDPEx]]: [+ 2.6.3] Stores IP configuration through UDP broadcast with host IP. | ||
Line 136: | Line 137: | ||
bool secureTamper; | bool secureTamper; | ||
bool reserved0; // (write protected) | bool reserved0; // (write protected) | ||
- | bool gdprSupport; | + | uint8_t reserved[2]; |
- | uint8_t reserved[1]; | + | uint32_t useCardOperationMask; |
- | uint8_t reserved2[20]; | + | uint8_t reserved2[16]; |
} BS2SystemConfig; | } BS2SystemConfig; | ||
</code> | </code> | ||
Line 172: | Line 173: | ||
Flag to determine whether to use a security tamper. \\ | Flag to determine whether to use a security tamper. \\ | ||
When Tamper on, the following data is deleted from the device. (User, log, data encryption key, SSL certificate) \\ \\ | When Tamper on, the following data is deleted from the device. (User, log, data encryption key, SSL certificate) \\ \\ | ||
- | **13. //tamperOn//** \\ | + | **13. //reserved0//** \\ |
- | The information to manage the tampering internally, which should not be set. \\ | + | |
- | Be sure to call [[BS2_SetSystemConfig]] after completing the necessary settings except for tamperOn after [[BS2_GetSystemConfig]]. \\ \\ | + | |
- | **14. //reserved1//** \\ | + | |
Reserved space. \\ \\ | Reserved space. \\ \\ | ||
- | **15. //reserved2//** \\ | + | **14. //reserved//** \\ |
+ | Reserved space. \\ \\ | ||
+ | 15. //useCardOperationMask// \\ | ||
+ | [+ V2.6.4] Provides a card selective option not to read all kinds of cards from the device. \\ | ||
+ | You can select multiple cards using MASK. The user can select or deselect of a specific card reading option using this option. \\ | ||
+ | However, it can be applied to the card types the device supporting. If you add a card type which isn't supported from the device would be ignored. \\ | ||
+ | Also, the required card type MASK should be combined with ''CARD_OPERATION_USE''. \\ | ||
+ | For example, useCardOperationMask needs to be configured ''x0x80000001'' when EM card is selected only. | ||
+ | <WRAP group 50%> | ||
+ | ^Value ^Description ^ | ||
+ | |0xFFFFFFFF |CARD_OPERATION_MASK_DEFAULT | | ||
+ | |0x80000000 |CARD_OPERATION_USE | | ||
+ | |0x00000200 |CARD_OPERATION_MASK_BLE | | ||
+ | |0x00000100 |CARD_OPERATION_MASK_NFC | | ||
+ | |0x00000080 |CARD_OPERATION_MASK_SEOS | | ||
+ | |0x00000040 |CARD_OPERATION_MASK_SR_SE | | ||
+ | |0x00000020 |CARD_OPERATION_MASK_DESFIRE_EV1 | | ||
+ | |0x00000010 |CARD_OPERATION_MASK_CLASSIC_PLUS | | ||
+ | |0x00000008 |CARD_OPERATION_MASK_ICLASS | | ||
+ | |0x00000004 |CARD_OPERATION_MASK_MIFARE_FELICA | | ||
+ | |0x00000002 |CARD_OPERATION_MASK_HIDPROX | | ||
+ | |0x00000001 |CARD_OPERATION_MASK_EM | | ||
+ | </WRAP> | ||
+ | **16. //reserved2//** \\ | ||
Reserved space. \\ \\ | Reserved space. \\ \\ | ||
Line 241: | Line 262: | ||
**7. //faceDetectionLevel//** \\ | **7. //faceDetectionLevel//** \\ | ||
Level of face detection in user authentication. If the detected face level is lower than the configuration, it will be processed as authentication fail.\\ | Level of face detection in user authentication. If the detected face level is lower than the configuration, it will be processed as authentication fail.\\ | ||
+ | When set, the camera view according to Normal/Strict is displayed, access is denied if the device doesn't recognize facial image through image log. Default is 0. | ||
<WRAP group 50%> | <WRAP group 50%> | ||
^Value ^Description ^ | ^Value ^Description ^ | ||
Line 248: | Line 270: | ||
</WRAP> | </WRAP> | ||
<WRAP info> | <WRAP info> | ||
- | Only valid for devices with a camera. | + | Only valid for A2. Not used with FaceStation2 or FaceLite. |
</WRAP> | </WRAP> | ||
**8. //useServerMatching//** \\ | **8. //useServerMatching//** \\ | ||
Line 639: | Line 661: | ||
|0 |Lagacy mode (Using PICC master key) | | |0 |Lagacy mode (Using PICC master key) | | ||
|1 |New mode (Using App master key) | | |1 |New mode (Using App master key) | | ||
+ | </WRAP> | ||
**17. //reserved//** \\ | **17. //reserved//** \\ | ||
Reserved space.\\ \\ | Reserved space.\\ \\ | ||
Line 667: | Line 690: | ||
**24. //reserved5//** \\ | **24. //reserved5//** \\ | ||
Reserved space. \\ | Reserved space. \\ | ||
+ | </WRAP> | ||
==== BS2FingerprintConfig ==== | ==== BS2FingerprintConfig ==== | ||
<code cpp> | <code cpp> | ||
Line 1801: | Line 1824: | ||
|0xFFFFFFFF|All configuration| | |0xFFFFFFFF|All configuration| | ||
</WRAP> | </WRAP> | ||
+ | |||
+ | ==== BS2DesFireCardConfigEx ==== | ||
+ | <code cpp> | ||
+ | typedef struct { | ||
+ | uint8_t appMasterKey[16]; | ||
+ | uint8_t fileReadKey[16]; | ||
+ | uint8_t fileWriteKey[16]; | ||
+ | uint8_t fileReadKeyNumber; | ||
+ | uint8_t fileWriteKeyNumber; | ||
+ | uint8_t reserved[2]; | ||
+ | } BS2DesFireAppLevelKey; ///< 52 bytes | ||
+ | |||
+ | typedef struct { | ||
+ | BS2DesFireAppLevelKey desfireAppKey; ///< 52 bytes | ||
+ | uint8_t reserved[16]; | ||
+ | } BS2DesFireCardConfigEx; ///< 68 bytes | ||
+ | </code> | ||
+ | 1. //appMasterKey// \\ | ||
+ | Application master key of DesFire. \\ \\ | ||
+ | 2. //fileReadKey// \\ | ||
+ | The key used to read the file. \\ \\ | ||
+ | 3. //fileWriteKey// \\ | ||
+ | The key used to write the file. \\ \\ | ||
+ | 4. //fileReadKeyNumber// \\ | ||
+ | The index of the key for reading the file. \\ \\ | ||
+ | 5. //fileWriteKeyNumber// \\ | ||
+ | The index of the key for writing the file. \\ \\ | ||
+ | 6. //reserved// \\ | ||
+ | Reserved space. \\ \\ | ||
+ | 7. //desfireAppKey// \\ | ||
+ | A structure containing DesFire key information. \\ \\ | ||
+ | 8. //reserved// \\ | ||
+ | Reserved space. \\ |