gbl 0.3.1

GBL firmware file handling library
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

use std::{fmt, io};

/// The error type used by this library.
#[derive(Fail, Debug)]
pub struct Error {
    kind: ErrorKind,
    details: Option<String>,
}

impl Error {
    pub(crate) fn with_details<D>(kind: ErrorKind, details: D) -> Self
    where
        D: Into<String>,
    {
        Self {
            kind,
            details: Some(details.into()),
        }
    }

    pub(crate) fn parse_err<T: Into<String>>(msg: T) -> Error {
        Error::with_details(ErrorKind::ParseError, msg.into())
    }

    /// Returns the `ErrorKind` classifying this error further.
    pub fn kind(&self) -> ErrorKind {
        self.kind.clone()
    }
}

impl From<ErrorKind> for Error {
    fn from(kind: ErrorKind) -> Self {
        Error {
            kind,
            details: None,
        }
    }
}

impl From<io::Error> for Error {
    fn from(err: io::Error) -> Self {
        Self {
            kind: ErrorKind::ParseError,
            details: Some(err.to_string()),
        }
    }
}

impl fmt::Display for Error {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        match &self.details {
            Some(details) => write!(fmt, "{}: {}", self.kind, details),
            None => write!(fmt, "{}", self.kind),
        }
    }
}

/// The different kinds of errors that can occur.
#[derive(Fail, Debug, Clone)]
pub enum ErrorKind {
    /// Data could not be parsed because it is malformed.
    ///
    /// "Data" in this case can be the GBL file, an ECDSA or an AES key file.
    /// This error can also mean that an invalid key was provided (eg. a
    /// non-ECDSA key).
    ///
    /// When this is returned by [`Gbl::decrypt`], it most likely means that the
    /// wrong AES key was provided, resulting in garbage data.
    ///
    /// [`Gbl::decrypt`]: struct.Gbl.html#method.decrypt
    #[fail(display = "data could not be parsed")]
    ParseError,

    /// Signature was not created by the private key belonging to the provided
    /// public key.
    #[fail(display = "the signature is invalid")]
    InvalidSignature,

    /// An unspecified error occurred.
    ///
    /// Displaying the `Error` should result in a more useful message. This
    /// error is generally used for errors in ring and OpenSSL.
    #[fail(display = "error")]
    Other,

    #[doc(hidden)]
    #[fail(display = "__NonExhaustive")]
    __NonExhaustive,
}