Skip to content

Use encrypted for windows to store and fetch local key. #438

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.

Sign up for GitHub

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
Zhidong Peng (ZhidongPeng) merged 3 commits into from
Oct 14, 2026
Merged

Use encrypted for windows to store and fetch local key. #438

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
45bde09
Use encrypted for windows to store and fetch local key.
ZhidongPeng Oct 12, 2026
5aca408
Merge branch 'dev' into dpapi
ZhidongPeng Oct 14, 2026
3fb8c92
Merge branch 'dev' into dpapi
ZhidongPeng Oct 14, 2026
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
84 changes: 14 additions & 70 deletions proxy_agent/src/key_keeper.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -725,7 +725,7 @@ impl KeyKeeper {
async fn try_fetch_local_key(&self, key_guid: &Option<String>) -> bool {
if let Some(guid) = key_guid {
// key latched before and search the key locally first
match Self::fetch_key(&self.key_dir, guid) {
match Self::fetch_local_key(&self.key_dir, guid) {
Ok(key) => {
if let Err(e) = self.update_key_to_shared_state(key.clone()).await {
logger::write_warning(format!("Failed to update key: {e}"));
Expand Down Expand Up @@ -770,7 +770,7 @@ impl KeyKeeper {

// persist the new key to local disk
let guid = key.guid.to_string();
if let Err(e) = Self::store_key(&self.key_dir, &key) {
if let Err(e) = Self::store_local_key(&self.key_dir, &key) {
self.update_status_message(format!("Failed to save key details to file: {e:?}"), true)
.await;
return false;
Expand All @@ -780,7 +780,7 @@ impl KeyKeeper {
));

// double check the key details saved correctly to local disk
if let Err(e) = Self::check_key(&self.key_dir, &key) {
if let Err(e) = Self::check_local_key(&self.key_dir, &key) {
self.update_status_message(
format!("Failed to check the key '{guid}' details saved locally: {e:?}."),
true,
Expand Down Expand Up @@ -968,7 +968,10 @@ impl KeyKeeper {
previous_message.is_none_or(|previous| previous != current_message)
}

fn store_local_key(key_dir: &Path, key: &Key, encrypted: bool) -> Result<()> {
fn store_local_key(key_dir: &Path, key: &Key) -> Result<()> {
// determine if the key should be stored encrypted based on the platform
let encrypted = cfg!(windows);

let guid = key.guid.to_string();
let mut key_file = key_dir.to_path_buf().join(guid);
if encrypted {
Expand Down Expand Up @@ -1017,19 +1020,8 @@ impl KeyKeeper {
}
}

fn store_key(key_dir: &Path, key: &Key) -> Result<()> {
#[cfg(windows)]
{
// save the key to encrypted file
Self::store_local_key(key_dir, key, true)
}
#[cfg(not(windows))]
{
Self::store_local_key(key_dir, key, false)
}
}

fn fetch_local_key(key_dir: &Path, key_guid: &str, encrypted: bool) -> Result<Key> {
fn fetch_local_key(key_dir: &Path, key_guid: &str) -> Result<Key> {
let encrypted = cfg!(windows);
let mut key_file = key_dir.join(key_guid);
if encrypted {
key_file.set_extension("encrypted");
Expand Down Expand Up @@ -1071,37 +1063,11 @@ impl KeyKeeper {
})
}

fn fetch_key(key_dir: &Path, key_guid: &str) -> Result<Key> {
// fetch encrypted key file first
match Self::fetch_local_key(key_dir, key_guid, true) {
Ok(key) => Ok(key),
Err(_e) => {
#[cfg(windows)]
{
logger::write_information(format!(
"Failed to fetch .encrypted file with error: {_e}. Fallback to fetch .key file for windows platform."
));
}

// fallback to fetch key file
let local_key = Self::fetch_local_key(key_dir, key_guid, false)?;

#[cfg(windows)]
{
// re-save the key to encrypted file for windows platform
Self::store_local_key(key_dir, &local_key, true)?;
}

Ok(local_key)
}
}
}

// key was saved locally correctly before
// check the key file found and its guid and key value are corrected
fn check_local_key(key_dir: &Path, key: &Key, encrypted: bool) -> Result<()> {
fn check_local_key(key_dir: &Path, key: &Key) -> Result<()> {
let guid = key.guid.to_string();
let local_key = Self::fetch_local_key(key_dir, &guid, encrypted)?;
let local_key = Self::fetch_local_key(key_dir, &guid)?;

if local_key.guid == key.guid && local_key.key == key.key {
Ok(())
Expand All @@ -1115,17 +1081,6 @@ impl KeyKeeper {
}
}

fn check_key(key_dir: &Path, key: &Key) -> Result<()> {
#[cfg(windows)]
{
Self::check_local_key(key_dir, key, true)
}
#[cfg(not(windows))]
{
Self::check_local_key(key_dir, key, false)
}
}

/// Stop the key keeper task
async fn stop(&self) {
if let Err(e) = self
Expand Down Expand Up @@ -1226,25 +1181,14 @@ mod tests {
}"#;
let key: Key = serde_json::from_str(key_str).unwrap();

KeyKeeper::store_local_key(&temp_test_path, &key, false).unwrap();
assert!(KeyKeeper::check_local_key(&temp_test_path, &key, false).is_ok());
let local_key = KeyKeeper::fetch_key(&temp_test_path, &key.guid).unwrap();
KeyKeeper::store_local_key(&temp_test_path, &key).unwrap();
assert!(KeyKeeper::check_local_key(&temp_test_path, &key).is_ok());
let local_key = KeyKeeper::fetch_local_key(&temp_test_path, &key.guid).unwrap();
assert_eq!(
key.key, local_key.key,
"Key value should be matched without encrypted."
);

#[cfg(windows)]
{
// test encrypted key for windows platform
assert!(KeyKeeper::check_local_key(&temp_test_path, &key, true).is_ok());
let local_key = KeyKeeper::fetch_key(&temp_test_path, &key.guid).unwrap();
assert_eq!(
key.key, local_key.key,
"Key value should be matched with encrypted."
);
}

_ = fs::remove_dir_all(&temp_test_path);
}

Expand Down
Loading