Struct bc_components::EncryptedMessage

pub struct EncryptedMessage { /* private fields */ }

A secure encrypted message.

Implemented using the IETF ChaCha20-Poly1305 encryption.

https://datatracker.ietf.org/doc/html/rfc8439

To facilitate decoding, it is recommended that the plaintext of an EncryptedMessage be tagged CBOR.

Implementations

impl EncryptedMessage

pub fn new( ciphertext: impl Into<Bytes>, aad: impl Into<Bytes>, nonce: Nonce, auth: AuthenticationTag ) -> Self

Restores an EncryptedMessage from its CBOR representation.

This is a low-level function that is not normally needed.

pub fn ciphertext(&self) -> &Bytes

Returns a reference to the ciphertext data.

pub fn aad(&self) -> &Bytes

Returns a reference to the additional authenticated data (AAD).

pub fn nonce(&self) -> &Nonce

Returns a reference to the nonce value used for encryption.

pub fn authentication_tag(&self) -> &AuthenticationTag

Returns a reference to the authentication tag value used for encryption.

pub fn opt_digest(&self) -> Option<Digest>

Returns an optional Digest instance if the AAD data can be parsed as CBOR.

pub fn has_digest(&self) -> bool

Returns true if the AAD data can be parsed as CBOR.

Trait Implementations

impl AsRef<EncryptedMessage> for EncryptedMessage

fn as_ref(&self) -> &EncryptedMessage

Converts this type into a shared reference of the (usually inferred) input type.

impl CBORDecodable for EncryptedMessage

fn from_cbor(cbor: &CBOR) -> Result<Self>

Creates an instance of this type from CBOR symbolic representation.

fn from_cbor_data(cbor_data: &[u8]) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type from encoded CBOR binary data.

impl CBOREncodable for EncryptedMessage

fn cbor(&self) -> CBOR

Returns the value in CBOR symbolic representation.

fn cbor_data(&self) -> Vec<u8>

Returns the value in CBOR binary representation.

impl CBORTagged for EncryptedMessage

fn cbor_tags() -> Vec<Tag>

The CBOR tags assocated with this type. If more than one tag is present, they are considered equivalent for reading, but only the first one is used for writing.

impl CBORTaggedDecodable for EncryptedMessage

fn from_untagged_cbor(cbor: &CBOR) -> Result<Self>

Creates an instance of this type by decoding it from untagged CBOR.

fn from_tagged_cbor(cbor: &CBOR) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from tagged CBOR.

fn from_tagged_cbor_data(data: &[u8]) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded tagged CBOR.

fn from_untagged_cbor_data(data: &[u8]) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded untagged CBOR.

impl CBORTaggedEncodable for EncryptedMessage

fn untagged_cbor(&self) -> CBOR

Returns the untagged CBOR encoding of this instance.

fn tagged_cbor(&self) -> CBOR

Returns the tagged CBOR encoding of this instance.

fn tagged_cbor_data(&self) -> Vec<u8>

Returns the tagged value in CBOR binary representation.

impl Clone for EncryptedMessage

fn clone(&self) -> EncryptedMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncryptedMessage

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

Formats the value using the given formatter.

impl DigestProvider for EncryptedMessage

fn digest(&self) -> Cow<'_, Digest>

impl From<EncryptedMessage> for CBOR

fn from(value: EncryptedMessage) -> Self

Converts to this type from the input type.

impl PartialEq for EncryptedMessage

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&CBOR> for EncryptedMessage

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: &CBOR) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<CBOR> for EncryptedMessage

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Self, Self::Error>

Performs the conversion.

impl URDecodable for EncryptedMessage

fn from_ur(ur: &UR) -> Result<Self, Error>

where Self: Sized,

fn from_ur_string<T>(ur_string: T) -> Result<Self, Error>

where T: Into<String>, Self: Sized,

impl UREncodable for EncryptedMessage

fn ur(&self) -> UR

Returns the UR representation of the object.

fn ur_string(&self) -> String

Returns the UR string representation of the object.

impl CBORCodable for EncryptedMessage

impl CBORTaggedCodable for EncryptedMessage

impl Eq for EncryptedMessage

impl StructuralPartialEq for EncryptedMessage

impl URCodable for EncryptedMessage