Struct Key

pub struct Key<P: KeyPurpose>(pub Box<Key>, _);

The symmetric encryption key used to communicate with the other side.

You don’t need to do any crypto, but you might need it to derive subkeys for sub-protocols.

Tuple Fields

0: Box<Key>

👎Deprecated since 0.7.0: Use the AsRef<Key> implementation to get access to the secretbox key

Implementations

impl Key<WormholeKey>

pub fn derive_transit_key(&self, appid: &AppID) -> Key<TransitKey>

👎Deprecated since 0.7.0: This will be a private method in the future. Open an issue if you require access to protocol intrinsics in the future

Derive the sub-key used for transit

This one’s a bit special, since the Wormhole’s AppID is included in the purpose. Different kinds of applications can’t talk to each other, not even accidentally, by design.

The new key is derived with the "{appid}/transit-key" purpose.

impl<P: KeyPurpose> Key<P>

pub fn new(key: Box<Key>) -> Self

Create a new key

pub fn to_hex(&self) -> String

Encode a key as a hex string

pub fn derive_subkey_from_purpose<NewP: KeyPurpose>( &self, purpose: &str, ) -> Key<NewP>

Derive a new sub-key from this one

Trait Implementations

impl<P: Clone + KeyPurpose> Clone for Key<P>

fn clone(&self) -> Key<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug + KeyPurpose> Debug for Key<P>

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

Formats the value using the given formatter.

impl<P: KeyPurpose> Deref for Key<P>

where Box<Key>: Deref,

type Target = <Box<GenericArray<u8, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>> as Deref>::Target

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<P: KeyPurpose> Display for Key<P>

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

Formats the value using the given formatter.