Ledger integration into KMS #172

adrianbrink · 2019-02-14T20:41:47Z

This PR adds the ledger integration as a backend to the KMS. There is
still more work required to ensure that the Ledger application knows how
to correctly decode/encode Tendermint votes.

This PR adds the ledger integration as a backend to the KMS. There is still more work required to ensure that the Ledger application knows how to correctly decode/encode Tendermint votes.

adrianbrink · 2019-02-14T20:44:05Z

We can update the signatory dependencies as soon as we can release 0.11 of signatory-cosmos-val.

liamsi · 2019-02-15T00:47:55Z

Cargo.toml

+signatory = { git = "https://github.com/cryptiumlabs/signatory" }
+signatory-dalek = { git = "https://github.com/cryptiumlabs/signatory" }
+signatory-yubihsm = { git = "https://github.com/cryptiumlabs/signatory" }
+signatory-ledger-cosval = { git = "https://github.com/cryptiumlabs/signatory" }


please do not introduce external versions/forks of these crates.

This is waiting on the release of the correct upstream crates, specifically the new release of signatory-ledger-cosval.

It's out: https://crates.io/crates/signatory-ledger-tm

liamsi · 2019-02-15T00:48:11Z

.circleci/config.yml

@@ -41,7 +41,7 @@ jobs:
        command: |
          rustc --version
          cargo --version
-          cargo test --all --all-features
+          cargo test --all --features "default softsign yubihsm yubihsm-mock"


Why is this change necessary?

The test harness does not work with the Ledger since I haven't implemented a ledger-mock.

src/keyring/ed25519/ledger.rs

jleni · 2019-02-15T05:14:49Z

@adrianbrink @liamsi
I have a kind of continuation of this integration that it depends on changes made here tendermint/signatory#141, other layers and it requires Ledger Validator app v0.6.0

@adrianbrink we can work together on this, I can rebase over your PR (so your commits in this PR are not lost) and apply all the other changes that are necessary for the complete integration.

Would that make sense?

jleni · 2019-02-15T05:17:08Z

Let me know what you prefer. In the meantime, I need to wait until tendermint/signatory#141 gets merged.

tarcieri · 2019-02-15T05:48:31Z

@jleni merged

adrianbrink · 2019-02-15T11:11:57Z

@adrianbrink @liamsi
I have a kind of continuation of this integration that it depends on changes made here tendermint/signatory#141, other layers and it requires Ledger Validator app v0.6.0

@adrianbrink we can work together on this, I can rebase over your PR (so your commits in this PR are not lost) and apply all the other changes that are necessary for the complete integration.

Would that make sense?

Rebasing sounds fine!

jleni · 2019-02-15T11:21:25Z

I have multiple changes that will make this PR incompatible, specially once @tony-iqlusion releases the new crates. signatory-ledger-cosval is obsolete and will be replaced.

@adrianbrink I think the best option is that:

I rebase on this PR
submit another one with all the additional changes on top.
give you access to the PR branch so you can also work there if you want

agree?

jleni · 2019-02-15T11:22:25Z

We also need to open a couple of new additional issues to track improvements that need to be made with respect to reconnections, timeout handling, extending command line support, etc.

adrianbrink · 2019-02-15T12:07:11Z

I have multiple changes that will make this PR incompatible, specially once @tony-iqlusion releases the new crates. signatory-ledger-cosval is obsolete and will be replaced.

@adrianbrink I think the best option is that:
* I rebase on this PR

* submit another one with all the additional changes on top.

* give you access to the PR branch so you can also work there if you want
agree?

That sounds good

adrianbrink · 2019-02-15T13:31:17Z

@jleni I just tested everything with the latest Ledger application and the updated dependencies and it works :-)

jleni · 2019-02-15T13:37:46Z

There are several linked issues that are pending. Here is another one: #173

jleni · 2019-02-15T13:39:20Z

If you give me write access to adrianbrink:adrian/ledger_integration I can push my additional KMS changes directly here.

I also need to add automatic reconnections in signatory.

adrianbrink · 2019-02-15T13:42:20Z

