Skip to main content

Encryption

Struct Encryption 

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

Encryption settings for a Bark encrypted push.

The algorithm, mode, key, and IV mirror Bark’s CryptoSettingFields. Create this value with Encryption::new to generate a fresh IV for CBC or GCM automatically, or with Encryption::with_iv when an exact IV is needed for tests or interoperability checks.

The IV is not secret. For CBC and GCM this crate serializes it as the top-level APNs iv field so Bark’s notification service extension can use it instead of the IV stored in the app settings.

Implementations§

Source§

impl Encryption

Source

pub fn new<K>( algorithm: EncryptionAlgorithm, mode: EncryptionMode, key: K, ) -> Result<Self>
where K: Into<String>,

Creates encryption settings and generates a mode-appropriate IV.

CBC generates a 16-byte ASCII IV, GCM generates a 12-byte ASCII IV, and ECB stores no IV. The key is validated immediately against the selected algorithm’s required byte length.

§Errors

Returns Error::InvalidKeyLength if the key length does not match the algorithm, or Error::Random if the operating system cannot provide randomness for an IV.

Source

pub fn with_iv<K, I>( algorithm: EncryptionAlgorithm, mode: EncryptionMode, key: K, iv: I, ) -> Result<Self>
where K: Into<String>, I: Into<String>,

Creates encryption settings with an explicit IV.

Use this when reproducing Bark documentation examples or when the caller deliberately wants to control the IV. Normal sends should prefer Encryption::new so CBC and GCM do not reuse IVs.

For ECB, pass an empty string because Bark’s ECB mode does not use an IV.

§Errors

Returns Error::InvalidKeyLength when the key has the wrong length, or Error::InvalidIvLength when the IV length does not match the selected mode.

Source

pub const fn algorithm(&self) -> EncryptionAlgorithm

Returns the selected Bark encryption algorithm.

Source

pub const fn mode(&self) -> EncryptionMode

Returns the selected Bark encryption mode.

Source

pub fn key(&self) -> &str

Returns the shared encryption key.

This is the exact UTF-8 key string that must also be configured on the iOS device in Bark’s push encryption settings.

Source

pub fn iv(&self) -> Option<&str>

Returns the IV that will be sent with the APNs payload.

CBC and GCM return Some, while ECB returns None because it has no IV.

Trait Implementations§

Source§

impl Clone for Encryption

Source§

fn clone(&self) -> Encryption

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 Encryption

Source§

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

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

impl Eq for Encryption

Source§

impl PartialEq for Encryption

Source§

fn eq(&self, other: &Encryption) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Encryption

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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<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