1 // 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
15 //! Microdroid Manager
16
17 mod dice;
18 mod instance;
19 mod ioutil;
20 mod payload;
21 mod swap;
22 mod verify;
23 mod vm_payload_service;
24 mod vm_secret;
25
26 use android_system_virtualizationcommon::aidl::android::system::virtualizationcommon::ErrorCode::ErrorCode;
27 use android_system_virtualmachineservice::aidl::android::system::virtualmachineservice::IVirtualMachineService::IVirtualMachineService;
28 use android_system_virtualization_payload::aidl::android::system::virtualization::payload::IVmPayloadService::{
29 VM_APK_CONTENTS_PATH,
30 VM_PAYLOAD_SERVICE_SOCKET_NAME,
31 ENCRYPTEDSTORE_MOUNTPOINT,
32 };
33
34 use crate::dice::dice_derivation;
35 use crate::instance::{InstanceDisk, MicrodroidData};
36 use crate::verify::verify_payload;
37 use crate::vm_payload_service::register_vm_payload_service;
38 use anyhow::{anyhow, bail, ensure, Context, Error, Result};
39 use binder::Strong;
40 use dice_driver::DiceDriver;
41 use keystore2_crypto::ZVec;
42 use libc::VMADDR_CID_HOST;
43 use log::{error, info};
44 use microdroid_metadata::{Metadata, PayloadMetadata};
45 use microdroid_payload_config::{ApkConfig, OsConfig, Task, TaskType, VmPayloadConfig};
46 use nix::mount::{umount2, MntFlags};
47 use nix::sys::signal::Signal;
48 use payload::load_metadata;
49 use rpcbinder::RpcSession;
50 use rustutils::sockets::android_get_control_socket;
51 use rustutils::system_properties;
52 use rustutils::system_properties::PropertyWatcher;
53 use secretkeeper_comm::data_types::ID_SIZE;
54 use std::borrow::Cow::{Borrowed, Owned};
55 use std::env;
56 use std::ffi::CString;
57 use std::fs::{self, create_dir, File, OpenOptions};
58 use std::io::{Read, Write};
59 use std::os::unix::io::OwnedFd;
60 use std::os::unix::process::CommandExt;
61 use std::os::unix::process::ExitStatusExt;
62 use std::path::Path;
63 use std::process::{Child, Command, Stdio};
64 use std::str;
65 use std::time::Duration;
66 use vm_secret::VmSecret;
67
68 const WAIT_TIMEOUT: Duration = Duration::from_secs(10);
69 const AVF_STRICT_BOOT: &str = "/proc/device-tree/chosen/avf,strict-boot";
70 const AVF_NEW_INSTANCE: &str = "/proc/device-tree/chosen/avf,new-instance";
71 const AVF_DEBUG_POLICY_RAMDUMP: &str = "/proc/device-tree/avf/guest/common/ramdump";
72 const DEBUG_MICRODROID_NO_VERIFIED_BOOT: &str =
73 "/proc/device-tree/virtualization/guest/debug-microdroid,no-verified-boot";
74 const SECRETKEEPER_KEY: &str = "/proc/device-tree/avf/secretkeeper_public_key";
75 const INSTANCE_ID_PATH: &str = "/proc/device-tree/avf/untrusted/instance-id";
76 const DEFER_ROLLBACK_PROTECTION: &str = "/proc/device-tree/avf/untrusted/defer-rollback-protection";
77
78 const ENCRYPTEDSTORE_BIN: &str = "/system/bin/encryptedstore";
79 const ZIPFUSE_BIN: &str = "/system/bin/zipfuse";
80
81 const APEX_CONFIG_DONE_PROP: &str = "apex_config.done";
82 const DEBUGGABLE_PROP: &str = "ro.boot.microdroid.debuggable";
83
84 // SYNC WITH virtualizationservice/src/crosvm.rs
85 const FAILURE_SERIAL_DEVICE: &str = "/dev/ttyS1";
86
87 const ENCRYPTEDSTORE_BACKING_DEVICE: &str = "/dev/block/by-name/encryptedstore";
88 const ENCRYPTEDSTORE_KEYSIZE: usize = 32;
89
90 const DICE_CHAIN_FILE: &str = "/microdroid_resources/dice_chain.raw";
91
92 #[derive(thiserror::Error, Debug)]
93 enum MicrodroidError {
94 #[error("Cannot connect to virtualization service: {0}")]
95 FailedToConnectToVirtualizationService(String),
96 #[error("Payload has changed: {0}")]
97 PayloadChanged(String),
98 #[error("Payload verification has failed: {0}")]
99 PayloadVerificationFailed(String),
100 #[error("Payload config is invalid: {0}")]
101 PayloadInvalidConfig(String),
102 }
103
translate_error(err: &Error) -> (ErrorCode, String)104 fn translate_error(err: &Error) -> (ErrorCode, String) {
105 if let Some(e) = err.downcast_ref::<MicrodroidError>() {
106 match e {
107 MicrodroidError::PayloadChanged(msg) => (ErrorCode::PAYLOAD_CHANGED, msg.to_string()),
108 MicrodroidError::PayloadVerificationFailed(msg) => {
109 (ErrorCode::PAYLOAD_VERIFICATION_FAILED, msg.to_string())
110 }
111 MicrodroidError::PayloadInvalidConfig(msg) => {
112 (ErrorCode::PAYLOAD_INVALID_CONFIG, msg.to_string())
113 }
114 // Connection failure won't be reported to VS; return the default value
115 MicrodroidError::FailedToConnectToVirtualizationService(msg) => {
116 (ErrorCode::UNKNOWN, msg.to_string())
117 }
118 }
119 } else {
120 (ErrorCode::UNKNOWN, err.to_string())
121 }
122 }
123
write_death_reason_to_serial(err: &Error) -> Result<()>124 fn write_death_reason_to_serial(err: &Error) -> Result<()> {
125 let death_reason = if let Some(e) = err.downcast_ref::<MicrodroidError>() {
126 Borrowed(match e {
127 MicrodroidError::FailedToConnectToVirtualizationService(_) => {
128 "MICRODROID_FAILED_TO_CONNECT_TO_VIRTUALIZATION_SERVICE"
129 }
130 MicrodroidError::PayloadChanged(_) => "MICRODROID_PAYLOAD_HAS_CHANGED",
131 MicrodroidError::PayloadVerificationFailed(_) => {
132 "MICRODROID_PAYLOAD_VERIFICATION_FAILED"
133 }
134 MicrodroidError::PayloadInvalidConfig(_) => "MICRODROID_INVALID_PAYLOAD_CONFIG",
135 })
136 } else {
137 // Send context information back after a separator, to ease diagnosis.
138 // These errors occur before the payload runs, so this should not leak sensitive
139 // information.
140 Owned(format!("MICRODROID_UNKNOWN_RUNTIME_ERROR|{:?}", err))
141 };
142
143 let mut serial_file = OpenOptions::new().read(false).write(true).open(FAILURE_SERIAL_DEVICE)?;
144 serial_file.write_all(death_reason.as_bytes()).context("serial device write_all failed")?;
145 // Block until the serial port trasmits all the data to the host.
146 nix::sys::termios::tcdrain(&serial_file).context("tcdrain failed")?;
147
148 Ok(())
149 }
150
151 /// The (host allocated) instance_id can be found at node /avf/untrusted/ in the device tree.
get_instance_id() -> Result<Option<[u8; ID_SIZE]>>152 fn get_instance_id() -> Result<Option<[u8; ID_SIZE]>> {
153 let path = Path::new(INSTANCE_ID_PATH);
154 let instance_id = if path.exists() {
155 Some(
156 fs::read(path)?
157 .try_into()
158 .map_err(|x: Vec<_>| anyhow!("Expected {ID_SIZE} bytes, found {:?}", x.len()))?,
159 )
160 } else {
161 // TODO(b/325094712): x86 support for Device tree in nested guest is limited/broken/
162 // untested. So instance_id will not be present in cuttlefish.
163 None
164 };
165 Ok(instance_id)
166 }
167
should_defer_rollback_protection() -> bool168 fn should_defer_rollback_protection() -> bool {
169 Path::new(DEFER_ROLLBACK_PROTECTION).exists()
170 }
171
main() -> Result<()>172 fn main() -> Result<()> {
173 // SAFETY: This is very early in the process. Nobody has taken ownership of the inherited FDs
174 // yet.
175 unsafe { rustutils::inherited_fd::init_once()? };
176
177 // If debuggable, print full backtrace to console log with stdio_to_kmsg
178 if is_debuggable()? {
179 env::set_var("RUST_BACKTRACE", "full");
180 }
181
182 scopeguard::defer! {
183 info!("Shutting down...");
184 if let Err(e) = system_properties::write("sys.powerctl", "shutdown") {
185 error!("failed to shutdown {:?}", e);
186 }
187 }
188
189 try_main().map_err(|e| {
190 error!("Failed with {:?}.", e);
191 if let Err(e) = write_death_reason_to_serial(&e) {
192 error!("Failed to write death reason {:?}", e);
193 }
194 e
195 })
196 }
197
try_main() -> Result<()>198 fn try_main() -> Result<()> {
199 android_logger::init_once(
200 android_logger::Config::default()
201 .with_tag("microdroid_manager")
202 .with_max_level(log::LevelFilter::Info),
203 );
204 info!("started.");
205
206 let vm_payload_service_fd = android_get_control_socket(VM_PAYLOAD_SERVICE_SOCKET_NAME)?;
207
208 load_crashkernel_if_supported().context("Failed to load crashkernel")?;
209
210 swap::init_swap().context("Failed to initialize swap")?;
211 info!("swap enabled.");
212
213 let service = get_vms_rpc_binder()
214 .context("cannot connect to VirtualMachineService")
215 .map_err(|e| MicrodroidError::FailedToConnectToVirtualizationService(e.to_string()))?;
216
217 match try_run_payload(&service, vm_payload_service_fd) {
218 Ok(code) => {
219 if code == 0 {
220 info!("task successfully finished");
221 } else {
222 error!("task exited with exit code: {}", code);
223 }
224 if let Err(e) = post_payload_work() {
225 error!(
226 "Failed to run post payload work. It is possible that certain tasks
227 like syncing encrypted store might be incomplete. Error: {:?}",
228 e
229 );
230 };
231
232 info!("notifying payload finished");
233 service.notifyPayloadFinished(code)?;
234 Ok(())
235 }
236 Err(err) => {
237 let (error_code, message) = translate_error(&err);
238 service.notifyError(error_code, &message)?;
239 Err(err)
240 }
241 }
242 }
243
verify_payload_with_instance_img( metadata: &Metadata, dice: &DiceDriver, ) -> Result<MicrodroidData>244 fn verify_payload_with_instance_img(
245 metadata: &Metadata,
246 dice: &DiceDriver,
247 ) -> Result<MicrodroidData> {
248 let mut instance = InstanceDisk::new().context("Failed to load instance.img")?;
249 let saved_data = instance.read_microdroid_data(dice).context("Failed to read identity data")?;
250
251 if is_strict_boot() {
252 // Provisioning must happen on the first boot and never again.
253 if is_new_instance() {
254 ensure!(
255 saved_data.is_none(),
256 MicrodroidError::PayloadInvalidConfig(
257 "Found instance data on first boot.".to_string()
258 )
259 );
260 } else {
261 ensure!(
262 saved_data.is_some(),
263 MicrodroidError::PayloadInvalidConfig("Instance data not found.".to_string())
264 );
265 };
266 }
267
268 // Verify the payload before using it.
269 let extracted_data = verify_payload(metadata, saved_data.as_ref())
270 .context("Payload verification failed")
271 .map_err(|e| MicrodroidError::PayloadVerificationFailed(format!("{:?}", e)))?;
272
273 // In case identity is ignored (by debug policy), we should reuse existing payload data, even
274 // when the payload is changed. This is to keep the derived secret same as before.
275 let instance_data = if let Some(saved_data) = saved_data {
276 if !is_verified_boot() {
277 if saved_data != extracted_data {
278 info!("Detected an update of the payload, but continue (regarding debug policy)")
279 }
280 } else {
281 ensure!(
282 saved_data == extracted_data,
283 MicrodroidError::PayloadChanged(String::from(
284 "Detected an update of the payload which isn't supported yet."
285 ))
286 );
287 info!("Saved data is verified.");
288 }
289 saved_data
290 } else {
291 info!("Saving verified data.");
292 instance
293 .write_microdroid_data(&extracted_data, dice)
294 .context("Failed to write identity data")?;
295 extracted_data
296 };
297 Ok(instance_data)
298 }
299
try_run_payload( service: &Strong<dyn IVirtualMachineService>, vm_payload_service_fd: OwnedFd, ) -> Result<i32>300 fn try_run_payload(
301 service: &Strong<dyn IVirtualMachineService>,
302 vm_payload_service_fd: OwnedFd,
303 ) -> Result<i32> {
304 let metadata = load_metadata().context("Failed to load payload metadata")?;
305 let dice = if Path::new(DICE_CHAIN_FILE).exists() {
306 DiceDriver::from_file(Path::new(DICE_CHAIN_FILE))
307 .context("Failed to load DICE from file")?
308 } else {
309 DiceDriver::new(Path::new("/dev/open-dice0"), is_strict_boot())
310 .context("Failed to load DICE from driver")?
311 };
312
313 // Microdroid skips checking payload against instance image iff the device supports
314 // secretkeeper. In that case Microdroid use VmSecret::V2, which provide protection against
315 // rollback of boot images and packages.
316 let instance_data = if should_defer_rollback_protection() {
317 verify_payload(&metadata, None)?
318 } else {
319 verify_payload_with_instance_img(&metadata, &dice)?
320 };
321
322 let payload_metadata = metadata.payload.ok_or_else(|| {
323 MicrodroidError::PayloadInvalidConfig("No payload config in metadata".to_string())
324 })?;
325
326 // To minimize the exposure to untrusted data, derive dice profile as soon as possible.
327 info!("DICE derivation for payload");
328 let dice_artifacts = dice_derivation(dice, &instance_data, &payload_metadata)?;
329 let vm_secret =
330 VmSecret::new(dice_artifacts, service).context("Failed to create VM secrets")?;
331
332 if cfg!(dice_changes) {
333 // Now that the DICE derivation is done, it's ok to allow payload code to run.
334
335 // Start apexd to activate APEXes. This may allow code within them to run.
336 system_properties::write("ctl.start", "apexd-vm")?;
337
338 // Unmounting /microdroid_resources is a defence-in-depth effort to ensure that payload
339 // can't get hold of dice chain stored there.
340 umount2("/microdroid_resources", MntFlags::MNT_DETACH)?;
341 }
342
343 // Run encryptedstore binary to prepare the storage
344 let encryptedstore_child = if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
345 info!("Preparing encryptedstore ...");
346 Some(prepare_encryptedstore(&vm_secret).context("encryptedstore run")?)
347 } else {
348 None
349 };
350
351 let mut zipfuse = Zipfuse::default();
352
353 // Before reading a file from the APK, start zipfuse
354 zipfuse.mount(
355 MountForExec::Allowed,
356 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:system_file:s0",
357 Path::new(verify::DM_MOUNTED_APK_PATH),
358 Path::new(VM_APK_CONTENTS_PATH),
359 "microdroid_manager.apk.mounted".to_owned(),
360 )?;
361
362 // Restricted APIs are only allowed to be used by platform or test components. Infer this from
363 // the use of a VM config file since those can only be used by platform and test components.
364 let allow_restricted_apis = match payload_metadata {
365 PayloadMetadata::ConfigPath(_) => true,
366 PayloadMetadata::Config(_) => false,
367 _ => false, // default is false for safety
368 };
369
370 let config = load_config(payload_metadata).context("Failed to load payload metadata")?;
371
372 let task = config
373 .task
374 .as_ref()
375 .ok_or_else(|| MicrodroidError::PayloadInvalidConfig("No task in VM config".to_string()))?;
376
377 ensure!(
378 config.extra_apks.len() == instance_data.extra_apks_data.len(),
379 "config expects {} extra apks, but found {}",
380 config.extra_apks.len(),
381 instance_data.extra_apks_data.len()
382 );
383 mount_extra_apks(&config, &mut zipfuse)?;
384
385 register_vm_payload_service(
386 allow_restricted_apis,
387 service.clone(),
388 vm_secret,
389 vm_payload_service_fd,
390 )?;
391
392 // Set export_tombstones if enabled
393 if should_export_tombstones(&config) {
394 // This property is read by tombstone_handler.
395 system_properties::write("microdroid_manager.export_tombstones.enabled", "1")
396 .context("set microdroid_manager.export_tombstones.enabled")?;
397 }
398
399 // Wait until apex config is done. (e.g. linker configuration for apexes)
400 wait_for_property_true(APEX_CONFIG_DONE_PROP).context("Failed waiting for apex config done")?;
401
402 // Trigger init post-fs-data. This will start authfs if we wask it to.
403 if config.enable_authfs {
404 system_properties::write("microdroid_manager.authfs.enabled", "1")
405 .context("failed to write microdroid_manager.authfs.enabled")?;
406 }
407 system_properties::write("microdroid_manager.config_done", "1")
408 .context("failed to write microdroid_manager.config_done")?;
409
410 // Wait until zipfuse has mounted the APKs so we can access the payload
411 zipfuse.wait_until_done()?;
412
413 // Wait for encryptedstore to finish mounting the storage (if enabled) before setting
414 // microdroid_manager.init_done. Reason is init stops uneventd after that.
415 // Encryptedstore, however requires ueventd
416 if let Some(mut child) = encryptedstore_child {
417 let exitcode = child.wait().context("Wait for encryptedstore child")?;
418 ensure!(exitcode.success(), "Unable to prepare encrypted storage. Exitcode={}", exitcode);
419 }
420
421 // Wait for init to have finished booting.
422 wait_for_property_true("dev.bootcomplete").context("failed waiting for dev.bootcomplete")?;
423
424 // And then tell it we're done so unnecessary services can be shut down.
425 system_properties::write("microdroid_manager.init_done", "1")
426 .context("set microdroid_manager.init_done")?;
427
428 info!("boot completed, time to run payload");
429 exec_task(task, service).context("Failed to run payload")
430 }
431
post_payload_work() -> Result<()>432 fn post_payload_work() -> Result<()> {
433 // Sync the encrypted storage filesystem (flushes the filesystem caches).
434 if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
435 let mountpoint = CString::new(ENCRYPTEDSTORE_MOUNTPOINT).unwrap();
436
437 // SAFETY: `mountpoint` is a valid C string. `syncfs` and `close` are safe for any parameter
438 // values.
439 let ret = unsafe {
440 let dirfd = libc::open(
441 mountpoint.as_ptr(),
442 libc::O_DIRECTORY | libc::O_RDONLY | libc::O_CLOEXEC,
443 );
444 ensure!(dirfd >= 0, "Unable to open {:?}", mountpoint);
445 let ret = libc::syncfs(dirfd);
446 libc::close(dirfd);
447 ret
448 };
449 if ret != 0 {
450 error!("failed to sync encrypted storage.");
451 return Err(anyhow!(std::io::Error::last_os_error()));
452 }
453 }
454 Ok(())
455 }
456
mount_extra_apks(config: &VmPayloadConfig, zipfuse: &mut Zipfuse) -> Result<()>457 fn mount_extra_apks(config: &VmPayloadConfig, zipfuse: &mut Zipfuse) -> Result<()> {
458 // For now, only the number of apks is important, as the mount point and dm-verity name is fixed
459 for i in 0..config.extra_apks.len() {
460 let mount_dir = format!("/mnt/extra-apk/{i}");
461 create_dir(Path::new(&mount_dir)).context("Failed to create mount dir for extra apks")?;
462
463 let mount_for_exec =
464 if cfg!(multi_tenant) { MountForExec::Allowed } else { MountForExec::Disallowed };
465 // These run asynchronously in parallel - we wait later for them to complete.
466 zipfuse.mount(
467 mount_for_exec,
468 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:extra_apk_file:s0",
469 Path::new(&format!("/dev/block/mapper/extra-apk-{i}")),
470 Path::new(&mount_dir),
471 format!("microdroid_manager.extra_apk.mounted.{i}"),
472 )?;
473 }
474
475 Ok(())
476 }
477
get_vms_rpc_binder() -> Result<Strong<dyn IVirtualMachineService>>478 fn get_vms_rpc_binder() -> Result<Strong<dyn IVirtualMachineService>> {
479 // The host is running a VirtualMachineService for this VM on a port equal
480 // to the CID of this VM.
481 let port = vsock::get_local_cid().context("Could not determine local CID")?;
482 RpcSession::new()
483 .setup_vsock_client(VMADDR_CID_HOST, port)
484 .context("Could not connect to IVirtualMachineService")
485 }
486
is_strict_boot() -> bool487 fn is_strict_boot() -> bool {
488 Path::new(AVF_STRICT_BOOT).exists()
489 }
490
is_new_instance() -> bool491 fn is_new_instance() -> bool {
492 Path::new(AVF_NEW_INSTANCE).exists()
493 }
494
is_verified_boot() -> bool495 fn is_verified_boot() -> bool {
496 !Path::new(DEBUG_MICRODROID_NO_VERIFIED_BOOT).exists()
497 }
498
is_debuggable() -> Result<bool>499 fn is_debuggable() -> Result<bool> {
500 Ok(system_properties::read_bool(DEBUGGABLE_PROP, true)?)
501 }
502
should_export_tombstones(config: &VmPayloadConfig) -> bool503 fn should_export_tombstones(config: &VmPayloadConfig) -> bool {
504 match config.export_tombstones {
505 Some(b) => b,
506 None => is_debuggable().unwrap_or(false),
507 }
508 }
509
510 /// Get debug policy value in bool. It's true iff the value is explicitly set to <1>.
get_debug_policy_bool(path: &'static str) -> Result<Option<bool>>511 fn get_debug_policy_bool(path: &'static str) -> Result<Option<bool>> {
512 let mut file = match File::open(path) {
513 Ok(dp) => dp,
514 Err(e) => {
515 info!(
516 "Assumes that debug policy is disabled because failed to read debug policy ({e:?})"
517 );
518 return Ok(Some(false));
519 }
520 };
521 let mut log: [u8; 4] = Default::default();
522 file.read_exact(&mut log).context("Malformed data in {path}")?;
523 // DT spec uses big endian although Android is always little endian.
524 Ok(Some(u32::from_be_bytes(log) == 1))
525 }
526
527 enum MountForExec {
528 Allowed,
529 Disallowed,
530 }
531
532 #[derive(Default)]
533 struct Zipfuse {
534 ready_properties: Vec<String>,
535 }
536
537 impl Zipfuse {
mount( &mut self, noexec: MountForExec, option: &str, zip_path: &Path, mount_dir: &Path, ready_prop: String, ) -> Result<Child>538 fn mount(
539 &mut self,
540 noexec: MountForExec,
541 option: &str,
542 zip_path: &Path,
543 mount_dir: &Path,
544 ready_prop: String,
545 ) -> Result<Child> {
546 let mut cmd = Command::new(ZIPFUSE_BIN);
547 if let MountForExec::Disallowed = noexec {
548 cmd.arg("--noexec");
549 }
550 // Let root own the files in APK, so we can access them, but set the group to
551 // allow all payloads to have access too.
552 let (uid, gid) = (microdroid_uids::ROOT_UID, microdroid_uids::MICRODROID_PAYLOAD_GID);
553
554 cmd.args(["-p", &ready_prop, "-o", option]);
555 cmd.args(["-u", &uid.to_string()]);
556 cmd.args(["-g", &gid.to_string()]);
557 cmd.arg(zip_path).arg(mount_dir);
558 self.ready_properties.push(ready_prop);
559 cmd.spawn().with_context(|| format!("Failed to run zipfuse for {mount_dir:?}"))
560 }
561
wait_until_done(self) -> Result<()>562 fn wait_until_done(self) -> Result<()> {
563 // We check the last-started check first in the hope that by the time it is done
564 // all or most of the others will also be done, minimising the number of times we
565 // block on a property.
566 for property in self.ready_properties.into_iter().rev() {
567 wait_for_property_true(&property)
568 .with_context(|| format!("Failed waiting for {property}"))?;
569 }
570 Ok(())
571 }
572 }
573
wait_for_property_true(property_name: &str) -> Result<()>574 fn wait_for_property_true(property_name: &str) -> Result<()> {
575 let mut prop = PropertyWatcher::new(property_name)?;
576 loop {
577 prop.wait(None)?;
578 if system_properties::read_bool(property_name, false)? {
579 break;
580 }
581 }
582 Ok(())
583 }
584
load_config(payload_metadata: PayloadMetadata) -> Result<VmPayloadConfig>585 fn load_config(payload_metadata: PayloadMetadata) -> Result<VmPayloadConfig> {
586 match payload_metadata {
587 PayloadMetadata::ConfigPath(path) => {
588 let path = Path::new(&path);
589 info!("loading config from {:?}...", path);
590 let file = ioutil::wait_for_file(path, WAIT_TIMEOUT)
591 .with_context(|| format!("Failed to read {:?}", path))?;
592 Ok(serde_json::from_reader(file)?)
593 }
594 PayloadMetadata::Config(payload_config) => {
595 let task = Task {
596 type_: TaskType::MicrodroidLauncher,
597 command: payload_config.payload_binary_name,
598 };
599 // We don't care about the paths, only the number of extra APKs really matters.
600 let extra_apks = (0..payload_config.extra_apk_count)
601 .map(|i| ApkConfig { path: format!("extra-apk-{i}") })
602 .collect();
603 Ok(VmPayloadConfig {
604 os: OsConfig { name: "microdroid".to_owned() },
605 task: Some(task),
606 apexes: vec![],
607 extra_apks,
608 prefer_staged: false,
609 export_tombstones: None,
610 enable_authfs: false,
611 hugepages: false,
612 })
613 }
614 _ => bail!("Failed to match config against a config type."),
615 }
616 }
617
618 /// Loads the crashkernel into memory using kexec if debuggable or debug policy says so.
619 /// The VM should be loaded with `crashkernel=' parameter in the cmdline to allocate memory
620 /// for crashkernel.
load_crashkernel_if_supported() -> Result<()>621 fn load_crashkernel_if_supported() -> Result<()> {
622 let supported = std::fs::read_to_string("/proc/cmdline")?.contains(" crashkernel=");
623 info!("ramdump supported: {}", supported);
624
625 if !supported {
626 return Ok(());
627 }
628
629 let debuggable = is_debuggable()?;
630 let ramdump = get_debug_policy_bool(AVF_DEBUG_POLICY_RAMDUMP)?.unwrap_or_default();
631 let requested = debuggable | ramdump;
632
633 if requested {
634 let status = Command::new("/system/bin/kexec_load").status()?;
635 if !status.success() {
636 return Err(anyhow!("Failed to load crashkernel: {status}"));
637 }
638 info!("ramdump is loaded: debuggable={debuggable}, ramdump={ramdump}");
639 }
640 Ok(())
641 }
642
643 /// Executes the given task.
exec_task(task: &Task, service: &Strong<dyn IVirtualMachineService>) -> Result<i32>644 fn exec_task(task: &Task, service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
645 info!("executing main task {:?}...", task);
646 let mut command = match task.type_ {
647 TaskType::Executable => {
648 // TODO(b/297501338): Figure out how to handle non-root for system payloads.
649 Command::new(&task.command)
650 }
651 TaskType::MicrodroidLauncher => {
652 let mut command = Command::new("/system/bin/microdroid_launcher");
653 command.arg(find_library_path(&task.command)?);
654 command.uid(microdroid_uids::MICRODROID_PAYLOAD_UID);
655 command.gid(microdroid_uids::MICRODROID_PAYLOAD_GID);
656 command
657 }
658 };
659
660 // SAFETY: We are not accessing any resource of the parent process. This means we can't make any
661 // log calls inside the closure.
662 unsafe {
663 command.pre_exec(|| {
664 // It is OK to continue with payload execution even if the calls below fail, since
665 // whether process can use a capability is controlled by the SELinux. Dropping the
666 // capabilities here is just another defense-in-depth layer.
667 let _ = cap::drop_inheritable_caps();
668 let _ = cap::drop_bounding_set();
669 Ok(())
670 });
671 }
672
673 if !is_debuggable()? {
674 command.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
675 }
676
677 info!("notifying payload started");
678 service.notifyPayloadStarted()?;
679
680 let exit_status = command.spawn()?.wait()?;
681 match exit_status.code() {
682 Some(exit_code) => Ok(exit_code),
683 None => Err(match exit_status.signal() {
684 Some(signal) => anyhow!(
685 "Payload exited due to signal: {} ({})",
686 signal,
687 Signal::try_from(signal).map_or("unknown", |s| s.as_str())
688 ),
689 None => anyhow!("Payload has neither exit code nor signal"),
690 }),
691 }
692 }
693
find_library_path(name: &str) -> Result<String>694 fn find_library_path(name: &str) -> Result<String> {
695 let mut watcher = PropertyWatcher::new("ro.product.cpu.abilist")?;
696 let value = watcher.read(|_name, value| Ok(value.trim().to_string()))?;
697 let abi = value.split(',').next().ok_or_else(|| anyhow!("no abilist"))?;
698 let path = format!("{}/lib/{}/{}", VM_APK_CONTENTS_PATH, abi, name);
699
700 let metadata = fs::metadata(&path).with_context(|| format!("Unable to access {}", path))?;
701 if !metadata.is_file() {
702 bail!("{} is not a file", &path);
703 }
704
705 Ok(path)
706 }
707
prepare_encryptedstore(vm_secret: &VmSecret) -> Result<Child>708 fn prepare_encryptedstore(vm_secret: &VmSecret) -> Result<Child> {
709 let mut key = ZVec::new(ENCRYPTEDSTORE_KEYSIZE)?;
710 vm_secret.derive_encryptedstore_key(&mut key)?;
711 let mut cmd = Command::new(ENCRYPTEDSTORE_BIN);
712 cmd.arg("--blkdevice")
713 .arg(ENCRYPTEDSTORE_BACKING_DEVICE)
714 .arg("--key")
715 .arg(hex::encode(&*key))
716 .args(["--mountpoint", ENCRYPTEDSTORE_MOUNTPOINT])
717 .spawn()
718 .context("encryptedstore failed")
719 }
720