Struct ockam::ProfileState

pub struct ProfileState { /* fields omitted */ }

Profile implementation

Implementations

impl ProfileState

pub fn new(
    identifier: EntityIdentifier,
    change_events: Vec<ProfileChangeEvent, Global>,
    contacts: HashMap<EntityIdentifier, Contact, RandomState, Global>,
    vault: VaultSync,
    rng: impl RngCore + CryptoRng + Clone
) -> ProfileState

Profile constructor

pub async fn get_root_secret(&'_ mut self) -> Result<Secret, Error>

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: HashMap<String, String, RandomState, Global>,
    root_key: Option<&'_ Secret>,
    vault: &'_ mut VaultSync
) -> Result<ProfileChangeEvent, Error>

Create a new key

Trait Implementations

impl AsyncTryClone for ProfileState

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

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

impl Identity for ProfileState

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

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

pub fn create_auth_proof<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    channel_state: &'life1 [u8]
) -> Pin<Box<dyn Future<Output = Result<Vec<u8, Global>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    ProfileState: '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)

pub fn verify_auth_proof<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 mut self,
    channel_state: &'life1 [u8],
    responder_contact_id: &'life2 EntityIdentifier,
    proof: &'life3 [u8]
) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    ProfileState: '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)

pub fn verify_changes<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    ProfileState: 'async_trait, 

Verify whole event chain of current Profile

pub fn identifier<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<EntityIdentifier, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    ProfileState: 'async_trait, 

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

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

Create new key.

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

Rotate existing key.

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

Get Secret key.

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

Get PublicKey.

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

Get PublicKey.

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

Add a change event.

pub fn get_changes<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<ProfileChangeEvent, Global>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    ProfileState: 'async_trait, 

Return change history chain

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

Return all known to this profile Contacts

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

Convert Profile to Contact

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

Return Contact with given ProfileIdentifier

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

Verify cryptographically whole event chain. Also verify sequence correctness

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

Verify and add new Contact to Profile’s Contact list

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

Verify and update known Contact with new ProfileChangeEvents

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

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