blob: 278365c0b72ce47683085b0a6a5f25bb176d5235 [file] [log] [blame]
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001// Copyright 2021, The Android Open Source Project
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
Andrew Walbranf6bf6862021-05-21 12:41:13 +000015//! Implementation of the AIDL interface of the VirtualizationService.
Andrew Walbrand6dce6f2021-03-05 16:39:08 +000016
David Brazdil1f530702022-10-03 12:18:10 +010017use crate::{get_calling_pid, get_calling_uid};
Alan Stokesfda70842023-12-20 17:50:14 +000018use crate::atom::{write_vm_booted_stats, write_vm_creation_stats};
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000019use crate::composite::make_composite_image;
Jakob Vukalovicd42aa2c2023-11-09 16:04:00 +000020use crate::crosvm::{CrosvmConfig, DiskFile, PayloadState, VmContext, VmInstance, VmState};
Jaewan Kim61f86142023-03-28 15:12:52 +090021use crate::debug_config::DebugConfig;
Shikha Panwar55e10ec2024-02-13 12:53:49 +000022use crate::dt_overlay::{create_device_tree_overlay, VM_DT_OVERLAY_MAX_SIZE, VM_DT_OVERLAY_PATH};
Nikita Ioffe5dfddf22023-06-29 16:11:26 +010023use crate::payload::{add_microdroid_payload_images, add_microdroid_system_images, add_microdroid_vendor_image};
Seungjae Yoofd9a0622022-10-14 10:01:29 +090024use crate::selinux::{getfilecon, SeContext};
Jiyong Park753553b2021-07-12 21:21:09 +090025use android_os_permissions_aidl::aidl::android::os::IPermissionController;
David Brazdil49f96f52022-12-16 21:29:13 +000026use android_system_virtualizationcommon::aidl::android::system::virtualizationcommon::{
Alice Wang4e3015d2023-10-10 09:35:37 +000027 Certificate::Certificate,
Andrew Walbranc92d35f2022-01-12 12:45:19 +000028 DeathReason::DeathReason,
David Brazdil49f96f52022-12-16 21:29:13 +000029 ErrorCode::ErrorCode,
30};
31use android_system_virtualizationservice::aidl::android::system::virtualizationservice::{
Inseob Kim53d0b212023-07-20 16:58:37 +090032 AssignableDevice::AssignableDevice,
David Brazdil7d1e5ec2023-02-06 17:56:29 +000033 CpuTopology::CpuTopology,
Andrew Walbran6b650662021-09-07 13:13:23 +000034 DiskImage::DiskImage,
Alan Stokes0cc59ee2021-09-24 11:20:34 +010035 IVirtualMachine::{BnVirtualMachine, IVirtualMachine},
Andrew Walbran6b650662021-09-07 13:13:23 +000036 IVirtualMachineCallback::IVirtualMachineCallback,
37 IVirtualizationService::IVirtualizationService,
Keir Frasercdd4b112022-11-24 14:02:25 +000038 MemoryTrimLevel::MemoryTrimLevel,
Jiyong Park029977d2021-11-24 21:56:49 +090039 Partition::Partition,
Andrew Walbran6b650662021-09-07 13:13:23 +000040 PartitionType::PartitionType,
Inseob Kim0168b462022-12-27 14:54:35 +090041 VirtualMachineAppConfig::{DebugLevel::DebugLevel, Payload::Payload, VirtualMachineAppConfig},
Jooyung Han21e9b922021-06-26 04:14:16 +090042 VirtualMachineConfig::VirtualMachineConfig,
Andrew Walbran6b650662021-09-07 13:13:23 +000043 VirtualMachineDebugInfo::VirtualMachineDebugInfo,
Alan Stokes0d1ef782022-09-27 13:46:35 +010044 VirtualMachinePayloadConfig::VirtualMachinePayloadConfig,
Jooyung Han21e9b922021-06-26 04:14:16 +090045 VirtualMachineRawConfig::VirtualMachineRawConfig,
Andrew Walbran6b650662021-09-07 13:13:23 +000046 VirtualMachineState::VirtualMachineState,
Jooyung Han21e9b922021-06-26 04:14:16 +090047};
David Brazdilafc9a9e2023-01-12 16:08:10 +000048use android_system_virtualizationservice_internal::aidl::android::system::virtualizationservice_internal::IVirtualizationServiceInternal::IVirtualizationServiceInternal;
Seungjae Yoodd91f0f2022-11-09 15:25:21 +090049use android_system_virtualmachineservice::aidl::android::system::virtualmachineservice::IVirtualMachineService::{
David Brazdilafc9a9e2023-01-12 16:08:10 +000050 BnVirtualMachineService, IVirtualMachineService,
Seungjae Yoofd9a0622022-10-14 10:01:29 +090051};
Shikha Panwarc78d8092024-03-08 15:26:28 +000052use android_hardware_security_secretkeeper::aidl::android::hardware::security::secretkeeper::ISecretkeeper::ISecretkeeper;
Shikha Panwar5d6a6752023-12-14 22:08:26 +000053use android_hardware_security_secretkeeper::aidl::android::hardware::security::secretkeeper::SecretId::SecretId;
54use android_hardware_security_authgraph::aidl::android::hardware::security::authgraph::{
55 Arc::Arc as AuthgraphArc, IAuthGraphKeyExchange::IAuthGraphKeyExchange,
56 IAuthGraphKeyExchange::BnAuthGraphKeyExchange, Identity::Identity, KeInitResult::KeInitResult,
57 Key::Key, PubKey::PubKey, SessionIdSignature::SessionIdSignature, SessionInfo::SessionInfo,
58 SessionInitiationInfo::SessionInitiationInfo,
59};
Alan Stokes25f69362023-03-06 16:51:54 +000060use anyhow::{anyhow, bail, Context, Result};
Seungjae Yoofd9a0622022-10-14 10:01:29 +090061use apkverify::{HashAlgorithm, V4Signature};
Jiyong Parkd7bd2f22023-08-10 20:41:19 +090062use avflog::LogResult;
Alan Stokes0e82b502022-08-08 14:44:48 +010063use binder::{
David Brazdilafc9a9e2023-01-12 16:08:10 +000064 self, wait_for_interface, BinderFeatures, ExceptionCode, Interface, ParcelFileDescriptor,
65 Status, StatusCode, Strong,
Jiyong Park2227eaa2023-08-04 11:59:18 +090066 IntoBinderResult,
Andrew Walbrana89fc132021-03-17 17:08:36 +000067};
Shikha Panwar55e10ec2024-02-13 12:53:49 +000068use cstr::cstr;
David Brazdilf50c7a62023-04-19 14:22:42 +000069use disk::QcowFile;
Inseob Kim46257382024-01-03 15:41:22 +090070use glob::glob;
David Brazdil49f96f52022-12-16 21:29:13 +000071use lazy_static::lazy_static;
Seungjae Yoo0a8c84c2022-07-11 08:19:15 +000072use log::{debug, error, info, warn};
Alan Stokesfda70842023-12-20 17:50:14 +000073use microdroid_payload_config::{ApkConfig, OsConfig, Task, TaskType, VmPayloadConfig};
Inseob Kim0168b462022-12-27 14:54:35 +090074use nix::unistd::pipe;
David Brazdil73988ea2022-11-11 15:10:32 +000075use rpcbinder::RpcServer;
Alan Stokes25f69362023-03-06 16:51:54 +000076use rustutils::system_properties;
Jiyong Parkdcf17412022-02-08 15:07:23 +090077use semver::VersionReq;
Inseob Kim6ef80972023-07-20 17:23:36 +090078use std::collections::HashSet;
Andrew Walbrandff3b942021-06-09 15:20:36 +000079use std::convert::TryInto;
Shikha Panwar55e10ec2024-02-13 12:53:49 +000080use std::fs;
Jaewan Kim39952072024-01-19 17:04:53 +090081use std::ffi::CStr;
Inseob Kim6ef80972023-07-20 17:23:36 +090082use std::fs::{canonicalize, read_dir, remove_file, File, OpenOptions};
Shikha Panwar9ae2e622024-01-30 12:22:30 +000083use std::io::{BufRead, BufReader, Error, ErrorKind, Seek, SeekFrom, Write};
Inseob Kim46257382024-01-03 15:41:22 +090084use std::iter;
Nikita Ioffe5776f082023-02-10 21:38:26 +000085use std::num::{NonZeroU16, NonZeroU32};
Inseob Kimff48a7c2024-02-26 22:07:21 +090086use std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd};
David Brazdilafc9a9e2023-01-12 16:08:10 +000087use std::os::unix::raw::pid_t;
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000088use std::path::{Path, PathBuf};
Andrew Walbran320b5602021-03-04 16:11:12 +000089use std::sync::{Arc, Mutex, Weak};
Seungjae Yoo14e60182024-02-21 13:28:31 +090090use vbmeta::VbMetaImage;
Andrew Walbrancc0db522021-07-12 17:03:42 +000091use vmconfig::VmConfig;
David Brazdilafc9a9e2023-01-12 16:08:10 +000092use vsock::VsockStream;
Jooyung Han35edb8f2021-07-01 16:17:16 +090093use zip::ZipArchive;
Andrew Walbrand6dce6f2021-03-05 16:39:08 +000094
David Brazdil41d1a872022-10-05 14:44:19 +010095/// The unique ID of a VM used (together with a port number) for vsock communication.
96pub type Cid = u32;
97
David Brazdil4b4c5102022-12-19 22:56:20 +000098pub const BINDER_SERVICE_IDENTIFIER: &str = "android.system.virtualizationservice";
99
Jooyung Han95884632021-07-06 22:27:54 +0900100/// The size of zero.img.
101/// Gaps in composite disk images are filled with a shared zero.img.
102const ZERO_FILLER_SIZE: u64 = 4096;
103
David Brazdilf50c7a62023-04-19 14:22:42 +0000104/// Magic string for the instance image
105const ANDROID_VM_INSTANCE_MAGIC: &str = "Android-VM-instance";
106
107/// Version of the instance image format
108const ANDROID_VM_INSTANCE_VERSION: u16 = 1;
109
Alan Stokes0d1ef782022-09-27 13:46:35 +0100110const MICRODROID_OS_NAME: &str = "microdroid";
111
Shikha Panwar5d6a6752023-12-14 22:08:26 +0000112const SECRETKEEPER_IDENTIFIER: &str =
Shikha Panwarbe5dee72024-02-21 19:06:20 +0000113 "android.hardware.security.secretkeeper.ISecretkeeper/default";
Shikha Panwar5d6a6752023-12-14 22:08:26 +0000114
David Brazdilf50c7a62023-04-19 14:22:42 +0000115const UNFORMATTED_STORAGE_MAGIC: &str = "UNFORMATTED-STORAGE";
116
117/// crosvm requires all partitions to be a multiple of 4KiB.
118const PARTITION_GRANULARITY_BYTES: u64 = 4096;
119
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000120const VM_REFERENCE_DT_ON_HOST_PATH: &str = "/proc/device-tree/avf/reference";
121
David Brazdil49f96f52022-12-16 21:29:13 +0000122lazy_static! {
David Brazdil4b4c5102022-12-19 22:56:20 +0000123 pub static ref GLOBAL_SERVICE: Strong<dyn IVirtualizationServiceInternal> =
124 wait_for_interface(BINDER_SERVICE_IDENTIFIER)
125 .expect("Could not connect to VirtualizationServiceInternal");
Inseob Kim46257382024-01-03 15:41:22 +0900126 static ref SUPPORTED_OS_NAMES: HashSet<String> =
127 get_supported_os_names().expect("Failed to get list of supported os names");
David Brazdil49f96f52022-12-16 21:29:13 +0000128}
129
Nikita Ioffef1ce9872022-12-09 13:31:59 +0000130fn create_or_update_idsig_file(
131 input_fd: &ParcelFileDescriptor,
132 idsig_fd: &ParcelFileDescriptor,
133) -> Result<()> {
134 let mut input = clone_file(input_fd)?;
135 let metadata = input.metadata().context("failed to get input metadata")?;
136 if !metadata.is_file() {
137 bail!("input is not a regular file");
138 }
Alan Stokes25f69362023-03-06 16:51:54 +0000139 let mut sig =
140 V4Signature::create(&mut input, get_current_sdk()?, 4096, &[], HashAlgorithm::SHA256)
141 .context("failed to create idsig")?;
Nikita Ioffef1ce9872022-12-09 13:31:59 +0000142
143 let mut output = clone_file(idsig_fd)?;
Jiyong Park8d192952023-06-26 14:29:51 +0900144
145 // Optimization. We don't have to update idsig file whenever a VM is started. Don't update it,
146 // if the idsig file already has the same APK digest.
147 if output.metadata()?.len() > 0 {
148 if let Ok(out_sig) = V4Signature::from_idsig(&mut output) {
149 if out_sig.signing_info.apk_digest == sig.signing_info.apk_digest {
150 debug!("idsig {:?} is up-to-date with apk {:?}.", output, input);
151 return Ok(());
152 }
153 }
154 // if we fail to read v4signature from output, that's fine. User can pass a random file.
155 // We will anyway overwrite the file to the v4signature generated from input_fd.
156 }
157
Shikha Panwar9ae2e622024-01-30 12:22:30 +0000158 output
159 .seek(SeekFrom::Start(0))
160 .context("failed to move cursor to start on the idsig output")?;
Nikita Ioffec09b0492022-12-14 20:18:33 +0000161 output.set_len(0).context("failed to set_len on the idsig output")?;
162 sig.write_into(&mut output).context("failed to write idsig")?;
Nikita Ioffef1ce9872022-12-09 13:31:59 +0000163 Ok(())
164}
165
Alan Stokes25f69362023-03-06 16:51:54 +0000166fn get_current_sdk() -> Result<u32> {
167 let current_sdk = system_properties::read("ro.build.version.sdk")?;
168 let current_sdk = current_sdk.ok_or_else(|| anyhow!("SDK version missing"))?;
169 current_sdk.parse().context("Malformed SDK version")
170}
171
David Brazdil4b4c5102022-12-19 22:56:20 +0000172pub fn remove_temporary_files(path: &PathBuf) -> Result<()> {
173 for dir_entry in read_dir(path)? {
174 remove_file(dir_entry?.path())?;
175 }
176 Ok(())
David Brazdil528e0472022-10-10 15:06:02 +0100177}
178
David Brazdil528e0472022-10-10 15:06:02 +0100179/// Implementation of `IVirtualizationService`, the entry point of the AIDL service.
David Brazdil49f96f52022-12-16 21:29:13 +0000180#[derive(Debug, Default)]
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000181pub struct VirtualizationService {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900182 state: Arc<Mutex<State>>,
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000183}
184
Shikha Panward8e35422021-10-11 13:51:27 +0000185impl Interface for VirtualizationService {
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000186 fn dump(&self, writer: &mut dyn Write, _args: &[&CStr]) -> Result<(), StatusCode> {
Shikha Panward8e35422021-10-11 13:51:27 +0000187 check_permission("android.permission.DUMP").or(Err(StatusCode::PERMISSION_DENIED))?;
188 let state = &mut *self.state.lock().unwrap();
189 let vms = state.vms();
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000190 writeln!(writer, "Running {0} VMs:", vms.len()).or(Err(StatusCode::UNKNOWN_ERROR))?;
Shikha Panward8e35422021-10-11 13:51:27 +0000191 for vm in vms {
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000192 writeln!(writer, "VM CID: {}", vm.cid).or(Err(StatusCode::UNKNOWN_ERROR))?;
193 writeln!(writer, "\tState: {:?}", vm.vm_state.lock().unwrap())
Shikha Panward8e35422021-10-11 13:51:27 +0000194 .or(Err(StatusCode::UNKNOWN_ERROR))?;
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000195 writeln!(writer, "\tPayload state {:?}", vm.payload_state())
Shikha Panward8e35422021-10-11 13:51:27 +0000196 .or(Err(StatusCode::UNKNOWN_ERROR))?;
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000197 writeln!(writer, "\tProtected: {}", vm.protected).or(Err(StatusCode::UNKNOWN_ERROR))?;
198 writeln!(writer, "\ttemporary_directory: {}", vm.temporary_directory.to_string_lossy())
Shikha Panward8e35422021-10-11 13:51:27 +0000199 .or(Err(StatusCode::UNKNOWN_ERROR))?;
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000200 writeln!(writer, "\trequester_uid: {}", vm.requester_uid)
Shikha Panward8e35422021-10-11 13:51:27 +0000201 .or(Err(StatusCode::UNKNOWN_ERROR))?;
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000202 writeln!(writer, "\trequester_debug_pid: {}", vm.requester_debug_pid)
Shikha Panward8e35422021-10-11 13:51:27 +0000203 .or(Err(StatusCode::UNKNOWN_ERROR))?;
204 }
205 Ok(())
206 }
207}
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000208impl IVirtualizationService for VirtualizationService {
Andrew Walbranf8d94112021-09-07 11:45:36 +0000209 /// Creates (but does not start) a new VM with the given configuration, assigning it the next
210 /// available CID.
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000211 ///
212 /// Returns a binder `IVirtualMachine` object referring to it, as a handle for the client.
Andrew Walbranf8d94112021-09-07 11:45:36 +0000213 fn createVm(
Andrew Walbrana89fc132021-03-17 17:08:36 +0000214 &self,
Andrew Walbran3a5a9212021-05-04 17:09:08 +0000215 config: &VirtualMachineConfig,
Jiyong Parke6fb1672023-06-26 16:45:55 +0900216 console_out_fd: Option<&ParcelFileDescriptor>,
217 console_in_fd: Option<&ParcelFileDescriptor>,
Andrew Walbrana89fc132021-03-17 17:08:36 +0000218 log_fd: Option<&ParcelFileDescriptor>,
219 ) -> binder::Result<Strong<dyn IVirtualMachine>> {
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000220 let mut is_protected = false;
Jiyong Parke6fb1672023-06-26 16:45:55 +0900221 let ret = self.create_vm_internal(
222 config,
223 console_out_fd,
224 console_in_fd,
225 log_fd,
226 &mut is_protected,
227 );
Seungjae Yoo0a8c84c2022-07-11 08:19:15 +0000228 write_vm_creation_stats(config, is_protected, &ret);
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000229 ret
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000230 }
Andrew Walbran320b5602021-03-04 16:11:12 +0000231
Shikha Panwar61a74b52024-02-16 13:17:01 +0000232 /// Allocate a new instance_id to the VM
233 fn allocateInstanceId(&self) -> binder::Result<[u8; 64]> {
234 GLOBAL_SERVICE.allocateInstanceId()
235 }
236
Andrew Walbrandff3b942021-06-09 15:20:36 +0000237 /// Initialise an empty partition image of the given size to be used as a writable partition.
238 fn initializeWritablePartition(
239 &self,
240 image_fd: &ParcelFileDescriptor,
Alan Stokesff0005f2023-01-30 09:53:00 +0000241 size_bytes: i64,
Jiyong Park9dd389e2021-08-23 20:42:59 +0900242 partition_type: PartitionType,
Andrew Walbrandff3b942021-06-09 15:20:36 +0000243 ) -> binder::Result<()> {
Jiyong Park753553b2021-07-12 21:21:09 +0900244 check_manage_access()?;
Jiyong Park2227eaa2023-08-04 11:59:18 +0900245 let size_bytes = size_bytes
246 .try_into()
247 .with_context(|| format!("Invalid size: {}", size_bytes))
248 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT)?;
David Brazdilf50c7a62023-04-19 14:22:42 +0000249 let size_bytes = round_up(size_bytes, PARTITION_GRANULARITY_BYTES);
Shikha Panwar9ae2e622024-01-30 12:22:30 +0000250 let mut image = clone_file(image_fd)?;
David Brazdilf50c7a62023-04-19 14:22:42 +0000251 // initialize the file. Any data in the file will be erased.
Shikha Panwar9ae2e622024-01-30 12:22:30 +0000252 image
253 .seek(SeekFrom::Start(0))
254 .context("failed to move cursor to start")
255 .or_service_specific_exception(-1)?;
Jiyong Park2227eaa2023-08-04 11:59:18 +0900256 image.set_len(0).context("Failed to reset a file").or_service_specific_exception(-1)?;
Shikha Panwar9ae2e622024-01-30 12:22:30 +0000257
Jiyong Park2227eaa2023-08-04 11:59:18 +0900258 let mut part = QcowFile::new(image, size_bytes)
259 .context("Failed to create QCOW2 image")
260 .or_service_specific_exception(-1)?;
David Brazdilf50c7a62023-04-19 14:22:42 +0000261
262 match partition_type {
263 PartitionType::RAW => Ok(()),
264 PartitionType::ANDROID_VM_INSTANCE => format_as_android_vm_instance(&mut part),
265 PartitionType::ENCRYPTEDSTORE => format_as_encryptedstore(&mut part),
266 _ => Err(Error::new(
267 ErrorKind::Unsupported,
268 format!("Unsupported partition type {:?}", partition_type),
269 )),
270 }
Jiyong Park2227eaa2023-08-04 11:59:18 +0900271 .with_context(|| format!("Failed to initialize partition as {:?}", partition_type))
272 .or_service_specific_exception(-1)?;
David Brazdilf50c7a62023-04-19 14:22:42 +0000273
274 Ok(())
Andrew Walbrandff3b942021-06-09 15:20:36 +0000275 }
276
Jiyong Park0a248432021-08-20 23:32:39 +0900277 /// Creates or update the idsig file by digesting the input APK file.
278 fn createOrUpdateIdsigFile(
279 &self,
280 input_fd: &ParcelFileDescriptor,
281 idsig_fd: &ParcelFileDescriptor,
282 ) -> binder::Result<()> {
Jiyong Parkc3ca24f2022-06-28 10:45:15 +0900283 check_manage_access()?;
284
Jiyong Park2227eaa2023-08-04 11:59:18 +0900285 create_or_update_idsig_file(input_fd, idsig_fd).or_service_specific_exception(-1)?;
Jiyong Park0a248432021-08-20 23:32:39 +0900286 Ok(())
287 }
288
Andrew Walbran320b5602021-03-04 16:11:12 +0000289 /// Get a list of all currently running VMs. This method is only intended for debug purposes,
290 /// and as such is only permitted from the shell user.
291 fn debugListVms(&self) -> binder::Result<Vec<VirtualMachineDebugInfo>> {
David Brazdil209074a2023-01-12 16:44:51 +0000292 // Delegate to the global service, including checking the debug permission.
David Brazdild4f51a52023-01-11 14:09:27 +0000293 GLOBAL_SERVICE.debugListVms()
Andrew Walbran320b5602021-03-04 16:11:12 +0000294 }
Inseob Kim53d0b212023-07-20 16:58:37 +0900295
296 /// Get a list of assignable device types.
297 fn getAssignableDevices(&self) -> binder::Result<Vec<AssignableDevice>> {
298 // Delegate to the global service, including checking the permission.
299 GLOBAL_SERVICE.getAssignableDevices()
300 }
Nikita Ioffef7c742a2023-09-04 16:57:59 +0100301
Inseob Kim46257382024-01-03 15:41:22 +0900302 /// Get a list of supported OSes.
303 fn getSupportedOSList(&self) -> binder::Result<Vec<String>> {
304 Ok(Vec::from_iter(SUPPORTED_OS_NAMES.iter().cloned()))
305 }
306
Nikita Ioffef7c742a2023-09-04 16:57:59 +0100307 /// Returns whether given feature is enabled
308 fn isFeatureEnabled(&self, feature: &str) -> binder::Result<bool> {
309 check_manage_access()?;
Shikha Panwar6d306412024-02-17 21:37:49 +0000310 Ok(avf_features::is_feature_enabled(feature))
Nikita Ioffef7c742a2023-09-04 16:57:59 +0100311 }
Alice Wange64dd182024-01-17 15:57:55 +0000312
313 fn enableTestAttestation(&self) -> binder::Result<()> {
314 GLOBAL_SERVICE.enableTestAttestation()
315 }
Andrew Walbran320b5602021-03-04 16:11:12 +0000316}
317
Jiyong Park8611a6c2021-07-09 18:17:44 +0900318impl VirtualizationService {
319 pub fn init() -> VirtualizationService {
David Brazdil49f96f52022-12-16 21:29:13 +0000320 VirtualizationService::default()
Jiyong Park8611a6c2021-07-09 18:17:44 +0900321 }
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000322
David Brazdil209074a2023-01-12 16:44:51 +0000323 fn create_vm_context(
324 &self,
325 requester_debug_pid: pid_t,
326 ) -> binder::Result<(VmContext, Cid, PathBuf)> {
David Brazdil8cf8f482022-11-23 14:21:26 +0000327 const NUM_ATTEMPTS: usize = 5;
328
329 for _ in 0..NUM_ATTEMPTS {
Charisee96113f32023-01-26 09:00:42 +0000330 let vm_context = GLOBAL_SERVICE.allocateGlobalVmContext(requester_debug_pid)?;
David Brazdild4f51a52023-01-11 14:09:27 +0000331 let cid = vm_context.getCid()? as Cid;
332 let temp_dir: PathBuf = vm_context.getTemporaryDirectory()?.into();
David Brazdil8cf8f482022-11-23 14:21:26 +0000333 let service = VirtualMachineService::new_binder(self.state.clone(), cid).as_binder();
334
335 // Start VM service listening for connections from the new CID on port=CID.
David Brazdil8cf8f482022-11-23 14:21:26 +0000336 let port = cid;
David Brazdil3238da42022-11-18 10:04:51 +0000337 match RpcServer::new_vsock(service, cid, port) {
David Brazdil8cf8f482022-11-23 14:21:26 +0000338 Ok(vm_server) => {
339 vm_server.start();
David Brazdild4f51a52023-01-11 14:09:27 +0000340 return Ok((VmContext::new(vm_context, vm_server), cid, temp_dir));
David Brazdil8cf8f482022-11-23 14:21:26 +0000341 }
342 Err(err) => {
343 warn!("Could not start RpcServer on port {}: {}", port, err);
344 }
345 }
346 }
Jiyong Park2227eaa2023-08-04 11:59:18 +0900347 Err(anyhow!("Too many attempts to create VM context failed"))
348 .or_service_specific_exception(-1)
David Brazdil8cf8f482022-11-23 14:21:26 +0000349 }
350
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000351 fn create_vm_internal(
352 &self,
353 config: &VirtualMachineConfig,
Jiyong Parke6fb1672023-06-26 16:45:55 +0900354 console_out_fd: Option<&ParcelFileDescriptor>,
355 console_in_fd: Option<&ParcelFileDescriptor>,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000356 log_fd: Option<&ParcelFileDescriptor>,
357 is_protected: &mut bool,
358 ) -> binder::Result<Strong<dyn IVirtualMachine>> {
David Brazdil209074a2023-01-12 16:44:51 +0000359 let requester_uid = get_calling_uid();
360 let requester_debug_pid = get_calling_pid();
361
Nikita Ioffe631717e2023-09-05 13:38:07 +0100362 check_config_features(config)?;
363
David Brazdil209074a2023-01-12 16:44:51 +0000364 // Allocating VM context checks the MANAGE_VIRTUAL_MACHINE permission.
365 let (vm_context, cid, temporary_directory) = self.create_vm_context(requester_debug_pid)?;
Inseob Kim1119d702022-05-02 18:01:58 +0900366
Alan Stokesfda70842023-12-20 17:50:14 +0000367 if is_custom_config(config) {
Alan Stokes7bc146c2022-10-20 17:10:32 +0100368 check_use_custom_virtual_machine()?;
Inseob Kim1119d702022-05-02 18:01:58 +0900369 }
370
Nikita Ioffe5776f082023-02-10 21:38:26 +0000371 let gdb_port = extract_gdb_port(config);
372
373 // Additional permission checks if caller request gdb.
374 if gdb_port.is_some() {
375 check_gdb_allowed(config)?;
376 }
377
Shikha Panwar8707f0f2024-02-28 20:40:42 +0000378 // Currently, VirtMgr adds the host copy of reference DT & untrusted properties
379 // (e.g. instance-id)
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000380 let host_ref_dt = Path::new(VM_REFERENCE_DT_ON_HOST_PATH);
381 let host_ref_dt = if host_ref_dt.exists()
382 && read_dir(host_ref_dt).or_service_specific_exception(-1)?.next().is_some()
383 {
384 Some(host_ref_dt)
385 } else {
386 warn!("VM reference DT doesn't exist in host DT");
387 None
388 };
389
Seungjae Yoo14e60182024-02-21 13:28:31 +0900390 let vendor_hashtree_digest = extract_vendor_hashtree_digest(config)
391 .context("Failed to extract vendor hashtree digest")
392 .or_service_specific_exception(-1)?;
393
394 let trusted_props = if let Some(ref vendor_hashtree_digest) = vendor_hashtree_digest {
395 info!(
396 "Passing vendor hashtree digest to pvmfw. This will be rejected if it doesn't \
397 match the trusted digest in the pvmfw config, causing the VM to fail to start."
398 );
399 vec![(
400 cstr!("vendor_hashtree_descriptor_root_digest"),
401 vendor_hashtree_digest.as_slice(),
402 )]
403 } else {
404 vec![]
405 };
406
Shikha Panwar61a74b52024-02-16 13:17:01 +0000407 let instance_id;
Shikha Panwar8707f0f2024-02-28 20:40:42 +0000408 let mut untrusted_props = Vec::with_capacity(2);
409 if cfg!(llpvm_changes) {
Shikha Panwar61a74b52024-02-16 13:17:01 +0000410 instance_id = extract_instance_id(config);
Shikha Panwar8707f0f2024-02-28 20:40:42 +0000411 untrusted_props.push((cstr!("instance-id"), &instance_id[..]));
412 if is_secretkeeper_supported() {
413 // Let guest know that it can defer rollback protection to Secretkeeper by setting
414 // an empty property in untrusted node in DT. This enables Updatable VMs.
415 untrusted_props.push((cstr!("defer-rollback-protection"), &[]))
416 }
417 }
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000418
Seungjae Yoo14e60182024-02-21 13:28:31 +0900419 let device_tree_overlay =
420 if host_ref_dt.is_some() || !untrusted_props.is_empty() || !trusted_props.is_empty() {
421 let dt_output = temporary_directory.join(VM_DT_OVERLAY_PATH);
422 let mut data = [0_u8; VM_DT_OVERLAY_MAX_SIZE];
423 let fdt = create_device_tree_overlay(
424 &mut data,
425 host_ref_dt,
426 &untrusted_props,
427 &trusted_props,
428 )
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000429 .map_err(|e| anyhow!("Failed to create DT overlay, {e:?}"))
430 .or_service_specific_exception(-1)?;
Seungjae Yoo14e60182024-02-21 13:28:31 +0900431 fs::write(&dt_output, fdt.as_slice()).or_service_specific_exception(-1)?;
432 Some(File::open(dt_output).or_service_specific_exception(-1)?)
433 } else {
434 None
435 };
Seungjae Yooec3bc522023-11-09 10:14:30 +0900436
Jaewan Kim61f86142023-03-28 15:12:52 +0900437 let debug_level = match config {
438 VirtualMachineConfig::AppConfig(config) => config.debugLevel,
439 _ => DebugLevel::NONE,
440 };
441 let debug_config = DebugConfig::new(debug_level);
442
443 let ramdump = if debug_config.is_ramdump_needed() {
Jiyong Parked180932023-02-24 19:55:41 +0900444 Some(prepare_ramdump_file(&temporary_directory)?)
445 } else {
446 None
447 };
448
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000449 let state = &mut *self.state.lock().unwrap();
Jiyong Parke6fb1672023-06-26 16:45:55 +0900450 let console_out_fd =
451 clone_or_prepare_logger_fd(&debug_config, console_out_fd, format!("Console({})", cid))?;
452 let console_in_fd = console_in_fd.map(clone_file).transpose()?;
Jaewan Kim61f86142023-03-28 15:12:52 +0900453 let log_fd = clone_or_prepare_logger_fd(&debug_config, log_fd, format!("Log({})", cid))?;
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000454
455 // Counter to generate unique IDs for temporary image files.
456 let mut next_temporary_image_id = 0;
457 // Files which are referred to from composite images. These must be mapped to the crosvm
458 // child process, and not closed before it is started.
459 let mut indirect_files = vec![];
460
Alan Stokes7bc146c2022-10-20 17:10:32 +0100461 let (is_app_config, config) = match config {
462 VirtualMachineConfig::RawConfig(config) => (false, BorrowedOrOwned::Borrowed(config)),
463 VirtualMachineConfig::AppConfig(config) => {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900464 let config = load_app_config(config, &debug_config, &temporary_directory)
465 .or_service_specific_exception_with(-1, |e| {
Jaewan Kim61f86142023-03-28 15:12:52 +0900466 *is_protected = config.protectedVm;
467 let message = format!("Failed to load app config: {:?}", e);
468 error!("{}", message);
Jiyong Park2227eaa2023-08-04 11:59:18 +0900469 message
Jaewan Kim61f86142023-03-28 15:12:52 +0900470 })?;
Alan Stokes7bc146c2022-10-20 17:10:32 +0100471 (true, BorrowedOrOwned::Owned(config))
472 }
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000473 };
474 let config = config.as_ref();
475 *is_protected = config.protectedVm;
476
477 // Check if partition images are labeled incorrectly. This is to prevent random images
478 // which are not protected by the Android Verified Boot (e.g. bits downloaded by apps) from
Alan Stokes3e5eec12023-09-07 12:10:00 +0100479 // being loaded in a pVM. This applies to everything but the instance image in the raw
480 // config, and everything but the non-executable, generated partitions in the app
481 // config.
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000482 config
483 .disks
484 .iter()
485 .flat_map(|disk| disk.partitions.iter())
486 .filter(|partition| {
487 if is_app_config {
Alan Stokes53cc5ca2022-08-30 14:28:19 +0100488 !is_safe_app_partition(&partition.label)
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000489 } else {
Alice Wangc206b9b2023-08-28 14:13:51 +0000490 !is_safe_raw_partition(&partition.label)
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000491 }
492 })
493 .try_for_each(check_label_for_partition)
Jiyong Park2227eaa2023-08-04 11:59:18 +0900494 .or_service_specific_exception(-1)?;
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000495
Inseob Kimff48a7c2024-02-26 22:07:21 +0900496 // Check if files for payloads and bases are NOT coming from /vendor and /odm, as they may
497 // have unstable interfaces.
498 // TODO(b/316431494): remove once Treble interfaces are stabilized.
499 check_partitions_for_files(config).or_service_specific_exception(-1)?;
500
Alan Stokes185fe112023-01-10 16:20:55 +0000501 let kernel = maybe_clone_file(&config.kernel)?;
502 let initrd = maybe_clone_file(&config.initrd)?;
503
504 // In a protected VM, we require custom kernels to come from a trusted source (b/237054515).
505 if config.protectedVm {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900506 check_label_for_kernel_files(&kernel, &initrd).or_service_specific_exception(-1)?;
Alan Stokes185fe112023-01-10 16:20:55 +0000507 }
508
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000509 let zero_filler_path = temporary_directory.join("zero.img");
Jiyong Park2227eaa2023-08-04 11:59:18 +0900510 write_zero_filler(&zero_filler_path)
511 .context("Failed to make composite image")
512 .with_log()
513 .or_service_specific_exception(-1)?;
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000514
515 // Assemble disk images if needed.
516 let disks = config
517 .disks
518 .iter()
519 .map(|disk| {
520 assemble_disk_image(
521 disk,
522 &zero_filler_path,
523 &temporary_directory,
524 &mut next_temporary_image_id,
525 &mut indirect_files,
526 )
527 })
528 .collect::<Result<Vec<DiskFile>, _>>()?;
529
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000530 let (cpus, host_cpu_topology) = match config.cpuTopology {
531 CpuTopology::MATCH_HOST => (None, true),
532 CpuTopology::ONE_CPU => (NonZeroU32::new(1), false),
533 val => {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900534 return Err(anyhow!("Failed to parse CPU topology value {:?}", val))
535 .with_log()
536 .or_service_specific_exception(-1);
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000537 }
538 };
539
David Brazdil2dfefd12023-11-17 14:07:36 +0000540 let (vfio_devices, dtbo) = if !config.devices.is_empty() {
Inseob Kim6ef80972023-07-20 17:23:36 +0900541 let mut set = HashSet::new();
542 for device in config.devices.iter() {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900543 let path = canonicalize(device)
544 .with_context(|| format!("can't canonicalize {device}"))
545 .or_service_specific_exception(-1)?;
Inseob Kim6ef80972023-07-20 17:23:36 +0900546 if !set.insert(path) {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900547 return Err(anyhow!("duplicated device {device}"))
548 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT);
Inseob Kim6ef80972023-07-20 17:23:36 +0900549 }
550 }
Jakob Vukalovicd42aa2c2023-11-09 16:04:00 +0000551 let devices = GLOBAL_SERVICE.bindDevicesToVfioDriver(&config.devices)?;
David Brazdil2dfefd12023-11-17 14:07:36 +0000552 let dtbo_file = File::from(
553 GLOBAL_SERVICE
554 .getDtboFile()?
555 .as_ref()
556 .try_clone()
Jaewan Kim39952072024-01-19 17:04:53 +0900557 .context("Failed to create VM DTBO from ParcelFileDescriptor")
David Brazdil2dfefd12023-11-17 14:07:36 +0000558 .or_binder_exception(ExceptionCode::BAD_PARCELABLE)?,
559 );
560 (devices, Some(dtbo_file))
Inseob Kim7307a892023-09-14 13:37:58 +0900561 } else {
David Brazdil2dfefd12023-11-17 14:07:36 +0000562 (vec![], None)
Inseob Kim7307a892023-09-14 13:37:58 +0900563 };
Inseob Kim6ef80972023-07-20 17:23:36 +0900564
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000565 // Actually start the VM.
566 let crosvm_config = CrosvmConfig {
567 cid,
Seungjae Yoo62085c02022-08-12 04:44:52 +0000568 name: config.name.clone(),
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000569 bootloader: maybe_clone_file(&config.bootloader)?,
Alan Stokes185fe112023-01-10 16:20:55 +0000570 kernel,
571 initrd,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000572 disks,
573 params: config.params.to_owned(),
574 protected: *is_protected,
Jaewan Kim61f86142023-03-28 15:12:52 +0900575 debug_config,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000576 memory_mib: config.memoryMib.try_into().ok().and_then(NonZeroU32::new),
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000577 cpus,
578 host_cpu_topology,
Jiyong Parke6fb1672023-06-26 16:45:55 +0900579 console_out_fd,
580 console_in_fd,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000581 log_fd,
Jiyong Parked180932023-02-24 19:55:41 +0900582 ramdump,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000583 indirect_files,
584 platform_version: parse_platform_version_req(&config.platformVersion)?,
Jiyong Parke6ed0f92022-06-22 00:13:00 +0900585 detect_hangup: is_app_config,
Nikita Ioffe5776f082023-02-10 21:38:26 +0000586 gdb_port,
Inseob Kim7307a892023-09-14 13:37:58 +0900587 vfio_devices,
David Brazdil2dfefd12023-11-17 14:07:36 +0000588 dtbo,
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000589 device_tree_overlay,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000590 };
591 let instance = Arc::new(
David Brazdil528e0472022-10-10 15:06:02 +0100592 VmInstance::new(
593 crosvm_config,
594 temporary_directory,
595 requester_uid,
596 requester_debug_pid,
597 vm_context,
598 )
Jiyong Park2227eaa2023-08-04 11:59:18 +0900599 .with_context(|| format!("Failed to create VM with config {:?}", config))
600 .with_log()
601 .or_service_specific_exception(-1)?,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000602 );
603 state.add_vm(Arc::downgrade(&instance));
604 Ok(VirtualMachine::create(instance))
605 }
Jiyong Park8611a6c2021-07-09 18:17:44 +0900606}
607
Alan Stokesfda70842023-12-20 17:50:14 +0000608/// Returns whether a VM config represents a "custom" virtual machine, which requires the
609/// USE_CUSTOM_VIRTUAL_MACHINE.
610fn is_custom_config(config: &VirtualMachineConfig) -> bool {
611 match config {
612 // Any raw (non-Microdroid) VM is considered custom.
613 VirtualMachineConfig::RawConfig(_) => true,
614 VirtualMachineConfig::AppConfig(config) => {
615 // Some features are reserved for platform apps only, even when using
616 // VirtualMachineAppConfig. Almost all of these features are grouped in the
617 // CustomConfig struct:
618 // - controlling CPUs;
619 // - gdbPort is set, meaning that crosvm will start a gdb server;
620 // - using anything other than the default kernel;
621 // - specifying devices to be assigned.
622 if config.customConfig.is_some() {
623 true
624 } else {
625 // Additional custom features not included in CustomConfig:
626 // - specifying a config file;
Alan Stokes736f6822024-02-16 16:08:00 +0000627 // - specifying extra APKs;
628 // - specifying an OS other than Microdroid.
Alan Stokesfda70842023-12-20 17:50:14 +0000629 match &config.payload {
630 Payload::ConfigPath(_) => true,
Alan Stokes736f6822024-02-16 16:08:00 +0000631 Payload::PayloadConfig(payload_config) => {
632 !payload_config.extraApks.is_empty()
633 || payload_config.osName != MICRODROID_OS_NAME
634 }
Alan Stokesfda70842023-12-20 17:50:14 +0000635 }
636 }
637 }
638 }
639}
640
Seungjae Yoo14e60182024-02-21 13:28:31 +0900641fn extract_vendor_hashtree_digest(config: &VirtualMachineConfig) -> Result<Option<Vec<u8>>> {
642 let VirtualMachineConfig::AppConfig(config) = config else {
643 return Ok(None);
644 };
645 let Some(custom_config) = &config.customConfig else {
646 return Ok(None);
647 };
648 let Some(file) = custom_config.vendorImage.as_ref() else {
649 return Ok(None);
650 };
651
652 let file = clone_file(file)?;
653 let size =
654 file.metadata().context("Failed to get metadata from microdroid vendor image")?.len();
655 let vbmeta = VbMetaImage::verify_reader_region(&file, 0, size)
656 .context("Failed to get vbmeta from microdroid-vendor.img")?;
657
658 for descriptor in vbmeta.descriptors()?.iter() {
659 if let vbmeta::Descriptor::Hashtree(_) = descriptor {
660 let root_digest = hex::encode(descriptor.to_hashtree()?.root_digest());
661 return Ok(Some(root_digest.as_bytes().to_vec()));
662 }
663 }
664 Err(anyhow!("No hashtree digest is extracted from microdroid vendor image"))
665}
666
Andrew Walbranfbb39d22021-07-28 17:01:25 +0000667fn write_zero_filler(zero_filler_path: &Path) -> Result<()> {
Jooyung Han95884632021-07-06 22:27:54 +0900668 let file = OpenOptions::new()
669 .create_new(true)
670 .read(true)
671 .write(true)
672 .open(zero_filler_path)
673 .with_context(|| "Failed to create zero.img")?;
674 file.set_len(ZERO_FILLER_SIZE)?;
Andrew Walbranfbb39d22021-07-28 17:01:25 +0000675 Ok(())
Jooyung Han95884632021-07-06 22:27:54 +0900676}
677
David Brazdilf50c7a62023-04-19 14:22:42 +0000678fn format_as_android_vm_instance(part: &mut dyn Write) -> std::io::Result<()> {
679 part.write_all(ANDROID_VM_INSTANCE_MAGIC.as_bytes())?;
680 part.write_all(&ANDROID_VM_INSTANCE_VERSION.to_le_bytes())?;
681 part.flush()
682}
683
684fn format_as_encryptedstore(part: &mut dyn Write) -> std::io::Result<()> {
685 part.write_all(UNFORMATTED_STORAGE_MAGIC.as_bytes())?;
686 part.flush()
687}
688
689fn round_up(input: u64, granularity: u64) -> u64 {
690 if granularity == 0 {
691 return input;
692 }
693 // If the input is absurdly large we round down instead of up; it's going to fail anyway.
694 let result = input.checked_add(granularity - 1).unwrap_or(input);
695 (result / granularity) * granularity
696}
697
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000698/// Given the configuration for a disk image, assembles the `DiskFile` to pass to crosvm.
699///
700/// This may involve assembling a composite disk from a set of partition images.
701fn assemble_disk_image(
702 disk: &DiskImage,
Jooyung Han95884632021-07-06 22:27:54 +0900703 zero_filler_path: &Path,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000704 temporary_directory: &Path,
705 next_temporary_image_id: &mut u64,
706 indirect_files: &mut Vec<File>,
Andrew Walbran806f1542021-06-10 14:07:12 +0000707) -> Result<DiskFile, Status> {
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000708 let image = if !disk.partitions.is_empty() {
709 if disk.image.is_some() {
710 warn!("DiskImage {:?} contains both image and partitions.", disk);
Jiyong Park2227eaa2023-08-04 11:59:18 +0900711 return Err(anyhow!("DiskImage contains both image and partitions"))
712 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT);
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000713 }
714
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000715 let composite_image_filenames =
716 make_composite_image_filenames(temporary_directory, next_temporary_image_id);
717 let (image, partition_files) = make_composite_image(
718 &disk.partitions,
Jooyung Han95884632021-07-06 22:27:54 +0900719 zero_filler_path,
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000720 &composite_image_filenames.composite,
721 &composite_image_filenames.header,
722 &composite_image_filenames.footer,
723 )
Jiyong Park2227eaa2023-08-04 11:59:18 +0900724 .with_context(|| format!("Failed to make composite disk image with config {:?}", disk))
725 .with_log()
726 .or_service_specific_exception(-1)?;
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000727
728 // Pass the file descriptors for the various partition files to crosvm when it
729 // is run.
730 indirect_files.extend(partition_files);
731
732 image
733 } else if let Some(image) = &disk.image {
734 clone_file(image)?
735 } else {
736 warn!("DiskImage {:?} didn't contain image or partitions.", disk);
Jiyong Park2227eaa2023-08-04 11:59:18 +0900737 return Err(anyhow!("DiskImage didn't contain image or partitions."))
738 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT);
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000739 };
740
741 Ok(DiskFile { image, writable: disk.writable })
742}
743
Nikita Ioffeaa6858c2023-07-04 01:37:41 +0100744fn append_kernel_param(param: &str, vm_config: &mut VirtualMachineRawConfig) {
745 if let Some(ref mut params) = vm_config.params {
746 params.push(' ');
747 params.push_str(param)
748 } else {
749 vm_config.params = Some(param.to_owned())
750 }
751}
752
Inseob Kim46257382024-01-03 15:41:22 +0900753fn extract_os_name_from_config_path(config: &Path) -> Option<String> {
754 if config.extension()?.to_str()? != "json" {
755 return None;
Inseob Kim172f9eb2023-11-06 17:02:08 +0900756 }
Inseob Kim46257382024-01-03 15:41:22 +0900757
758 Some(config.with_extension("").file_name()?.to_str()?.to_owned())
759}
760
761fn extract_os_names_from_configs(config_glob_pattern: &str) -> Result<HashSet<String>> {
762 let configs = glob(config_glob_pattern)?.collect::<Result<Vec<_>, _>>()?;
763 let os_names =
764 configs.iter().filter_map(|x| extract_os_name_from_config_path(x)).collect::<HashSet<_>>();
765
766 Ok(os_names)
767}
768
769fn get_supported_os_names() -> Result<HashSet<String>> {
770 if !cfg!(vendor_modules) {
771 return Ok(iter::once(MICRODROID_OS_NAME.to_owned()).collect());
772 }
773
774 extract_os_names_from_configs("/apex/com.android.virt/etc/microdroid*.json")
775}
776
777fn is_valid_os(os_name: &str) -> bool {
778 SUPPORTED_OS_NAMES.contains(os_name)
Inseob Kim172f9eb2023-11-06 17:02:08 +0900779}
780
Jooyung Han21e9b922021-06-26 04:14:16 +0900781fn load_app_config(
782 config: &VirtualMachineAppConfig,
Jaewan Kim61f86142023-03-28 15:12:52 +0900783 debug_config: &DebugConfig,
Jooyung Han21e9b922021-06-26 04:14:16 +0900784 temporary_directory: &Path,
Jooyung Hanadfb76c2021-06-28 17:29:30 +0900785) -> Result<VirtualMachineRawConfig> {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000786 let apk_file = clone_file(config.apk.as_ref().unwrap())?;
787 let idsig_file = clone_file(config.idsig.as_ref().unwrap())?;
Jiyong Park8d081812021-07-23 17:45:04 +0900788 let instance_file = clone_file(config.instanceImage.as_ref().unwrap())?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900789
Shikha Panwar22e70452022-10-10 18:32:55 +0000790 let storage_image = if let Some(file) = config.encryptedStorageImage.as_ref() {
791 Some(clone_file(file)?)
792 } else {
793 None
794 };
795
Alan Stokesfda70842023-12-20 17:50:14 +0000796 let vm_payload_config;
797 let extra_apk_files: Vec<_>;
798 match &config.payload {
Alan Stokes0d1ef782022-09-27 13:46:35 +0100799 Payload::ConfigPath(config_path) => {
Alan Stokesfda70842023-12-20 17:50:14 +0000800 vm_payload_config =
801 load_vm_payload_config_from_file(&apk_file, config_path.as_str())
802 .with_context(|| format!("Couldn't read config from {}", config_path))?;
803 extra_apk_files = vm_payload_config
804 .extra_apks
805 .iter()
806 .enumerate()
807 .map(|(i, apk)| {
808 File::open(PathBuf::from(&apk.path))
809 .with_context(|| format!("Failed to open extra apk #{i} {}", apk.path))
810 })
811 .collect::<Result<_>>()?;
Alan Stokes0d1ef782022-09-27 13:46:35 +0100812 }
Alan Stokesfda70842023-12-20 17:50:14 +0000813 Payload::PayloadConfig(payload_config) => {
814 vm_payload_config = create_vm_payload_config(payload_config)?;
815 extra_apk_files =
816 payload_config.extraApks.iter().map(clone_file).collect::<binder::Result<_>>()?;
817 }
Alan Stokes0d1ef782022-09-27 13:46:35 +0100818 };
Jooyung Han21e9b922021-06-26 04:14:16 +0900819
Inseob Kim172f9eb2023-11-06 17:02:08 +0900820 // For now, the only supported OS is Microdroid and Microdroid GKI
Alan Stokes0d1ef782022-09-27 13:46:35 +0100821 let os_name = vm_payload_config.os.name.as_str();
Inseob Kim172f9eb2023-11-06 17:02:08 +0900822 if !is_valid_os(os_name) {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000823 bail!("Unknown OS \"{}\"", os_name);
Jooyung Han35edb8f2021-07-01 16:17:16 +0900824 }
Andrew Walbrancc0db522021-07-12 17:03:42 +0000825
826 // It is safe to construct a filename based on the os_name because we've already checked that it
827 // is one of the allowed values.
Jooyung Han21e9b922021-06-26 04:14:16 +0900828 let vm_config_path = PathBuf::from(format!("/apex/com.android.virt/etc/{}.json", os_name));
829 let vm_config_file = File::open(vm_config_path)?;
Andrew Walbrancc0db522021-07-12 17:03:42 +0000830 let mut vm_config = VmConfig::load(&vm_config_file)?.to_parcelable()?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900831
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +0100832 if let Some(custom_config) = &config.customConfig {
833 if let Some(file) = custom_config.customKernelImage.as_ref() {
834 vm_config.kernel = Some(ParcelFileDescriptor::new(clone_file(file)?))
835 }
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +0100836 vm_config.gdbPort = custom_config.gdbPort;
Nikita Ioffe5dfddf22023-06-29 16:11:26 +0100837
838 if let Some(file) = custom_config.vendorImage.as_ref() {
Nikita Ioffeaa6858c2023-07-04 01:37:41 +0100839 add_microdroid_vendor_image(clone_file(file)?, &mut vm_config);
840 append_kernel_param("androidboot.microdroid.mount_vendor=1", &mut vm_config)
Nikita Ioffe5dfddf22023-06-29 16:11:26 +0100841 }
Inseob Kim6ef80972023-07-20 17:23:36 +0900842
843 vm_config.devices = custom_config.devices.clone();
Nikita Ioffe26c35ed2023-06-05 17:49:08 +0100844 }
845
Andrew Walbrancc045902021-07-27 16:06:17 +0000846 if config.memoryMib > 0 {
847 vm_config.memoryMib = config.memoryMib;
Andrew Walbran45bcb0c2021-07-14 15:02:06 +0000848 }
849
Seungjae Yoo62085c02022-08-12 04:44:52 +0000850 vm_config.name = config.name.clone();
Andrew Walbran3994f002022-01-27 17:33:45 +0000851 vm_config.protectedVm = config.protectedVm;
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000852 vm_config.cpuTopology = config.cpuTopology;
Jiyong Park032615f2022-01-10 13:55:34 +0900853
Shikha Panwar22e70452022-10-10 18:32:55 +0000854 // Microdroid takes additional init ramdisk & (optionally) storage image
Inseob Kim172f9eb2023-11-06 17:02:08 +0900855 add_microdroid_system_images(config, instance_file, storage_image, os_name, &mut vm_config)?;
Shikha Panwar22e70452022-10-10 18:32:55 +0000856
857 // Include Microdroid payload disk (contains apks, idsigs) in vm config
858 add_microdroid_payload_images(
Alan Stokes0d1ef782022-09-27 13:46:35 +0100859 config,
Jaewan Kim61f86142023-03-28 15:12:52 +0900860 debug_config,
Alan Stokes0d1ef782022-09-27 13:46:35 +0100861 temporary_directory,
862 apk_file,
863 idsig_file,
Alan Stokesfda70842023-12-20 17:50:14 +0000864 extra_apk_files,
Alan Stokes0d1ef782022-09-27 13:46:35 +0100865 &vm_payload_config,
866 &mut vm_config,
867 )?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900868
Andrew Walbrancc0db522021-07-12 17:03:42 +0000869 Ok(vm_config)
Jooyung Han21e9b922021-06-26 04:14:16 +0900870}
871
Inseob Kimff48a7c2024-02-26 22:07:21 +0900872fn check_partition_for_file(fd: &ParcelFileDescriptor) -> Result<()> {
873 let path = format!("/proc/self/fd/{}", fd.as_raw_fd());
874 let link = fs::read_link(&path).context(format!("can't read_link {path}"))?;
875
876 // microdroid vendor image is OK
877 if cfg!(vendor_modules) && link == Path::new("/vendor/etc/avf/microdroid/microdroid_vendor.img")
878 {
879 return Ok(());
880 }
881
882 if link.starts_with("/vendor") || link.starts_with("/odm") {
883 bail!("vendor or odm file {} can't be used for VM", link.display());
884 }
885
886 Ok(())
887}
888
889fn check_partitions_for_files(config: &VirtualMachineRawConfig) -> Result<()> {
890 config
891 .disks
892 .iter()
893 .flat_map(|disk| disk.partitions.iter())
894 .filter_map(|partition| partition.image.as_ref())
895 .try_for_each(check_partition_for_file)?;
896
897 config.kernel.as_ref().map_or(Ok(()), check_partition_for_file)?;
898 config.initrd.as_ref().map_or(Ok(()), check_partition_for_file)?;
899 config.bootloader.as_ref().map_or(Ok(()), check_partition_for_file)?;
900
901 Ok(())
902}
903
Alan Stokes0d1ef782022-09-27 13:46:35 +0100904fn load_vm_payload_config_from_file(apk_file: &File, config_path: &str) -> Result<VmPayloadConfig> {
905 let mut apk_zip = ZipArchive::new(apk_file)?;
906 let config_file = apk_zip.by_name(config_path)?;
907 Ok(serde_json::from_reader(config_file)?)
908}
909
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000910fn create_vm_payload_config(
911 payload_config: &VirtualMachinePayloadConfig,
912) -> Result<VmPayloadConfig> {
Alan Stokes0d1ef782022-09-27 13:46:35 +0100913 // There isn't an actual config file. Construct a synthetic VmPayloadConfig from the explicit
914 // parameters we've been given. Microdroid will do something equivalent inside the VM using the
915 // payload config that we send it via the metadata file.
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000916
917 let payload_binary_name = &payload_config.payloadBinaryName;
918 if payload_binary_name.contains('/') {
919 bail!("Payload binary name must not specify a path: {payload_binary_name}");
920 }
921
922 let task = Task { type_: TaskType::MicrodroidLauncher, command: payload_binary_name.clone() };
Inseob Kim172f9eb2023-11-06 17:02:08 +0900923 let name = payload_config.osName.clone();
Alan Stokesfda70842023-12-20 17:50:14 +0000924
925 // The VM only cares about how many there are, these names are actually ignored.
926 let extra_apk_count = payload_config.extraApks.len();
927 let extra_apks =
928 (0..extra_apk_count).map(|i| ApkConfig { path: format!("extra-apk-{i}") }).collect();
929
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000930 Ok(VmPayloadConfig {
Inseob Kim172f9eb2023-11-06 17:02:08 +0900931 os: OsConfig { name },
Alan Stokes0d1ef782022-09-27 13:46:35 +0100932 task: Some(task),
933 apexes: vec![],
Alan Stokesfda70842023-12-20 17:50:14 +0000934 extra_apks,
Alan Stokes0d1ef782022-09-27 13:46:35 +0100935 prefer_staged: false,
Inseob Kimab1037d2023-02-08 17:03:31 +0900936 export_tombstones: None,
Alan Stokes0d1ef782022-09-27 13:46:35 +0100937 enable_authfs: false,
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000938 })
Alan Stokes0d1ef782022-09-27 13:46:35 +0100939}
940
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000941/// Generates a unique filename to use for a composite disk image.
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000942fn make_composite_image_filenames(
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000943 temporary_directory: &Path,
944 next_temporary_image_id: &mut u64,
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000945) -> CompositeImageFilenames {
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000946 let id = *next_temporary_image_id;
947 *next_temporary_image_id += 1;
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000948 CompositeImageFilenames {
949 composite: temporary_directory.join(format!("composite-{}.img", id)),
950 header: temporary_directory.join(format!("composite-{}-header.img", id)),
951 footer: temporary_directory.join(format!("composite-{}-footer.img", id)),
952 }
953}
954
955/// Filenames for a composite disk image, including header and footer partitions.
956#[derive(Clone, Debug, Eq, PartialEq)]
957struct CompositeImageFilenames {
958 /// The composite disk image itself.
959 composite: PathBuf,
960 /// The header partition image.
961 header: PathBuf,
962 /// The footer partition image.
963 footer: PathBuf,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000964}
965
Jiyong Park753553b2021-07-12 21:21:09 +0900966/// Checks whether the caller has a specific permission
967fn check_permission(perm: &str) -> binder::Result<()> {
David Brazdil1f530702022-10-03 12:18:10 +0100968 let calling_pid = get_calling_pid();
969 let calling_uid = get_calling_uid();
Jiyong Park753553b2021-07-12 21:21:09 +0900970 // Root can do anything
971 if calling_uid == 0 {
972 return Ok(());
973 }
974 let perm_svc: Strong<dyn IPermissionController::IPermissionController> =
975 binder::get_interface("permission")?;
976 if perm_svc.checkPermission(perm, calling_pid, calling_uid as i32)? {
Andrew Walbran806f1542021-06-10 14:07:12 +0000977 Ok(())
978 } else {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900979 Err(anyhow!("does not have the {} permission", perm))
980 .or_binder_exception(ExceptionCode::SECURITY)
Andrew Walbran806f1542021-06-10 14:07:12 +0000981 }
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000982}
983
Jiyong Park753553b2021-07-12 21:21:09 +0900984/// Check whether the caller of the current Binder method is allowed to manage VMs
985fn check_manage_access() -> binder::Result<()> {
986 check_permission("android.permission.MANAGE_VIRTUAL_MACHINE")
987}
988
Inseob Kim1119d702022-05-02 18:01:58 +0900989/// Check whether the caller of the current Binder method is allowed to create custom VMs
990fn check_use_custom_virtual_machine() -> binder::Result<()> {
991 check_permission("android.permission.USE_CUSTOM_VIRTUAL_MACHINE")
992}
993
Alan Stokes185fe112023-01-10 16:20:55 +0000994/// Return whether a partition is exempt from selinux label checks, because we know that it does
995/// not contain code and is likely to be generated in an app-writable directory.
Alan Stokes53cc5ca2022-08-30 14:28:19 +0100996fn is_safe_app_partition(label: &str) -> bool {
Shikha Panwara2ff8c52022-11-30 19:25:46 +0000997 // See add_microdroid_system_images & add_microdroid_payload_images in payload.rs.
Alan Stokes53cc5ca2022-08-30 14:28:19 +0100998 label == "vm-instance"
Shikha Panwara2ff8c52022-11-30 19:25:46 +0000999 || label == "encryptedstore"
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001000 || label == "microdroid-apk-idsig"
1001 || label == "payload-metadata"
1002 || label.starts_with("extra-idsig-")
1003}
1004
Alice Wangc206b9b2023-08-28 14:13:51 +00001005/// Returns whether a partition with the given label is safe for a raw config VM.
1006fn is_safe_raw_partition(label: &str) -> bool {
1007 label == "vm-instance"
1008}
1009
Alan Stokes185fe112023-01-10 16:20:55 +00001010/// Check that a file SELinux label is acceptable.
1011///
1012/// We only want to allow code in a VM to be sourced from places that apps, and the
Seungjae Yoo2b74c442023-11-15 18:05:07 +09001013/// system or vendor, do not have write access to.
Alan Stokes185fe112023-01-10 16:20:55 +00001014///
1015/// Note that sepolicy must also grant read access for these types to both virtualization
1016/// service and crosvm.
1017///
1018/// App private data files are deliberately excluded, to avoid arbitrary payloads being run on
1019/// user devices (W^X).
1020fn check_label_is_allowed(context: &SeContext) -> Result<()> {
1021 match context.selinux_type()? {
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001022 | "apk_data_file" // APKs of an installed app
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001023 | "shell_data_file" // test files created via adb shell
Alan Stokesfe4bb0c2023-03-20 14:15:36 +00001024 | "staging_data_file" // updated/staged APEX images
1025 | "system_file" // immutable dm-verity protected partition
1026 | "virtualizationservice_data_file" // files created by VS / VirtMgr
Seungjae Yoo2b74c442023-11-15 18:05:07 +09001027 | "vendor_microdroid_file" // immutable dm-verity protected partition (/vendor/etc/avf/microdroid/.*)
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001028 => Ok(()),
Alan Stokes185fe112023-01-10 16:20:55 +00001029 _ => bail!("Label {} is not allowed", context),
Jiyong Park029977d2021-11-24 21:56:49 +09001030 }
1031}
1032
Alan Stokes185fe112023-01-10 16:20:55 +00001033fn check_label_for_partition(partition: &Partition) -> Result<()> {
1034 let file = partition.image.as_ref().unwrap().as_ref();
1035 check_label_is_allowed(&getfilecon(file)?)
1036 .with_context(|| format!("Partition {} invalid", &partition.label))
1037}
1038
1039fn check_label_for_kernel_files(kernel: &Option<File>, initrd: &Option<File>) -> Result<()> {
1040 if let Some(f) = kernel {
1041 check_label_for_file(f, "kernel")?;
1042 }
1043 if let Some(f) = initrd {
1044 check_label_for_file(f, "initrd")?;
1045 }
1046 Ok(())
1047}
1048fn check_label_for_file(file: &File, name: &str) -> Result<()> {
1049 check_label_is_allowed(&getfilecon(file)?).with_context(|| format!("{} file invalid", name))
1050}
1051
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001052/// Implementation of the AIDL `IVirtualMachine` interface. Used as a handle to a VM.
1053#[derive(Debug)]
1054struct VirtualMachine {
1055 instance: Arc<VmInstance>,
1056}
1057
1058impl VirtualMachine {
1059 fn create(instance: Arc<VmInstance>) -> Strong<dyn IVirtualMachine> {
David Brazdil4b4c5102022-12-19 22:56:20 +00001060 BnVirtualMachine::new_binder(VirtualMachine { instance }, BinderFeatures::default())
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001061 }
1062}
1063
1064impl Interface for VirtualMachine {}
1065
1066impl IVirtualMachine for VirtualMachine {
1067 fn getCid(&self) -> binder::Result<i32> {
Jiyong Park753553b2021-07-12 21:21:09 +09001068 // Don't check permission. The owner of the VM might have passed this binder object to
1069 // others.
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001070 Ok(self.instance.cid as i32)
1071 }
Andrew Walbrandae07162021-03-12 17:05:20 +00001072
Andrew Walbran6b650662021-09-07 13:13:23 +00001073 fn getState(&self) -> binder::Result<VirtualMachineState> {
Jiyong Park753553b2021-07-12 21:21:09 +09001074 // Don't check permission. The owner of the VM might have passed this binder object to
1075 // others.
Andrew Walbran6b650662021-09-07 13:13:23 +00001076 Ok(get_state(&self.instance))
Andrew Walbrandae07162021-03-12 17:05:20 +00001077 }
1078
1079 fn registerCallback(
1080 &self,
1081 callback: &Strong<dyn IVirtualMachineCallback>,
1082 ) -> binder::Result<()> {
Jiyong Park753553b2021-07-12 21:21:09 +09001083 // Don't check permission. The owner of the VM might have passed this binder object to
1084 // others.
1085 //
Andrew Walbrandae07162021-03-12 17:05:20 +00001086 // TODO: Should this give an error if the VM is already dead?
1087 self.instance.callbacks.add(callback.clone());
1088 Ok(())
1089 }
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001090
Andrew Walbranf8d94112021-09-07 11:45:36 +00001091 fn start(&self) -> binder::Result<()> {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001092 self.instance
1093 .start()
1094 .with_context(|| format!("Error starting VM with CID {}", self.instance.cid))
1095 .with_log()
1096 .or_service_specific_exception(-1)
Andrew Walbranf8d94112021-09-07 11:45:36 +00001097 }
1098
Inseob Kima446f802022-07-11 19:46:37 +09001099 fn stop(&self) -> binder::Result<()> {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001100 self.instance
1101 .kill()
1102 .with_context(|| format!("Error stopping VM with CID {}", self.instance.cid))
1103 .with_log()
1104 .or_service_specific_exception(-1)
Inseob Kima446f802022-07-11 19:46:37 +09001105 }
1106
Keir Frasercdd4b112022-11-24 14:02:25 +00001107 fn onTrimMemory(&self, level: MemoryTrimLevel) -> binder::Result<()> {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001108 self.instance
1109 .trim_memory(level)
1110 .with_context(|| format!("Error trimming VM with CID {}", self.instance.cid))
1111 .with_log()
1112 .or_service_specific_exception(-1)
Keir Frasercdd4b112022-11-24 14:02:25 +00001113 }
1114
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001115 fn connectVsock(&self, port: i32) -> binder::Result<ParcelFileDescriptor> {
Andrew Walbranf8d94112021-09-07 11:45:36 +00001116 if !matches!(&*self.instance.vm_state.lock().unwrap(), VmState::Running { .. }) {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001117 return Err(anyhow!("VM is not running")).or_service_specific_exception(-1);
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001118 }
Alan Stokes10c47672022-12-13 17:17:08 +00001119 let port = port as u32;
1120 if port < 1024 {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001121 return Err(anyhow!("Can't connect to privileged port {port}"))
1122 .or_service_specific_exception(-1);
Alan Stokes10c47672022-12-13 17:17:08 +00001123 }
Jiyong Park2227eaa2023-08-04 11:59:18 +09001124 let stream = VsockStream::connect_with_cid_port(self.instance.cid, port)
1125 .context("Failed to connect")
1126 .or_service_specific_exception(-1)?;
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001127 Ok(vsock_stream_to_pfd(stream))
1128 }
Andrew Walbrandae07162021-03-12 17:05:20 +00001129}
1130
1131impl Drop for VirtualMachine {
1132 fn drop(&mut self) {
1133 debug!("Dropping {:?}", self);
Inseob Kima446f802022-07-11 19:46:37 +09001134 if let Err(e) = self.instance.kill() {
1135 debug!("Error stopping dropped VM with CID {}: {:?}", self.instance.cid, e);
1136 }
Andrew Walbrandae07162021-03-12 17:05:20 +00001137 }
1138}
1139
1140/// A set of Binders to be called back in response to various events on the VM, such as when it
1141/// dies.
1142#[derive(Debug, Default)]
1143pub struct VirtualMachineCallbacks(Mutex<Vec<Strong<dyn IVirtualMachineCallback>>>);
1144
1145impl VirtualMachineCallbacks {
Jiyong Park8611a6c2021-07-09 18:17:44 +09001146 /// Call all registered callbacks to notify that the payload has started.
David Brazdil451cc962022-10-14 14:08:12 +01001147 pub fn notify_payload_started(&self, cid: Cid) {
Jiyong Park8611a6c2021-07-09 18:17:44 +09001148 let callbacks = &*self.0.lock().unwrap();
Jiyong Park8611a6c2021-07-09 18:17:44 +09001149 for callback in callbacks {
David Brazdil451cc962022-10-14 14:08:12 +01001150 if let Err(e) = callback.onPayloadStarted(cid as i32) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001151 error!("Error notifying payload start event from VM CID {}: {:?}", cid, e);
Jiyong Park8611a6c2021-07-09 18:17:44 +09001152 }
1153 }
1154 }
1155
Inseob Kim14cb8692021-08-31 21:50:39 +09001156 /// Call all registered callbacks to notify that the payload is ready to serve.
1157 pub fn notify_payload_ready(&self, cid: Cid) {
1158 let callbacks = &*self.0.lock().unwrap();
1159 for callback in callbacks {
1160 if let Err(e) = callback.onPayloadReady(cid as i32) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001161 error!("Error notifying payload ready event from VM CID {}: {:?}", cid, e);
Inseob Kim14cb8692021-08-31 21:50:39 +09001162 }
1163 }
1164 }
1165
Inseob Kim2444af92021-08-31 01:22:50 +09001166 /// Call all registered callbacks to notify that the payload has finished.
1167 pub fn notify_payload_finished(&self, cid: Cid, exit_code: i32) {
1168 let callbacks = &*self.0.lock().unwrap();
1169 for callback in callbacks {
1170 if let Err(e) = callback.onPayloadFinished(cid as i32, exit_code) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001171 error!("Error notifying payload finish event from VM CID {}: {:?}", cid, e);
Inseob Kim2444af92021-08-31 01:22:50 +09001172 }
1173 }
1174 }
1175
Jooyung Handd0a1732021-11-23 15:26:20 +09001176 /// Call all registered callbacks to say that the VM encountered an error.
Alan Stokes2bead0d2022-09-05 16:58:34 +01001177 pub fn notify_error(&self, cid: Cid, error_code: ErrorCode, message: &str) {
Jooyung Handd0a1732021-11-23 15:26:20 +09001178 let callbacks = &*self.0.lock().unwrap();
1179 for callback in callbacks {
1180 if let Err(e) = callback.onError(cid as i32, error_code, message) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001181 error!("Error notifying error event from VM CID {}: {:?}", cid, e);
Jooyung Handd0a1732021-11-23 15:26:20 +09001182 }
1183 }
1184 }
1185
Andrew Walbrandae07162021-03-12 17:05:20 +00001186 /// Call all registered callbacks to say that the VM has died.
Andrew Walbranc92d35f2022-01-12 12:45:19 +00001187 pub fn callback_on_died(&self, cid: Cid, reason: DeathReason) {
Andrew Walbrandae07162021-03-12 17:05:20 +00001188 let callbacks = &*self.0.lock().unwrap();
1189 for callback in callbacks {
Andrew Walbranc92d35f2022-01-12 12:45:19 +00001190 if let Err(e) = callback.onDied(cid as i32, reason) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001191 error!("Error notifying exit of VM CID {}: {:?}", cid, e);
Andrew Walbrandae07162021-03-12 17:05:20 +00001192 }
1193 }
1194 }
1195
1196 /// Add a new callback to the set.
1197 fn add(&self, callback: Strong<dyn IVirtualMachineCallback>) {
1198 self.0.lock().unwrap().push(callback);
1199 }
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001200}
1201
Andrew Walbranf6bf6862021-05-21 12:41:13 +00001202/// The mutable state of the VirtualizationService. There should only be one instance of this
1203/// struct.
Chris Wailes641fc4a2021-12-01 15:03:21 -08001204#[derive(Debug, Default)]
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001205struct State {
Alan Stokes3e5eec12023-09-07 12:10:00 +01001206 /// The VMs which have been started. When VMs are started a weak reference is added to this
1207 /// list while a strong reference is returned to the caller over Binder. Once all copies of
1208 /// the Binder client are dropped the weak reference here will become invalid, and will be
1209 /// removed from the list opportunistically the next time `add_vm` is called.
Andrew Walbran320b5602021-03-04 16:11:12 +00001210 vms: Vec<Weak<VmInstance>>,
1211}
1212
1213impl State {
Andrew Walbrandae07162021-03-12 17:05:20 +00001214 /// Get a list of VMs which still have Binder references to them.
Andrew Walbran320b5602021-03-04 16:11:12 +00001215 fn vms(&self) -> Vec<Arc<VmInstance>> {
1216 // Attempt to upgrade the weak pointers to strong pointers.
1217 self.vms.iter().filter_map(Weak::upgrade).collect()
1218 }
1219
1220 /// Add a new VM to the list.
1221 fn add_vm(&mut self, vm: Weak<VmInstance>) {
1222 // Garbage collect any entries from the stored list which no longer exist.
1223 self.vms.retain(|vm| vm.strong_count() > 0);
1224
1225 // Actually add the new VM.
1226 self.vms.push(vm);
1227 }
David Brazdil3c2ddef2021-03-18 13:09:57 +00001228
Jiyong Park8611a6c2021-07-09 18:17:44 +09001229 /// Get a VM that corresponds to the given cid
1230 fn get_vm(&self, cid: Cid) -> Option<Arc<VmInstance>> {
1231 self.vms().into_iter().find(|vm| vm.cid == cid)
1232 }
Jiyong Parkd50a0242021-09-16 21:00:14 +09001233}
1234
Andrew Walbran6b650662021-09-07 13:13:23 +00001235/// Gets the `VirtualMachineState` of the given `VmInstance`.
1236fn get_state(instance: &VmInstance) -> VirtualMachineState {
Andrew Walbranf8d94112021-09-07 11:45:36 +00001237 match &*instance.vm_state.lock().unwrap() {
1238 VmState::NotStarted { .. } => VirtualMachineState::NOT_STARTED,
1239 VmState::Running { .. } => match instance.payload_state() {
Andrew Walbran6b650662021-09-07 13:13:23 +00001240 PayloadState::Starting => VirtualMachineState::STARTING,
1241 PayloadState::Started => VirtualMachineState::STARTED,
1242 PayloadState::Ready => VirtualMachineState::READY,
1243 PayloadState::Finished => VirtualMachineState::FINISHED,
Jiyong Parka4eebde2022-07-12 18:01:12 +09001244 PayloadState::Hangup => VirtualMachineState::DEAD,
Andrew Walbranf8d94112021-09-07 11:45:36 +00001245 },
1246 VmState::Dead => VirtualMachineState::DEAD,
1247 VmState::Failed => VirtualMachineState::DEAD,
Andrew Walbran6b650662021-09-07 13:13:23 +00001248 }
1249}
1250
David Brazdilf50c7a62023-04-19 14:22:42 +00001251/// Converts a `&ParcelFileDescriptor` to a `File` by cloning the file.
Jiyong Park2227eaa2023-08-04 11:59:18 +09001252pub fn clone_file(file: &ParcelFileDescriptor) -> binder::Result<File> {
1253 file.as_ref()
1254 .try_clone()
1255 .context("Failed to clone File from ParcelFileDescriptor")
1256 .or_binder_exception(ExceptionCode::BAD_PARCELABLE)
Andrei Homescu11333c62023-11-09 04:26:39 +00001257 .map(File::from)
David Brazdilf50c7a62023-04-19 14:22:42 +00001258}
1259
Andrew Walbrand3a84182021-09-07 14:48:52 +00001260/// Converts an `&Option<ParcelFileDescriptor>` to an `Option<File>` by cloning the file.
Jiyong Park2227eaa2023-08-04 11:59:18 +09001261fn maybe_clone_file(file: &Option<ParcelFileDescriptor>) -> binder::Result<Option<File>> {
Andrew Walbrand3a84182021-09-07 14:48:52 +00001262 file.as_ref().map(clone_file).transpose()
1263}
1264
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001265/// Converts a `VsockStream` to a `ParcelFileDescriptor`.
1266fn vsock_stream_to_pfd(stream: VsockStream) -> ParcelFileDescriptor {
1267 // SAFETY: ownership is transferred from stream to f
1268 let f = unsafe { File::from_raw_fd(stream.into_raw_fd()) };
1269 ParcelFileDescriptor::new(f)
1270}
1271
Jiyong Parkdcf17412022-02-08 15:07:23 +09001272/// Parses the platform version requirement string.
Jiyong Park2227eaa2023-08-04 11:59:18 +09001273fn parse_platform_version_req(s: &str) -> binder::Result<VersionReq> {
1274 VersionReq::parse(s)
1275 .with_context(|| format!("Invalid platform version requirement {}", s))
1276 .or_binder_exception(ExceptionCode::BAD_PARCELABLE)
Jiyong Parkdcf17412022-02-08 15:07:23 +09001277}
1278
Jiyong Parked180932023-02-24 19:55:41 +09001279/// Create the empty ramdump file
1280fn prepare_ramdump_file(temporary_directory: &Path) -> binder::Result<File> {
1281 // `ramdump_write` is sent to crosvm and will be the backing store for the /dev/hvc1 where
1282 // VM will emit ramdump to. `ramdump_read` will be sent back to the client (i.e. the VM
1283 // owner) for readout.
1284 let ramdump_path = temporary_directory.join("ramdump");
Jiyong Park2227eaa2023-08-04 11:59:18 +09001285 let ramdump = File::create(ramdump_path)
1286 .context("Failed to prepare ramdump file")
1287 .with_log()
1288 .or_service_specific_exception(-1)?;
Jiyong Parked180932023-02-24 19:55:41 +09001289 Ok(ramdump)
1290}
1291
Nikita Ioffe5776f082023-02-10 21:38:26 +00001292fn is_protected(config: &VirtualMachineConfig) -> bool {
1293 match config {
1294 VirtualMachineConfig::RawConfig(config) => config.protectedVm,
1295 VirtualMachineConfig::AppConfig(config) => config.protectedVm,
1296 }
1297}
1298
1299fn check_gdb_allowed(config: &VirtualMachineConfig) -> binder::Result<()> {
1300 if is_protected(config) {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001301 return Err(anyhow!("Can't use gdb with protected VMs"))
1302 .or_binder_exception(ExceptionCode::SECURITY);
Nikita Ioffe5776f082023-02-10 21:38:26 +00001303 }
1304
1305 match config {
1306 VirtualMachineConfig::RawConfig(_) => Ok(()),
1307 VirtualMachineConfig::AppConfig(config) => {
1308 if config.debugLevel != DebugLevel::FULL {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001309 Err(anyhow!("Can't use gdb with non-debuggable VMs"))
1310 .or_binder_exception(ExceptionCode::SECURITY)
Nikita Ioffe5776f082023-02-10 21:38:26 +00001311 } else {
1312 Ok(())
1313 }
1314 }
1315 }
1316}
1317
Shikha Panwar61a74b52024-02-16 13:17:01 +00001318fn extract_instance_id(config: &VirtualMachineConfig) -> [u8; 64] {
1319 match config {
1320 VirtualMachineConfig::RawConfig(config) => config.instanceId,
1321 VirtualMachineConfig::AppConfig(config) => config.instanceId,
1322 }
1323}
1324
Nikita Ioffe5776f082023-02-10 21:38:26 +00001325fn extract_gdb_port(config: &VirtualMachineConfig) -> Option<NonZeroU16> {
1326 match config {
1327 VirtualMachineConfig::RawConfig(config) => NonZeroU16::new(config.gdbPort as u16),
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +01001328 VirtualMachineConfig::AppConfig(config) => {
1329 NonZeroU16::new(config.customConfig.as_ref().map(|c| c.gdbPort).unwrap_or(0) as u16)
1330 }
Nikita Ioffe5776f082023-02-10 21:38:26 +00001331 }
1332}
1333
Nikita Ioffe631717e2023-09-05 13:38:07 +01001334fn check_no_vendor_modules(config: &VirtualMachineConfig) -> binder::Result<()> {
1335 let VirtualMachineConfig::AppConfig(config) = config else { return Ok(()) };
1336 if let Some(custom_config) = &config.customConfig {
1337 if custom_config.vendorImage.is_some() || custom_config.customKernelImage.is_some() {
1338 return Err(anyhow!("vendor modules feature is disabled"))
1339 .or_binder_exception(ExceptionCode::UNSUPPORTED_OPERATION);
1340 }
1341 }
1342 Ok(())
1343}
1344
Nikita Ioffe94a8a182023-11-16 16:37:48 +00001345fn check_no_devices(config: &VirtualMachineConfig) -> binder::Result<()> {
1346 let VirtualMachineConfig::AppConfig(config) = config else { return Ok(()) };
1347 if let Some(custom_config) = &config.customConfig {
1348 if !custom_config.devices.is_empty() {
1349 return Err(anyhow!("device assignment feature is disabled"))
1350 .or_binder_exception(ExceptionCode::UNSUPPORTED_OPERATION);
1351 }
1352 }
1353 Ok(())
1354}
1355
Alan Stokesfda70842023-12-20 17:50:14 +00001356fn check_no_extra_apks(config: &VirtualMachineConfig) -> binder::Result<()> {
1357 let VirtualMachineConfig::AppConfig(config) = config else { return Ok(()) };
1358 let Payload::PayloadConfig(payload_config) = &config.payload else { return Ok(()) };
1359 if !payload_config.extraApks.is_empty() {
1360 return Err(anyhow!("multi-tenant feature is disabled"))
1361 .or_binder_exception(ExceptionCode::UNSUPPORTED_OPERATION);
1362 }
1363 Ok(())
1364}
1365
Nikita Ioffe631717e2023-09-05 13:38:07 +01001366fn check_config_features(config: &VirtualMachineConfig) -> binder::Result<()> {
1367 if !cfg!(vendor_modules) {
1368 check_no_vendor_modules(config)?;
1369 }
Nikita Ioffe94a8a182023-11-16 16:37:48 +00001370 if !cfg!(device_assignment) {
1371 check_no_devices(config)?;
1372 }
Alan Stokesfda70842023-12-20 17:50:14 +00001373 if !cfg!(multi_tenant) {
1374 check_no_extra_apks(config)?;
1375 }
Nikita Ioffe631717e2023-09-05 13:38:07 +01001376 Ok(())
1377}
1378
Inseob Kim0168b462022-12-27 14:54:35 +09001379fn clone_or_prepare_logger_fd(
Jaewan Kim61f86142023-03-28 15:12:52 +09001380 debug_config: &DebugConfig,
Inseob Kim0168b462022-12-27 14:54:35 +09001381 fd: Option<&ParcelFileDescriptor>,
1382 tag: String,
1383) -> Result<Option<File>, Status> {
1384 if let Some(fd) = fd {
1385 return Ok(Some(clone_file(fd)?));
1386 }
1387
Jaewan Kim61f86142023-03-28 15:12:52 +09001388 if !debug_config.should_prepare_console_output() {
Jaewan Kim66f062e2023-02-25 01:07:43 +09001389 return Ok(None);
1390 };
Inseob Kim0168b462022-12-27 14:54:35 +09001391
Jiyong Park2227eaa2023-08-04 11:59:18 +09001392 let (raw_read_fd, raw_write_fd) =
1393 pipe().context("Failed to create pipe").or_service_specific_exception(-1)?;
Inseob Kim0168b462022-12-27 14:54:35 +09001394
Andrew Walbranb58d1b42023-07-07 13:54:49 +01001395 // SAFETY: We are the sole owner of this FD as we just created it, and it is valid and open.
Inseob Kim0168b462022-12-27 14:54:35 +09001396 let mut reader = BufReader::new(unsafe { File::from_raw_fd(raw_read_fd) });
Andrew Walbranb58d1b42023-07-07 13:54:49 +01001397 // SAFETY: We are the sole owner of this FD as we just created it, and it is valid and open.
Inseob Kim0168b462022-12-27 14:54:35 +09001398 let write_fd = unsafe { File::from_raw_fd(raw_write_fd) };
1399
1400 std::thread::spawn(move || loop {
1401 let mut buf = vec![];
1402 match reader.read_until(b'\n', &mut buf) {
1403 Ok(0) => {
1404 // EOF
1405 return;
1406 }
1407 Ok(size) => {
1408 if buf[size - 1] == b'\n' {
1409 buf.pop();
1410 }
1411 info!("{}: {}", &tag, &String::from_utf8_lossy(&buf));
1412 }
1413 Err(e) => {
1414 error!("Could not read console pipe: {:?}", e);
1415 return;
1416 }
1417 };
1418 });
1419
1420 Ok(Some(write_fd))
1421}
1422
Jooyung Han35edb8f2021-07-01 16:17:16 +09001423/// Simple utility for referencing Borrowed or Owned. Similar to std::borrow::Cow, but
1424/// it doesn't require that T implements Clone.
1425enum BorrowedOrOwned<'a, T> {
1426 Borrowed(&'a T),
1427 Owned(T),
1428}
1429
1430impl<'a, T> AsRef<T> for BorrowedOrOwned<'a, T> {
1431 fn as_ref(&self) -> &T {
1432 match self {
1433 Self::Borrowed(b) => b,
Chris Wailes68c39f82021-07-27 16:03:44 -07001434 Self::Owned(o) => o,
Jooyung Han35edb8f2021-07-01 16:17:16 +09001435 }
1436 }
1437}
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001438
1439/// Implementation of `IVirtualMachineService`, the entry point of the AIDL service.
1440#[derive(Debug, Default)]
1441struct VirtualMachineService {
1442 state: Arc<Mutex<State>>,
Inseob Kimc7d28c72021-10-25 14:28:10 +00001443 cid: Cid,
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001444}
1445
1446impl Interface for VirtualMachineService {}
1447
1448impl IVirtualMachineService for VirtualMachineService {
Inseob Kimc7d28c72021-10-25 14:28:10 +00001449 fn notifyPayloadStarted(&self) -> binder::Result<()> {
1450 let cid = self.cid;
Inseob Kim7f61fe72021-08-20 20:50:47 +09001451 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001452 info!("VM with CID {} started payload", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001453 vm.update_payload_state(PayloadState::Started)
1454 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
David Brazdil451cc962022-10-14 14:08:12 +01001455 vm.callbacks.notify_payload_started(cid);
Seungjae Yoo62085c02022-08-12 04:44:52 +00001456
Seungjae Yoo6d265d92022-11-15 10:51:33 +09001457 let vm_start_timestamp = vm.vm_metric.lock().unwrap().start_timestamp;
1458 write_vm_booted_stats(vm.requester_uid as i32, &vm.name, vm_start_timestamp);
Inseob Kim7f61fe72021-08-20 20:50:47 +09001459 Ok(())
1460 } else {
Jooyung Handd0a1732021-11-23 15:26:20 +09001461 error!("notifyPayloadStarted is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001462 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001463 }
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001464 }
Inseob Kim2444af92021-08-31 01:22:50 +09001465
Inseob Kimc7d28c72021-10-25 14:28:10 +00001466 fn notifyPayloadReady(&self) -> binder::Result<()> {
1467 let cid = self.cid;
Inseob Kim14cb8692021-08-31 21:50:39 +09001468 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001469 info!("VM with CID {} reported payload is ready", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001470 vm.update_payload_state(PayloadState::Ready)
1471 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
Inseob Kim14cb8692021-08-31 21:50:39 +09001472 vm.callbacks.notify_payload_ready(cid);
1473 Ok(())
1474 } else {
Jooyung Handd0a1732021-11-23 15:26:20 +09001475 error!("notifyPayloadReady is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001476 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Inseob Kim14cb8692021-08-31 21:50:39 +09001477 }
1478 }
1479
Inseob Kimc7d28c72021-10-25 14:28:10 +00001480 fn notifyPayloadFinished(&self, exit_code: i32) -> binder::Result<()> {
1481 let cid = self.cid;
Inseob Kim2444af92021-08-31 01:22:50 +09001482 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001483 info!("VM with CID {} finished payload", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001484 vm.update_payload_state(PayloadState::Finished)
1485 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
Inseob Kim2444af92021-08-31 01:22:50 +09001486 vm.callbacks.notify_payload_finished(cid, exit_code);
1487 Ok(())
1488 } else {
Jooyung Handd0a1732021-11-23 15:26:20 +09001489 error!("notifyPayloadFinished is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001490 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Jooyung Handd0a1732021-11-23 15:26:20 +09001491 }
1492 }
1493
Alan Stokes2bead0d2022-09-05 16:58:34 +01001494 fn notifyError(&self, error_code: ErrorCode, message: &str) -> binder::Result<()> {
Jooyung Handd0a1732021-11-23 15:26:20 +09001495 let cid = self.cid;
1496 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001497 info!("VM with CID {} encountered an error", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001498 vm.update_payload_state(PayloadState::Finished)
1499 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
Jooyung Handd0a1732021-11-23 15:26:20 +09001500 vm.callbacks.notify_error(cid, error_code, message);
1501 Ok(())
1502 } else {
Seungjae Yooec8c1602022-06-20 05:28:00 +00001503 error!("notifyError is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001504 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Inseob Kim2444af92021-08-31 01:22:50 +09001505 }
1506 }
Alice Wangc2fec932023-02-23 16:24:02 +00001507
Shikha Panwar5d6a6752023-12-14 22:08:26 +00001508 fn getSecretkeeper(&self) -> binder::Result<Option<Strong<dyn ISecretkeeper>>> {
Shikha Panwarc78d8092024-03-08 15:26:28 +00001509 // TODO(b/327526008): Session establishment wth secretkeeper is failing.
1510 // Re-enable this when fixed.
1511 let _sk_supported = is_secretkeeper_supported();
1512 Ok(None)
Shikha Panwar5d6a6752023-12-14 22:08:26 +00001513 }
1514
Alice Wange64dd182024-01-17 15:57:55 +00001515 fn requestAttestation(&self, csr: &[u8], test_mode: bool) -> binder::Result<Vec<Certificate>> {
1516 GLOBAL_SERVICE.requestAttestation(csr, get_calling_uid() as i32, test_mode)
Alice Wangc2fec932023-02-23 16:24:02 +00001517 }
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001518}
1519
Shikha Panwar8707f0f2024-02-28 20:40:42 +00001520fn is_secretkeeper_supported() -> bool {
Shikha Panwar8187ca22024-01-04 08:33:08 +00001521 binder::is_declared(SECRETKEEPER_IDENTIFIER)
1522 .expect("Could not check for declared Secretkeeper interface")
1523}
1524
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001525impl VirtualMachineService {
Inseob Kimc7d28c72021-10-25 14:28:10 +00001526 fn new_binder(state: Arc<Mutex<State>>, cid: Cid) -> Strong<dyn IVirtualMachineService> {
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001527 BnVirtualMachineService::new_binder(
Inseob Kimc7d28c72021-10-25 14:28:10 +00001528 VirtualMachineService { state, cid },
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001529 BinderFeatures::default(),
1530 )
1531 }
1532}
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001533
Stephen Hines4c1e2fc2024-02-09 16:34:47 -08001534struct SecretkeeperProxy(Strong<dyn ISecretkeeper>);
1535
1536impl Interface for SecretkeeperProxy {}
1537
1538impl ISecretkeeper for SecretkeeperProxy {
1539 fn processSecretManagementRequest(&self, req: &[u8]) -> binder::Result<Vec<u8>> {
1540 // Pass the request to the channel, and read the response.
1541 self.0.processSecretManagementRequest(req)
1542 }
1543
1544 fn getAuthGraphKe(&self) -> binder::Result<Strong<dyn IAuthGraphKeyExchange>> {
1545 let ag = AuthGraphKeyExchangeProxy(self.0.getAuthGraphKe()?);
1546 Ok(BnAuthGraphKeyExchange::new_binder(ag, BinderFeatures::default()))
1547 }
1548
1549 fn deleteIds(&self, ids: &[SecretId]) -> binder::Result<()> {
1550 self.0.deleteIds(ids)
1551 }
1552
1553 fn deleteAll(&self) -> binder::Result<()> {
1554 self.0.deleteAll()
1555 }
1556}
1557
1558struct AuthGraphKeyExchangeProxy(Strong<dyn IAuthGraphKeyExchange>);
1559
1560impl Interface for AuthGraphKeyExchangeProxy {}
1561
1562impl IAuthGraphKeyExchange for AuthGraphKeyExchangeProxy {
1563 fn create(&self) -> binder::Result<SessionInitiationInfo> {
1564 self.0.create()
1565 }
1566
1567 fn init(
1568 &self,
1569 peer_pub_key: &PubKey,
1570 peer_id: &Identity,
1571 peer_nonce: &[u8],
1572 peer_version: i32,
1573 ) -> binder::Result<KeInitResult> {
1574 self.0.init(peer_pub_key, peer_id, peer_nonce, peer_version)
1575 }
1576
1577 fn finish(
1578 &self,
1579 peer_pub_key: &PubKey,
1580 peer_id: &Identity,
1581 peer_signature: &SessionIdSignature,
1582 peer_nonce: &[u8],
1583 peer_version: i32,
1584 own_key: &Key,
1585 ) -> binder::Result<SessionInfo> {
1586 self.0.finish(peer_pub_key, peer_id, peer_signature, peer_nonce, peer_version, own_key)
1587 }
1588
1589 fn authenticationComplete(
1590 &self,
1591 peer_signature: &SessionIdSignature,
1592 shared_keys: &[AuthgraphArc; 2],
1593 ) -> binder::Result<[AuthgraphArc; 2]> {
1594 self.0.authenticationComplete(peer_signature, shared_keys)
1595 }
1596}
1597
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001598#[cfg(test)]
1599mod tests {
1600 use super::*;
1601
1602 #[test]
1603 fn test_is_allowed_label_for_partition() -> Result<()> {
1604 let expected_results = vec![
1605 ("u:object_r:system_file:s0", true),
1606 ("u:object_r:apk_data_file:s0", true),
1607 ("u:object_r:app_data_file:s0", false),
1608 ("u:object_r:app_data_file:s0:c512,c768", false),
1609 ("u:object_r:privapp_data_file:s0:c512,c768", false),
1610 ("invalid", false),
1611 ("user:role:apk_data_file:severity:categories", true),
1612 ("user:role:apk_data_file:severity:categories:extraneous", false),
1613 ];
1614
1615 for (label, expected_valid) in expected_results {
1616 let context = SeContext::new(label)?;
1617 let result = check_label_is_allowed(&context);
1618 if expected_valid {
1619 assert!(result.is_ok(), "Expected label {} to be allowed, got {:?}", label, result);
1620 } else if result.is_ok() {
1621 bail!("Expected label {} to be disallowed", label);
1622 }
1623 }
1624 Ok(())
1625 }
Nikita Ioffef1ce9872022-12-09 13:31:59 +00001626
1627 #[test]
1628 fn test_create_or_update_idsig_file_empty_apk() -> Result<()> {
1629 let apk = tempfile::tempfile().unwrap();
1630 let idsig = tempfile::tempfile().unwrap();
1631
1632 let ret = create_or_update_idsig_file(
1633 &ParcelFileDescriptor::new(apk),
1634 &ParcelFileDescriptor::new(idsig),
1635 );
1636 assert!(ret.is_err(), "should fail");
1637 Ok(())
1638 }
1639
1640 #[test]
1641 fn test_create_or_update_idsig_dir_instead_of_file_for_apk() -> Result<()> {
1642 let tmp_dir = tempfile::TempDir::new().unwrap();
1643 let apk = File::open(tmp_dir.path()).unwrap();
1644 let idsig = tempfile::tempfile().unwrap();
1645
1646 let ret = create_or_update_idsig_file(
1647 &ParcelFileDescriptor::new(apk),
1648 &ParcelFileDescriptor::new(idsig),
1649 );
1650 assert!(ret.is_err(), "should fail");
1651 Ok(())
1652 }
1653
1654 /// Verifies that create_or_update_idsig_file won't oom if a fd that corresponds to a directory
1655 /// on ext4 filesystem is passed.
1656 /// On ext4 lseek on a directory fd will return (off_t)-1 (see:
1657 /// https://bugzilla.kernel.org/show_bug.cgi?id=200043), which will result in
1658 /// create_or_update_idsig_file ooming while attempting to allocate petabytes of memory.
1659 #[test]
1660 fn test_create_or_update_idsig_does_not_crash_dir_on_ext4() -> Result<()> {
1661 // APEXes are backed by the ext4.
1662 let apk = File::open("/apex/com.android.virt/").unwrap();
1663 let idsig = tempfile::tempfile().unwrap();
1664
1665 let ret = create_or_update_idsig_file(
1666 &ParcelFileDescriptor::new(apk),
1667 &ParcelFileDescriptor::new(idsig),
1668 );
1669 assert!(ret.is_err(), "should fail");
1670 Ok(())
1671 }
Jiyong Park8d192952023-06-26 14:29:51 +09001672
1673 #[test]
1674 fn test_create_or_update_idsig_does_not_update_if_already_valid() -> Result<()> {
1675 use std::io::Seek;
1676
1677 // Pick any APK
1678 let mut apk = File::open("/system/priv-app/Shell/Shell.apk").unwrap();
1679 let mut idsig = tempfile::tempfile().unwrap();
1680
1681 create_or_update_idsig_file(
1682 &ParcelFileDescriptor::new(apk.try_clone()?),
1683 &ParcelFileDescriptor::new(idsig.try_clone()?),
1684 )?;
1685 let modified_orig = idsig.metadata()?.modified()?;
1686 apk.rewind()?;
1687 idsig.rewind()?;
1688
1689 // Call the function again
1690 create_or_update_idsig_file(
1691 &ParcelFileDescriptor::new(apk.try_clone()?),
1692 &ParcelFileDescriptor::new(idsig.try_clone()?),
1693 )?;
1694 let modified_new = idsig.metadata()?.modified()?;
1695 assert!(modified_orig == modified_new, "idsig file was updated unnecessarily");
1696 Ok(())
1697 }
Nikita Ioffeaa6858c2023-07-04 01:37:41 +01001698
1699 #[test]
Shikha Panwar9ae2e622024-01-30 12:22:30 +00001700 fn test_create_or_update_idsig_on_non_empty_file() -> Result<()> {
1701 use std::io::Read;
1702
1703 // Pick any APK
1704 let mut apk = File::open("/system/priv-app/Shell/Shell.apk").unwrap();
1705 let idsig_empty = tempfile::tempfile().unwrap();
1706 let mut idsig_invalid = tempfile::tempfile().unwrap();
1707 idsig_invalid.write_all(b"Oops")?;
1708
1709 // Create new idsig
1710 create_or_update_idsig_file(
1711 &ParcelFileDescriptor::new(apk.try_clone()?),
1712 &ParcelFileDescriptor::new(idsig_empty.try_clone()?),
1713 )?;
1714 apk.rewind()?;
1715
1716 // Update idsig_invalid
1717 create_or_update_idsig_file(
1718 &ParcelFileDescriptor::new(apk.try_clone()?),
1719 &ParcelFileDescriptor::new(idsig_invalid.try_clone()?),
1720 )?;
1721
1722 // Ensure the 2 idsig files have same size!
1723 assert!(
1724 idsig_empty.metadata()?.len() == idsig_invalid.metadata()?.len(),
1725 "idsig files differ in size"
1726 );
1727 // Ensure the 2 idsig files have same content!
1728 for (b1, b2) in idsig_empty.bytes().zip(idsig_invalid.bytes()) {
1729 assert!(b1.unwrap() == b2.unwrap(), "idsig files differ")
1730 }
1731 Ok(())
1732 }
1733 #[test]
Nikita Ioffeaa6858c2023-07-04 01:37:41 +01001734 fn test_append_kernel_param_first_param() {
1735 let mut vm_config = VirtualMachineRawConfig { ..Default::default() };
1736 append_kernel_param("foo=1", &mut vm_config);
1737 assert_eq!(vm_config.params, Some("foo=1".to_owned()))
1738 }
1739
1740 #[test]
1741 fn test_append_kernel_param() {
1742 let mut vm_config =
1743 VirtualMachineRawConfig { params: Some("foo=5".to_owned()), ..Default::default() };
1744 append_kernel_param("bar=42", &mut vm_config);
1745 assert_eq!(vm_config.params, Some("foo=5 bar=42".to_owned()))
1746 }
Seungjae Yooec3bc522023-11-09 10:14:30 +09001747
Inseob Kim46257382024-01-03 15:41:22 +09001748 fn test_extract_os_name_from_config_path(
1749 path: &Path,
1750 expected_result: Option<&str>,
1751 ) -> Result<()> {
1752 let result = extract_os_name_from_config_path(path);
1753 if result.as_deref() != expected_result {
1754 bail!("Expected {:?} but was {:?}", expected_result, &result)
1755 }
1756 Ok(())
1757 }
1758
1759 #[test]
1760 fn test_extract_os_name_from_microdroid_config() -> Result<()> {
1761 test_extract_os_name_from_config_path(
1762 Path::new("/apex/com.android.virt/etc/microdroid.json"),
1763 Some("microdroid"),
1764 )
1765 }
1766
1767 #[test]
1768 fn test_extract_os_name_from_microdroid_gki_config() -> Result<()> {
1769 test_extract_os_name_from_config_path(
1770 Path::new("/apex/com.android.virt/etc/microdroid_gki-android14-6.1.json"),
1771 Some("microdroid_gki-android14-6.1"),
1772 )
1773 }
1774
1775 #[test]
1776 fn test_extract_os_name_from_invalid_path() -> Result<()> {
1777 test_extract_os_name_from_config_path(
1778 Path::new("/apex/com.android.virt/etc/microdroid.img"),
1779 None,
1780 )
1781 }
1782
1783 #[test]
1784 fn test_extract_os_name_from_configs() -> Result<()> {
1785 let tmp_dir = tempfile::TempDir::new()?;
1786 let tmp_dir_path = tmp_dir.path().to_owned();
1787
1788 let mut os_names: HashSet<String> = HashSet::new();
1789 os_names.insert("microdroid".to_owned());
1790 os_names.insert("microdroid_gki-android14-6.1".to_owned());
1791 os_names.insert("microdroid_gki-android15-6.1".to_owned());
1792
1793 // config files
1794 for os_name in &os_names {
1795 std::fs::write(tmp_dir_path.join(os_name.to_owned() + ".json"), b"")?;
1796 }
1797
1798 // fake files not related to configs
1799 std::fs::write(tmp_dir_path.join("microdroid_super.img"), b"")?;
1800 std::fs::write(tmp_dir_path.join("microdroid_foobar.apk"), b"")?;
1801
1802 let glob_pattern = match tmp_dir_path.join("microdroid*.json").to_str() {
1803 Some(s) => s.to_owned(),
1804 None => bail!("tmp_dir_path {:?} is not UTF-8", tmp_dir_path),
1805 };
1806
1807 let result = extract_os_names_from_configs(&glob_pattern)?;
1808 if result != os_names {
1809 bail!("Expected {:?} but was {:?}", os_names, result);
1810 }
1811 Ok(())
1812 }
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001813}