Skip to content

Use KeyObfuscator in VssStore. #378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -477,15 +477,19 @@ impl NodeBuilder {

let vss_seed_bytes: [u8; 32] = vss_xprv.private_key.secret_bytes();

let vss_store = Arc::new(VssStore::new(vss_url, store_id, vss_seed_bytes, header_provider));
let vss_store =
VssStore::new(vss_url, store_id, vss_seed_bytes, header_provider).map_err(|e| {
log_error!(logger, "Failed to setup VssStore: {}", e);
BuildError::KVStoreSetupFailed
})?;
build_with_store_internal(
config,
self.chain_data_source_config.as_ref(),
self.gossip_source_config.as_ref(),
self.liquidity_source_config.as_ref(),
seed_bytes,
logger,
vss_store,
Arc::new(vss_store),
)
}

Expand Down
52 changes: 37 additions & 15 deletions src/io/vss_store.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use crate::io::utils::check_namespace_key_validity;
use bitcoin::hashes::{sha256, Hash, HashEngine, Hmac, HmacEngine};
use lightning::io::{self, Error, ErrorKind};
use lightning::util::persist::KVStore;
use prost::Message;
use rand::RngCore;
#[cfg(test)]
use std::panic::RefUnwindSafe;
use std::sync::Arc;
use std::time::Duration;

use crate::io::utils::check_namespace_key_validity;
use lightning::util::persist::KVStore;
use prost::Message;
use rand::RngCore;
use tokio::runtime::Runtime;
use vss_client::client::VssClient;
use vss_client::error::VssError;
Expand All @@ -23,6 +23,7 @@ use vss_client::types::{
DeleteObjectRequest, GetObjectRequest, KeyValue, ListKeyVersionsRequest, PutObjectRequest,
Storable,
};
use vss_client::util::key_obfuscator::KeyObfuscator;
use vss_client::util::retry::{
ExponentialBackoffRetryPolicy, FilteredRetryPolicy, JitteredRetryPolicy,
MaxAttemptsRetryPolicy, MaxTotalDelayRetryPolicy, RetryPolicy,
Expand All @@ -42,14 +43,18 @@ pub struct VssStore {
store_id: String,
runtime: Runtime,
storable_builder: StorableBuilder<RandEntropySource>,
key_obfuscator: KeyObfuscator,
}

impl VssStore {
pub(crate) fn new(
base_url: String, store_id: String, data_encryption_key: [u8; 32],
base_url: String, store_id: String, vss_seed: [u8; 32],
header_provider: Arc<dyn VssHeaderProvider>,
) -> Self {
let runtime = tokio::runtime::Builder::new_multi_thread().enable_all().build().unwrap();
) -> io::Result<Self> {
let runtime = tokio::runtime::Builder::new_multi_thread().enable_all().build()?;
let (data_encryption_key, obfuscation_master_key) =
derive_data_encryption_and_obfuscation_keys(&vss_seed);
let key_obfuscator = KeyObfuscator::new(obfuscation_master_key);
let storable_builder = StorableBuilder::new(data_encryption_key, RandEntropySource);
let retry_policy = ExponentialBackoffRetryPolicy::new(Duration::from_millis(10))
.with_max_attempts(10)
Expand All @@ -65,24 +70,28 @@ impl VssStore {
}) as _);

let client = VssClient::new_with_headers(base_url, retry_policy, header_provider);
Self { client, store_id, runtime, storable_builder }
Ok(Self { client, store_id, runtime, storable_builder, key_obfuscator })
}

fn build_key(
&self, primary_namespace: &str, secondary_namespace: &str, key: &str,
) -> io::Result<String> {
let obfuscated_key = self.key_obfuscator.obfuscate(key);
if primary_namespace.is_empty() {
Ok(key.to_string())
Ok(obfuscated_key)
} else {
Ok(format!("{}#{}#{}", primary_namespace, secondary_namespace, key))
Ok(format!("{}#{}#{}", primary_namespace, secondary_namespace, obfuscated_key))
}
}

fn extract_key(&self, unified_key: &str) -> io::Result<String> {
let mut parts = unified_key.splitn(3, '#');
let (_primary_namespace, _secondary_namespace) = (parts.next(), parts.next());
match parts.next() {
Some(actual_key) => Ok(actual_key.to_string()),
Some(obfuscated_key) => {
let actual_key = self.key_obfuscator.deobfuscate(obfuscated_key)?;
Ok(actual_key)
},
None => Err(Error::new(ErrorKind::InvalidData, "Invalid key format")),
}
}
Expand Down Expand Up @@ -224,6 +233,19 @@ impl KVStore for VssStore {
}
}

fn derive_data_encryption_and_obfuscation_keys(vss_seed: &[u8; 32]) -> ([u8; 32], [u8; 32]) {
let hkdf = |initial_key_material: &[u8], salt: &[u8]| -> [u8; 32] {
let mut engine = HmacEngine::<sha256::Hash>::new(salt);
engine.input(initial_key_material);
Hmac::from_engine(engine).to_byte_array()
};

let prk = hkdf(vss_seed, b"pseudo_random_key");
let k1 = hkdf(&prk, b"data_encryption_key");
let k2 = hkdf(&prk, &[&k1[..], b"obfuscation_key"].concat());
(k1, k2)
}

/// A source for generating entropy/randomness using [`rand`].
pub(crate) struct RandEntropySource;

Expand Down Expand Up @@ -251,11 +273,11 @@ mod tests {
let vss_base_url = std::env::var("TEST_VSS_BASE_URL").unwrap();
let mut rng = thread_rng();
let rand_store_id: String = (0..7).map(|_| rng.sample(Alphanumeric) as char).collect();
let mut data_encryption_key = [0u8; 32];
rng.fill_bytes(&mut data_encryption_key);
let mut vss_seed = [0u8; 32];
rng.fill_bytes(&mut vss_seed);
let header_provider = Arc::new(FixedHeaders::new(HashMap::new()));
let vss_store =
VssStore::new(vss_base_url, rand_store_id, data_encryption_key, header_provider);
VssStore::new(vss_base_url, rand_store_id, vss_seed, header_provider).unwrap();

do_read_write_remove_list_persist(&vss_store);
}
Expand Down
Loading