Skip to main content

TransportCrypto

Struct TransportCrypto 

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

Symmetric payload encryption (XChaCha20-Poly1305).

Implementations§

Source§

impl TransportCrypto

Source

pub fn from_bytes(key: [u8; 32]) -> Self

Build from an explicit 32-byte key.

Callers own key material and secrecy. Prefer this in tests and when wiring a key from a secrets manager rather than the process environment.

Source

pub fn from_env() -> Result<Self>

Load key from PHOTON_TRANSPORT_KEY (standard base64 encoding of exactly 32 bytes).

§Errors

Returns PhotonError::Internal when the variable is missing, not valid base64, or does not decode to 32 bytes. Production hosts should fail closed here.

§Contract

Does not fall back to a development key. Use Self::from_env_or_dev_default only with an explicit development opt-in.

Source

pub fn from_env_or_dev_default() -> Result<Self>

Load key from PHOTON_TRANSPORT_KEY, or the hard-coded development key when explicitly opted in.

Development-only. The hard-coded key is used only when PHOTON_ALLOW_DEV_TRANSPORT_KEY is 1 or true and PHOTON_TRANSPORT_KEY is unset or invalid. A loud warning is printed when the development key is used.

Prefer Self::from_env in production and CI (set a real PHOTON_TRANSPORT_KEY).

§Errors

Returns an error when the environment key is missing/invalid and the development-key opt-in is not set.

Source

pub fn encrypt( &self, actor_json: &Value, payload_json: &Value, ) -> Result<Vec<u8>>

Encrypt actor + payload JSON into opaque ciphertext bytes.

§Errors

Returns an error if the operation fails.

Source

pub fn decrypt(&self, ciphertext: &[u8]) -> Result<(Value, Value)>

Decrypt ciphertext into actor + payload JSON.

§Errors

Returns an error if the operation fails.

Trait Implementations§

Source§

impl Clone for TransportCrypto

Source§

fn clone(&self) -> TransportCrypto

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, 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> 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.