blob: c78b20f5a36d76bcba47d0de3663787f3d58df11 [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;
Jooyung Han347d9f22021-05-28 00:05:14 +090023
Alice Wang285a3d22023-03-01 11:36:29 +000024use crate::dice::{DiceDriver, derive_sealing_key, format_payload_config_descriptor};
Inseob Kime379e7d2022-07-22 18:55:18 +090025use crate::instance::{ApexData, ApkData, InstanceDisk, MicrodroidData, RootHash};
Alice Wang59a9e562022-10-04 15:24:10 +000026use crate::vm_payload_service::register_vm_payload_service;
Alan Stokes2bead0d2022-09-05 16:58:34 +010027use android_system_virtualizationcommon::aidl::android::system::virtualizationcommon::ErrorCode::ErrorCode;
David Brazdil73988ea2022-11-11 15:10:32 +000028use android_system_virtualmachineservice::aidl::android::system::virtualmachineservice::IVirtualMachineService::IVirtualMachineService;
Inseob Kim090b70b2022-11-16 20:01:14 +090029use android_system_virtualization_payload::aidl::android::system::virtualization::payload::IVmPayloadService::{
30 VM_APK_CONTENTS_PATH,
31 VM_PAYLOAD_SERVICE_SOCKET_NAME,
Shikha Panwarddc124b2022-11-28 19:17:54 +000032 ENCRYPTEDSTORE_MOUNTPOINT,
Inseob Kim090b70b2022-11-16 20:01:14 +090033};
Jooyung Handd0a1732021-11-23 15:26:20 +090034use anyhow::{anyhow, bail, ensure, Context, Error, Result};
Alice Wang1bf3d782022-09-28 07:56:36 +000035use apkverify::{get_public_key_der, verify, V4Signature};
Alice Wang43c884b2022-10-24 09:42:40 +000036use binder::Strong;
Alice Wang62f7e642023-02-10 09:55:13 +000037use diced_open_dice::OwnedDiceArtifacts;
Inseob Kim197748b2021-12-01 19:49:00 +090038use glob::glob;
Inseob Kim197748b2021-12-01 19:49:00 +090039use itertools::sorted;
David Brazdila07a1792022-10-25 13:37:57 +010040use libc::VMADDR_CID_HOST;
Inseob Kim090b70b2022-11-16 20:01:14 +090041use log::{error, info, warn};
Alice Wang7e6c9352023-02-15 15:44:13 +000042use keystore2_crypto::ZVec;
Alan Stokes0d1ef782022-09-27 13:46:35 +010043use microdroid_metadata::{write_metadata, Metadata, PayloadMetadata};
Seungjae Yoofd9a0622022-10-14 10:01:29 +090044use microdroid_payload_config::{OsConfig, Task, TaskType, VmPayloadConfig};
Inseob Kim090b70b2022-11-16 20:01:14 +090045use nix::fcntl::{fcntl, F_SETFD, FdFlag};
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;
Jooyung Hanf48ceb42021-06-01 18:00:04 +090062use std::path::Path;
Inseob Kim217038e2021-11-25 11:15:06 +090063use std::process::{Child, Command, Stdio};
Jiyong Park8611a6c2021-07-09 18:17:44 +090064use std::str;
Jiyong Parkbb4a9872021-09-06 15:59:21 +090065use std::time::{Duration, SystemTime};
Jooyung Han634e2d72021-06-10 16:27:38 +090066
67const WAIT_TIMEOUT: Duration = Duration::from_secs(10);
Inseob Kim197748b2021-12-01 19:49:00 +090068const MAIN_APK_PATH: &str = "/dev/block/by-name/microdroid-apk";
69const MAIN_APK_IDSIG_PATH: &str = "/dev/block/by-name/microdroid-apk-idsig";
70const MAIN_APK_DEVICE_NAME: &str = "microdroid-apk";
71const EXTRA_APK_PATH_PATTERN: &str = "/dev/block/by-name/extra-apk-*";
72const EXTRA_IDSIG_PATH_PATTERN: &str = "/dev/block/by-name/extra-idsig-*";
Jooyung Han19c1d6c2021-08-06 14:08:16 +090073const DM_MOUNTED_APK_PATH: &str = "/dev/block/mapper/microdroid-apk";
Andrew Scullab72ec52022-03-14 09:10:52 +000074const AVF_STRICT_BOOT: &str = "/sys/firmware/devicetree/base/chosen/avf,strict-boot";
75const AVF_NEW_INSTANCE: &str = "/sys/firmware/devicetree/base/chosen/avf,new-instance";
Jaewan Kim3124ef02023-03-23 19:25:20 +090076const AVF_DEBUG_POLICY_RAMDUMP: &str = "/sys/firmware/devicetree/base/avf/guest/common/ramdump";
Inseob Kime379e7d2022-07-22 18:55:18 +090077const DEBUG_MICRODROID_NO_VERIFIED_BOOT: &str =
78 "/sys/firmware/devicetree/base/virtualization/guest/debug-microdroid,no-verified-boot";
Jooyung Han347d9f22021-05-28 00:05:14 +090079
Alan Stokes4fb201c2023-02-08 17:39:05 +000080const APKDMVERITY_BIN: &str = "/system/bin/apkdmverity";
81const ENCRYPTEDSTORE_BIN: &str = "/system/bin/encryptedstore";
82const ZIPFUSE_BIN: &str = "/system/bin/zipfuse";
83
Jiyong Parkbb4a9872021-09-06 15:59:21 +090084const APEX_CONFIG_DONE_PROP: &str = "apex_config.done";
Seungjae Yoofa22bb02022-12-08 16:38:42 +090085const DEBUGGABLE_PROP: &str = "ro.boot.microdroid.debuggable";
Jiyong Parkbb4a9872021-09-06 15:59:21 +090086
Inseob Kim11f40d02022-06-13 17:16:00 +090087// SYNC WITH virtualizationservice/src/crosvm.rs
88const FAILURE_SERIAL_DEVICE: &str = "/dev/ttyS1";
89
Shikha Panwar566c9672022-11-15 14:39:58 +000090const ENCRYPTEDSTORE_BACKING_DEVICE: &str = "/dev/block/by-name/encryptedstore";
Shikha Panwar566c9672022-11-15 14:39:58 +000091const ENCRYPTEDSTORE_KEY_IDENTIFIER: &str = "encryptedstore_key";
Alice Wang62f7e642023-02-10 09:55:13 +000092const ENCRYPTEDSTORE_KEYSIZE: usize = 32;
Shikha Panwar566c9672022-11-15 14:39:58 +000093
Jooyung Handd0a1732021-11-23 15:26:20 +090094#[derive(thiserror::Error, Debug)]
95enum MicrodroidError {
Inseob Kim11f40d02022-06-13 17:16:00 +090096 #[error("Cannot connect to virtualization service: {0}")]
97 FailedToConnectToVirtualizationService(String),
Jooyung Handd0a1732021-11-23 15:26:20 +090098 #[error("Payload has changed: {0}")]
99 PayloadChanged(String),
100 #[error("Payload verification has failed: {0}")]
101 PayloadVerificationFailed(String),
Jooyung Han5c6d4172021-12-06 14:17:52 +0900102 #[error("Payload config is invalid: {0}")]
103 InvalidConfig(String),
Jooyung Handd0a1732021-11-23 15:26:20 +0900104}
105
Alan Stokes2bead0d2022-09-05 16:58:34 +0100106fn translate_error(err: &Error) -> (ErrorCode, String) {
Jooyung Handd0a1732021-11-23 15:26:20 +0900107 if let Some(e) = err.downcast_ref::<MicrodroidError>() {
108 match e {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100109 MicrodroidError::PayloadChanged(msg) => (ErrorCode::PAYLOAD_CHANGED, msg.to_string()),
Jooyung Handd0a1732021-11-23 15:26:20 +0900110 MicrodroidError::PayloadVerificationFailed(msg) => {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100111 (ErrorCode::PAYLOAD_VERIFICATION_FAILED, msg.to_string())
Jooyung Handd0a1732021-11-23 15:26:20 +0900112 }
Alan Stokes2bead0d2022-09-05 16:58:34 +0100113 MicrodroidError::InvalidConfig(msg) => {
114 (ErrorCode::PAYLOAD_CONFIG_INVALID, msg.to_string())
115 }
Inseob Kim11f40d02022-06-13 17:16:00 +0900116
117 // Connection failure won't be reported to VS; return the default value
118 MicrodroidError::FailedToConnectToVirtualizationService(msg) => {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100119 (ErrorCode::UNKNOWN, msg.to_string())
Inseob Kim11f40d02022-06-13 17:16:00 +0900120 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900121 }
122 } else {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100123 (ErrorCode::UNKNOWN, err.to_string())
Jooyung Handd0a1732021-11-23 15:26:20 +0900124 }
125}
126
Inseob Kim11f40d02022-06-13 17:16:00 +0900127fn write_death_reason_to_serial(err: &Error) -> Result<()> {
128 let death_reason = if let Some(e) = err.downcast_ref::<MicrodroidError>() {
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100129 Borrowed(match e {
Inseob Kim11f40d02022-06-13 17:16:00 +0900130 MicrodroidError::FailedToConnectToVirtualizationService(_) => {
131 "MICRODROID_FAILED_TO_CONNECT_TO_VIRTUALIZATION_SERVICE"
132 }
133 MicrodroidError::PayloadChanged(_) => "MICRODROID_PAYLOAD_HAS_CHANGED",
134 MicrodroidError::PayloadVerificationFailed(_) => {
135 "MICRODROID_PAYLOAD_VERIFICATION_FAILED"
136 }
137 MicrodroidError::InvalidConfig(_) => "MICRODROID_INVALID_PAYLOAD_CONFIG",
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100138 })
Inseob Kim11f40d02022-06-13 17:16:00 +0900139 } else {
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100140 // Send context information back after a separator, to ease diagnosis.
141 // These errors occur before the payload runs, so this should not leak sensitive
142 // information.
143 Owned(format!("MICRODROID_UNKNOWN_RUNTIME_ERROR|{:?}", err))
Inseob Kim11f40d02022-06-13 17:16:00 +0900144 };
145
146 let death_reason_bytes = death_reason.as_bytes();
147 let mut sent_total = 0;
148 while sent_total < death_reason_bytes.len() {
149 // TODO(b/220071963): Sometimes, sending more than 16 bytes at once makes MM hang.
150 let begin = sent_total;
151 let end = std::cmp::min(begin.saturating_add(16), death_reason_bytes.len());
152 OpenOptions::new()
153 .read(false)
154 .write(true)
155 .open(FAILURE_SERIAL_DEVICE)?
156 .write_all(&death_reason_bytes[begin..end])?;
157 sent_total = end;
158 }
159
160 Ok(())
161}
162
Inseob Kim1b95f2e2021-08-19 13:17:40 +0900163fn get_vms_rpc_binder() -> Result<Strong<dyn IVirtualMachineService>> {
David Brazdil73988ea2022-11-11 15:10:32 +0000164 // The host is running a VirtualMachineService for this VM on a port equal
165 // to the CID of this VM.
166 let port = vsock::get_local_cid().context("Could not determine local CID")?;
David Brazdila2125dd2022-12-14 16:37:44 +0000167 RpcSession::new()
168 .setup_vsock_client(VMADDR_CID_HOST, port)
David Brazdil73988ea2022-11-11 15:10:32 +0000169 .context("Could not connect to IVirtualMachineService")
Inseob Kim1b95f2e2021-08-19 13:17:40 +0900170}
171
Inseob Kim437f1052022-06-21 11:30:22 +0900172fn main() -> Result<()> {
Inseob Kim7ff121c2022-11-14 18:13:23 +0900173 // If debuggable, print full backtrace to console log with stdio_to_kmsg
Seungjae Yoofa22bb02022-12-08 16:38:42 +0900174 if system_properties::read_bool(DEBUGGABLE_PROP, true)? {
Inseob Kim7ff121c2022-11-14 18:13:23 +0900175 env::set_var("RUST_BACKTRACE", "full");
176 }
177
Inseob Kim437f1052022-06-21 11:30:22 +0900178 scopeguard::defer! {
179 info!("Shutting down...");
Jooyung Hanbfe086f2021-10-28 10:15:45 +0900180 if let Err(e) = system_properties::write("sys.powerctl", "shutdown") {
181 error!("failed to shutdown {:?}", e);
182 }
Jooyung Han311b1202021-09-14 22:00:16 +0900183 }
Inseob Kim437f1052022-06-21 11:30:22 +0900184
185 try_main().map_err(|e| {
186 error!("Failed with {:?}.", e);
187 if let Err(e) = write_death_reason_to_serial(&e) {
188 error!("Failed to write death reason {:?}", e);
189 }
190 e
191 })
Jooyung Han311b1202021-09-14 22:00:16 +0900192}
193
Inseob Kim090b70b2022-11-16 20:01:14 +0900194fn set_cloexec_on_vm_payload_service_socket() -> Result<()> {
195 let fd = android_get_control_socket(VM_PAYLOAD_SERVICE_SOCKET_NAME)?;
196
197 fcntl(fd, F_SETFD(FdFlag::FD_CLOEXEC))?;
198
199 Ok(())
200}
201
Jooyung Han311b1202021-09-14 22:00:16 +0900202fn try_main() -> Result<()> {
Andrew Sculle127cff2022-02-15 15:34:04 +0000203 let _ = kernlog::init();
Jooyung Han347d9f22021-05-28 00:05:14 +0900204 info!("started.");
205
Inseob Kim090b70b2022-11-16 20:01:14 +0900206 if let Err(e) = set_cloexec_on_vm_payload_service_socket() {
207 warn!("Failed to set cloexec on vm payload socket: {:?}", e);
208 }
209
Jiyong Park202856e2022-08-22 16:04:26 +0900210 load_crashkernel_if_supported().context("Failed to load crashkernel")?;
211
Keir Fraser933f0ac2022-10-12 08:23:28 +0000212 swap::init_swap().context("Failed to initialise swap")?;
213 info!("swap enabled.");
214
Inseob Kim11f40d02022-06-13 17:16:00 +0900215 let service = get_vms_rpc_binder()
216 .context("cannot connect to VirtualMachineService")
217 .map_err(|e| MicrodroidError::FailedToConnectToVirtualizationService(e.to_string()))?;
Seungjae Yoofd9a0622022-10-14 10:01:29 +0900218
Jooyung Han5c6d4172021-12-06 14:17:52 +0900219 match try_run_payload(&service) {
220 Ok(code) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900221 if code == 0 {
222 info!("task successfully finished");
223 } else {
224 error!("task exited with exit code: {}", code);
225 }
Shikha Panwardef7ef92023-01-06 08:35:48 +0000226 if let Err(e) = post_payload_work() {
227 error!(
228 "Failed to run post payload work. It is possible that certain tasks
229 like syncing encrypted store might be incomplete. Error: {:?}",
230 e
231 );
232 };
233
234 info!("notifying payload finished");
235 service.notifyPayloadFinished(code)?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900236 Ok(())
237 }
238 Err(err) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900239 let (error_code, message) = translate_error(&err);
240 service.notifyError(error_code, &message)?;
241 Err(err)
242 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900243 }
244}
245
Shikha Panwardef7ef92023-01-06 08:35:48 +0000246fn post_payload_work() -> Result<()> {
247 // Sync the encrypted storage filesystem (flushes the filesystem caches).
248 if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
249 let mountpoint = CString::new(ENCRYPTEDSTORE_MOUNTPOINT).unwrap();
250
251 let ret = unsafe {
252 let dirfd = libc::open(
253 mountpoint.as_ptr(),
254 libc::O_DIRECTORY | libc::O_RDONLY | libc::O_CLOEXEC,
255 );
256 ensure!(dirfd >= 0, "Unable to open {:?}", mountpoint);
257 let ret = libc::syncfs(dirfd);
258 libc::close(dirfd);
259 ret
260 };
261 if ret != 0 {
262 error!("failed to sync encrypted storage.");
263 return Err(anyhow!(std::io::Error::last_os_error()));
264 }
265 }
266 Ok(())
267}
Alan Stokes1f417c92022-09-29 15:13:28 +0100268fn dice_derivation(
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000269 dice: DiceDriver,
Alan Stokes1f417c92022-09-29 15:13:28 +0100270 verified_data: &MicrodroidData,
271 payload_metadata: &PayloadMetadata,
Alice Wang62f7e642023-02-10 09:55:13 +0000272) -> Result<OwnedDiceArtifacts> {
Andrew Scullb2f44472022-01-21 14:41:34 +0000273 // Calculate compound digests of code and authorities
Andrew Sculla0d1b1a2022-05-24 19:32:47 +0000274 let mut code_hash_ctx = Sha512::new();
275 let mut authority_hash_ctx = Sha512::new();
Andrew Scullb2f44472022-01-21 14:41:34 +0000276 code_hash_ctx.update(verified_data.apk_data.root_hash.as_ref());
277 authority_hash_ctx.update(verified_data.apk_data.pubkey.as_ref());
Inseob Kimb2519c52022-04-14 02:10:09 +0900278 for extra_apk in &verified_data.extra_apks_data {
Andrew Scullb2f44472022-01-21 14:41:34 +0000279 code_hash_ctx.update(extra_apk.root_hash.as_ref());
280 authority_hash_ctx.update(extra_apk.pubkey.as_ref());
281 }
Inseob Kimb2519c52022-04-14 02:10:09 +0900282 for apex in &verified_data.apex_data {
Andrew Scullb2f44472022-01-21 14:41:34 +0000283 code_hash_ctx.update(apex.root_digest.as_ref());
284 authority_hash_ctx.update(apex.public_key.as_ref());
285 }
Andrew Sculla0d1b1a2022-05-24 19:32:47 +0000286 let code_hash = code_hash_ctx.finish();
287 let authority_hash = authority_hash_ctx.finish();
Andrew Scullb2f44472022-01-21 14:41:34 +0000288
Alice Wang285a3d22023-03-01 11:36:29 +0000289 let config_descriptor = format_payload_config_descriptor(payload_metadata)?;
Andrew Scullb2f44472022-01-21 14:41:34 +0000290
Seungjae Yoofa22bb02022-12-08 16:38:42 +0900291 // Check debuggability, conservatively assuming it is debuggable
292 let debuggable = system_properties::read_bool(DEBUGGABLE_PROP, true)?;
Andrew Scull65ddfc42022-02-14 21:03:58 +0000293
Andrew Scullb2f44472022-01-21 14:41:34 +0000294 // Send the details to diced
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000295 let hidden = verified_data.salt.clone().try_into().unwrap();
Alice Wang285a3d22023-03-01 11:36:29 +0000296 dice.derive(code_hash, &config_descriptor, authority_hash, debuggable, hidden)
Alan Stokes1f417c92022-09-29 15:13:28 +0100297}
298
Andrew Scullab72ec52022-03-14 09:10:52 +0000299fn is_strict_boot() -> bool {
300 Path::new(AVF_STRICT_BOOT).exists()
301}
302
303fn is_new_instance() -> bool {
304 Path::new(AVF_NEW_INSTANCE).exists()
305}
306
Inseob Kime379e7d2022-07-22 18:55:18 +0900307fn is_verified_boot() -> bool {
308 !Path::new(DEBUG_MICRODROID_NO_VERIFIED_BOOT).exists()
309}
310
Inseob Kimab1037d2023-02-08 17:03:31 +0900311fn should_export_tombstones(config: &VmPayloadConfig) -> bool {
312 match config.export_tombstones {
313 Some(b) => b,
314 None => system_properties::read_bool(DEBUGGABLE_PROP, true).unwrap_or(false),
315 }
316}
317
Jaewan Kim3124ef02023-03-23 19:25:20 +0900318/// Get debug policy value in bool. It's true iff the value is explicitly set to <1>.
319fn get_debug_policy_bool(path: &'static str) -> Result<Option<bool>> {
320 let mut file = match File::open(path) {
321 Ok(dp) => dp,
322 Err(e) => {
323 info!("{e:?}. Assumes <0>");
324 return Ok(Some(false));
325 }
326 };
327 let mut log: [u8; 4] = Default::default();
328 file.read_exact(&mut log).context("Malformed data in {path}")?;
329 // DT spec uses big endian although Android is always little endian.
330 Ok(Some(u32::from_be_bytes(log) == 1))
331}
332
Jooyung Han5c6d4172021-12-06 14:17:52 +0900333fn try_run_payload(service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jooyung Han311b1202021-09-14 22:00:16 +0900334 let metadata = load_metadata().context("Failed to load payload metadata")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000335 let dice = DiceDriver::new(Path::new("/dev/open-dice0")).context("Failed to load DICE")?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900336
Jooyung Han311b1202021-09-14 22:00:16 +0900337 let mut instance = InstanceDisk::new().context("Failed to load instance.img")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000338 let saved_data =
339 instance.read_microdroid_data(&dice).context("Failed to read identity data")?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900340
Andrew Scullab72ec52022-03-14 09:10:52 +0000341 if is_strict_boot() {
342 // Provisioning must happen on the first boot and never again.
343 if is_new_instance() {
344 ensure!(
345 saved_data.is_none(),
346 MicrodroidError::InvalidConfig("Found instance data on first boot.".to_string())
347 );
348 } else {
349 ensure!(
350 saved_data.is_some(),
351 MicrodroidError::InvalidConfig("Instance data not found.".to_string())
352 );
353 };
354 }
355
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900356 // Verify the payload before using it.
Inseob Kim11f40d02022-06-13 17:16:00 +0900357 let verified_data = verify_payload(&metadata, saved_data.as_ref())
358 .context("Payload verification failed")
359 .map_err(|e| MicrodroidError::PayloadVerificationFailed(e.to_string()))?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900360
361 // In case identity is ignored (by debug policy), we should reuse existing payload data, even
362 // when the payload is changed. This is to keep the derived secret same as before.
363 let verified_data = if let Some(saved_data) = saved_data {
364 if !is_verified_boot() {
365 if saved_data != verified_data {
366 info!("Detected an update of the payload, but continue (regarding debug policy)")
367 }
368 } else {
369 ensure!(
370 saved_data == verified_data,
371 MicrodroidError::PayloadChanged(String::from(
372 "Detected an update of the payload which isn't supported yet."
373 ))
374 );
375 info!("Saved data is verified.");
376 }
377 saved_data
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900378 } else {
Jooyung Han7a343f92021-09-08 22:53:11 +0900379 info!("Saving verified data.");
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000380 instance
381 .write_microdroid_data(&verified_data, &dice)
382 .context("Failed to write identity data")?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900383 verified_data
384 };
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900385
Alan Stokes1f417c92022-09-29 15:13:28 +0100386 let payload_metadata = metadata.payload.ok_or_else(|| {
387 MicrodroidError::InvalidConfig("No payload config in metadata".to_string())
388 })?;
Alan Stokes0d1ef782022-09-27 13:46:35 +0100389
Inseob Kimb2519c52022-04-14 02:10:09 +0900390 // To minimize the exposure to untrusted data, derive dice profile as soon as possible.
391 info!("DICE derivation for payload");
Alice Wang62f7e642023-02-10 09:55:13 +0000392 let dice_artifacts = dice_derivation(dice, &verified_data, &payload_metadata)?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000393
394 // Run encryptedstore binary to prepare the storage
395 let encryptedstore_child = if Path::new(ENCRYPTEDSTORE_BACKING_DEVICE).exists() {
396 info!("Preparing encryptedstore ...");
Alice Wang62f7e642023-02-10 09:55:13 +0000397 Some(prepare_encryptedstore(&dice_artifacts).context("encryptedstore run")?)
Shikha Panwar566c9672022-11-15 14:39:58 +0000398 } else {
399 None
400 };
Inseob Kimb2519c52022-04-14 02:10:09 +0900401
Alan Stokes960c9032022-12-07 16:53:45 +0000402 let mut zipfuse = Zipfuse::default();
403
Jooyung Hana6d11eb2021-09-10 11:48:05 +0900404 // Before reading a file from the APK, start zipfuse
Alan Stokes960c9032022-12-07 16:53:45 +0000405 zipfuse.mount(
Alan Stokes60f82202022-10-07 16:40:07 +0100406 MountForExec::Allowed,
Inseob Kim217038e2021-11-25 11:15:06 +0900407 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:system_file:s0",
408 Path::new("/dev/block/mapper/microdroid-apk"),
Alice Wang6bbb6da2022-10-26 12:44:06 +0000409 Path::new(VM_APK_CONTENTS_PATH),
Alan Stokes960c9032022-12-07 16:53:45 +0000410 "microdroid_manager.apk.mounted".to_owned(),
411 )?;
Jiyong Park21ce2c52021-08-28 02:32:17 +0900412
Andrew Scull4d262dc2022-10-21 13:14:33 +0000413 // Restricted APIs are only allowed to be used by platform or test components. Infer this from
414 // the use of a VM config file since those can only be used by platform and test components.
415 let allow_restricted_apis = match payload_metadata {
416 PayloadMetadata::config_path(_) => true,
417 PayloadMetadata::config(_) => false,
418 };
419
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100420 let config = load_config(payload_metadata).context("Failed to load payload metadata")?;
Shikha Panwar6f03c942022-04-13 20:26:50 +0000421
Alan Stokes01b3ef02022-09-22 17:43:24 +0100422 let task = config
423 .task
424 .as_ref()
425 .ok_or_else(|| MicrodroidError::InvalidConfig("No task in VM config".to_string()))?;
426
Alice Wang061478b2023-04-11 13:26:17 +0000427 ensure!(
428 config.extra_apks.len() == verified_data.extra_apks_data.len(),
429 "config expects {} extra apks, but found {}",
430 config.extra_apks.len(),
431 verified_data.extra_apks_data.len()
432 );
Alan Stokes960c9032022-12-07 16:53:45 +0000433 mount_extra_apks(&config, &mut zipfuse)?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900434
Jooyung Han5c6d4172021-12-06 14:17:52 +0900435 // Wait until apex config is done. (e.g. linker configuration for apexes)
Jooyung Han5c6d4172021-12-06 14:17:52 +0900436 wait_for_apex_config_done()?;
437
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000438 setup_config_sysprops(&config)?;
439
Shikha Panwar1a6efcd2023-02-03 19:23:43 +0000440 // Set export_tombstones if enabled
Inseob Kimab1037d2023-02-08 17:03:31 +0900441 if should_export_tombstones(&config) {
Shikha Panwar1a6efcd2023-02-03 19:23:43 +0000442 // This property is read by tombstone_handler.
443 system_properties::write("microdroid_manager.export_tombstones.enabled", "1")
444 .context("set microdroid_manager.export_tombstones.enabled")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900445 }
446
Alan Stokes960c9032022-12-07 16:53:45 +0000447 // Wait until zipfuse has mounted the APKs so we can access the payload
448 zipfuse.wait_until_done()?;
Alan Stokes60f82202022-10-07 16:40:07 +0100449
Alice Wang62f7e642023-02-10 09:55:13 +0000450 register_vm_payload_service(allow_restricted_apis, service.clone(), dice_artifacts)?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000451
Shikha Panwarddc124b2022-11-28 19:17:54 +0000452 // Wait for encryptedstore to finish mounting the storage (if enabled) before setting
453 // microdroid_manager.init_done. Reason is init stops uneventd after that.
454 // Encryptedstore, however requires ueventd
Shikha Panwar566c9672022-11-15 14:39:58 +0000455 if let Some(mut child) = encryptedstore_child {
456 let exitcode = child.wait().context("Wait for encryptedstore child")?;
457 ensure!(exitcode.success(), "Unable to prepare encrypted storage. Exitcode={}", exitcode);
458 }
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100459
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000460 wait_for_property_true("dev.bootcomplete").context("failed waiting for dev.bootcomplete")?;
Shikha Panwar3f6f6a52022-11-29 17:28:36 +0000461 system_properties::write("microdroid_manager.init_done", "1")
462 .context("set microdroid_manager.init_done")?;
Inseob Kimc16b0cc2023-01-26 14:57:24 +0900463
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000464 info!("boot completed, time to run payload");
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100465 exec_task(task, service).context("Failed to run payload")
Alan Stokes01b3ef02022-09-22 17:43:24 +0100466}
467
Inseob Kim217038e2021-11-25 11:15:06 +0900468struct ApkDmverityArgument<'a> {
469 apk: &'a str,
470 idsig: &'a str,
471 name: &'a str,
Inseob Kim197748b2021-12-01 19:49:00 +0900472 saved_root_hash: Option<&'a RootHash>,
Inseob Kim217038e2021-11-25 11:15:06 +0900473}
474
475fn run_apkdmverity(args: &[ApkDmverityArgument]) -> Result<Child> {
476 let mut cmd = Command::new(APKDMVERITY_BIN);
477
Inseob Kim217038e2021-11-25 11:15:06 +0900478 for argument in args {
479 cmd.arg("--apk").arg(argument.apk).arg(argument.idsig).arg(argument.name);
Inseob Kim197748b2021-12-01 19:49:00 +0900480 if let Some(root_hash) = argument.saved_root_hash {
481 cmd.arg(&to_hex_string(root_hash));
482 } else {
483 cmd.arg("none");
484 }
Inseob Kim217038e2021-11-25 11:15:06 +0900485 }
486
487 cmd.spawn().context("Spawn apkdmverity")
488}
489
Alan Stokes60f82202022-10-07 16:40:07 +0100490enum MountForExec {
491 Allowed,
492 Disallowed,
493}
494
Alan Stokes960c9032022-12-07 16:53:45 +0000495#[derive(Default)]
496struct Zipfuse {
497 ready_properties: Vec<String>,
498}
499
500impl Zipfuse {
Jiyong Park231f9692023-01-09 19:36:21 +0900501 const MICRODROID_PAYLOAD_UID: u32 = 0; // TODO(b/264861173) should be non-root
502 const MICRODROID_PAYLOAD_GID: u32 = 0; // TODO(b/264861173) should be non-root
Alan Stokes960c9032022-12-07 16:53:45 +0000503 fn mount(
504 &mut self,
505 noexec: MountForExec,
506 option: &str,
507 zip_path: &Path,
508 mount_dir: &Path,
509 ready_prop: String,
510 ) -> Result<Child> {
511 let mut cmd = Command::new(ZIPFUSE_BIN);
512 if let MountForExec::Disallowed = noexec {
513 cmd.arg("--noexec");
514 }
515 cmd.args(["-p", &ready_prop, "-o", option]);
Jiyong Park231f9692023-01-09 19:36:21 +0900516 cmd.args(["-u", &Self::MICRODROID_PAYLOAD_UID.to_string()]);
517 cmd.args(["-g", &Self::MICRODROID_PAYLOAD_GID.to_string()]);
Alan Stokes960c9032022-12-07 16:53:45 +0000518 cmd.arg(zip_path).arg(mount_dir);
519 self.ready_properties.push(ready_prop);
520 cmd.spawn().with_context(|| format!("Failed to run zipfuse for {mount_dir:?}"))
Andrew Scullcc339a12022-07-04 12:44:19 +0000521 }
Alan Stokes960c9032022-12-07 16:53:45 +0000522
523 fn wait_until_done(self) -> Result<()> {
524 // We check the last-started check first in the hope that by the time it is done
525 // all or most of the others will also be done, minimising the number of times we
526 // block on a property.
527 for property in self.ready_properties.into_iter().rev() {
528 wait_for_property_true(&property)
529 .with_context(|| format!("Failed waiting for {property}"))?;
530 }
531 Ok(())
Alan Stokes60f82202022-10-07 16:40:07 +0100532 }
Inseob Kim217038e2021-11-25 11:15:06 +0900533}
534
Inseob Kime379e7d2022-07-22 18:55:18 +0900535fn write_apex_payload_data(
536 saved_data: Option<&MicrodroidData>,
537 apex_data_from_payload: &[ApexData],
538) -> Result<()> {
539 if let Some(saved_apex_data) = saved_data.map(|d| &d.apex_data) {
540 // We don't support APEX updates. (assuming that update will change root digest)
541 ensure!(
542 saved_apex_data == apex_data_from_payload,
543 MicrodroidError::PayloadChanged(String::from("APEXes have changed."))
544 );
545 let apex_metadata = to_metadata(apex_data_from_payload);
546 // Pass metadata(with public keys and root digests) to apexd so that it uses the passed
547 // metadata instead of the default one (/dev/block/by-name/payload-metadata)
548 OpenOptions::new()
549 .create_new(true)
550 .write(true)
551 .open("/apex/vm-payload-metadata")
552 .context("Failed to open /apex/vm-payload-metadata")
553 .and_then(|f| write_metadata(&apex_metadata, f))?;
554 }
555 Ok(())
556}
557
Jooyung Han7a343f92021-09-08 22:53:11 +0900558// Verify payload before executing it. For APK payload, Full verification (which is slow) is done
559// when the root_hash values from the idsig file and the instance disk are different. This function
560// returns the verified root hash (for APK payload) and pubkeys (for APEX payloads) that can be
561// saved to the instance disk.
562fn verify_payload(
563 metadata: &Metadata,
564 saved_data: Option<&MicrodroidData>,
565) -> Result<MicrodroidData> {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900566 let start_time = SystemTime::now();
567
Inseob Kim197748b2021-12-01 19:49:00 +0900568 // Verify main APK
Inseob Kim197748b2021-12-01 19:49:00 +0900569 let root_hash_from_idsig = get_apk_root_hash_from_idsig(MAIN_APK_IDSIG_PATH)?;
Alice Wang061478b2023-04-11 13:26:17 +0000570 let root_hash_trustful =
571 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 +0900572
Jiyong Parkf7dea252021-09-08 01:42:54 +0900573 // 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 +0900574 // instead of the value read from the idsig file.
Inseob Kim197748b2021-12-01 19:49:00 +0900575 let main_apk_argument = {
576 ApkDmverityArgument {
577 apk: MAIN_APK_PATH,
578 idsig: MAIN_APK_IDSIG_PATH,
579 name: MAIN_APK_DEVICE_NAME,
580 saved_root_hash: if root_hash_trustful {
581 Some(root_hash_from_idsig.as_ref())
582 } else {
583 None
584 },
585 }
586 };
587 let mut apkdmverity_arguments = vec![main_apk_argument];
588
589 // Verify extra APKs
590 // For now, we can't read the payload config, so glob APKs and idsigs.
591 // Later, we'll see if it matches with the payload config.
592
593 // sort globbed paths to match apks (extra-apk-{idx}) and idsigs (extra-idsig-{idx})
594 // e.g. "extra-apk-0" corresponds to "extra-idsig-0"
595 let extra_apks =
596 sorted(glob(EXTRA_APK_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
597 let extra_idsigs =
598 sorted(glob(EXTRA_IDSIG_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
Alice Wang061478b2023-04-11 13:26:17 +0000599 ensure!(
600 extra_apks.len() == extra_idsigs.len(),
601 "Extra apks/idsigs mismatch: {} apks but {} idsigs",
602 extra_apks.len(),
603 extra_idsigs.len()
604 );
Inseob Kim197748b2021-12-01 19:49:00 +0900605
Alice Wang061478b2023-04-11 13:26:17 +0000606 let extra_root_hashes_from_idsig: Vec<_> = extra_idsigs
Inseob Kim197748b2021-12-01 19:49:00 +0900607 .iter()
Alice Wang061478b2023-04-11 13:26:17 +0000608 .map(|idsig| {
609 get_apk_root_hash_from_idsig(idsig).expect("Can't find root hash from extra idsig")
Inseob Kim197748b2021-12-01 19:49:00 +0900610 })
611 .collect();
612
Alice Wang061478b2023-04-11 13:26:17 +0000613 let extra_root_hashes_trustful: Vec<_> = if let Some(data) = saved_data {
614 extra_root_hashes_from_idsig
615 .iter()
616 .enumerate()
617 .map(|(i, root_hash)| data.extra_apk_root_hash_eq(i, root_hash))
618 .collect()
619 } else {
620 vec![false; extra_root_hashes_from_idsig.len()]
621 };
622 let extra_apk_names: Vec<_> =
623 (0..extra_apks.len()).map(|i| format!("extra-apk-{}", i)).collect();
624
625 for (i, extra_apk) in extra_apks.iter().enumerate() {
Inseob Kim197748b2021-12-01 19:49:00 +0900626 apkdmverity_arguments.push({
627 ApkDmverityArgument {
Alice Wang061478b2023-04-11 13:26:17 +0000628 apk: extra_apk.to_str().unwrap(),
Inseob Kim197748b2021-12-01 19:49:00 +0900629 idsig: extra_idsigs[i].to_str().unwrap(),
630 name: &extra_apk_names[i],
631 saved_root_hash: if extra_root_hashes_trustful[i] {
632 Some(&extra_root_hashes_from_idsig[i])
633 } else {
634 None
635 },
636 }
637 });
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900638 }
639
640 // Start apkdmverity and wait for the dm-verify block
Inseob Kim197748b2021-12-01 19:49:00 +0900641 let mut apkdmverity_child = run_apkdmverity(&apkdmverity_arguments)?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900642
Jooyung Hanc8deb472021-09-13 13:48:25 +0900643 // While waiting for apkdmverity to mount APK, gathers public keys and root digests from
644 // APEX payload.
Jooyung Han7a343f92021-09-08 22:53:11 +0900645 let apex_data_from_payload = get_apex_data_from_payload(metadata)?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900646
647 // Writing /apex/vm-payload-metadata is to verify that the payload isn't changed.
648 // Skip writing it if the debug policy ignoring identity is on
649 if is_verified_boot() {
650 write_apex_payload_data(saved_data, &apex_data_from_payload)?;
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900651 }
Inseob Kime379e7d2022-07-22 18:55:18 +0900652
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900653 // Start apexd to activate APEXes
654 system_properties::write("ctl.start", "apexd-vm")?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900655
Inseob Kim217038e2021-11-25 11:15:06 +0900656 // TODO(inseob): add timeout
657 apkdmverity_child.wait()?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900658
Jiyong Parkf7dea252021-09-08 01:42:54 +0900659 // Do the full verification if the root_hash is un-trustful. This requires the full scanning of
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900660 // 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 +0900661 // 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 +0900662 // of the VM or APK was updated in the host.
663 // TODO(jooyung): consider multithreading to make this faster
Inseob Kim197748b2021-12-01 19:49:00 +0900664 let main_apk_pubkey = get_public_key_from_apk(DM_MOUNTED_APK_PATH, root_hash_trustful)?;
665 let extra_apks_data = extra_root_hashes_from_idsig
666 .into_iter()
667 .enumerate()
668 .map(|(i, extra_root_hash)| {
669 let mount_path = format!("/dev/block/mapper/{}", &extra_apk_names[i]);
670 let apk_pubkey = get_public_key_from_apk(&mount_path, extra_root_hashes_trustful[i])?;
671 Ok(ApkData { root_hash: extra_root_hash, pubkey: apk_pubkey })
672 })
673 .collect::<Result<Vec<_>>>()?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900674
675 info!("payload verification successful. took {:#?}", start_time.elapsed().unwrap());
676
Andrew Scull34916a72022-01-30 21:34:24 +0000677 // Use the salt from a verified instance, or generate a salt for a new instance.
678 let salt = if let Some(saved_data) = saved_data {
679 saved_data.salt.clone()
Pierre-Clément Tosicecb0aa2023-02-08 16:57:54 +0000680 } else if is_strict_boot() {
681 // No need to add more entropy as a previous stage must have used a new, random salt.
682 vec![0u8; 64]
Andrew Scull34916a72022-01-30 21:34:24 +0000683 } else {
684 let mut salt = vec![0u8; 64];
685 salt.as_mut_slice().try_fill(&mut rand::thread_rng())?;
686 salt
687 };
688
Jiyong Parkf7dea252021-09-08 01:42:54 +0900689 // At this point, we can ensure that the root_hash from the idsig file is trusted, either by
690 // fully verifying the APK or by comparing it with the saved root_hash.
Jooyung Han7a343f92021-09-08 22:53:11 +0900691 Ok(MicrodroidData {
Andrew Scull34916a72022-01-30 21:34:24 +0000692 salt,
Inseob Kim197748b2021-12-01 19:49:00 +0900693 apk_data: ApkData { root_hash: root_hash_from_idsig, pubkey: main_apk_pubkey },
694 extra_apks_data,
Jooyung Han7a343f92021-09-08 22:53:11 +0900695 apex_data: apex_data_from_payload,
696 })
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900697}
698
Alan Stokes960c9032022-12-07 16:53:45 +0000699fn mount_extra_apks(config: &VmPayloadConfig, zipfuse: &mut Zipfuse) -> Result<()> {
Inseob Kim197748b2021-12-01 19:49:00 +0900700 // For now, only the number of apks is important, as the mount point and dm-verity name is fixed
701 for i in 0..config.extra_apks.len() {
Alan Stokes960c9032022-12-07 16:53:45 +0000702 let mount_dir = format!("/mnt/extra-apk/{i}");
Inseob Kim197748b2021-12-01 19:49:00 +0900703 create_dir(Path::new(&mount_dir)).context("Failed to create mount dir for extra apks")?;
704
705 // don't wait, just detach
Alan Stokes960c9032022-12-07 16:53:45 +0000706 zipfuse.mount(
Alan Stokes60f82202022-10-07 16:40:07 +0100707 MountForExec::Disallowed,
Inseob Kim197748b2021-12-01 19:49:00 +0900708 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:extra_apk_file:s0",
Alan Stokes960c9032022-12-07 16:53:45 +0000709 Path::new(&format!("/dev/block/mapper/extra-apk-{i}")),
Inseob Kim197748b2021-12-01 19:49:00 +0900710 Path::new(&mount_dir),
Alan Stokes960c9032022-12-07 16:53:45 +0000711 format!("microdroid_manager.extra_apk.mounted.{i}"),
712 )?;
Inseob Kim197748b2021-12-01 19:49:00 +0900713 }
714
715 Ok(())
716}
717
Nikita Ioffe57bc8d72022-11-27 00:50:50 +0000718fn setup_config_sysprops(config: &VmPayloadConfig) -> Result<()> {
719 if config.enable_authfs {
720 system_properties::write("microdroid_manager.authfs.enabled", "1")
721 .context("failed to write microdroid_manager.authfs.enabled")?;
722 }
723 system_properties::write("microdroid_manager.config_done", "1")
724 .context("failed to write microdroid_manager.config_done")?;
725 Ok(())
726}
727
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900728// Waits until linker config is generated
729fn wait_for_apex_config_done() -> Result<()> {
Alan Stokes60f82202022-10-07 16:40:07 +0100730 wait_for_property_true(APEX_CONFIG_DONE_PROP).context("Failed waiting for apex config done")
731}
732
733fn wait_for_property_true(property_name: &str) -> Result<()> {
734 let mut prop = PropertyWatcher::new(property_name)?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900735 loop {
736 prop.wait()?;
Alan Stokes60f82202022-10-07 16:40:07 +0100737 if system_properties::read_bool(property_name, false)? {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900738 break;
739 }
740 }
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900741 Ok(())
742}
743
Alice Wang89cff012022-09-26 10:05:16 +0000744fn get_apk_root_hash_from_idsig<P: AsRef<Path>>(idsig_path: P) -> Result<Box<RootHash>> {
745 Ok(V4Signature::from_idsig_path(idsig_path)?.hashing_info.raw_root_hash)
Jiyong Park21ce2c52021-08-28 02:32:17 +0900746}
747
Inseob Kim197748b2021-12-01 19:49:00 +0900748fn get_public_key_from_apk(apk: &str, root_hash_trustful: bool) -> Result<Box<[u8]>> {
Alan Stokes25f69362023-03-06 16:51:54 +0000749 let current_sdk = get_current_sdk()?;
Inseob Kim197748b2021-12-01 19:49:00 +0900750 if !root_hash_trustful {
Alan Stokes25f69362023-03-06 16:51:54 +0000751 verify(apk, current_sdk).context(MicrodroidError::PayloadVerificationFailed(format!(
Inseob Kim197748b2021-12-01 19:49:00 +0900752 "failed to verify {}",
753 apk
754 )))
755 } else {
Alan Stokes25f69362023-03-06 16:51:54 +0000756 get_public_key_der(apk, current_sdk)
Inseob Kim197748b2021-12-01 19:49:00 +0900757 }
758}
759
Alan Stokes25f69362023-03-06 16:51:54 +0000760fn get_current_sdk() -> Result<u32> {
761 let current_sdk = system_properties::read("ro.build.version.sdk")?;
762 let current_sdk = current_sdk.ok_or_else(|| anyhow!("SDK version missing"))?;
763 current_sdk.parse().context("Malformed SDK version")
764}
765
Alan Stokes1f417c92022-09-29 15:13:28 +0100766fn load_config(payload_metadata: PayloadMetadata) -> Result<VmPayloadConfig> {
767 match payload_metadata {
768 PayloadMetadata::config_path(path) => {
769 let path = Path::new(&path);
770 info!("loading config from {:?}...", path);
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100771 let file = ioutil::wait_for_file(path, WAIT_TIMEOUT)
772 .with_context(|| format!("Failed to read {:?}", path))?;
Alan Stokes1f417c92022-09-29 15:13:28 +0100773 Ok(serde_json::from_reader(file)?)
774 }
775 PayloadMetadata::config(payload_config) => {
776 let task = Task {
777 type_: TaskType::MicrodroidLauncher,
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000778 command: payload_config.payload_binary_name,
Alan Stokes1f417c92022-09-29 15:13:28 +0100779 };
780 Ok(VmPayloadConfig {
781 os: OsConfig { name: "microdroid".to_owned() },
782 task: Some(task),
783 apexes: vec![],
784 extra_apks: vec![],
785 prefer_staged: false,
Inseob Kimab1037d2023-02-08 17:03:31 +0900786 export_tombstones: None,
Alan Stokes1f417c92022-09-29 15:13:28 +0100787 enable_authfs: false,
788 })
789 }
790 }
Jooyung Han634e2d72021-06-10 16:27:38 +0900791}
792
Jaewan Kim3124ef02023-03-23 19:25:20 +0900793/// Loads the crashkernel into memory using kexec if debuggable or debug policy says so.
794/// The VM should be loaded with `crashkernel=' parameter in the cmdline to allocate memory
795/// for crashkernel.
Jiyong Park202856e2022-08-22 16:04:26 +0900796fn load_crashkernel_if_supported() -> Result<()> {
797 let supported = std::fs::read_to_string("/proc/cmdline")?.contains(" crashkernel=");
798 info!("ramdump supported: {}", supported);
Jaewan Kim3124ef02023-03-23 19:25:20 +0900799
800 if !supported {
801 return Ok(());
802 }
803
804 let debuggable = system_properties::read_bool(DEBUGGABLE_PROP, true)?;
805 let ramdump = get_debug_policy_bool(AVF_DEBUG_POLICY_RAMDUMP)?.unwrap_or_default();
806 let requested = debuggable | ramdump;
807
808 if requested {
Jiyong Park202856e2022-08-22 16:04:26 +0900809 let status = Command::new("/system/bin/kexec_load").status()?;
810 if !status.success() {
811 return Err(anyhow!("Failed to load crashkernel: {:?}", status));
812 }
Jaewan Kim3124ef02023-03-23 19:25:20 +0900813 info!("ramdump is loaded: debuggable={debuggable}, ramdump={ramdump}");
Jiyong Park202856e2022-08-22 16:04:26 +0900814 }
815 Ok(())
816}
817
Inseob Kim090b70b2022-11-16 20:01:14 +0900818/// Executes the given task.
Jooyung Han5c6d4172021-12-06 14:17:52 +0900819fn exec_task(task: &Task, service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900820 info!("executing main task {:?}...", task);
David Brazdil451cc962022-10-14 14:08:12 +0100821 let mut command = match task.type_ {
822 TaskType::Executable => Command::new(&task.command),
823 TaskType::MicrodroidLauncher => {
824 let mut command = Command::new("/system/bin/microdroid_launcher");
825 command.arg(find_library_path(&task.command)?);
826 command
827 }
828 };
Nikita Ioffe3452ee22022-12-15 00:31:56 +0000829
830 unsafe {
831 // SAFETY: we are not accessing any resource of the parent process.
832 command.pre_exec(|| {
833 info!("dropping capabilities before executing payload");
834 // It is OK to continue with payload execution even if the calls below fail, since
835 // whether process can use a capability is controlled by the SELinux. Dropping the
836 // capabilities here is just another defense-in-depth layer.
837 if let Err(e) = cap::drop_inheritable_caps() {
838 error!("failed to drop inheritable capabilities: {:?}", e);
839 }
840 if let Err(e) = cap::drop_bounding_set() {
841 error!("failed to drop bounding set: {:?}", e);
842 }
843 Ok(())
844 });
845 }
846
Inseob Kim090b70b2022-11-16 20:01:14 +0900847 command.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
Inseob Kim7f61fe72021-08-20 20:50:47 +0900848
849 info!("notifying payload started");
Inseob Kimc7d28c72021-10-25 14:28:10 +0000850 service.notifyPayloadStarted()?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900851
Inseob Kim86ca0162021-10-20 02:21:02 +0000852 let exit_status = command.spawn()?.wait()?;
Frederick Mayleb5f7b6b2022-11-11 15:24:03 -0800853 match exit_status.code() {
854 Some(exit_code) => Ok(exit_code),
855 None => Err(match exit_status.signal() {
856 Some(signal) => anyhow!(
857 "Payload exited due to signal: {} ({})",
858 signal,
859 Signal::try_from(signal).map_or("unknown", |s| s.as_str())
860 ),
861 None => anyhow!("Payload has neither exit code nor signal"),
862 }),
863 }
Jooyung Han347d9f22021-05-28 00:05:14 +0900864}
Jooyung Han634e2d72021-06-10 16:27:38 +0900865
Jooyung Han634e2d72021-06-10 16:27:38 +0900866fn find_library_path(name: &str) -> Result<String> {
867 let mut watcher = PropertyWatcher::new("ro.product.cpu.abilist")?;
868 let value = watcher.read(|_name, value| Ok(value.trim().to_string()))?;
869 let abi = value.split(',').next().ok_or_else(|| anyhow!("no abilist"))?;
Alice Wang6bbb6da2022-10-26 12:44:06 +0000870 let path = format!("{}/lib/{}/{}", VM_APK_CONTENTS_PATH, abi, name);
Jooyung Han634e2d72021-06-10 16:27:38 +0900871
Alan Stokes3ba10fd2022-10-06 15:46:51 +0100872 let metadata = fs::metadata(&path).with_context(|| format!("Unable to access {}", path))?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900873 if !metadata.is_file() {
874 bail!("{} is not a file", &path);
875 }
876
877 Ok(path)
878}
Jiyong Park21ce2c52021-08-28 02:32:17 +0900879
880fn to_hex_string(buf: &[u8]) -> String {
881 buf.iter().map(|b| format!("{:02X}", b)).collect()
882}
Shikha Panwar566c9672022-11-15 14:39:58 +0000883
Alice Wang62f7e642023-02-10 09:55:13 +0000884fn prepare_encryptedstore(dice_artifacts: &OwnedDiceArtifacts) -> Result<Child> {
Shikha Panwar566c9672022-11-15 14:39:58 +0000885 // Use a fixed salt to scope the derivation to this API.
886 // Generated using hexdump -vn32 -e'14/1 "0x%02X, " 1 "\n"' /dev/urandom
887 // TODO(b/241541860) : Move this (& other salts) to a salt container, i.e. a global enum
888 let salt = [
889 0xFC, 0x1D, 0x35, 0x7B, 0x96, 0xF3, 0xEF, 0x17, 0x78, 0x7D, 0x70, 0xED, 0xEA, 0xFE, 0x1D,
890 0x6F, 0xB3, 0xF9, 0x40, 0xCE, 0xDD, 0x99, 0x40, 0xAA, 0xA7, 0x0E, 0x92, 0x73, 0x90, 0x86,
891 0x4A, 0x75,
892 ];
Alice Wang7e6c9352023-02-15 15:44:13 +0000893 let mut key = ZVec::new(ENCRYPTEDSTORE_KEYSIZE)?;
894 derive_sealing_key(dice_artifacts, &salt, ENCRYPTEDSTORE_KEY_IDENTIFIER.as_bytes(), &mut key)?;
Shikha Panwar566c9672022-11-15 14:39:58 +0000895
896 let mut cmd = Command::new(ENCRYPTEDSTORE_BIN);
897 cmd.arg("--blkdevice")
898 .arg(ENCRYPTEDSTORE_BACKING_DEVICE)
899 .arg("--key")
900 .arg(hex::encode(&*key))
Shikha Panwar9fd198f2022-11-18 17:43:43 +0000901 .args(["--mountpoint", ENCRYPTEDSTORE_MOUNTPOINT])
Shikha Panwar566c9672022-11-15 14:39:58 +0000902 .spawn()
903 .context("encryptedstore failed")
904}