yubihsm 0.26.0

Pure Rust client for YubiHSM2 devices with support for HTTP and USB-based access to the device. Supports most HSM functionality including ECDSA, Ed25519, HMAC, and RSA.
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

//! YubiHSM client errors

use crate::{connector, device, serialization, session};
use failure::Fail;
use std::{error::Error as StdError, io};

/// Client errors
pub type Error = crate::Error<ErrorKind>;

/// Client error kinds
#[derive(Copy, Clone, Eq, PartialEq, Debug, Fail)]
pub enum ErrorKind {
    /// Couldn't authenticate session
    #[fail(display = "authentication failed")]
    AuthenticationError,

    /// Session is closed
    #[fail(display = "session closed")]
    ClosedSessionError,

    /// Errors with the connection to the HSM
    #[fail(display = "connection error")]
    ConnectorError {
        /// Connection error kind
        kind: connector::ErrorKind,
    },

    /// Couldn't create session
    #[fail(display = "couldn't create session")]
    CreateFailed,

    /// Errors originating in the HSM device
    #[fail(display = "HSM error: {}", kind)]
    DeviceError {
        /// HSM error kind
        kind: device::ErrorKind,
    },

    /// Protocol error occurred
    #[fail(display = "protocol error")]
    ProtocolError,

    /// Error response from HSM we can't further specify
    #[fail(display = "HSM error")]
    ResponseError,
}

impl ErrorKind {
    /// Get the device error, if this is a device error
    pub fn device_error(self) -> Option<device::ErrorKind> {
        match self {
            ErrorKind::DeviceError { kind } => Some(kind),
            _ => None,
        }
    }
}

// TODO: capture causes?
impl From<connector::Error> for Error {
    fn from(err: connector::Error) -> Self {
        let kind = ErrorKind::ConnectorError { kind: err.kind() };
        err!(kind, err.description())
    }
}

// TODO: capture causes?
impl From<session::Error> for Error {
    fn from(err: session::Error) -> Self {
        let kind = match err.kind() {
            session::ErrorKind::AuthenticationError => ErrorKind::AuthenticationError,
            session::ErrorKind::ClosedError => ErrorKind::ClosedSessionError,
            session::ErrorKind::CreateFailed => ErrorKind::CreateFailed,
            session::ErrorKind::DeviceError { kind } => ErrorKind::DeviceError { kind },
            session::ErrorKind::ProtocolError
            | session::ErrorKind::CommandLimitExceeded
            | session::ErrorKind::MismatchError
            | session::ErrorKind::VerifyFailed => ErrorKind::ProtocolError,
            session::ErrorKind::ResponseError => ErrorKind::ResponseError,
        };

        err!(kind, err.description())
    }
}

impl From<io::Error> for Error {
    fn from(err: io::Error) -> Self {
        err!(ErrorKind::ProtocolError, err.description())
    }
}

// TODO: capture causes?
impl From<serialization::Error> for Error {
    fn from(err: serialization::Error) -> Self {
        err!(ErrorKind::ProtocolError, err.description())
    }
}

impl From<Error> for signatory::Error {
    fn from(client_error: Error) -> signatory::Error {
        signatory::Error::from_cause(client_error)
    }
}