-
Notifications
You must be signed in to change notification settings - Fork 215
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Increment wallet key manager index during recovery
Currently, when recovery is performed the key manager index is not incremented as outputs are found. This means that when new transactions are performed the key manager produces previously used spending keys for the new outputs, reusing private keys. We also did not apply the correct script private key to the recovered output. This wasn’t a problem because we are using `Nop` scripts but for any script that requires this key to be correct we would have had a problem. This PR adds the logic that when an output is rewound during recovery that we find the key manager index for the recovered spending key, update the key manager index to one more than the highest index found during recovery and also use this index to apply the correct script private key to the recovered output. This PR also contains a but of neatness refactoring in the Output Manager Service.
- Loading branch information
1 parent
b6e74bb
commit c8113ec
Showing
22 changed files
with
760 additions
and
391 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
222 changes: 222 additions & 0 deletions
222
base_layer/wallet/src/output_manager_service/master_key_manager.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,222 @@ | ||
| // Copyright 2021. The Tari Project | ||
| // | ||
| // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the | ||
| // following conditions are met: | ||
| // | ||
| // 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following | ||
| // disclaimer. | ||
| // | ||
| // 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the | ||
| // following disclaimer in the documentation and/or other materials provided with the distribution. | ||
| // | ||
| // 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote | ||
| // products derived from this software without specific prior written permission. | ||
| // | ||
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, | ||
| // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
| // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
| // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, | ||
| // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE | ||
| // USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
|
|
||
| use crate::{ | ||
| output_manager_service::{ | ||
| error::OutputManagerError, | ||
| handle::PublicRewindKeys, | ||
| storage::database::{KeyManagerState, OutputManagerBackend, OutputManagerDatabase}, | ||
| }, | ||
| types::KeyDigest, | ||
| }; | ||
| use futures::lock::Mutex; | ||
| use log::*; | ||
| use tari_core::transactions::{ | ||
| transaction_protocol::RewindData, | ||
| types::{PrivateKey, PublicKey}, | ||
| }; | ||
| use tari_crypto::{keys::PublicKey as PublicKeyTrait, range_proof::REWIND_USER_MESSAGE_LENGTH}; | ||
| use tari_key_manager::{ | ||
| key_manager::KeyManager, | ||
| mnemonic::{from_secret_key, MnemonicLanguage}, | ||
| }; | ||
|
|
||
| const LOG_TARGET: &str = "wallet::output_manager_service::master_key_manager"; | ||
|
|
||
| const KEY_MANAGER_COINBASE_BRANCH_KEY: &str = "coinbase"; | ||
| const KEY_MANAGER_COINBASE_SCRIPT_BRANCH_KEY: &str = "coinbase_script"; | ||
| const KEY_MANAGER_SCRIPT_BRANCH_KEY: &str = "script"; | ||
| const KEY_MANAGER_RECOVERY_VIEWONLY_BRANCH_KEY: &str = "recovery_viewonly"; | ||
| const KEY_MANAGER_RECOVERY_BLINDING_BRANCH_KEY: &str = "recovery_blinding"; | ||
| const KEY_MANAGER_MAX_SEARCH_DEPTH: u64 = 1_000_000; | ||
|
|
||
| pub(crate) struct MasterKeyManager<TBackend> | ||
| where TBackend: OutputManagerBackend + 'static | ||
| { | ||
| utxo_key_manager: Mutex<KeyManager<PrivateKey, KeyDigest>>, | ||
| utxo_script_key_manager: Mutex<KeyManager<PrivateKey, KeyDigest>>, | ||
| coinbase_key_manager: Mutex<KeyManager<PrivateKey, KeyDigest>>, | ||
| coinbase_script_key_manager: Mutex<KeyManager<PrivateKey, KeyDigest>>, | ||
| rewind_data: RewindData, | ||
| db: OutputManagerDatabase<TBackend>, | ||
| } | ||
|
|
||
| impl<TBackend> MasterKeyManager<TBackend> | ||
| where TBackend: OutputManagerBackend + 'static | ||
| { | ||
| pub async fn new( | ||
| master_secret_key: PrivateKey, | ||
| db: OutputManagerDatabase<TBackend>, | ||
| ) -> Result<Self, OutputManagerError> { | ||
| // Check to see if there is any persisted state. If there is confirm that the provided master secret key matches | ||
| let key_manager_state = match db.get_key_manager_state().await? { | ||
| None => { | ||
| let starting_state = KeyManagerState { | ||
| master_key: master_secret_key, | ||
| branch_seed: "".to_string(), | ||
| primary_key_index: 0, | ||
| }; | ||
| db.set_key_manager_state(starting_state.clone()).await?; | ||
| starting_state | ||
| }, | ||
| Some(km) => { | ||
| if km.master_key != master_secret_key { | ||
| return Err(OutputManagerError::MasterSecretKeyMismatch); | ||
| } | ||
| km | ||
| }, | ||
| }; | ||
|
|
||
| let utxo_key_manager = KeyManager::<PrivateKey, KeyDigest>::from( | ||
| key_manager_state.master_key.clone(), | ||
| key_manager_state.branch_seed, | ||
| key_manager_state.primary_key_index, | ||
| ); | ||
|
|
||
| let utxo_script_key_manager = KeyManager::<PrivateKey, KeyDigest>::from( | ||
| key_manager_state.master_key.clone(), | ||
| KEY_MANAGER_SCRIPT_BRANCH_KEY.to_string(), | ||
| key_manager_state.primary_key_index, | ||
| ); | ||
|
|
||
| let coinbase_key_manager = KeyManager::<PrivateKey, KeyDigest>::from( | ||
| key_manager_state.master_key.clone(), | ||
| KEY_MANAGER_COINBASE_BRANCH_KEY.to_string(), | ||
| 0, | ||
| ); | ||
|
|
||
| let coinbase_script_key_manager = KeyManager::<PrivateKey, KeyDigest>::from( | ||
| key_manager_state.master_key.clone(), | ||
| KEY_MANAGER_COINBASE_SCRIPT_BRANCH_KEY.to_string(), | ||
| 0, | ||
| ); | ||
|
|
||
| let rewind_key_manager = KeyManager::<PrivateKey, KeyDigest>::from( | ||
| key_manager_state.master_key.clone(), | ||
| KEY_MANAGER_RECOVERY_VIEWONLY_BRANCH_KEY.to_string(), | ||
| 0, | ||
| ); | ||
| let rewind_key = rewind_key_manager.derive_key(0)?.k; | ||
|
|
||
| let rewind_blinding_key_manager = KeyManager::<PrivateKey, KeyDigest>::from( | ||
| key_manager_state.master_key, | ||
| KEY_MANAGER_RECOVERY_BLINDING_BRANCH_KEY.to_string(), | ||
| 0, | ||
| ); | ||
| let rewind_blinding_key = rewind_blinding_key_manager.derive_key(0)?.k; | ||
|
|
||
| let rewind_data = RewindData { | ||
| rewind_key, | ||
| rewind_blinding_key, | ||
| proof_message: [0u8; REWIND_USER_MESSAGE_LENGTH], | ||
| }; | ||
|
|
||
| Ok(Self { | ||
| utxo_key_manager: Mutex::new(utxo_key_manager), | ||
| utxo_script_key_manager: Mutex::new(utxo_script_key_manager), | ||
| coinbase_key_manager: Mutex::new(coinbase_key_manager), | ||
| coinbase_script_key_manager: Mutex::new(coinbase_script_key_manager), | ||
| rewind_data, | ||
| db, | ||
| }) | ||
| } | ||
|
|
||
| pub fn rewind_data(&self) -> &RewindData { | ||
| &self.rewind_data | ||
| } | ||
|
|
||
| /// Return the next pair of (spending_key, script_private_key) from the key managers. These will always be generated | ||
| /// in tandem and at corresponding increments | ||
| pub async fn get_next_spend_and_script_key(&self) -> Result<(PrivateKey, PrivateKey), OutputManagerError> { | ||
| let mut km = self.utxo_key_manager.lock().await; | ||
| let key = km.next_key()?; | ||
|
|
||
| let mut skm = self.utxo_script_key_manager.lock().await; | ||
| let script_key = skm.next_key()?; | ||
|
|
||
| self.db.increment_key_index().await?; | ||
| Ok((key.k, script_key.k)) | ||
| } | ||
|
|
||
| pub async fn get_script_key_at_index(&self, index: u64) -> Result<PrivateKey, OutputManagerError> { | ||
| let skm = self.utxo_script_key_manager.lock().await; | ||
| let script_key = skm.derive_key(index)?; | ||
| Ok(script_key.k) | ||
| } | ||
|
|
||
| pub async fn get_coinbase_spend_and_script_key_for_height( | ||
| &self, | ||
| height: u64, | ||
| ) -> Result<(PrivateKey, PrivateKey), OutputManagerError> { | ||
| let km = self.coinbase_key_manager.lock().await; | ||
| let spending_key = km.derive_key(height)?; | ||
|
|
||
| let mut skm = self.coinbase_script_key_manager.lock().await; | ||
| let script_key = skm.next_key()?; | ||
| Ok((spending_key.k, script_key.k)) | ||
| } | ||
|
|
||
| /// Return the Seed words for the current Master Key set in the Key Manager | ||
| pub async fn get_seed_words(&self, language: &MnemonicLanguage) -> Result<Vec<String>, OutputManagerError> { | ||
| Ok(from_secret_key( | ||
| self.utxo_key_manager.lock().await.master_key(), | ||
| language, | ||
| )?) | ||
| } | ||
|
|
||
| /// Return the public rewind keys | ||
| pub fn get_rewind_public_keys(&self) -> PublicRewindKeys { | ||
| PublicRewindKeys { | ||
| rewind_public_key: PublicKey::from_secret_key(&self.rewind_data.rewind_key), | ||
| rewind_blinding_public_key: PublicKey::from_secret_key(&self.rewind_data.rewind_blinding_key), | ||
| } | ||
| } | ||
|
|
||
| /// Search the current key manager key chain to find the index of the specified key. | ||
| pub async fn find_utxo_key_index(&self, key: PrivateKey) -> Result<u64, OutputManagerError> { | ||
| let utxo_key_manager = self.utxo_key_manager.lock().await; | ||
| let current_index = (*utxo_key_manager).key_index(); | ||
|
|
||
| for i in 0u64..current_index + KEY_MANAGER_MAX_SEARCH_DEPTH { | ||
| if (*utxo_key_manager).derive_key(i)?.k == key { | ||
| trace!(target: LOG_TARGET, "Key found in Key Chain at index {}", i); | ||
| return Ok(i); | ||
| } | ||
| } | ||
|
|
||
| Err(OutputManagerError::KeyNotFoundInKeyChain) | ||
| } | ||
|
|
||
| /// If the supplied index is higher than the current UTXO key chain indices then they will be updated. | ||
| pub async fn update_current_index_if_higher(&self, index: u64) -> Result<(), OutputManagerError> { | ||
| let mut utxo_key_manager = self.utxo_key_manager.lock().await; | ||
| let mut utxo_script_key_manager = self.utxo_script_key_manager.lock().await; | ||
| let current_index = (*utxo_key_manager).key_index(); | ||
| if index > current_index { | ||
| (*utxo_key_manager).update_key_index(index); | ||
| (*utxo_script_key_manager).update_key_index(index); | ||
| self.db.set_key_index(index).await?; | ||
| trace!(target: LOG_TARGET, "Updated UTXO Key Index to {}", index); | ||
| } | ||
| Ok(()) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.