Welcome to the WooKey project documentation!

Welcome to the WooKey project quick start guide. The philosophy, main purpose and features of the project are summarized in the WooKey project section. More detailed about the project can be found in the Publications section.

To experiment with a demo WooKey project on a STM32F407 Discovery board, directly go to the Quick start section.

Any questions or propositions on the project ? Don’t hesitate to use the Wookey project mailing list, kindly hosted by the CNRS.

Warning

A new release of the Wookey software has been delivered, denoted 2020-june. This release includes a huge amount of new security features and bufixes described in the 2020-june section of the Releases page. This release is still nightly but will be tagged stable shortly.

Table of Contents

• 1. About the WooKey project
  • 1.1. Building trusted USB devices and IoTs
  • 1.2. WooKey threat model
  • 1.3. Security features
• 2. Quickstart
  • 2.1. Pre-requisites
  • 2.2. Build the firmware
  • 2.3. Flash the firmware
  • 2.4. Execute the new firmware
  • 2.5. Debug
  • 2.6. Going further
  • 2.7. Troubleshooting
• 3. Demo applications
  • 3.1. Blinky demo
  • 3.2. Blinky with IPC demo
• 4. Wookey architecture
  • 4.1. Hardware design rationale
  • 4.2. Software design rationale
  • 4.3. Cryptography
  • 4.4. Flip-flop mechanism
• 5. EwoK kernel
  • 5.1. What is EwoK ?
  • 5.2. EwoK architecture
  • 5.3. EwoK API
  • 5.4. Internals
  • 5.5. FAQ
• 6. Libraries
  • 6.1. libs/aes
  • 6.2. libs/console
  • 6.3. libs/des
  • 6.4. libs/dfu
  • 6.5. libs/firmware
  • 6.6. libs/gui
  • 6.7. libs/hmac
  • 6.8. libs/iso7816
  • 6.9. libs/massstorage
  • 6.10. libs/sd
  • 6.11. libs/smartcard
  • 6.12. libs/std
  • 6.13. libs/token
• 7. Drivers
  • 7.1. drivers/can
  • 7.2. drivers/cryp
  • 7.3. drivers/flash
  • 7.4. drivers/hash
  • 7.5. drivers/iso7816
  • 7.6. drivers/spi
  • 7.7. drivers/usart
  • 7.8. drivers/ili9341
• 8. Javacard Applets
  • 8.1. Overview
  • 8.2. Applets compilation
  • 8.3. Applets flash
  • 8.4. Common instructions in AUTH, DFU, SIG
  • 8.5. AUTH applet
  • 8.6. DFU applet
  • 8.7. SIG applet
• 9. Tataouine SDK
  • 9.1. Dependencies
  • 9.2. Downloading the project with repo
  • 9.3. External dependencies
  • 9.4. Configuration
  • 9.5. Building a new firmware
  • 9.6. Flashing a new firmware
  • 9.7. Production mode
  • 9.8. Debugging the project
  • 9.9. Creating a new driver
  • 9.10. Creating a new library
  • 9.11. Creating a new application
  • 9.12. Internals
  • 9.13. Layout and portability
  • 9.14. Tataouine directories
• 10. Hardware
  • 10.1. Motherboard design
  • 10.2. Screen board design
  • 10.3. JTAG board design
• 11. Publications
  • 11.1. Presentations
  • 11.2. Articles and publications
• 12. Roadmap
  • 12.1. About the components versioning
  • 12.2. Releases
  • 12.3. Planned Updates and wishlist