Board designs, FPGA verilog, firmware for TKey, the flexible and open USB security key
Go to file
2023-03-21 14:38:26 +01:00
.github/workflows Config verilator lint to ignore known 3rd-party warnings; let warnings be fatal 2023-03-01 13:37:31 +01:00
contrib Update udev rule for raw usb programmer 2023-03-21 14:38:26 +01:00
doc fw: Steady white led while waiting cmd; led off while loading app 2023-03-14 10:25:03 +01:00
hw Add test routine for erasing CH552 2023-03-21 14:38:26 +01:00
LICENSES Let script check all files in repo no matter where it is run from 2023-02-03 16:13:34 +01:00
.editorconfig Help our editors fight less 2022-09-21 14:47:24 +02:00
.gitattributes Make initial public release 2022-09-19 08:51:11 +02:00
.gitignore Ignore virtualenv dir down where we use it; unignore disused toolchain dirs 2022-11-29 08:10:05 +01:00
dco.md Add dco file and link to the dco in README 2022-11-21 13:47:42 +01:00
README.md One link to boards should be enough 2023-03-21 14:05:49 +01:00

ci

Tillitis TKey

Introduction

The Tillitis TKey is a new kind of USB security token. What makes the TKey unique is that it allows a user to load and run applications on the device, while still providing security. This allow for open-ended, flexible usage. Given the right application, the TKey can support use cases such as SSH login, Ed25519 signing, Root of Trust, FIDO2, TOTP, Passkey, and more.

During the load operation, the device measures the application (calculates a cryptographic hash digest over it) before running it on the open hardware security processor. This measurement is similar to TCG DICE.

Each TKey device contains a Unique Device Secret (UDS), which together with the application measurement, and an optional User-Supplied Secret (USS), is used to derive key material unique to each application. This guarantees that if the integrity of the application loaded onto the device has been tampered with, the correct keys needed for an authentication will not be generated.

Key derivation with a User-Supplied Secret allows users to build and load their own apps, while ensuring that each app loaded will have its own cryptographic identity, and can also be used for authentication towards different services.

The TKey platform is based around a 32-bit RISC-V processor and has 128 KB of RAM. Firmware can load and start an app that is as large as RAM.

All of the TKey software, firmware, FPGA Verilog source code, schematics and PCB design files are open source. Like all trustworthy security software and hardware should be. This in itself makes it different, as other security tokens utilize at least some closed source hardware for its security-critical operations.

Tillitis Key 1 PCB, first implementation The TK1 PCB, the first implementation of the TKey.

Documentation

Getting started

In-depth technical information

Note that development is ongoing. For example, changes might be made to the measuring and derivation of key material, causing the public/private keys of a signer app to change. To avoid unexpected changes, please use a tagged release. Read the Release Notes to keep up to date with changes and new releases.

About this repository

This repository contains hardware, software and utilities written as part of the TKey. It is structured as monolithic repository, or "monorepo", where all components live in one repository.

Licensing

See LICENSES for more information about the projects' licenses.

All contributors must adhere to the Developer Certificate of Origin.