Trait ockam::IdentityTrait

pub trait IdentityTrait: 'static + AsyncTryClone + Send + Sync {
    fn identifier<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = Result<IdentityIdentifier, Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
    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,
        Self: 'async_trait;
    fn add_key<'life0, 'life1, 'async_trait>(
        &'life0 mut self, 
        label: String, 
        secret: &'life1 Secret
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;
    fn rotate_root_secret_key<'life0, 'async_trait>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
    fn get_root_secret_key<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = Result<Secret, Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
    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,
        Self: 'async_trait;
    fn get_root_public_key<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = Result<PublicKey, Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
    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,
        Self: 'async_trait;
    fn create_auth_proof<'life0, 'life1, 'async_trait>(
        &'life0 mut self, 
        state_slice: &'life1 [u8]
    ) -> Pin<Box<dyn Future<Output = Result<Vec<u8, Global>, Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;
    fn verify_auth_proof<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 mut self, 
        state_slice: &'life1 [u8], 
        peer_id: &'life2 IdentityIdentifier, 
        proof_slice: &'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,
        Self: 'async_trait;
    fn add_change<'life0, 'async_trait>(
        &'life0 mut self, 
        change_event: IdentityChangeEvent
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
    fn get_changes<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = Result<Vec<IdentityChangeEvent, Global>, Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
    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,
        Self: 'async_trait;
    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,
        Self: 'async_trait;
    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,
        Self: 'async_trait;
    fn get_contact<'life0, 'life1, 'async_trait>(
        &'life0 mut self, 
        contact_id: &'life1 IdentityIdentifier
    ) -> Pin<Box<dyn Future<Output = Result<Option<Contact>, Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;
    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,
        Self: 'async_trait;
    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,
        Self: 'async_trait;
    fn verify_and_update_contact<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 mut self, 
        contact_id: &'life1 IdentityIdentifier, 
        change_events: &'life2 [IdentityChangeEvent]
    ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;
    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,
        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<(), Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;
}

Identity

Required methods

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

Return unique Identity 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<(), Error>> + Send + 'async_trait, Global>> 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<(), Error>> + Send + 'async_trait, Global>> 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<(), Error>> + Send + 'async_trait, Global>> 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, Error>> + Send + 'async_trait, Global>> 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, Error>> + Send + 'async_trait, Global>> 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, Error>> + Send + 'async_trait, Global>> 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, Error>> + Send + 'async_trait, Global>> 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<Vec<u8, Global>, Error>> + Send + 'async_trait, Global>> 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 IdentityIdentifier,
    proof_slice: &'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,
    Self: 'async_trait, 

Verify a proof based on the given state, proof and identity.

fn add_change<'life0, 'async_trait>(
    &'life0 mut self,
    change_event: IdentityChangeEvent
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> 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<Vec<IdentityChangeEvent, Global>, Error>> + Send + 'async_trait, Global>> 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, Error>> + Send + 'async_trait, Global>> 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, Global>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Return all known to this identity Contacts

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,
    Self: 'async_trait, 

Convert Identity to Contact

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

Return Contact with given IdentityIdentifier

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,
    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, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Verify and add new Contact to Identity’s Contact list

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

Verify and update known Contact with new IdentityChangeEvents

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,
    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<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Implementors

impl<V> IdentityTrait for Identity<V> where
    V: IdentityVault,