use-secret 0.0.1

Secret classification, masking, and secret-reference primitives for RustUse
Documentation
  • Coverage
  • 36.11%
    26 out of 72 items documented1 out of 28 items with examples
  • Size
  • Source code size: 13.96 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.19 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 2s Average build duration of successful builds.
  • all releases: 2s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • Documentation
  • RustUse/use-security
    1 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • CloudBranch

use-secret

Secret classification, masking, and secret-reference primitives for RustUse.

Experimental

use-secret is experimental while the use-security workspace remains below 0.3.0. Expect small API adjustments during the first release wave.

Example

use use_secret::{MaskedSecret, SecretReference, mask_keep_last};

let reference = SecretReference::new("prod/database/password")?;
let masked = MaskedSecret::new("super-secret-token");

assert_eq!(reference.as_str(), "prod/database/password");
assert_eq!(mask_keep_last("abcdef", 2), "****ef");
assert_eq!(format!("{masked:?}"), "MaskedSecret(\"<redacted>\")");
# Ok::<(), use_secret::SecretTextError>(())

Scope

  • Secret kind, provider, scope, sensitivity, and rotation labels.
  • Secret names and references.
  • Simple masking helpers and redacted secret wrappers.

Non-goals

  • Secret generation.
  • Secret storage, encryption, retrieval, or synchronization.
  • Secret scanning or pattern classification beyond local metadata.

License

Licensed under either of the following, at your option:

  • Apache License, Version 2.0
  • MIT license