Struct ockam_entity::Entity

pub struct Entity { /* fields omitted */ }

Implementations

impl Entity

pub async fn create(node_ctx: &Context) -> Result<Entity>

pub async fn secure_channel_listen_on_address<A: Into<Address>, T: TrustPolicy>(
    &mut self,
    address: A,
    trust_policy: T
) -> Result<()>

pub async fn create_secure_channel_listener<T: TrustPolicy>(
    &mut self,
    secure_channel_address: &str,
    trust_policy: T
) -> Result<()>

pub async fn create_secure_channel<R: Into<Route>, T: TrustPolicy>(
    &mut self,
    route: R,
    trust_policy: T
) -> Result<Address>

pub fn list_secure_channels(&self) -> Result<Vec<(&Address, &Route)>>

Trait Implementations

impl ProfileAdd for Entity

fn add_profile(&mut self, profile: ProfileSync) -> Result<()>

impl ProfileAuth for Entity

fn generate_authentication_proof(
    &mut self,
    channel_state: &[u8]
) -> Result<Vec<u8>>

Generate an authentication proof based on the given channel_state

fn verify_authentication_proof(
    &mut self,
    channel_state: &[u8],
    responder_contact_id: &ProfileIdentifier,
    proof: &[u8]
) -> Result<bool>

Verify an authentication proof based on the given channel state, proof and profile.

impl ProfileChanges for Entity

fn change_events(&self) -> Result<Vec<ProfileChangeEvent>>

Return change history chain

fn update_no_verification(
    &mut self,
    change_event: ProfileChangeEvent
) -> Result<()>

Add a change event.

fn verify(&mut self) -> Result<bool>

Verify the whole change event chain

impl ProfileContacts for Entity

fn contacts(&self) -> Result<ContactsDb>

Return all known to this profile Contacts

fn to_contact(&self) -> Result<Contact>

Convert [Profile] to Contact

fn serialize_to_contact(&self) -> Result<Vec<u8>>

Serialize [Profile] to Contact in binary form for storing/transferring over the network

fn get_contact(&self, id: &ProfileIdentifier) -> Result<Option<Contact>>

Return Contact with given ProfileIdentifier

fn verify_contact(&mut self, contact: &Contact) -> Result<bool>

Verify cryptographically whole event chain. Also verify sequence correctness

fn verify_and_add_contact(&mut self, contact: Contact) -> Result<bool>

Verify and add new Contact to [Profile]’s Contact list

fn verify_and_update_contact(
    &mut self,
    profile_id: &ProfileIdentifier,
    change_events: Vec<ProfileChangeEvent>
) -> Result<bool>

Verify and update known Contact with new ProfileChangeEvents

impl ProfileIdentity for Entity

fn identifier(&self) -> Result<ProfileIdentifier>

Return unique [Profile] identifier, which is equal to sha256 of the root public key

impl ProfileRemove for Entity

fn remove_profile(&mut self, profile_id: &ProfileIdentifier) -> Result<()>

impl ProfileRetrieve for Entity

fn profile(
    &self,
    profile_identifier: &ProfileIdentifier
) -> Option<&ProfileSync>

fn profile_mut(
    &mut self,
    profile_identifier: &ProfileIdentifier
) -> Option<&mut ProfileSync>

impl ProfileSecrets for Entity

fn create_key(
    &mut self,
    key_attributes: KeyAttributes,
    attributes: Option<ProfileEventAttributes>
) -> Result<()>

Create new key. Key is uniquely identified by label in KeyAttributes

fn rotate_key(
    &mut self,
    key_attributes: KeyAttributes,
    attributes: Option<ProfileEventAttributes>
) -> Result<()>

Rotate existing key. Key is uniquely identified by label in KeyAttributes

fn get_secret_key(&mut self, key_attributes: &KeyAttributes) -> Result<Secret>

Get Secret key. Key is uniquely identified by label in KeyAttributes

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

Get PublicKey. Key is uniquely identified by label in KeyAttributes

fn get_root_secret(&mut self) -> Result<Secret>

Get the root Secret