Merge pull request #39 from All-Your-Locks-Are-Belong-To-Us/doc

Author: frcroth

examples/README.md

@@ -0,0 +1,10 @@
+# examples
+
+This directory contains examples demonstrating the use of libmicrofido2 on different microcontrollers.
+
+- `nfc.c` shows the setup of a FIDO device.
+- `invalid_device.c` shows how errors are returned by libmicrofido2.
+- `measurements/` contains files to run measurements. More info in the README.
+- `esp32/` contains specific files for the ESP32 hardware platform. More info in the README.
+- `nrf52/` contains specific files for the NRF52480 hardware platform. More info in the README.
+- `stateless_rp` contains an example of a stateless, offline relying party. This can be used in hardware or with the provided nfc simulator (which can be executed from `nfc_simulator.c`).

examples/invalid_device.c

@@ -7,13 +7,15 @@
  */
 
 #include "fido.h"
+#include "assert.h"
 
 int main(void) {
     fido_dev_t device;
     fido_dev_init(&device);
 
     // This should fail because the io and transport functions are not set for the device.
-    fido_dev_open(&device);
+    int r = fido_dev_open(&device);
+    assert(r != FIDO_OK);
 
     // Always close your devices.
     fido_dev_close(&device);

examples/nrf52/README.md

@@ -11,13 +11,20 @@ This container image can be built using the following command:
 sudo DOCKER_BUILDKIT=1 docker build -t nrf52-sdk .
 ```
 
-## Building, Flashing and Debugging
+## Building
 
-After connecting the Devkit to the computer, it should be shown with `lsusb` as `SEGGER J-LINK`.
-It should also be found as ACM device in `/dev/ttyACM?` (*remember the number*).  
-Building can be done with (run from this directory!): `sudo docker run --rm -v $PWD/../../:/libmicrofido2 nrf52-sdk west -v build -b nrf52840dk_nrf52840 -d /libmicrofido2/examples/nrf52/build /libmicrofido2/examples/nrf52`.  
-Flashing can then be done with `sudo docker run --rm -v $PWD/../../:/libmicrofido2 --privileged --device=/dev/ttyACM? nrf52-sdk west flash -d /libmicrofido2/examples/nrf52/build`.  
-An interactive GDB session can be started with `sudo docker run --rm -it -v $PWD/../../:/libmicrofido2 --privileged --device=/dev/ttyACM? nrf52-sdk west debug -d /libmicrofido2/examples/nrf52/build`.  
+1. Navigate to this directory.
+1. Run `sudo docker run --rm -v $PWD/../../:/libmicrofido2 nrf52-sdk west -v build -b nrf52840dk_nrf52840 -d /libmicrofido2/examples/nrf52/build /libmicrofido2/examples/nrf52`.
+
+## Flashing
+
+1. Connect the Devkit to the computer.
+1. It should be shown with `lsusb` as `SEGGER J-LINK`. It should also be found as ACM device in `/dev/ttyACM?` (*remember the number*). 
+1. Run `sudo docker run --rm -v $PWD/../../:/libmicrofido2 --privileged --device=/dev/ttyACM? nrf52-sdk west flash -d /libmicrofido2/examples/nrf52/build`.
+
+## Debugging
+
+An interactive GDB session can be started with `sudo docker run --rm -it -v $PWD/../../:/libmicrofido2 --privileged --device=/dev/ttyACM? nrf52-sdk west debug -d /libmicrofido2/examples/nrf52/build`. 
 You can additionally connect to the serial console output / log via `sudo docker run --rm -it --privileged --device=/dev/ttyACM0 nrf52-sdk minicom -D /dev/ttyACM0 -b 115200`.
 
 ## Hardware Cryptography

external/README.md

@@ -0,0 +1,9 @@
+# external
+
+This directory contains external libraries.
+
+- [Monocypher](https://github.com/All-Your-Locks-Are-Belong-To-Us/Monocypher), used for Ed25519 signature verification
+- [AES GCM](https://github.com/All-Your-Locks-Are-Belong-To-Us/aes_gcm) for AES in Galois Counter Mode
+- [cb0r](https://github.com/All-Your-Locks-Are-Belong-To-Us/cb0r) for writing and reading CBOR encoded data
+- sha256
+- [tinf](https://github.com/All-Your-Locks-Are-Belong-To-Us/tinf) for INFLATE decompression