Skip to main content

SessionSecret

Struct SessionSecret 

Source
pub struct SessionSecret(/* private fields */);
Expand description

Server-held signing key. Wrap Vec<u8> so callers can’t accidentally print it. Clone is opt-in so the same secret can be shared across layers that use distinct cookie names + payload shapes (e.g. tenancy operator + tenancy tenant + bare admin — three layers, one key, three independent cookies).

Implementations§

Source§

impl SessionSecret

Source

pub fn from_env_or_random() -> Self

Read the secret from RUSTANGO_SESSION_SECRET (base64-encoded 32+ bytes). Falls back to a randomly generated secret with a tracing::warn when the var is unset — sessions are then invalidated on every server restart.

When the var IS set but unparseable (bad base64, fewer than 32 bytes), we ALSO print a loud eprintln! to stderr in addition to the tracing::warn (history: operators who set the var and forgot to run it through base64 quietly lost session persistence on every redeploy).

Source

pub fn from_env_or_disk(disk_path: &Path) -> Self

Dev-friendly variant of Self::from_env_or_random that persists the generated key to disk so sessions survive server restarts even without RUSTANGO_SESSION_SECRET set.

Resolution order:

  1. RUSTANGO_SESSION_SECRET env var — production path.
  2. Read disk_path if it exists and contains ≥ 32 bytes.
  3. Generate a random key, atomically write it to disk_path (creating parent directories as needed), and return it.
  4. If the write fails, fall back to ephemeral random + a tracing::warn!.

Used by the runserver boot path so dev cargo run cycles don’t sign every operator out on every reload (#69). Production deployments should still set RUSTANGO_SESSION_SECRET so the secret lives in env / a secret-manager rather than the filesystem.

Source

pub fn try_from_env() -> Result<Self, SessionSecretError>

Strict variant of Self::from_env_or_random: returns Err(...) when the env var is set but unparseable or too short. Use this from production boot paths where a malformed secret should fail loudly instead of silently downgrading to a random ephemeral key.

§Errors

SessionSecretError::BadBase64 when decode fails; SessionSecretError::TooShort when the decoded bytes are fewer than 32.

Source

pub fn require_from_env() -> Result<Self, SessionSecretError>

Strict variant for production boot: requires RUSTANGO_SESSION_SECRET to be present, valid base64, and ≥ 32 bytes. Unlike Self::try_from_env, an unset var is an error (SessionSecretError::Missing) rather than a silent random key — an ephemeral key breaks multi-instance deployments and masks a missing-secret misconfiguration. Used by load_session_secret_for_tier on the prod tier.

§Errors

SessionSecretError::Missing when unset; BadBase64 / TooShort per Self::try_from_env.

Source

pub fn from_bytes(bytes: Vec<u8>) -> Self

Construct from raw bytes — useful for tests + callers that load the key from a custom source.

Trait Implementations§

Source§

impl Clone for SessionSecret

Source§

fn clone(&self) -> SessionSecret

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeMyFromRow for T

Source§

impl<T> MaybeMyLoadRelated for T

Source§

impl<T> MaybeMyScalar for T

Source§

impl<T> MaybeSqliteFromRow for T

Source§

impl<T> MaybeSqliteLoadRelated for T

Source§

impl<T> MaybeSqliteScalar for T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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