1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
use crate::{
macros::{impl_choose_int, impl_sealed_trait_for_uint},
types::NumericalZeroSizedType,
};
use core::{
cmp::PartialOrd,
fmt::{Debug, Display},
hash::Hash,
ops::{Add, AddAssign},
};
use typenum::{IsLessOrEqual, Sum, True, Unsigned, U0, U1};
/// A trait for safely exposing secrets with a limited exposure count.
///
/// The `ExposeSecret` trait provides a mechanism to progressively expose a secret
/// value in a controlled manner, with an invariant lifetime and compile-time guarantees.
/// It allows for limiting the exposure of a secret to a maximum count (`MEC`).
/// The exposure count (`EC`) is tracked at compile time to ensure that it does not exceed the specified maximum count.
///
/// # Type Parameters
/// - `'max`: A lifetime parameter indicating the lifetime of the value of the type that implements this trait.
/// - `T`: The type of the secret being exposed.
/// - `MEC`: A type-level unsigned integer (with `typenum::Unsigned` trait bound) representing the maximum exposure count.
/// - `EC`: A type-level unsigned integer (with `typenum::Unsigned` trait bound) representing the current exposure count.
pub trait ExposeSecret<'max, T, MEC: Unsigned, EC: Unsigned>: Sized {
/// A wrapper type representing the exposed secret. It is associated with a lifetime `'brand`, indicating the lifetime of the wrapper type, which is strictly a subtype of `'max`,
type Exposed<'brand>
where
'max: 'brand;
/// The `Secret<T, _, _>` with an incremented count (i.e. `EC`) after exposing the secret.
/// It is a new value of a type which implements the same trait, namely, `ExposeSecret` with an incremented exposure count, i.e. the new `EC` = previous `EC` + `1`.
type Next: ExposeSecret<'max, T, MEC, Sum<EC, U1>>
where
EC: Add<U1> + Unsigned + IsLessOrEqual<MEC, Output = True>,
Sum<EC, U1>: Unsigned + IsLessOrEqual<MEC, Output = True> + Add<U1>;
/// Exposes the secret and returns the `Secret<T, _, _>` with an incremented count (i.e. `EC`), along with the result of a provided closure.
/// It is impossible to return `Self::Exposed` associated type out from the closure `scope`.
///
/// # Parameters
/// - `self`.
/// - `scope`: A closure (of the type given by the type parameter `ClosureType`) that takes the exposed secret, of type `Exposed<'brand>` and returns a result, of type `ReturnType`.
///
/// Returns `(Self::Next, ReturnType)`
fn expose_secret<ReturnType, ClosureType>(self, scope: ClosureType) -> (Self::Next, ReturnType)
where
for<'brand> ClosureType: FnOnce(Self::Exposed<'brand>) -> ReturnType,
EC: Add<U1> + IsLessOrEqual<MEC, Output = True>,
Sum<EC, U1>: Unsigned + Add<U1> + IsLessOrEqual<MEC, Output = True>;
}
#[cfg(feature = "cloneable-secret")]
pub use self::cloneable_secret::CloneableSecret;
#[cfg(feature = "debug-secret")]
pub use self::debug_secret::DebugSecret;
#[cfg(feature = "cloneable-secret")]
mod cloneable_secret {
//! Traits and implementations related to cloneable secrets.
use core::clone::Clone;
#[cfg(feature = "zeroize")]
use zeroize::Zeroize;
/// A trait for cloneable secrets.
///
/// This trait extends the standard `Clone` trait for types that represent secrets,
/// allowing them to be cloned.
#[cfg(feature = "zeroize")]
pub trait CloneableSecret: Clone + Zeroize {}
/// A trait for cloneable secrets.
///
/// This trait extends the standard `Clone` trait for types that represent secrets,
/// allowing them to be cloned.
#[cfg(not(feature = "zeroize"))]
pub trait CloneableSecret: Clone {}
impl<
#[cfg(feature = "zeroize")] T: Clone + Zeroize,
#[cfg(not(feature = "zeroize"))] T: Clone,
const N: usize,
> CloneableSecret for [T; N]
{
}
#[cfg(feature = "alloc")]
use alloc::{string::String, vec::Vec};
#[cfg(feature = "alloc")]
impl CloneableSecret for String {}
#[cfg(feature = "alloc")]
impl<
#[cfg(feature = "zeroize")] T: Clone + Zeroize,
#[cfg(not(feature = "zeroize"))] T: Clone,
> CloneableSecret for Vec<T>
{
}
crate::macros::impl_cloneable_secret_for_numbers!(
i8, i16, i32, i64, i128, isize, u8, u16, u32, u64, u128, usize, f32, f64
);
}
#[cfg(feature = "debug-secret")]
mod debug_secret {
use core::fmt::Debug;
#[cfg(feature = "zeroize")]
use zeroize::Zeroize;
/// A trait for debuggable secrets.
///
/// This trait extends the standard `Debug` trait for types that represent secrets,
/// allowing them to be formatted for debugging purposes.
#[cfg(feature = "zeroize")]
pub trait DebugSecret: Debug + Zeroize {
/// Formats the secret as "`[REDACTED]`".
fn debug_secret(f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
f.write_str("[REDACTED]")
}
}
/// A trait for debuggable secrets.
///
/// This trait extends the standard `Debug` trait for types that represent secrets,
/// allowing them to be formatted for debugging purposes.
#[cfg(not(feature = "zeroize"))]
pub trait DebugSecret: Debug {
/// Formats the secret as "`[REDACTED]`".
fn debug_secret(f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
f.write_str("[REDACTED]")
}
}
impl<
#[cfg(feature = "zeroize")] T: Debug + Zeroize,
#[cfg(not(feature = "zeroize"))] T: Debug,
const N: usize,
> DebugSecret for [T; N]
{
}
#[cfg(feature = "alloc")]
use alloc::{string::String, vec::Vec};
#[cfg(feature = "alloc")]
impl DebugSecret for String {}
#[cfg(feature = "alloc")]
impl<
#[cfg(feature = "zeroize")] T: Debug + Zeroize,
#[cfg(not(feature = "zeroize"))] T: Debug,
> DebugSecret for Vec<T>
{
}
crate::macros::impl_debug_secret_for_numbers!(
i8, i16, i32, i64, i128, isize, u8, u16, u32, u64, u128, usize, f32, f64
);
}
impl_sealed_trait_for_uint!(u8, u16, u32, u64, u128);
/// A trait for types that can choose the minimally representable unsigned integer.
pub trait ChooseMinimallyRepresentableUInt: __private::SealedTrait {
/// The Rust's primitive unsigned integer type that is minimally representable of the unsigned integer represented at the type level by `Self`.
/// e.g. If `Self` is `typenum::consts::U69`, then `Self::Output` is `u8`.
type Output: AddAssign
+ Add<Self::Output, Output = Self::Output>
+ PartialOrd
+ Debug
+ Display
+ Copy
+ Eq
+ Ord
+ PartialOrd
+ Clone
+ Hash
+ Default;
/// Currently, a placeholder for future feature of this crate. Safe to put a placeholder here because this is a 'Sealed' trait.
type AtomicOutput;
/// The additive identity of the type `Self::Output`, e.g. `0_usize`, `0_u32`.
const ZERO: Self::Output;
/// The multiplicative identity of the type `Self::Output`, e.g. `1_usize`, `1_u32`.
const ONE: Self::Output;
/// A convenient method to convert the unsigned integer represented at the type level by `Self` to a value of type `Self::Output`.
/// e.g. converting from `typenum::consts::U69` to `69_u8`.
fn cast_unsigned_to_self_type<T: Unsigned>(_: __private::SealedToken) -> Self::Output;
}
/// A trait for types that can be converted to their atomic representation.
/// Currently, a placeholder for future feature of this crate. Safe to put a placeholder here because this is a 'Sealed' trait.
pub trait AsAtomic: __private::SealedTrait {
type Output;
}
pub(crate) mod __private {
pub struct SealedToken {}
pub trait SealedTrait {}
}
#[cfg(target_pointer_width = "32")]
impl_choose_int! {
B00 => u8;
B01 => u8;
B02 => u8;
B03 => u8;
B04 => u8;
B05 => u8;
B06 => u8;
B07 => u8;
B10 => u16;
B11 => u16;
B12 => u16;
B13 => u16;
B14 => u16;
B15 => u16;
B16 => u16;
B17 => u16;
B20 => u32;
B21 => u32;
B22 => u32;
B23 => u32;
B24 => u32;
B25 => u32;
B26 => u32;
B27 => u32;
B30 => u32;
B31 => u32;
B32 => u32;
B33 => u32;
B34 => u32;
B35 => u32;
B36 => u32;
B37 => u32;
}
#[cfg(target_pointer_width = "64")]
impl_choose_int! {
B00 => u8;
B01 => u8;
B02 => u8;
B03 => u8;
B04 => u8;
B05 => u8;
B06 => u8;
B07 => u8;
B10 => u16;
B11 => u16;
B12 => u16;
B13 => u16;
B14 => u16;
B15 => u16;
B16 => u16;
B17 => u16;
B20 => u32;
B21 => u32;
B22 => u32;
B23 => u32;
B24 => u32;
B25 => u32;
B26 => u32;
B27 => u32;
B30 => u32;
B31 => u32;
B32 => u32;
B33 => u32;
B34 => u32;
B35 => u32;
B36 => u32;
B37 => u32;
B40 => u64;
B41 => u64;
B42 => u64;
B43 => u64;
B44 => u64;
B45 => u64;
B46 => u64;
B47 => u64;
B50 => u64;
B51 => u64;
B52 => u64;
B53 => u64;
B54 => u64;
B55 => u64;
B56 => u64;
B57 => u64;
B60 => u64;
B61 => u64;
B62 => u64;
B63 => u64;
B64 => u64;
B65 => u64;
B66 => u64;
B67 => u64;
B70 => u64;
B71 => u64;
B72 => u64;
B73 => u64;
B74 => u64;
B75 => u64;
B76 => u64;
B77 => u64;
}
impl __private::SealedTrait for U0 {}
impl ChooseMinimallyRepresentableUInt for U0 {
type Output = NumericalZeroSizedType;
type AtomicOutput = NumericalZeroSizedType;
const ZERO: Self::Output = NumericalZeroSizedType {};
const ONE: Self::Output = NumericalZeroSizedType {};
fn cast_unsigned_to_self_type<T: Unsigned>(_: __private::SealedToken) -> Self::Output {
NumericalZeroSizedType {}
}
}
#[cfg(target_has_atomic = "8")]
impl AsAtomic for u8 {
type Output = core::sync::atomic::AtomicU8;
}
#[cfg(target_has_atomic = "16")]
impl AsAtomic for u16 {
type Output = core::sync::atomic::AtomicU16;
}
#[cfg(target_has_atomic = "32")]
impl AsAtomic for u32 {
type Output = core::sync::atomic::AtomicU32;
}
#[cfg(target_has_atomic = "64")]
impl AsAtomic for u64 {
type Output = core::sync::atomic::AtomicU64;
}