https://github.com/r4gus/candy-stick-nrf
https://github.com/r4gus/candy-stick-nrf
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/r4gus/candy-stick-nrf
- Owner: r4gus
- Created: 2023-01-23T00:03:02.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T19:14:05.000Z (about 1 year ago)
- Last Synced: 2025-02-14T22:19:25.300Z (2 months ago)
- Language: Zig
- Size: 2.01 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Candy Stick
CTAP2 firmware
```
src/
|- main.zig (entry point and callbacks)
|- nrf52/ (nrf52840 specific code)
|- tusb_config.h
|- usb_descriptors.c
```
## Getting Started
To get started install the following dependencies:
### Dependencies
#### Zig
Download [Zig](https://ziglang.org/download/) compiler version 0.12.0 from the official website
and install it on your system.
#### ARM Tool Chain
##### Linux
###### Arch
```
sudo pacman -S arm-none-eabi-gcc arm-none-eabi-newlib
```
###### Debian/ Ubuntu
```
sudo apt install gcc-arm-none-eabi
```
##### MAC with Homebrew
```
brew tap ArmMbed/homebrew-formulae
brew upgrade
brew install arm-none-eabi-gcc
```
#### NRF Tools
To flash the device you need [nrfutil](https://www.nordicsemi.com/Products/Development-tools/nrf-util).
Download the file and then move it to a location of your likeing, e.g. `sudo cp nrfutil /usr/local/bin`.
After that run the following command:
```
nrfutil install nrf5sdk-tools
nrfutil install device
```
### Build
After you've installed the required dependencies clone the following repositories into `./libs`.
* [tinyusb](https://github.com/r4gus/tinyusb) TODO: update to official repo
Then run `./build` to build the project. This will output a `.elf` file.
### Flash
This project targets the nRF52840 MDK USB Dongle, i.e. the Nordic nRF52840 (ARM Cortex-M4F) chip.
We assume that you're using DFU via [Open Bootloader](https://github.com/makerdiary/nrf52840-mdk-usb-dongle/tree/master/firmware/open_bootloader).
You can change from UF2 to Open Bootloader (see [here])https://github.com/makerdiary/nrf52840-mdk-usb-dongle/tree/master/firmware/open_bootloader#change-to-open-bootloader-from-uf2-bootloader)).
> During tests, using UF2 for flashing lead to a corruption of the bootloader. This is why we use Open Bootloader instead.
Insert the Dongle into your Pc while pressing the button on the device (LED should start blinking red).
Then just run `./flash.sh ` (e.g. `./flash.sh /dev/tty.usbmodemE04AC0F44B391` (MAC) or `./flash.sh /dev/ttyACM0`) from within the project folder.
If you don't have the permission to write to the device, you can either change its permissions (e.g., `sudo chmod 666 /dev/ttyACM0`) or
add a udev rule (e.g., `sudo echo 'KERNEL=="ttyACM0", MODE="0666"' > /etc/udev/rules.d/99-usb.rules`, requires reboot!).
## Tools
To use the tools you need to install `libfido2`.
### Install
#### Linux
##### Arch
```
sudo pacman -S libfido2
```
##### Debian/ Ubuntu
```
$ sudo apt install libfido2-1 libfido2-dev libfido2-doc fido2-tools
```
#### MAC with Homebrew
```
brew install libfido2
```
#### Build from source
```
git clone https://github.com/Yubico/libfido2.git
cd libfido2
cmake -B build
make -C build
sudo make -C build install
```
### Run
The `cred.sh`script can be used to create a new credential and `assert.sh` can be used to verify it.
Both take a number `N` that selects the `/dev/hidrawN` device. If don't use Linux you might need to alter the script slightly.