Struct ockam_entity::Contact

pub struct Contact { /* fields omitted */ }

Contact is an abstraction responsible for storing user’s public data (mainly - public keys). It is designed to share users’ public keys in cryptographically verifiable way. Public keys together with metadata are organised into verifiable events chain exactly like crate::Profile. There are two ways to get Contact:

1. From another user (in this case Contact will be cryptographically verified)
2. Generate one from user’s own crate::Profile

Public keys from Contact can be used for many purposes, e.g. running key exchange, or signing&encrypting data.

Examples

Creating Contact from crate::Profile

let vault = Vault::create(&ctx)?;
let mut alice = Profile::create(&ctx, &vault).await?;

let truck_key_attributes = KeyAttributes::new(
    "Truck management".to_string(),
);

alice.create_key(truck_key_attributes.clone(), None)?;

let alice_contact = alice.to_contact();

let public_key = alice.get_public_key(&truck_key_attributes)?;

Sending Contact over the network

// Send this over the network
let alice_contact_binary = alice.serialize_to_contact()?;

Implementations

impl Contact

pub fn identifier(&self) -> &ProfileIdentifier

Return unique identifier, which equals to crate::Profile’s identifier

pub fn change_events(&self) -> &[ProfileChangeEvent]

Return change history chain

impl Contact

pub fn new(
    identifier: ProfileIdentifier,
    change_events: Vec<ProfileChangeEvent>
) -> Self

Create a new Contact.

impl Contact

pub fn verify(&self, vault: &mut impl ProfileVault) -> Result<()>

Verify cryptographically whole event chain. Also verify sequence correctness

pub fn verify_and_update(
    &mut self,
    change_events: Vec<ProfileChangeEvent>,
    vault: &mut impl ProfileVault
) -> Result<()>

Update Contact by using new change events

impl Contact

pub fn get_profile_update_public_key(&self) -> Result<PublicKey>

Get crate::Profile Update PublicKey

pub fn get_public_key(
    &self,
    key_attributes: &KeyAttributes
) -> Result<PublicKey>

Get PublicKey. Key is uniquely identified by label in KeyAttributes

pub fn get_last_event_id(&self) -> Result<EventIdentifier>

Get EventIdentifier of the last known event

Trait Implementations

impl Clone for Contact

fn clone(&self) -> Contact

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Contact

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Contact

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Contact

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

Serialize this value into the given Serde serializer.