Git-Mirrors
/
tillitis-key
mirror of https://github.com/tillitis/tillitis-key1.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Board designs, FPGA verilog, firmware for TKey, the flexible and open USB security key
465 Commits 12 Branches 13 Tags 28 MiB
Verilog 46.7%
C 30.6%
Python 14.5%
Makefile 5%
C++ 1%
Other 2.2%
Go to file
dehanj d7b8bb26a9
CI: move check-hash to separate job. 
- This makes it easier to see if CI fails on hashes (which might be
  expected during development) or something else.
 		2024-04-17 12:10:28 +02:00
.github/workflows CI: move check-hash to separate job. 2024-04-17 12:10:28 +02:00
LICENSES Use tkey-builder:2; add hashes & checks for bitstream & fw bins 2023-07-04 09:04:23 +02:00
contrib Use tkey-builder:4 2024-03-22 10:54:33 +01:00
doc Add release notes for TK1-24.03 2024-03-26 13:34:54 +01:00
hw hw/tool: UDI/UDS storage 2024-04-03 11:27:00 +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 Ignore virtualenv dir down where we use it; unignore disused toolchain dirs 2022-11-29 08:10:05 +01:00
README.md Updated readme and docs to point at dev.tillitis.se. 2024-03-19 17:06:34 +01:00
dco.md Add dco file and link to the dco in README 2022-11-21 13:47:42 +01:00

README.md

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.

Getting started

The official website is tillitis.se.

The Tkey can be purchased at shop.tillitis.se.

All documentation concerning the TKey has been migrated to TKey Developer Handbook.

Tkey Device Apps

Offically supported apps can be found at tillitis.se

The source and other projects from us can be found here at our GitHub.

Other known (but not all) projects can be found at dev.tillitis.se.

Other noteworthy links

Note that development is ongoing. To avoid unexpected changes of derived key material, 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, firmware and utilities written as part of the TKey. It is structured as monolithic repository, or "monorepo", where all components live in one repository.

Device and client applications, however, are kept in other repositories here at our GitHub.

Licensing

See LICENSES for more information about the projects' licenses.

All contributors must adhere to the Developer Certificate of Origin.