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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

use crate::models::{ChangeHistory, CredentialAndPurposeKey};
use minicbor::{CborLen, Decode, Encode};
use ockam_core::compat::vec::Vec;
use ockam_core::{CowBytes, Route};

/// Secure Channel Message format.
#[derive(Debug, Encode, Decode, CborLen, Clone)]
#[rustfmt::skip]
pub struct SecureChannelPaddedMessage<'a> {
    /// Message itself.
    #[b(0)] pub message: SecureChannelMessage<'a>,
    /// Padding to reduce leaking of the message size.
    #[b(1)] pub padding: CowBytes<'a>,
}

/// Secure Channel Message format.
#[derive(Debug, Encode, Decode, CborLen, Clone)]
#[rustfmt::skip]
pub enum SecureChannelMessage<'a> {
    /// Encrypted payload message.
    #[b(0)] Payload(#[b(0)] PlaintextPayloadMessage<'a>),
    /// Present credentials one more time.
    #[n(1)] RefreshCredentials(#[n(0)] RefreshCredentialsMessage),
    /// Close the channel.
    #[n(2)] Close,
}

/// Secure Channel Message format.
#[derive(Debug, Encode, Decode, CborLen, Clone)]
#[rustfmt::skip]
pub struct PlaintextPayloadMessage<'a> {
    /// Onward route of the message.
    #[n(0)] pub onward_route: Route,
    /// Return route of the message.
    #[n(1)] pub return_route: Route,
    /// Untyped binary payload.
    #[b(2)] pub payload: CowBytes<'a>,
}

/// Secure Channel Message format.
#[derive(Debug, Encode, Decode, CborLen, Clone)]
#[rustfmt::skip]
pub struct RefreshCredentialsMessage {
    /// Exported identity
    #[n(0)] pub change_history: ChangeHistory,
    /// Credentials associated to the identity along with corresponding Credentials Purpose Keys
    /// to verify those Credentials
    #[n(1)] pub credentials: Vec<CredentialAndPurposeKey>,
}