Struct ockam_entity::ProfileState

pub struct ProfileState { /* private fields */ }

Profile implementation

Implementations

impl ProfileState

pub fn new(
    identifier: ProfileIdentifier,
    change_events: Changes,
    contacts: Contacts,
    vault: VaultSync,
    rng: impl RngCore + CryptoRng + Clone
) -> Self

Profile constructor

pub fn has_lease(&self) -> bool

pub fn lease(&self) -> Option<&Lease>

impl ProfileState

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

pub async fn create_key(&mut self, label: String) -> Result<()>

pub async fn add_key(&mut self, label: String, secret: &Secret) -> Result<()>

pub async fn rotate_root_secret_key(&mut self) -> Result<()>

pub async fn get_root_secret_key(&self) -> Result<Secret>

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

pub async fn get_secret_key(&self, label: String) -> Result<Secret>

pub async fn get_root_public_key(&self) -> Result<PublicKey>

pub async fn get_public_key(&self, label: String) -> Result<PublicKey>

pub async fn create_auth_proof(
    &mut self,
    channel_state: &[u8]
) -> Result<AuthenticationProof>

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

pub async fn verify_auth_proof(
    &mut self,
    channel_state: &[u8],
    responder_contact_id: &ProfileIdentifier,
    proof: &[u8]
) -> 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)

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

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

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

Verify whole event chain of current Profile

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

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

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

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

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

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

pub async fn get_lease(
    &self,
    _lease_manager_route: &Route,
    _org_id: String,
    _bucket: String,
    _ttl: TTL
) -> Result<Lease>

pub async fn revoke_lease(
    &mut self,
    _lease_manager_route: &Route,
    lease: Lease
) -> Result<()>