tmkms 0.2.3

Tendermint Key Management System
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

// Error types

use abscissa::Error;
use prost;
use signatory;
use std::{
    any::Any,
    error::Error as StdError,
    fmt::{self, Display},
    io,
};
use tendermint;
use tendermint::amino_types::validate::ValidationError as TmValidationError;
#[cfg(feature = "yubihsm")]
use yubihsm;

/// Error type
#[derive(Debug)]
pub struct KmsError(Error<KmsErrorKind>);

impl KmsError {
    /// Create an error from a panic
    pub fn from_panic(msg: &Any) -> Self {
        if let Some(e) = msg.downcast_ref::<String>() {
            err!(KmsErrorKind::PanicError, e)
        } else if let Some(e) = msg.downcast_ref::<&str>() {
            err!(KmsErrorKind::PanicError, e)
        } else {
            err!(KmsErrorKind::PanicError, "unknown cause")
        }.into()
    }
}

/// Kinds of errors
#[derive(Copy, Clone, Eq, PartialEq, Debug, Fail)]
pub enum KmsErrorKind {
    /// Access denied
    #[fail(display = "access denied")]
    #[cfg(feature = "yubihsm")]
    AccessError,

    /// Error in configuration file
    #[fail(display = "config error")]
    ConfigError,

    /// KMS internal panic
    #[fail(display = "internal crash")]
    PanicError,

    /// Cryptographic operation failed
    #[fail(display = "cryptographic error")]
    CryptoError,

    /// Malformatted or otherwise invalid cryptographic key
    #[fail(display = "invalid key")]
    InvalidKey,

    /// Validation of consensus message failed
    #[fail(display = "invalid consensus message")]
    InvalidMessageError,

    /// Input/output error
    #[fail(display = "I/O error")]
    IoError,

    /// Parse error
    #[fail(display = "parse error")]
    ParseError,

    /// Network protocol-related errors
    #[fail(display = "protocol error")]
    ProtocolError,

    /// Signing operation failed
    #[fail(display = "signing operation failed")]
    SigningError,

    /// Verification operation failed
    #[fail(display = "verification failed")]
    VerificationError,
}

impl Display for KmsError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.0.fmt(f)
    }
}

impl From<Error<KmsErrorKind>> for KmsError {
    fn from(other: Error<KmsErrorKind>) -> Self {
        KmsError(other)
    }
}

impl From<io::Error> for KmsError {
    fn from(other: io::Error) -> Self {
        err!(KmsErrorKind::IoError, other).into()
    }
}

impl From<prost::DecodeError> for KmsError {
    fn from(other: prost::DecodeError) -> Self {
        err!(KmsErrorKind::ProtocolError, other).into()
    }
}

impl From<prost::EncodeError> for KmsError {
    fn from(other: prost::EncodeError) -> Self {
        err!(KmsErrorKind::ProtocolError, other).into()
    }
}

impl From<signatory::Error> for KmsError {
    fn from(other: signatory::Error) -> Self {
        let kind = match other.kind() {
            signatory::ErrorKind::Io => KmsErrorKind::IoError,
            signatory::ErrorKind::KeyInvalid => KmsErrorKind::InvalidKey,
            signatory::ErrorKind::ParseError => KmsErrorKind::ParseError,
            signatory::ErrorKind::ProviderError => KmsErrorKind::SigningError,
            signatory::ErrorKind::SignatureInvalid => KmsErrorKind::VerificationError,
        };

        Error::new(kind, Some(other.description().to_owned())).into()
    }
}

impl From<tendermint::Error> for KmsError {
    fn from(other: tendermint::Error) -> Self {
        let kind = match other {
            tendermint::Error::Crypto => KmsErrorKind::CryptoError,
            tendermint::Error::InvalidKey => KmsErrorKind::InvalidKey,
            tendermint::Error::Io => KmsErrorKind::IoError,
            tendermint::Error::Protocol => KmsErrorKind::ProtocolError,
            tendermint::Error::Length
            | tendermint::Error::Parse
            | tendermint::Error::OutOfRange => KmsErrorKind::ParseError,
            tendermint::Error::SignatureInvalid => KmsErrorKind::VerificationError,
        };

        Error::new(kind, None).into()
    }
}

impl From<TmValidationError> for KmsError {
    fn from(other: TmValidationError) -> Self {
        err!(KmsErrorKind::InvalidMessageError, other).into()
    }
}

#[cfg(feature = "yubihsm")]
impl From<yubihsm::connector::ConnectionError> for KmsError {
    fn from(other: yubihsm::connector::ConnectionError) -> Self {
        use yubihsm::connector::ConnectionErrorKind;

        let kind = match other.kind() {
            ConnectionErrorKind::AddrInvalid => KmsErrorKind::ConfigError,
            ConnectionErrorKind::AccessDenied => KmsErrorKind::AccessError,
            ConnectionErrorKind::IoError
            | ConnectionErrorKind::ConnectionFailed
            | ConnectionErrorKind::DeviceBusyError
            | ConnectionErrorKind::RequestError
            | ConnectionErrorKind::ResponseError
            | ConnectionErrorKind::UsbError => KmsErrorKind::IoError,
        };

        Error::new(kind, Some(other.description().to_owned())).into()
    }
}