# Release notes

## Upcoming release

- Detect and load different signer device apps depending on TKey
  model.
- Embed two different signer binaries: one for Castor and one for
  earlier versions.
- tkeysign updated to v1.1.0.
- tkeyclient updated to v1.2.0.

## v1.0.0

- All other apps, libraries, and packages have moved to their own
  repos.
- Bug fix for Windows: Complain and quit cleanly when agent socket
  already exists.
- Embed binary signer in repo. This enables `go install` as install
  method.
- `--version` now also outputs version of embedded device app.
- Builds releases and OS packages with
  [goreleaser](https://goreleaser.com/).
- [tkey-device-signer](https://github.com/tillitis/tkey-device-signer)
  has been updated to v1.0.0. WARNING: Breaks CDI! Generates new key pair.
- [tkeyclient](https://github.com/tillitis/tkeyclient) has been
  updated to v1.0.0.
- [tkeysign](https://github.com/tillitis/tkeysign) has been updated to
  v1.0.0.

Full
[changelog](https://github.com/tillitis/tkey-ssh-agent/compare/v0.0.6...v1.0.0).

## v0.0.6

- Change maximum frame length back to 128 bytes.

## v0.0.5

- Update largest frame size to follow change in firmware - breaks CDI!
- Firmware now loads app at the start of RAM, so we adjust our linker
  script and C runtime to init the stack to begin just below the end
  of RAM. - This breaks CDI, changing app hash of all apps!
- Make apps use a steady LED color when waiting for a command,
  flashing only to draw attention (currently only when signer-app
  requires touching). - breaking CDI of signer app (changing hash of
  modified apps)
- Let apps respond with status Not OK in header if they receive a
  command meant for firmware - breaks CDI!

## v0.0.4

- tkey-ssh-agent now connects to the TKey for each SSH agent operation
  (and disconnects afterwards with a delay). The serial port is thus
  left accessible to others. The udev rule that sent SIGHUP to
  tkey-ssh-agent upon insert/remove of TKey is no longer needed, and
  tkey-ssh-agent does nothing upon receiving a SIGHUP.

## v0.0.3

- Update tk1_mem.h and timer app to the revised timer MMIO API

## v0.0.2

We forgot to add the release here when tagging for
https://github.com/tillitis/tillitis-key1-apps/releases/tag/v0.0.2

Notable changes:

- Make monocypher a library - breaks CDI!
- Remove GET_UDI from signer app, and the use of it - breaks CDI!

## v0.0.1

Since we haven't tagged any release before this we list some recent
significant and/or breaking changes.

### Revised SSH Agent

Introduces a revised Tillitis TKey SSH Agent, `tkey-ssh-agent`. The
new agent:

- runs as a daemon all the time (as `systemd` user unit, if you want).
- autodetects TKey removal and insertion with the help of `udev` rules
  (or just send it a `SIGHUP` yourself to make it look for a TKey
  again).
- spawns a graphical `pinentry` program to enter the User-Supplied
  Secret.

The first iteration of this revision of the SSH agent is focused on
Linux distributions and has a Ubuntu/Debian package available.

### Simplified firmware protocol

The firmware protocol for loading a TKey app has changed. We now
combine starting to load an app by setting size and loading USS into a
single request. The firmware automatically returns the app digest and
start the app when the last chunk of the binary has been received.

`GetNameVersion` also now expects an ASCII array for `NAME0` and
`NAME1` both from the firmware and from TKey apps. This also means the
`signerapp` has a new digest and hence a new identity.

### Division no longer available

We now build the TKey apps with the RV32 Zmmul extension since we
removed support for division on the PicoRV32 CPU.