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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

use core::fmt::Display;
use ockam_core::api::Method;
use ockam_core::compat::string::{String, ToString};
use ockam_core::Route;

use crate::Identifier;

enum CredentialIssuerServiceAddress {
    Controller,
    AuthorityNode,
}

impl Display for CredentialIssuerServiceAddress {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            CredentialIssuerServiceAddress::Controller => write!(f, "accounts"),
            CredentialIssuerServiceAddress::AuthorityNode => write!(f, "credential_issuer"),
        }
    }
}

enum CredentialIssuerApiServiceAddress {
    ControllerAccount,
    ControllerProject { project_id: String },
    AuthorityNode,
}

impl Display for CredentialIssuerApiServiceAddress {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            CredentialIssuerApiServiceAddress::ControllerAccount => write!(f, "/v0/account"),
            CredentialIssuerApiServiceAddress::ControllerProject { project_id } => {
                write!(f, "/v0/project/{}", project_id)
            }
            CredentialIssuerApiServiceAddress::AuthorityNode => write!(f, "/"),
        }
    }
}

/// Information necessary to connect to a remote credential retriever
#[derive(Debug, Clone)]
pub struct RemoteCredentialRetrieverInfo {
    /// Issuer identity, used to validate retrieved credentials
    pub issuer: Identifier,
    /// Route used to establish a secure channel to the remote node
    pub route: Route,
    /// Address of the credentials service on the remote node, e.g. "credential_issuer" or "accounts"
    pub service_address: String,
    /// Request path, e.g. "/" or "/v0/project/$project_id"
    pub api_service_address: String,
    /// Request method, e.g. Post or Get
    pub request_method: Method,
}

impl RemoteCredentialRetrieverInfo {
    /// Create info for a project member credential that we get from Project Membership Authority
    pub fn create_for_project_member(issuer: Identifier, route: Route) -> Self {
        Self::new(
            issuer,
            route,
            CredentialIssuerServiceAddress::AuthorityNode.to_string(),
            CredentialIssuerApiServiceAddress::AuthorityNode.to_string(),
            Method::Post,
        )
    }

    /// Create info for a project admin credential that we get from the Orchestrator
    pub fn create_for_project_admin(issuer: Identifier, route: Route, project_id: String) -> Self {
        Self::new(
            issuer,
            route,
            CredentialIssuerServiceAddress::Controller.to_string(),
            CredentialIssuerApiServiceAddress::ControllerProject { project_id }.to_string(),
            Method::Get,
        )
    }

    /// Create info for a account admin credential that we get from the Orchestrator
    pub fn create_for_account_admin(issuer: Identifier, route: Route) -> Self {
        Self::new(
            issuer,
            route,
            CredentialIssuerServiceAddress::Controller.to_string(),
            CredentialIssuerApiServiceAddress::ControllerAccount.to_string(),
            Method::Get,
        )
    }

    /// Constructor
    pub fn new(
        issuer: Identifier,
        route: Route,
        service_address: String,
        api_service_address: String,
        request_method: Method,
    ) -> Self {
        Self {
            issuer,
            route,
            service_address,
            api_service_address,
            request_method,
        }
    }
}