|
| 1 | +// This program is free software: you can redistribute it and/or modify |
| 2 | +// it under the terms of the GNU General Public License as published by |
| 3 | +// the Free Software Foundation, either version 3 of the License, or |
| 4 | +// (at your option) any later version. |
| 5 | + |
| 6 | +// This program is distributed in the hope that it will be useful, |
| 7 | +// but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 8 | +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 9 | +// GNU General Public License for more details. |
| 10 | + |
| 11 | +// You should have received a copy of the GNU General Public License |
| 12 | +// along with this program. If not, see <https://www.gnu.org/licenses/>. |
| 13 | + |
| 14 | +use std::convert::TryInto; |
| 15 | + |
| 16 | +use sp_application_crypto::RuntimeAppPublic; |
| 17 | +use sp_core::keccak_256; |
| 18 | +use sp_keystore::{SyncCryptoStore, SyncCryptoStorePtr}; |
| 19 | + |
| 20 | +use beefy_primitives::{ |
| 21 | + crypto::{Public, Signature}, |
| 22 | + KEY_TYPE, |
| 23 | +}; |
| 24 | + |
| 25 | +use crate::error; |
| 26 | + |
| 27 | +/// A BEEFY specific keystore implemented as a `Newtype`. This is basically a |
| 28 | +/// wrapper around [`sp_keystore::SyncCryptoStore`] and allows to customize |
| 29 | +/// common cryptographic functionality. |
| 30 | +pub(crate) struct BeefyKeystore(Option<SyncCryptoStorePtr>); |
| 31 | + |
| 32 | +impl BeefyKeystore { |
| 33 | + /// Check if the keystore contains a private key for one of the public keys |
| 34 | + /// contained in `keys`. A public key with a matching private key is known |
| 35 | + /// as a local authority id. |
| 36 | + /// |
| 37 | + /// Return the public key for which we also do have a private key. If no |
| 38 | + /// matching private key is found, `None` will be returned. |
| 39 | + pub fn authority_id(&self, keys: &[Public]) -> Option<Public> { |
| 40 | + let store = self.0.clone()?; |
| 41 | + |
| 42 | + for key in keys { |
| 43 | + if SyncCryptoStore::has_keys(&*store, &[(key.to_raw_vec(), KEY_TYPE)]) { |
| 44 | + return Some(key.clone()); |
| 45 | + } |
| 46 | + } |
| 47 | + |
| 48 | + None |
| 49 | + } |
| 50 | + |
| 51 | + /// Sign `message` with the `public` key. |
| 52 | + /// |
| 53 | + /// Note that `message` usually will be pre-hashed before being singed. |
| 54 | + /// |
| 55 | + /// Return the message signature or an error in case of failure. |
| 56 | + pub fn sign(&self, public: &Public, message: &[u8]) -> Result<Signature, error::Error> { |
| 57 | + let store = if let Some(store) = self.0.clone() { |
| 58 | + store |
| 59 | + } else { |
| 60 | + return Err(error::Error::Keystore("no Keystore".to_string())); |
| 61 | + }; |
| 62 | + |
| 63 | + let msg = keccak_256(message); |
| 64 | + let public = public.as_ref(); |
| 65 | + |
| 66 | + let sig = SyncCryptoStore::ecdsa_sign_prehashed(&*store, KEY_TYPE, public, &msg) |
| 67 | + .map_err(|e| error::Error::Keystore(e.to_string()))? |
| 68 | + .ok_or_else(|| error::Error::Signature("ecdsa_sign_prehashed() failed".to_string()))?; |
| 69 | + |
| 70 | + // check that `sig` has the expected result type |
| 71 | + let sig = sig |
| 72 | + .clone() |
| 73 | + .try_into() |
| 74 | + .map_err(|_| error::Error::Signature(format!("invalid signature {:?} for key {:?}", sig, public)))?; |
| 75 | + |
| 76 | + Ok(sig) |
| 77 | + } |
| 78 | + |
| 79 | + /// Use the `public` key to verify that `sig` is a valid signature for `message`. |
| 80 | + /// |
| 81 | + /// Return `true` if the signature is authentic, `false` otherwise. |
| 82 | + pub fn verify(public: &Public, sig: &Signature, message: &[u8]) -> bool { |
| 83 | + let msg = keccak_256(message); |
| 84 | + let sig = sig.as_ref(); |
| 85 | + let public = public.as_ref(); |
| 86 | + |
| 87 | + sp_core::ecdsa::Pair::verify_prehashed(sig, &msg, public) |
| 88 | + } |
| 89 | +} |
| 90 | + |
| 91 | +impl From<Option<SyncCryptoStorePtr>> for BeefyKeystore { |
| 92 | + fn from(store: Option<SyncCryptoStorePtr>) -> BeefyKeystore { |
| 93 | + BeefyKeystore(store) |
| 94 | + } |
| 95 | +} |
| 96 | + |
| 97 | +#[cfg(test)] |
| 98 | +mod tests { |
| 99 | + #![allow(clippy::unit_cmp)] |
| 100 | + |
| 101 | + use sp_core::{keccak_256, Pair}; |
| 102 | + use sp_keystore::{testing::KeyStore, SyncCryptoStore, SyncCryptoStorePtr}; |
| 103 | + |
| 104 | + use beefy_primitives::{crypto, KEY_TYPE}; |
| 105 | + |
| 106 | + use super::BeefyKeystore; |
| 107 | + use crate::error::Error; |
| 108 | + |
| 109 | + #[test] |
| 110 | + fn authority_id_works() { |
| 111 | + let store: SyncCryptoStorePtr = KeyStore::new().into(); |
| 112 | + |
| 113 | + let alice = crypto::Pair::from_string("//Alice", None).unwrap(); |
| 114 | + let _ = SyncCryptoStore::insert_unknown(&*store, KEY_TYPE, "//Alice", alice.public().as_ref()).unwrap(); |
| 115 | + |
| 116 | + let bob = crypto::Pair::from_string("//Bob", None).unwrap(); |
| 117 | + let charlie = crypto::Pair::from_string("//Charlie", None).unwrap(); |
| 118 | + |
| 119 | + let store: BeefyKeystore = Some(store).into(); |
| 120 | + |
| 121 | + let mut keys = vec![bob.public(), charlie.public()]; |
| 122 | + |
| 123 | + let id = store.authority_id(keys.as_slice()); |
| 124 | + assert!(id.is_none()); |
| 125 | + |
| 126 | + keys.push(alice.public()); |
| 127 | + |
| 128 | + let id = store.authority_id(keys.as_slice()).unwrap(); |
| 129 | + assert_eq!(id, alice.public()); |
| 130 | + } |
| 131 | + |
| 132 | + #[test] |
| 133 | + fn sign_works() { |
| 134 | + let store: SyncCryptoStorePtr = KeyStore::new().into(); |
| 135 | + |
| 136 | + let suri = "//Alice"; |
| 137 | + let pair = sp_core::ecdsa::Pair::from_string(suri, None).unwrap(); |
| 138 | + |
| 139 | + let res = SyncCryptoStore::insert_unknown(&*store, KEY_TYPE, suri, pair.public().as_ref()).unwrap(); |
| 140 | + assert_eq!((), res); |
| 141 | + |
| 142 | + let beefy_store: BeefyKeystore = Some(store.clone()).into(); |
| 143 | + |
| 144 | + let msg = b"are you involved or commited?"; |
| 145 | + let sig1 = beefy_store.sign(&pair.public().into(), msg).unwrap(); |
| 146 | + |
| 147 | + let msg = keccak_256(b"are you involved or commited?"); |
| 148 | + let sig2 = SyncCryptoStore::ecdsa_sign_prehashed(&*store, KEY_TYPE, &pair.public(), &msg) |
| 149 | + .unwrap() |
| 150 | + .unwrap(); |
| 151 | + |
| 152 | + assert_eq!(sig1, sig2.into()); |
| 153 | + } |
| 154 | + |
| 155 | + #[test] |
| 156 | + fn sign_error() { |
| 157 | + let store: SyncCryptoStorePtr = KeyStore::new().into(); |
| 158 | + |
| 159 | + let bob = crypto::Pair::from_string("//Bob", None).unwrap(); |
| 160 | + let res = SyncCryptoStore::insert_unknown(&*store, KEY_TYPE, "//Bob", bob.public().as_ref()).unwrap(); |
| 161 | + assert_eq!((), res); |
| 162 | + |
| 163 | + let alice = crypto::Pair::from_string("//Alice", None).unwrap(); |
| 164 | + |
| 165 | + let store: BeefyKeystore = Some(store).into(); |
| 166 | + |
| 167 | + let msg = b"are you involved or commited?"; |
| 168 | + let sig = store.sign(&alice.public(), msg).err().unwrap(); |
| 169 | + let err = Error::Signature("ecdsa_sign_prehashed() failed".to_string()); |
| 170 | + assert_eq!(sig, err); |
| 171 | + } |
| 172 | + |
| 173 | + #[test] |
| 174 | + fn sign_no_keystore() { |
| 175 | + let store: BeefyKeystore = None.into(); |
| 176 | + |
| 177 | + let alice = crypto::Pair::from_string("//Alice", None).unwrap(); |
| 178 | + let msg = b"are you involved or commited"; |
| 179 | + |
| 180 | + let sig = store.sign(&alice.public(), msg).err().unwrap(); |
| 181 | + let err = Error::Keystore("no Keystore".to_string()); |
| 182 | + assert_eq!(sig, err); |
| 183 | + } |
| 184 | + |
| 185 | + #[test] |
| 186 | + fn verify_works() { |
| 187 | + let store: SyncCryptoStorePtr = KeyStore::new().into(); |
| 188 | + |
| 189 | + let suri = "//Alice"; |
| 190 | + let pair = crypto::Pair::from_string(suri, None).unwrap(); |
| 191 | + |
| 192 | + let res = SyncCryptoStore::insert_unknown(&*store, KEY_TYPE, suri, pair.public().as_ref()).unwrap(); |
| 193 | + assert_eq!((), res); |
| 194 | + |
| 195 | + let store: BeefyKeystore = Some(store).into(); |
| 196 | + |
| 197 | + // `msg` and `sig` match |
| 198 | + let msg = b"are you involved or commited?"; |
| 199 | + let sig = store.sign(&pair.public(), msg).unwrap(); |
| 200 | + assert!(BeefyKeystore::verify(&pair.public(), &sig, msg)); |
| 201 | + |
| 202 | + // `msg and `sig` don't match |
| 203 | + let msg = b"you are just involved"; |
| 204 | + assert!(!BeefyKeystore::verify(&pair.public(), &sig, msg)); |
| 205 | + } |
| 206 | +} |
0 commit comments