blob: e9cb0ec4350e09fde7a927056da544ac23fea74d [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;
Alice Wang59a9e562022-10-04 15:24:10 +000022mod vm_payload_service;
Shikha Panwar95084df2023-07-22 11:47:45 +000023mod vm_secret;
Jooyung Han347d9f22021-05-28 00:05:14 +090024
Shikha Panwar95084df2023-07-22 11:47:45 +000025use crate::dice::{DiceDriver, format_payload_config_descriptor};
Inseob Kime379e7d2022-07-22 18:55:18 +090026use crate::instance::{ApexData, ApkData, InstanceDisk, MicrodroidData, RootHash};
Alice Wang59a9e562022-10-04 15:24:10 +000027use crate::vm_payload_service::register_vm_payload_service;
Alan Stokes2bead0d2022-09-05 16:58:34 +010028use android_system_virtualizationcommon::aidl::android::system::virtualizationcommon::ErrorCode::ErrorCode;
David Brazdil73988ea2022-11-11 15:10:32 +000029use android_system_virtualmachineservice::aidl::android::system::virtualmachineservice::IVirtualMachineService::IVirtualMachineService;
Inseob Kim090b70b2022-11-16 20:01:14 +090030use android_system_virtualization_payload::aidl::android::system::virtualization::payload::IVmPayloadService::{
31 VM_APK_CONTENTS_PATH,
32 VM_PAYLOAD_SERVICE_SOCKET_NAME,
Shikha Panwarddc124b2022-11-28 19:17:54 +000033 ENCRYPTEDSTORE_MOUNTPOINT,
Inseob Kim090b70b2022-11-16 20:01:14 +090034};
Jooyung Handd0a1732021-11-23 15:26:20 +090035use anyhow::{anyhow, bail, ensure, Context, Error, Result};
Alice Wang1bf3d782022-09-28 07:56:36 +000036use apkverify::{get_public_key_der, verify, V4Signature};
Alice Wang43c884b2022-10-24 09:42:40 +000037use binder::Strong;
Alice Wang62f7e642023-02-10 09:55:13 +000038use diced_open_dice::OwnedDiceArtifacts;
Inseob Kim197748b2021-12-01 19:49:00 +090039use glob::glob;
Inseob Kim197748b2021-12-01 19:49:00 +090040use itertools::sorted;
David Brazdila07a1792022-10-25 13:37:57 +010041use libc::VMADDR_CID_HOST;
Alice Wang2a5306e2023-06-05 09:18:32 +000042use log::{error, info};
Alice Wang7e6c9352023-02-15 15:44:13 +000043use keystore2_crypto::ZVec;
Alan Stokes0d1ef782022-09-27 13:46:35 +010044use microdroid_metadata::{write_metadata, Metadata, PayloadMetadata};
Seungjae Yoofd9a0622022-10-14 10:01:29 +090045use microdroid_payload_config::{OsConfig, Task, TaskType, VmPayloadConfig};
Frederick Mayleb5f7b6b2022-11-11 15:24:03 -080046use nix::sys::signal::Signal;
Andrew Sculla0d1b1a2022-05-24 19:32:47 +000047use openssl::sha::Sha512;
Jooyung Han4a9b3bf2021-09-10 17:19:00 +090048use payload::{get_apex_data_from_payload, load_metadata, to_metadata};
Andrew Scull34916a72022-01-30 21:34:24 +000049use rand::Fill;
David Brazdila2125dd2022-12-14 16:37:44 +000050use rpcbinder::RpcSession;
Inseob Kim090b70b2022-11-16 20:01:14 +090051use rustutils::sockets::android_get_control_socket;
Jiyong Parkbb4a9872021-09-06 15:59:21 +090052use rustutils::system_properties;
Joel Galenson482704c2021-07-29 15:53:53 -070053use rustutils::system_properties::PropertyWatcher;
Alan Stokes3ba10fd2022-10-06 15:46:51 +010054use std::borrow::Cow::{Borrowed, Owned};
Andrew Scullb2f44472022-01-21 14:41:34 +000055use std::convert::TryInto;
Inseob Kim7ff121c2022-11-14 18:13:23 +090056use std::env;
Shikha Panwardef7ef92023-01-06 08:35:48 +000057use std::ffi::CString;
Jaewan Kim3124ef02023-03-23 19:25:20 +090058use std::fs::{self, create_dir, OpenOptions, File};
59use std::io::{Read, Write};
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;
Alice Wangfd222fd2023-05-25 09:37:38 +000062use std::os::unix::io::{FromRawFd, OwnedFd};
Jooyung Hanf48ceb42021-06-01 18:00:04 +090063use std::path::Path;
Inseob Kim217038e2021-11-25 11:15:06 +090064use std::process::{Child, Command, Stdio};
Jiyong Park8611a6c2021-07-09 18:17:44 +090065use std::str;
Jiyong Parkbb4a9872021-09-06 15:59:21 +090066use std::time::{Duration, SystemTime};
Shikha Panwar95084df2023-07-22 11:47:45 +000067use vm_secret::VmSecret;
Jooyung Han634e2d72021-06-10 16:27:38 +090068
69const WAIT_TIMEOUT: Duration = Duration::from_secs(10);
Inseob Kim197748b2021-12-01 19:49:00 +090070const MAIN_APK_PATH: &str = "/dev/block/by-name/microdroid-apk";
71const MAIN_APK_IDSIG_PATH: &str = "/dev/block/by-name/microdroid-apk-idsig";
72const MAIN_APK_DEVICE_NAME: &str = "microdroid-apk";
73const EXTRA_APK_PATH_PATTERN: &str = "/dev/block/by-name/extra-apk-*";
74const EXTRA_IDSIG_PATH_PATTERN: &str = "/dev/block/by-name/extra-idsig-*";
Jooyung Han19c1d6c2021-08-06 14:08:16 +090075const DM_MOUNTED_APK_PATH: &str = "/dev/block/mapper/microdroid-apk";
Andrew Scullab72ec52022-03-14 09:10:52 +000076const AVF_STRICT_BOOT: &str = "/sys/firmware/devicetree/base/chosen/avf,strict-boot";
77const AVF_NEW_INSTANCE: &str = "/sys/firmware/devicetree/base/chosen/avf,new-instance";
Jaewan Kim3124ef02023-03-23 19:25:20 +090078const AVF_DEBUG_POLICY_RAMDUMP: &str = "/sys/firmware/devicetree/base/avf/guest/common/ramdump";
Inseob Kime379e7d2022-07-22 18:55:18 +090079const DEBUG_MICRODROID_NO_VERIFIED_BOOT: &str =
80 "/sys/firmware/devicetree/base/virtualization/guest/debug-microdroid,no-verified-boot";
Jooyung Han347d9f22021-05-28 00:05:14 +090081
Alan Stokes4fb201c2023-02-08 17:39:05 +000082const APKDMVERITY_BIN: &str = "/system/bin/apkdmverity";
83const ENCRYPTEDSTORE_BIN: &str = "/system/bin/encryptedstore";
84const ZIPFUSE_BIN: &str = "/system/bin/zipfuse";
85
Jiyong Parkbb4a9872021-09-06 15:59:21 +090086const APEX_CONFIG_DONE_PROP: &str = "apex_config.done";
Seungjae Yoofa22bb02022-12-08 16:38:42 +090087const DEBUGGABLE_PROP: &str = "ro.boot.microdroid.debuggable";
Jiyong Parkbb4a9872021-09-06 15:59:21 +090088
Inseob Kim11f40d02022-06-13 17:16:00 +090089// SYNC WITH virtualizationservice/src/crosvm.rs
90const FAILURE_SERIAL_DEVICE: &str = "/dev/ttyS1";
91
Shikha Panwar566c9672022-11-15 14:39:58 +000092const ENCRYPTEDSTORE_BACKING_DEVICE: &str = "/dev/block/by-name/encryptedstore";
Alice Wang62f7e642023-02-10 09:55:13 +000093const ENCRYPTEDSTORE_KEYSIZE: usize = 32;
Shikha Panwar566c9672022-11-15 14:39:58 +000094
Jooyung Handd0a1732021-11-23 15:26:20 +090095#[derive(thiserror::Error, Debug)]
96enum MicrodroidError {
Inseob Kim11f40d02022-06-13 17:16:00 +090097 #[error("Cannot connect to virtualization service: {0}")]
98 FailedToConnectToVirtualizationService(String),
Jooyung Handd0a1732021-11-23 15:26:20 +090099 #[error("Payload has changed: {0}")]
100 PayloadChanged(String),
101 #[error("Payload verification has failed: {0}")]
102 PayloadVerificationFailed(String),
Jooyung Han5c6d4172021-12-06 14:17:52 +0900103 #[error("Payload config is invalid: {0}")]
104 InvalidConfig(String),
Jooyung Handd0a1732021-11-23 15:26:20 +0900105}
106
Alan Stokes2bead0d2022-09-05 16:58:34 +0100107fn translate_error(err: &Error) -> (ErrorCode, String) {
Jooyung Handd0a1732021-11-23 15:26:20 +0900108 if let Some(e) = err.downcast_ref::<MicrodroidError>() {
109 match e {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100110 MicrodroidError::PayloadChanged(msg) => (ErrorCode::PAYLOAD_CHANGED, msg.to_string()),
Jooyung Handd0a1732021-11-23 15:26:20 +0900111 MicrodroidError::PayloadVerificationFailed(msg) => {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100112 (ErrorCode::PAYLOAD_VERIFICATION_FAILED, msg.to_string())
Jooyung Handd0a1732021-11-23 15:26:20 +0900113 }
Alan Stokes2bead0d2022-09-05 16:58:34 +0100114 MicrodroidError::InvalidConfig(msg) => {
115 (ErrorCode::PAYLOAD_CONFIG_INVALID, msg.to_string())
116 }
Inseob Kim11f40d02022-06-13 17:16:00 +0900117
118 // Connection failure won't be reported to VS; return the default value
119 MicrodroidError::FailedToConnectToVirtualizationService(msg) => {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100120 (ErrorCode::UNKNOWN, msg.to_string())
Inseob Kim11f40d02022-06-13 17:16:00 +0900121 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900122 }
123 } else {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100124 (ErrorCode::UNKNOWN, err.to_string())
Jooyung Handd0a1732021-11-23 15:26:20 +0900125 }
126}
127
Inseob Kim11f40d02022-06-13 17:16:00 +0900128fn write_death_reason_to_serial(err: &Error) -> Result<()> {
129 let death_reason = if let Some(e) = err.downcast_ref::<MicrodroidError>() {
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100130 Borrowed(match e {
Inseob Kim11f40d02022-06-13 17:16:00 +0900131 MicrodroidError::FailedToConnectToVirtualizationService(_) => {
132 "MICRODROID_FAILED_TO_CONNECT_TO_VIRTUALIZATION_SERVICE"
133 }
134 MicrodroidError::PayloadChanged(_) => "MICRODROID_PAYLOAD_HAS_CHANGED",
135 MicrodroidError::PayloadVerificationFailed(_) => {
136 "MICRODROID_PAYLOAD_VERIFICATION_FAILED"
137 }
138 MicrodroidError::InvalidConfig(_) => "MICRODROID_INVALID_PAYLOAD_CONFIG",
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100139 })
Inseob Kim11f40d02022-06-13 17:16:00 +0900140 } else {
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100141 // Send context information back after a separator, to ease diagnosis.
142 // These errors occur before the payload runs, so this should not leak sensitive
143 // information.
144 Owned(format!("MICRODROID_UNKNOWN_RUNTIME_ERROR|{:?}", err))
Inseob Kim11f40d02022-06-13 17:16:00 +0900145 };
146
147 let death_reason_bytes = death_reason.as_bytes();
148 let mut sent_total = 0;
149 while sent_total < death_reason_bytes.len() {
150 // TODO(b/220071963): Sometimes, sending more than 16 bytes at once makes MM hang.
151 let begin = sent_total;
152 let end = std::cmp::min(begin.saturating_add(16), death_reason_bytes.len());
153 OpenOptions::new()
154 .read(false)
155 .write(true)
156 .open(FAILURE_SERIAL_DEVICE)?
157 .write_all(&death_reason_bytes[begin..end])?;
158 sent_total = end;
159 }
160
161 Ok(())
162}
163
Inseob Kim1b95f2e2021-08-19 13:17:40 +0900164fn get_vms_rpc_binder() -> Result<Strong<dyn IVirtualMachineService>> {
David Brazdil73988ea2022-11-11 15:10:32 +0000165 // The host is running a VirtualMachineService for this VM on a port equal
166 // to the CID of this VM.
167 let port = vsock::get_local_cid().context("Could not determine local CID")?;
David Brazdila2125dd2022-12-14 16:37:44 +0000168 RpcSession::new()
169 .setup_vsock_client(VMADDR_CID_HOST, port)
David Brazdil73988ea2022-11-11 15:10:32 +0000170 .context("Could not connect to IVirtualMachineService")
Inseob Kim1b95f2e2021-08-19 13:17:40 +0900171}
172
Inseob Kim437f1052022-06-21 11:30:22 +0900173fn main() -> Result<()> {
Inseob Kim7ff121c2022-11-14 18:13:23 +0900174 // If debuggable, print full backtrace to console log with stdio_to_kmsg
Seungjae Yoofa22bb02022-12-08 16:38:42 +0900175 if system_properties::read_bool(DEBUGGABLE_PROP, true)? {
Inseob Kim7ff121c2022-11-14 18:13:23 +0900176 env::set_var("RUST_BACKTRACE", "full");
177 }
178
Inseob Kim437f1052022-06-21 11:30:22 +0900179 scopeguard::defer! {
180 info!("Shutting down...");
Jooyung Hanbfe086f2021-10-28 10:15:45 +0900181 if let Err(e) = system_properties::write("sys.powerctl", "shutdown") {
182 error!("failed to shutdown {:?}", e);
183 }
Jooyung Han311b1202021-09-14 22:00:16 +0900184 }
Inseob Kim437f1052022-06-21 11:30:22 +0900185
186 try_main().map_err(|e| {
187 error!("Failed with {:?}.", e);
188 if let Err(e) = write_death_reason_to_serial(&e) {
189 error!("Failed to write death reason {:?}", e);
190 }
191 e
192 })
Jooyung Han311b1202021-09-14 22:00:16 +0900193}
194
Alice Wangfd222fd2023-05-25 09:37:38 +0000195/// Prepares a socket file descriptor for the vm payload service.
196///
Andrew Walbranae3350d2023-07-21 19:01:18 +0100197/// # Safety
Alice Wangfd222fd2023-05-25 09:37:38 +0000198///
199/// The caller must ensure that this function is the only place that claims ownership
200/// of the file descriptor and it is called only once.
201unsafe fn prepare_vm_payload_service_socket() -> Result<OwnedFd> {
202 let raw_fd = android_get_control_socket(VM_PAYLOAD_SERVICE_SOCKET_NAME)?;
Inseob Kim090b70b2022-11-16 20:01:14 +0900203
Alice Wangfd222fd2023-05-25 09:37:38 +0000204 // Creating OwnedFd for stdio FDs is not safe.
205 if [libc::STDIN_FILENO, libc::STDOUT_FILENO, libc::STDERR_FILENO].contains(&raw_fd) {
206 bail!("File descriptor {raw_fd} is standard I/O descriptor");
207 }
208 // SAFETY: Initializing OwnedFd for a RawFd created by the init.
209 // We checked that the integer value corresponds to a valid FD and that the caller
210 // ensures that this is the only place to claim its ownership.
211 Ok(unsafe { OwnedFd::from_raw_fd(raw_fd) })
Inseob Kim090b70b2022-11-16 20:01:14 +0900212}
213
Jooyung Han311b1202021-09-14 22:00:16 +0900214fn try_main() -> Result<()> {
Jiyong Park2b6346d2023-06-19 13:37:42 +0900215 android_logger::init_once(
216 android_logger::Config::default()
217 .with_tag("microdroid_manager")
218 .with_min_level(log::Level::Info),
219 );
Jooyung Han347d9f22021-05-28 00:05:14 +0900220 info!("started.");
221
Alice Wangfd222fd2023-05-25 09:37:38 +0000222 // SAFETY: This is the only place we take the ownership of the fd of the vm payload service.
223 //
Alice Wang2a5306e2023-06-05 09:18:32 +0000224 // To ensure that the CLOEXEC flag is set on the file descriptor as early as possible,
225 // it is necessary to fetch the socket corresponding to vm_payload_service at the
226 // very beginning, as android_get_control_socket() sets the CLOEXEC flag on the file
227 // descriptor.
Alice Wangfd222fd2023-05-25 09:37:38 +0000228 let vm_payload_service_fd = unsafe { prepare_vm_payload_service_socket()? };
Inseob Kim090b70b2022-11-16 20:01:14 +0900229
Jiyong Park202856e2022-08-22 16:04:26 +0900230 load_crashkernel_if_supported().context("Failed to load crashkernel")?;
231
Alice Wangeff58392023-07-04 13:32:09 +0000232 swap::init_swap().context("Failed to initialize swap")?;
Keir Fraser933f0ac2022-10-12 08:23:28 +0000233 info!("swap enabled.");
234
Inseob Kim11f40d02022-06-13 17:16:00 +0900235 let service = get_vms_rpc_binder()
236 .context("cannot connect to VirtualMachineService")
237 .map_err(|e| MicrodroidError::FailedToConnectToVirtualizationService(e.to_string()))?;
Seungjae Yoofd9a0622022-10-14 10:01:29 +0900238
Alice Wangfd222fd2023-05-25 09:37:38 +0000239 match try_run_payload(&service, vm_payload_service_fd) {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900240 Ok(code) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900241 if code == 0 {
242 info!("task successfully finished");
243 } else {
244 error!("task exited with exit code: {}", code);
245 }
Shikha Panwardef7ef92023-01-06 08:35:48 +0000246 if let Err(e) = post_payload_work() {
247 error!(
248 "Failed to run post payload work. It is possible that certain tasks
249 like syncing encrypted store might be incomplete. Error: {:?}",
250 e
251 );
252 };
253
254 info!("notifying payload finished");
255 service.notifyPayloadFinished(code)?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900256 Ok(())
257 }
258 Err(err) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900259 let (error_code, message) = translate_error(&err);
260 service.notifyError(error_code, &message)?;
261 Err(err)
262 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900263 }
264}
265
Shikha Panwardef7ef92023-01-06 08:35:48 +0000266fn post_payload_work() -> Result<()> {
267 // Sync the encrypted storage filesystem (flushes the filesystem caches).
268 if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
269 let mountpoint = CString::new(ENCRYPTEDSTORE_MOUNTPOINT).unwrap();
270
Andrew Walbranae3350d2023-07-21 19:01:18 +0100271 // SAFETY: `mountpoint` is a valid C string. `syncfs` and `close` are safe for any parameter
272 // values.
Shikha Panwardef7ef92023-01-06 08:35:48 +0000273 let ret = unsafe {
274 let dirfd = libc::open(
275 mountpoint.as_ptr(),
276 libc::O_DIRECTORY | libc::O_RDONLY | libc::O_CLOEXEC,
277 );
278 ensure!(dirfd >= 0, "Unable to open {:?}", mountpoint);
279 let ret = libc::syncfs(dirfd);
280 libc::close(dirfd);
281 ret
282 };
283 if ret != 0 {
284 error!("failed to sync encrypted storage.");
285 return Err(anyhow!(std::io::Error::last_os_error()));
286 }
287 }
288 Ok(())
289}
Alan Stokes1f417c92022-09-29 15:13:28 +0100290fn dice_derivation(
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000291 dice: DiceDriver,
Alan Stokes1f417c92022-09-29 15:13:28 +0100292 verified_data: &MicrodroidData,
293 payload_metadata: &PayloadMetadata,
Alice Wang62f7e642023-02-10 09:55:13 +0000294) -> Result<OwnedDiceArtifacts> {
Andrew Scullb2f44472022-01-21 14:41:34 +0000295 // Calculate compound digests of code and authorities
Andrew Sculla0d1b1a2022-05-24 19:32:47 +0000296 let mut code_hash_ctx = Sha512::new();
297 let mut authority_hash_ctx = Sha512::new();
Andrew Scullb2f44472022-01-21 14:41:34 +0000298 code_hash_ctx.update(verified_data.apk_data.root_hash.as_ref());
299 authority_hash_ctx.update(verified_data.apk_data.pubkey.as_ref());
Inseob Kimb2519c52022-04-14 02:10:09 +0900300 for extra_apk in &verified_data.extra_apks_data {
Andrew Scullb2f44472022-01-21 14:41:34 +0000301 code_hash_ctx.update(extra_apk.root_hash.as_ref());
302 authority_hash_ctx.update(extra_apk.pubkey.as_ref());
303 }
Inseob Kimb2519c52022-04-14 02:10:09 +0900304 for apex in &verified_data.apex_data {
Andrew Scullb2f44472022-01-21 14:41:34 +0000305 code_hash_ctx.update(apex.root_digest.as_ref());
306 authority_hash_ctx.update(apex.public_key.as_ref());
307 }
Andrew Sculla0d1b1a2022-05-24 19:32:47 +0000308 let code_hash = code_hash_ctx.finish();
309 let authority_hash = authority_hash_ctx.finish();
Andrew Scullb2f44472022-01-21 14:41:34 +0000310
Alice Wang285a3d22023-03-01 11:36:29 +0000311 let config_descriptor = format_payload_config_descriptor(payload_metadata)?;
Andrew Scullb2f44472022-01-21 14:41:34 +0000312
Seungjae Yoofa22bb02022-12-08 16:38:42 +0900313 // Check debuggability, conservatively assuming it is debuggable
314 let debuggable = system_properties::read_bool(DEBUGGABLE_PROP, true)?;
Andrew Scull65ddfc42022-02-14 21:03:58 +0000315
Andrew Scullb2f44472022-01-21 14:41:34 +0000316 // Send the details to diced
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000317 let hidden = verified_data.salt.clone().try_into().unwrap();
Alice Wang285a3d22023-03-01 11:36:29 +0000318 dice.derive(code_hash, &config_descriptor, authority_hash, debuggable, hidden)
Alan Stokes1f417c92022-09-29 15:13:28 +0100319}
320
Andrew Scullab72ec52022-03-14 09:10:52 +0000321fn is_strict_boot() -> bool {
322 Path::new(AVF_STRICT_BOOT).exists()
323}
324
325fn is_new_instance() -> bool {
326 Path::new(AVF_NEW_INSTANCE).exists()
327}
328
Inseob Kime379e7d2022-07-22 18:55:18 +0900329fn is_verified_boot() -> bool {
330 !Path::new(DEBUG_MICRODROID_NO_VERIFIED_BOOT).exists()
331}
332
Inseob Kimab1037d2023-02-08 17:03:31 +0900333fn should_export_tombstones(config: &VmPayloadConfig) -> bool {
334 match config.export_tombstones {
335 Some(b) => b,
336 None => system_properties::read_bool(DEBUGGABLE_PROP, true).unwrap_or(false),
337 }
338}
339
Jaewan Kim3124ef02023-03-23 19:25:20 +0900340/// Get debug policy value in bool. It's true iff the value is explicitly set to <1>.
341fn get_debug_policy_bool(path: &'static str) -> Result<Option<bool>> {
342 let mut file = match File::open(path) {
343 Ok(dp) => dp,
344 Err(e) => {
Jaewan Kim476ecd42023-08-28 05:57:00 +0000345 info!(
346 "Assumes that debug policy is disabled because failed to read debug policy ({e:?})"
347 );
Jaewan Kim3124ef02023-03-23 19:25:20 +0900348 return Ok(Some(false));
349 }
350 };
351 let mut log: [u8; 4] = Default::default();
352 file.read_exact(&mut log).context("Malformed data in {path}")?;
353 // DT spec uses big endian although Android is always little endian.
354 Ok(Some(u32::from_be_bytes(log) == 1))
355}
356
Alice Wangfd222fd2023-05-25 09:37:38 +0000357fn try_run_payload(
358 service: &Strong<dyn IVirtualMachineService>,
359 vm_payload_service_fd: OwnedFd,
360) -> Result<i32> {
Jooyung Han311b1202021-09-14 22:00:16 +0900361 let metadata = load_metadata().context("Failed to load payload metadata")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000362 let dice = DiceDriver::new(Path::new("/dev/open-dice0")).context("Failed to load DICE")?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900363
Jooyung Han311b1202021-09-14 22:00:16 +0900364 let mut instance = InstanceDisk::new().context("Failed to load instance.img")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000365 let saved_data =
366 instance.read_microdroid_data(&dice).context("Failed to read identity data")?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900367
Andrew Scullab72ec52022-03-14 09:10:52 +0000368 if is_strict_boot() {
369 // Provisioning must happen on the first boot and never again.
370 if is_new_instance() {
371 ensure!(
372 saved_data.is_none(),
373 MicrodroidError::InvalidConfig("Found instance data on first boot.".to_string())
374 );
375 } else {
376 ensure!(
377 saved_data.is_some(),
378 MicrodroidError::InvalidConfig("Instance data not found.".to_string())
379 );
380 };
381 }
382
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900383 // Verify the payload before using it.
Inseob Kim11f40d02022-06-13 17:16:00 +0900384 let verified_data = verify_payload(&metadata, saved_data.as_ref())
385 .context("Payload verification failed")
386 .map_err(|e| MicrodroidError::PayloadVerificationFailed(e.to_string()))?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900387
388 // In case identity is ignored (by debug policy), we should reuse existing payload data, even
389 // when the payload is changed. This is to keep the derived secret same as before.
390 let verified_data = if let Some(saved_data) = saved_data {
391 if !is_verified_boot() {
392 if saved_data != verified_data {
393 info!("Detected an update of the payload, but continue (regarding debug policy)")
394 }
395 } else {
396 ensure!(
397 saved_data == verified_data,
398 MicrodroidError::PayloadChanged(String::from(
399 "Detected an update of the payload which isn't supported yet."
400 ))
401 );
402 info!("Saved data is verified.");
403 }
404 saved_data
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900405 } else {
Jooyung Han7a343f92021-09-08 22:53:11 +0900406 info!("Saving verified data.");
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000407 instance
408 .write_microdroid_data(&verified_data, &dice)
409 .context("Failed to write identity data")?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900410 verified_data
411 };
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900412
Alan Stokes1f417c92022-09-29 15:13:28 +0100413 let payload_metadata = metadata.payload.ok_or_else(|| {
414 MicrodroidError::InvalidConfig("No payload config in metadata".to_string())
415 })?;
Alan Stokes0d1ef782022-09-27 13:46:35 +0100416
Inseob Kimb2519c52022-04-14 02:10:09 +0900417 // To minimize the exposure to untrusted data, derive dice profile as soon as possible.
418 info!("DICE derivation for payload");
Alice Wang62f7e642023-02-10 09:55:13 +0000419 let dice_artifacts = dice_derivation(dice, &verified_data, &payload_metadata)?;
Shikha Panwar95084df2023-07-22 11:47:45 +0000420 let vm_secret = VmSecret::new(dice_artifacts).context("Failed to create VM secrets")?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000421
422 // Run encryptedstore binary to prepare the storage
423 let encryptedstore_child = if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
424 info!("Preparing encryptedstore ...");
Shikha Panwar95084df2023-07-22 11:47:45 +0000425 Some(prepare_encryptedstore(&vm_secret).context("encryptedstore run")?)
Shikha Panwar566c9672022-11-15 14:39:58 +0000426 } else {
427 None
428 };
Inseob Kimb2519c52022-04-14 02:10:09 +0900429
Alan Stokes960c9032022-12-07 16:53:45 +0000430 let mut zipfuse = Zipfuse::default();
431
Jooyung Hana6d11eb2021-09-10 11:48:05 +0900432 // Before reading a file from the APK, start zipfuse
Alan Stokes960c9032022-12-07 16:53:45 +0000433 zipfuse.mount(
Alan Stokes60f82202022-10-07 16:40:07 +0100434 MountForExec::Allowed,
Inseob Kim217038e2021-11-25 11:15:06 +0900435 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:system_file:s0",
436 Path::new("/dev/block/mapper/microdroid-apk"),
Alice Wang6bbb6da2022-10-26 12:44:06 +0000437 Path::new(VM_APK_CONTENTS_PATH),
Alan Stokes960c9032022-12-07 16:53:45 +0000438 "microdroid_manager.apk.mounted".to_owned(),
439 )?;
Jiyong Park21ce2c52021-08-28 02:32:17 +0900440
Andrew Scull4d262dc2022-10-21 13:14:33 +0000441 // Restricted APIs are only allowed to be used by platform or test components. Infer this from
442 // the use of a VM config file since those can only be used by platform and test components.
443 let allow_restricted_apis = match payload_metadata {
Ludovic Barman93ee3082023-06-20 12:18:43 +0000444 PayloadMetadata::ConfigPath(_) => true,
445 PayloadMetadata::Config(_) => false,
446 _ => false, // default is false for safety
Andrew Scull4d262dc2022-10-21 13:14:33 +0000447 };
448
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100449 let config = load_config(payload_metadata).context("Failed to load payload metadata")?;
Shikha Panwar6f03c942022-04-13 20:26:50 +0000450
Alan Stokes01b3ef02022-09-22 17:43:24 +0100451 let task = config
452 .task
453 .as_ref()
454 .ok_or_else(|| MicrodroidError::InvalidConfig("No task in VM config".to_string()))?;
455
Alice Wang061478b2023-04-11 13:26:17 +0000456 ensure!(
457 config.extra_apks.len() == verified_data.extra_apks_data.len(),
458 "config expects {} extra apks, but found {}",
459 config.extra_apks.len(),
460 verified_data.extra_apks_data.len()
461 );
Alan Stokes960c9032022-12-07 16:53:45 +0000462 mount_extra_apks(&config, &mut zipfuse)?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900463
Jooyung Han5c6d4172021-12-06 14:17:52 +0900464 // Wait until apex config is done. (e.g. linker configuration for apexes)
Jooyung Han5c6d4172021-12-06 14:17:52 +0900465 wait_for_apex_config_done()?;
466
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000467 setup_config_sysprops(&config)?;
468
Shikha Panwar1a6efcd2023-02-03 19:23:43 +0000469 // Set export_tombstones if enabled
Inseob Kimab1037d2023-02-08 17:03:31 +0900470 if should_export_tombstones(&config) {
Shikha Panwar1a6efcd2023-02-03 19:23:43 +0000471 // This property is read by tombstone_handler.
472 system_properties::write("microdroid_manager.export_tombstones.enabled", "1")
473 .context("set microdroid_manager.export_tombstones.enabled")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900474 }
475
Alan Stokes960c9032022-12-07 16:53:45 +0000476 // Wait until zipfuse has mounted the APKs so we can access the payload
477 zipfuse.wait_until_done()?;
Alan Stokes60f82202022-10-07 16:40:07 +0100478
Alice Wangfd222fd2023-05-25 09:37:38 +0000479 register_vm_payload_service(
480 allow_restricted_apis,
481 service.clone(),
Shikha Panwar95084df2023-07-22 11:47:45 +0000482 vm_secret,
Alice Wangfd222fd2023-05-25 09:37:38 +0000483 vm_payload_service_fd,
484 )?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000485
Shikha Panwarddc124b2022-11-28 19:17:54 +0000486 // Wait for encryptedstore to finish mounting the storage (if enabled) before setting
487 // microdroid_manager.init_done. Reason is init stops uneventd after that.
488 // Encryptedstore, however requires ueventd
Shikha Panwar566c9672022-11-15 14:39:58 +0000489 if let Some(mut child) = encryptedstore_child {
490 let exitcode = child.wait().context("Wait for encryptedstore child")?;
491 ensure!(exitcode.success(), "Unable to prepare encrypted storage. Exitcode={}", exitcode);
492 }
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100493
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000494 wait_for_property_true("dev.bootcomplete").context("failed waiting for dev.bootcomplete")?;
Shikha Panwar3f6f6a52022-11-29 17:28:36 +0000495 system_properties::write("microdroid_manager.init_done", "1")
496 .context("set microdroid_manager.init_done")?;
Inseob Kimc16b0cc2023-01-26 14:57:24 +0900497
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000498 info!("boot completed, time to run payload");
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100499 exec_task(task, service).context("Failed to run payload")
Alan Stokes01b3ef02022-09-22 17:43:24 +0100500}
501
Inseob Kim217038e2021-11-25 11:15:06 +0900502struct ApkDmverityArgument<'a> {
503 apk: &'a str,
504 idsig: &'a str,
505 name: &'a str,
Inseob Kim197748b2021-12-01 19:49:00 +0900506 saved_root_hash: Option<&'a RootHash>,
Inseob Kim217038e2021-11-25 11:15:06 +0900507}
508
509fn run_apkdmverity(args: &[ApkDmverityArgument]) -> Result<Child> {
510 let mut cmd = Command::new(APKDMVERITY_BIN);
511
Inseob Kim217038e2021-11-25 11:15:06 +0900512 for argument in args {
513 cmd.arg("--apk").arg(argument.apk).arg(argument.idsig).arg(argument.name);
Inseob Kim197748b2021-12-01 19:49:00 +0900514 if let Some(root_hash) = argument.saved_root_hash {
515 cmd.arg(&to_hex_string(root_hash));
516 } else {
517 cmd.arg("none");
518 }
Inseob Kim217038e2021-11-25 11:15:06 +0900519 }
520
521 cmd.spawn().context("Spawn apkdmverity")
522}
523
Alan Stokes60f82202022-10-07 16:40:07 +0100524enum MountForExec {
525 Allowed,
526 Disallowed,
527}
528
Alan Stokes960c9032022-12-07 16:53:45 +0000529#[derive(Default)]
530struct Zipfuse {
531 ready_properties: Vec<String>,
532}
533
534impl Zipfuse {
535 fn mount(
536 &mut self,
537 noexec: MountForExec,
538 option: &str,
539 zip_path: &Path,
540 mount_dir: &Path,
541 ready_prop: String,
542 ) -> Result<Child> {
543 let mut cmd = Command::new(ZIPFUSE_BIN);
544 if let MountForExec::Disallowed = noexec {
545 cmd.arg("--noexec");
546 }
Alan Stokes1294f942023-08-21 14:34:12 +0100547 // Let root own the files in APK, so we can access them, but set the group to
548 // allow all payloads to have access too.
549 let (uid, gid) = (microdroid_uids::ROOT_UID, microdroid_uids::MICRODROID_PAYLOAD_GID);
550
Alan Stokes960c9032022-12-07 16:53:45 +0000551 cmd.args(["-p", &ready_prop, "-o", option]);
Alan Stokes1294f942023-08-21 14:34:12 +0100552 cmd.args(["-u", &uid.to_string()]);
553 cmd.args(["-g", &gid.to_string()]);
Alan Stokes960c9032022-12-07 16:53:45 +0000554 cmd.arg(zip_path).arg(mount_dir);
555 self.ready_properties.push(ready_prop);
556 cmd.spawn().with_context(|| format!("Failed to run zipfuse for {mount_dir:?}"))
Andrew Scullcc339a12022-07-04 12:44:19 +0000557 }
Alan Stokes960c9032022-12-07 16:53:45 +0000558
559 fn wait_until_done(self) -> Result<()> {
560 // We check the last-started check first in the hope that by the time it is done
561 // all or most of the others will also be done, minimising the number of times we
562 // block on a property.
563 for property in self.ready_properties.into_iter().rev() {
564 wait_for_property_true(&property)
565 .with_context(|| format!("Failed waiting for {property}"))?;
566 }
567 Ok(())
Alan Stokes60f82202022-10-07 16:40:07 +0100568 }
Inseob Kim217038e2021-11-25 11:15:06 +0900569}
570
Inseob Kime379e7d2022-07-22 18:55:18 +0900571fn write_apex_payload_data(
572 saved_data: Option<&MicrodroidData>,
573 apex_data_from_payload: &[ApexData],
574) -> Result<()> {
575 if let Some(saved_apex_data) = saved_data.map(|d| &d.apex_data) {
576 // We don't support APEX updates. (assuming that update will change root digest)
577 ensure!(
578 saved_apex_data == apex_data_from_payload,
579 MicrodroidError::PayloadChanged(String::from("APEXes have changed."))
580 );
581 let apex_metadata = to_metadata(apex_data_from_payload);
582 // Pass metadata(with public keys and root digests) to apexd so that it uses the passed
583 // metadata instead of the default one (/dev/block/by-name/payload-metadata)
584 OpenOptions::new()
585 .create_new(true)
586 .write(true)
587 .open("/apex/vm-payload-metadata")
588 .context("Failed to open /apex/vm-payload-metadata")
589 .and_then(|f| write_metadata(&apex_metadata, f))?;
590 }
591 Ok(())
592}
593
Jooyung Han7a343f92021-09-08 22:53:11 +0900594// Verify payload before executing it. For APK payload, Full verification (which is slow) is done
595// when the root_hash values from the idsig file and the instance disk are different. This function
596// returns the verified root hash (for APK payload) and pubkeys (for APEX payloads) that can be
597// saved to the instance disk.
598fn verify_payload(
599 metadata: &Metadata,
600 saved_data: Option<&MicrodroidData>,
601) -> Result<MicrodroidData> {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900602 let start_time = SystemTime::now();
603
Inseob Kim197748b2021-12-01 19:49:00 +0900604 // Verify main APK
Inseob Kim197748b2021-12-01 19:49:00 +0900605 let root_hash_from_idsig = get_apk_root_hash_from_idsig(MAIN_APK_IDSIG_PATH)?;
Alice Wang061478b2023-04-11 13:26:17 +0000606 let root_hash_trustful =
607 saved_data.map(|d| d.apk_data.root_hash_eq(root_hash_from_idsig.as_ref())).unwrap_or(false);
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900608
Jiyong Parkf7dea252021-09-08 01:42:54 +0900609 // If root_hash can be trusted, pass it to apkdmverity so that it uses the passed root_hash
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900610 // instead of the value read from the idsig file.
Inseob Kim197748b2021-12-01 19:49:00 +0900611 let main_apk_argument = {
612 ApkDmverityArgument {
613 apk: MAIN_APK_PATH,
614 idsig: MAIN_APK_IDSIG_PATH,
615 name: MAIN_APK_DEVICE_NAME,
616 saved_root_hash: if root_hash_trustful {
617 Some(root_hash_from_idsig.as_ref())
618 } else {
619 None
620 },
621 }
622 };
623 let mut apkdmverity_arguments = vec![main_apk_argument];
624
625 // Verify extra APKs
626 // For now, we can't read the payload config, so glob APKs and idsigs.
627 // Later, we'll see if it matches with the payload config.
628
629 // sort globbed paths to match apks (extra-apk-{idx}) and idsigs (extra-idsig-{idx})
630 // e.g. "extra-apk-0" corresponds to "extra-idsig-0"
631 let extra_apks =
632 sorted(glob(EXTRA_APK_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
633 let extra_idsigs =
634 sorted(glob(EXTRA_IDSIG_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
Alice Wang061478b2023-04-11 13:26:17 +0000635 ensure!(
636 extra_apks.len() == extra_idsigs.len(),
637 "Extra apks/idsigs mismatch: {} apks but {} idsigs",
638 extra_apks.len(),
639 extra_idsigs.len()
640 );
Inseob Kim197748b2021-12-01 19:49:00 +0900641
Alice Wang061478b2023-04-11 13:26:17 +0000642 let extra_root_hashes_from_idsig: Vec<_> = extra_idsigs
Inseob Kim197748b2021-12-01 19:49:00 +0900643 .iter()
Alice Wang061478b2023-04-11 13:26:17 +0000644 .map(|idsig| {
645 get_apk_root_hash_from_idsig(idsig).expect("Can't find root hash from extra idsig")
Inseob Kim197748b2021-12-01 19:49:00 +0900646 })
647 .collect();
648
Alice Wang061478b2023-04-11 13:26:17 +0000649 let extra_root_hashes_trustful: Vec<_> = if let Some(data) = saved_data {
650 extra_root_hashes_from_idsig
651 .iter()
652 .enumerate()
653 .map(|(i, root_hash)| data.extra_apk_root_hash_eq(i, root_hash))
654 .collect()
655 } else {
656 vec![false; extra_root_hashes_from_idsig.len()]
657 };
658 let extra_apk_names: Vec<_> =
659 (0..extra_apks.len()).map(|i| format!("extra-apk-{}", i)).collect();
660
661 for (i, extra_apk) in extra_apks.iter().enumerate() {
Inseob Kim197748b2021-12-01 19:49:00 +0900662 apkdmverity_arguments.push({
663 ApkDmverityArgument {
Alice Wang061478b2023-04-11 13:26:17 +0000664 apk: extra_apk.to_str().unwrap(),
Inseob Kim197748b2021-12-01 19:49:00 +0900665 idsig: extra_idsigs[i].to_str().unwrap(),
666 name: &extra_apk_names[i],
667 saved_root_hash: if extra_root_hashes_trustful[i] {
668 Some(&extra_root_hashes_from_idsig[i])
669 } else {
670 None
671 },
672 }
673 });
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900674 }
675
676 // Start apkdmverity and wait for the dm-verify block
Inseob Kim197748b2021-12-01 19:49:00 +0900677 let mut apkdmverity_child = run_apkdmverity(&apkdmverity_arguments)?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900678
Jooyung Hanc8deb472021-09-13 13:48:25 +0900679 // While waiting for apkdmverity to mount APK, gathers public keys and root digests from
680 // APEX payload.
Jooyung Han7a343f92021-09-08 22:53:11 +0900681 let apex_data_from_payload = get_apex_data_from_payload(metadata)?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900682
683 // Writing /apex/vm-payload-metadata is to verify that the payload isn't changed.
684 // Skip writing it if the debug policy ignoring identity is on
685 if is_verified_boot() {
686 write_apex_payload_data(saved_data, &apex_data_from_payload)?;
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900687 }
Inseob Kime379e7d2022-07-22 18:55:18 +0900688
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900689 // Start apexd to activate APEXes
690 system_properties::write("ctl.start", "apexd-vm")?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900691
Inseob Kim217038e2021-11-25 11:15:06 +0900692 // TODO(inseob): add timeout
693 apkdmverity_child.wait()?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900694
Jiyong Parkf7dea252021-09-08 01:42:54 +0900695 // Do the full verification if the root_hash is un-trustful. This requires the full scanning of
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900696 // the APK file and therefore can be very slow if the APK is large. Note that this step is
Jiyong Parkf7dea252021-09-08 01:42:54 +0900697 // taken only when the root_hash is un-trustful which can be either when this is the first boot
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900698 // of the VM or APK was updated in the host.
699 // TODO(jooyung): consider multithreading to make this faster
Inseob Kim197748b2021-12-01 19:49:00 +0900700 let main_apk_pubkey = get_public_key_from_apk(DM_MOUNTED_APK_PATH, root_hash_trustful)?;
701 let extra_apks_data = extra_root_hashes_from_idsig
702 .into_iter()
703 .enumerate()
704 .map(|(i, extra_root_hash)| {
705 let mount_path = format!("/dev/block/mapper/{}", &extra_apk_names[i]);
706 let apk_pubkey = get_public_key_from_apk(&mount_path, extra_root_hashes_trustful[i])?;
707 Ok(ApkData { root_hash: extra_root_hash, pubkey: apk_pubkey })
708 })
709 .collect::<Result<Vec<_>>>()?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900710
711 info!("payload verification successful. took {:#?}", start_time.elapsed().unwrap());
712
Andrew Scull34916a72022-01-30 21:34:24 +0000713 // Use the salt from a verified instance, or generate a salt for a new instance.
714 let salt = if let Some(saved_data) = saved_data {
715 saved_data.salt.clone()
Pierre-Clément Tosicecb0aa2023-02-08 16:57:54 +0000716 } else if is_strict_boot() {
717 // No need to add more entropy as a previous stage must have used a new, random salt.
718 vec![0u8; 64]
Andrew Scull34916a72022-01-30 21:34:24 +0000719 } else {
720 let mut salt = vec![0u8; 64];
721 salt.as_mut_slice().try_fill(&mut rand::thread_rng())?;
722 salt
723 };
724
Jiyong Parkf7dea252021-09-08 01:42:54 +0900725 // At this point, we can ensure that the root_hash from the idsig file is trusted, either by
726 // fully verifying the APK or by comparing it with the saved root_hash.
Jooyung Han7a343f92021-09-08 22:53:11 +0900727 Ok(MicrodroidData {
Andrew Scull34916a72022-01-30 21:34:24 +0000728 salt,
Inseob Kim197748b2021-12-01 19:49:00 +0900729 apk_data: ApkData { root_hash: root_hash_from_idsig, pubkey: main_apk_pubkey },
730 extra_apks_data,
Jooyung Han7a343f92021-09-08 22:53:11 +0900731 apex_data: apex_data_from_payload,
732 })
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900733}
734
Alan Stokes960c9032022-12-07 16:53:45 +0000735fn mount_extra_apks(config: &VmPayloadConfig, zipfuse: &mut Zipfuse) -> Result<()> {
Inseob Kim197748b2021-12-01 19:49:00 +0900736 // For now, only the number of apks is important, as the mount point and dm-verity name is fixed
737 for i in 0..config.extra_apks.len() {
Alan Stokes960c9032022-12-07 16:53:45 +0000738 let mount_dir = format!("/mnt/extra-apk/{i}");
Inseob Kim197748b2021-12-01 19:49:00 +0900739 create_dir(Path::new(&mount_dir)).context("Failed to create mount dir for extra apks")?;
740
741 // don't wait, just detach
Alan Stokes960c9032022-12-07 16:53:45 +0000742 zipfuse.mount(
Alan Stokes60f82202022-10-07 16:40:07 +0100743 MountForExec::Disallowed,
Inseob Kim197748b2021-12-01 19:49:00 +0900744 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:extra_apk_file:s0",
Alan Stokes960c9032022-12-07 16:53:45 +0000745 Path::new(&format!("/dev/block/mapper/extra-apk-{i}")),
Inseob Kim197748b2021-12-01 19:49:00 +0900746 Path::new(&mount_dir),
Alan Stokes960c9032022-12-07 16:53:45 +0000747 format!("microdroid_manager.extra_apk.mounted.{i}"),
748 )?;
Inseob Kim197748b2021-12-01 19:49:00 +0900749 }
750
751 Ok(())
752}
753
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000754fn setup_config_sysprops(config: &VmPayloadConfig) -> Result<()> {
755 if config.enable_authfs {
756 system_properties::write("microdroid_manager.authfs.enabled", "1")
757 .context("failed to write microdroid_manager.authfs.enabled")?;
758 }
759 system_properties::write("microdroid_manager.config_done", "1")
760 .context("failed to write microdroid_manager.config_done")?;
761 Ok(())
762}
763
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900764// Waits until linker config is generated
765fn wait_for_apex_config_done() -> Result<()> {
Alan Stokes60f82202022-10-07 16:40:07 +0100766 wait_for_property_true(APEX_CONFIG_DONE_PROP).context("Failed waiting for apex config done")
767}
768
769fn wait_for_property_true(property_name: &str) -> Result<()> {
770 let mut prop = PropertyWatcher::new(property_name)?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900771 loop {
Andrew Walbrand9c766e2023-05-10 15:15:39 +0000772 prop.wait(None)?;
Alan Stokes60f82202022-10-07 16:40:07 +0100773 if system_properties::read_bool(property_name, false)? {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900774 break;
775 }
776 }
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900777 Ok(())
778}
779
Alice Wang89cff012022-09-26 10:05:16 +0000780fn get_apk_root_hash_from_idsig<P: AsRef<Path>>(idsig_path: P) -> Result<Box<RootHash>> {
781 Ok(V4Signature::from_idsig_path(idsig_path)?.hashing_info.raw_root_hash)
Jiyong Park21ce2c52021-08-28 02:32:17 +0900782}
783
Inseob Kim197748b2021-12-01 19:49:00 +0900784fn get_public_key_from_apk(apk: &str, root_hash_trustful: bool) -> Result<Box<[u8]>> {
Alan Stokes25f69362023-03-06 16:51:54 +0000785 let current_sdk = get_current_sdk()?;
Inseob Kim197748b2021-12-01 19:49:00 +0900786 if !root_hash_trustful {
Alan Stokes25f69362023-03-06 16:51:54 +0000787 verify(apk, current_sdk).context(MicrodroidError::PayloadVerificationFailed(format!(
Inseob Kim197748b2021-12-01 19:49:00 +0900788 "failed to verify {}",
789 apk
790 )))
791 } else {
Alan Stokes25f69362023-03-06 16:51:54 +0000792 get_public_key_der(apk, current_sdk)
Inseob Kim197748b2021-12-01 19:49:00 +0900793 }
794}
795
Alan Stokes25f69362023-03-06 16:51:54 +0000796fn get_current_sdk() -> Result<u32> {
797 let current_sdk = system_properties::read("ro.build.version.sdk")?;
798 let current_sdk = current_sdk.ok_or_else(|| anyhow!("SDK version missing"))?;
799 current_sdk.parse().context("Malformed SDK version")
800}
801
Alan Stokes1f417c92022-09-29 15:13:28 +0100802fn load_config(payload_metadata: PayloadMetadata) -> Result<VmPayloadConfig> {
803 match payload_metadata {
Ludovic Barman93ee3082023-06-20 12:18:43 +0000804 PayloadMetadata::ConfigPath(path) => {
Alan Stokes1f417c92022-09-29 15:13:28 +0100805 let path = Path::new(&path);
806 info!("loading config from {:?}...", path);
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100807 let file = ioutil::wait_for_file(path, WAIT_TIMEOUT)
808 .with_context(|| format!("Failed to read {:?}", path))?;
Alan Stokes1f417c92022-09-29 15:13:28 +0100809 Ok(serde_json::from_reader(file)?)
810 }
Ludovic Barman93ee3082023-06-20 12:18:43 +0000811 PayloadMetadata::Config(payload_config) => {
Alan Stokes1f417c92022-09-29 15:13:28 +0100812 let task = Task {
813 type_: TaskType::MicrodroidLauncher,
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000814 command: payload_config.payload_binary_name,
Alan Stokes1f417c92022-09-29 15:13:28 +0100815 };
816 Ok(VmPayloadConfig {
817 os: OsConfig { name: "microdroid".to_owned() },
818 task: Some(task),
819 apexes: vec![],
820 extra_apks: vec![],
821 prefer_staged: false,
Inseob Kimab1037d2023-02-08 17:03:31 +0900822 export_tombstones: None,
Alan Stokes1f417c92022-09-29 15:13:28 +0100823 enable_authfs: false,
824 })
825 }
Ludovic Barman93ee3082023-06-20 12:18:43 +0000826 _ => bail!("Failed to match config against a config type."),
Alan Stokes1f417c92022-09-29 15:13:28 +0100827 }
Jooyung Han634e2d72021-06-10 16:27:38 +0900828}
829
Jaewan Kim3124ef02023-03-23 19:25:20 +0900830/// Loads the crashkernel into memory using kexec if debuggable or debug policy says so.
831/// The VM should be loaded with `crashkernel=' parameter in the cmdline to allocate memory
832/// for crashkernel.
Jiyong Park202856e2022-08-22 16:04:26 +0900833fn load_crashkernel_if_supported() -> Result<()> {
834 let supported = std::fs::read_to_string("/proc/cmdline")?.contains(" crashkernel=");
835 info!("ramdump supported: {}", supported);
Jaewan Kim3124ef02023-03-23 19:25:20 +0900836
837 if !supported {
838 return Ok(());
839 }
840
841 let debuggable = system_properties::read_bool(DEBUGGABLE_PROP, true)?;
842 let ramdump = get_debug_policy_bool(AVF_DEBUG_POLICY_RAMDUMP)?.unwrap_or_default();
843 let requested = debuggable | ramdump;
844
845 if requested {
Jiyong Park202856e2022-08-22 16:04:26 +0900846 let status = Command::new("/system/bin/kexec_load").status()?;
847 if !status.success() {
848 return Err(anyhow!("Failed to load crashkernel: {:?}", status));
849 }
Jaewan Kim3124ef02023-03-23 19:25:20 +0900850 info!("ramdump is loaded: debuggable={debuggable}, ramdump={ramdump}");
Jiyong Park202856e2022-08-22 16:04:26 +0900851 }
852 Ok(())
853}
854
Inseob Kim090b70b2022-11-16 20:01:14 +0900855/// Executes the given task.
Jooyung Han5c6d4172021-12-06 14:17:52 +0900856fn exec_task(task: &Task, service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900857 info!("executing main task {:?}...", task);
David Brazdil451cc962022-10-14 14:08:12 +0100858 let mut command = match task.type_ {
Alan Stokes1294f942023-08-21 14:34:12 +0100859 TaskType::Executable => {
Alan Stokes679ddf32023-09-01 11:14:48 +0100860 // TODO(b/297501338): Figure out how to handle non-root for system payloads.
Alan Stokes1294f942023-08-21 14:34:12 +0100861 Command::new(&task.command)
862 }
David Brazdil451cc962022-10-14 14:08:12 +0100863 TaskType::MicrodroidLauncher => {
864 let mut command = Command::new("/system/bin/microdroid_launcher");
865 command.arg(find_library_path(&task.command)?);
Alan Stokes1294f942023-08-21 14:34:12 +0100866 command.uid(microdroid_uids::MICRODROID_PAYLOAD_UID);
867 command.gid(microdroid_uids::MICRODROID_PAYLOAD_GID);
David Brazdil451cc962022-10-14 14:08:12 +0100868 command
869 }
870 };
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000871
Andrew Walbranaac68302023-07-21 19:05:34 +0100872 // SAFETY: We are not accessing any resource of the parent process. This means we can't make any
873 // log calls inside the closure.
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000874 unsafe {
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000875 command.pre_exec(|| {
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000876 // It is OK to continue with payload execution even if the calls below fail, since
877 // whether process can use a capability is controlled by the SELinux. Dropping the
878 // capabilities here is just another defense-in-depth layer.
Andrew Walbranaac68302023-07-21 19:05:34 +0100879 let _ = cap::drop_inheritable_caps();
880 let _ = cap::drop_bounding_set();
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000881 Ok(())
882 });
883 }
884
Inseob Kim090b70b2022-11-16 20:01:14 +0900885 command.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
Inseob Kim7f61fe72021-08-20 20:50:47 +0900886
887 info!("notifying payload started");
Inseob Kimc7d28c72021-10-25 14:28:10 +0000888 service.notifyPayloadStarted()?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900889
Inseob Kim86ca0162021-10-20 02:21:02 +0000890 let exit_status = command.spawn()?.wait()?;
Frederick Mayleb5f7b6b2022-11-11 15:24:03 -0800891 match exit_status.code() {
892 Some(exit_code) => Ok(exit_code),
893 None => Err(match exit_status.signal() {
894 Some(signal) => anyhow!(
895 "Payload exited due to signal: {} ({})",
896 signal,
897 Signal::try_from(signal).map_or("unknown", |s| s.as_str())
898 ),
899 None => anyhow!("Payload has neither exit code nor signal"),
900 }),
901 }
Jooyung Han347d9f22021-05-28 00:05:14 +0900902}
Jooyung Han634e2d72021-06-10 16:27:38 +0900903
Jooyung Han634e2d72021-06-10 16:27:38 +0900904fn find_library_path(name: &str) -> Result<String> {
905 let mut watcher = PropertyWatcher::new("ro.product.cpu.abilist")?;
906 let value = watcher.read(|_name, value| Ok(value.trim().to_string()))?;
907 let abi = value.split(',').next().ok_or_else(|| anyhow!("no abilist"))?;
Alice Wang6bbb6da2022-10-26 12:44:06 +0000908 let path = format!("{}/lib/{}/{}", VM_APK_CONTENTS_PATH, abi, name);
Jooyung Han634e2d72021-06-10 16:27:38 +0900909
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100910 let metadata = fs::metadata(&path).with_context(|| format!("Unable to access {}", path))?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900911 if !metadata.is_file() {
912 bail!("{} is not a file", &path);
913 }
914
915 Ok(path)
916}
Jiyong Park21ce2c52021-08-28 02:32:17 +0900917
918fn to_hex_string(buf: &[u8]) -> String {
919 buf.iter().map(|b| format!("{:02X}", b)).collect()
920}
Shikha Panwar566c9672022-11-15 14:39:58 +0000921
Shikha Panwar95084df2023-07-22 11:47:45 +0000922fn prepare_encryptedstore(vm_secret: &VmSecret) -> Result<Child> {
Alice Wang7e6c9352023-02-15 15:44:13 +0000923 let mut key = ZVec::new(ENCRYPTEDSTORE_KEYSIZE)?;
Shikha Panwar3d3a70a2023-08-21 20:02:08 +0000924 vm_secret.derive_encryptedstore_key(&mut key)?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000925 let mut cmd = Command::new(ENCRYPTEDSTORE_BIN);
926 cmd.arg("--blkdevice")
927 .arg(ENCRYPTEDSTORE_BACKING_DEVICE)
928 .arg("--key")
929 .arg(hex::encode(&*key))
Shikha Panwar9fd198f2022-11-18 17:43:43 +0000930 .args(["--mountpoint", ENCRYPTEDSTORE_MOUNTPOINT])
Shikha Panwar566c9672022-11-15 14:39:58 +0000931 .spawn()
932 .context("encryptedstore failed")
933}