ockam_identity 0.134.0

Ockam is a library for building devices that communicate securely, privately and trustfully with cloud services and other devices.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

use ockam_core::compat::boxed::Box;
use ockam_core::compat::sync::Arc;
use ockam_core::{async_trait, Address, Result};

use crate::models::CredentialAndPurposeKey;
use crate::Identifier;

/// Trait for retrieving a credential for a given identity
#[async_trait]
pub trait CredentialRetriever: Send + Sync + 'static {
    /// Initialization of the retriever. Might load initial state, or start scheduled refresh events.
    async fn initialize(&self) -> Result<()>;

    /// Retrieve a credential for an identity.
    async fn retrieve(&self) -> Result<CredentialAndPurposeKey>;

    /// Subscribe to credential refresh
    fn subscribe(&self, address: &Address) -> Result<()>;

    /// Unsubscribe from credential refresh
    fn unsubscribe(&self, address: &Address) -> Result<()>;
}

/// Creator for [`CredentialRetriever`] implementation
#[async_trait]
pub trait CredentialRetrieverCreator: Send + Sync + 'static {
    /// Retrieve a credential for an identity.
    async fn create(&self, subject: &Identifier) -> Result<Arc<dyn CredentialRetriever>>;
}