I've added you as a contributor to adrianbrink/kms

+ Adding a basic command line

Refactoring and adjusting to new ledger-tm library

Upgrading crates + cargo fmt fixes

Disabling ledgertm tests until a ledgermock is available

jleni · 2019-02-19T08:28:57Z

@liamsi Any news about this PR? It would be good to integrate this alpha version.

liamsi · 2019-02-19T09:02:13Z

I'll look into it in a bit!

liamsi

The changes look OK. Do we want to include code snippets that aren't currently used though? I would suggest to remove the currently unused boilerplate code and add it together with the functionality that comes with followup PRs.

It is not clear to me what needs to be done to get the ledger sign anything with these changes. Just add [[providers.ledgertm]] to the config and we are done?

liamsi · 2019-02-19T13:46:25Z

src/commands/ledgertm/detect.rs

+impl Callable for DetectCommand {
+    /// Detect all Ledger devices running the Tendermint app
+    fn call(&self) {
+        println!("This feature will be soon available");


Why include the detect command if it does not do anything yet?

liamsi · 2019-02-19T13:49:05Z

tmkms.toml.example

@@ -17,3 +17,5 @@ adapter = { type = "usb" }
 auth = { key = 1, password = "password" } # Default YubiHSM admin credentials. Change ASAP!
 keys = [{ id = "gaia-9000", key = 1 }]
 #serial_number = "0123456789" # identify serial number of a specific YubiHSM to connect to
+
+[[providers.ledgertm]]


Is this everything that is necessary to get the ledger up and running? If not providing (all) existing options with some exemplary defaults would be cool.

liamsi · 2019-02-19T13:50:08Z

src/keyring/ed25519/ledgertm.rs

+};
+
+pub const LEDGER_TM_PROVIDER_LABEL: &str = "ledgertm";
+pub const LEDGER_TM_ID: &str = "ledgertm";


Shouldn't the ID come from the config? An ID that is always the same (and the same as the constant LEDGER_TM_PROVIDER_LABEL), feels wrong.

liamsi · 2019-02-19T13:52:45Z

src/ledgertm.rs

+    static ref HSM_CLIENT: Mutex<Ed25519LedgerTmAppSigner> = Mutex::new(create_hsm_client());
+}
+
+fn create_hsm_client() -> Ed25519LedgerTmAppSigner {


It looks like this is not used anywhere?

liamsi · 2019-02-19T13:54:37Z

src/ledgertm.rs

+use signatory_ledger_tm::Ed25519LedgerTmAppSigner;
+use std::sync::Mutex;
+
+// This instance is only used by CLI commands or tests


Currently not used anywhere?

liamsi · 2019-02-20T13:26:44Z

Thanks a lot @jleni @adrianbrink!

I would suggest to apply the following changes to this PR:

remove all unused / incomplete / boilerplate code:
The commands in src/commands/ledgertm do not provide any functionality yet (help prints about the detect command: "detect connected Ledger devices running the Tendermint app" and detect does only print "This feature will be soon available"), please submit a follow-up PR
revert changes from 562109d:
(error[E0658]: use of unstable library feature 'duration_as_u128' (see issue #50202), also error: Could not compile tmkms.), different concern and not properly formatted (please fix and submit a follow up PR)
remove src/ledgertm.rs: this code is not used anywhere yet and is not useful yet
add a comment about the config options and used defaults (if any)

I've submitted a follow up PR here which contains all your changes: #176, PTAL

@jleni plans to submit a follow up PR which completes this PR and uses completes the commands etc.

liamsi · 2019-02-22T06:07:02Z

Please do use the latest master branch instead of this one. I've removed a bunch of code and fixed other parts in #173. You should still be able to experiment with the ledger integration.

Adrian Brink added 2 commits February 14, 2019 21:39

Ledger integration into KMS

95ce661

This PR adds the ledger integration as a backend to the KMS. There is still more work required to ensure that the Ledger application knows how to correctly decode/encode Tendermint votes.

Run 'cargo fmt'

f38e570

Exclude ledger from test harness

75bdb0b

adrianbrink mentioned this pull request Feb 14, 2019

Ledger backend is not on par with tendermint votes/proposals #171

Closed

liamsi reviewed Feb 15, 2019

View reviewed changes

src/keyring/ed25519/ledger.rs Outdated Show resolved Hide resolved

Remove incorrect comment

9caeec2

jleni mentioned this pull request Feb 15, 2019

KMS Documentation/Tutorial. How to run a Validator with a Ledger device cosmos/cosmos-sdk#3659

Merged

4 tasks

jleni mentioned this pull request Feb 15, 2019

Gaiad cannot reconnect KMS unless restart gaiad cosmos/cosmos-sdk#3190

Closed

4 tasks

Update to latest dependencies

7f0e046

jleni and others added 6 commits February 15, 2019 15:41

Refactoring and adjusting to new ledger-tm library

99b5b27

+ Adding a basic command line

Merge pull request #1 from ZondaX/zondax/ledger-tm

f6a9c8f

Refactoring and adjusting to new ledger-tm library

Upgrading creates + fmt fixes

47289c0

Merge pull request #2 from ZondaX/ledger_integration

ff43eb5

Upgrading crates + cargo fmt fixes

Disabling ledgertm tests until a ledgermock is available

76e054c

Merge pull request #4 from ZondaX/ledger_integration

90e37d5

Disabling ledgertm tests until a ledgermock is available

liamsi reviewed Feb 19, 2019

View reviewed changes

Add better logging to sign requests

562109d

liamsi mentioned this pull request Feb 20, 2019

Review, and followup on ledger integration #176

Merged

liamsi merged commit 562109d into tendermint:master Feb 20, 2019

cwgoes deleted the adrian/ledger_integration branch February 23, 2019 19:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ledger integration into KMS #172

Ledger integration into KMS #172

adrianbrink commented Feb 14, 2019

adrianbrink commented Feb 14, 2019

liamsi Feb 15, 2019 •

edited

Loading

adrianbrink Feb 15, 2019

tarcieri Feb 15, 2019

liamsi Feb 15, 2019

adrianbrink Feb 15, 2019

jleni commented Feb 15, 2019

jleni commented Feb 15, 2019

tarcieri commented Feb 15, 2019

adrianbrink commented Feb 15, 2019

jleni commented Feb 15, 2019 •

edited

Loading

jleni commented Feb 15, 2019

adrianbrink commented Feb 15, 2019

adrianbrink commented Feb 15, 2019

jleni commented Feb 15, 2019

jleni commented Feb 15, 2019

adrianbrink commented Feb 15, 2019

jleni commented Feb 19, 2019

liamsi commented Feb 19, 2019 •

edited

Loading

liamsi left a comment

liamsi Feb 19, 2019

liamsi Feb 19, 2019

liamsi Feb 19, 2019

liamsi Feb 19, 2019

liamsi Feb 19, 2019

liamsi commented Feb 20, 2019 •

edited

Loading

liamsi commented Feb 22, 2019

Ledger integration into KMS #172

Ledger integration into KMS #172

Conversation

adrianbrink commented Feb 14, 2019

adrianbrink commented Feb 14, 2019

liamsi Feb 15, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jleni commented Feb 15, 2019

jleni commented Feb 15, 2019

tarcieri commented Feb 15, 2019

adrianbrink commented Feb 15, 2019

jleni commented Feb 15, 2019 • edited Loading

jleni commented Feb 15, 2019

adrianbrink commented Feb 15, 2019

adrianbrink commented Feb 15, 2019

jleni commented Feb 15, 2019

jleni commented Feb 15, 2019

adrianbrink commented Feb 15, 2019

jleni commented Feb 19, 2019

liamsi commented Feb 19, 2019 • edited Loading

liamsi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

liamsi commented Feb 20, 2019 • edited Loading

liamsi commented Feb 22, 2019

liamsi Feb 15, 2019 •

edited

Loading

jleni commented Feb 15, 2019 •

edited

Loading

liamsi commented Feb 19, 2019 •

edited

Loading

liamsi commented Feb 20, 2019 •

edited

Loading