Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/canokeys/canokey-core
Core implementations of an open-source secure key
https://github.com/canokeys/canokey-core
fido2 ndef openpgp piv totp u2f webusb
Last synced: about 2 months ago
JSON representation
Core implementations of an open-source secure key
- Host: GitHub
- URL: https://github.com/canokeys/canokey-core
- Owner: canokeys
- License: apache-2.0
- Created: 2019-07-10T15:42:46.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T16:13:02.000Z (about 2 months ago)
- Last Synced: 2024-07-25T18:39:58.620Z (about 2 months ago)
- Topics: fido2, ndef, openpgp, piv, totp, u2f, webusb
- Language: C
- Homepage: https://canokeys.org/
- Size: 1.82 MB
- Stars: 306
- Watchers: 16
- Forks: 35
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Canokey Core
[](https://github.com/canokeys/canokey-core/actions?query=branch%3Amaster)
[](https://coveralls.io/github/canokeys/canokey-core?branch=master)
[](https://github.com/canokeys/canokey-core/blob/master/LICENSE)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fcanokeys%2Fcanokey-core?ref=badge_shield)
## Introduction
Core implementations of an open-source secure key, with supports of:
* U2F / FIDO2 with ed25519 and HMAC-secret
* OpenPGP Card V3.4, [Supported Algorithm List](https://docs.canokeys.org/userguide/openpgp/#supported-algorithm)
* PIV (NIST SP 800-73-4)
* HOTP / TOTP
* NDEF
The USB mode contains 3 different interfaces:
* Interface 0: U2F / FIDO2, which is an HID interface
* Interface 1: PIV/OpenPGP/OATH Card, which is a CCID interface
* Interface 2: WebUSB, which is not a standard interface
* Interface 3: Keyboard
The WebUSB interface is used to configure the key via a web-based interface.
## Protocol
Please refer to the [documentation](https://docs.canokeys.org/development/protocols/).
## Porting
Use [Canokey-STM32](https://github.com/canokeys/canokey-stm32) as an example.
1. You need to implement these functions in `device.h`:
* `void device_delay(int ms);`
* `uint32_t device_get_tick(void);`
* `int device_spinlock_lock(volatile uint32_t *lock, uint32_t blocking);`
* `void device_spinlock_unlock(volatile uint32_t *lock);`
* `int device_atomic_compare_and_swap(volatile uint32_t *var, uint32_t expect, uint32_t update);`
* `void led_on(void);`
* `void led_off(void);`
* `void device_set_timeout(void (*callback)(void), uint16_t timeout);`
* A hardware timer with IRQ is required
If you need NFC, you also need to implement the following functions for FM11NC08:
* `void fm_csn_low(void);`
* `void fm_csn_high(void);`
* `void spi_transmit(uint8_t *buf, uint8_t len);`
* `void spi_receive(uint8_t *buf, uint8_t len);`
or the following functions if you use FM11NT08:
* `void fm_csn_low(void);`
* `void fm_csn_high(void);`
* `void i2c_start(void);`
* `void i2c_stop(void);`
* `void scl_delay(void);`
* `uint8_t i2c_read_ack(void);`
* `void i2c_send_ack(void);`
* `void i2c_send_nack(void);`
* `void i2c_write_byte(uint8_t data);`
* `uint8_t i2c_read_byte(void);`
2. You should also provide a `random32` and a optional `random_buffer` function in `rand.h`.
3. You need to configure the littlefs properly.
4. You need to configure the mbed-tls according to its documentation or provide the algorithms on your own by overwriting the weak symbols.
Or instead, you may implement the cryptography algorithms by yourself.
5. You should call the `device_loop` or `nfc_loop` in the main loop, and the `device_update_led` in a periodic interrupt.
6. You should call the `set_touch_result` to report touch sensing result, and `set_nfc_state` to report NFC state.
## Fuzz testing
Install honggfuzz from source first, then enable fuzz tests:
```bash
cd build
cmake .. -DENABLE_FUZZING=ON -DENABLE_TESTS=ON -DCMAKE_C_COMPILER=hfuzz-clang -DCMAKE_BUILD_TYPE=Debug
```
Then, run fuzzing tests:
```bash
./fuzzer/run-fuzzer.sh honggfuzz ${id}
```
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fcanokeys%2Fcanokey-core?ref=badge_large)