Skip to content
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

finally resolved the problem of not zeroizing when EC < MEC #9

Merged
merged 1 commit into from
Nov 25, 2023
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
38 changes: 16 additions & 22 deletions src/secret.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use core::{
marker::PhantomData,
mem::ManuallyDrop,
mem::{forget, ManuallyDrop},
ops::{Add, Deref, Drop},
};

Expand Down Expand Up @@ -58,18 +58,14 @@ impl<
for<'brand> ClosureType: FnOnce(ExposedSecret<'brand, &'brand T>) -> ReturnType,
{
let returned_value = scope(ExposedSecret(&self.0, PhantomData));
(
Secret(
// SAFETY: Since compile error prevents constructing a `Secret` with `EC` > `MEC`,
// `zeroize()` is only called when `Secret` is maximally exposed
// and it is not possible to call `expose_secret(...)`
// when `Secret` is maximally exposed to access **private** `self.0` field,
// therefore, this is safe.
ManuallyDrop::new(unsafe { ManuallyDrop::take(&mut self.0) }),
PhantomData,
),
returned_value,
)
// SAFETY: Since compile error prevents constructing a `Secret` with `EC` > `MEC`,
// `zeroize()` is only called when `Secret` is maximally exposed
// and it is not possible to call `expose_secret(...)`
// when `Secret` is maximally exposed to access **private** `self.0` field,
// therefore, this is safe.
let inner = ManuallyDrop::new(unsafe { ManuallyDrop::take(&mut self.0) });
forget(self);
(Secret(inner, PhantomData), returned_value)
}
}

Expand All @@ -90,15 +86,13 @@ where
{
#[inline(always)]
fn drop(&mut self) {
if EC::U64 == MEC::U64 {
// SAFETY: Since compile error prevents constructing a `Secret` with `EC` > `MEC`,
// `zeroize()` is only called when `Secret` is maximally exposed
// and it is not possible to call `expose_secret(...)`
// when `Secret` is maximally exposed to access **private** `self.0` field,
// therefore, this is safe.
let mut inner = unsafe { ManuallyDrop::take(&mut self.0) };
inner.zeroize();
}
// SAFETY: Since compile error prevents constructing a `Secret` with `EC` > `MEC`,
// `zeroize()` is only called when `Secret` is maximally exposed
// and it is not possible to call `expose_secret(...)`
// when `Secret` is maximally exposed to access **private** `self.0` field,
// therefore, this is safe.
let mut inner = unsafe { ManuallyDrop::take(&mut self.0) };
inner.zeroize();
}
}

Expand Down
48 changes: 48 additions & 0 deletions tests/extern_bin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,58 @@ fn test_expose_secret_extern() {
assert_eq!(returned_value.inner, "MySecret".to_owned());
}

#[test]
fn test_expose_secret_with_wrapper() {
use typenum::U50;
use zeroize::Zeroize;

#[derive(Clone, Debug, PartialEq)]
struct SecretString(String);

impl Zeroize for SecretString {
fn zeroize(&mut self) {
self.0.zeroize();
}
}

let secret = SecretString("MySecret".to_owned());
let new_secret: Secret<_, U50, _> = Secret::new(secret);
let (new_secret, returned_value) = new_secret.expose_secret(|exposed_secret| {
let returned_value = UseSecret::new((*exposed_secret).to_owned());
returned_value
});
assert_eq!(returned_value.inner, SecretString("MySecret".to_owned()));

let (new_secret, returned_value) = new_secret.expose_secret(|exposed_secret| {
let returned_value = UseSecret::new((*exposed_secret).to_owned());
returned_value
});
assert_eq!(returned_value.inner, SecretString("MySecret".to_owned()));

let (new_secret, returned_value) = new_secret.expose_secret(|exposed_secret| {
let returned_value = UseSecret::new((*exposed_secret).to_owned());
returned_value
});
assert_eq!(returned_value.inner, SecretString("MySecret".to_owned()));

let (new_secret, returned_value) = new_secret.expose_secret(|exposed_secret| {
let returned_value = UseSecret::new((*exposed_secret).to_owned());
returned_value
});
assert_eq!(returned_value.inner, SecretString("MySecret".to_owned()));

let (_new_secret, returned_value) = new_secret.expose_secret(|exposed_secret| {
let returned_value = UseSecret::new((*exposed_secret).to_owned());
returned_value
});
assert_eq!(returned_value.inner, SecretString("MySecret".to_owned()));
}

// #[test]
// fn test_expose_secret_in_a_loop() {
// use common::{self, UseSecret};
// use sosecrets_rs::traits::ExposeSecret;
// use typenum::U50;

// let secret = "MySecret".to_owned();
// let new_secret: Secret<_, U50, _> = Secret::new(secret);
Expand Down
Loading