Skip to main content

EncryptedPathCodec

Struct EncryptedPathCodec 

Source
pub struct EncryptedPathCodec { /* private fields */ }
Expand description

Encrypting codec: shadow paths are opaque v1.<base64url> blobs.

Real paths are AES-256-GCM encrypted with a server-held key; the ciphertext carries a random 96-bit nonce and a 128-bit auth tag, so the shadow is unreadable and unforgeable (tampering fails the tag check at decode time). Encrypting the same path twice yields different shadows: a listing leaks nothing, not even equality of paths.

Shadow format: v1. + base64url(no-pad) of nonce(12) ‖ ciphertext+tag.

use libfw_core::pathmap::{EncryptedPathCodec, PathCodec};

let codec = EncryptedPathCodec::from_hex(
    "000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f",
).unwrap();

let shadow = codec.encode("docs/机密/plan.pdf");
assert_ne!(shadow, "docs/机密/plan.pdf");
assert_eq!(codec.decode(&shadow).unwrap(), "docs/机密/plan.pdf");
// the same path encrypts differently every time
assert_ne!(codec.encode("docs/机密/plan.pdf"), shadow);
// tampered shadows are rejected
let mut bad = shadow.into_bytes();
let n = bad.len();
bad[n - 1] = if bad[n - 1] == b'A' { b'B' } else { b'A' };
assert!(codec.decode(&String::from_utf8(bad).unwrap()).is_err());

Implementations§

Source§

impl EncryptedPathCodec

Source

pub fn new(key: [u8; 32]) -> EncryptedPathCodec

Build the codec from a 32-byte key.

§Panics

If the host has no usable OS CSPRNG: AES-GCM nonces must be unpredictable (see random_bytes), so the codec refuses to exist rather than silently emit predictable nonces. Use EncryptedPathCodec::from_hex to get this as a recoverable error.

Source

pub fn from_hex(hex: &str) -> Result<EncryptedPathCodec, PathCodecError>

Build the codec from a 64-char hex key (32 bytes).

Trait Implementations§

Source§

impl Clone for EncryptedPathCodec

Source§

fn clone(&self) -> EncryptedPathCodec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for EncryptedPathCodec

Available on crate feature path-encrypt only.
Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl PathCodec for EncryptedPathCodec

Available on crate feature path-encrypt only.
Source§

fn encode(&self, real: &str) -> String

Real path → shadow path.
Source§

fn decode(&self, shadow: &str) -> Result<String, PathCodecError>

Shadow path → real path.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more