Ledger integration into KMS

.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"
     - run:
         name: audit
         command: |

Cargo.toml

@@ -35,15 +35,23 @@ signal-hook = "0.1.7"
 signatory = { version = "0.11", features = ["ed25519"] }
 signatory-dalek = "0.11"
 signatory-yubihsm = { version = "0.11", optional = true }
+signatory-ledger-cosval = { version = "0.11", optional = true }
 subtle-encoding = "0.3"
 tendermint = { version = "0.2", path = "tendermint-rs" }
 
+[patch.crates-io]
+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" }
+
 [dev-dependencies]
 tempfile = "3"
 rand = "0.6"
 
 [features]
-default = ["softsign", "yubihsm"]
+default = ["softsign"]
+ledger = ["signatory-ledger-cosval"]
 softsign = []
 yubihsm = ["signatory-yubihsm/usb"] # USB only for now
 yubihsm-mock = ["yubihsm", "signatory-yubihsm/mockhsm"]

src/config/provider/ledger.rs

@@ -0,0 +1,7 @@
+//! Configuration for ledger-backed signer
+
+/// Ledger signer configuration
+#[derive(Clone, Deserialize, Debug)]
+pub struct LedgerConfig {
+    pub active: bool,
+}

src/config/provider/mod.rs

@@ -1,8 +1,12 @@
+#[cfg(feature = "ledger")]
+pub mod ledger;
 #[cfg(feature = "softsign")]
 pub mod softsign;
 #[cfg(feature = "yubihsm")]
 pub mod yubihsm;
 
+#[cfg(feature = "ledger")]
+use self::ledger::LedgerConfig;
 #[cfg(feature = "softsign")]
 use self::softsign::SoftSignConfig;
 #[cfg(feature = "yubihsm")]
@@ -20,4 +24,8 @@ pub struct ProviderConfig {
     #[cfg(feature = "yubihsm")]
     #[serde(default)]
     pub yubihsm: Vec<YubihsmConfig>,
+
+    #[cfg(feature = "ledger")]
+    #[serde(default)]
+    pub ledger: Vec<LedgerConfig>,
 }

src/keyring/ed25519/ledger.rs

@@ -0,0 +1,32 @@
+//! Ledger-based signer
+
+use signatory::PublicKeyed;
+use signatory_ledger_cosval::Ed25519CosmosAppSigner;
+
+use crate::{
+    config::provider::ledger::LedgerConfig,
+    error::KmsError,
+    keyring::{ed25519::Signer, KeyRing},
+};
+
+/// Label for ed25519-dalek provider
+// TODO: use a non-string type for these, e.g. an enum
+pub const LEDGER_PROVIDER_LABEL: &str = "ledger";
+
+// TODO: Maybe make this depend on the app. This may not matter since the Ledger doesn't hold multiple keys. Could work with HD deriv path.
+pub const LEDGER_ID: &str = "1";
+
+/// Create hardware-backed YubiHSM signer objects from the given configuration
+pub fn init(keyring: &mut KeyRing, _ledger_configs: &[LedgerConfig]) -> Result<(), KmsError> {
+    // TODO: Maybe use the active field from the config.
+    let provider = Ed25519CosmosAppSigner::connect().unwrap();
+    keyring.add(
+        provider.public_key().unwrap(),
+        Signer::new(
+            LEDGER_PROVIDER_LABEL,
+            LEDGER_ID.to_owned(),
+            Box::new(provider),
+        ),
+    )?;
+    Ok(())
+}

src/keyring/ed25519/mod.rs

@@ -1,5 +1,7 @@
 pub use signatory::ed25519::{PublicKey, Seed, PUBLIC_KEY_SIZE};
 
+#[cfg(feature = "ledger")]
+pub mod ledger;
 mod signer;
 #[cfg(feature = "softsign")]
 pub mod softsign;

src/keyring/mod.rs

@@ -12,6 +12,8 @@ use crate::{
     error::{KmsError, KmsErrorKind::*},
 };
 
+#[cfg(feature = "ledger")]
+use self::ed25519::ledger;
 #[cfg(feature = "yubihsm")]
 use self::ed25519::yubihsm;
 use self::ed25519::{softsign, Signer};
@@ -42,6 +44,9 @@ impl KeyRing {
         #[cfg(feature = "yubihsm")]
         yubihsm::init(&mut keyring, &config.yubihsm)?;
 
+        #[cfg(feature = "ledger")]
+        ledger::init(&mut keyring, &config.ledger)?;
+
         if keyring.0.is_empty() {
             fail!(ConfigError, "no signing keys configured!")
         } else {
@@ -106,6 +111,7 @@ impl KeyRing {
                 }
             }
         };
+        debug!("Successfully got signer and now trying to sign message");
 
         signer.sign(msg)
     }

src/ledger.rs

@@ -0,0 +1,15 @@
+use std::sync::Mutex;
+
+use signatory_ledger_cosval::Ed25519CosmosAppSigner;
+
+lazy_static! {
+    static ref HSM_CLIENT: Mutex<Ed25519CosmosAppSigner> = Mutex::new(create_hsm_client());
+}
+
+// pub fn get_hsm_client() -> MutexGuard<'static, Ed25519CosmosAppSigner> {
+//     HSM_CLIENT.lock().unwrap()
+// }
+
+fn create_hsm_client() -> Ed25519CosmosAppSigner {
+    Ed25519CosmosAppSigner::connect().unwrap()
+}

src/lib.rs

@@ -29,6 +29,8 @@ extern crate sha2;
 extern crate signal_hook;
 extern crate signatory;
 extern crate signatory_dalek;
+#[cfg(feature = "ledger")]
+extern crate signatory_ledger_cosval;
 #[cfg(feature = "yubihsm")]
 extern crate signatory_yubihsm;
 extern crate subtle_encoding;
@@ -42,6 +44,8 @@ mod client;
 mod commands;
 mod config;
 mod keyring;
+#[cfg(feature = "ledger")]
+mod ledger;
 mod rpc;
 mod session;
 mod unix_connection;