isomdl 0.2.0

ISO mDL implementation in Rust
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

use std::collections::BTreeMap;

use crate::presentation::device::RequestedItems;
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Module containing functions to perform mdoc authentication.
pub mod mdoc;

/// The outcome of the holder device authenticating the device request.
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq)]
pub struct RequestAuthenticationOutcome {
    /// The requested items from the mDL namespace.
    pub items_request: RequestedItems,
    /// The common name from the certificate that signed this request, if available.
    /// This value can be used to display to the user who the reader is, however
    /// caution should be exercised if reader authentication was not successful.
    pub common_name: Option<String>,
    /// Outcome of reader authentication.
    pub reader_authentication: AuthenticationStatus,
    /// Errors that occurred during request processing.
    pub errors: Errors,
}

/// The outcome of the reader device authenticating the device response.
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq)]
pub struct ResponseAuthenticationOutcome {
    /// The values sent back from the holder device, serialized as JSON.
    pub response: BTreeMap<String, Value>,
    /// Outcome of issuer authentication.
    pub issuer_authentication: AuthenticationStatus,
    /// Outcome of device authentication.
    pub device_authentication: AuthenticationStatus,
    /// Errors that occurred during response processing.
    pub errors: Errors,
}

/// The outcome of authenticity checks.
#[derive(Debug, Serialize, Deserialize, Default, Clone, Copy, PartialEq, Eq)]
pub enum AuthenticationStatus {
    #[default]
    Unchecked,
    Invalid,
    Valid,
}

/// Errors that occur during request/response processing.
pub type Errors = BTreeMap<String, serde_json::Value>;