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,
    rng: impl RngCore + CryptoRng + Clone
) -> Self

Profile constructor

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

pub fn has_lease(&self) -> bool

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

impl ProfileState

pub async 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 AsyncTryClone for ProfileState

fn async_try_clone<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Try cloning a object and return an Err in case of failure.

impl Identity for ProfileState

fn get_profile_secret_key<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Secret>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn create_auth_proof<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    channel_state: &'life1 [u8]
) -> Pin<Box<dyn Future<Output = Result<AuthenticationProof>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

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_auth_proof<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 mut self,
    channel_state: &'life1 [u8],
    responder_contact_id: &'life2 ProfileIdentifier,
    proof: &'life3 [u8]
) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, 

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<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Verify whole event chain of current Profile

fn identifier<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<ProfileIdentifier>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn create_key<'life0, 'async_trait>(
    &'life0 mut self,
    label: String
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Create new key.

fn rotate_profile_key<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Rotate existing key.

fn get_secret_key<'life0, 'async_trait>(
    &'life0 self,
    label: String
) -> Pin<Box<dyn Future<Output = Result<Secret>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Get Secret key.

fn get_profile_public_key<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<PublicKey>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Get PublicKey.

fn get_public_key<'life0, 'async_trait>(
    &'life0 self,
    label: String
) -> Pin<Box<dyn Future<Output = Result<PublicKey>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Get PublicKey.

fn add_change<'life0, 'async_trait>(
    &'life0 mut self,
    change_event: ProfileChangeEvent
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Add a change event.

fn get_changes<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Changes>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Return change history chain

fn get_contacts<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<Contact>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Return all known to this profile Contacts

fn as_contact<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Contact>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Convert Profile to Contact

fn get_contact<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    id: &'life1 ProfileIdentifier
) -> Pin<Box<dyn Future<Output = Result<Option<Contact>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Return Contact with given ProfileIdentifier

fn verify_contact<'life0, 'async_trait>(
    &'life0 mut self,
    contact: Contact
) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Verify cryptographically whole event chain. Also verify sequence correctness

fn verify_and_add_contact<'life0, 'async_trait>(
    &'life0 mut self,
    contact: Contact
) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Verify and add new Contact to Profile’s Contact list

fn verify_and_update_contact<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 mut self,
    contact_id: &'life1 ProfileIdentifier,
    change_events: &'life2 [ProfileChangeEvent]
) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Verify and update known Contact with new ProfileChangeEvents

fn get_lease<'life0, 'life1, 'async_trait>(
    &'life0 self,
    _lease_manager_route: &'life1 Route,
    _org_id: String,
    _bucket: String,
    _ttl: TTL
) -> Pin<Box<dyn Future<Output = Result<Lease>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

fn revoke_lease<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    _lease_manager_route: &'life1 Route,
    lease: Lease
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,