yubihsm 0.17.3

Pure Rust client for YubiHSM2 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

//! Status responses from `yubihsm-connector` process (from the YubiHSM2 SDK)

use std::str::FromStr;

use adapter::{AdapterError, AdapterErrorKind::ResponseError};
use serial_number::SerialNumber;

/// `yubihsm-connector` status message when healthy
pub(super) const CONNECTOR_STATUS_OK: &str = "OK";

/// Status response from `yubihsm-connector` containing information about its
/// health and what `YubiHSM2` we're connected to
#[derive(Clone, Debug)]
pub struct ConnectorStatus {
    /// Status message for `yubihsm-connector` e.g. "OK"
    pub message: String,

    /// Serial number of `YubiHSM2` device. Only available if `yubihsm-connector`
    /// has been started with the --serial option
    pub serial_number: Option<SerialNumber>,

    /// `YubiHSM2` SDK version for `yubihsm-connector`
    pub version: String,

    /// PID of `yubihsm-connector`
    pub pid: u32,
}

impl ConnectorStatus {
    /// Parse the `yubihsm-connector` status response into a status struct
    pub fn parse(response_body: &str) -> Result<Self, AdapterError> {
        let mut response_message: Option<&str> = None;
        let mut response_serial: Option<&str> = None;
        let mut response_version: Option<&str> = None;
        let mut response_pid: Option<&str> = None;

        for line in response_body.split('\n') {
            if line.is_empty() {
                continue;
            }

            let mut fields = line.split('=');

            let key = fields
                .next()
                .ok_or_else(|| err!(ResponseError, "couldn't parse key"))?;

            let value = fields
                .next()
                .ok_or_else(|| err!(ResponseError, "couldn't parse value"))?;

            if let Some(remaining) = fields.next() {
                fail!(ResponseError, "unexpected additional data: {}", remaining)
            }

            match key {
                "status" => response_message = Some(value),
                "serial" => response_serial = Some(value),
                "version" => response_version = Some(value),
                "pid" => response_pid = Some(value),
                _ => (),
            }
        }

        let message = response_message
            .ok_or_else(|| err!(ResponseError, "missing status"))?
            .to_owned();

        let serial_number = match response_serial {
            Some("*") => None,
            Some(s) => Some(SerialNumber::from_str(s)?),
            None => fail!(ResponseError, "missing serial"),
        };

        let version = response_version
            .ok_or_else(|| err!(ResponseError, "missing version"))?
            .to_owned();

        let pid = response_pid
            .ok_or_else(|| err!(ResponseError, "missing PID"))?
            .parse()
            .map_err(|_| err!(ResponseError, "invalid PID: {}", response_pid.unwrap()))?;

        Ok(Self {
            message,
            serial_number,
            version,
            pid,
        })
    }

    /// Is the status message "OK"?
    pub fn is_ok(&self) -> bool {
        if self.message == CONNECTOR_STATUS_OK {
            true
        } else {
            debug!(
                "bad status message from yubihsm-connector: {}",
                &self.message
            );
            false
        }
    }
}