ostool 0.30.0

A tool for operating system development
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

//! Host boot payload shared by QEMU, U-Boot, and board runners.

use std::path::PathBuf;

use anyhow::Result;
use httpboot_protocol::valid_host_cmdline;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

use crate::project::variables::{self, VariableScope};

/// Optional host initramfs and kernel command line.
#[derive(Clone, Debug, Default, Deserialize, Serialize, JsonSchema, PartialEq, Eq)]
pub struct BootPayloadConfig {
    /// Path to a host initramfs archive; guest initrds are configured separately.
    pub initramfs: Option<String>,
    /// Boot arguments passed to the host kernel.
    pub cmdline: Option<String>,
}

impl BootPayloadConfig {
    pub(crate) fn replace_strings(&mut self, scope: &VariableScope) -> Result<()> {
        self.initramfs = self
            .initramfs
            .as_deref()
            .map(|path| variables::expand_variables(path, scope))
            .transpose()?;
        self.cmdline = self
            .cmdline
            .as_deref()
            .map(|value| variables::expand_variables(value, scope))
            .transpose()?;
        Ok(())
    }

    pub(crate) fn initramfs_path(&self) -> Option<PathBuf> {
        self.initramfs.as_ref().map(PathBuf::from)
    }

    pub(crate) fn validate(&self) -> Result<()> {
        anyhow::ensure!(
            self.initramfs
                .as_ref()
                .is_none_or(|path| !path.trim().is_empty()),
            "initramfs path cannot be empty"
        );
        anyhow::ensure!(
            self.cmdline
                .as_ref()
                .is_none_or(|cmdline| valid_host_cmdline(cmdline)),
            "kernel command line must be at most 4095 printable ASCII bytes"
        );
        Ok(())
    }
}

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

    #[test]
    fn rejects_control_bytes_and_oversize() {
        for value in [
            "console=ttyS0\nreset".to_string(),
            "console=ttyS0\x1b".to_string(),
            "x".repeat(4096),
        ] {
            assert!(
                BootPayloadConfig {
                    cmdline: Some(value),
                    ..Default::default()
                }
                .validate()
                .is_err()
            );
        }
        assert!(
            BootPayloadConfig {
                cmdline: Some("rdinit=\"/sbin/my init\" -- arg".into()),
                ..Default::default()
            }
            .validate()
            .is_ok()
        );
        assert!(
            BootPayloadConfig {
                cmdline: Some("value='literal'".into()),
                ..Default::default()
            }
            .validate()
            .is_ok()
        );
    }
}