Git-Mirrors/tillitis-key
1
0
Fork 0
mirror of https://github.com/tillitis/tillitis-key1.git synced 2024-12-18 20:34:29 -05:00
Code Issues Packages Projects Releases Wiki Activity
Board designs, FPGA verilog, firmware for TKey, the flexible and open USB security key
140 Commits 26 Branches 14 Tags 32 MiB
Verilog 57.7%
C 28.8%
Makefile 5.4%
Python 3.7%
Shell 2%
Other 2.4%
a15a94fe8e
Go to file
Joachim Strömbergson a15a94fe8e
Move readme:s for boards and firmware to doc subdir 
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2022-11-21 16:27:30 +01:00
contrib Add deps for building qemu 2022-09-29 15:24:21 +02:00
doc Move readme:s for boards and firmware to doc subdir 2022-11-21 16:27:30 +01:00
hw Move readme:s for boards and firmware to doc subdir 2022-11-21 16:27:30 +01:00
LICENSES Make initial public release 2022-09-19 08:51:11 +02: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 Add wrapper script that runs reset.py using virtualenv 2022-11-02 15:19:31 +01:00
dco.md Add dco file and link to the dco in README 2022-11-21 13:47:42 +01:00
README.md Move readme:s for boards and firmware to doc subdir 2022-11-21 16:27:30 +01:00

README.md

Tillitis Key 1

Introduction

Tillitis Key 1 (TK1) is a new kind of USB security token. What makes the TK1 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 TK1 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 TK1 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 TK1 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 TK1 software, FPGA logic, schematics, and PCB layout are open source. Like all security software and hardware should be. This in itself makes it different, as other security tokens utilize closed source hardware for its security-critical operations.

Tillitis Key 1 PCB, first implementation Tillitis Key 1 PCB, first implementation

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.

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

About this repository

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

The repository follows the OpenTitan layout.

Licensing

See LICENSES for more information about the projects' licenses.

All contributors must adhere to the Developer Certificate of Origin.