Struct ockam_entity::Profile

pub struct Profile { /* private fields */ }

Implementations

impl Profile

pub fn new<I: Into<ProfileIdentifier>>(id: I, handle: Handle) -> Self

pub async fn entity(&self) -> Result<Entity>

pub async fn call(&self, req: IdentityRequest) -> Result<IdentityResponse>

pub async fn cast(&self, req: IdentityRequest) -> Result<()>

impl Profile

pub const NO_EVENT: &'static [u8]

Sha256 of that value is used as previous event id for first event in a Profile

pub const ROOT_LABEL: &'static str

Label for Profile update key

pub const CURRENT_CHANGE_VERSION: u8

Current version of change structure

Trait Implementations

impl AsyncTryClone for Profile

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

Add key that already exists in current Vault

fn rotate_root_secret_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_root_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.

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_root_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 create_auth_proof<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    state_slice: &'life1 [u8]
) -> Pin<Box<dyn Future<Output = Result<AuthenticationProof>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Create an authentication proof based on the given state

fn verify_auth_proof<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 mut self,
    state_slice: &'life1 [u8],
    peer_id: &'life2 ProfileIdentifier,
    proof_slice: &'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 a proof based on the given state, proof and profile.

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 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 the whole change event 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,
    contact_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,