Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uru-card/uru-card
Arduino based firmware for FIDO2 Authenticator
https://github.com/uru-card/uru-card
arduino authenticator ble ctap ctap2 esp32 fido2 platformio uru-card webauthn
Last synced: 1 day ago
JSON representation
Arduino based firmware for FIDO2 Authenticator
- Host: GitHub
- URL: https://github.com/uru-card/uru-card
- Owner: uru-card
- License: apache-2.0
- Created: 2020-04-12T18:13:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T17:02:20.000Z (almost 2 years ago)
- Last Synced: 2024-10-31T09:50:16.033Z (8 days ago)
- Topics: arduino, authenticator, ble, ctap, ctap2, esp32, fido2, platformio, uru-card, webauthn
- Language: C++
- Homepage: https://en.ovcharov.me/tag/uru-card/
- Size: 400 KB
- Stars: 158
- Watchers: 10
- Forks: 11
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-fido2 - uru-card/uru-card
README
# URU Card - Arduino FIDO2 Authenticator
[](https://travis-ci.com/uru-card/uru-card)
[](https://codeclimate.com/github/uru-card/uru-card/maintainability)
URU Card is an Arduino based FIDO2 Authenticator. This repository contains source code for the firmware.
**Warning**: At the moment BLE transport is supported only by Windows and Chrome browser on Android.
**Warning**: The project is in very early stage of the development
## How to run the project
### ESP32 development board and USB cable
You can use simple and affordable Wroom 32 development board. At the moment advanced features like secure element ATECC508a are not used so there is no need in more sophisticated boards.
Connect the board to your computer using USB cable and make sure the UART port is available to your system. Make sure the selected port provides enough current as the ESP32 chips are quite hungry and sensitive to stability of the power source.
ESP8266 or AVR based Arduino will not work.
### URU Card board
The firmware is intended for use with the URU Card device which provides more hardware features than the development board including OLED display, touch keyboard and hardware secure element. The design files for the URU Card device are avialable in the separate repository [here](https://github.com/uru-card/uru-card-pcb).
### Development Environment - PlatformIO
To build the firmware you will need [PlatformIO](https://platformio.org/). Follow [the instructions](https://platformio.org/platformio-ide) to install it for your platform.
## Building
First of all, get a copy of the source code using either `git` command or downloading a zip file.
Open the project in the PlatformIO IDE. Connect the dev board to your computer then build and upload the firmware from the PlatformIO. All the required libraries will be downloaded automatically.
I'm using the following command in terminal window:
```bash
$ pio run -t upload -t monitor
```
The program will start immediately and the serial console will start output of the debug information.
## Testing
### Pairing (bonding) the device
Despite the fact, the FIDO2 protocol supports BLE transport, at the moment is it available only under Windows. So, you will need either a Windows machine or a virtual environment. I am using Oracle Virtual Box and the trial version of Windows 10.
Open bluetooth settings on your Windows computer or Android phone. Add new device and select "URU Card" from the list of discovered devices.
After a few seconds, the device should be paired and appear in the list of available devices.
This step should be performed only once.
### Testing tools
Open the browser in your Windows. Chrome, Firefox and Edge browsers work equally well as they are using the system layer to communicate with the authenticator device.
Visit the website [webauthn.me](https://webauthn.me/). There you find a number of tools for testing the Authenticator device. The communication between the browser and the authenticator will be displayed in the serial console.
## Contributing
Please read [CONTRIBUTING.md](/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Authors
* [**Andrey Ovcharov**](https://github.com/snakeye) - project owner
See also the list of [contributors](https://github.com/uru-card/uru-card/contributors) who participated in this project.
## License
This project is licensed under the Apache License 2.0 - see the [LICENSE](/LICENSE) file for details.