blob: a496d534ba3c35a94f0ce8c05bde47b9ad7eec4a [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
Pierre-Clément Tosid225af52023-09-15 15:59:20 +0100147 for chunk in death_reason.as_bytes().chunks(16) {
Inseob Kim11f40d02022-06-13 17:16:00 +0900148 // TODO(b/220071963): Sometimes, sending more than 16 bytes at once makes MM hang.
Pierre-Clément Tosid225af52023-09-15 15:59:20 +0100149 OpenOptions::new().read(false).write(true).open(FAILURE_SERIAL_DEVICE)?.write_all(chunk)?;
Inseob Kim11f40d02022-06-13 17:16:00 +0900150 }
151
152 Ok(())
153}
154
Inseob Kim1b95f2e2021-08-19 13:17:40 +0900155fn get_vms_rpc_binder() -> Result<Strong<dyn IVirtualMachineService>> {
David Brazdil73988ea2022-11-11 15:10:32 +0000156 // The host is running a VirtualMachineService for this VM on a port equal
157 // to the CID of this VM.
158 let port = vsock::get_local_cid().context("Could not determine local CID")?;
David Brazdila2125dd2022-12-14 16:37:44 +0000159 RpcSession::new()
160 .setup_vsock_client(VMADDR_CID_HOST, port)
David Brazdil73988ea2022-11-11 15:10:32 +0000161 .context("Could not connect to IVirtualMachineService")
Inseob Kim1b95f2e2021-08-19 13:17:40 +0900162}
163
Inseob Kim437f1052022-06-21 11:30:22 +0900164fn main() -> Result<()> {
Inseob Kim7ff121c2022-11-14 18:13:23 +0900165 // If debuggable, print full backtrace to console log with stdio_to_kmsg
Seungjae Yoofa22bb02022-12-08 16:38:42 +0900166 if system_properties::read_bool(DEBUGGABLE_PROP, true)? {
Inseob Kim7ff121c2022-11-14 18:13:23 +0900167 env::set_var("RUST_BACKTRACE", "full");
168 }
169
Inseob Kim437f1052022-06-21 11:30:22 +0900170 scopeguard::defer! {
171 info!("Shutting down...");
Jooyung Hanbfe086f2021-10-28 10:15:45 +0900172 if let Err(e) = system_properties::write("sys.powerctl", "shutdown") {
173 error!("failed to shutdown {:?}", e);
174 }
Jooyung Han311b1202021-09-14 22:00:16 +0900175 }
Inseob Kim437f1052022-06-21 11:30:22 +0900176
177 try_main().map_err(|e| {
178 error!("Failed with {:?}.", e);
179 if let Err(e) = write_death_reason_to_serial(&e) {
180 error!("Failed to write death reason {:?}", e);
181 }
182 e
183 })
Jooyung Han311b1202021-09-14 22:00:16 +0900184}
185
Alice Wangfd222fd2023-05-25 09:37:38 +0000186/// Prepares a socket file descriptor for the vm payload service.
187///
Andrew Walbranae3350d2023-07-21 19:01:18 +0100188/// # Safety
Alice Wangfd222fd2023-05-25 09:37:38 +0000189///
190/// The caller must ensure that this function is the only place that claims ownership
191/// of the file descriptor and it is called only once.
192unsafe fn prepare_vm_payload_service_socket() -> Result<OwnedFd> {
193 let raw_fd = android_get_control_socket(VM_PAYLOAD_SERVICE_SOCKET_NAME)?;
Inseob Kim090b70b2022-11-16 20:01:14 +0900194
Alice Wangfd222fd2023-05-25 09:37:38 +0000195 // Creating OwnedFd for stdio FDs is not safe.
196 if [libc::STDIN_FILENO, libc::STDOUT_FILENO, libc::STDERR_FILENO].contains(&raw_fd) {
197 bail!("File descriptor {raw_fd} is standard I/O descriptor");
198 }
199 // SAFETY: Initializing OwnedFd for a RawFd created by the init.
200 // We checked that the integer value corresponds to a valid FD and that the caller
201 // ensures that this is the only place to claim its ownership.
202 Ok(unsafe { OwnedFd::from_raw_fd(raw_fd) })
Inseob Kim090b70b2022-11-16 20:01:14 +0900203}
204
Jooyung Han311b1202021-09-14 22:00:16 +0900205fn try_main() -> Result<()> {
Jiyong Park2b6346d2023-06-19 13:37:42 +0900206 android_logger::init_once(
207 android_logger::Config::default()
208 .with_tag("microdroid_manager")
209 .with_min_level(log::Level::Info),
210 );
Jooyung Han347d9f22021-05-28 00:05:14 +0900211 info!("started.");
212
Alice Wangfd222fd2023-05-25 09:37:38 +0000213 // SAFETY: This is the only place we take the ownership of the fd of the vm payload service.
214 //
Alice Wang2a5306e2023-06-05 09:18:32 +0000215 // To ensure that the CLOEXEC flag is set on the file descriptor as early as possible,
216 // it is necessary to fetch the socket corresponding to vm_payload_service at the
217 // very beginning, as android_get_control_socket() sets the CLOEXEC flag on the file
218 // descriptor.
Alice Wangfd222fd2023-05-25 09:37:38 +0000219 let vm_payload_service_fd = unsafe { prepare_vm_payload_service_socket()? };
Inseob Kim090b70b2022-11-16 20:01:14 +0900220
Jiyong Park202856e2022-08-22 16:04:26 +0900221 load_crashkernel_if_supported().context("Failed to load crashkernel")?;
222
Alice Wangeff58392023-07-04 13:32:09 +0000223 swap::init_swap().context("Failed to initialize swap")?;
Keir Fraser933f0ac2022-10-12 08:23:28 +0000224 info!("swap enabled.");
225
Inseob Kim11f40d02022-06-13 17:16:00 +0900226 let service = get_vms_rpc_binder()
227 .context("cannot connect to VirtualMachineService")
228 .map_err(|e| MicrodroidError::FailedToConnectToVirtualizationService(e.to_string()))?;
Seungjae Yoofd9a0622022-10-14 10:01:29 +0900229
Alice Wangfd222fd2023-05-25 09:37:38 +0000230 match try_run_payload(&service, vm_payload_service_fd) {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900231 Ok(code) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900232 if code == 0 {
233 info!("task successfully finished");
234 } else {
235 error!("task exited with exit code: {}", code);
236 }
Shikha Panwardef7ef92023-01-06 08:35:48 +0000237 if let Err(e) = post_payload_work() {
238 error!(
239 "Failed to run post payload work. It is possible that certain tasks
240 like syncing encrypted store might be incomplete. Error: {:?}",
241 e
242 );
243 };
244
245 info!("notifying payload finished");
246 service.notifyPayloadFinished(code)?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900247 Ok(())
248 }
249 Err(err) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900250 let (error_code, message) = translate_error(&err);
251 service.notifyError(error_code, &message)?;
252 Err(err)
253 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900254 }
255}
256
Shikha Panwardef7ef92023-01-06 08:35:48 +0000257fn post_payload_work() -> Result<()> {
258 // Sync the encrypted storage filesystem (flushes the filesystem caches).
259 if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
260 let mountpoint = CString::new(ENCRYPTEDSTORE_MOUNTPOINT).unwrap();
261
Andrew Walbranae3350d2023-07-21 19:01:18 +0100262 // SAFETY: `mountpoint` is a valid C string. `syncfs` and `close` are safe for any parameter
263 // values.
Shikha Panwardef7ef92023-01-06 08:35:48 +0000264 let ret = unsafe {
265 let dirfd = libc::open(
266 mountpoint.as_ptr(),
267 libc::O_DIRECTORY | libc::O_RDONLY | libc::O_CLOEXEC,
268 );
269 ensure!(dirfd >= 0, "Unable to open {:?}", mountpoint);
270 let ret = libc::syncfs(dirfd);
271 libc::close(dirfd);
272 ret
273 };
274 if ret != 0 {
275 error!("failed to sync encrypted storage.");
276 return Err(anyhow!(std::io::Error::last_os_error()));
277 }
278 }
279 Ok(())
280}
Alan Stokes1f417c92022-09-29 15:13:28 +0100281fn dice_derivation(
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000282 dice: DiceDriver,
Alan Stokes1f417c92022-09-29 15:13:28 +0100283 verified_data: &MicrodroidData,
284 payload_metadata: &PayloadMetadata,
Alice Wang62f7e642023-02-10 09:55:13 +0000285) -> Result<OwnedDiceArtifacts> {
Andrew Scullb2f44472022-01-21 14:41:34 +0000286 // Calculate compound digests of code and authorities
Andrew Sculla0d1b1a2022-05-24 19:32:47 +0000287 let mut code_hash_ctx = Sha512::new();
288 let mut authority_hash_ctx = Sha512::new();
Andrew Scullb2f44472022-01-21 14:41:34 +0000289 code_hash_ctx.update(verified_data.apk_data.root_hash.as_ref());
290 authority_hash_ctx.update(verified_data.apk_data.pubkey.as_ref());
Inseob Kimb2519c52022-04-14 02:10:09 +0900291 for extra_apk in &verified_data.extra_apks_data {
Andrew Scullb2f44472022-01-21 14:41:34 +0000292 code_hash_ctx.update(extra_apk.root_hash.as_ref());
293 authority_hash_ctx.update(extra_apk.pubkey.as_ref());
294 }
Inseob Kimb2519c52022-04-14 02:10:09 +0900295 for apex in &verified_data.apex_data {
Andrew Scullb2f44472022-01-21 14:41:34 +0000296 code_hash_ctx.update(apex.root_digest.as_ref());
297 authority_hash_ctx.update(apex.public_key.as_ref());
298 }
Andrew Sculla0d1b1a2022-05-24 19:32:47 +0000299 let code_hash = code_hash_ctx.finish();
300 let authority_hash = authority_hash_ctx.finish();
Andrew Scullb2f44472022-01-21 14:41:34 +0000301
Alice Wang285a3d22023-03-01 11:36:29 +0000302 let config_descriptor = format_payload_config_descriptor(payload_metadata)?;
Andrew Scullb2f44472022-01-21 14:41:34 +0000303
Seungjae Yoofa22bb02022-12-08 16:38:42 +0900304 // Check debuggability, conservatively assuming it is debuggable
305 let debuggable = system_properties::read_bool(DEBUGGABLE_PROP, true)?;
Andrew Scull65ddfc42022-02-14 21:03:58 +0000306
Andrew Scullb2f44472022-01-21 14:41:34 +0000307 // Send the details to diced
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000308 let hidden = verified_data.salt.clone().try_into().unwrap();
Alice Wang285a3d22023-03-01 11:36:29 +0000309 dice.derive(code_hash, &config_descriptor, authority_hash, debuggable, hidden)
Alan Stokes1f417c92022-09-29 15:13:28 +0100310}
311
Andrew Scullab72ec52022-03-14 09:10:52 +0000312fn is_strict_boot() -> bool {
313 Path::new(AVF_STRICT_BOOT).exists()
314}
315
316fn is_new_instance() -> bool {
317 Path::new(AVF_NEW_INSTANCE).exists()
318}
319
Inseob Kime379e7d2022-07-22 18:55:18 +0900320fn is_verified_boot() -> bool {
321 !Path::new(DEBUG_MICRODROID_NO_VERIFIED_BOOT).exists()
322}
323
Inseob Kimab1037d2023-02-08 17:03:31 +0900324fn should_export_tombstones(config: &VmPayloadConfig) -> bool {
325 match config.export_tombstones {
326 Some(b) => b,
327 None => system_properties::read_bool(DEBUGGABLE_PROP, true).unwrap_or(false),
328 }
329}
330
Jaewan Kim3124ef02023-03-23 19:25:20 +0900331/// Get debug policy value in bool. It's true iff the value is explicitly set to <1>.
332fn get_debug_policy_bool(path: &'static str) -> Result<Option<bool>> {
333 let mut file = match File::open(path) {
334 Ok(dp) => dp,
335 Err(e) => {
Jaewan Kim476ecd42023-08-28 05:57:00 +0000336 info!(
337 "Assumes that debug policy is disabled because failed to read debug policy ({e:?})"
338 );
Jaewan Kim3124ef02023-03-23 19:25:20 +0900339 return Ok(Some(false));
340 }
341 };
342 let mut log: [u8; 4] = Default::default();
343 file.read_exact(&mut log).context("Malformed data in {path}")?;
344 // DT spec uses big endian although Android is always little endian.
345 Ok(Some(u32::from_be_bytes(log) == 1))
346}
347
Alice Wangfd222fd2023-05-25 09:37:38 +0000348fn try_run_payload(
349 service: &Strong<dyn IVirtualMachineService>,
350 vm_payload_service_fd: OwnedFd,
351) -> Result<i32> {
Jooyung Han311b1202021-09-14 22:00:16 +0900352 let metadata = load_metadata().context("Failed to load payload metadata")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000353 let dice = DiceDriver::new(Path::new("/dev/open-dice0")).context("Failed to load DICE")?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900354
Jooyung Han311b1202021-09-14 22:00:16 +0900355 let mut instance = InstanceDisk::new().context("Failed to load instance.img")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000356 let saved_data =
357 instance.read_microdroid_data(&dice).context("Failed to read identity data")?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900358
Andrew Scullab72ec52022-03-14 09:10:52 +0000359 if is_strict_boot() {
360 // Provisioning must happen on the first boot and never again.
361 if is_new_instance() {
362 ensure!(
363 saved_data.is_none(),
364 MicrodroidError::InvalidConfig("Found instance data on first boot.".to_string())
365 );
366 } else {
367 ensure!(
368 saved_data.is_some(),
369 MicrodroidError::InvalidConfig("Instance data not found.".to_string())
370 );
371 };
372 }
373
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900374 // Verify the payload before using it.
Inseob Kim11f40d02022-06-13 17:16:00 +0900375 let verified_data = verify_payload(&metadata, saved_data.as_ref())
376 .context("Payload verification failed")
377 .map_err(|e| MicrodroidError::PayloadVerificationFailed(e.to_string()))?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900378
379 // In case identity is ignored (by debug policy), we should reuse existing payload data, even
380 // when the payload is changed. This is to keep the derived secret same as before.
381 let verified_data = if let Some(saved_data) = saved_data {
382 if !is_verified_boot() {
383 if saved_data != verified_data {
384 info!("Detected an update of the payload, but continue (regarding debug policy)")
385 }
386 } else {
387 ensure!(
388 saved_data == verified_data,
389 MicrodroidError::PayloadChanged(String::from(
390 "Detected an update of the payload which isn't supported yet."
391 ))
392 );
393 info!("Saved data is verified.");
394 }
395 saved_data
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900396 } else {
Jooyung Han7a343f92021-09-08 22:53:11 +0900397 info!("Saving verified data.");
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000398 instance
399 .write_microdroid_data(&verified_data, &dice)
400 .context("Failed to write identity data")?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900401 verified_data
402 };
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900403
Alan Stokes1f417c92022-09-29 15:13:28 +0100404 let payload_metadata = metadata.payload.ok_or_else(|| {
405 MicrodroidError::InvalidConfig("No payload config in metadata".to_string())
406 })?;
Alan Stokes0d1ef782022-09-27 13:46:35 +0100407
Inseob Kimb2519c52022-04-14 02:10:09 +0900408 // To minimize the exposure to untrusted data, derive dice profile as soon as possible.
409 info!("DICE derivation for payload");
Alice Wang62f7e642023-02-10 09:55:13 +0000410 let dice_artifacts = dice_derivation(dice, &verified_data, &payload_metadata)?;
Shikha Panwar95084df2023-07-22 11:47:45 +0000411 let vm_secret = VmSecret::new(dice_artifacts).context("Failed to create VM secrets")?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000412
413 // Run encryptedstore binary to prepare the storage
414 let encryptedstore_child = if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
415 info!("Preparing encryptedstore ...");
Shikha Panwar95084df2023-07-22 11:47:45 +0000416 Some(prepare_encryptedstore(&vm_secret).context("encryptedstore run")?)
Shikha Panwar566c9672022-11-15 14:39:58 +0000417 } else {
418 None
419 };
Inseob Kimb2519c52022-04-14 02:10:09 +0900420
Alan Stokes960c9032022-12-07 16:53:45 +0000421 let mut zipfuse = Zipfuse::default();
422
Jooyung Hana6d11eb2021-09-10 11:48:05 +0900423 // Before reading a file from the APK, start zipfuse
Alan Stokes960c9032022-12-07 16:53:45 +0000424 zipfuse.mount(
Alan Stokes60f82202022-10-07 16:40:07 +0100425 MountForExec::Allowed,
Inseob Kim217038e2021-11-25 11:15:06 +0900426 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:system_file:s0",
427 Path::new("/dev/block/mapper/microdroid-apk"),
Alice Wang6bbb6da2022-10-26 12:44:06 +0000428 Path::new(VM_APK_CONTENTS_PATH),
Alan Stokes960c9032022-12-07 16:53:45 +0000429 "microdroid_manager.apk.mounted".to_owned(),
430 )?;
Jiyong Park21ce2c52021-08-28 02:32:17 +0900431
Andrew Scull4d262dc2022-10-21 13:14:33 +0000432 // Restricted APIs are only allowed to be used by platform or test components. Infer this from
433 // the use of a VM config file since those can only be used by platform and test components.
434 let allow_restricted_apis = match payload_metadata {
Ludovic Barman93ee3082023-06-20 12:18:43 +0000435 PayloadMetadata::ConfigPath(_) => true,
436 PayloadMetadata::Config(_) => false,
437 _ => false, // default is false for safety
Andrew Scull4d262dc2022-10-21 13:14:33 +0000438 };
439
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100440 let config = load_config(payload_metadata).context("Failed to load payload metadata")?;
Shikha Panwar6f03c942022-04-13 20:26:50 +0000441
Alan Stokes01b3ef02022-09-22 17:43:24 +0100442 let task = config
443 .task
444 .as_ref()
445 .ok_or_else(|| MicrodroidError::InvalidConfig("No task in VM config".to_string()))?;
446
Alice Wang061478b2023-04-11 13:26:17 +0000447 ensure!(
448 config.extra_apks.len() == verified_data.extra_apks_data.len(),
449 "config expects {} extra apks, but found {}",
450 config.extra_apks.len(),
451 verified_data.extra_apks_data.len()
452 );
Alan Stokes960c9032022-12-07 16:53:45 +0000453 mount_extra_apks(&config, &mut zipfuse)?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900454
Jooyung Han5c6d4172021-12-06 14:17:52 +0900455 // Wait until apex config is done. (e.g. linker configuration for apexes)
Jooyung Han5c6d4172021-12-06 14:17:52 +0900456 wait_for_apex_config_done()?;
457
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000458 setup_config_sysprops(&config)?;
459
Shikha Panwar1a6efcd2023-02-03 19:23:43 +0000460 // Set export_tombstones if enabled
Inseob Kimab1037d2023-02-08 17:03:31 +0900461 if should_export_tombstones(&config) {
Shikha Panwar1a6efcd2023-02-03 19:23:43 +0000462 // This property is read by tombstone_handler.
463 system_properties::write("microdroid_manager.export_tombstones.enabled", "1")
464 .context("set microdroid_manager.export_tombstones.enabled")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900465 }
466
Alan Stokes960c9032022-12-07 16:53:45 +0000467 // Wait until zipfuse has mounted the APKs so we can access the payload
468 zipfuse.wait_until_done()?;
Alan Stokes60f82202022-10-07 16:40:07 +0100469
Alice Wangfd222fd2023-05-25 09:37:38 +0000470 register_vm_payload_service(
471 allow_restricted_apis,
472 service.clone(),
Shikha Panwar95084df2023-07-22 11:47:45 +0000473 vm_secret,
Alice Wangfd222fd2023-05-25 09:37:38 +0000474 vm_payload_service_fd,
475 )?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000476
Shikha Panwarddc124b2022-11-28 19:17:54 +0000477 // Wait for encryptedstore to finish mounting the storage (if enabled) before setting
478 // microdroid_manager.init_done. Reason is init stops uneventd after that.
479 // Encryptedstore, however requires ueventd
Shikha Panwar566c9672022-11-15 14:39:58 +0000480 if let Some(mut child) = encryptedstore_child {
481 let exitcode = child.wait().context("Wait for encryptedstore child")?;
482 ensure!(exitcode.success(), "Unable to prepare encrypted storage. Exitcode={}", exitcode);
483 }
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100484
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000485 wait_for_property_true("dev.bootcomplete").context("failed waiting for dev.bootcomplete")?;
Shikha Panwar3f6f6a52022-11-29 17:28:36 +0000486 system_properties::write("microdroid_manager.init_done", "1")
487 .context("set microdroid_manager.init_done")?;
Inseob Kimc16b0cc2023-01-26 14:57:24 +0900488
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000489 info!("boot completed, time to run payload");
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100490 exec_task(task, service).context("Failed to run payload")
Alan Stokes01b3ef02022-09-22 17:43:24 +0100491}
492
Inseob Kim217038e2021-11-25 11:15:06 +0900493struct ApkDmverityArgument<'a> {
494 apk: &'a str,
495 idsig: &'a str,
496 name: &'a str,
Inseob Kim197748b2021-12-01 19:49:00 +0900497 saved_root_hash: Option<&'a RootHash>,
Inseob Kim217038e2021-11-25 11:15:06 +0900498}
499
500fn run_apkdmverity(args: &[ApkDmverityArgument]) -> Result<Child> {
501 let mut cmd = Command::new(APKDMVERITY_BIN);
502
Inseob Kim217038e2021-11-25 11:15:06 +0900503 for argument in args {
504 cmd.arg("--apk").arg(argument.apk).arg(argument.idsig).arg(argument.name);
Inseob Kim197748b2021-12-01 19:49:00 +0900505 if let Some(root_hash) = argument.saved_root_hash {
506 cmd.arg(&to_hex_string(root_hash));
507 } else {
508 cmd.arg("none");
509 }
Inseob Kim217038e2021-11-25 11:15:06 +0900510 }
511
512 cmd.spawn().context("Spawn apkdmverity")
513}
514
Alan Stokes60f82202022-10-07 16:40:07 +0100515enum MountForExec {
516 Allowed,
517 Disallowed,
518}
519
Alan Stokes960c9032022-12-07 16:53:45 +0000520#[derive(Default)]
521struct Zipfuse {
522 ready_properties: Vec<String>,
523}
524
525impl Zipfuse {
526 fn mount(
527 &mut self,
528 noexec: MountForExec,
529 option: &str,
530 zip_path: &Path,
531 mount_dir: &Path,
532 ready_prop: String,
533 ) -> Result<Child> {
534 let mut cmd = Command::new(ZIPFUSE_BIN);
535 if let MountForExec::Disallowed = noexec {
536 cmd.arg("--noexec");
537 }
Alan Stokes1294f942023-08-21 14:34:12 +0100538 // Let root own the files in APK, so we can access them, but set the group to
539 // allow all payloads to have access too.
540 let (uid, gid) = (microdroid_uids::ROOT_UID, microdroid_uids::MICRODROID_PAYLOAD_GID);
541
Alan Stokes960c9032022-12-07 16:53:45 +0000542 cmd.args(["-p", &ready_prop, "-o", option]);
Alan Stokes1294f942023-08-21 14:34:12 +0100543 cmd.args(["-u", &uid.to_string()]);
544 cmd.args(["-g", &gid.to_string()]);
Alan Stokes960c9032022-12-07 16:53:45 +0000545 cmd.arg(zip_path).arg(mount_dir);
546 self.ready_properties.push(ready_prop);
547 cmd.spawn().with_context(|| format!("Failed to run zipfuse for {mount_dir:?}"))
Andrew Scullcc339a12022-07-04 12:44:19 +0000548 }
Alan Stokes960c9032022-12-07 16:53:45 +0000549
550 fn wait_until_done(self) -> Result<()> {
551 // We check the last-started check first in the hope that by the time it is done
552 // all or most of the others will also be done, minimising the number of times we
553 // block on a property.
554 for property in self.ready_properties.into_iter().rev() {
555 wait_for_property_true(&property)
556 .with_context(|| format!("Failed waiting for {property}"))?;
557 }
558 Ok(())
Alan Stokes60f82202022-10-07 16:40:07 +0100559 }
Inseob Kim217038e2021-11-25 11:15:06 +0900560}
561
Inseob Kime379e7d2022-07-22 18:55:18 +0900562fn write_apex_payload_data(
563 saved_data: Option<&MicrodroidData>,
564 apex_data_from_payload: &[ApexData],
565) -> Result<()> {
566 if let Some(saved_apex_data) = saved_data.map(|d| &d.apex_data) {
567 // We don't support APEX updates. (assuming that update will change root digest)
568 ensure!(
569 saved_apex_data == apex_data_from_payload,
570 MicrodroidError::PayloadChanged(String::from("APEXes have changed."))
571 );
572 let apex_metadata = to_metadata(apex_data_from_payload);
573 // Pass metadata(with public keys and root digests) to apexd so that it uses the passed
574 // metadata instead of the default one (/dev/block/by-name/payload-metadata)
575 OpenOptions::new()
576 .create_new(true)
577 .write(true)
578 .open("/apex/vm-payload-metadata")
579 .context("Failed to open /apex/vm-payload-metadata")
580 .and_then(|f| write_metadata(&apex_metadata, f))?;
581 }
582 Ok(())
583}
584
Jooyung Han7a343f92021-09-08 22:53:11 +0900585// Verify payload before executing it. For APK payload, Full verification (which is slow) is done
586// when the root_hash values from the idsig file and the instance disk are different. This function
587// returns the verified root hash (for APK payload) and pubkeys (for APEX payloads) that can be
588// saved to the instance disk.
589fn verify_payload(
590 metadata: &Metadata,
591 saved_data: Option<&MicrodroidData>,
592) -> Result<MicrodroidData> {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900593 let start_time = SystemTime::now();
594
Inseob Kim197748b2021-12-01 19:49:00 +0900595 // Verify main APK
Inseob Kim197748b2021-12-01 19:49:00 +0900596 let root_hash_from_idsig = get_apk_root_hash_from_idsig(MAIN_APK_IDSIG_PATH)?;
Alice Wang061478b2023-04-11 13:26:17 +0000597 let root_hash_trustful =
598 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 +0900599
Jiyong Parkf7dea252021-09-08 01:42:54 +0900600 // 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 +0900601 // instead of the value read from the idsig file.
Inseob Kim197748b2021-12-01 19:49:00 +0900602 let main_apk_argument = {
603 ApkDmverityArgument {
604 apk: MAIN_APK_PATH,
605 idsig: MAIN_APK_IDSIG_PATH,
606 name: MAIN_APK_DEVICE_NAME,
607 saved_root_hash: if root_hash_trustful {
608 Some(root_hash_from_idsig.as_ref())
609 } else {
610 None
611 },
612 }
613 };
614 let mut apkdmverity_arguments = vec![main_apk_argument];
615
616 // Verify extra APKs
617 // For now, we can't read the payload config, so glob APKs and idsigs.
618 // Later, we'll see if it matches with the payload config.
619
620 // sort globbed paths to match apks (extra-apk-{idx}) and idsigs (extra-idsig-{idx})
621 // e.g. "extra-apk-0" corresponds to "extra-idsig-0"
622 let extra_apks =
623 sorted(glob(EXTRA_APK_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
624 let extra_idsigs =
625 sorted(glob(EXTRA_IDSIG_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
Alice Wang061478b2023-04-11 13:26:17 +0000626 ensure!(
627 extra_apks.len() == extra_idsigs.len(),
628 "Extra apks/idsigs mismatch: {} apks but {} idsigs",
629 extra_apks.len(),
630 extra_idsigs.len()
631 );
Inseob Kim197748b2021-12-01 19:49:00 +0900632
Alice Wang061478b2023-04-11 13:26:17 +0000633 let extra_root_hashes_from_idsig: Vec<_> = extra_idsigs
Inseob Kim197748b2021-12-01 19:49:00 +0900634 .iter()
Alice Wang061478b2023-04-11 13:26:17 +0000635 .map(|idsig| {
636 get_apk_root_hash_from_idsig(idsig).expect("Can't find root hash from extra idsig")
Inseob Kim197748b2021-12-01 19:49:00 +0900637 })
638 .collect();
639
Alice Wang061478b2023-04-11 13:26:17 +0000640 let extra_root_hashes_trustful: Vec<_> = if let Some(data) = saved_data {
641 extra_root_hashes_from_idsig
642 .iter()
643 .enumerate()
644 .map(|(i, root_hash)| data.extra_apk_root_hash_eq(i, root_hash))
645 .collect()
646 } else {
647 vec![false; extra_root_hashes_from_idsig.len()]
648 };
649 let extra_apk_names: Vec<_> =
650 (0..extra_apks.len()).map(|i| format!("extra-apk-{}", i)).collect();
651
652 for (i, extra_apk) in extra_apks.iter().enumerate() {
Inseob Kim197748b2021-12-01 19:49:00 +0900653 apkdmverity_arguments.push({
654 ApkDmverityArgument {
Alice Wang061478b2023-04-11 13:26:17 +0000655 apk: extra_apk.to_str().unwrap(),
Inseob Kim197748b2021-12-01 19:49:00 +0900656 idsig: extra_idsigs[i].to_str().unwrap(),
657 name: &extra_apk_names[i],
658 saved_root_hash: if extra_root_hashes_trustful[i] {
659 Some(&extra_root_hashes_from_idsig[i])
660 } else {
661 None
662 },
663 }
664 });
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900665 }
666
667 // Start apkdmverity and wait for the dm-verify block
Inseob Kim197748b2021-12-01 19:49:00 +0900668 let mut apkdmverity_child = run_apkdmverity(&apkdmverity_arguments)?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900669
Jooyung Hanc8deb472021-09-13 13:48:25 +0900670 // While waiting for apkdmverity to mount APK, gathers public keys and root digests from
671 // APEX payload.
Jooyung Han7a343f92021-09-08 22:53:11 +0900672 let apex_data_from_payload = get_apex_data_from_payload(metadata)?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900673
674 // Writing /apex/vm-payload-metadata is to verify that the payload isn't changed.
675 // Skip writing it if the debug policy ignoring identity is on
676 if is_verified_boot() {
677 write_apex_payload_data(saved_data, &apex_data_from_payload)?;
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900678 }
Inseob Kime379e7d2022-07-22 18:55:18 +0900679
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900680 // Start apexd to activate APEXes
681 system_properties::write("ctl.start", "apexd-vm")?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900682
Inseob Kim217038e2021-11-25 11:15:06 +0900683 // TODO(inseob): add timeout
684 apkdmverity_child.wait()?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900685
Jiyong Parkf7dea252021-09-08 01:42:54 +0900686 // Do the full verification if the root_hash is un-trustful. This requires the full scanning of
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900687 // 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 +0900688 // 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 +0900689 // of the VM or APK was updated in the host.
690 // TODO(jooyung): consider multithreading to make this faster
Inseob Kim197748b2021-12-01 19:49:00 +0900691 let main_apk_pubkey = get_public_key_from_apk(DM_MOUNTED_APK_PATH, root_hash_trustful)?;
692 let extra_apks_data = extra_root_hashes_from_idsig
693 .into_iter()
694 .enumerate()
695 .map(|(i, extra_root_hash)| {
696 let mount_path = format!("/dev/block/mapper/{}", &extra_apk_names[i]);
697 let apk_pubkey = get_public_key_from_apk(&mount_path, extra_root_hashes_trustful[i])?;
698 Ok(ApkData { root_hash: extra_root_hash, pubkey: apk_pubkey })
699 })
700 .collect::<Result<Vec<_>>>()?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900701
702 info!("payload verification successful. took {:#?}", start_time.elapsed().unwrap());
703
Andrew Scull34916a72022-01-30 21:34:24 +0000704 // Use the salt from a verified instance, or generate a salt for a new instance.
705 let salt = if let Some(saved_data) = saved_data {
706 saved_data.salt.clone()
Pierre-Clément Tosicecb0aa2023-02-08 16:57:54 +0000707 } else if is_strict_boot() {
708 // No need to add more entropy as a previous stage must have used a new, random salt.
709 vec![0u8; 64]
Andrew Scull34916a72022-01-30 21:34:24 +0000710 } else {
711 let mut salt = vec![0u8; 64];
712 salt.as_mut_slice().try_fill(&mut rand::thread_rng())?;
713 salt
714 };
715
Jiyong Parkf7dea252021-09-08 01:42:54 +0900716 // At this point, we can ensure that the root_hash from the idsig file is trusted, either by
717 // fully verifying the APK or by comparing it with the saved root_hash.
Jooyung Han7a343f92021-09-08 22:53:11 +0900718 Ok(MicrodroidData {
Andrew Scull34916a72022-01-30 21:34:24 +0000719 salt,
Inseob Kim197748b2021-12-01 19:49:00 +0900720 apk_data: ApkData { root_hash: root_hash_from_idsig, pubkey: main_apk_pubkey },
721 extra_apks_data,
Jooyung Han7a343f92021-09-08 22:53:11 +0900722 apex_data: apex_data_from_payload,
723 })
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900724}
725
Alan Stokes960c9032022-12-07 16:53:45 +0000726fn mount_extra_apks(config: &VmPayloadConfig, zipfuse: &mut Zipfuse) -> Result<()> {
Inseob Kim197748b2021-12-01 19:49:00 +0900727 // For now, only the number of apks is important, as the mount point and dm-verity name is fixed
728 for i in 0..config.extra_apks.len() {
Alan Stokes960c9032022-12-07 16:53:45 +0000729 let mount_dir = format!("/mnt/extra-apk/{i}");
Inseob Kim197748b2021-12-01 19:49:00 +0900730 create_dir(Path::new(&mount_dir)).context("Failed to create mount dir for extra apks")?;
731
732 // don't wait, just detach
Alan Stokes960c9032022-12-07 16:53:45 +0000733 zipfuse.mount(
Alan Stokes60f82202022-10-07 16:40:07 +0100734 MountForExec::Disallowed,
Inseob Kim197748b2021-12-01 19:49:00 +0900735 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:extra_apk_file:s0",
Alan Stokes960c9032022-12-07 16:53:45 +0000736 Path::new(&format!("/dev/block/mapper/extra-apk-{i}")),
Inseob Kim197748b2021-12-01 19:49:00 +0900737 Path::new(&mount_dir),
Alan Stokes960c9032022-12-07 16:53:45 +0000738 format!("microdroid_manager.extra_apk.mounted.{i}"),
739 )?;
Inseob Kim197748b2021-12-01 19:49:00 +0900740 }
741
742 Ok(())
743}
744
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000745fn setup_config_sysprops(config: &VmPayloadConfig) -> Result<()> {
746 if config.enable_authfs {
747 system_properties::write("microdroid_manager.authfs.enabled", "1")
748 .context("failed to write microdroid_manager.authfs.enabled")?;
749 }
750 system_properties::write("microdroid_manager.config_done", "1")
751 .context("failed to write microdroid_manager.config_done")?;
752 Ok(())
753}
754
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900755// Waits until linker config is generated
756fn wait_for_apex_config_done() -> Result<()> {
Alan Stokes60f82202022-10-07 16:40:07 +0100757 wait_for_property_true(APEX_CONFIG_DONE_PROP).context("Failed waiting for apex config done")
758}
759
760fn wait_for_property_true(property_name: &str) -> Result<()> {
761 let mut prop = PropertyWatcher::new(property_name)?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900762 loop {
Andrew Walbrand9c766e2023-05-10 15:15:39 +0000763 prop.wait(None)?;
Alan Stokes60f82202022-10-07 16:40:07 +0100764 if system_properties::read_bool(property_name, false)? {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900765 break;
766 }
767 }
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900768 Ok(())
769}
770
Alice Wang89cff012022-09-26 10:05:16 +0000771fn get_apk_root_hash_from_idsig<P: AsRef<Path>>(idsig_path: P) -> Result<Box<RootHash>> {
772 Ok(V4Signature::from_idsig_path(idsig_path)?.hashing_info.raw_root_hash)
Jiyong Park21ce2c52021-08-28 02:32:17 +0900773}
774
Inseob Kim197748b2021-12-01 19:49:00 +0900775fn get_public_key_from_apk(apk: &str, root_hash_trustful: bool) -> Result<Box<[u8]>> {
Alan Stokes25f69362023-03-06 16:51:54 +0000776 let current_sdk = get_current_sdk()?;
Inseob Kim197748b2021-12-01 19:49:00 +0900777 if !root_hash_trustful {
Alan Stokes25f69362023-03-06 16:51:54 +0000778 verify(apk, current_sdk).context(MicrodroidError::PayloadVerificationFailed(format!(
Inseob Kim197748b2021-12-01 19:49:00 +0900779 "failed to verify {}",
780 apk
781 )))
782 } else {
Alan Stokes25f69362023-03-06 16:51:54 +0000783 get_public_key_der(apk, current_sdk)
Inseob Kim197748b2021-12-01 19:49:00 +0900784 }
785}
786
Alan Stokes25f69362023-03-06 16:51:54 +0000787fn get_current_sdk() -> Result<u32> {
788 let current_sdk = system_properties::read("ro.build.version.sdk")?;
789 let current_sdk = current_sdk.ok_or_else(|| anyhow!("SDK version missing"))?;
790 current_sdk.parse().context("Malformed SDK version")
791}
792
Alan Stokes1f417c92022-09-29 15:13:28 +0100793fn load_config(payload_metadata: PayloadMetadata) -> Result<VmPayloadConfig> {
794 match payload_metadata {
Ludovic Barman93ee3082023-06-20 12:18:43 +0000795 PayloadMetadata::ConfigPath(path) => {
Alan Stokes1f417c92022-09-29 15:13:28 +0100796 let path = Path::new(&path);
797 info!("loading config from {:?}...", path);
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100798 let file = ioutil::wait_for_file(path, WAIT_TIMEOUT)
799 .with_context(|| format!("Failed to read {:?}", path))?;
Alan Stokes1f417c92022-09-29 15:13:28 +0100800 Ok(serde_json::from_reader(file)?)
801 }
Ludovic Barman93ee3082023-06-20 12:18:43 +0000802 PayloadMetadata::Config(payload_config) => {
Alan Stokes1f417c92022-09-29 15:13:28 +0100803 let task = Task {
804 type_: TaskType::MicrodroidLauncher,
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000805 command: payload_config.payload_binary_name,
Alan Stokes1f417c92022-09-29 15:13:28 +0100806 };
807 Ok(VmPayloadConfig {
808 os: OsConfig { name: "microdroid".to_owned() },
809 task: Some(task),
810 apexes: vec![],
811 extra_apks: vec![],
812 prefer_staged: false,
Inseob Kimab1037d2023-02-08 17:03:31 +0900813 export_tombstones: None,
Alan Stokes1f417c92022-09-29 15:13:28 +0100814 enable_authfs: false,
815 })
816 }
Ludovic Barman93ee3082023-06-20 12:18:43 +0000817 _ => bail!("Failed to match config against a config type."),
Alan Stokes1f417c92022-09-29 15:13:28 +0100818 }
Jooyung Han634e2d72021-06-10 16:27:38 +0900819}
820
Jaewan Kim3124ef02023-03-23 19:25:20 +0900821/// Loads the crashkernel into memory using kexec if debuggable or debug policy says so.
822/// The VM should be loaded with `crashkernel=' parameter in the cmdline to allocate memory
823/// for crashkernel.
Jiyong Park202856e2022-08-22 16:04:26 +0900824fn load_crashkernel_if_supported() -> Result<()> {
825 let supported = std::fs::read_to_string("/proc/cmdline")?.contains(" crashkernel=");
826 info!("ramdump supported: {}", supported);
Jaewan Kim3124ef02023-03-23 19:25:20 +0900827
828 if !supported {
829 return Ok(());
830 }
831
832 let debuggable = system_properties::read_bool(DEBUGGABLE_PROP, true)?;
833 let ramdump = get_debug_policy_bool(AVF_DEBUG_POLICY_RAMDUMP)?.unwrap_or_default();
834 let requested = debuggable | ramdump;
835
836 if requested {
Jiyong Park202856e2022-08-22 16:04:26 +0900837 let status = Command::new("/system/bin/kexec_load").status()?;
838 if !status.success() {
839 return Err(anyhow!("Failed to load crashkernel: {:?}", status));
840 }
Jaewan Kim3124ef02023-03-23 19:25:20 +0900841 info!("ramdump is loaded: debuggable={debuggable}, ramdump={ramdump}");
Jiyong Park202856e2022-08-22 16:04:26 +0900842 }
843 Ok(())
844}
845
Inseob Kim090b70b2022-11-16 20:01:14 +0900846/// Executes the given task.
Jooyung Han5c6d4172021-12-06 14:17:52 +0900847fn exec_task(task: &Task, service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900848 info!("executing main task {:?}...", task);
David Brazdil451cc962022-10-14 14:08:12 +0100849 let mut command = match task.type_ {
Alan Stokes1294f942023-08-21 14:34:12 +0100850 TaskType::Executable => {
Alan Stokes679ddf32023-09-01 11:14:48 +0100851 // TODO(b/297501338): Figure out how to handle non-root for system payloads.
Alan Stokes1294f942023-08-21 14:34:12 +0100852 Command::new(&task.command)
853 }
David Brazdil451cc962022-10-14 14:08:12 +0100854 TaskType::MicrodroidLauncher => {
855 let mut command = Command::new("/system/bin/microdroid_launcher");
856 command.arg(find_library_path(&task.command)?);
Alan Stokes1294f942023-08-21 14:34:12 +0100857 command.uid(microdroid_uids::MICRODROID_PAYLOAD_UID);
858 command.gid(microdroid_uids::MICRODROID_PAYLOAD_GID);
David Brazdil451cc962022-10-14 14:08:12 +0100859 command
860 }
861 };
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000862
Andrew Walbranaac68302023-07-21 19:05:34 +0100863 // SAFETY: We are not accessing any resource of the parent process. This means we can't make any
864 // log calls inside the closure.
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000865 unsafe {
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000866 command.pre_exec(|| {
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000867 // It is OK to continue with payload execution even if the calls below fail, since
868 // whether process can use a capability is controlled by the SELinux. Dropping the
869 // capabilities here is just another defense-in-depth layer.
Andrew Walbranaac68302023-07-21 19:05:34 +0100870 let _ = cap::drop_inheritable_caps();
871 let _ = cap::drop_bounding_set();
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000872 Ok(())
873 });
874 }
875
Inseob Kim090b70b2022-11-16 20:01:14 +0900876 command.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
Inseob Kim7f61fe72021-08-20 20:50:47 +0900877
878 info!("notifying payload started");
Inseob Kimc7d28c72021-10-25 14:28:10 +0000879 service.notifyPayloadStarted()?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900880
Inseob Kim86ca0162021-10-20 02:21:02 +0000881 let exit_status = command.spawn()?.wait()?;
Frederick Mayleb5f7b6b2022-11-11 15:24:03 -0800882 match exit_status.code() {
883 Some(exit_code) => Ok(exit_code),
884 None => Err(match exit_status.signal() {
885 Some(signal) => anyhow!(
886 "Payload exited due to signal: {} ({})",
887 signal,
888 Signal::try_from(signal).map_or("unknown", |s| s.as_str())
889 ),
890 None => anyhow!("Payload has neither exit code nor signal"),
891 }),
892 }
Jooyung Han347d9f22021-05-28 00:05:14 +0900893}
Jooyung Han634e2d72021-06-10 16:27:38 +0900894
Jooyung Han634e2d72021-06-10 16:27:38 +0900895fn find_library_path(name: &str) -> Result<String> {
896 let mut watcher = PropertyWatcher::new("ro.product.cpu.abilist")?;
897 let value = watcher.read(|_name, value| Ok(value.trim().to_string()))?;
898 let abi = value.split(',').next().ok_or_else(|| anyhow!("no abilist"))?;
Alice Wang6bbb6da2022-10-26 12:44:06 +0000899 let path = format!("{}/lib/{}/{}", VM_APK_CONTENTS_PATH, abi, name);
Jooyung Han634e2d72021-06-10 16:27:38 +0900900
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100901 let metadata = fs::metadata(&path).with_context(|| format!("Unable to access {}", path))?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900902 if !metadata.is_file() {
903 bail!("{} is not a file", &path);
904 }
905
906 Ok(path)
907}
Jiyong Park21ce2c52021-08-28 02:32:17 +0900908
909fn to_hex_string(buf: &[u8]) -> String {
910 buf.iter().map(|b| format!("{:02X}", b)).collect()
911}
Shikha Panwar566c9672022-11-15 14:39:58 +0000912
Shikha Panwar95084df2023-07-22 11:47:45 +0000913fn prepare_encryptedstore(vm_secret: &VmSecret) -> Result<Child> {
Alice Wang7e6c9352023-02-15 15:44:13 +0000914 let mut key = ZVec::new(ENCRYPTEDSTORE_KEYSIZE)?;
Shikha Panwar3d3a70a2023-08-21 20:02:08 +0000915 vm_secret.derive_encryptedstore_key(&mut key)?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000916 let mut cmd = Command::new(ENCRYPTEDSTORE_BIN);
917 cmd.arg("--blkdevice")
918 .arg(ENCRYPTEDSTORE_BACKING_DEVICE)
919 .arg("--key")
920 .arg(hex::encode(&*key))
Shikha Panwar9fd198f2022-11-18 17:43:43 +0000921 .args(["--mountpoint", ENCRYPTEDSTORE_MOUNTPOINT])
Shikha Panwar566c9672022-11-15 14:39:58 +0000922 .spawn()
923 .context("encryptedstore failed")
924}