Struct bc_components::SymmetricKey

pub struct SymmetricKey(/* private fields */);

A symmetric encryption key.

Implementations

impl SymmetricKey

pub const SYMMETRIC_KEY_SIZE: usize = 32usize

pub fn new() -> Self

Create a new random symmetric key.

pub fn new_using(rng: &mut impl RandomNumberGenerator) -> Self

Create a new random symmetric key using the given random number generator.

pub const fn from_data(data: [u8; 32]) -> Self

Create a new symmetric key from data.

pub fn from_data_ref(data: impl AsRef<[u8]>) -> Result<Self>

Create a new symmetric key from data.

pub fn data(&self) -> &[u8; 32]

Get the data of the symmetric key.

pub fn from_hex(hex: impl AsRef<str>) -> Result<Self>

Create a new symmetric key from the given hexadecimal string.

Panics

Panics if the string is not exactly 24 hexadecimal digits.

pub fn hex(&self) -> String

The data as a hexadecimal string.

pub fn encrypt( &self, plaintext: impl Into<Bytes>, aad: Option<impl Into<Bytes>>, nonce: Option<impl AsRef<Nonce>> ) -> EncryptedMessage

Encrypt the given plaintext with this key, and the given additional authenticated data and nonce.

pub fn encrypt_with_digest( &self, plaintext: impl Into<Bytes>, digest: impl AsRef<Digest>, nonce: Option<impl AsRef<Nonce>> ) -> EncryptedMessage

Encrypt the given plaintext with this key, and the given digest of the plaintext, and nonce.

pub fn decrypt(&self, message: &EncryptedMessage) -> Result<Vec<u8>, Error>

Decrypt the given encrypted message with this key.

Trait Implementations

impl AsRef<SymmetricKey> for SymmetricKey

fn as_ref(&self) -> &SymmetricKey

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

impl CBORDecodable for SymmetricKey

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 SymmetricKey

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 SymmetricKey

const CBOR_TAG: Tag = tags::SYMMETRIC_KEY

The CBOR tag assocated with this type.

impl CBORTaggedDecodable for SymmetricKey

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 SymmetricKey

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 SymmetricKey

fn clone(&self) -> SymmetricKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SymmetricKey

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

Formats the value using the given formatter.

impl Default for SymmetricKey

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'a SymmetricKey> for &'a [u8; 32]

fn from(digest: &'a SymmetricKey) -> Self

Converts to this type from the input type.

impl From<&SymmetricKey> for SymmetricKey

fn from(digest: &SymmetricKey) -> Self

Converts to this type from the input type.

impl From<&SymmetricKey> for Vec<u8>

fn from(digest: &SymmetricKey) -> Self

Converts to this type from the input type.

impl From<SymmetricKey> for CBOR

fn from(value: SymmetricKey) -> Self

Converts to this type from the input type.

impl From<SymmetricKey> for Vec<u8>

fn from(digest: SymmetricKey) -> Self

Converts to this type from the input type.

impl Hash for SymmetricKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SymmetricKey

fn eq(&self, other: &SymmetricKey) -> 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 SymmetricKey

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 SymmetricKey

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 SymmetricKey

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 SymmetricKey

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 Eq for SymmetricKey

impl StructuralEq for SymmetricKey

impl StructuralPartialEq for SymmetricKey

impl URCodable for SymmetricKey