You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

54 lines
3.1 KiB

  1. # Secure
  2. The secure feature aims to prevent unwanted interaction without user intervention.
  3. ?> Secure does **not** currently implement encryption/decryption/etc and should not be a replacement where a strong hardware/software based solution is required.
  4. ### Unlock sequence
  5. To unlock, the user must perform a set of actions. This can optionally be configured to be multiple keys.
  6. * While unlocking all keyboard input is ignored
  7. * Incorrect attempts will revert back to the previously locked state
  8. ### Automatic Locking
  9. Once unlocked, the keyboard will revert back to a locked state after the configured timeout.
  10. The timeout can be refreshed by using the `secure_activity_event` function, for example from one of the various [hooks](custom_quantum_functions.md).
  11. ## Usage
  12. Add the following to your `rules.mk`:
  13. ```make
  14. SECURE_ENABLE = yes
  15. ```
  16. ## Keycodes
  17. | Key |Aliases | Description |
  18. |---------------------|---------|--------------------------------------------------------------------------------|
  19. | `QK_SECURE_LOCK` |`SE_LOCK`| Revert back to a locked state |
  20. | `QK_SECURE_UNLOCK` |`SE_UNLK`| Forces unlock without performing a unlock sequence |
  21. | `QK_SECURE_TOGGLE` |`SE_TOGG`| Toggle directly between locked and unlock without performing a unlock sequence |
  22. | `QK_SECURE_REQUEST` |`SE_REQ` | Request that user perform the unlock sequence |
  23. ## Configuration
  24. | Define | Default | Description |
  25. |-------------------------|----------------|---------------------------------------------------------------------------------|
  26. |`SECURE_UNLOCK_TIMEOUT` | `5000` | Timeout for the user to perform the configured unlock sequence - `0` to disable |
  27. |`SECURE_IDLE_TIMEOUT` | `60000` | Timeout while unlocked before returning to locked - `0` to disable |
  28. |`SECURE_UNLOCK_SEQUENCE` | `{ { 0, 0 } }` | Array of matrix locations describing a sequential sequence of keypresses |
  29. ## Functions
  30. | Function | Description |
  31. |---------------------------|----------------------------------------------------------------------------|
  32. | `secure_is_locked()` | Check if the device is currently locked |
  33. | `secure_is_unlocking()` | Check if an unlock sequence is currently in progress |
  34. | `secure_is_unlocked()` | Check if the device is currently unlocked |
  35. | `secure_lock()` | Lock down the device |
  36. | `secure_unlock()` | Force unlock the device - bypasses user unlock sequence |
  37. | `secure_request_unlock()` | Begin listening for an unlock sequence |
  38. | `secure_activity_event()` | Flag that user activity has happened and the device should remain unlocked |