tillitis/tkeyclient

Go package for a TKey client

Tillitis TKey Client package

A Go package for controlling a Tillitis TKey, upload device apps, and communicate with it.

See the Go doc for tkeyclient for details on how to call the functions.

See tkey-ssh-agent or tkeysign for example applications using this Go package.

Release notes in RELEASE.md.

Licenses and SPDX tags

Unless otherwise noted, the project sources are licensed under the terms and conditions of the "GNU General Public License v2.0 only":

Copyright Tillitis AB.

These programs are free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2 only.

These programs are distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see:

https://www.gnu.org/licenses

See LICENSE for the full GPLv2-only license text.

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/

tkeyclient's Issues

Device locking

Investigate device locking in different operating system.

Trying to run two tkey-runapp at once messes up the firmware but doesn't enter failed state. This works for me as an ordinary non-root user. If the serial package doesn't support device locking we should implement it ourselves somehow on the client side.

Might also need to look into why the firmware isn't in state failed.

% ./tkey-runapp apps/signer/app.bin &; ./tkey-runapp apps/signer/app.bin
[1] 91914
Auto-detected serial port /dev/ttyACM0
Connecting to device on serial port /dev/ttyACM0 ...
Auto-detected serial port /dev/ttyACM0
Connecting to device on serial port /dev/ttyACM0 ...
GetNameVersion failed: ReadFrame: Expected cmdlen 2 (32 bytes), got 1 (4 bytes)
If the serial port is correct, then the TKey might not be in firmware-
mode, and have an app running already. Please unplug and plug it in again.
[1]  + exit 1     ./tkey-runapp apps/signer/app.bin
Firmware name0:'tk m' name1:'kdf' version:0
GetUDI failed: ReadFrame: Message not meant for us: dest 0

Export DetectSerialPort function

In our client apps we try to autodetect the TKey serial device. We use the internal function util.DetectSerialPort from internal/util.

To make it possible for external repos to also autodetect TKey devices we might want to export this function, perhaps in tk1.

Enable static build on macOS

Enumeration of USB devices requires a dynamic build on macOS. We would like to be able to do static builds. One way to do this is to run an external command for enumeration on macOS.