mirror of https://github.com/tillitis/tillitis-key1.git synced 2024-06-18 10:50:11 +00:00

Board designs, FPGA verilog, firmware for TKey, the flexible and open USB security key

Go to file

Daniel Lublin 49d4735f17 Use TKey name Signed-off-by: Daniel Lublin <daniel@lublin.se>		2022-12-02 08:03:06 +01:00
contrib	Remove version suffixes, no longer needed on ubuntu 22.10 (clang 15)	2022-11-23 09:47:48 +01:00
doc	Use TKey name	2022-12-02 08:03:06 +01:00
hw	Use TKey name	2022-12-02 08:03:06 +01:00
LICENSES	Use TKey name	2022-12-02 08:03:06 +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	Use TKey name	2022-12-02 08:03:06 +01:00

README.md

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-provided seed, 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-provided seed 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. The current firmware is designed to load an app that is up to 100 KB in size, and gives it a stack of 28 KB. A smaller app may move itself in memory to get larger continuous memory.

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.

The TK1 PCB, the first implementation of the TKey.

Documentation

Getting started

Applications and host programs that communicate with the apps are kept in this repository: https://github.com/tillitis/tillitis-key1-apps

In-depth technical information

System Description
Threat Model
Framing Protocol
Boards
Boards
FPGA
Software
QEMU (branch tk1 in separate repository)

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.