Struct didcomm_rs::Jwe

source · [−]

pub struct Jwe {
    pub protected: Option<JwmHeader>,
    pub unprotected: Option<JwmHeader>,
    pub recipient: Option<Recipient>,
    pub recipients: Option<Vec<Recipient>>,
    pub tag: Option<String>,
    /* private fields */
}

Expand description

JWE representation of Message with public header. Can be serialized to JSON or Compact representations and from same.

Fields

protected: Option<JwmHeader>

integrity protected header elements

unprotected: Option<JwmHeader>

header elements that are not integrity protected

recipient: Option<Recipient>

Top-level recipient data for flat JWE JSON messages. Will be ignored if recipients is not None

recipients: Option<Vec<Recipient>>

Pre-recipient data for flat JWE JSON messages. If not None, will be preferred over recipient.

tag: Option<String>

base64 encoded JWE authentication tag

Implementations

impl Jwe

pub fn new(
    unprotected: Option<JwmHeader>,
    recipients: Option<Vec<Recipient>>,
    ciphertext: impl AsRef<[u8 ]>,
    protected: Option<JwmHeader>,
    tag: Option<impl AsRef<[u8 ]>>,
    iv_input: Option<String>
) -> Self

Constructor, which should be used after message is encrypted.

pub fn new_flat(
    unprotected: Option<JwmHeader>,
    recipient: Recipient,
    ciphertext: impl AsRef<[u8 ]>,
    protected: Option<JwmHeader>,
    tag: Option<impl AsRef<[u8 ]>>,
    iv_input: Option<String>
) -> Self

Constructor for creating a flat JWE JSON

pub fn generate_iv() -> String

Generate new random IV as String

pub fn get_iv(&self) -> impl AsRef<[u8 ]>

Gets iv as byte array.

pub fn get_payload(&self) -> Vec<u8>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Getter for ciphered payload of JWE.

pub fn get_alg(&self) -> Option<String>

Gets alg header value from either protected or from unprotected.

Will default to None if not set in any of them.

pub fn get_cty(&self) -> Option<String>

Gets cty header value from either protected or from unprotected.

Will default to None if not set in any of them.

pub fn get_enc(&self) -> Option<String>

Gets enc header value from either protected or from unprotected.

Will default to None if not set in any of them.

pub fn get_epk(&self) -> Option<Jwk>

Gets epk header value from either protected or from unprotected.

Will default to None if not set in any of them.

pub fn get_jku(&self) -> Option<String>

Gets jku header value from either protected or from unprotected.

Will default to None if not set in any of them.

pub fn get_jwk(&self) -> Option<Jwk>

Gets jwk header value from either protected or from unprotected.

Will default to None if not set in any of them.

pub fn get_kid(&self) -> Option<String>

Gets kid header value from either protected or from unprotected.

Will default to None if not set in any of them.

pub fn get_skid(&self) -> Option<String>

Gets skid header value from either protected or from unprotected.

Will default to None if not set in any of them.

Trait Implementations

impl Clone for Jwe

fn clone(&self) -> Jwe

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Default for Jwe

fn default() -> Jwe

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for Jwe

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for Jwe

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for Jwe

impl Send for Jwe

impl Sync for Jwe

impl Unpin for Jwe

impl UnwindSafe for Jwe

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,