blob: 2386bd4835b51572d27c175b6986e69d87feba45 [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;
Jiyong Park21ce2c52021-08-28 02:32:17 +090018mod instance;
Jooyung Hanf48ceb42021-06-01 18:00:04 +090019mod ioutil;
Jooyung Han7a343f92021-09-08 22:53:11 +090020mod payload;
Keir Fraser933f0ac2022-10-12 08:23:28 +000021mod swap;
Alan Stokes1125e012023-10-13 12:31:10 +010022mod verify;
Alice Wang59a9e562022-10-04 15:24:10 +000023mod vm_payload_service;
Shikha Panwar95084df2023-07-22 11:47:45 +000024mod vm_secret;
Jooyung Han347d9f22021-05-28 00:05:14 +090025
Alan Stokes2bead0d2022-09-05 16:58:34 +010026use android_system_virtualizationcommon::aidl::android::system::virtualizationcommon::ErrorCode::ErrorCode;
David Brazdil73988ea2022-11-11 15:10:32 +000027use android_system_virtualmachineservice::aidl::android::system::virtualmachineservice::IVirtualMachineService::IVirtualMachineService;
Inseob Kim090b70b2022-11-16 20:01:14 +090028use android_system_virtualization_payload::aidl::android::system::virtualization::payload::IVmPayloadService::{
29 VM_APK_CONTENTS_PATH,
30 VM_PAYLOAD_SERVICE_SOCKET_NAME,
Shikha Panwarddc124b2022-11-28 19:17:54 +000031 ENCRYPTEDSTORE_MOUNTPOINT,
Inseob Kim090b70b2022-11-16 20:01:14 +090032};
Alan Stokes1125e012023-10-13 12:31:10 +010033
34use crate::dice::dice_derivation;
Alan Stokes03754962023-11-06 15:36:09 +000035use crate::instance::{InstanceDisk, MicrodroidData};
Alan Stokes1125e012023-10-13 12:31:10 +010036use crate::verify::verify_payload;
37use crate::vm_payload_service::register_vm_payload_service;
Jooyung Handd0a1732021-11-23 15:26:20 +090038use anyhow::{anyhow, bail, ensure, Context, Error, Result};
Alice Wang43c884b2022-10-24 09:42:40 +000039use binder::Strong;
Nikita Ioffee18cc132024-02-28 16:13:36 +000040use dice_driver::DiceDriver;
Alice Wang7e6c9352023-02-15 15:44:13 +000041use keystore2_crypto::ZVec;
Alan Stokes1125e012023-10-13 12:31:10 +010042use libc::VMADDR_CID_HOST;
43use log::{error, info};
Shikha Panwar185ba932024-03-12 22:35:09 +000044use microdroid_metadata::{Metadata, PayloadMetadata};
Alan Stokesfda70842023-12-20 17:50:14 +000045use microdroid_payload_config::{ApkConfig, OsConfig, Task, TaskType, VmPayloadConfig};
Frederick Mayleb5f7b6b2022-11-11 15:24:03 -080046use nix::sys::signal::Signal;
Alan Stokes03754962023-11-06 15:36:09 +000047use payload::load_metadata;
David Brazdila2125dd2022-12-14 16:37:44 +000048use rpcbinder::RpcSession;
Inseob Kim090b70b2022-11-16 20:01:14 +090049use rustutils::sockets::android_get_control_socket;
Jiyong Parkbb4a9872021-09-06 15:59:21 +090050use rustutils::system_properties;
Joel Galenson482704c2021-07-29 15:53:53 -070051use rustutils::system_properties::PropertyWatcher;
Shikha Panwar0503cb02024-01-05 10:11:28 +000052use secretkeeper_comm::data_types::ID_SIZE;
Alan Stokes3ba10fd2022-10-06 15:46:51 +010053use std::borrow::Cow::{Borrowed, Owned};
Inseob Kim7ff121c2022-11-14 18:13:23 +090054use std::env;
Shikha Panwardef7ef92023-01-06 08:35:48 +000055use std::ffi::CString;
Alan Stokes1125e012023-10-13 12:31:10 +010056use std::fs::{self, create_dir, File, OpenOptions};
Jaewan Kim3124ef02023-03-23 19:25:20 +090057use std::io::{Read, Write};
Alan Stokes1125e012023-10-13 12:31:10 +010058use std::os::unix::io::{FromRawFd, OwnedFd};
Nikita Ioffe3452ee22022-12-15 00:31:56 +000059use std::os::unix::process::CommandExt;
Frederick Mayleb5f7b6b2022-11-11 15:24:03 -080060use std::os::unix::process::ExitStatusExt;
Jooyung Hanf48ceb42021-06-01 18:00:04 +090061use std::path::Path;
Inseob Kim217038e2021-11-25 11:15:06 +090062use std::process::{Child, Command, Stdio};
Jiyong Park8611a6c2021-07-09 18:17:44 +090063use std::str;
Alan Stokes1125e012023-10-13 12:31:10 +010064use std::time::Duration;
Shikha Panwar95084df2023-07-22 11:47:45 +000065use vm_secret::VmSecret;
Jooyung Han634e2d72021-06-10 16:27:38 +090066
67const WAIT_TIMEOUT: Duration = Duration::from_secs(10);
Jaewan Kim1f0135b2024-01-31 14:59:47 +090068const AVF_STRICT_BOOT: &str = "/proc/device-tree/chosen/avf,strict-boot";
69const AVF_NEW_INSTANCE: &str = "/proc/device-tree/chosen/avf,new-instance";
70const AVF_DEBUG_POLICY_RAMDUMP: &str = "/proc/device-tree/avf/guest/common/ramdump";
Inseob Kime379e7d2022-07-22 18:55:18 +090071const DEBUG_MICRODROID_NO_VERIFIED_BOOT: &str =
Jaewan Kim1f0135b2024-01-31 14:59:47 +090072 "/proc/device-tree/virtualization/guest/debug-microdroid,no-verified-boot";
Shikha Panwar14abe442024-02-23 15:04:27 +000073const SECRETKEEPER_KEY: &str = "/proc/device-tree/avf/secretkeeper_public_key";
74const INSTANCE_ID_PATH: &str = "/proc/device-tree/avf/untrusted/instance-id";
Shikha Panware45e9422024-02-28 21:18:10 +000075const DEFER_ROLLBACK_PROTECTION: &str = "/proc/device-tree/avf/untrusted/defer-rollback-protection";
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
Shikha Panware45e9422024-02-28 21:18:10 +0000165fn should_defer_rollback_protection() -> bool {
166 Path::new(DEFER_ROLLBACK_PROTECTION).exists()
167}
168
Inseob Kim437f1052022-06-21 11:30:22 +0900169fn main() -> Result<()> {
Inseob Kim7ff121c2022-11-14 18:13:23 +0900170 // If debuggable, print full backtrace to console log with stdio_to_kmsg
Alan Stokes1125e012023-10-13 12:31:10 +0100171 if is_debuggable()? {
Inseob Kim7ff121c2022-11-14 18:13:23 +0900172 env::set_var("RUST_BACKTRACE", "full");
173 }
174
Inseob Kim437f1052022-06-21 11:30:22 +0900175 scopeguard::defer! {
176 info!("Shutting down...");
Jooyung Hanbfe086f2021-10-28 10:15:45 +0900177 if let Err(e) = system_properties::write("sys.powerctl", "shutdown") {
178 error!("failed to shutdown {:?}", e);
179 }
Jooyung Han311b1202021-09-14 22:00:16 +0900180 }
Inseob Kim437f1052022-06-21 11:30:22 +0900181
182 try_main().map_err(|e| {
183 error!("Failed with {:?}.", e);
184 if let Err(e) = write_death_reason_to_serial(&e) {
185 error!("Failed to write death reason {:?}", e);
186 }
187 e
188 })
Jooyung Han311b1202021-09-14 22:00:16 +0900189}
190
191fn try_main() -> Result<()> {
Jiyong Park2b6346d2023-06-19 13:37:42 +0900192 android_logger::init_once(
193 android_logger::Config::default()
194 .with_tag("microdroid_manager")
Jeff Vander Stoep57da1572024-01-31 10:52:16 +0100195 .with_max_level(log::LevelFilter::Info),
Jiyong Park2b6346d2023-06-19 13:37:42 +0900196 );
Jooyung Han347d9f22021-05-28 00:05:14 +0900197 info!("started.");
198
Alice Wangfd222fd2023-05-25 09:37:38 +0000199 // SAFETY: This is the only place we take the ownership of the fd of the vm payload service.
200 //
Alice Wang2a5306e2023-06-05 09:18:32 +0000201 // To ensure that the CLOEXEC flag is set on the file descriptor as early as possible,
202 // it is necessary to fetch the socket corresponding to vm_payload_service at the
203 // very beginning, as android_get_control_socket() sets the CLOEXEC flag on the file
204 // descriptor.
Alice Wangfd222fd2023-05-25 09:37:38 +0000205 let vm_payload_service_fd = unsafe { prepare_vm_payload_service_socket()? };
Inseob Kim090b70b2022-11-16 20:01:14 +0900206
Jiyong Park202856e2022-08-22 16:04:26 +0900207 load_crashkernel_if_supported().context("Failed to load crashkernel")?;
208
Alice Wangeff58392023-07-04 13:32:09 +0000209 swap::init_swap().context("Failed to initialize swap")?;
Keir Fraser933f0ac2022-10-12 08:23:28 +0000210 info!("swap enabled.");
211
Inseob Kim11f40d02022-06-13 17:16:00 +0900212 let service = get_vms_rpc_binder()
213 .context("cannot connect to VirtualMachineService")
214 .map_err(|e| MicrodroidError::FailedToConnectToVirtualizationService(e.to_string()))?;
Seungjae Yoofd9a0622022-10-14 10:01:29 +0900215
Alice Wangfd222fd2023-05-25 09:37:38 +0000216 match try_run_payload(&service, vm_payload_service_fd) {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900217 Ok(code) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900218 if code == 0 {
219 info!("task successfully finished");
220 } else {
221 error!("task exited with exit code: {}", code);
222 }
Shikha Panwardef7ef92023-01-06 08:35:48 +0000223 if let Err(e) = post_payload_work() {
224 error!(
225 "Failed to run post payload work. It is possible that certain tasks
226 like syncing encrypted store might be incomplete. Error: {:?}",
227 e
228 );
229 };
230
231 info!("notifying payload finished");
232 service.notifyPayloadFinished(code)?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900233 Ok(())
234 }
235 Err(err) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900236 let (error_code, message) = translate_error(&err);
237 service.notifyError(error_code, &message)?;
238 Err(err)
239 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900240 }
241}
242
Shikha Panwar185ba932024-03-12 22:35:09 +0000243fn verify_payload_with_instance_img(
244 metadata: &Metadata,
245 dice: &DiceDriver,
246) -> Result<MicrodroidData> {
Jooyung Han311b1202021-09-14 22:00:16 +0900247 let mut instance = InstanceDisk::new().context("Failed to load instance.img")?;
Shikha Panwar185ba932024-03-12 22:35:09 +0000248 let saved_data = instance.read_microdroid_data(dice).context("Failed to read identity data")?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900249
Andrew Scullab72ec52022-03-14 09:10:52 +0000250 if is_strict_boot() {
251 // Provisioning must happen on the first boot and never again.
252 if is_new_instance() {
253 ensure!(
254 saved_data.is_none(),
Alan Stokesbbed8872023-10-19 13:17:12 +0100255 MicrodroidError::PayloadInvalidConfig(
256 "Found instance data on first boot.".to_string()
257 )
Andrew Scullab72ec52022-03-14 09:10:52 +0000258 );
259 } else {
260 ensure!(
261 saved_data.is_some(),
Alan Stokesbbed8872023-10-19 13:17:12 +0100262 MicrodroidError::PayloadInvalidConfig("Instance data not found.".to_string())
Andrew Scullab72ec52022-03-14 09:10:52 +0000263 );
264 };
265 }
266
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900267 // Verify the payload before using it.
Shikha Panwar185ba932024-03-12 22:35:09 +0000268 let extracted_data = verify_payload(metadata, saved_data.as_ref())
Inseob Kim11f40d02022-06-13 17:16:00 +0900269 .context("Payload verification failed")
270 .map_err(|e| MicrodroidError::PayloadVerificationFailed(e.to_string()))?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900271
272 // In case identity is ignored (by debug policy), we should reuse existing payload data, even
273 // when the payload is changed. This is to keep the derived secret same as before.
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000274 let instance_data = if let Some(saved_data) = saved_data {
Inseob Kime379e7d2022-07-22 18:55:18 +0900275 if !is_verified_boot() {
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000276 if saved_data != extracted_data {
Inseob Kime379e7d2022-07-22 18:55:18 +0900277 info!("Detected an update of the payload, but continue (regarding debug policy)")
278 }
279 } else {
280 ensure!(
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000281 saved_data == extracted_data,
Inseob Kime379e7d2022-07-22 18:55:18 +0900282 MicrodroidError::PayloadChanged(String::from(
283 "Detected an update of the payload which isn't supported yet."
284 ))
285 );
286 info!("Saved data is verified.");
287 }
288 saved_data
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900289 } else {
Jooyung Han7a343f92021-09-08 22:53:11 +0900290 info!("Saving verified data.");
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000291 instance
Shikha Panwar185ba932024-03-12 22:35:09 +0000292 .write_microdroid_data(&extracted_data, dice)
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000293 .context("Failed to write identity data")?;
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000294 extracted_data
Inseob Kime379e7d2022-07-22 18:55:18 +0900295 };
Shikha Panwar185ba932024-03-12 22:35:09 +0000296 Ok(instance_data)
297}
298
299fn try_run_payload(
300 service: &Strong<dyn IVirtualMachineService>,
301 vm_payload_service_fd: OwnedFd,
302) -> Result<i32> {
303 let metadata = load_metadata().context("Failed to load payload metadata")?;
304 let dice = DiceDriver::new(Path::new("/dev/open-dice0"), is_strict_boot())
305 .context("Failed to load DICE")?;
306
Shikha Panware45e9422024-02-28 21:18:10 +0000307 // Microdroid skips checking payload against instance image iff the device supports
308 // secretkeeper. In that case Microdroid use VmSecret::V2, which provide protection against
309 // rollback of boot images and packages.
310 let instance_data = if should_defer_rollback_protection() {
Shikha Panwar185ba932024-03-12 22:35:09 +0000311 verify_payload(&metadata, None)?
312 } else {
313 verify_payload_with_instance_img(&metadata, &dice)?
314 };
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900315
Alan Stokes1f417c92022-09-29 15:13:28 +0100316 let payload_metadata = metadata.payload.ok_or_else(|| {
Alan Stokesbbed8872023-10-19 13:17:12 +0100317 MicrodroidError::PayloadInvalidConfig("No payload config in metadata".to_string())
Alan Stokes1f417c92022-09-29 15:13:28 +0100318 })?;
Alan Stokes0d1ef782022-09-27 13:46:35 +0100319
Inseob Kimb2519c52022-04-14 02:10:09 +0900320 // To minimize the exposure to untrusted data, derive dice profile as soon as possible.
321 info!("DICE derivation for payload");
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000322 let dice_artifacts = dice_derivation(dice, &instance_data, &payload_metadata)?;
Shikha Panwar5d6a6752023-12-14 22:08:26 +0000323 let vm_secret =
Shikha Panwar14abe442024-02-23 15:04:27 +0000324 VmSecret::new(dice_artifacts, service).context("Failed to create VM secrets")?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000325
Alan Stokes9a7f67e2023-11-07 09:37:40 +0000326 if cfg!(dice_changes) {
327 // Now that the DICE derivation is done, it's ok to allow payload code to run.
328
329 // Start apexd to activate APEXes. This may allow code within them to run.
330 system_properties::write("ctl.start", "apexd-vm")?;
331 }
332
Shikha Panwar566c9672022-11-15 14:39:58 +0000333 // Run encryptedstore binary to prepare the storage
334 let encryptedstore_child = if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
335 info!("Preparing encryptedstore ...");
Shikha Panwar95084df2023-07-22 11:47:45 +0000336 Some(prepare_encryptedstore(&vm_secret).context("encryptedstore run")?)
Shikha Panwar566c9672022-11-15 14:39:58 +0000337 } else {
338 None
339 };
Inseob Kimb2519c52022-04-14 02:10:09 +0900340
Alan Stokes960c9032022-12-07 16:53:45 +0000341 let mut zipfuse = Zipfuse::default();
342
Jooyung Hana6d11eb2021-09-10 11:48:05 +0900343 // Before reading a file from the APK, start zipfuse
Alan Stokes960c9032022-12-07 16:53:45 +0000344 zipfuse.mount(
Alan Stokes60f82202022-10-07 16:40:07 +0100345 MountForExec::Allowed,
Inseob Kim217038e2021-11-25 11:15:06 +0900346 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:system_file:s0",
Alan Stokes1125e012023-10-13 12:31:10 +0100347 Path::new(verify::DM_MOUNTED_APK_PATH),
Alice Wang6bbb6da2022-10-26 12:44:06 +0000348 Path::new(VM_APK_CONTENTS_PATH),
Alan Stokes960c9032022-12-07 16:53:45 +0000349 "microdroid_manager.apk.mounted".to_owned(),
350 )?;
Jiyong Park21ce2c52021-08-28 02:32:17 +0900351
Andrew Scull4d262dc2022-10-21 13:14:33 +0000352 // Restricted APIs are only allowed to be used by platform or test components. Infer this from
353 // the use of a VM config file since those can only be used by platform and test components.
354 let allow_restricted_apis = match payload_metadata {
Ludovic Barman93ee3082023-06-20 12:18:43 +0000355 PayloadMetadata::ConfigPath(_) => true,
356 PayloadMetadata::Config(_) => false,
357 _ => false, // default is false for safety
Andrew Scull4d262dc2022-10-21 13:14:33 +0000358 };
359
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100360 let config = load_config(payload_metadata).context("Failed to load payload metadata")?;
Shikha Panwar6f03c942022-04-13 20:26:50 +0000361
Alan Stokes01b3ef02022-09-22 17:43:24 +0100362 let task = config
363 .task
364 .as_ref()
Alan Stokesbbed8872023-10-19 13:17:12 +0100365 .ok_or_else(|| MicrodroidError::PayloadInvalidConfig("No task in VM config".to_string()))?;
Alan Stokes01b3ef02022-09-22 17:43:24 +0100366
Alice Wang061478b2023-04-11 13:26:17 +0000367 ensure!(
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000368 config.extra_apks.len() == instance_data.extra_apks_data.len(),
Alice Wang061478b2023-04-11 13:26:17 +0000369 "config expects {} extra apks, but found {}",
370 config.extra_apks.len(),
Alan Stokes26a6a5c2023-11-10 16:18:43 +0000371 instance_data.extra_apks_data.len()
Alice Wang061478b2023-04-11 13:26:17 +0000372 );
Alan Stokes960c9032022-12-07 16:53:45 +0000373 mount_extra_apks(&config, &mut zipfuse)?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900374
Alan Stokes26efd192023-11-06 16:30:15 +0000375 register_vm_payload_service(
376 allow_restricted_apis,
377 service.clone(),
378 vm_secret,
379 vm_payload_service_fd,
380 )?;
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000381
Shikha Panwar1a6efcd2023-02-03 19:23:43 +0000382 // Set export_tombstones if enabled
Inseob Kimab1037d2023-02-08 17:03:31 +0900383 if should_export_tombstones(&config) {
Shikha Panwar1a6efcd2023-02-03 19:23:43 +0000384 // This property is read by tombstone_handler.
385 system_properties::write("microdroid_manager.export_tombstones.enabled", "1")
386 .context("set microdroid_manager.export_tombstones.enabled")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900387 }
388
Alan Stokes26efd192023-11-06 16:30:15 +0000389 // Wait until apex config is done. (e.g. linker configuration for apexes)
390 wait_for_property_true(APEX_CONFIG_DONE_PROP).context("Failed waiting for apex config done")?;
391
392 // Trigger init post-fs-data. This will start authfs if we wask it to.
393 if config.enable_authfs {
394 system_properties::write("microdroid_manager.authfs.enabled", "1")
395 .context("failed to write microdroid_manager.authfs.enabled")?;
396 }
397 system_properties::write("microdroid_manager.config_done", "1")
398 .context("failed to write microdroid_manager.config_done")?;
399
Alan Stokes960c9032022-12-07 16:53:45 +0000400 // Wait until zipfuse has mounted the APKs so we can access the payload
401 zipfuse.wait_until_done()?;
Alan Stokes60f82202022-10-07 16:40:07 +0100402
Shikha Panwarddc124b2022-11-28 19:17:54 +0000403 // Wait for encryptedstore to finish mounting the storage (if enabled) before setting
404 // microdroid_manager.init_done. Reason is init stops uneventd after that.
405 // Encryptedstore, however requires ueventd
Shikha Panwar566c9672022-11-15 14:39:58 +0000406 if let Some(mut child) = encryptedstore_child {
407 let exitcode = child.wait().context("Wait for encryptedstore child")?;
408 ensure!(exitcode.success(), "Unable to prepare encrypted storage. Exitcode={}", exitcode);
409 }
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100410
Alan Stokes26efd192023-11-06 16:30:15 +0000411 // Wait for init to have finished booting.
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000412 wait_for_property_true("dev.bootcomplete").context("failed waiting for dev.bootcomplete")?;
Alan Stokes26efd192023-11-06 16:30:15 +0000413
414 // And then tell it we're done so unnecessary services can be shut down.
Shikha Panwar3f6f6a52022-11-29 17:28:36 +0000415 system_properties::write("microdroid_manager.init_done", "1")
416 .context("set microdroid_manager.init_done")?;
Inseob Kimc16b0cc2023-01-26 14:57:24 +0900417
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000418 info!("boot completed, time to run payload");
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100419 exec_task(task, service).context("Failed to run payload")
Alan Stokes01b3ef02022-09-22 17:43:24 +0100420}
421
Alan Stokes03754962023-11-06 15:36:09 +0000422fn post_payload_work() -> Result<()> {
423 // Sync the encrypted storage filesystem (flushes the filesystem caches).
424 if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
425 let mountpoint = CString::new(ENCRYPTEDSTORE_MOUNTPOINT).unwrap();
426
427 // SAFETY: `mountpoint` is a valid C string. `syncfs` and `close` are safe for any parameter
428 // values.
429 let ret = unsafe {
430 let dirfd = libc::open(
431 mountpoint.as_ptr(),
432 libc::O_DIRECTORY | libc::O_RDONLY | libc::O_CLOEXEC,
433 );
434 ensure!(dirfd >= 0, "Unable to open {:?}", mountpoint);
435 let ret = libc::syncfs(dirfd);
436 libc::close(dirfd);
437 ret
438 };
439 if ret != 0 {
440 error!("failed to sync encrypted storage.");
441 return Err(anyhow!(std::io::Error::last_os_error()));
442 }
443 }
444 Ok(())
445}
446
Alan Stokes03754962023-11-06 15:36:09 +0000447fn mount_extra_apks(config: &VmPayloadConfig, zipfuse: &mut Zipfuse) -> Result<()> {
448 // For now, only the number of apks is important, as the mount point and dm-verity name is fixed
449 for i in 0..config.extra_apks.len() {
450 let mount_dir = format!("/mnt/extra-apk/{i}");
451 create_dir(Path::new(&mount_dir)).context("Failed to create mount dir for extra apks")?;
452
453 let mount_for_exec =
454 if cfg!(multi_tenant) { MountForExec::Allowed } else { MountForExec::Disallowed };
455 // These run asynchronously in parallel - we wait later for them to complete.
456 zipfuse.mount(
457 mount_for_exec,
458 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:extra_apk_file:s0",
459 Path::new(&format!("/dev/block/mapper/extra-apk-{i}")),
460 Path::new(&mount_dir),
461 format!("microdroid_manager.extra_apk.mounted.{i}"),
462 )?;
463 }
464
465 Ok(())
466}
467
468fn get_vms_rpc_binder() -> Result<Strong<dyn IVirtualMachineService>> {
469 // The host is running a VirtualMachineService for this VM on a port equal
470 // to the CID of this VM.
471 let port = vsock::get_local_cid().context("Could not determine local CID")?;
472 RpcSession::new()
473 .setup_vsock_client(VMADDR_CID_HOST, port)
474 .context("Could not connect to IVirtualMachineService")
475}
476
477/// Prepares a socket file descriptor for the vm payload service.
478///
479/// # Safety
480///
481/// The caller must ensure that this function is the only place that claims ownership
482/// of the file descriptor and it is called only once.
483unsafe fn prepare_vm_payload_service_socket() -> Result<OwnedFd> {
484 let raw_fd = android_get_control_socket(VM_PAYLOAD_SERVICE_SOCKET_NAME)?;
485
486 // Creating OwnedFd for stdio FDs is not safe.
487 if [libc::STDIN_FILENO, libc::STDOUT_FILENO, libc::STDERR_FILENO].contains(&raw_fd) {
488 bail!("File descriptor {raw_fd} is standard I/O descriptor");
489 }
490 // SAFETY: Initializing OwnedFd for a RawFd created by the init.
491 // We checked that the integer value corresponds to a valid FD and that the caller
492 // ensures that this is the only place to claim its ownership.
493 Ok(unsafe { OwnedFd::from_raw_fd(raw_fd) })
494}
495
496fn is_strict_boot() -> bool {
497 Path::new(AVF_STRICT_BOOT).exists()
498}
499
500fn is_new_instance() -> bool {
501 Path::new(AVF_NEW_INSTANCE).exists()
502}
503
504fn is_verified_boot() -> bool {
505 !Path::new(DEBUG_MICRODROID_NO_VERIFIED_BOOT).exists()
506}
507
508fn is_debuggable() -> Result<bool> {
509 Ok(system_properties::read_bool(DEBUGGABLE_PROP, true)?)
510}
511
512fn should_export_tombstones(config: &VmPayloadConfig) -> bool {
513 match config.export_tombstones {
514 Some(b) => b,
515 None => is_debuggable().unwrap_or(false),
516 }
517}
518
519/// Get debug policy value in bool. It's true iff the value is explicitly set to <1>.
520fn get_debug_policy_bool(path: &'static str) -> Result<Option<bool>> {
521 let mut file = match File::open(path) {
522 Ok(dp) => dp,
523 Err(e) => {
524 info!(
525 "Assumes that debug policy is disabled because failed to read debug policy ({e:?})"
526 );
527 return Ok(Some(false));
528 }
529 };
530 let mut log: [u8; 4] = Default::default();
531 file.read_exact(&mut log).context("Malformed data in {path}")?;
532 // DT spec uses big endian although Android is always little endian.
533 Ok(Some(u32::from_be_bytes(log) == 1))
534}
535
Alan Stokes60f82202022-10-07 16:40:07 +0100536enum MountForExec {
537 Allowed,
538 Disallowed,
539}
540
Alan Stokes960c9032022-12-07 16:53:45 +0000541#[derive(Default)]
542struct Zipfuse {
543 ready_properties: Vec<String>,
544}
545
546impl Zipfuse {
547 fn mount(
548 &mut self,
549 noexec: MountForExec,
550 option: &str,
551 zip_path: &Path,
552 mount_dir: &Path,
553 ready_prop: String,
554 ) -> Result<Child> {
555 let mut cmd = Command::new(ZIPFUSE_BIN);
556 if let MountForExec::Disallowed = noexec {
557 cmd.arg("--noexec");
558 }
Alan Stokes1294f942023-08-21 14:34:12 +0100559 // Let root own the files in APK, so we can access them, but set the group to
560 // allow all payloads to have access too.
561 let (uid, gid) = (microdroid_uids::ROOT_UID, microdroid_uids::MICRODROID_PAYLOAD_GID);
562
Alan Stokes960c9032022-12-07 16:53:45 +0000563 cmd.args(["-p", &ready_prop, "-o", option]);
Alan Stokes1294f942023-08-21 14:34:12 +0100564 cmd.args(["-u", &uid.to_string()]);
565 cmd.args(["-g", &gid.to_string()]);
Alan Stokes960c9032022-12-07 16:53:45 +0000566 cmd.arg(zip_path).arg(mount_dir);
567 self.ready_properties.push(ready_prop);
568 cmd.spawn().with_context(|| format!("Failed to run zipfuse for {mount_dir:?}"))
Andrew Scullcc339a12022-07-04 12:44:19 +0000569 }
Alan Stokes960c9032022-12-07 16:53:45 +0000570
571 fn wait_until_done(self) -> Result<()> {
572 // We check the last-started check first in the hope that by the time it is done
573 // all or most of the others will also be done, minimising the number of times we
574 // block on a property.
575 for property in self.ready_properties.into_iter().rev() {
576 wait_for_property_true(&property)
577 .with_context(|| format!("Failed waiting for {property}"))?;
578 }
579 Ok(())
Alan Stokes60f82202022-10-07 16:40:07 +0100580 }
Inseob Kim217038e2021-11-25 11:15:06 +0900581}
582
Alan Stokes60f82202022-10-07 16:40:07 +0100583fn wait_for_property_true(property_name: &str) -> Result<()> {
584 let mut prop = PropertyWatcher::new(property_name)?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900585 loop {
Andrew Walbrand9c766e2023-05-10 15:15:39 +0000586 prop.wait(None)?;
Alan Stokes60f82202022-10-07 16:40:07 +0100587 if system_properties::read_bool(property_name, false)? {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900588 break;
589 }
590 }
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900591 Ok(())
592}
593
Alan Stokes1f417c92022-09-29 15:13:28 +0100594fn load_config(payload_metadata: PayloadMetadata) -> Result<VmPayloadConfig> {
595 match payload_metadata {
Ludovic Barman93ee3082023-06-20 12:18:43 +0000596 PayloadMetadata::ConfigPath(path) => {
Alan Stokes1f417c92022-09-29 15:13:28 +0100597 let path = Path::new(&path);
598 info!("loading config from {:?}...", path);
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100599 let file = ioutil::wait_for_file(path, WAIT_TIMEOUT)
600 .with_context(|| format!("Failed to read {:?}", path))?;
Alan Stokes1f417c92022-09-29 15:13:28 +0100601 Ok(serde_json::from_reader(file)?)
602 }
Ludovic Barman93ee3082023-06-20 12:18:43 +0000603 PayloadMetadata::Config(payload_config) => {
Alan Stokes1f417c92022-09-29 15:13:28 +0100604 let task = Task {
605 type_: TaskType::MicrodroidLauncher,
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000606 command: payload_config.payload_binary_name,
Alan Stokes1f417c92022-09-29 15:13:28 +0100607 };
Alan Stokesfda70842023-12-20 17:50:14 +0000608 // We don't care about the paths, only the number of extra APKs really matters.
609 let extra_apks = (0..payload_config.extra_apk_count)
610 .map(|i| ApkConfig { path: format!("extra-apk-{i}") })
611 .collect();
Alan Stokes1f417c92022-09-29 15:13:28 +0100612 Ok(VmPayloadConfig {
613 os: OsConfig { name: "microdroid".to_owned() },
614 task: Some(task),
615 apexes: vec![],
Alan Stokesfda70842023-12-20 17:50:14 +0000616 extra_apks,
Alan Stokes1f417c92022-09-29 15:13:28 +0100617 prefer_staged: false,
Inseob Kimab1037d2023-02-08 17:03:31 +0900618 export_tombstones: None,
Alan Stokes1f417c92022-09-29 15:13:28 +0100619 enable_authfs: false,
620 })
621 }
Ludovic Barman93ee3082023-06-20 12:18:43 +0000622 _ => bail!("Failed to match config against a config type."),
Alan Stokes1f417c92022-09-29 15:13:28 +0100623 }
Jooyung Han634e2d72021-06-10 16:27:38 +0900624}
625
Jaewan Kim3124ef02023-03-23 19:25:20 +0900626/// Loads the crashkernel into memory using kexec if debuggable or debug policy says so.
627/// The VM should be loaded with `crashkernel=' parameter in the cmdline to allocate memory
628/// for crashkernel.
Jiyong Park202856e2022-08-22 16:04:26 +0900629fn load_crashkernel_if_supported() -> Result<()> {
630 let supported = std::fs::read_to_string("/proc/cmdline")?.contains(" crashkernel=");
631 info!("ramdump supported: {}", supported);
Jaewan Kim3124ef02023-03-23 19:25:20 +0900632
633 if !supported {
634 return Ok(());
635 }
636
Alan Stokes1125e012023-10-13 12:31:10 +0100637 let debuggable = is_debuggable()?;
Jaewan Kim3124ef02023-03-23 19:25:20 +0900638 let ramdump = get_debug_policy_bool(AVF_DEBUG_POLICY_RAMDUMP)?.unwrap_or_default();
639 let requested = debuggable | ramdump;
640
641 if requested {
Jiyong Park202856e2022-08-22 16:04:26 +0900642 let status = Command::new("/system/bin/kexec_load").status()?;
643 if !status.success() {
644 return Err(anyhow!("Failed to load crashkernel: {:?}", status));
645 }
Jaewan Kim3124ef02023-03-23 19:25:20 +0900646 info!("ramdump is loaded: debuggable={debuggable}, ramdump={ramdump}");
Jiyong Park202856e2022-08-22 16:04:26 +0900647 }
648 Ok(())
649}
650
Inseob Kim090b70b2022-11-16 20:01:14 +0900651/// Executes the given task.
Jooyung Han5c6d4172021-12-06 14:17:52 +0900652fn exec_task(task: &Task, service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900653 info!("executing main task {:?}...", task);
David Brazdil451cc962022-10-14 14:08:12 +0100654 let mut command = match task.type_ {
Alan Stokes1294f942023-08-21 14:34:12 +0100655 TaskType::Executable => {
Alan Stokes679ddf32023-09-01 11:14:48 +0100656 // TODO(b/297501338): Figure out how to handle non-root for system payloads.
Alan Stokes1294f942023-08-21 14:34:12 +0100657 Command::new(&task.command)
658 }
David Brazdil451cc962022-10-14 14:08:12 +0100659 TaskType::MicrodroidLauncher => {
660 let mut command = Command::new("/system/bin/microdroid_launcher");
661 command.arg(find_library_path(&task.command)?);
Alan Stokes1294f942023-08-21 14:34:12 +0100662 command.uid(microdroid_uids::MICRODROID_PAYLOAD_UID);
663 command.gid(microdroid_uids::MICRODROID_PAYLOAD_GID);
David Brazdil451cc962022-10-14 14:08:12 +0100664 command
665 }
666 };
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000667
Andrew Walbranaac68302023-07-21 19:05:34 +0100668 // SAFETY: We are not accessing any resource of the parent process. This means we can't make any
669 // log calls inside the closure.
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000670 unsafe {
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000671 command.pre_exec(|| {
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000672 // It is OK to continue with payload execution even if the calls below fail, since
673 // whether process can use a capability is controlled by the SELinux. Dropping the
674 // capabilities here is just another defense-in-depth layer.
Andrew Walbranaac68302023-07-21 19:05:34 +0100675 let _ = cap::drop_inheritable_caps();
676 let _ = cap::drop_bounding_set();
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000677 Ok(())
678 });
679 }
680
Inseob Kim090b70b2022-11-16 20:01:14 +0900681 command.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
Inseob Kim7f61fe72021-08-20 20:50:47 +0900682
683 info!("notifying payload started");
Inseob Kimc7d28c72021-10-25 14:28:10 +0000684 service.notifyPayloadStarted()?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900685
Inseob Kim86ca0162021-10-20 02:21:02 +0000686 let exit_status = command.spawn()?.wait()?;
Frederick Mayleb5f7b6b2022-11-11 15:24:03 -0800687 match exit_status.code() {
688 Some(exit_code) => Ok(exit_code),
689 None => Err(match exit_status.signal() {
690 Some(signal) => anyhow!(
691 "Payload exited due to signal: {} ({})",
692 signal,
693 Signal::try_from(signal).map_or("unknown", |s| s.as_str())
694 ),
695 None => anyhow!("Payload has neither exit code nor signal"),
696 }),
697 }
Jooyung Han347d9f22021-05-28 00:05:14 +0900698}
Jooyung Han634e2d72021-06-10 16:27:38 +0900699
Jooyung Han634e2d72021-06-10 16:27:38 +0900700fn find_library_path(name: &str) -> Result<String> {
701 let mut watcher = PropertyWatcher::new("ro.product.cpu.abilist")?;
702 let value = watcher.read(|_name, value| Ok(value.trim().to_string()))?;
703 let abi = value.split(',').next().ok_or_else(|| anyhow!("no abilist"))?;
Alice Wang6bbb6da2022-10-26 12:44:06 +0000704 let path = format!("{}/lib/{}/{}", VM_APK_CONTENTS_PATH, abi, name);
Jooyung Han634e2d72021-06-10 16:27:38 +0900705
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100706 let metadata = fs::metadata(&path).with_context(|| format!("Unable to access {}", path))?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900707 if !metadata.is_file() {
708 bail!("{} is not a file", &path);
709 }
710
711 Ok(path)
712}
Jiyong Park21ce2c52021-08-28 02:32:17 +0900713
Shikha Panwar95084df2023-07-22 11:47:45 +0000714fn prepare_encryptedstore(vm_secret: &VmSecret) -> Result<Child> {
Alice Wang7e6c9352023-02-15 15:44:13 +0000715 let mut key = ZVec::new(ENCRYPTEDSTORE_KEYSIZE)?;
Shikha Panwar3d3a70a2023-08-21 20:02:08 +0000716 vm_secret.derive_encryptedstore_key(&mut key)?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000717 let mut cmd = Command::new(ENCRYPTEDSTORE_BIN);
718 cmd.arg("--blkdevice")
719 .arg(ENCRYPTEDSTORE_BACKING_DEVICE)
720 .arg("--key")
721 .arg(hex::encode(&*key))
Shikha Panwar9fd198f2022-11-18 17:43:43 +0000722 .args(["--mountpoint", ENCRYPTEDSTORE_MOUNTPOINT])
Shikha Panwar566c9672022-11-15 14:39:58 +0000723 .spawn()
724 .context("encryptedstore failed")
725}