tkeysign

README

Tillitis TKey Sign package

A Go package for communicating with the signer device app on a Tillitis TKey to get cryptographic signatures over a message.

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

See tkey-ssh-agent and tkey-sign-cli for client applications using this go package.

Release notes in RELEASE.md.

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 Oct 25, 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/

We attempt to follow the REUSE specification.

Documentation

Overview

Package tkeysign provides a connection to the ed25519 signer app running on the TKey. You're expected to pass an existing connection to it, so use it like this:

tk := tkeyclient.New()
err := tk.Connect(port)
signer := tkeysign.New(tk)

Then use it like this to get the public key of the TKey:

pubkey, err := signer.GetPubkey()

And like this to sign a message:

signature, err := signer.Sign(message)

Index

• Constants
• type Signer
  • func New(tk *tkeyclient.TillitisKey) Signer
  • func (s Signer) Close() error
  • func (s Signer) GetAppNameVersion() (*tkeyclient.NameVersion, error)
  • func (s Signer) GetFWDigest(len int) ([]byte, error)
  • func (s Signer) GetPubkey() ([]byte, error)
  • func (s Signer) Sign(data []byte) ([]byte, error)

Constants

const MaxSignSize = 4096

Types

type Signer

type Signer struct {
	// contains filtered or unexported fields
}

func New

func New(tk *tkeyclient.TillitisKey) Signer

New allocates a struct for communicating with the ed25519 signer app running on the TKey. You're expected to pass an existing connection to it, so use it like this:

tk := tkeyclient.New()
err := tk.Connect(port)
signer := tk1sign.New(tk)

func (Signer) Close

func (s Signer) Close() error

Close closes the connection to the TKey

func (Signer) GetAppNameVersion

func (s Signer) GetAppNameVersion() (*tkeyclient.NameVersion, error)

GetAppNameVersion gets the name and version of the running app in the same style as the stick itself.

func (Signer) GetFWDigest

func (s Signer) GetFWDigest(len int) ([]byte, error)

GetFWDigest asks the signer app to hash len bytes of the firmware.

It returns the resulting SHA512 digest or an error.

func (Signer) GetPubkey

func (s Signer) GetPubkey() ([]byte, error)

GetPubkey fetches the public key of the signer.

func (Signer) Sign

func (s Signer) Sign(data []byte) ([]byte, error)

Sign signs the message in data and returns an ed25519 signature.