electron-hardener 0.2.2

Utility to remove features from Electron that modify runtime behavior
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

use std::fmt;

/// An error that the provided binary didn't contain the required information for
/// an operation on it.
#[derive(Debug, PartialEq)]
#[non_exhaustive]
pub enum BinaryError {
    /// No [sentinel byte marker]() could be found in the binary.
    ///
    /// [sentinel byte marker]: https://www.electronjs.org/docs/tutorial/fuses#quick-glossary
    NoSentinel,
    /// No fuse version was found in the binary.
    NoFuseVersion,
    /// The length of the fuse was not found in the binary.
    NoFuseLength,
    /// The requested fuse to be modifed wasn't present in the fuse wire.
    FuseDoesNotExist(crate::Fuse),
    /// An unknown fuse status was encountered.
    ///
    /// The Electron project may have made a breaking change to the fuse format if
    /// this is returned.
    UnknownFuse {
        /// The fuse that returned an unknown value.
        fuse: crate::Fuse,
        /// The value found querying the fuse.
        value: u8,
    },
    #[allow(deprecated)]
    /// The Node.JS command line flag attempted to be disabled wasn't present.
    NodeJsFlagNotPresent(crate::patcher::NodeJsCommandLineFlag),
    /// The Electron command line flag attempted to be disabled wasn't present.
    ElectronOptionNotPresent(crate::patcher::ElectronOption),
    #[allow(deprecated)]
    /// The Node.JS debugging message attempted to be disabled wasn't present.
    MessageNotPresent(crate::patcher::DevToolsMessage),
}

impl fmt::Display for BinaryError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            BinaryError::NoSentinel => f.write_str("No fuse sentinel found"),
            BinaryError::NoFuseVersion => f.write_str("Fuse had no version present"),
            BinaryError::NoFuseLength => f.write_str("Fuse had no length specified"),
            BinaryError::FuseDoesNotExist(fuse) => write!(f, "The {:?} fuse wasn't present", fuse),
            BinaryError::UnknownFuse { fuse, value } => write!(
                f,
                "The {:?} fuse returned an unknown value of '{}'",
                fuse, value
            ),
            BinaryError::NodeJsFlagNotPresent(flag) => {
                write!(f, "The {:?} debugging flag wasn't present", flag)
            }
            BinaryError::ElectronOptionNotPresent(opt) => {
                write!(f, "The Electron option for {:?} wasn't present", opt)
            }
            BinaryError::MessageNotPresent(msg) => {
                write!(f, "The DevTools message {:?} wasn't present", msg)
            }
        }
    }
}

impl std::error::Error for BinaryError {}

/// An error that can result from parsing an Electron binary and attempting to modify it.
#[derive(Debug, PartialEq)]
#[non_exhaustive]
pub enum PatcherError {
    /// A part of the provided binary's contents was invalid.
    Binary(BinaryError),
    /// A different fuse schema version was found then what the library supports.
    FuseVersion {
        /// The supported version of the Electron fuse schema by this library.
        expected: u8,
        /// The Electron fuse schema version found in the provided application binary.
        found: u8,
    },
    /// An attempt was made to modify a fuse which has been removed from the Electron schema.
    ///
    /// This is an error because modifying a removed fuse has no effect, so this may lead to unexpected behavior.
    RemovedFuse(crate::Fuse),
}

impl From<BinaryError> for PatcherError {
    fn from(e: BinaryError) -> Self {
        PatcherError::Binary(e)
    }
}

impl fmt::Display for PatcherError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            PatcherError::Binary(e) => write!(f, "{}", e),
            PatcherError::FuseVersion { expected, found } => write!(
                f,
                "Unknown fuse version found. Expected {}, but found {}",
                expected, found
            ),
            PatcherError::RemovedFuse(fuse) => write!(
                f,
                "Failed to modify the {:?} fuse because it is marked as removed",
                fuse
            ),
        }
    }
}

impl std::error::Error for PatcherError {}