Struct ockam_entity::ProfileState

pub struct ProfileState { /* fields omitted */ }

Profile implementation

Implementations

impl ProfileState

pub fn new(
    identifier: ProfileIdentifier,
    change_events: Changes,
    contacts: Contacts,
    vault: VaultSync,
    key_attribs: KeyAttributes
) -> Self

Profile constructor

pub fn vault(&self) -> VaultSync

Return clone of Vault

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

impl ProfileState

pub fn create_key_static(
    prev_id: EventIdentifier,
    key_attributes: KeyAttributes,
    attributes: ProfileEventAttributes,
    root_key: Option<&Secret>,
    vault: &mut VaultSync
) -> Result<ProfileChangeEvent>

Create a new key

Trait Implementations

impl Clone for ProfileState

fn clone(&self) -> ProfileState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Identity for ProfileState

fn get_secret_key(&self) -> Result<Secret>

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

fn create_proof<S: AsRef<[u8]>>(&mut self, channel_state: S) -> Result<Proof>

Generate Proof of possession of [Profile]. channel_state should be tied to channel’s cryptographical material (e.g. h value for Noise XX)

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

Verify Proof of possession of [Profile] with given ProfileIdentifier. channel_state should be tied to channel’s cryptographical material (e.g. h value for Noise XX)

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

Verify whole event chain of current [Profile]

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

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

fn create_key<S: Into<String>>(&mut self, label: S) -> Result<()>

Create new key.

fn rotate_key(&mut self) -> Result<()>

Rotate existing key.

fn get_public_key(&self) -> Result<PublicKey>

Get PublicKey.

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

Add a change event.

fn get_changes(&self) -> Result<Changes>

Return change history chain

fn get_contacts(&self) -> Result<Vec<Contact>>

Return all known to this profile Contacts

fn as_contact(&mut self) -> Result<Contact>

Convert [Profile] to Contact

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

Return Contact with given ProfileIdentifier

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

Verify cryptographically whole event chain. Also verify sequence correctness

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

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

fn verify_and_update_contact<C: AsRef<[ProfileChangeEvent]>>(
    &mut self,
    contact_id: &ProfileIdentifier,
    change_events: C
) -> Result<bool>

Verify and update known Contact with new ProfileChangeEvents