Skip to content

firmware_uefi: test NVRAM quota enforcement #5071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mike Ebersol (mebersol) wants to merge 1 commit into
base: main
Choose a base branch
from
+230 −1
Open

firmware_uefi: test NVRAM quota enforcement #5071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 144 additions & 1 deletion vm/devices/firmware/firmware_uefi/src/service/nvram/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -748,14 +748,157 @@ mod tests {
}
}

fn nvram_services(storage: InMemoryNvram) -> NvramServices {
fn nvram_services(storage: impl VmmNvramStorage + 'static) -> NvramServices {
let storage: Box<dyn VmmNvramStorage> = Box::new(storage);
NvramServices {
vsm_config: None,
services: NvramSpecServices::new(storage),
}
}

#[async_test]
async fn full_nvram_guest_writes_return_out_of_resources() {
use hcl_compat_uefi_nvram_storage::HclCompatNvram;
use hcl_compat_uefi_nvram_storage::storage_backend::StorageBackend;
use hcl_compat_uefi_nvram_storage::storage_backend::StorageBackendError;
use uefi_specs::hyperv::nvram::NvramCommand;
use uefi_specs::hyperv::nvram::NvramCommandDescriptor;
use uefi_specs::hyperv::nvram::NvramVariableCommand;
use uefi_specs::uefi::nvram::EfiVariableAttributes;

#[derive(Default)]
struct TestStorage(Option<Vec<u8>>);

#[async_trait::async_trait]
impl StorageBackend for TestStorage {
async fn persist(&mut self, data: Vec<u8>) -> Result<(), StorageBackendError> {
self.0 = Some(data);
Ok(())
}

async fn restore(&mut self) -> Result<Option<Vec<u8>>, StorageBackendError> {
Ok(self.0.clone())
}
}

async fn set_variable(
nvram: &mut NvramServices,
gm: &GuestMemory,
vendor: Guid,
attributes: u32,
data: &[u8],
) -> EfiStatus {
let name = wchz!(u16, "var").as_bytes();
gm.write_at(0x2000, name).unwrap();
gm.write_at(0x3000, data).unwrap();
gm.write_plain(
0x1000,
&NvramCommandDescriptor {
command: NvramCommand::SET_VARIABLE,
status: EfiStatus::DEVICE_ERROR.into(),
},
)
.unwrap();
gm.write_plain(
0x1000 + size_of::<NvramCommandDescriptor>() as u64,
&NvramVariableCommand {
attributes,
name_address: 0x2000.into(),
name_bytes: name.len() as u32,
vendor_guid: vendor,
data_address: 0x3000.into(),
data_bytes: data.len() as u32,
},
)
.unwrap();
nvram.handle_command(gm, 0x1000).await;
EfiStatus::from(
gm.read_plain::<NvramCommandDescriptor>(0x1000)
.unwrap()
.status,
)
}

let gm = GuestMemory::allocate(64 * 1024);
let mut nvram = nvram_services(HclCompatNvram::new(TestStorage::default(), None));
let vendors: [Guid; 4] = std::array::from_fn(|_| Guid::new_random());
let attributes = EfiVariableAttributes::new()
.with_non_volatile(true)
.with_bootservice_access(true)
.with_runtime_access(true);
let data = vec![0x5a; 32 * 1024 - 48 - wchz!(u16, "var").as_bytes().len()];
nvram.services.prepare_for_boot();

for &vendor in &vendors {
assert_eq!(
set_variable(&mut nvram, &gm, vendor, attributes.into(), &data).await,
EfiStatus::SUCCESS
);
}

for runtime in [false, true] {
if runtime {
nvram.services.exit_boot_services();
}
assert_eq!(
set_variable(&mut nvram, &gm, Guid::new_random(), attributes.into(), &[1],).await,
EfiStatus::OUT_OF_RESOURCES
);
assert_eq!(
set_variable(
&mut nvram,
&gm,
vendors[0],
attributes.into(),
&vec![1; data.len() + 1],
)
.await,
EfiStatus::OUT_OF_RESOURCES
);
assert_eq!(
set_variable(
&mut nvram,
&gm,
vendors[0],
attributes.with_append_write(true).into(),
&[1],
)
.await,
EfiStatus::OUT_OF_RESOURCES
);
assert_eq!(
set_variable(
&mut nvram,
&gm,
vendors[0],
attributes.into(),
&vec![1; 32 * 1024 + 1],
)
.await,
EfiStatus::INVALID_PARAMETER
);
assert_eq!(
set_variable(
&mut nvram,
&gm,
vendors[0],
attributes.with_append_write(true).into(),
&vec![1; 32 * 1024 - data.len() + 1],
)
.await,
EfiStatus::INVALID_PARAMETER
);
let name = Ucs2LeSlice::from_slice_with_nul(wchz!(u16, "var").as_bytes()).unwrap();
let (stored_attributes, stored_data) = nvram
.services
.get_variable_ucs2(vendors[0], name)
.await
.unwrap();
assert_eq!(stored_attributes, u32::from(attributes));
assert_eq!(stored_data, data);
}
}

#[test]
fn authenticated_and_raw_signature_payloads_parse_identically() {
let raw = x509_variable(&[b"cert1"]);
Expand Down
86 changes: 86 additions & 0 deletions vm/devices/firmware/hcl_compat_uefi_nvram_storage/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -626,6 +626,92 @@ mod test {
}
}

#[async_test]
async fn storage_limit_rejects_writes_without_mutation() {
let name = Ucs2LeSlice::from_slice_with_nul(wchz!(u16, "var").as_bytes()).unwrap();
let timestamp = EFI_TIME::default();
let vendors: [Guid; 4] = std::array::from_fn(|_| Guid::new_random());
let entry_overhead = size_of::<format::NvramVariable>() + name.as_bytes().len();
let data = vec![0x5a; MAXIMUM_NVRAM_SIZE / vendors.len() - entry_overhead];
let mut nvram = HclCompatNvram::new(EphemeralStorageBackend::default(), None);

for &vendor in &vendors {
nvram
.set_variable(name, vendor, 0x1234, data.clone(), timestamp)
.await
.unwrap();
}
let persisted = nvram.storage.0.clone().unwrap();
assert_eq!(persisted.len(), MAXIMUM_NVRAM_SIZE);

let new_vendor = Guid::new_random();
assert!(matches!(
nvram
.set_variable(name, new_vendor, 0x5678, vec![1], timestamp)
.await,
Err(NvramStorageError::OutOfSpace)
));
assert!(
nvram
.get_variable(name, new_vendor)
.await
.unwrap()
.is_none()
);

assert!(matches!(
nvram
.set_variable(name, vendors[0], 0x5678, vec![1; data.len() + 1], timestamp)
.await,
Err(NvramStorageError::OutOfSpace)
));
assert!(matches!(
nvram
.append_variable(name, vendors[0], vec![1], timestamp)
.await,
Err(NvramStorageError::OutOfSpace)
));
assert_eq!(
nvram.get_variable(name, vendors[0]).await.unwrap(),
Some((0x1234, data.clone(), timestamp))
);
assert_eq!(nvram.storage.0.as_ref(), Some(&persisted));

nvram
.set_variable(name, vendors[0], 0x1234, vec![0x5a], timestamp)
.await
.unwrap();
assert!(
nvram
.append_variable(name, vendors[0], vec![0x5a; data.len() - 1], timestamp)
.await
.unwrap()
);
assert_eq!(nvram.storage.0.as_ref(), Some(&persisted));

assert!(nvram.remove_variable(name, vendors[0]).await.unwrap());
nvram
.set_variable(name, new_vendor, 0x1234, data.clone(), timestamp)
.await
.unwrap();
assert_eq!(nvram.storage.0.as_ref().unwrap().len(), MAXIMUM_NVRAM_SIZE);

let mut reloaded = HclCompatNvram::new(nvram.storage, None);
assert!(
reloaded
.get_variable(name, vendors[0])
.await
.unwrap()
.is_none()
);
for vendor in vendors[1..].iter().copied().chain([new_vendor]) {
assert_eq!(
reloaded.get_variable(name, vendor).await.unwrap(),
Some((0x1234, data.clone(), timestamp))
);
}
}

#[async_test]
async fn load_reload() {
let mut storage = EphemeralStorageBackend::default();
Expand Down
Loading