blob: e8017e864d68be3779cd50fb7c3cf8b394645996 [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};
Shikha Panwar9b4b3332024-02-24 17:09:47 +000045use microdroid_metadata::{Metadata, PayloadMetadata};
Alan Stokesfda70842023-12-20 17:50:14 +000046use microdroid_payload_config::{ApkConfig, OsConfig, Task, TaskType, VmPayloadConfig};
Frederick Mayleb5f7b6b2022-11-11 15:24:03 -080047use nix::sys::signal::Signal;
Alan Stokes03754962023-11-06 15:36:09 +000048use payload::load_metadata;
David Brazdila2125dd2022-12-14 16:37:44 +000049use rpcbinder::RpcSession;
Inseob Kim090b70b2022-11-16 20:01:14 +090050use rustutils::sockets::android_get_control_socket;
Jiyong Parkbb4a9872021-09-06 15:59:21 +090051use rustutils::system_properties;
Joel Galenson482704c2021-07-29 15:53:53 -070052use rustutils::system_properties::PropertyWatcher;
Shikha Panwar0503cb02024-01-05 10:11:28 +000053use secretkeeper_comm::data_types::ID_SIZE;
Alan Stokes3ba10fd2022-10-06 15:46:51 +010054use std::borrow::Cow::{Borrowed, Owned};
Inseob Kim7ff121c2022-11-14 18:13:23 +090055use std::env;
Shikha Panwardef7ef92023-01-06 08:35:48 +000056use std::ffi::CString;
Alan Stokes1125e012023-10-13 12:31:10 +010057use std::fs::{self, create_dir, File, OpenOptions};
Jaewan Kim3124ef02023-03-23 19:25:20 +090058use std::io::{Read, Write};
Alan Stokes1125e012023-10-13 12:31:10 +010059use std::os::unix::io::{FromRawFd, OwnedFd};
Nikita Ioffe3452ee22022-12-15 00:31:56 +000060use std::os::unix::process::CommandExt;
Frederick Mayleb5f7b6b2022-11-11 15:24:03 -080061use std::os::unix::process::ExitStatusExt;
Jooyung Hanf48ceb42021-06-01 18:00:04 +090062use std::path::Path;
Inseob Kim217038e2021-11-25 11:15:06 +090063use std::process::{Child, Command, Stdio};
Jiyong Park8611a6c2021-07-09 18:17:44 +090064use std::str;
Alan Stokes1125e012023-10-13 12:31:10 +010065use std::time::Duration;
Shikha Panwar95084df2023-07-22 11:47:45 +000066use vm_secret::VmSecret;
Jooyung Han634e2d72021-06-10 16:27:38 +090067
68const WAIT_TIMEOUT: Duration = Duration::from_secs(10);
Jaewan Kim1f0135b2024-01-31 14:59:47 +090069const AVF_STRICT_BOOT: &str = "/proc/device-tree/chosen/avf,strict-boot";
70const AVF_NEW_INSTANCE: &str = "/proc/device-tree/chosen/avf,new-instance";
71const AVF_DEBUG_POLICY_RAMDUMP: &str = "/proc/device-tree/avf/guest/common/ramdump";
Inseob Kime379e7d2022-07-22 18:55:18 +090072const DEBUG_MICRODROID_NO_VERIFIED_BOOT: &str =
Jaewan Kim1f0135b2024-01-31 14:59:47 +090073 "/proc/device-tree/virtualization/guest/debug-microdroid,no-verified-boot";
Shikha Panwar14abe442024-02-23 15:04:27 +000074const SECRETKEEPER_KEY: &str = "/proc/device-tree/avf/secretkeeper_public_key";
75const INSTANCE_ID_PATH: &str = "/proc/device-tree/avf/untrusted/instance-id";
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
Shikha Panwar14abe442024-02-23 15:04:27 +0000148/// The (host allocated) instance_id can be found at node /avf/untrusted/ in the device tree.
149fn get_instance_id() -> Result<Option<[u8; ID_SIZE]>> {
150 let path = Path::new(INSTANCE_ID_PATH);
151 let instance_id = if path.exists() {
152 Some(
153 fs::read(path)?
154 .try_into()
155 .map_err(|x: Vec<_>| anyhow!("Expected {ID_SIZE} bytes, found {:?}", x.len()))?,
156 )
157 } else {
158 // TODO(b/325094712): x86 support for Device tree in nested guest is limited/broken/
159 // untested. So instance_id will not be present in cuttlefish.
160 None
161 };
162 Ok(instance_id)
163}
164
Inseob Kim437f1052022-06-21 11:30:22 +0900165fn main() -> Result<()> {
Inseob Kim7ff121c2022-11-14 18:13:23 +0900166 // If debuggable, print full backtrace to console log with stdio_to_kmsg
Alan Stokes1125e012023-10-13 12:31:10 +0100167 if is_debuggable()? {
Inseob Kim7ff121c2022-11-14 18:13:23 +0900168 env::set_var("RUST_BACKTRACE", "full");
169 }
170
Inseob Kim437f1052022-06-21 11:30:22 +0900171 scopeguard::defer! {
172 info!("Shutting down...");
Jooyung Hanbfe086f2021-10-28 10:15:45 +0900173 if let Err(e) = system_properties::write("sys.powerctl", "shutdown") {
174 error!("failed to shutdown {:?}", e);
175 }
Jooyung Han311b1202021-09-14 22:00:16 +0900176 }
Inseob Kim437f1052022-06-21 11:30:22 +0900177
178 try_main().map_err(|e| {
179 error!("Failed with {:?}.", e);
180 if let Err(e) = write_death_reason_to_serial(&e) {
181 error!("Failed to write death reason {:?}", e);
182 }
183 e
184 })
Jooyung Han311b1202021-09-14 22:00:16 +0900185}
186
187fn try_main() -> Result<()> {
Jiyong Park2b6346d2023-06-19 13:37:42 +0900188 android_logger::init_once(
189 android_logger::Config::default()
190 .with_tag("microdroid_manager")
Jeff Vander Stoep57da1572024-01-31 10:52:16 +0100191 .with_max_level(log::LevelFilter::Info),
Jiyong Park2b6346d2023-06-19 13:37:42 +0900192 );
Jooyung Han347d9f22021-05-28 00:05:14 +0900193 info!("started.");
194
Alice Wangfd222fd2023-05-25 09:37:38 +0000195 // SAFETY: This is the only place we take the ownership of the fd of the vm payload service.
196 //
Alice Wang2a5306e2023-06-05 09:18:32 +0000197 // To ensure that the CLOEXEC flag is set on the file descriptor as early as possible,
198 // it is necessary to fetch the socket corresponding to vm_payload_service at the
199 // very beginning, as android_get_control_socket() sets the CLOEXEC flag on the file
200 // descriptor.
Alice Wangfd222fd2023-05-25 09:37:38 +0000201 let vm_payload_service_fd = unsafe { prepare_vm_payload_service_socket()? };
Inseob Kim090b70b2022-11-16 20:01:14 +0900202
Jiyong Park202856e2022-08-22 16:04:26 +0900203 load_crashkernel_if_supported().context("Failed to load crashkernel")?;
204
Alice Wangeff58392023-07-04 13:32:09 +0000205 swap::init_swap().context("Failed to initialize swap")?;
Keir Fraser933f0ac2022-10-12 08:23:28 +0000206 info!("swap enabled.");
207
Inseob Kim11f40d02022-06-13 17:16:00 +0900208 let service = get_vms_rpc_binder()
209 .context("cannot connect to VirtualMachineService")
210 .map_err(|e| MicrodroidError::FailedToConnectToVirtualizationService(e.to_string()))?;
Seungjae Yoofd9a0622022-10-14 10:01:29 +0900211
Alice Wangfd222fd2023-05-25 09:37:38 +0000212 match try_run_payload(&service, vm_payload_service_fd) {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900213 Ok(code) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900214 if code == 0 {
215 info!("task successfully finished");
216 } else {
217 error!("task exited with exit code: {}", code);
218 }
Shikha Panwardef7ef92023-01-06 08:35:48 +0000219 if let Err(e) = post_payload_work() {
220 error!(
221 "Failed to run post payload work. It is possible that certain tasks
222 like syncing encrypted store might be incomplete. Error: {:?}",
223 e
224 );
225 };
226
227 info!("notifying payload finished");
228 service.notifyPayloadFinished(code)?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900229 Ok(())
230 }
231 Err(err) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900232 let (error_code, message) = translate_error(&err);
233 service.notifyError(error_code, &message)?;
234 Err(err)
235 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900236 }
237}
238
Shikha Panwar9b4b3332024-02-24 17:09:47 +0000239fn verify_payload_with_instance_img(
240 metadata: &Metadata,
241 dice: &DiceDriver,
242) -> Result<MicrodroidData> {
Jooyung Han311b1202021-09-14 22:00:16 +0900243 let mut instance = InstanceDisk::new().context("Failed to load instance.img")?;
Shikha Panwar9b4b3332024-02-24 17:09:47 +0000244 let saved_data = instance.read_microdroid_data(dice).context("Failed to read identity data")?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900245
Andrew Scullab72ec52022-03-14 09:10:52 +0000246 if is_strict_boot() {
247 // Provisioning must happen on the first boot and never again.
248 if is_new_instance() {
249 ensure!(
250 saved_data.is_none(),
Alan Stokesbbed8872023-10-19 13:17:12 +0100251 MicrodroidError::PayloadInvalidConfig(
252 "Found instance data on first boot.".to_string()
253 )
Andrew Scullab72ec52022-03-14 09:10:52 +0000254 );
255 } else {
256 ensure!(
257 saved_data.is_some(),
Alan Stokesbbed8872023-10-19 13:17:12 +0100258 MicrodroidError::PayloadInvalidConfig("Instance data not found.".to_string())
Andrew Scullab72ec52022-03-14 09:10:52 +0000259 );
260 };
261 }
262
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900263 // Verify the payload before using it.
Shikha Panwar9b4b3332024-02-24 17:09:47 +0000264 let extracted_data = verify_payload(metadata, saved_data.as_ref())
Inseob Kim11f40d02022-06-13 17:16:00 +0900265 .context("Payload verification failed")
266 .map_err(|e| MicrodroidError::PayloadVerificationFailed(e.to_string()))?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900267
268 // In case identity is ignored (by debug policy), we should reuse existing payload data, even
269 // when the payload is changed. This is to keep the derived secret same as before.
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000270 let instance_data = if let Some(saved_data) = saved_data {
Inseob Kime379e7d2022-07-22 18:55:18 +0900271 if !is_verified_boot() {
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000272 if saved_data != extracted_data {
Inseob Kime379e7d2022-07-22 18:55:18 +0900273 info!("Detected an update of the payload, but continue (regarding debug policy)")
274 }
275 } else {
276 ensure!(
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000277 saved_data == extracted_data,
Inseob Kime379e7d2022-07-22 18:55:18 +0900278 MicrodroidError::PayloadChanged(String::from(
279 "Detected an update of the payload which isn't supported yet."
280 ))
281 );
282 info!("Saved data is verified.");
283 }
284 saved_data
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900285 } else {
Jooyung Han7a343f92021-09-08 22:53:11 +0900286 info!("Saving verified data.");
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000287 instance
Shikha Panwar9b4b3332024-02-24 17:09:47 +0000288 .write_microdroid_data(&extracted_data, dice)
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000289 .context("Failed to write identity data")?;
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000290 extracted_data
Inseob Kime379e7d2022-07-22 18:55:18 +0900291 };
Shikha Panwar9b4b3332024-02-24 17:09:47 +0000292 Ok(instance_data)
293}
294
295fn try_run_payload(
296 service: &Strong<dyn IVirtualMachineService>,
297 vm_payload_service_fd: OwnedFd,
298) -> Result<i32> {
299 let metadata = load_metadata().context("Failed to load payload metadata")?;
300 let dice = DiceDriver::new(Path::new("/dev/open-dice0")).context("Failed to load DICE")?;
301
302 // TODO(b/291306122): Checking with host about Secretkeeper support multiple times introduces
303 // a whole range of security vulnerability since host can give different answers. Guest should
304 // check only once and the same answer should be known to pVM Firmware and Microdroid.
305 let instance_data = if let Some(_sk) = vm_secret::is_sk_supported(service)? {
306 verify_payload(&metadata, None)?
307 } else {
308 verify_payload_with_instance_img(&metadata, &dice)?
309 };
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900310
Alan Stokes1f417c92022-09-29 15:13:28 +0100311 let payload_metadata = metadata.payload.ok_or_else(|| {
Alan Stokesbbed8872023-10-19 13:17:12 +0100312 MicrodroidError::PayloadInvalidConfig("No payload config in metadata".to_string())
Alan Stokes1f417c92022-09-29 15:13:28 +0100313 })?;
Alan Stokes0d1ef782022-09-27 13:46:35 +0100314
Inseob Kimb2519c52022-04-14 02:10:09 +0900315 // To minimize the exposure to untrusted data, derive dice profile as soon as possible.
316 info!("DICE derivation for payload");
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000317 let dice_artifacts = dice_derivation(dice, &instance_data, &payload_metadata)?;
Shikha Panwar5d6a6752023-12-14 22:08:26 +0000318 let vm_secret =
Shikha Panwar14abe442024-02-23 15:04:27 +0000319 VmSecret::new(dice_artifacts, service).context("Failed to create VM secrets")?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000320
Alan Stokes9a7f67e2023-11-07 09:37:40 +0000321 if cfg!(dice_changes) {
322 // Now that the DICE derivation is done, it's ok to allow payload code to run.
323
324 // Start apexd to activate APEXes. This may allow code within them to run.
325 system_properties::write("ctl.start", "apexd-vm")?;
326 }
327
Shikha Panwar566c9672022-11-15 14:39:58 +0000328 // Run encryptedstore binary to prepare the storage
329 let encryptedstore_child = if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
330 info!("Preparing encryptedstore ...");
Shikha Panwar95084df2023-07-22 11:47:45 +0000331 Some(prepare_encryptedstore(&vm_secret).context("encryptedstore run")?)
Shikha Panwar566c9672022-11-15 14:39:58 +0000332 } else {
333 None
334 };
Inseob Kimb2519c52022-04-14 02:10:09 +0900335
Alan Stokes960c9032022-12-07 16:53:45 +0000336 let mut zipfuse = Zipfuse::default();
337
Jooyung Hana6d11eb2021-09-10 11:48:05 +0900338 // Before reading a file from the APK, start zipfuse
Alan Stokes960c9032022-12-07 16:53:45 +0000339 zipfuse.mount(
Alan Stokes60f82202022-10-07 16:40:07 +0100340 MountForExec::Allowed,
Inseob Kim217038e2021-11-25 11:15:06 +0900341 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:system_file:s0",
Alan Stokes1125e012023-10-13 12:31:10 +0100342 Path::new(verify::DM_MOUNTED_APK_PATH),
Alice Wang6bbb6da2022-10-26 12:44:06 +0000343 Path::new(VM_APK_CONTENTS_PATH),
Alan Stokes960c9032022-12-07 16:53:45 +0000344 "microdroid_manager.apk.mounted".to_owned(),
345 )?;
Jiyong Park21ce2c52021-08-28 02:32:17 +0900346
Andrew Scull4d262dc2022-10-21 13:14:33 +0000347 // Restricted APIs are only allowed to be used by platform or test components. Infer this from
348 // the use of a VM config file since those can only be used by platform and test components.
349 let allow_restricted_apis = match payload_metadata {
Ludovic Barman93ee3082023-06-20 12:18:43 +0000350 PayloadMetadata::ConfigPath(_) => true,
351 PayloadMetadata::Config(_) => false,
352 _ => false, // default is false for safety
Andrew Scull4d262dc2022-10-21 13:14:33 +0000353 };
354
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100355 let config = load_config(payload_metadata).context("Failed to load payload metadata")?;
Shikha Panwar6f03c942022-04-13 20:26:50 +0000356
Alan Stokes01b3ef02022-09-22 17:43:24 +0100357 let task = config
358 .task
359 .as_ref()
Alan Stokesbbed8872023-10-19 13:17:12 +0100360 .ok_or_else(|| MicrodroidError::PayloadInvalidConfig("No task in VM config".to_string()))?;
Alan Stokes01b3ef02022-09-22 17:43:24 +0100361
Alice Wang061478b2023-04-11 13:26:17 +0000362 ensure!(
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000363 config.extra_apks.len() == instance_data.extra_apks_data.len(),
Alice Wang061478b2023-04-11 13:26:17 +0000364 "config expects {} extra apks, but found {}",
365 config.extra_apks.len(),
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000366 instance_data.extra_apks_data.len()
Alice Wang061478b2023-04-11 13:26:17 +0000367 );
Alan Stokes960c9032022-12-07 16:53:45 +0000368 mount_extra_apks(&config, &mut zipfuse)?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900369
Alan Stokes26efd192023-11-06 16:30:15 +0000370 register_vm_payload_service(
371 allow_restricted_apis,
372 service.clone(),
373 vm_secret,
374 vm_payload_service_fd,
375 )?;
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000376
Shikha Panwar1a6efcd2023-02-03 19:23:43 +0000377 // Set export_tombstones if enabled
Inseob Kimab1037d2023-02-08 17:03:31 +0900378 if should_export_tombstones(&config) {
Shikha Panwar1a6efcd2023-02-03 19:23:43 +0000379 // This property is read by tombstone_handler.
380 system_properties::write("microdroid_manager.export_tombstones.enabled", "1")
381 .context("set microdroid_manager.export_tombstones.enabled")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900382 }
383
Alan Stokes26efd192023-11-06 16:30:15 +0000384 // Wait until apex config is done. (e.g. linker configuration for apexes)
385 wait_for_property_true(APEX_CONFIG_DONE_PROP).context("Failed waiting for apex config done")?;
386
387 // Trigger init post-fs-data. This will start authfs if we wask it to.
388 if config.enable_authfs {
389 system_properties::write("microdroid_manager.authfs.enabled", "1")
390 .context("failed to write microdroid_manager.authfs.enabled")?;
391 }
392 system_properties::write("microdroid_manager.config_done", "1")
393 .context("failed to write microdroid_manager.config_done")?;
394
Alan Stokes960c9032022-12-07 16:53:45 +0000395 // Wait until zipfuse has mounted the APKs so we can access the payload
396 zipfuse.wait_until_done()?;
Alan Stokes60f82202022-10-07 16:40:07 +0100397
Shikha Panwarddc124b2022-11-28 19:17:54 +0000398 // Wait for encryptedstore to finish mounting the storage (if enabled) before setting
399 // microdroid_manager.init_done. Reason is init stops uneventd after that.
400 // Encryptedstore, however requires ueventd
Shikha Panwar566c9672022-11-15 14:39:58 +0000401 if let Some(mut child) = encryptedstore_child {
402 let exitcode = child.wait().context("Wait for encryptedstore child")?;
403 ensure!(exitcode.success(), "Unable to prepare encrypted storage. Exitcode={}", exitcode);
404 }
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100405
Alan Stokes26efd192023-11-06 16:30:15 +0000406 // Wait for init to have finished booting.
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000407 wait_for_property_true("dev.bootcomplete").context("failed waiting for dev.bootcomplete")?;
Alan Stokes26efd192023-11-06 16:30:15 +0000408
409 // And then tell it we're done so unnecessary services can be shut down.
Shikha Panwar3f6f6a52022-11-29 17:28:36 +0000410 system_properties::write("microdroid_manager.init_done", "1")
411 .context("set microdroid_manager.init_done")?;
Inseob Kimc16b0cc2023-01-26 14:57:24 +0900412
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000413 info!("boot completed, time to run payload");
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100414 exec_task(task, service).context("Failed to run payload")
Alan Stokes01b3ef02022-09-22 17:43:24 +0100415}
416
Alan Stokes03754962023-11-06 15:36:09 +0000417fn post_payload_work() -> Result<()> {
418 // Sync the encrypted storage filesystem (flushes the filesystem caches).
419 if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
420 let mountpoint = CString::new(ENCRYPTEDSTORE_MOUNTPOINT).unwrap();
421
422 // SAFETY: `mountpoint` is a valid C string. `syncfs` and `close` are safe for any parameter
423 // values.
424 let ret = unsafe {
425 let dirfd = libc::open(
426 mountpoint.as_ptr(),
427 libc::O_DIRECTORY | libc::O_RDONLY | libc::O_CLOEXEC,
428 );
429 ensure!(dirfd >= 0, "Unable to open {:?}", mountpoint);
430 let ret = libc::syncfs(dirfd);
431 libc::close(dirfd);
432 ret
433 };
434 if ret != 0 {
435 error!("failed to sync encrypted storage.");
436 return Err(anyhow!(std::io::Error::last_os_error()));
437 }
438 }
439 Ok(())
440}
441
Alan Stokes03754962023-11-06 15:36:09 +0000442fn mount_extra_apks(config: &VmPayloadConfig, zipfuse: &mut Zipfuse) -> Result<()> {
443 // For now, only the number of apks is important, as the mount point and dm-verity name is fixed
444 for i in 0..config.extra_apks.len() {
445 let mount_dir = format!("/mnt/extra-apk/{i}");
446 create_dir(Path::new(&mount_dir)).context("Failed to create mount dir for extra apks")?;
447
448 let mount_for_exec =
449 if cfg!(multi_tenant) { MountForExec::Allowed } else { MountForExec::Disallowed };
450 // These run asynchronously in parallel - we wait later for them to complete.
451 zipfuse.mount(
452 mount_for_exec,
453 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:extra_apk_file:s0",
454 Path::new(&format!("/dev/block/mapper/extra-apk-{i}")),
455 Path::new(&mount_dir),
456 format!("microdroid_manager.extra_apk.mounted.{i}"),
457 )?;
458 }
459
460 Ok(())
461}
462
463fn get_vms_rpc_binder() -> Result<Strong<dyn IVirtualMachineService>> {
464 // The host is running a VirtualMachineService for this VM on a port equal
465 // to the CID of this VM.
466 let port = vsock::get_local_cid().context("Could not determine local CID")?;
467 RpcSession::new()
468 .setup_vsock_client(VMADDR_CID_HOST, port)
469 .context("Could not connect to IVirtualMachineService")
470}
471
472/// Prepares a socket file descriptor for the vm payload service.
473///
474/// # Safety
475///
476/// The caller must ensure that this function is the only place that claims ownership
477/// of the file descriptor and it is called only once.
478unsafe fn prepare_vm_payload_service_socket() -> Result<OwnedFd> {
479 let raw_fd = android_get_control_socket(VM_PAYLOAD_SERVICE_SOCKET_NAME)?;
480
481 // Creating OwnedFd for stdio FDs is not safe.
482 if [libc::STDIN_FILENO, libc::STDOUT_FILENO, libc::STDERR_FILENO].contains(&raw_fd) {
483 bail!("File descriptor {raw_fd} is standard I/O descriptor");
484 }
485 // SAFETY: Initializing OwnedFd for a RawFd created by the init.
486 // We checked that the integer value corresponds to a valid FD and that the caller
487 // ensures that this is the only place to claim its ownership.
488 Ok(unsafe { OwnedFd::from_raw_fd(raw_fd) })
489}
490
491fn is_strict_boot() -> bool {
492 Path::new(AVF_STRICT_BOOT).exists()
493}
494
495fn is_new_instance() -> bool {
496 Path::new(AVF_NEW_INSTANCE).exists()
497}
498
499fn is_verified_boot() -> bool {
500 !Path::new(DEBUG_MICRODROID_NO_VERIFIED_BOOT).exists()
501}
502
503fn is_debuggable() -> Result<bool> {
504 Ok(system_properties::read_bool(DEBUGGABLE_PROP, true)?)
505}
506
507fn should_export_tombstones(config: &VmPayloadConfig) -> bool {
508 match config.export_tombstones {
509 Some(b) => b,
510 None => is_debuggable().unwrap_or(false),
511 }
512}
513
514/// Get debug policy value in bool. It's true iff the value is explicitly set to <1>.
515fn get_debug_policy_bool(path: &'static str) -> Result<Option<bool>> {
516 let mut file = match File::open(path) {
517 Ok(dp) => dp,
518 Err(e) => {
519 info!(
520 "Assumes that debug policy is disabled because failed to read debug policy ({e:?})"
521 );
522 return Ok(Some(false));
523 }
524 };
525 let mut log: [u8; 4] = Default::default();
526 file.read_exact(&mut log).context("Malformed data in {path}")?;
527 // DT spec uses big endian although Android is always little endian.
528 Ok(Some(u32::from_be_bytes(log) == 1))
529}
530
Alan Stokes60f82202022-10-07 16:40:07 +0100531enum MountForExec {
532 Allowed,
533 Disallowed,
534}
535
Alan Stokes960c9032022-12-07 16:53:45 +0000536#[derive(Default)]
537struct Zipfuse {
538 ready_properties: Vec<String>,
539}
540
541impl Zipfuse {
542 fn mount(
543 &mut self,
544 noexec: MountForExec,
545 option: &str,
546 zip_path: &Path,
547 mount_dir: &Path,
548 ready_prop: String,
549 ) -> Result<Child> {
550 let mut cmd = Command::new(ZIPFUSE_BIN);
551 if let MountForExec::Disallowed = noexec {
552 cmd.arg("--noexec");
553 }
Alan Stokes1294f942023-08-21 14:34:12 +0100554 // Let root own the files in APK, so we can access them, but set the group to
555 // allow all payloads to have access too.
556 let (uid, gid) = (microdroid_uids::ROOT_UID, microdroid_uids::MICRODROID_PAYLOAD_GID);
557
Alan Stokes960c9032022-12-07 16:53:45 +0000558 cmd.args(["-p", &ready_prop, "-o", option]);
Alan Stokes1294f942023-08-21 14:34:12 +0100559 cmd.args(["-u", &uid.to_string()]);
560 cmd.args(["-g", &gid.to_string()]);
Alan Stokes960c9032022-12-07 16:53:45 +0000561 cmd.arg(zip_path).arg(mount_dir);
562 self.ready_properties.push(ready_prop);
563 cmd.spawn().with_context(|| format!("Failed to run zipfuse for {mount_dir:?}"))
Andrew Scullcc339a12022-07-04 12:44:19 +0000564 }
Alan Stokes960c9032022-12-07 16:53:45 +0000565
566 fn wait_until_done(self) -> Result<()> {
567 // We check the last-started check first in the hope that by the time it is done
568 // all or most of the others will also be done, minimising the number of times we
569 // block on a property.
570 for property in self.ready_properties.into_iter().rev() {
571 wait_for_property_true(&property)
572 .with_context(|| format!("Failed waiting for {property}"))?;
573 }
574 Ok(())
Alan Stokes60f82202022-10-07 16:40:07 +0100575 }
Inseob Kim217038e2021-11-25 11:15:06 +0900576}
577
Alan Stokes60f82202022-10-07 16:40:07 +0100578fn wait_for_property_true(property_name: &str) -> Result<()> {
579 let mut prop = PropertyWatcher::new(property_name)?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900580 loop {
Andrew Walbrand9c766e2023-05-10 15:15:39 +0000581 prop.wait(None)?;
Alan Stokes60f82202022-10-07 16:40:07 +0100582 if system_properties::read_bool(property_name, false)? {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900583 break;
584 }
585 }
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900586 Ok(())
587}
588
Alan Stokes1f417c92022-09-29 15:13:28 +0100589fn load_config(payload_metadata: PayloadMetadata) -> Result<VmPayloadConfig> {
590 match payload_metadata {
Ludovic Barman93ee3082023-06-20 12:18:43 +0000591 PayloadMetadata::ConfigPath(path) => {
Alan Stokes1f417c92022-09-29 15:13:28 +0100592 let path = Path::new(&path);
593 info!("loading config from {:?}...", path);
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100594 let file = ioutil::wait_for_file(path, WAIT_TIMEOUT)
595 .with_context(|| format!("Failed to read {:?}", path))?;
Alan Stokes1f417c92022-09-29 15:13:28 +0100596 Ok(serde_json::from_reader(file)?)
597 }
Ludovic Barman93ee3082023-06-20 12:18:43 +0000598 PayloadMetadata::Config(payload_config) => {
Alan Stokes1f417c92022-09-29 15:13:28 +0100599 let task = Task {
600 type_: TaskType::MicrodroidLauncher,
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000601 command: payload_config.payload_binary_name,
Alan Stokes1f417c92022-09-29 15:13:28 +0100602 };
Alan Stokesfda70842023-12-20 17:50:14 +0000603 // We don't care about the paths, only the number of extra APKs really matters.
604 let extra_apks = (0..payload_config.extra_apk_count)
605 .map(|i| ApkConfig { path: format!("extra-apk-{i}") })
606 .collect();
Alan Stokes1f417c92022-09-29 15:13:28 +0100607 Ok(VmPayloadConfig {
608 os: OsConfig { name: "microdroid".to_owned() },
609 task: Some(task),
610 apexes: vec![],
Alan Stokesfda70842023-12-20 17:50:14 +0000611 extra_apks,
Alan Stokes1f417c92022-09-29 15:13:28 +0100612 prefer_staged: false,
Inseob Kimab1037d2023-02-08 17:03:31 +0900613 export_tombstones: None,
Alan Stokes1f417c92022-09-29 15:13:28 +0100614 enable_authfs: false,
615 })
616 }
Ludovic Barman93ee3082023-06-20 12:18:43 +0000617 _ => bail!("Failed to match config against a config type."),
Alan Stokes1f417c92022-09-29 15:13:28 +0100618 }
Jooyung Han634e2d72021-06-10 16:27:38 +0900619}
620
Jaewan Kim3124ef02023-03-23 19:25:20 +0900621/// Loads the crashkernel into memory using kexec if debuggable or debug policy says so.
622/// The VM should be loaded with `crashkernel=' parameter in the cmdline to allocate memory
623/// for crashkernel.
Jiyong Park202856e2022-08-22 16:04:26 +0900624fn load_crashkernel_if_supported() -> Result<()> {
625 let supported = std::fs::read_to_string("/proc/cmdline")?.contains(" crashkernel=");
626 info!("ramdump supported: {}", supported);
Jaewan Kim3124ef02023-03-23 19:25:20 +0900627
628 if !supported {
629 return Ok(());
630 }
631
Alan Stokes1125e012023-10-13 12:31:10 +0100632 let debuggable = is_debuggable()?;
Jaewan Kim3124ef02023-03-23 19:25:20 +0900633 let ramdump = get_debug_policy_bool(AVF_DEBUG_POLICY_RAMDUMP)?.unwrap_or_default();
634 let requested = debuggable | ramdump;
635
636 if requested {
Jiyong Park202856e2022-08-22 16:04:26 +0900637 let status = Command::new("/system/bin/kexec_load").status()?;
638 if !status.success() {
639 return Err(anyhow!("Failed to load crashkernel: {:?}", status));
640 }
Jaewan Kim3124ef02023-03-23 19:25:20 +0900641 info!("ramdump is loaded: debuggable={debuggable}, ramdump={ramdump}");
Jiyong Park202856e2022-08-22 16:04:26 +0900642 }
643 Ok(())
644}
645
Inseob Kim090b70b2022-11-16 20:01:14 +0900646/// Executes the given task.
Jooyung Han5c6d4172021-12-06 14:17:52 +0900647fn exec_task(task: &Task, service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900648 info!("executing main task {:?}...", task);
David Brazdil451cc962022-10-14 14:08:12 +0100649 let mut command = match task.type_ {
Alan Stokes1294f942023-08-21 14:34:12 +0100650 TaskType::Executable => {
Alan Stokes679ddf32023-09-01 11:14:48 +0100651 // TODO(b/297501338): Figure out how to handle non-root for system payloads.
Alan Stokes1294f942023-08-21 14:34:12 +0100652 Command::new(&task.command)
653 }
David Brazdil451cc962022-10-14 14:08:12 +0100654 TaskType::MicrodroidLauncher => {
655 let mut command = Command::new("/system/bin/microdroid_launcher");
656 command.arg(find_library_path(&task.command)?);
Alan Stokes1294f942023-08-21 14:34:12 +0100657 command.uid(microdroid_uids::MICRODROID_PAYLOAD_UID);
658 command.gid(microdroid_uids::MICRODROID_PAYLOAD_GID);
David Brazdil451cc962022-10-14 14:08:12 +0100659 command
660 }
661 };
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000662
Andrew Walbranaac68302023-07-21 19:05:34 +0100663 // SAFETY: We are not accessing any resource of the parent process. This means we can't make any
664 // log calls inside the closure.
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000665 unsafe {
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000666 command.pre_exec(|| {
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000667 // It is OK to continue with payload execution even if the calls below fail, since
668 // whether process can use a capability is controlled by the SELinux. Dropping the
669 // capabilities here is just another defense-in-depth layer.
Andrew Walbranaac68302023-07-21 19:05:34 +0100670 let _ = cap::drop_inheritable_caps();
671 let _ = cap::drop_bounding_set();
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000672 Ok(())
673 });
674 }
675
Inseob Kim090b70b2022-11-16 20:01:14 +0900676 command.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
Inseob Kim7f61fe72021-08-20 20:50:47 +0900677
678 info!("notifying payload started");
Inseob Kimc7d28c72021-10-25 14:28:10 +0000679 service.notifyPayloadStarted()?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900680
Inseob Kim86ca0162021-10-20 02:21:02 +0000681 let exit_status = command.spawn()?.wait()?;
Frederick Mayleb5f7b6b2022-11-11 15:24:03 -0800682 match exit_status.code() {
683 Some(exit_code) => Ok(exit_code),
684 None => Err(match exit_status.signal() {
685 Some(signal) => anyhow!(
686 "Payload exited due to signal: {} ({})",
687 signal,
688 Signal::try_from(signal).map_or("unknown", |s| s.as_str())
689 ),
690 None => anyhow!("Payload has neither exit code nor signal"),
691 }),
692 }
Jooyung Han347d9f22021-05-28 00:05:14 +0900693}
Jooyung Han634e2d72021-06-10 16:27:38 +0900694
Jooyung Han634e2d72021-06-10 16:27:38 +0900695fn find_library_path(name: &str) -> Result<String> {
696 let mut watcher = PropertyWatcher::new("ro.product.cpu.abilist")?;
697 let value = watcher.read(|_name, value| Ok(value.trim().to_string()))?;
698 let abi = value.split(',').next().ok_or_else(|| anyhow!("no abilist"))?;
Alice Wang6bbb6da2022-10-26 12:44:06 +0000699 let path = format!("{}/lib/{}/{}", VM_APK_CONTENTS_PATH, abi, name);
Jooyung Han634e2d72021-06-10 16:27:38 +0900700
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100701 let metadata = fs::metadata(&path).with_context(|| format!("Unable to access {}", path))?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900702 if !metadata.is_file() {
703 bail!("{} is not a file", &path);
704 }
705
706 Ok(path)
707}
Jiyong Park21ce2c52021-08-28 02:32:17 +0900708
Shikha Panwar95084df2023-07-22 11:47:45 +0000709fn prepare_encryptedstore(vm_secret: &VmSecret) -> Result<Child> {
Alice Wang7e6c9352023-02-15 15:44:13 +0000710 let mut key = ZVec::new(ENCRYPTEDSTORE_KEYSIZE)?;
Shikha Panwar3d3a70a2023-08-21 20:02:08 +0000711 vm_secret.derive_encryptedstore_key(&mut key)?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000712 let mut cmd = Command::new(ENCRYPTEDSTORE_BIN);
713 cmd.arg("--blkdevice")
714 .arg(ENCRYPTEDSTORE_BACKING_DEVICE)
715 .arg("--key")
716 .arg(hex::encode(&*key))
Shikha Panwar9fd198f2022-11-18 17:43:43 +0000717 .args(["--mountpoint", ENCRYPTEDSTORE_MOUNTPOINT])
Shikha Panwar566c9672022-11-15 14:39:58 +0000718 .spawn()
719 .context("encryptedstore failed")
720}