blob: 8888feb68e911af3d2ad0255c43f5c1ff24b8bc7 [file] [log] [blame]
Jooyung Han347d9f22021-05-28 00:05:14 +09001// 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
Andrew Sculld64ae7d2022-10-05 17:41:43 +000017mod dice;
Alan Stokes1125e012023-10-13 12:31:10 +010018mod dice_driver;
Jiyong Park21ce2c52021-08-28 02:32:17 +090019mod instance;
Jooyung Hanf48ceb42021-06-01 18:00:04 +090020mod ioutil;
Jooyung Han7a343f92021-09-08 22:53:11 +090021mod payload;
Keir Fraser933f0ac2022-10-12 08:23:28 +000022mod swap;
Alan Stokes1125e012023-10-13 12:31:10 +010023mod verify;
Alice Wang59a9e562022-10-04 15:24:10 +000024mod vm_payload_service;
Shikha Panwar95084df2023-07-22 11:47:45 +000025mod vm_secret;
Jooyung Han347d9f22021-05-28 00:05:14 +090026
Alan Stokes2bead0d2022-09-05 16:58:34 +010027use android_system_virtualizationcommon::aidl::android::system::virtualizationcommon::ErrorCode::ErrorCode;
David Brazdil73988ea2022-11-11 15:10:32 +000028use android_system_virtualmachineservice::aidl::android::system::virtualmachineservice::IVirtualMachineService::IVirtualMachineService;
Inseob Kim090b70b2022-11-16 20:01:14 +090029use android_system_virtualization_payload::aidl::android::system::virtualization::payload::IVmPayloadService::{
30 VM_APK_CONTENTS_PATH,
31 VM_PAYLOAD_SERVICE_SOCKET_NAME,
Shikha Panwarddc124b2022-11-28 19:17:54 +000032 ENCRYPTEDSTORE_MOUNTPOINT,
Inseob Kim090b70b2022-11-16 20:01:14 +090033};
Alan Stokes1125e012023-10-13 12:31:10 +010034
35use crate::dice::dice_derivation;
36use crate::dice_driver::DiceDriver;
Alan Stokes03754962023-11-06 15:36:09 +000037use crate::instance::{InstanceDisk, MicrodroidData};
Alan Stokes1125e012023-10-13 12:31:10 +010038use crate::verify::verify_payload;
39use crate::vm_payload_service::register_vm_payload_service;
Jooyung Handd0a1732021-11-23 15:26:20 +090040use anyhow::{anyhow, bail, ensure, Context, Error, Result};
Alice Wang43c884b2022-10-24 09:42:40 +000041use binder::Strong;
Alice Wang7e6c9352023-02-15 15:44:13 +000042use keystore2_crypto::ZVec;
Alan Stokes1125e012023-10-13 12:31:10 +010043use libc::VMADDR_CID_HOST;
44use log::{error, info};
Alan Stokes03754962023-11-06 15:36:09 +000045use microdroid_metadata::PayloadMetadata;
Seungjae Yoofd9a0622022-10-14 10:01:29 +090046use microdroid_payload_config::{OsConfig, Task, TaskType, VmPayloadConfig};
Frederick Mayleb5f7b6b2022-11-11 15:24:03 -080047use nix::sys::signal::Signal;
Shikha Panwar0503cb02024-01-05 10:11:28 +000048use openssl::hkdf::hkdf;
49use openssl::md::Md;
Alan Stokes03754962023-11-06 15:36:09 +000050use payload::load_metadata;
David Brazdila2125dd2022-12-14 16:37:44 +000051use rpcbinder::RpcSession;
Inseob Kim090b70b2022-11-16 20:01:14 +090052use rustutils::sockets::android_get_control_socket;
Jiyong Parkbb4a9872021-09-06 15:59:21 +090053use rustutils::system_properties;
Joel Galenson482704c2021-07-29 15:53:53 -070054use rustutils::system_properties::PropertyWatcher;
Shikha Panwar0503cb02024-01-05 10:11:28 +000055use secretkeeper_comm::data_types::ID_SIZE;
Alan Stokes3ba10fd2022-10-06 15:46:51 +010056use std::borrow::Cow::{Borrowed, Owned};
Inseob Kim7ff121c2022-11-14 18:13:23 +090057use std::env;
Shikha Panwardef7ef92023-01-06 08:35:48 +000058use std::ffi::CString;
Alan Stokes1125e012023-10-13 12:31:10 +010059use std::fs::{self, create_dir, File, OpenOptions};
Jaewan Kim3124ef02023-03-23 19:25:20 +090060use std::io::{Read, Write};
Alan Stokes1125e012023-10-13 12:31:10 +010061use std::os::unix::io::{FromRawFd, OwnedFd};
Nikita Ioffe3452ee22022-12-15 00:31:56 +000062use std::os::unix::process::CommandExt;
Frederick Mayleb5f7b6b2022-11-11 15:24:03 -080063use std::os::unix::process::ExitStatusExt;
Jooyung Hanf48ceb42021-06-01 18:00:04 +090064use std::path::Path;
Inseob Kim217038e2021-11-25 11:15:06 +090065use std::process::{Child, Command, Stdio};
Jiyong Park8611a6c2021-07-09 18:17:44 +090066use std::str;
Alan Stokes1125e012023-10-13 12:31:10 +010067use std::time::Duration;
Shikha Panwar95084df2023-07-22 11:47:45 +000068use vm_secret::VmSecret;
Jooyung Han634e2d72021-06-10 16:27:38 +090069
70const WAIT_TIMEOUT: Duration = Duration::from_secs(10);
Andrew Scullab72ec52022-03-14 09:10:52 +000071const AVF_STRICT_BOOT: &str = "/sys/firmware/devicetree/base/chosen/avf,strict-boot";
72const AVF_NEW_INSTANCE: &str = "/sys/firmware/devicetree/base/chosen/avf,new-instance";
Jaewan Kim3124ef02023-03-23 19:25:20 +090073const AVF_DEBUG_POLICY_RAMDUMP: &str = "/sys/firmware/devicetree/base/avf/guest/common/ramdump";
Inseob Kime379e7d2022-07-22 18:55:18 +090074const DEBUG_MICRODROID_NO_VERIFIED_BOOT: &str =
75 "/sys/firmware/devicetree/base/virtualization/guest/debug-microdroid,no-verified-boot";
Jooyung Han347d9f22021-05-28 00:05:14 +090076
Alan Stokes4fb201c2023-02-08 17:39:05 +000077const ENCRYPTEDSTORE_BIN: &str = "/system/bin/encryptedstore";
78const ZIPFUSE_BIN: &str = "/system/bin/zipfuse";
79
Jiyong Parkbb4a9872021-09-06 15:59:21 +090080const APEX_CONFIG_DONE_PROP: &str = "apex_config.done";
Seungjae Yoofa22bb02022-12-08 16:38:42 +090081const DEBUGGABLE_PROP: &str = "ro.boot.microdroid.debuggable";
Jiyong Parkbb4a9872021-09-06 15:59:21 +090082
Inseob Kim11f40d02022-06-13 17:16:00 +090083// SYNC WITH virtualizationservice/src/crosvm.rs
84const FAILURE_SERIAL_DEVICE: &str = "/dev/ttyS1";
85
Shikha Panwar566c9672022-11-15 14:39:58 +000086const ENCRYPTEDSTORE_BACKING_DEVICE: &str = "/dev/block/by-name/encryptedstore";
Alice Wang62f7e642023-02-10 09:55:13 +000087const ENCRYPTEDSTORE_KEYSIZE: usize = 32;
Shikha Panwar566c9672022-11-15 14:39:58 +000088
Jooyung Handd0a1732021-11-23 15:26:20 +090089#[derive(thiserror::Error, Debug)]
90enum MicrodroidError {
Inseob Kim11f40d02022-06-13 17:16:00 +090091 #[error("Cannot connect to virtualization service: {0}")]
92 FailedToConnectToVirtualizationService(String),
Jooyung Handd0a1732021-11-23 15:26:20 +090093 #[error("Payload has changed: {0}")]
94 PayloadChanged(String),
95 #[error("Payload verification has failed: {0}")]
96 PayloadVerificationFailed(String),
Jooyung Han5c6d4172021-12-06 14:17:52 +090097 #[error("Payload config is invalid: {0}")]
Alan Stokesbbed8872023-10-19 13:17:12 +010098 PayloadInvalidConfig(String),
Jooyung Handd0a1732021-11-23 15:26:20 +090099}
100
Alan Stokes2bead0d2022-09-05 16:58:34 +0100101fn translate_error(err: &Error) -> (ErrorCode, String) {
Jooyung Handd0a1732021-11-23 15:26:20 +0900102 if let Some(e) = err.downcast_ref::<MicrodroidError>() {
103 match e {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100104 MicrodroidError::PayloadChanged(msg) => (ErrorCode::PAYLOAD_CHANGED, msg.to_string()),
Jooyung Handd0a1732021-11-23 15:26:20 +0900105 MicrodroidError::PayloadVerificationFailed(msg) => {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100106 (ErrorCode::PAYLOAD_VERIFICATION_FAILED, msg.to_string())
Jooyung Handd0a1732021-11-23 15:26:20 +0900107 }
Alan Stokesbbed8872023-10-19 13:17:12 +0100108 MicrodroidError::PayloadInvalidConfig(msg) => {
109 (ErrorCode::PAYLOAD_INVALID_CONFIG, msg.to_string())
Alan Stokes2bead0d2022-09-05 16:58:34 +0100110 }
Inseob Kim11f40d02022-06-13 17:16:00 +0900111 // Connection failure won't be reported to VS; return the default value
112 MicrodroidError::FailedToConnectToVirtualizationService(msg) => {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100113 (ErrorCode::UNKNOWN, msg.to_string())
Inseob Kim11f40d02022-06-13 17:16:00 +0900114 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900115 }
116 } else {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100117 (ErrorCode::UNKNOWN, err.to_string())
Jooyung Handd0a1732021-11-23 15:26:20 +0900118 }
119}
120
Inseob Kim11f40d02022-06-13 17:16:00 +0900121fn write_death_reason_to_serial(err: &Error) -> Result<()> {
122 let death_reason = if let Some(e) = err.downcast_ref::<MicrodroidError>() {
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100123 Borrowed(match e {
Inseob Kim11f40d02022-06-13 17:16:00 +0900124 MicrodroidError::FailedToConnectToVirtualizationService(_) => {
125 "MICRODROID_FAILED_TO_CONNECT_TO_VIRTUALIZATION_SERVICE"
126 }
127 MicrodroidError::PayloadChanged(_) => "MICRODROID_PAYLOAD_HAS_CHANGED",
128 MicrodroidError::PayloadVerificationFailed(_) => {
129 "MICRODROID_PAYLOAD_VERIFICATION_FAILED"
130 }
Alan Stokesbbed8872023-10-19 13:17:12 +0100131 MicrodroidError::PayloadInvalidConfig(_) => "MICRODROID_INVALID_PAYLOAD_CONFIG",
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100132 })
Inseob Kim11f40d02022-06-13 17:16:00 +0900133 } else {
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100134 // Send context information back after a separator, to ease diagnosis.
135 // These errors occur before the payload runs, so this should not leak sensitive
136 // information.
137 Owned(format!("MICRODROID_UNKNOWN_RUNTIME_ERROR|{:?}", err))
Inseob Kim11f40d02022-06-13 17:16:00 +0900138 };
139
Pierre-Clément Tosid225af52023-09-15 15:59:20 +0100140 for chunk in death_reason.as_bytes().chunks(16) {
Inseob Kim11f40d02022-06-13 17:16:00 +0900141 // TODO(b/220071963): Sometimes, sending more than 16 bytes at once makes MM hang.
Pierre-Clément Tosid225af52023-09-15 15:59:20 +0100142 OpenOptions::new().read(false).write(true).open(FAILURE_SERIAL_DEVICE)?.write_all(chunk)?;
Inseob Kim11f40d02022-06-13 17:16:00 +0900143 }
144
145 Ok(())
146}
147
Inseob Kim437f1052022-06-21 11:30:22 +0900148fn main() -> Result<()> {
Inseob Kim7ff121c2022-11-14 18:13:23 +0900149 // If debuggable, print full backtrace to console log with stdio_to_kmsg
Alan Stokes1125e012023-10-13 12:31:10 +0100150 if is_debuggable()? {
Inseob Kim7ff121c2022-11-14 18:13:23 +0900151 env::set_var("RUST_BACKTRACE", "full");
152 }
153
Inseob Kim437f1052022-06-21 11:30:22 +0900154 scopeguard::defer! {
155 info!("Shutting down...");
Jooyung Hanbfe086f2021-10-28 10:15:45 +0900156 if let Err(e) = system_properties::write("sys.powerctl", "shutdown") {
157 error!("failed to shutdown {:?}", e);
158 }
Jooyung Han311b1202021-09-14 22:00:16 +0900159 }
Inseob Kim437f1052022-06-21 11:30:22 +0900160
161 try_main().map_err(|e| {
162 error!("Failed with {:?}.", e);
163 if let Err(e) = write_death_reason_to_serial(&e) {
164 error!("Failed to write death reason {:?}", e);
165 }
166 e
167 })
Jooyung Han311b1202021-09-14 22:00:16 +0900168}
169
170fn try_main() -> Result<()> {
Jiyong Park2b6346d2023-06-19 13:37:42 +0900171 android_logger::init_once(
172 android_logger::Config::default()
173 .with_tag("microdroid_manager")
174 .with_min_level(log::Level::Info),
175 );
Jooyung Han347d9f22021-05-28 00:05:14 +0900176 info!("started.");
177
Alice Wangfd222fd2023-05-25 09:37:38 +0000178 // SAFETY: This is the only place we take the ownership of the fd of the vm payload service.
179 //
Alice Wang2a5306e2023-06-05 09:18:32 +0000180 // To ensure that the CLOEXEC flag is set on the file descriptor as early as possible,
181 // it is necessary to fetch the socket corresponding to vm_payload_service at the
182 // very beginning, as android_get_control_socket() sets the CLOEXEC flag on the file
183 // descriptor.
Alice Wangfd222fd2023-05-25 09:37:38 +0000184 let vm_payload_service_fd = unsafe { prepare_vm_payload_service_socket()? };
Inseob Kim090b70b2022-11-16 20:01:14 +0900185
Jiyong Park202856e2022-08-22 16:04:26 +0900186 load_crashkernel_if_supported().context("Failed to load crashkernel")?;
187
Alice Wangeff58392023-07-04 13:32:09 +0000188 swap::init_swap().context("Failed to initialize swap")?;
Keir Fraser933f0ac2022-10-12 08:23:28 +0000189 info!("swap enabled.");
190
Inseob Kim11f40d02022-06-13 17:16:00 +0900191 let service = get_vms_rpc_binder()
192 .context("cannot connect to VirtualMachineService")
193 .map_err(|e| MicrodroidError::FailedToConnectToVirtualizationService(e.to_string()))?;
Seungjae Yoofd9a0622022-10-14 10:01:29 +0900194
Alice Wangfd222fd2023-05-25 09:37:38 +0000195 match try_run_payload(&service, vm_payload_service_fd) {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900196 Ok(code) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900197 if code == 0 {
198 info!("task successfully finished");
199 } else {
200 error!("task exited with exit code: {}", code);
201 }
Shikha Panwardef7ef92023-01-06 08:35:48 +0000202 if let Err(e) = post_payload_work() {
203 error!(
204 "Failed to run post payload work. It is possible that certain tasks
205 like syncing encrypted store might be incomplete. Error: {:?}",
206 e
207 );
208 };
209
210 info!("notifying payload finished");
211 service.notifyPayloadFinished(code)?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900212 Ok(())
213 }
214 Err(err) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900215 let (error_code, message) = translate_error(&err);
216 service.notifyError(error_code, &message)?;
217 Err(err)
218 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900219 }
220}
221
Alice Wangfd222fd2023-05-25 09:37:38 +0000222fn try_run_payload(
223 service: &Strong<dyn IVirtualMachineService>,
224 vm_payload_service_fd: OwnedFd,
225) -> Result<i32> {
Jooyung Han311b1202021-09-14 22:00:16 +0900226 let metadata = load_metadata().context("Failed to load payload metadata")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000227 let dice = DiceDriver::new(Path::new("/dev/open-dice0")).context("Failed to load DICE")?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900228
Jooyung Han311b1202021-09-14 22:00:16 +0900229 let mut instance = InstanceDisk::new().context("Failed to load instance.img")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000230 let saved_data =
231 instance.read_microdroid_data(&dice).context("Failed to read identity data")?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900232
Andrew Scullab72ec52022-03-14 09:10:52 +0000233 if is_strict_boot() {
234 // Provisioning must happen on the first boot and never again.
235 if is_new_instance() {
236 ensure!(
237 saved_data.is_none(),
Alan Stokesbbed8872023-10-19 13:17:12 +0100238 MicrodroidError::PayloadInvalidConfig(
239 "Found instance data on first boot.".to_string()
240 )
Andrew Scullab72ec52022-03-14 09:10:52 +0000241 );
242 } else {
243 ensure!(
244 saved_data.is_some(),
Alan Stokesbbed8872023-10-19 13:17:12 +0100245 MicrodroidError::PayloadInvalidConfig("Instance data not found.".to_string())
Andrew Scullab72ec52022-03-14 09:10:52 +0000246 );
247 };
248 }
249
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900250 // Verify the payload before using it.
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000251 let extracted_data = verify_payload(&metadata, saved_data.as_ref())
Inseob Kim11f40d02022-06-13 17:16:00 +0900252 .context("Payload verification failed")
253 .map_err(|e| MicrodroidError::PayloadVerificationFailed(e.to_string()))?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900254
255 // In case identity is ignored (by debug policy), we should reuse existing payload data, even
256 // when the payload is changed. This is to keep the derived secret same as before.
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000257 let instance_data = if let Some(saved_data) = saved_data {
Inseob Kime379e7d2022-07-22 18:55:18 +0900258 if !is_verified_boot() {
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000259 if saved_data != extracted_data {
Inseob Kime379e7d2022-07-22 18:55:18 +0900260 info!("Detected an update of the payload, but continue (regarding debug policy)")
261 }
262 } else {
263 ensure!(
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000264 saved_data == extracted_data,
Inseob Kime379e7d2022-07-22 18:55:18 +0900265 MicrodroidError::PayloadChanged(String::from(
266 "Detected an update of the payload which isn't supported yet."
267 ))
268 );
269 info!("Saved data is verified.");
270 }
271 saved_data
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900272 } else {
Jooyung Han7a343f92021-09-08 22:53:11 +0900273 info!("Saving verified data.");
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000274 instance
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000275 .write_microdroid_data(&extracted_data, &dice)
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000276 .context("Failed to write identity data")?;
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000277 extracted_data
Inseob Kime379e7d2022-07-22 18:55:18 +0900278 };
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900279
Alan Stokes1f417c92022-09-29 15:13:28 +0100280 let payload_metadata = metadata.payload.ok_or_else(|| {
Alan Stokesbbed8872023-10-19 13:17:12 +0100281 MicrodroidError::PayloadInvalidConfig("No payload config in metadata".to_string())
Alan Stokes1f417c92022-09-29 15:13:28 +0100282 })?;
Alan Stokes0d1ef782022-09-27 13:46:35 +0100283
Inseob Kimb2519c52022-04-14 02:10:09 +0900284 // To minimize the exposure to untrusted data, derive dice profile as soon as possible.
285 info!("DICE derivation for payload");
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000286 let dice_artifacts = dice_derivation(dice, &instance_data, &payload_metadata)?;
Shikha Panwar0503cb02024-01-05 10:11:28 +0000287 // TODO(b/291213394): This will be the Id for non-pVM only, instance_data.salt is all 0
288 // for protected VM, implement a mechanism for pVM!
289 let mut vm_id = [0u8; ID_SIZE];
290 hkdf(
291 &mut vm_id,
292 Md::sha256(),
293 &instance_data.salt,
294 /* salt */ b"",
295 /* info */ b"VM_ID",
296 )
297 .context("hkdf failed")?;
Shikha Panwar5d6a6752023-12-14 22:08:26 +0000298 let vm_secret =
Shikha Panwar0503cb02024-01-05 10:11:28 +0000299 VmSecret::new(vm_id, dice_artifacts, service).context("Failed to create VM secrets")?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000300
Alan Stokes9a7f67e2023-11-07 09:37:40 +0000301 if cfg!(dice_changes) {
302 // Now that the DICE derivation is done, it's ok to allow payload code to run.
303
304 // Start apexd to activate APEXes. This may allow code within them to run.
305 system_properties::write("ctl.start", "apexd-vm")?;
306 }
307
Shikha Panwar566c9672022-11-15 14:39:58 +0000308 // Run encryptedstore binary to prepare the storage
309 let encryptedstore_child = if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
310 info!("Preparing encryptedstore ...");
Shikha Panwar95084df2023-07-22 11:47:45 +0000311 Some(prepare_encryptedstore(&vm_secret).context("encryptedstore run")?)
Shikha Panwar566c9672022-11-15 14:39:58 +0000312 } else {
313 None
314 };
Inseob Kimb2519c52022-04-14 02:10:09 +0900315
Alan Stokes960c9032022-12-07 16:53:45 +0000316 let mut zipfuse = Zipfuse::default();
317
Jooyung Hana6d11eb2021-09-10 11:48:05 +0900318 // Before reading a file from the APK, start zipfuse
Alan Stokes960c9032022-12-07 16:53:45 +0000319 zipfuse.mount(
Alan Stokes60f82202022-10-07 16:40:07 +0100320 MountForExec::Allowed,
Inseob Kim217038e2021-11-25 11:15:06 +0900321 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:system_file:s0",
Alan Stokes1125e012023-10-13 12:31:10 +0100322 Path::new(verify::DM_MOUNTED_APK_PATH),
Alice Wang6bbb6da2022-10-26 12:44:06 +0000323 Path::new(VM_APK_CONTENTS_PATH),
Alan Stokes960c9032022-12-07 16:53:45 +0000324 "microdroid_manager.apk.mounted".to_owned(),
325 )?;
Jiyong Park21ce2c52021-08-28 02:32:17 +0900326
Andrew Scull4d262dc2022-10-21 13:14:33 +0000327 // Restricted APIs are only allowed to be used by platform or test components. Infer this from
328 // the use of a VM config file since those can only be used by platform and test components.
329 let allow_restricted_apis = match payload_metadata {
Ludovic Barman93ee3082023-06-20 12:18:43 +0000330 PayloadMetadata::ConfigPath(_) => true,
331 PayloadMetadata::Config(_) => false,
332 _ => false, // default is false for safety
Andrew Scull4d262dc2022-10-21 13:14:33 +0000333 };
334
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100335 let config = load_config(payload_metadata).context("Failed to load payload metadata")?;
Shikha Panwar6f03c942022-04-13 20:26:50 +0000336
Alan Stokes01b3ef02022-09-22 17:43:24 +0100337 let task = config
338 .task
339 .as_ref()
Alan Stokesbbed8872023-10-19 13:17:12 +0100340 .ok_or_else(|| MicrodroidError::PayloadInvalidConfig("No task in VM config".to_string()))?;
Alan Stokes01b3ef02022-09-22 17:43:24 +0100341
Alice Wang061478b2023-04-11 13:26:17 +0000342 ensure!(
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000343 config.extra_apks.len() == instance_data.extra_apks_data.len(),
Alice Wang061478b2023-04-11 13:26:17 +0000344 "config expects {} extra apks, but found {}",
345 config.extra_apks.len(),
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000346 instance_data.extra_apks_data.len()
Alice Wang061478b2023-04-11 13:26:17 +0000347 );
Alan Stokes960c9032022-12-07 16:53:45 +0000348 mount_extra_apks(&config, &mut zipfuse)?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900349
Alan Stokes26efd192023-11-06 16:30:15 +0000350 register_vm_payload_service(
351 allow_restricted_apis,
352 service.clone(),
353 vm_secret,
354 vm_payload_service_fd,
355 )?;
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000356
Shikha Panwar1a6efcd2023-02-03 19:23:43 +0000357 // Set export_tombstones if enabled
Inseob Kimab1037d2023-02-08 17:03:31 +0900358 if should_export_tombstones(&config) {
Shikha Panwar1a6efcd2023-02-03 19:23:43 +0000359 // This property is read by tombstone_handler.
360 system_properties::write("microdroid_manager.export_tombstones.enabled", "1")
361 .context("set microdroid_manager.export_tombstones.enabled")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900362 }
363
Alan Stokes26efd192023-11-06 16:30:15 +0000364 // Wait until apex config is done. (e.g. linker configuration for apexes)
365 wait_for_property_true(APEX_CONFIG_DONE_PROP).context("Failed waiting for apex config done")?;
366
367 // Trigger init post-fs-data. This will start authfs if we wask it to.
368 if config.enable_authfs {
369 system_properties::write("microdroid_manager.authfs.enabled", "1")
370 .context("failed to write microdroid_manager.authfs.enabled")?;
371 }
372 system_properties::write("microdroid_manager.config_done", "1")
373 .context("failed to write microdroid_manager.config_done")?;
374
Alan Stokes960c9032022-12-07 16:53:45 +0000375 // Wait until zipfuse has mounted the APKs so we can access the payload
376 zipfuse.wait_until_done()?;
Alan Stokes60f82202022-10-07 16:40:07 +0100377
Shikha Panwarddc124b2022-11-28 19:17:54 +0000378 // Wait for encryptedstore to finish mounting the storage (if enabled) before setting
379 // microdroid_manager.init_done. Reason is init stops uneventd after that.
380 // Encryptedstore, however requires ueventd
Shikha Panwar566c9672022-11-15 14:39:58 +0000381 if let Some(mut child) = encryptedstore_child {
382 let exitcode = child.wait().context("Wait for encryptedstore child")?;
383 ensure!(exitcode.success(), "Unable to prepare encrypted storage. Exitcode={}", exitcode);
384 }
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100385
Alan Stokes26efd192023-11-06 16:30:15 +0000386 // Wait for init to have finished booting.
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000387 wait_for_property_true("dev.bootcomplete").context("failed waiting for dev.bootcomplete")?;
Alan Stokes26efd192023-11-06 16:30:15 +0000388
389 // And then tell it we're done so unnecessary services can be shut down.
Shikha Panwar3f6f6a52022-11-29 17:28:36 +0000390 system_properties::write("microdroid_manager.init_done", "1")
391 .context("set microdroid_manager.init_done")?;
Inseob Kimc16b0cc2023-01-26 14:57:24 +0900392
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000393 info!("boot completed, time to run payload");
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100394 exec_task(task, service).context("Failed to run payload")
Alan Stokes01b3ef02022-09-22 17:43:24 +0100395}
396
Alan Stokes03754962023-11-06 15:36:09 +0000397fn post_payload_work() -> Result<()> {
398 // Sync the encrypted storage filesystem (flushes the filesystem caches).
399 if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
400 let mountpoint = CString::new(ENCRYPTEDSTORE_MOUNTPOINT).unwrap();
401
402 // SAFETY: `mountpoint` is a valid C string. `syncfs` and `close` are safe for any parameter
403 // values.
404 let ret = unsafe {
405 let dirfd = libc::open(
406 mountpoint.as_ptr(),
407 libc::O_DIRECTORY | libc::O_RDONLY | libc::O_CLOEXEC,
408 );
409 ensure!(dirfd >= 0, "Unable to open {:?}", mountpoint);
410 let ret = libc::syncfs(dirfd);
411 libc::close(dirfd);
412 ret
413 };
414 if ret != 0 {
415 error!("failed to sync encrypted storage.");
416 return Err(anyhow!(std::io::Error::last_os_error()));
417 }
418 }
419 Ok(())
420}
421
Alan Stokes03754962023-11-06 15:36:09 +0000422fn mount_extra_apks(config: &VmPayloadConfig, zipfuse: &mut Zipfuse) -> Result<()> {
423 // For now, only the number of apks is important, as the mount point and dm-verity name is fixed
424 for i in 0..config.extra_apks.len() {
425 let mount_dir = format!("/mnt/extra-apk/{i}");
426 create_dir(Path::new(&mount_dir)).context("Failed to create mount dir for extra apks")?;
427
428 let mount_for_exec =
429 if cfg!(multi_tenant) { MountForExec::Allowed } else { MountForExec::Disallowed };
430 // These run asynchronously in parallel - we wait later for them to complete.
431 zipfuse.mount(
432 mount_for_exec,
433 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:extra_apk_file:s0",
434 Path::new(&format!("/dev/block/mapper/extra-apk-{i}")),
435 Path::new(&mount_dir),
436 format!("microdroid_manager.extra_apk.mounted.{i}"),
437 )?;
438 }
439
440 Ok(())
441}
442
443fn get_vms_rpc_binder() -> Result<Strong<dyn IVirtualMachineService>> {
444 // The host is running a VirtualMachineService for this VM on a port equal
445 // to the CID of this VM.
446 let port = vsock::get_local_cid().context("Could not determine local CID")?;
447 RpcSession::new()
448 .setup_vsock_client(VMADDR_CID_HOST, port)
449 .context("Could not connect to IVirtualMachineService")
450}
451
452/// Prepares a socket file descriptor for the vm payload service.
453///
454/// # Safety
455///
456/// The caller must ensure that this function is the only place that claims ownership
457/// of the file descriptor and it is called only once.
458unsafe fn prepare_vm_payload_service_socket() -> Result<OwnedFd> {
459 let raw_fd = android_get_control_socket(VM_PAYLOAD_SERVICE_SOCKET_NAME)?;
460
461 // Creating OwnedFd for stdio FDs is not safe.
462 if [libc::STDIN_FILENO, libc::STDOUT_FILENO, libc::STDERR_FILENO].contains(&raw_fd) {
463 bail!("File descriptor {raw_fd} is standard I/O descriptor");
464 }
465 // SAFETY: Initializing OwnedFd for a RawFd created by the init.
466 // We checked that the integer value corresponds to a valid FD and that the caller
467 // ensures that this is the only place to claim its ownership.
468 Ok(unsafe { OwnedFd::from_raw_fd(raw_fd) })
469}
470
471fn is_strict_boot() -> bool {
472 Path::new(AVF_STRICT_BOOT).exists()
473}
474
475fn is_new_instance() -> bool {
476 Path::new(AVF_NEW_INSTANCE).exists()
477}
478
479fn is_verified_boot() -> bool {
480 !Path::new(DEBUG_MICRODROID_NO_VERIFIED_BOOT).exists()
481}
482
483fn is_debuggable() -> Result<bool> {
484 Ok(system_properties::read_bool(DEBUGGABLE_PROP, true)?)
485}
486
487fn should_export_tombstones(config: &VmPayloadConfig) -> bool {
488 match config.export_tombstones {
489 Some(b) => b,
490 None => is_debuggable().unwrap_or(false),
491 }
492}
493
494/// Get debug policy value in bool. It's true iff the value is explicitly set to <1>.
495fn get_debug_policy_bool(path: &'static str) -> Result<Option<bool>> {
496 let mut file = match File::open(path) {
497 Ok(dp) => dp,
498 Err(e) => {
499 info!(
500 "Assumes that debug policy is disabled because failed to read debug policy ({e:?})"
501 );
502 return Ok(Some(false));
503 }
504 };
505 let mut log: [u8; 4] = Default::default();
506 file.read_exact(&mut log).context("Malformed data in {path}")?;
507 // DT spec uses big endian although Android is always little endian.
508 Ok(Some(u32::from_be_bytes(log) == 1))
509}
510
Alan Stokes60f82202022-10-07 16:40:07 +0100511enum MountForExec {
512 Allowed,
513 Disallowed,
514}
515
Alan Stokes960c9032022-12-07 16:53:45 +0000516#[derive(Default)]
517struct Zipfuse {
518 ready_properties: Vec<String>,
519}
520
521impl Zipfuse {
522 fn mount(
523 &mut self,
524 noexec: MountForExec,
525 option: &str,
526 zip_path: &Path,
527 mount_dir: &Path,
528 ready_prop: String,
529 ) -> Result<Child> {
530 let mut cmd = Command::new(ZIPFUSE_BIN);
531 if let MountForExec::Disallowed = noexec {
532 cmd.arg("--noexec");
533 }
Alan Stokes1294f942023-08-21 14:34:12 +0100534 // Let root own the files in APK, so we can access them, but set the group to
535 // allow all payloads to have access too.
536 let (uid, gid) = (microdroid_uids::ROOT_UID, microdroid_uids::MICRODROID_PAYLOAD_GID);
537
Alan Stokes960c9032022-12-07 16:53:45 +0000538 cmd.args(["-p", &ready_prop, "-o", option]);
Alan Stokes1294f942023-08-21 14:34:12 +0100539 cmd.args(["-u", &uid.to_string()]);
540 cmd.args(["-g", &gid.to_string()]);
Alan Stokes960c9032022-12-07 16:53:45 +0000541 cmd.arg(zip_path).arg(mount_dir);
542 self.ready_properties.push(ready_prop);
543 cmd.spawn().with_context(|| format!("Failed to run zipfuse for {mount_dir:?}"))
Andrew Scullcc339a12022-07-04 12:44:19 +0000544 }
Alan Stokes960c9032022-12-07 16:53:45 +0000545
546 fn wait_until_done(self) -> Result<()> {
547 // We check the last-started check first in the hope that by the time it is done
548 // all or most of the others will also be done, minimising the number of times we
549 // block on a property.
550 for property in self.ready_properties.into_iter().rev() {
551 wait_for_property_true(&property)
552 .with_context(|| format!("Failed waiting for {property}"))?;
553 }
554 Ok(())
Alan Stokes60f82202022-10-07 16:40:07 +0100555 }
Inseob Kim217038e2021-11-25 11:15:06 +0900556}
557
Alan Stokes60f82202022-10-07 16:40:07 +0100558fn wait_for_property_true(property_name: &str) -> Result<()> {
559 let mut prop = PropertyWatcher::new(property_name)?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900560 loop {
Andrew Walbrand9c766e2023-05-10 15:15:39 +0000561 prop.wait(None)?;
Alan Stokes60f82202022-10-07 16:40:07 +0100562 if system_properties::read_bool(property_name, false)? {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900563 break;
564 }
565 }
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900566 Ok(())
567}
568
Alan Stokes1f417c92022-09-29 15:13:28 +0100569fn load_config(payload_metadata: PayloadMetadata) -> Result<VmPayloadConfig> {
570 match payload_metadata {
Ludovic Barman93ee3082023-06-20 12:18:43 +0000571 PayloadMetadata::ConfigPath(path) => {
Alan Stokes1f417c92022-09-29 15:13:28 +0100572 let path = Path::new(&path);
573 info!("loading config from {:?}...", path);
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100574 let file = ioutil::wait_for_file(path, WAIT_TIMEOUT)
575 .with_context(|| format!("Failed to read {:?}", path))?;
Alan Stokes1f417c92022-09-29 15:13:28 +0100576 Ok(serde_json::from_reader(file)?)
577 }
Ludovic Barman93ee3082023-06-20 12:18:43 +0000578 PayloadMetadata::Config(payload_config) => {
Alan Stokes1f417c92022-09-29 15:13:28 +0100579 let task = Task {
580 type_: TaskType::MicrodroidLauncher,
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000581 command: payload_config.payload_binary_name,
Alan Stokes1f417c92022-09-29 15:13:28 +0100582 };
583 Ok(VmPayloadConfig {
584 os: OsConfig { name: "microdroid".to_owned() },
585 task: Some(task),
586 apexes: vec![],
587 extra_apks: vec![],
588 prefer_staged: false,
Inseob Kimab1037d2023-02-08 17:03:31 +0900589 export_tombstones: None,
Alan Stokes1f417c92022-09-29 15:13:28 +0100590 enable_authfs: false,
591 })
592 }
Ludovic Barman93ee3082023-06-20 12:18:43 +0000593 _ => bail!("Failed to match config against a config type."),
Alan Stokes1f417c92022-09-29 15:13:28 +0100594 }
Jooyung Han634e2d72021-06-10 16:27:38 +0900595}
596
Jaewan Kim3124ef02023-03-23 19:25:20 +0900597/// Loads the crashkernel into memory using kexec if debuggable or debug policy says so.
598/// The VM should be loaded with `crashkernel=' parameter in the cmdline to allocate memory
599/// for crashkernel.
Jiyong Park202856e2022-08-22 16:04:26 +0900600fn load_crashkernel_if_supported() -> Result<()> {
601 let supported = std::fs::read_to_string("/proc/cmdline")?.contains(" crashkernel=");
602 info!("ramdump supported: {}", supported);
Jaewan Kim3124ef02023-03-23 19:25:20 +0900603
604 if !supported {
605 return Ok(());
606 }
607
Alan Stokes1125e012023-10-13 12:31:10 +0100608 let debuggable = is_debuggable()?;
Jaewan Kim3124ef02023-03-23 19:25:20 +0900609 let ramdump = get_debug_policy_bool(AVF_DEBUG_POLICY_RAMDUMP)?.unwrap_or_default();
610 let requested = debuggable | ramdump;
611
612 if requested {
Jiyong Park202856e2022-08-22 16:04:26 +0900613 let status = Command::new("/system/bin/kexec_load").status()?;
614 if !status.success() {
615 return Err(anyhow!("Failed to load crashkernel: {:?}", status));
616 }
Jaewan Kim3124ef02023-03-23 19:25:20 +0900617 info!("ramdump is loaded: debuggable={debuggable}, ramdump={ramdump}");
Jiyong Park202856e2022-08-22 16:04:26 +0900618 }
619 Ok(())
620}
621
Inseob Kim090b70b2022-11-16 20:01:14 +0900622/// Executes the given task.
Jooyung Han5c6d4172021-12-06 14:17:52 +0900623fn exec_task(task: &Task, service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900624 info!("executing main task {:?}...", task);
David Brazdil451cc962022-10-14 14:08:12 +0100625 let mut command = match task.type_ {
Alan Stokes1294f942023-08-21 14:34:12 +0100626 TaskType::Executable => {
Alan Stokes679ddf32023-09-01 11:14:48 +0100627 // TODO(b/297501338): Figure out how to handle non-root for system payloads.
Alan Stokes1294f942023-08-21 14:34:12 +0100628 Command::new(&task.command)
629 }
David Brazdil451cc962022-10-14 14:08:12 +0100630 TaskType::MicrodroidLauncher => {
631 let mut command = Command::new("/system/bin/microdroid_launcher");
632 command.arg(find_library_path(&task.command)?);
Alan Stokes1294f942023-08-21 14:34:12 +0100633 command.uid(microdroid_uids::MICRODROID_PAYLOAD_UID);
634 command.gid(microdroid_uids::MICRODROID_PAYLOAD_GID);
David Brazdil451cc962022-10-14 14:08:12 +0100635 command
636 }
637 };
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000638
Andrew Walbranaac68302023-07-21 19:05:34 +0100639 // SAFETY: We are not accessing any resource of the parent process. This means we can't make any
640 // log calls inside the closure.
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000641 unsafe {
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000642 command.pre_exec(|| {
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000643 // It is OK to continue with payload execution even if the calls below fail, since
644 // whether process can use a capability is controlled by the SELinux. Dropping the
645 // capabilities here is just another defense-in-depth layer.
Andrew Walbranaac68302023-07-21 19:05:34 +0100646 let _ = cap::drop_inheritable_caps();
647 let _ = cap::drop_bounding_set();
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000648 Ok(())
649 });
650 }
651
Inseob Kim090b70b2022-11-16 20:01:14 +0900652 command.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
Inseob Kim7f61fe72021-08-20 20:50:47 +0900653
654 info!("notifying payload started");
Inseob Kimc7d28c72021-10-25 14:28:10 +0000655 service.notifyPayloadStarted()?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900656
Inseob Kim86ca0162021-10-20 02:21:02 +0000657 let exit_status = command.spawn()?.wait()?;
Frederick Mayleb5f7b6b2022-11-11 15:24:03 -0800658 match exit_status.code() {
659 Some(exit_code) => Ok(exit_code),
660 None => Err(match exit_status.signal() {
661 Some(signal) => anyhow!(
662 "Payload exited due to signal: {} ({})",
663 signal,
664 Signal::try_from(signal).map_or("unknown", |s| s.as_str())
665 ),
666 None => anyhow!("Payload has neither exit code nor signal"),
667 }),
668 }
Jooyung Han347d9f22021-05-28 00:05:14 +0900669}
Jooyung Han634e2d72021-06-10 16:27:38 +0900670
Jooyung Han634e2d72021-06-10 16:27:38 +0900671fn find_library_path(name: &str) -> Result<String> {
672 let mut watcher = PropertyWatcher::new("ro.product.cpu.abilist")?;
673 let value = watcher.read(|_name, value| Ok(value.trim().to_string()))?;
674 let abi = value.split(',').next().ok_or_else(|| anyhow!("no abilist"))?;
Alice Wang6bbb6da2022-10-26 12:44:06 +0000675 let path = format!("{}/lib/{}/{}", VM_APK_CONTENTS_PATH, abi, name);
Jooyung Han634e2d72021-06-10 16:27:38 +0900676
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100677 let metadata = fs::metadata(&path).with_context(|| format!("Unable to access {}", path))?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900678 if !metadata.is_file() {
679 bail!("{} is not a file", &path);
680 }
681
682 Ok(path)
683}
Jiyong Park21ce2c52021-08-28 02:32:17 +0900684
Shikha Panwar95084df2023-07-22 11:47:45 +0000685fn prepare_encryptedstore(vm_secret: &VmSecret) -> Result<Child> {
Alice Wang7e6c9352023-02-15 15:44:13 +0000686 let mut key = ZVec::new(ENCRYPTEDSTORE_KEYSIZE)?;
Shikha Panwar3d3a70a2023-08-21 20:02:08 +0000687 vm_secret.derive_encryptedstore_key(&mut key)?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000688 let mut cmd = Command::new(ENCRYPTEDSTORE_BIN);
689 cmd.arg("--blkdevice")
690 .arg(ENCRYPTEDSTORE_BACKING_DEVICE)
691 .arg("--key")
692 .arg(hex::encode(&*key))
Shikha Panwar9fd198f2022-11-18 17:43:43 +0000693 .args(["--mountpoint", ENCRYPTEDSTORE_MOUNTPOINT])
Shikha Panwar566c9672022-11-15 14:39:58 +0000694 .spawn()
695 .context("encryptedstore failed")
696}