tkey-tools

This repository contains some development tools for the Tillitis TKey USB security stick.

• tkey-runapp: A simple development tool to load and start any TKey device app.

• run-tkey-qemu: Script around our TKey emulator OCI image ghcr.io/tillitis/tkey-qemu-tk1-23.03.1.

See the TKey Developer Handbook for how to develop your own apps, how to run and debug them in the emulator or on real hardware.

Current list of known projects.

Building

You have two options, either our OCI image ghcr.io/tillitis/tkey-builder for use with a rootless podman setup, or native tools. See the Devoloper Handbook for setup.

With native tools you should be able to use make

$ make

If you want to use podman and you have make you can run:

$ podman pull ghcr.io/tillitis/tkey-builder:2
$ make podman

or run podman directly with

$ podman run --rm --mount type=bind,source=.,target=/src -w /src -it ghcr.io/tillitis/tkey-builder:2 make -j

To install:

sudo make install

If you want to reload the udev rules to access the TKey use:

sudo make reload-rules

Undo the installation with the uninstall target.

Using tkey-runapp

The client app tkey-runapp only loads and starts a device app. It's mostly a development tool. You'll then have to switch to a different client app that speaks your app's specific protocol. Run with -h to get help.

Using run-tkey-qemu

$ ./run-tkey-qemu

This gives you tkey-qemu-pty in the current working directory you can attach your client programs to, typically with --port ./tkey-qemu-pty.

Licenses and SPDX tags

Unless otherwise noted, the project sources are copyright Tillitis AB, licensed under the terms and conditions of the "BSD-2-Clause" license. See LICENSE for the full license text.

Until Dec 30, 2024, the license was GPL-2.0 Only.

External source code we have imported are isolated in their own directories. They may be released under other licenses. This is noted with a similar LICENSE file in every directory containing imported sources.

The project uses single-line references to Unique License Identifiers as defined by the Linux Foundation's SPDX project on its own source files, but not necessarily imported files. The line in each individual source file identifies the license applicable to that file.

The current set of valid, predefined SPDX identifiers can be found on the SPDX License List at:

https://spdx.org/licenses/

All contributors must adhere to the Developer Certificate of Origin.