Struct josekit::jwe::JweContext

pub struct JweContext { /* fields omitted */ }

Implementations

impl JweContext

pub fn new() -> Self

pub fn is_acceptable_critical(&self, name: &str) -> bool

Test a critical header claim name is acceptable.

Arguments

• name - a critical header claim name

pub fn add_acceptable_critical(&mut self, name: &str)

Add a acceptable critical header claim name

Arguments

• name - a acceptable critical header claim name

pub fn remove_acceptable_critical(&mut self, name: &str)

Remove a acceptable critical header claim name

Arguments

• name - a acceptable critical header claim name

pub fn get_compression(&self, name: &str) -> Option<&dyn JweCompression>

Get a compression algorithm for zip header claim value.

Arguments

• name - a zip header claim name

pub fn add_compression(&mut self, compression: Box<dyn JweCompression>)

Add a compression algorithm for zip header claim name.

Arguments

• compression - a compression algorithm

pub fn remove_compression(&mut self, name: &str)

Remove a compression algorithm for zip header claim name.

Arguments

• name - a zip header claim name

pub fn get_content_encryption(
    &self,
    name: &str
) -> Option<&dyn JweContentEncryption>

Get a content encryption algorithm for enc header claim value.

Arguments

• name - a content encryption header claim name

pub fn add_content_encryption(
    &mut self,
    content_encryption: Box<dyn JweContentEncryption>
)

Add a content encryption algorithm for enc header claim name.

Arguments

• content_encryption - a content encryption algorithm

pub fn remove_content_encryption(&mut self, name: &str)

Remove a content encryption algorithm for enc header claim name.

Arguments

• name - a enc header claim name

pub fn serialize_compact(
    &self,
    payload: &[u8],
    header: &JweHeader,
    encrypter: &dyn JweEncrypter
) -> Result<String, JoseError>

Return a representation of the data that is formatted by compact serialization.

Arguments

• payload - The payload data.
• header - The JWS heaser claims.
• encrypter - The JWS encrypter.

pub fn serialize_compact_with_selector<'a, F>(
    &self,
    payload: &[u8],
    header: &JweHeader,
    selector: F
) -> Result<String, JoseError> where
    F: Fn(&JweHeader) -> Option<&'a dyn JweEncrypter>, 

Return a representation of the data that is formatted by compact serialization.

Arguments

• payload - The payload data.
• header - The JWS heaser claims.
• selector - a function for selecting the signing algorithm.

pub fn serialize_general_json(
    &self,
    payload: &[u8],
    header: Option<&JweHeaderSet>,
    recipients: &[(Option<&JweHeader>, &dyn JweEncrypter)],
    aad: Option<&[u8]>
) -> Result<String, JoseError>

Return a representation of the data that is formatted by flattened json serialization.

Arguments

• payload - The payload data.
• header - The JWE shared protected and unprotected header claims.
• recipients - The JWE header claims and the JWE encrypter pair for recipients.
• aad - The JWE additional authenticated data.

pub fn serialize_general_json_with_selector<'a, F>(
    &self,
    payload: &[u8],
    header: Option<&JweHeaderSet>,
    recipient_headers: &[Option<&JweHeader>],
    aad: Option<&[u8]>,
    selector: F
) -> Result<String, JoseError> where
    F: Fn(usize, &JweHeader) -> Option<&'a dyn JweEncrypter>, 

Return a representation of the data that is formatted by flattened json serialization.

Arguments

• payload - The payload data.
• header - The JWS shared protected and unprotected header claims.
• recipient_headers - The JWE unprotected header claims for recipients.
• aad - The JWE additional authenticated data.
• selector - a function for selecting the encrypting algorithm.

pub fn serialize_flattened_json(
    &self,
    payload: &[u8],
    header: Option<&JweHeaderSet>,
    recipient_header: Option<&JweHeader>,
    aad: Option<&[u8]>,
    encrypter: &dyn JweEncrypter
) -> Result<String, JoseError>

Return a representation of the data that is formatted by flattened json serialization.

Arguments

• payload - The payload data.
• header - The JWE shared protected and unprotected header claims.
• recipient_header - The JWE unprotected header claims per recipient.
• aad - The JWE additional authenticated data.
• encrypter - The JWS encrypter.

pub fn serialize_flattened_json_with_selector<'a, F>(
    &self,
    payload: &[u8],
    header: Option<&JweHeaderSet>,
    recipient_header: Option<&JweHeader>,
    aad: Option<&[u8]>,
    selector: F
) -> Result<String, JoseError> where
    F: Fn(&JweHeader) -> Option<&'a dyn JweEncrypter>, 

Return a representation of the data that is formatted by flatted json serialization.

Arguments

• payload - The payload data.
• header - The JWE shared protected and unprotected header claims.
• recipient_header - The JWE unprotected header claims per recipient.
• aad - The JWE additional authenticated data.
• selector - a function for selecting the encrypting algorithm.

pub fn deserialize_compact(
    &self,
    input: impl AsRef<[u8]>,
    decrypter: &dyn JweDecrypter
) -> Result<(Vec<u8>, JweHeader), JoseError>

Deserialize the input that is formatted by compact serialization.

Arguments

• input - The input data.
• decrypter - The JWS decrypter.

pub fn deserialize_compact_with_selector<'a, F>(
    &self,
    input: impl AsRef<[u8]>,
    selector: F
) -> Result<(Vec<u8>, JweHeader), JoseError> where
    F: Fn(&JweHeader) -> Result<Option<&'a dyn JweDecrypter>, JoseError>, 

Deserialize the input that is formatted by compact serialization.

Arguments

• input - The input data.
• selector - a function for selecting the decrypting algorithm.

pub fn deserialize_json<'a>(
    &self,
    input: impl AsRef<[u8]>,
    decrypter: &'a dyn JweDecrypter
) -> Result<(Vec<u8>, JweHeader), JoseError>

Deserialize the input that is formatted by flattened json serialization.

Arguments

• input - The input data.
• decrypter - The JWE decrypter.

pub fn deserialize_json_with_selector<'a, F>(
    &self,
    input: impl AsRef<[u8]>,
    selector: F
) -> Result<(Vec<u8>, JweHeader), JoseError> where
    F: Fn(&JweHeader) -> Result<Option<&'a dyn JweDecrypter>, JoseError>, 

Deserialize the input that is formatted by flattened json serialization.

Arguments

• input - The input data.
• selector - a function for selecting the decrypting algorithm.

Trait Implementations

impl Clone for JweContext

fn clone(&self) -> JweContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JweContext

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

Formats the value using the given formatter.

impl PartialEq<JweContext> for JweContext

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for JweContext

impl StructuralEq for JweContext

impl StructuralPartialEq for JweContext