blob: 78f8bb47688871469f7aa03a6223fdcbb9dbd427 [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
Andrew Sculld64ae7d2022-10-05 17:41:43 +000024use crate::dice::{DiceContext, DiceDriver};
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;
28use android_system_virtualmachineservice::aidl::android::system::virtualmachineservice::IVirtualMachineService::{
29 VM_BINDER_SERVICE_PORT, VM_STREAM_SERVICE_PORT, IVirtualMachineService,
30};
Jooyung Handd0a1732021-11-23 15:26:20 +090031use anyhow::{anyhow, bail, ensure, Context, Error, Result};
Alice Wang1bf3d782022-09-28 07:56:36 +000032use apkverify::{get_public_key_der, verify, V4Signature};
Andrew Sculld64ae7d2022-10-05 17:41:43 +000033use binder::{ProcessState, Strong};
Alan Stokes1f417c92022-09-29 15:13:28 +010034use diced_utils::cbor::{encode_header, encode_number};
Inseob Kim197748b2021-12-01 19:49:00 +090035use glob::glob;
Inseob Kim197748b2021-12-01 19:49:00 +090036use itertools::sorted;
Andrew Scull684590f2022-01-27 16:14:26 +000037use log::{error, info};
Alan Stokes0d1ef782022-09-27 13:46:35 +010038use microdroid_metadata::{write_metadata, Metadata, PayloadMetadata};
Alan Stokes1f417c92022-09-29 15:13:28 +010039use microdroid_payload_config::{Task, TaskType, VmPayloadConfig, OsConfig};
Andrew Sculla0d1b1a2022-05-24 19:32:47 +000040use openssl::sha::Sha512;
Jooyung Han4a9b3bf2021-09-10 17:19:00 +090041use payload::{get_apex_data_from_payload, load_metadata, to_metadata};
Andrew Scull34916a72022-01-30 21:34:24 +000042use rand::Fill;
Andrew Walbran7eb5ca42022-08-08 15:33:34 +000043use rpcbinder::get_vsock_rpc_interface;
Jiyong Parkbb4a9872021-09-06 15:59:21 +090044use rustutils::system_properties;
Joel Galenson482704c2021-07-29 15:53:53 -070045use rustutils::system_properties::PropertyWatcher;
Andrew Scullb2f44472022-01-21 14:41:34 +000046use std::convert::TryInto;
Inseob Kim197748b2021-12-01 19:49:00 +090047use std::fs::{self, create_dir, File, OpenOptions};
Inseob Kim11f40d02022-06-13 17:16:00 +090048use std::io::Write;
Inseob Kimc7d28c72021-10-25 14:28:10 +000049use std::os::unix::io::{FromRawFd, IntoRawFd};
Jooyung Hanf48ceb42021-06-01 18:00:04 +090050use std::path::Path;
Inseob Kim217038e2021-11-25 11:15:06 +090051use std::process::{Child, Command, Stdio};
Jiyong Park8611a6c2021-07-09 18:17:44 +090052use std::str;
Jiyong Parkbb4a9872021-09-06 15:59:21 +090053use std::time::{Duration, SystemTime};
Jiyong Park8611a6c2021-07-09 18:17:44 +090054use vsock::VsockStream;
Jooyung Han634e2d72021-06-10 16:27:38 +090055
56const WAIT_TIMEOUT: Duration = Duration::from_secs(10);
Inseob Kim197748b2021-12-01 19:49:00 +090057const MAIN_APK_PATH: &str = "/dev/block/by-name/microdroid-apk";
58const MAIN_APK_IDSIG_PATH: &str = "/dev/block/by-name/microdroid-apk-idsig";
59const MAIN_APK_DEVICE_NAME: &str = "microdroid-apk";
60const EXTRA_APK_PATH_PATTERN: &str = "/dev/block/by-name/extra-apk-*";
61const EXTRA_IDSIG_PATH_PATTERN: &str = "/dev/block/by-name/extra-idsig-*";
Jooyung Han19c1d6c2021-08-06 14:08:16 +090062const DM_MOUNTED_APK_PATH: &str = "/dev/block/mapper/microdroid-apk";
Inseob Kim217038e2021-11-25 11:15:06 +090063const APKDMVERITY_BIN: &str = "/system/bin/apkdmverity";
64const ZIPFUSE_BIN: &str = "/system/bin/zipfuse";
Andrew Scullab72ec52022-03-14 09:10:52 +000065const AVF_STRICT_BOOT: &str = "/sys/firmware/devicetree/base/chosen/avf,strict-boot";
66const AVF_NEW_INSTANCE: &str = "/sys/firmware/devicetree/base/chosen/avf,new-instance";
Inseob Kime379e7d2022-07-22 18:55:18 +090067const DEBUG_MICRODROID_NO_VERIFIED_BOOT: &str =
68 "/sys/firmware/devicetree/base/virtualization/guest/debug-microdroid,no-verified-boot";
Jooyung Han347d9f22021-05-28 00:05:14 +090069
Inseob Kim1b95f2e2021-08-19 13:17:40 +090070/// The CID representing the host VM
71const VMADDR_CID_HOST: u32 = 2;
72
Jiyong Parkbb4a9872021-09-06 15:59:21 +090073const APEX_CONFIG_DONE_PROP: &str = "apex_config.done";
Andrew Scull65ddfc42022-02-14 21:03:58 +000074const APP_DEBUGGABLE_PROP: &str = "ro.boot.microdroid.app_debuggable";
Alan Stokes60f82202022-10-07 16:40:07 +010075const APK_MOUNT_DONE_PROP: &str = "microdroid_manager.apk.mounted";
Jiyong Parkbb4a9872021-09-06 15:59:21 +090076
Inseob Kim11f40d02022-06-13 17:16:00 +090077// SYNC WITH virtualizationservice/src/crosvm.rs
78const FAILURE_SERIAL_DEVICE: &str = "/dev/ttyS1";
79
Jooyung Handd0a1732021-11-23 15:26:20 +090080#[derive(thiserror::Error, Debug)]
81enum MicrodroidError {
Inseob Kim11f40d02022-06-13 17:16:00 +090082 #[error("Cannot connect to virtualization service: {0}")]
83 FailedToConnectToVirtualizationService(String),
Jooyung Handd0a1732021-11-23 15:26:20 +090084 #[error("Payload has changed: {0}")]
85 PayloadChanged(String),
86 #[error("Payload verification has failed: {0}")]
87 PayloadVerificationFailed(String),
Jooyung Han5c6d4172021-12-06 14:17:52 +090088 #[error("Payload config is invalid: {0}")]
89 InvalidConfig(String),
Jooyung Handd0a1732021-11-23 15:26:20 +090090}
91
Alan Stokes2bead0d2022-09-05 16:58:34 +010092fn translate_error(err: &Error) -> (ErrorCode, String) {
Jooyung Handd0a1732021-11-23 15:26:20 +090093 if let Some(e) = err.downcast_ref::<MicrodroidError>() {
94 match e {
Alan Stokes2bead0d2022-09-05 16:58:34 +010095 MicrodroidError::PayloadChanged(msg) => (ErrorCode::PAYLOAD_CHANGED, msg.to_string()),
Jooyung Handd0a1732021-11-23 15:26:20 +090096 MicrodroidError::PayloadVerificationFailed(msg) => {
Alan Stokes2bead0d2022-09-05 16:58:34 +010097 (ErrorCode::PAYLOAD_VERIFICATION_FAILED, msg.to_string())
Jooyung Handd0a1732021-11-23 15:26:20 +090098 }
Alan Stokes2bead0d2022-09-05 16:58:34 +010099 MicrodroidError::InvalidConfig(msg) => {
100 (ErrorCode::PAYLOAD_CONFIG_INVALID, msg.to_string())
101 }
Inseob Kim11f40d02022-06-13 17:16:00 +0900102
103 // Connection failure won't be reported to VS; return the default value
104 MicrodroidError::FailedToConnectToVirtualizationService(msg) => {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100105 (ErrorCode::UNKNOWN, msg.to_string())
Inseob Kim11f40d02022-06-13 17:16:00 +0900106 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900107 }
108 } else {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100109 (ErrorCode::UNKNOWN, err.to_string())
Jooyung Handd0a1732021-11-23 15:26:20 +0900110 }
111}
112
Inseob Kim11f40d02022-06-13 17:16:00 +0900113fn write_death_reason_to_serial(err: &Error) -> Result<()> {
114 let death_reason = if let Some(e) = err.downcast_ref::<MicrodroidError>() {
115 match e {
116 MicrodroidError::FailedToConnectToVirtualizationService(_) => {
117 "MICRODROID_FAILED_TO_CONNECT_TO_VIRTUALIZATION_SERVICE"
118 }
119 MicrodroidError::PayloadChanged(_) => "MICRODROID_PAYLOAD_HAS_CHANGED",
120 MicrodroidError::PayloadVerificationFailed(_) => {
121 "MICRODROID_PAYLOAD_VERIFICATION_FAILED"
122 }
123 MicrodroidError::InvalidConfig(_) => "MICRODROID_INVALID_PAYLOAD_CONFIG",
124 }
125 } else {
126 "MICRODROID_UNKNOWN_RUNTIME_ERROR"
127 };
128
129 let death_reason_bytes = death_reason.as_bytes();
130 let mut sent_total = 0;
131 while sent_total < death_reason_bytes.len() {
132 // TODO(b/220071963): Sometimes, sending more than 16 bytes at once makes MM hang.
133 let begin = sent_total;
134 let end = std::cmp::min(begin.saturating_add(16), death_reason_bytes.len());
135 OpenOptions::new()
136 .read(false)
137 .write(true)
138 .open(FAILURE_SERIAL_DEVICE)?
139 .write_all(&death_reason_bytes[begin..end])?;
140 sent_total = end;
141 }
142
143 Ok(())
144}
145
Inseob Kim1b95f2e2021-08-19 13:17:40 +0900146fn get_vms_rpc_binder() -> Result<Strong<dyn IVirtualMachineService>> {
Andrew Walbran7eb5ca42022-08-08 15:33:34 +0000147 get_vsock_rpc_interface(VMADDR_CID_HOST, VM_BINDER_SERVICE_PORT as u32)
Andrew Walbranc4ce7872022-07-29 11:26:41 +0000148 .context("Cannot connect to RPC service")
Inseob Kim1b95f2e2021-08-19 13:17:40 +0900149}
150
Inseob Kim437f1052022-06-21 11:30:22 +0900151fn main() -> Result<()> {
152 scopeguard::defer! {
153 info!("Shutting down...");
Jooyung Hanbfe086f2021-10-28 10:15:45 +0900154 if let Err(e) = system_properties::write("sys.powerctl", "shutdown") {
155 error!("failed to shutdown {:?}", e);
156 }
Jooyung Han311b1202021-09-14 22:00:16 +0900157 }
Inseob Kim437f1052022-06-21 11:30:22 +0900158
159 try_main().map_err(|e| {
160 error!("Failed with {:?}.", e);
161 if let Err(e) = write_death_reason_to_serial(&e) {
162 error!("Failed to write death reason {:?}", e);
163 }
164 e
165 })
Jooyung Han311b1202021-09-14 22:00:16 +0900166}
167
168fn try_main() -> Result<()> {
Andrew Sculle127cff2022-02-15 15:34:04 +0000169 let _ = kernlog::init();
Jooyung Han347d9f22021-05-28 00:05:14 +0900170 info!("started.");
171
Jiyong Park202856e2022-08-22 16:04:26 +0900172 load_crashkernel_if_supported().context("Failed to load crashkernel")?;
173
Keir Fraser933f0ac2022-10-12 08:23:28 +0000174 swap::init_swap().context("Failed to initialise swap")?;
175 info!("swap enabled.");
176
Inseob Kim11f40d02022-06-13 17:16:00 +0900177 let service = get_vms_rpc_binder()
178 .context("cannot connect to VirtualMachineService")
179 .map_err(|e| MicrodroidError::FailedToConnectToVirtualizationService(e.to_string()))?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900180 match try_run_payload(&service) {
181 Ok(code) => {
182 info!("notifying payload finished");
183 service.notifyPayloadFinished(code)?;
184 if code == 0 {
185 info!("task successfully finished");
186 } else {
187 error!("task exited with exit code: {}", code);
188 }
189 Ok(())
190 }
191 Err(err) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900192 let (error_code, message) = translate_error(&err);
193 service.notifyError(error_code, &message)?;
194 Err(err)
195 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900196 }
197}
198
Alan Stokes1f417c92022-09-29 15:13:28 +0100199fn dice_derivation(
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000200 dice: DiceDriver,
Alan Stokes1f417c92022-09-29 15:13:28 +0100201 verified_data: &MicrodroidData,
202 payload_metadata: &PayloadMetadata,
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000203) -> Result<DiceContext> {
Andrew Scullb2f44472022-01-21 14:41:34 +0000204 // Calculate compound digests of code and authorities
Andrew Sculla0d1b1a2022-05-24 19:32:47 +0000205 let mut code_hash_ctx = Sha512::new();
206 let mut authority_hash_ctx = Sha512::new();
Andrew Scullb2f44472022-01-21 14:41:34 +0000207 code_hash_ctx.update(verified_data.apk_data.root_hash.as_ref());
208 authority_hash_ctx.update(verified_data.apk_data.pubkey.as_ref());
Inseob Kimb2519c52022-04-14 02:10:09 +0900209 for extra_apk in &verified_data.extra_apks_data {
Andrew Scullb2f44472022-01-21 14:41:34 +0000210 code_hash_ctx.update(extra_apk.root_hash.as_ref());
211 authority_hash_ctx.update(extra_apk.pubkey.as_ref());
212 }
Inseob Kimb2519c52022-04-14 02:10:09 +0900213 for apex in &verified_data.apex_data {
Andrew Scullb2f44472022-01-21 14:41:34 +0000214 code_hash_ctx.update(apex.root_digest.as_ref());
215 authority_hash_ctx.update(apex.public_key.as_ref());
216 }
Andrew Sculla0d1b1a2022-05-24 19:32:47 +0000217 let code_hash = code_hash_ctx.finish();
218 let authority_hash = authority_hash_ctx.finish();
Andrew Scullb2f44472022-01-21 14:41:34 +0000219
220 // {
221 // -70002: "Microdroid payload",
Alan Stokes1f417c92022-09-29 15:13:28 +0100222 // ? -71000: tstr // payload_config_path
223 // ? -71001: PayloadConfig
Andrew Scullb2f44472022-01-21 14:41:34 +0000224 // }
Alan Stokes1f417c92022-09-29 15:13:28 +0100225 // PayloadConfig = {
226 // 1: tstr // payload_binary_path
227 // // TODO(b/249064104 Either include args, or deprecate them
228 // }
229
Andrew Scullb2f44472022-01-21 14:41:34 +0000230 let mut config_desc = vec![
Alan Stokes1f417c92022-09-29 15:13:28 +0100231 0xa2, // map(2)
232 0x3a, 0x00, 0x01, 0x11, 0x71, // -70002
233 0x72, 0x4d, 0x69, 0x63, 0x72, 0x6f, 0x64, 0x72, 0x6f, 0x69, 0x64, 0x20, 0x70, 0x61, 0x79,
234 0x6c, 0x6f, 0x61, 0x64, // "Microdroid payload"
Andrew Scullb2f44472022-01-21 14:41:34 +0000235 ];
Alan Stokes1f417c92022-09-29 15:13:28 +0100236
237 match payload_metadata {
238 PayloadMetadata::config_path(payload_config_path) => {
239 encode_negative_number(-71000, &mut config_desc)?;
240 encode_tstr(payload_config_path, &mut config_desc)?;
241 }
242 PayloadMetadata::config(payload_config) => {
243 encode_negative_number(-71001, &mut config_desc)?;
244 encode_header(5, 1, &mut config_desc)?; // map(1)
245 encode_number(1, &mut config_desc)?;
246 encode_tstr(&payload_config.payload_binary_path, &mut config_desc)?;
247 }
248 }
Andrew Scullb2f44472022-01-21 14:41:34 +0000249
Andrew Scull65ddfc42022-02-14 21:03:58 +0000250 // Check app debuggability, conervatively assuming it is debuggable
251 let app_debuggable = system_properties::read_bool(APP_DEBUGGABLE_PROP, true)?;
252
Andrew Scullb2f44472022-01-21 14:41:34 +0000253 // Send the details to diced
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000254 let hidden = verified_data.salt.clone().try_into().unwrap();
255 dice.derive(code_hash, &config_desc, authority_hash, app_debuggable, hidden)
Andrew Scullb2f44472022-01-21 14:41:34 +0000256}
257
Alan Stokes1f417c92022-09-29 15:13:28 +0100258fn encode_tstr(tstr: &str, buffer: &mut Vec<u8>) -> Result<()> {
259 let bytes = tstr.as_bytes();
260 encode_header(3, bytes.len().try_into().unwrap(), buffer)?;
261 buffer.extend_from_slice(bytes);
262 Ok(())
263}
264
265fn encode_negative_number(n: i64, buffer: &mut dyn Write) -> Result<()> {
266 ensure!(n < 0);
267 let n = -1 - n;
268 encode_header(1, n.try_into().unwrap(), buffer)
269}
270
Andrew Scullab72ec52022-03-14 09:10:52 +0000271fn is_strict_boot() -> bool {
272 Path::new(AVF_STRICT_BOOT).exists()
273}
274
275fn is_new_instance() -> bool {
276 Path::new(AVF_NEW_INSTANCE).exists()
277}
278
Inseob Kime379e7d2022-07-22 18:55:18 +0900279fn is_verified_boot() -> bool {
280 !Path::new(DEBUG_MICRODROID_NO_VERIFIED_BOOT).exists()
281}
282
Jooyung Han5c6d4172021-12-06 14:17:52 +0900283fn try_run_payload(service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jooyung Han311b1202021-09-14 22:00:16 +0900284 let metadata = load_metadata().context("Failed to load payload metadata")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000285 let dice = DiceDriver::new(Path::new("/dev/open-dice0")).context("Failed to load DICE")?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900286
Jooyung Han311b1202021-09-14 22:00:16 +0900287 let mut instance = InstanceDisk::new().context("Failed to load instance.img")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000288 let saved_data =
289 instance.read_microdroid_data(&dice).context("Failed to read identity data")?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900290
Andrew Scullab72ec52022-03-14 09:10:52 +0000291 if is_strict_boot() {
292 // Provisioning must happen on the first boot and never again.
293 if is_new_instance() {
294 ensure!(
295 saved_data.is_none(),
296 MicrodroidError::InvalidConfig("Found instance data on first boot.".to_string())
297 );
298 } else {
299 ensure!(
300 saved_data.is_some(),
301 MicrodroidError::InvalidConfig("Instance data not found.".to_string())
302 );
303 };
304 }
305
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900306 // Verify the payload before using it.
Inseob Kim11f40d02022-06-13 17:16:00 +0900307 let verified_data = verify_payload(&metadata, saved_data.as_ref())
308 .context("Payload verification failed")
309 .map_err(|e| MicrodroidError::PayloadVerificationFailed(e.to_string()))?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900310
311 // In case identity is ignored (by debug policy), we should reuse existing payload data, even
312 // when the payload is changed. This is to keep the derived secret same as before.
313 let verified_data = if let Some(saved_data) = saved_data {
314 if !is_verified_boot() {
315 if saved_data != verified_data {
316 info!("Detected an update of the payload, but continue (regarding debug policy)")
317 }
318 } else {
319 ensure!(
320 saved_data == verified_data,
321 MicrodroidError::PayloadChanged(String::from(
322 "Detected an update of the payload which isn't supported yet."
323 ))
324 );
325 info!("Saved data is verified.");
326 }
327 saved_data
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900328 } else {
Jooyung Han7a343f92021-09-08 22:53:11 +0900329 info!("Saving verified data.");
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000330 instance
331 .write_microdroid_data(&verified_data, &dice)
332 .context("Failed to write identity data")?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900333 verified_data
334 };
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900335
Alan Stokes1f417c92022-09-29 15:13:28 +0100336 let payload_metadata = metadata.payload.ok_or_else(|| {
337 MicrodroidError::InvalidConfig("No payload config in metadata".to_string())
338 })?;
Alan Stokes0d1ef782022-09-27 13:46:35 +0100339
Inseob Kimb2519c52022-04-14 02:10:09 +0900340 // To minimize the exposure to untrusted data, derive dice profile as soon as possible.
341 info!("DICE derivation for payload");
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000342 let dice = dice_derivation(dice, &verified_data, &payload_metadata)?;
Inseob Kimb2519c52022-04-14 02:10:09 +0900343
Jooyung Hana6d11eb2021-09-10 11:48:05 +0900344 // Before reading a file from the APK, start zipfuse
Inseob Kim217038e2021-11-25 11:15:06 +0900345 run_zipfuse(
Alan Stokes60f82202022-10-07 16:40:07 +0100346 MountForExec::Allowed,
Inseob Kim217038e2021-11-25 11:15:06 +0900347 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:system_file:s0",
348 Path::new("/dev/block/mapper/microdroid-apk"),
349 Path::new("/mnt/apk"),
Alan Stokes60f82202022-10-07 16:40:07 +0100350 Some(APK_MOUNT_DONE_PROP),
Inseob Kim217038e2021-11-25 11:15:06 +0900351 )
352 .context("Failed to run zipfuse")?;
Jiyong Park21ce2c52021-08-28 02:32:17 +0900353
Alan Stokes1f417c92022-09-29 15:13:28 +0100354 let config = load_config(payload_metadata)?;
Shikha Panwar6f03c942022-04-13 20:26:50 +0000355
Alan Stokes01b3ef02022-09-22 17:43:24 +0100356 let task = config
357 .task
358 .as_ref()
359 .ok_or_else(|| MicrodroidError::InvalidConfig("No task in VM config".to_string()))?;
360
Inseob Kim197748b2021-12-01 19:49:00 +0900361 if config.extra_apks.len() != verified_data.extra_apks_data.len() {
362 return Err(anyhow!(
Alan Stokes1f417c92022-09-29 15:13:28 +0100363 "config expects {} extra apks, but found {}",
Inseob Kim197748b2021-12-01 19:49:00 +0900364 config.extra_apks.len(),
365 verified_data.extra_apks_data.len()
366 ));
367 }
368 mount_extra_apks(&config)?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900369
Jooyung Han5c6d4172021-12-06 14:17:52 +0900370 // Wait until apex config is done. (e.g. linker configuration for apexes)
371 // TODO(jooyung): wait until sys.boot_completed?
372 wait_for_apex_config_done()?;
373
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900374 // Start tombstone_transmit if enabled
375 if config.export_tombstones {
Alan Stokes01b3ef02022-09-22 17:43:24 +0100376 control_service("start", "tombstone_transmit")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900377 } else {
Alan Stokes01b3ef02022-09-22 17:43:24 +0100378 control_service("stop", "tombstoned")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900379 }
380
Alan Stokes01b3ef02022-09-22 17:43:24 +0100381 // Start authfs if enabled
382 if config.enable_authfs {
383 control_service("start", "authfs_service")?;
384 }
385
Alan Stokes60f82202022-10-07 16:40:07 +0100386 // Wait until zipfuse has mounted the APK so we can access the payload
387 wait_for_property_true(APK_MOUNT_DONE_PROP).context("Failed waiting for APK mount done")?;
388
Victor Hsieh8d006ba2022-05-02 09:42:02 -0700389 system_properties::write("dev.bootcomplete", "1").context("set dev.bootcomplete")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000390 register_vm_payload_service(service.clone(), dice)?;
Alice Wang59a9e562022-10-04 15:24:10 +0000391 ProcessState::start_thread_pool();
Alan Stokes01b3ef02022-09-22 17:43:24 +0100392 exec_task(task, service)
393}
394
395fn control_service(action: &str, service: &str) -> Result<()> {
396 system_properties::write(&format!("ctl.{}", action), service)
397 .with_context(|| format!("Failed to {} {}", action, service))
Jooyung Han347d9f22021-05-28 00:05:14 +0900398}
399
Inseob Kim217038e2021-11-25 11:15:06 +0900400struct ApkDmverityArgument<'a> {
401 apk: &'a str,
402 idsig: &'a str,
403 name: &'a str,
Inseob Kim197748b2021-12-01 19:49:00 +0900404 saved_root_hash: Option<&'a RootHash>,
Inseob Kim217038e2021-11-25 11:15:06 +0900405}
406
407fn run_apkdmverity(args: &[ApkDmverityArgument]) -> Result<Child> {
408 let mut cmd = Command::new(APKDMVERITY_BIN);
409
410 cmd.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
411
412 for argument in args {
413 cmd.arg("--apk").arg(argument.apk).arg(argument.idsig).arg(argument.name);
Inseob Kim197748b2021-12-01 19:49:00 +0900414 if let Some(root_hash) = argument.saved_root_hash {
415 cmd.arg(&to_hex_string(root_hash));
416 } else {
417 cmd.arg("none");
418 }
Inseob Kim217038e2021-11-25 11:15:06 +0900419 }
420
421 cmd.spawn().context("Spawn apkdmverity")
422}
423
Alan Stokes60f82202022-10-07 16:40:07 +0100424enum MountForExec {
425 Allowed,
426 Disallowed,
427}
428
429fn run_zipfuse(
430 noexec: MountForExec,
431 option: &str,
432 zip_path: &Path,
433 mount_dir: &Path,
434 ready_prop: Option<&str>,
435) -> Result<Child> {
Andrew Scullcc339a12022-07-04 12:44:19 +0000436 let mut cmd = Command::new(ZIPFUSE_BIN);
Alan Stokes60f82202022-10-07 16:40:07 +0100437 if let MountForExec::Disallowed = noexec {
Andrew Scullcc339a12022-07-04 12:44:19 +0000438 cmd.arg("--noexec");
439 }
Alan Stokes60f82202022-10-07 16:40:07 +0100440 if let Some(property_name) = ready_prop {
441 cmd.args(["-p", property_name]);
442 }
Andrew Scullcc339a12022-07-04 12:44:19 +0000443 cmd.arg("-o")
Inseob Kim217038e2021-11-25 11:15:06 +0900444 .arg(option)
445 .arg(zip_path)
446 .arg(mount_dir)
447 .stdin(Stdio::null())
448 .stdout(Stdio::null())
449 .stderr(Stdio::null())
450 .spawn()
451 .context("Spawn zipfuse")
452}
453
Inseob Kime379e7d2022-07-22 18:55:18 +0900454fn write_apex_payload_data(
455 saved_data: Option<&MicrodroidData>,
456 apex_data_from_payload: &[ApexData],
457) -> Result<()> {
458 if let Some(saved_apex_data) = saved_data.map(|d| &d.apex_data) {
459 // We don't support APEX updates. (assuming that update will change root digest)
460 ensure!(
461 saved_apex_data == apex_data_from_payload,
462 MicrodroidError::PayloadChanged(String::from("APEXes have changed."))
463 );
464 let apex_metadata = to_metadata(apex_data_from_payload);
465 // Pass metadata(with public keys and root digests) to apexd so that it uses the passed
466 // metadata instead of the default one (/dev/block/by-name/payload-metadata)
467 OpenOptions::new()
468 .create_new(true)
469 .write(true)
470 .open("/apex/vm-payload-metadata")
471 .context("Failed to open /apex/vm-payload-metadata")
472 .and_then(|f| write_metadata(&apex_metadata, f))?;
473 }
474 Ok(())
475}
476
Jooyung Han7a343f92021-09-08 22:53:11 +0900477// Verify payload before executing it. For APK payload, Full verification (which is slow) is done
478// when the root_hash values from the idsig file and the instance disk are different. This function
479// returns the verified root hash (for APK payload) and pubkeys (for APEX payloads) that can be
480// saved to the instance disk.
481fn verify_payload(
482 metadata: &Metadata,
483 saved_data: Option<&MicrodroidData>,
484) -> Result<MicrodroidData> {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900485 let start_time = SystemTime::now();
486
Inseob Kim197748b2021-12-01 19:49:00 +0900487 // Verify main APK
Jooyung Han7a343f92021-09-08 22:53:11 +0900488 let root_hash = saved_data.map(|d| &d.apk_data.root_hash);
Inseob Kim197748b2021-12-01 19:49:00 +0900489 let root_hash_from_idsig = get_apk_root_hash_from_idsig(MAIN_APK_IDSIG_PATH)?;
Jiyong Parkf7dea252021-09-08 01:42:54 +0900490 let root_hash_trustful = root_hash == Some(&root_hash_from_idsig);
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900491
Jiyong Parkf7dea252021-09-08 01:42:54 +0900492 // 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 +0900493 // instead of the value read from the idsig file.
Inseob Kim197748b2021-12-01 19:49:00 +0900494 let main_apk_argument = {
495 ApkDmverityArgument {
496 apk: MAIN_APK_PATH,
497 idsig: MAIN_APK_IDSIG_PATH,
498 name: MAIN_APK_DEVICE_NAME,
499 saved_root_hash: if root_hash_trustful {
500 Some(root_hash_from_idsig.as_ref())
501 } else {
502 None
503 },
504 }
505 };
506 let mut apkdmverity_arguments = vec![main_apk_argument];
507
508 // Verify extra APKs
509 // For now, we can't read the payload config, so glob APKs and idsigs.
510 // Later, we'll see if it matches with the payload config.
511
512 // sort globbed paths to match apks (extra-apk-{idx}) and idsigs (extra-idsig-{idx})
513 // e.g. "extra-apk-0" corresponds to "extra-idsig-0"
514 let extra_apks =
515 sorted(glob(EXTRA_APK_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
516 let extra_idsigs =
517 sorted(glob(EXTRA_IDSIG_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
518 if extra_apks.len() != extra_idsigs.len() {
519 return Err(anyhow!(
520 "Extra apks/idsigs mismatch: {} apks but {} idsigs",
521 extra_apks.len(),
522 extra_idsigs.len()
523 ));
524 }
525 let extra_apks_count = extra_apks.len();
526
527 let (extra_apk_names, extra_root_hashes_from_idsig): (Vec<_>, Vec<_>) = extra_idsigs
528 .iter()
529 .enumerate()
530 .map(|(i, extra_idsig)| {
531 (
532 format!("extra-apk-{}", i),
Alice Wang89cff012022-09-26 10:05:16 +0000533 get_apk_root_hash_from_idsig(extra_idsig)
Inseob Kim197748b2021-12-01 19:49:00 +0900534 .expect("Can't find root hash from extra idsig"),
535 )
536 })
537 .unzip();
538
539 let saved_extra_root_hashes: Vec<_> = saved_data
540 .map(|d| d.extra_apks_data.iter().map(|apk_data| &apk_data.root_hash).collect())
541 .unwrap_or_else(Vec::new);
542 let extra_root_hashes_trustful: Vec<_> = extra_root_hashes_from_idsig
543 .iter()
544 .enumerate()
545 .map(|(i, root_hash_from_idsig)| {
546 saved_extra_root_hashes.get(i).copied() == Some(root_hash_from_idsig)
547 })
548 .collect();
549
550 for i in 0..extra_apks_count {
551 apkdmverity_arguments.push({
552 ApkDmverityArgument {
553 apk: extra_apks[i].to_str().unwrap(),
554 idsig: extra_idsigs[i].to_str().unwrap(),
555 name: &extra_apk_names[i],
556 saved_root_hash: if extra_root_hashes_trustful[i] {
557 Some(&extra_root_hashes_from_idsig[i])
558 } else {
559 None
560 },
561 }
562 });
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900563 }
564
565 // Start apkdmverity and wait for the dm-verify block
Inseob Kim197748b2021-12-01 19:49:00 +0900566 let mut apkdmverity_child = run_apkdmverity(&apkdmverity_arguments)?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900567
Jooyung Hanc8deb472021-09-13 13:48:25 +0900568 // While waiting for apkdmverity to mount APK, gathers public keys and root digests from
569 // APEX payload.
Jooyung Han7a343f92021-09-08 22:53:11 +0900570 let apex_data_from_payload = get_apex_data_from_payload(metadata)?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900571
572 // Writing /apex/vm-payload-metadata is to verify that the payload isn't changed.
573 // Skip writing it if the debug policy ignoring identity is on
574 if is_verified_boot() {
575 write_apex_payload_data(saved_data, &apex_data_from_payload)?;
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900576 }
Inseob Kime379e7d2022-07-22 18:55:18 +0900577
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900578 // Start apexd to activate APEXes
579 system_properties::write("ctl.start", "apexd-vm")?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900580
Inseob Kim217038e2021-11-25 11:15:06 +0900581 // TODO(inseob): add timeout
582 apkdmverity_child.wait()?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900583
Jiyong Parkf7dea252021-09-08 01:42:54 +0900584 // Do the full verification if the root_hash is un-trustful. This requires the full scanning of
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900585 // 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 +0900586 // 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 +0900587 // of the VM or APK was updated in the host.
588 // TODO(jooyung): consider multithreading to make this faster
Inseob Kim197748b2021-12-01 19:49:00 +0900589 let main_apk_pubkey = get_public_key_from_apk(DM_MOUNTED_APK_PATH, root_hash_trustful)?;
590 let extra_apks_data = extra_root_hashes_from_idsig
591 .into_iter()
592 .enumerate()
593 .map(|(i, extra_root_hash)| {
594 let mount_path = format!("/dev/block/mapper/{}", &extra_apk_names[i]);
595 let apk_pubkey = get_public_key_from_apk(&mount_path, extra_root_hashes_trustful[i])?;
596 Ok(ApkData { root_hash: extra_root_hash, pubkey: apk_pubkey })
597 })
598 .collect::<Result<Vec<_>>>()?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900599
600 info!("payload verification successful. took {:#?}", start_time.elapsed().unwrap());
601
Andrew Scull34916a72022-01-30 21:34:24 +0000602 // Use the salt from a verified instance, or generate a salt for a new instance.
603 let salt = if let Some(saved_data) = saved_data {
604 saved_data.salt.clone()
605 } else {
606 let mut salt = vec![0u8; 64];
607 salt.as_mut_slice().try_fill(&mut rand::thread_rng())?;
608 salt
609 };
610
Jiyong Parkf7dea252021-09-08 01:42:54 +0900611 // At this point, we can ensure that the root_hash from the idsig file is trusted, either by
612 // fully verifying the APK or by comparing it with the saved root_hash.
Jooyung Han7a343f92021-09-08 22:53:11 +0900613 Ok(MicrodroidData {
Andrew Scull34916a72022-01-30 21:34:24 +0000614 salt,
Inseob Kim197748b2021-12-01 19:49:00 +0900615 apk_data: ApkData { root_hash: root_hash_from_idsig, pubkey: main_apk_pubkey },
616 extra_apks_data,
Jooyung Han7a343f92021-09-08 22:53:11 +0900617 apex_data: apex_data_from_payload,
618 })
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900619}
620
Inseob Kim197748b2021-12-01 19:49:00 +0900621fn mount_extra_apks(config: &VmPayloadConfig) -> Result<()> {
622 // For now, only the number of apks is important, as the mount point and dm-verity name is fixed
623 for i in 0..config.extra_apks.len() {
624 let mount_dir = format!("/mnt/extra-apk/{}", i);
625 create_dir(Path::new(&mount_dir)).context("Failed to create mount dir for extra apks")?;
626
627 // don't wait, just detach
628 run_zipfuse(
Alan Stokes60f82202022-10-07 16:40:07 +0100629 MountForExec::Disallowed,
Inseob Kim197748b2021-12-01 19:49:00 +0900630 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:extra_apk_file:s0",
631 Path::new(&format!("/dev/block/mapper/extra-apk-{}", i)),
632 Path::new(&mount_dir),
Alan Stokes60f82202022-10-07 16:40:07 +0100633 None,
Inseob Kim197748b2021-12-01 19:49:00 +0900634 )
635 .context("Failed to zipfuse extra apks")?;
636 }
637
638 Ok(())
639}
640
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900641// Waits until linker config is generated
642fn wait_for_apex_config_done() -> Result<()> {
Alan Stokes60f82202022-10-07 16:40:07 +0100643 wait_for_property_true(APEX_CONFIG_DONE_PROP).context("Failed waiting for apex config done")
644}
645
646fn wait_for_property_true(property_name: &str) -> Result<()> {
647 let mut prop = PropertyWatcher::new(property_name)?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900648 loop {
649 prop.wait()?;
Alan Stokes60f82202022-10-07 16:40:07 +0100650 if system_properties::read_bool(property_name, false)? {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900651 break;
652 }
653 }
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900654 Ok(())
655}
656
Alice Wang89cff012022-09-26 10:05:16 +0000657fn get_apk_root_hash_from_idsig<P: AsRef<Path>>(idsig_path: P) -> Result<Box<RootHash>> {
658 Ok(V4Signature::from_idsig_path(idsig_path)?.hashing_info.raw_root_hash)
Jiyong Park21ce2c52021-08-28 02:32:17 +0900659}
660
Inseob Kim197748b2021-12-01 19:49:00 +0900661fn get_public_key_from_apk(apk: &str, root_hash_trustful: bool) -> Result<Box<[u8]>> {
662 if !root_hash_trustful {
663 verify(apk).context(MicrodroidError::PayloadVerificationFailed(format!(
664 "failed to verify {}",
665 apk
666 )))
667 } else {
668 get_public_key_der(apk)
669 }
670}
671
Alan Stokes1f417c92022-09-29 15:13:28 +0100672fn load_config(payload_metadata: PayloadMetadata) -> Result<VmPayloadConfig> {
673 match payload_metadata {
674 PayloadMetadata::config_path(path) => {
675 let path = Path::new(&path);
676 info!("loading config from {:?}...", path);
677 let file = ioutil::wait_for_file(path, WAIT_TIMEOUT)?;
678 Ok(serde_json::from_reader(file)?)
679 }
680 PayloadMetadata::config(payload_config) => {
681 let task = Task {
682 type_: TaskType::MicrodroidLauncher,
683 command: payload_config.payload_binary_path,
684 args: payload_config.args.into_vec(),
685 };
686 Ok(VmPayloadConfig {
687 os: OsConfig { name: "microdroid".to_owned() },
688 task: Some(task),
689 apexes: vec![],
690 extra_apks: vec![],
691 prefer_staged: false,
692 export_tombstones: false,
693 enable_authfs: false,
694 })
695 }
696 }
Jooyung Han634e2d72021-06-10 16:27:38 +0900697}
698
Jiyong Park202856e2022-08-22 16:04:26 +0900699/// Loads the crashkernel into memory using kexec if the VM is loaded with `crashkernel=' parameter
700/// in the cmdline.
701fn load_crashkernel_if_supported() -> Result<()> {
702 let supported = std::fs::read_to_string("/proc/cmdline")?.contains(" crashkernel=");
703 info!("ramdump supported: {}", supported);
704 if supported {
705 let status = Command::new("/system/bin/kexec_load").status()?;
706 if !status.success() {
707 return Err(anyhow!("Failed to load crashkernel: {:?}", status));
708 }
709 }
710 Ok(())
711}
712
Jiyong Park8611a6c2021-07-09 18:17:44 +0900713/// Executes the given task. Stdout of the task is piped into the vsock stream to the
714/// virtualizationservice in the host side.
Jooyung Han5c6d4172021-12-06 14:17:52 +0900715fn exec_task(task: &Task, service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900716 info!("executing main task {:?}...", task);
Inseob Kim86ca0162021-10-20 02:21:02 +0000717 let mut command = build_command(task)?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900718
719 info!("notifying payload started");
Inseob Kimc7d28c72021-10-25 14:28:10 +0000720 service.notifyPayloadStarted()?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900721
Inseob Kim86ca0162021-10-20 02:21:02 +0000722 let exit_status = command.spawn()?.wait()?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900723 exit_status.code().ok_or_else(|| anyhow!("Failed to get exit_code from the paylaod."))
Jooyung Han347d9f22021-05-28 00:05:14 +0900724}
Jooyung Han634e2d72021-06-10 16:27:38 +0900725
726fn build_command(task: &Task) -> Result<Command> {
Inseob Kim7f61fe72021-08-20 20:50:47 +0900727 const VMADDR_CID_HOST: u32 = 2;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900728
729 let mut command = match task.type_ {
Jooyung Han634e2d72021-06-10 16:27:38 +0900730 TaskType::Executable => {
731 let mut command = Command::new(&task.command);
732 command.args(&task.args);
733 command
734 }
735 TaskType::MicrodroidLauncher => {
736 let mut command = Command::new("/system/bin/microdroid_launcher");
737 command.arg(find_library_path(&task.command)?).args(&task.args);
738 command
739 }
Inseob Kim7f61fe72021-08-20 20:50:47 +0900740 };
741
Inseob Kimd0587562021-09-01 21:27:32 +0900742 match VsockStream::connect_with_cid_port(VMADDR_CID_HOST, VM_STREAM_SERVICE_PORT as u32) {
Inseob Kim7f61fe72021-08-20 20:50:47 +0900743 Ok(stream) => {
744 // SAFETY: the ownership of the underlying file descriptor is transferred from stream
745 // to the file object, and then into the Command object. When the command is finished,
746 // the file descriptor is closed.
747 let file = unsafe { File::from_raw_fd(stream.into_raw_fd()) };
748 command
749 .stdin(Stdio::from(file.try_clone()?))
750 .stdout(Stdio::from(file.try_clone()?))
751 .stderr(Stdio::from(file));
752 }
753 Err(e) => {
754 error!("failed to connect to virtualization service: {}", e);
755 // Don't fail hard here. Even if we failed to connect to the virtualizationservice,
756 // we keep executing the task. This can happen if the owner of the VM doesn't register
757 // callback to accept the stream. Use /dev/null as the stream so that the task can
758 // make progress without waiting for someone to consume the output.
759 command.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
760 }
761 }
762
763 Ok(command)
Jooyung Han634e2d72021-06-10 16:27:38 +0900764}
765
766fn find_library_path(name: &str) -> Result<String> {
767 let mut watcher = PropertyWatcher::new("ro.product.cpu.abilist")?;
768 let value = watcher.read(|_name, value| Ok(value.trim().to_string()))?;
769 let abi = value.split(',').next().ok_or_else(|| anyhow!("no abilist"))?;
770 let path = format!("/mnt/apk/lib/{}/{}", abi, name);
771
772 let metadata = fs::metadata(&path)?;
773 if !metadata.is_file() {
774 bail!("{} is not a file", &path);
775 }
776
777 Ok(path)
778}
Jiyong Park21ce2c52021-08-28 02:32:17 +0900779
780fn to_hex_string(buf: &[u8]) -> String {
781 buf.iter().map(|b| format!("{:02X}", b)).collect()
782}