Skip to main content

StateEncryptionService

Struct StateEncryptionService 

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

AEAD encryption service for OAuth state and PKCE blobs.

Wire format: URL-safe base64 of [12-byte nonce || ciphertext || 16-byte tag].

The 32-byte key is never printed in fmt::Debug output.

Implementations§

Source§

impl StateEncryptionService

Source

pub const fn from_raw_key( key: &[u8; 32], algorithm: EncryptionAlgorithm, ) -> Self

Construct from a raw 32-byte key slice.

Source

pub fn from_hex_key( hex: &str, algorithm: EncryptionAlgorithm, ) -> Result<Self, KeyError>

Construct from a 64-character hex string (= 32 bytes).

§Errors

Returns KeyError::WrongLength if hex is not 64 chars. Returns KeyError::InvalidHex if hex contains non-hex chars.

Source

pub fn new_from_env( var: &str, algorithm: EncryptionAlgorithm, ) -> Result<Self, Error>

Load the key from an environment variable containing a 64-char hex string.

§Errors

Returns an error if the env var is absent or the value is not valid hex/length.

Source

pub fn from_compiled_schema( security_json: &Value, ) -> Result<Option<Arc<Self>>, Error>

Build from the security blob of a compiled schema, if enabled.

Returns Ok(None) when the state_encryption key is absent or enabled = false.

§Errors

Returns Err when enabled = true but the key environment variable is absent or contains an invalid value. The server must refuse to start in this case.

Source

pub fn encrypt(&self, plaintext: &[u8]) -> Result<String, Error>

Encrypt plaintext to a URL-safe base64 string.

A fresh random nonce is generated on every call.

§Errors

Returns an error only on internal cipher failure (essentially never).

Source

pub fn decrypt(&self, encoded: &str) -> Result<Vec<u8>, DecryptionError>

Decrypt a URL-safe base64 string produced by Self::encrypt.

§Errors

Trait Implementations§

Source§

impl Debug for StateEncryptionService

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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, 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
Source§

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