Struct ockam_identity::Identity

pub struct Identity<V: IdentityVault> { /* private fields */ }

Identity implementation

Implementations

impl<V: IdentityVault> Identity<V>

pub async fn create_secure_channel_listener(
    &self,
    address: impl Into<Address>,
    trust_policy: impl TrustPolicy,
    storage: &impl AuthenticatedStorage
) -> Result<()>

pub async fn create_secure_channel(
    &self,
    route: impl Into<Route>,
    trust_policy: impl TrustPolicy,
    storage: &impl AuthenticatedStorage
) -> Result<Address>

pub async fn create_secure_channel_extended(
    &self,
    route: impl Into<Route>,
    trust_policy: impl TrustPolicy,
    storage: &impl AuthenticatedStorage,
    timeout: Duration
) -> Result<Address>

impl<V: IdentityVault> Identity<V>

pub fn new(
    id: IdentityIdentifier,
    change_history: IdentityChangeHistory,
    ctx: Context,
    vault: V,
    rng: impl RngCore + CryptoRng + Clone
) -> Self

Identity constructor

pub async fn export(&self) -> Result<Vec<u8>>

pub async fn import(ctx: &Context, data: &[u8], vault: &V) -> Result<Self>

pub async fn changes(&self) -> Result<IdentityChangeHistory>

pub fn vault(&self) -> &V

pub async fn verify_changes(&self) -> Result<bool>

pub async fn create(ctx: &Context, vault: &V) -> Result<Self>

Create Identity

impl<V: IdentityVault> Identity<V>

pub fn identifier(&self) -> Result<IdentityIdentifier>

pub async fn create_key(&self, label: String) -> Result<()>

pub async fn add_key(&self, label: String, secret: &KeyId) -> Result<()>

pub async fn rotate_root_secret_key(&self) -> Result<()>

pub async fn get_root_secret_key(&self) -> Result<KeyId>

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

pub async fn get_secret_key(&self, label: String) -> Result<KeyId>

pub async fn get_root_public_key(&self) -> Result<PublicKey>

pub async fn get_public_key(&self, label: String) -> Result<PublicKey>

pub async fn create_signature(&self, data: &[u8]) -> Result<Signature>

Generate Proof of possession of crate::Identity.

channel_state should be tied to channel’s cryptographical material (e.g. h value for Noise XX)

pub async fn verify_signature(
    &self,
    signature: &Signature,
    their_identity_id: &IdentityIdentifier,
    data: &[u8],
    storage: &impl AuthenticatedStorage
) -> Result<bool>

Verify Proof of possession of Identity with given IdentityIdentifier. channel_state should be tied to channel’s cryptographical material (e.g. h value for Noise XX)

pub async fn get_known_identity(
    &self,
    their_identity_id: &IdentityIdentifier,
    storage: &impl AuthenticatedStorage
) -> Result<Option<IdentityChangeHistory>>

pub async fn update_known_identity(
    &self,
    their_identity_id: &IdentityIdentifier,
    current_history: &IdentityChangeHistory,
    storage: &impl AuthenticatedStorage
) -> Result<()>

Trait Implementations

impl<V: IdentityVault + Send + Sync + AsyncTryClone> AsyncTryClone for Identity<V>

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.