secure-gate 0.9.0-rc.5

Secure wrappers for secrets with explicit access and mandatory zeroization — no_std-compatible, zero-overhead library with audit-friendly access patterns.
Documentation 
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

//! Owned wrapper types that complete the reveal model (Tier 3 owned consumption).
//!
//! > **Import paths:** `use secure_gate::{InnerSecret, EncodedSecret};`
//!
//! These types provide strong zeroization guarantees for secrets that have been
//! intentionally extracted from a [`RevealSecret`] wrapper:
//!
//! - [`InnerSecret<T>`] — returned by [`RevealSecret::into_inner`] for raw secret values.
//! - [`EncodedSecret`] — returned by zeroizing encoding methods (`to_hex_zeroizing`,
//!   `to_base64url_zeroizing`, `try_to_bech32_zeroizing`, etc.) when the encoded form
//!   itself must remain sensitive.
//!
//! Both types wrap [`zeroize::Zeroizing`] internally, provide redacted `Debug`
//! (`[REDACTED]`), and offer an `into_zeroizing()` escape hatch. They are the
//! idiomatic way to transfer ownership while preserving the crate’s “secrets are
//! radioactive” guarantees.
//!
//! See the [3-Tier Access Model](https://github.com/Slurp9187/secure-gate/blob/main/secure-gate-core/SECURITY.md#3-tier-access-model)
//! and the [“What secure-gate does NOT protect against”](https://github.com/Slurp9187/secure-gate/blob/main/secure-gate-core/SECURITY.md#what-secure-gate-does-not-protect-against)
//! section in `SECURITY.md` for full guidance on when and how to use these types.

#[cfg(feature = "alloc")]
pub use self::encoded_secret::EncodedSecret;

pub use self::inner_secret::InnerSecret;

mod encoded_secret;
mod inner_secret;