bootmgr-rs-core 0.16.5

A framework for easily creating boot managers in Rust
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

// SPDX-FileCopyrightText: 2025 some100 <ootinnyoo@outlook.com>
// SPDX-License-Identifier: MIT

//! The boot loader for network executables (really EFI loaded over network)
//!
//! It downloads a file from a TFTP server, then uses that file buffer as an EFI executable.
//! The current support for PXE is basic, and any more complex configurations (such as HTTP boot)
//! should use a more comprehensive PXE loader such as `iPXE` instead. This should be preferred even if your
//! configuration is very simple.
//!
//! Currently, there are no plans to add support for more advanced configurations like HTTP boot.

use alloc::vec;

use core::{net::Ipv4Addr, str::FromStr};

use uefi::{
    Handle, boot,
    proto::network::{IpAddress, pxe::BaseCode},
};

use crate::{
    BootResult,
    boot::{
        loader::{LoadError, get_efi},
        secure_boot::shim::shim_load_image,
    },
    config::Config,
    system::{
        fs::ONE_GIGABYTE,
        helper::{bytes_to_cstr8, locate_protocol, str_to_cstring},
    },
};

/// Loads a boot option from a given [`Config`] through TFTP.
///
/// # Errors
///
/// May return an `Error` if the firmware does not support [`BaseCode`], or the
/// EFI executable is not a valid Latin-1 string, or the filename is not a valid
/// IP address, or [`boot::load_image`] fails.
pub(crate) fn load_boot_option(config: &Config) -> BootResult<Handle> {
    let mut base_code = locate_protocol::<BaseCode>()?;

    let addr_as_octets = Ipv4Addr::from_str(&config.filename)
        .map_err(LoadError::IpParse)?
        .octets();
    let addr = IpAddress::new_v4(addr_as_octets);

    if !base_code.mode().started() {
        // at this point it should already be started
        base_code.start(true)?;
    }

    let efi = get_efi(config)?;

    let filename = str_to_cstring(efi)?; // convert efi to a CString, not to be confused with a CString16
    let filename_bytes = filename.as_bytes_with_nul();
    let filename_cstr = bytes_to_cstr8(filename_bytes)?;

    // if its too big, its due to 32 bit platform limitations, and it would not be possible to allocate a buffer
    // greater than the pointer width max either way. truncating should generally be fine on 64 bit platforms though
    let size = usize::try_from(base_code.tftp_get_file_size(&addr, filename_cstr)?)
        .unwrap_or(ONE_GIGABYTE);

    let mut vec = vec![0; size];
    base_code.tftp_read_file(&addr, filename_cstr, Some(&mut vec))?;

    let src = boot::LoadImageSource::FromBuffer {
        buffer: &vec,
        file_path: None,
    };
    shim_load_image(boot::image_handle(), src)
}