tmkms v0.6.0

[tarcieri]

This release is tested against tendermint v0.31 and known to be compatible with tendermint v0.32.

Upgrade Notes

state_file syntax changes

The validator state files use an incompatible syntax from Tendermint KMS v0.5. It has been changed to match the conventions used by the rest of Tendermint, where integer values are stored in strings rather than JSON integers.

When upgrading, you will need to either delete existing state files (they will be recreated automatically), or ensure the integer height and round fields contained within these files are quoted in strings, e.g. {"height":"123456","round":"0",...}.

Unknown fields now disallowed in tmkms.toml

The previous parser for tmkms.toml ignored unknown attributes in the config file. This means it would often ignore syntax errors, spelling mistakes, or attributes in the wrong location when parsing files.

This has been changed to explicitly reject such fields, however please be aware if your config file contained invalid syntax, it will now be rejected by the parser and the KMS will no longer boot.

We suggest validating the configuration in a staging or other noncritical deployment of the KMS in order to ensure your configuration does not contain accidental misconfigurations which were previously uncaught.

See #282 for more information.

YubiHSM improvements

This release contains many improvements for users of the yubihsm backend:

• New yubihsm-server feature: this release includes support for the KMS exposing an HTTP service which is compatible with Yubico's yubihsm-connector service. This allows for concurrently administering a YubiHSM2 while the KMS is running, either through tmkms yubihsm (see additional notes below) or via Yubico's yubihsm-shell.
• Loopback support for tmkms yubihsm: the CLI functionality in the KMS for administering YubiHSMs can now be configured to connect to the KMS's own yubihsm-server. Additionally it can also be configured to use a different authentication key, and to prompt for a password as opposed to using one in the configuration file.

For more information on these changes, please see the "yubihsm-server feature" section in the Tendermint KMS YubiHSM docs:

https://github.com/tendermint/kms/blob/master/README.yubihsm.md#yubihsm-server-feature

Detailed Changes

• tendermint crate v0.10.0 (tendermint-rs v0.10.0 #328)
• Double signing logging improvements (Double signing logging improvements #322, Log block ID prefix in more contexts; remove dup logging (closes #314) #319, Log block ID and [dup] blocks #317)
• Log tendermint::consensus::State height/round/step (Display tendermint::consensus::State height/round/step #316)
• yubihsm keys import: base64 support (yubihsm keys import: base64 support #306)
• yubihsm: Support for reading password from a file (yubihsm: Support for reading password from a file #305)
• softsign: Fix private key decoding + import command (softsign: Fix private key decoding + import command (closes #290) #304)
• softsign: Add subcommand; move keygen under it (softsign: Add subcommand; move keygen under it #303)
• yubihsm setup: use hkd32 crate to derive key hierarchy (yubihsm setup: use hkd32 crate to derive key hierarchy #302)
• yubihsm setup: Collect 256-bits entropy from both RNGs (yubihsm setup: Collect 256-bits entropy from both RNGs #300)
• abscissa crate v0.2 (Upgrade to abscissa v0.2.0 #294)
• Log durations for each signing operation (Log durations for each signing operation #283)
• Add serde(deny_unknown_fields) to all config structs (Add serde(deny_unknown_fields) to all config structs #282)
• tmkms yubihsm keys list: Use chain-specific formatters (yubihsm keys list: Use chain-specific formatters (fixes #253) #275)
• yubihsm-server: Allow CLI commands to use loopback connection (yubihsm-server: Allow CLI commands to use loopback connection #274)
• yubihsm-server: Optional yubihsm-connector compatibility (yubihsm-server: Provide optional yubihsm-connector compatibility #273)
• Send RemoteSignerError response to validator on double sign (Errors when connecting to multiple validators with same chain-id #249)
• Logging improvements (Log all signature events at INFO level #271)
• yubihsm: Mark imported priv_validator.json keys as re-exportable (Mark imported priv_validator keys as exportable #248)
• ledger: Add init commands (Add Ledger init commands #242)
• Add max_height support for stopping chains at specific heights (Zaki/max height #238)
• Chain-specific keyrings / multitenancy (Implement chain-specific keyrings (closes #231, #111) #232)
• ledger: Use ledger-tendermint backend (Feat/ledger #225)