sbat 1.0.0

UEFI Secure Boot Advanced Targeting (SBAT) no_std 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

// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use ascii::AsciiChar;
use core::fmt::{self, Display, Formatter};

/// SBAT parse error.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ParseError {
    /// CSV field is not ASCII. According to the SBAT spec, all fields
    /// must be ASCII.
    InvalidAscii,

    /// CSV field contains a special character. The characters allowed
    /// are alphabetic, numeric, and [`ALLOWED_SPECIAL_CHARS`]. This is
    /// to keep parsing simple. In particular, double-quote and escape
    /// characters are not allowed, so a field cannot contain a comma.
    ///
    /// [`ALLOWED_SPECIAL_CHARS`]: crate::ALLOWED_SPECIAL_CHARS
    SpecialChar(AsciiChar),

    /// CSV field is not a valid [`Generation`] number.
    ///
    /// [`Generation`]: crate::Generation
    InvalidGeneration,

    /// CSV record has too few fields.
    TooFewFields,
}

impl Display for ParseError {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            Self::InvalidAscii => write!(f, "CSV field is not ASCII"),
            Self::SpecialChar(c) => {
                write!(
                    f,
                    "CSV field contains special character: {:#04x}",
                    c.as_byte()
                )
            }
            Self::InvalidGeneration => {
                write!(f, "invalid generation, must be a positive integer")
            }
            Self::TooFewFields => {
                write!(f, "a CSV record does not have enough fields")
            }
        }
    }
}

impl core::error::Error for ParseError {}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_error_display() {
        assert_eq!(
            format!("{}", ParseError::SpecialChar(AsciiChar::Null)),
            "CSV field contains special character: 0x00"
        );

        // For the rest, don't bother testing the specific error
        // messages, just ensure nothing panics.
        let _ = format!("{}", ParseError::InvalidAscii);
        let _ = format!("{}", ParseError::InvalidGeneration);
        let _ = format!("{}", ParseError::TooFewFields);
    }
}