blob: 1349ede607be5c5d96622ace18f17e5775185295 [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
Jiyong Park21ce2c52021-08-28 02:32:17 +090017mod instance;
Jooyung Hanf48ceb42021-06-01 18:00:04 +090018mod ioutil;
Jooyung Han7a343f92021-09-08 22:53:11 +090019mod payload;
Alice Wang59a9e562022-10-04 15:24:10 +000020mod vm_payload_service;
Jooyung Han347d9f22021-05-28 00:05:14 +090021
Inseob Kime379e7d2022-07-22 18:55:18 +090022use crate::instance::{ApexData, ApkData, InstanceDisk, MicrodroidData, RootHash};
Alice Wang59a9e562022-10-04 15:24:10 +000023use crate::vm_payload_service::register_vm_payload_service;
Andrew Scullb2f44472022-01-21 14:41:34 +000024use android_hardware_security_dice::aidl::android::hardware::security::dice::{
25 Config::Config, InputValues::InputValues, Mode::Mode,
26};
27use android_security_dice::aidl::android::security::dice::IDiceMaintenance::IDiceMaintenance;
Alan Stokes2bead0d2022-09-05 16:58:34 +010028use android_system_virtualizationcommon::aidl::android::system::virtualizationcommon::ErrorCode::ErrorCode;
29use android_system_virtualmachineservice::aidl::android::system::virtualmachineservice::IVirtualMachineService::{
30 VM_BINDER_SERVICE_PORT, VM_STREAM_SERVICE_PORT, IVirtualMachineService,
31};
Jooyung Handd0a1732021-11-23 15:26:20 +090032use anyhow::{anyhow, bail, ensure, Context, Error, Result};
Alice Wang1bf3d782022-09-28 07:56:36 +000033use apkverify::{get_public_key_der, verify, V4Signature};
Alice Wang59a9e562022-10-04 15:24:10 +000034use binder::{ProcessState, wait_for_interface, Strong};
Alan Stokes1f417c92022-09-29 15:13:28 +010035use diced_utils::cbor::{encode_header, encode_number};
Inseob Kim197748b2021-12-01 19:49:00 +090036use glob::glob;
Inseob Kim197748b2021-12-01 19:49:00 +090037use itertools::sorted;
Andrew Scull684590f2022-01-27 16:14:26 +000038use log::{error, info};
Alan Stokes0d1ef782022-09-27 13:46:35 +010039use microdroid_metadata::{write_metadata, Metadata, PayloadMetadata};
Alan Stokes1f417c92022-09-29 15:13:28 +010040use microdroid_payload_config::{Task, TaskType, VmPayloadConfig, OsConfig};
Andrew Sculla0d1b1a2022-05-24 19:32:47 +000041use openssl::sha::Sha512;
Jooyung Han4a9b3bf2021-09-10 17:19:00 +090042use payload::{get_apex_data_from_payload, load_metadata, to_metadata};
Andrew Scull34916a72022-01-30 21:34:24 +000043use rand::Fill;
Andrew Walbran7eb5ca42022-08-08 15:33:34 +000044use rpcbinder::get_vsock_rpc_interface;
Jiyong Parkbb4a9872021-09-06 15:59:21 +090045use rustutils::system_properties;
Joel Galenson482704c2021-07-29 15:53:53 -070046use rustutils::system_properties::PropertyWatcher;
Andrew Scullb2f44472022-01-21 14:41:34 +000047use std::convert::TryInto;
Inseob Kim197748b2021-12-01 19:49:00 +090048use std::fs::{self, create_dir, File, OpenOptions};
Inseob Kim11f40d02022-06-13 17:16:00 +090049use std::io::Write;
Inseob Kimc7d28c72021-10-25 14:28:10 +000050use std::os::unix::io::{FromRawFd, IntoRawFd};
Jooyung Hanf48ceb42021-06-01 18:00:04 +090051use std::path::Path;
Inseob Kim217038e2021-11-25 11:15:06 +090052use std::process::{Child, Command, Stdio};
Jiyong Park8611a6c2021-07-09 18:17:44 +090053use std::str;
Jiyong Parkbb4a9872021-09-06 15:59:21 +090054use std::time::{Duration, SystemTime};
Jiyong Park8611a6c2021-07-09 18:17:44 +090055use vsock::VsockStream;
Jooyung Han634e2d72021-06-10 16:27:38 +090056
57const WAIT_TIMEOUT: Duration = Duration::from_secs(10);
Inseob Kim197748b2021-12-01 19:49:00 +090058const MAIN_APK_PATH: &str = "/dev/block/by-name/microdroid-apk";
59const MAIN_APK_IDSIG_PATH: &str = "/dev/block/by-name/microdroid-apk-idsig";
60const MAIN_APK_DEVICE_NAME: &str = "microdroid-apk";
61const EXTRA_APK_PATH_PATTERN: &str = "/dev/block/by-name/extra-apk-*";
62const EXTRA_IDSIG_PATH_PATTERN: &str = "/dev/block/by-name/extra-idsig-*";
Jooyung Han19c1d6c2021-08-06 14:08:16 +090063const DM_MOUNTED_APK_PATH: &str = "/dev/block/mapper/microdroid-apk";
Inseob Kim217038e2021-11-25 11:15:06 +090064const APKDMVERITY_BIN: &str = "/system/bin/apkdmverity";
65const ZIPFUSE_BIN: &str = "/system/bin/zipfuse";
Andrew Scullab72ec52022-03-14 09:10:52 +000066const AVF_STRICT_BOOT: &str = "/sys/firmware/devicetree/base/chosen/avf,strict-boot";
67const AVF_NEW_INSTANCE: &str = "/sys/firmware/devicetree/base/chosen/avf,new-instance";
Inseob Kime379e7d2022-07-22 18:55:18 +090068const DEBUG_MICRODROID_NO_VERIFIED_BOOT: &str =
69 "/sys/firmware/devicetree/base/virtualization/guest/debug-microdroid,no-verified-boot";
Jooyung Han347d9f22021-05-28 00:05:14 +090070
Inseob Kim1b95f2e2021-08-19 13:17:40 +090071/// The CID representing the host VM
72const VMADDR_CID_HOST: u32 = 2;
73
Jiyong Parkbb4a9872021-09-06 15:59:21 +090074const APEX_CONFIG_DONE_PROP: &str = "apex_config.done";
Andrew Scull65ddfc42022-02-14 21:03:58 +000075const APP_DEBUGGABLE_PROP: &str = "ro.boot.microdroid.app_debuggable";
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
Inseob Kim11f40d02022-06-13 17:16:00 +0900174 let service = get_vms_rpc_binder()
175 .context("cannot connect to VirtualMachineService")
176 .map_err(|e| MicrodroidError::FailedToConnectToVirtualizationService(e.to_string()))?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900177 match try_run_payload(&service) {
178 Ok(code) => {
179 info!("notifying payload finished");
180 service.notifyPayloadFinished(code)?;
181 if code == 0 {
182 info!("task successfully finished");
183 } else {
184 error!("task exited with exit code: {}", code);
185 }
186 Ok(())
187 }
188 Err(err) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900189 let (error_code, message) = translate_error(&err);
190 service.notifyError(error_code, &message)?;
191 Err(err)
192 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900193 }
194}
195
Alan Stokes1f417c92022-09-29 15:13:28 +0100196fn dice_derivation(
197 verified_data: &MicrodroidData,
198 payload_metadata: &PayloadMetadata,
199) -> Result<()> {
Andrew Scullb2f44472022-01-21 14:41:34 +0000200 // Calculate compound digests of code and authorities
Andrew Sculla0d1b1a2022-05-24 19:32:47 +0000201 let mut code_hash_ctx = Sha512::new();
202 let mut authority_hash_ctx = Sha512::new();
Andrew Scullb2f44472022-01-21 14:41:34 +0000203 code_hash_ctx.update(verified_data.apk_data.root_hash.as_ref());
204 authority_hash_ctx.update(verified_data.apk_data.pubkey.as_ref());
Inseob Kimb2519c52022-04-14 02:10:09 +0900205 for extra_apk in &verified_data.extra_apks_data {
Andrew Scullb2f44472022-01-21 14:41:34 +0000206 code_hash_ctx.update(extra_apk.root_hash.as_ref());
207 authority_hash_ctx.update(extra_apk.pubkey.as_ref());
208 }
Inseob Kimb2519c52022-04-14 02:10:09 +0900209 for apex in &verified_data.apex_data {
Andrew Scullb2f44472022-01-21 14:41:34 +0000210 code_hash_ctx.update(apex.root_digest.as_ref());
211 authority_hash_ctx.update(apex.public_key.as_ref());
212 }
Andrew Sculla0d1b1a2022-05-24 19:32:47 +0000213 let code_hash = code_hash_ctx.finish();
214 let authority_hash = authority_hash_ctx.finish();
Andrew Scullb2f44472022-01-21 14:41:34 +0000215
216 // {
217 // -70002: "Microdroid payload",
Alan Stokes1f417c92022-09-29 15:13:28 +0100218 // ? -71000: tstr // payload_config_path
219 // ? -71001: PayloadConfig
Andrew Scullb2f44472022-01-21 14:41:34 +0000220 // }
Alan Stokes1f417c92022-09-29 15:13:28 +0100221 // PayloadConfig = {
222 // 1: tstr // payload_binary_path
223 // // TODO(b/249064104 Either include args, or deprecate them
224 // }
225
Andrew Scullb2f44472022-01-21 14:41:34 +0000226 let mut config_desc = vec![
Alan Stokes1f417c92022-09-29 15:13:28 +0100227 0xa2, // map(2)
228 0x3a, 0x00, 0x01, 0x11, 0x71, // -70002
229 0x72, 0x4d, 0x69, 0x63, 0x72, 0x6f, 0x64, 0x72, 0x6f, 0x69, 0x64, 0x20, 0x70, 0x61, 0x79,
230 0x6c, 0x6f, 0x61, 0x64, // "Microdroid payload"
Andrew Scullb2f44472022-01-21 14:41:34 +0000231 ];
Alan Stokes1f417c92022-09-29 15:13:28 +0100232
233 match payload_metadata {
234 PayloadMetadata::config_path(payload_config_path) => {
235 encode_negative_number(-71000, &mut config_desc)?;
236 encode_tstr(payload_config_path, &mut config_desc)?;
237 }
238 PayloadMetadata::config(payload_config) => {
239 encode_negative_number(-71001, &mut config_desc)?;
240 encode_header(5, 1, &mut config_desc)?; // map(1)
241 encode_number(1, &mut config_desc)?;
242 encode_tstr(&payload_config.payload_binary_path, &mut config_desc)?;
243 }
244 }
Andrew Scullb2f44472022-01-21 14:41:34 +0000245
Andrew Scull65ddfc42022-02-14 21:03:58 +0000246 // Check app debuggability, conervatively assuming it is debuggable
247 let app_debuggable = system_properties::read_bool(APP_DEBUGGABLE_PROP, true)?;
248
Andrew Scullb2f44472022-01-21 14:41:34 +0000249 // Send the details to diced
250 let diced =
251 wait_for_interface::<dyn IDiceMaintenance>("android.security.dice.IDiceMaintenance")
252 .context("IDiceMaintenance service not found")?;
253 diced
254 .demoteSelf(&[InputValues {
255 codeHash: code_hash,
256 config: Config { desc: config_desc },
257 authorityHash: authority_hash,
258 authorityDescriptor: None,
Andrew Scull65ddfc42022-02-14 21:03:58 +0000259 mode: if app_debuggable { Mode::DEBUG } else { Mode::NORMAL },
Inseob Kimb2519c52022-04-14 02:10:09 +0900260 hidden: verified_data.salt.clone().try_into().unwrap(),
Andrew Scullb2f44472022-01-21 14:41:34 +0000261 }])
262 .context("IDiceMaintenance::demoteSelf failed")?;
263 Ok(())
264}
265
Alan Stokes1f417c92022-09-29 15:13:28 +0100266fn encode_tstr(tstr: &str, buffer: &mut Vec<u8>) -> Result<()> {
267 let bytes = tstr.as_bytes();
268 encode_header(3, bytes.len().try_into().unwrap(), buffer)?;
269 buffer.extend_from_slice(bytes);
270 Ok(())
271}
272
273fn encode_negative_number(n: i64, buffer: &mut dyn Write) -> Result<()> {
274 ensure!(n < 0);
275 let n = -1 - n;
276 encode_header(1, n.try_into().unwrap(), buffer)
277}
278
Andrew Scullab72ec52022-03-14 09:10:52 +0000279fn is_strict_boot() -> bool {
280 Path::new(AVF_STRICT_BOOT).exists()
281}
282
283fn is_new_instance() -> bool {
284 Path::new(AVF_NEW_INSTANCE).exists()
285}
286
Inseob Kime379e7d2022-07-22 18:55:18 +0900287fn is_verified_boot() -> bool {
288 !Path::new(DEBUG_MICRODROID_NO_VERIFIED_BOOT).exists()
289}
290
Jooyung Han5c6d4172021-12-06 14:17:52 +0900291fn try_run_payload(service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jooyung Han311b1202021-09-14 22:00:16 +0900292 let metadata = load_metadata().context("Failed to load payload metadata")?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900293
Jooyung Han311b1202021-09-14 22:00:16 +0900294 let mut instance = InstanceDisk::new().context("Failed to load instance.img")?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900295 let saved_data = instance.read_microdroid_data().context("Failed to read identity data")?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900296
Andrew Scullab72ec52022-03-14 09:10:52 +0000297 if is_strict_boot() {
298 // Provisioning must happen on the first boot and never again.
299 if is_new_instance() {
300 ensure!(
301 saved_data.is_none(),
302 MicrodroidError::InvalidConfig("Found instance data on first boot.".to_string())
303 );
304 } else {
305 ensure!(
306 saved_data.is_some(),
307 MicrodroidError::InvalidConfig("Instance data not found.".to_string())
308 );
309 };
310 }
311
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900312 // Verify the payload before using it.
Inseob Kim11f40d02022-06-13 17:16:00 +0900313 let verified_data = verify_payload(&metadata, saved_data.as_ref())
314 .context("Payload verification failed")
315 .map_err(|e| MicrodroidError::PayloadVerificationFailed(e.to_string()))?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900316
317 // In case identity is ignored (by debug policy), we should reuse existing payload data, even
318 // when the payload is changed. This is to keep the derived secret same as before.
319 let verified_data = if let Some(saved_data) = saved_data {
320 if !is_verified_boot() {
321 if saved_data != verified_data {
322 info!("Detected an update of the payload, but continue (regarding debug policy)")
323 }
324 } else {
325 ensure!(
326 saved_data == verified_data,
327 MicrodroidError::PayloadChanged(String::from(
328 "Detected an update of the payload which isn't supported yet."
329 ))
330 );
331 info!("Saved data is verified.");
332 }
333 saved_data
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900334 } else {
Jooyung Han7a343f92021-09-08 22:53:11 +0900335 info!("Saving verified data.");
336 instance.write_microdroid_data(&verified_data).context("Failed to write identity data")?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900337 verified_data
338 };
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900339
Alan Stokes1f417c92022-09-29 15:13:28 +0100340 let payload_metadata = metadata.payload.ok_or_else(|| {
341 MicrodroidError::InvalidConfig("No payload config in metadata".to_string())
342 })?;
Alan Stokes0d1ef782022-09-27 13:46:35 +0100343
Inseob Kimb2519c52022-04-14 02:10:09 +0900344 // To minimize the exposure to untrusted data, derive dice profile as soon as possible.
345 info!("DICE derivation for payload");
Alan Stokes1f417c92022-09-29 15:13:28 +0100346 dice_derivation(&verified_data, &payload_metadata)?;
Inseob Kimb2519c52022-04-14 02:10:09 +0900347
Jooyung Hana6d11eb2021-09-10 11:48:05 +0900348 // Before reading a file from the APK, start zipfuse
Andrew Scullcc339a12022-07-04 12:44:19 +0000349 let noexec = false;
Inseob Kim217038e2021-11-25 11:15:06 +0900350 run_zipfuse(
Andrew Scullcc339a12022-07-04 12:44:19 +0000351 noexec,
Inseob Kim217038e2021-11-25 11:15:06 +0900352 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:system_file:s0",
353 Path::new("/dev/block/mapper/microdroid-apk"),
354 Path::new("/mnt/apk"),
355 )
356 .context("Failed to run zipfuse")?;
Jiyong Park21ce2c52021-08-28 02:32:17 +0900357
Alan Stokes1f417c92022-09-29 15:13:28 +0100358 let config = load_config(payload_metadata)?;
Shikha Panwar6f03c942022-04-13 20:26:50 +0000359
Alan Stokes01b3ef02022-09-22 17:43:24 +0100360 let task = config
361 .task
362 .as_ref()
363 .ok_or_else(|| MicrodroidError::InvalidConfig("No task in VM config".to_string()))?;
364
Inseob Kim197748b2021-12-01 19:49:00 +0900365 if config.extra_apks.len() != verified_data.extra_apks_data.len() {
366 return Err(anyhow!(
Alan Stokes1f417c92022-09-29 15:13:28 +0100367 "config expects {} extra apks, but found {}",
Inseob Kim197748b2021-12-01 19:49:00 +0900368 config.extra_apks.len(),
369 verified_data.extra_apks_data.len()
370 ));
371 }
372 mount_extra_apks(&config)?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900373
Jooyung Han5c6d4172021-12-06 14:17:52 +0900374 // Wait until apex config is done. (e.g. linker configuration for apexes)
375 // TODO(jooyung): wait until sys.boot_completed?
376 wait_for_apex_config_done()?;
377
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900378 // Start tombstone_transmit if enabled
379 if config.export_tombstones {
Alan Stokes01b3ef02022-09-22 17:43:24 +0100380 control_service("start", "tombstone_transmit")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900381 } else {
Alan Stokes01b3ef02022-09-22 17:43:24 +0100382 control_service("stop", "tombstoned")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900383 }
384
Alan Stokes01b3ef02022-09-22 17:43:24 +0100385 // Start authfs if enabled
386 if config.enable_authfs {
387 control_service("start", "authfs_service")?;
388 }
389
Victor Hsieh8d006ba2022-05-02 09:42:02 -0700390 system_properties::write("dev.bootcomplete", "1").context("set dev.bootcomplete")?;
Alice Wang59a9e562022-10-04 15:24:10 +0000391 register_vm_payload_service(service.clone())?;
392 ProcessState::start_thread_pool();
Alan Stokes01b3ef02022-09-22 17:43:24 +0100393 exec_task(task, service)
394}
395
396fn control_service(action: &str, service: &str) -> Result<()> {
397 system_properties::write(&format!("ctl.{}", action), service)
398 .with_context(|| format!("Failed to {} {}", action, service))
Jooyung Han347d9f22021-05-28 00:05:14 +0900399}
400
Inseob Kim217038e2021-11-25 11:15:06 +0900401struct ApkDmverityArgument<'a> {
402 apk: &'a str,
403 idsig: &'a str,
404 name: &'a str,
Inseob Kim197748b2021-12-01 19:49:00 +0900405 saved_root_hash: Option<&'a RootHash>,
Inseob Kim217038e2021-11-25 11:15:06 +0900406}
407
408fn run_apkdmverity(args: &[ApkDmverityArgument]) -> Result<Child> {
409 let mut cmd = Command::new(APKDMVERITY_BIN);
410
411 cmd.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
412
413 for argument in args {
414 cmd.arg("--apk").arg(argument.apk).arg(argument.idsig).arg(argument.name);
Inseob Kim197748b2021-12-01 19:49:00 +0900415 if let Some(root_hash) = argument.saved_root_hash {
416 cmd.arg(&to_hex_string(root_hash));
417 } else {
418 cmd.arg("none");
419 }
Inseob Kim217038e2021-11-25 11:15:06 +0900420 }
421
422 cmd.spawn().context("Spawn apkdmverity")
423}
424
Andrew Scullcc339a12022-07-04 12:44:19 +0000425fn run_zipfuse(noexec: bool, option: &str, zip_path: &Path, mount_dir: &Path) -> Result<Child> {
426 let mut cmd = Command::new(ZIPFUSE_BIN);
427 if noexec {
428 cmd.arg("--noexec");
429 }
430 cmd.arg("-o")
Inseob Kim217038e2021-11-25 11:15:06 +0900431 .arg(option)
432 .arg(zip_path)
433 .arg(mount_dir)
434 .stdin(Stdio::null())
435 .stdout(Stdio::null())
436 .stderr(Stdio::null())
437 .spawn()
438 .context("Spawn zipfuse")
439}
440
Inseob Kime379e7d2022-07-22 18:55:18 +0900441fn write_apex_payload_data(
442 saved_data: Option<&MicrodroidData>,
443 apex_data_from_payload: &[ApexData],
444) -> Result<()> {
445 if let Some(saved_apex_data) = saved_data.map(|d| &d.apex_data) {
446 // We don't support APEX updates. (assuming that update will change root digest)
447 ensure!(
448 saved_apex_data == apex_data_from_payload,
449 MicrodroidError::PayloadChanged(String::from("APEXes have changed."))
450 );
451 let apex_metadata = to_metadata(apex_data_from_payload);
452 // Pass metadata(with public keys and root digests) to apexd so that it uses the passed
453 // metadata instead of the default one (/dev/block/by-name/payload-metadata)
454 OpenOptions::new()
455 .create_new(true)
456 .write(true)
457 .open("/apex/vm-payload-metadata")
458 .context("Failed to open /apex/vm-payload-metadata")
459 .and_then(|f| write_metadata(&apex_metadata, f))?;
460 }
461 Ok(())
462}
463
Jooyung Han7a343f92021-09-08 22:53:11 +0900464// Verify payload before executing it. For APK payload, Full verification (which is slow) is done
465// when the root_hash values from the idsig file and the instance disk are different. This function
466// returns the verified root hash (for APK payload) and pubkeys (for APEX payloads) that can be
467// saved to the instance disk.
468fn verify_payload(
469 metadata: &Metadata,
470 saved_data: Option<&MicrodroidData>,
471) -> Result<MicrodroidData> {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900472 let start_time = SystemTime::now();
473
Inseob Kim197748b2021-12-01 19:49:00 +0900474 // Verify main APK
Jooyung Han7a343f92021-09-08 22:53:11 +0900475 let root_hash = saved_data.map(|d| &d.apk_data.root_hash);
Inseob Kim197748b2021-12-01 19:49:00 +0900476 let root_hash_from_idsig = get_apk_root_hash_from_idsig(MAIN_APK_IDSIG_PATH)?;
Jiyong Parkf7dea252021-09-08 01:42:54 +0900477 let root_hash_trustful = root_hash == Some(&root_hash_from_idsig);
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900478
Jiyong Parkf7dea252021-09-08 01:42:54 +0900479 // 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 +0900480 // instead of the value read from the idsig file.
Inseob Kim197748b2021-12-01 19:49:00 +0900481 let main_apk_argument = {
482 ApkDmverityArgument {
483 apk: MAIN_APK_PATH,
484 idsig: MAIN_APK_IDSIG_PATH,
485 name: MAIN_APK_DEVICE_NAME,
486 saved_root_hash: if root_hash_trustful {
487 Some(root_hash_from_idsig.as_ref())
488 } else {
489 None
490 },
491 }
492 };
493 let mut apkdmverity_arguments = vec![main_apk_argument];
494
495 // Verify extra APKs
496 // For now, we can't read the payload config, so glob APKs and idsigs.
497 // Later, we'll see if it matches with the payload config.
498
499 // sort globbed paths to match apks (extra-apk-{idx}) and idsigs (extra-idsig-{idx})
500 // e.g. "extra-apk-0" corresponds to "extra-idsig-0"
501 let extra_apks =
502 sorted(glob(EXTRA_APK_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
503 let extra_idsigs =
504 sorted(glob(EXTRA_IDSIG_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
505 if extra_apks.len() != extra_idsigs.len() {
506 return Err(anyhow!(
507 "Extra apks/idsigs mismatch: {} apks but {} idsigs",
508 extra_apks.len(),
509 extra_idsigs.len()
510 ));
511 }
512 let extra_apks_count = extra_apks.len();
513
514 let (extra_apk_names, extra_root_hashes_from_idsig): (Vec<_>, Vec<_>) = extra_idsigs
515 .iter()
516 .enumerate()
517 .map(|(i, extra_idsig)| {
518 (
519 format!("extra-apk-{}", i),
Alice Wang89cff012022-09-26 10:05:16 +0000520 get_apk_root_hash_from_idsig(extra_idsig)
Inseob Kim197748b2021-12-01 19:49:00 +0900521 .expect("Can't find root hash from extra idsig"),
522 )
523 })
524 .unzip();
525
526 let saved_extra_root_hashes: Vec<_> = saved_data
527 .map(|d| d.extra_apks_data.iter().map(|apk_data| &apk_data.root_hash).collect())
528 .unwrap_or_else(Vec::new);
529 let extra_root_hashes_trustful: Vec<_> = extra_root_hashes_from_idsig
530 .iter()
531 .enumerate()
532 .map(|(i, root_hash_from_idsig)| {
533 saved_extra_root_hashes.get(i).copied() == Some(root_hash_from_idsig)
534 })
535 .collect();
536
537 for i in 0..extra_apks_count {
538 apkdmverity_arguments.push({
539 ApkDmverityArgument {
540 apk: extra_apks[i].to_str().unwrap(),
541 idsig: extra_idsigs[i].to_str().unwrap(),
542 name: &extra_apk_names[i],
543 saved_root_hash: if extra_root_hashes_trustful[i] {
544 Some(&extra_root_hashes_from_idsig[i])
545 } else {
546 None
547 },
548 }
549 });
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900550 }
551
552 // Start apkdmverity and wait for the dm-verify block
Inseob Kim197748b2021-12-01 19:49:00 +0900553 let mut apkdmverity_child = run_apkdmverity(&apkdmverity_arguments)?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900554
Jooyung Hanc8deb472021-09-13 13:48:25 +0900555 // While waiting for apkdmverity to mount APK, gathers public keys and root digests from
556 // APEX payload.
Jooyung Han7a343f92021-09-08 22:53:11 +0900557 let apex_data_from_payload = get_apex_data_from_payload(metadata)?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900558
559 // Writing /apex/vm-payload-metadata is to verify that the payload isn't changed.
560 // Skip writing it if the debug policy ignoring identity is on
561 if is_verified_boot() {
562 write_apex_payload_data(saved_data, &apex_data_from_payload)?;
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900563 }
Inseob Kime379e7d2022-07-22 18:55:18 +0900564
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900565 // Start apexd to activate APEXes
566 system_properties::write("ctl.start", "apexd-vm")?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900567
Inseob Kim217038e2021-11-25 11:15:06 +0900568 // TODO(inseob): add timeout
569 apkdmverity_child.wait()?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900570
Jiyong Parkf7dea252021-09-08 01:42:54 +0900571 // Do the full verification if the root_hash is un-trustful. This requires the full scanning of
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900572 // 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 +0900573 // 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 +0900574 // of the VM or APK was updated in the host.
575 // TODO(jooyung): consider multithreading to make this faster
Inseob Kim197748b2021-12-01 19:49:00 +0900576 let main_apk_pubkey = get_public_key_from_apk(DM_MOUNTED_APK_PATH, root_hash_trustful)?;
577 let extra_apks_data = extra_root_hashes_from_idsig
578 .into_iter()
579 .enumerate()
580 .map(|(i, extra_root_hash)| {
581 let mount_path = format!("/dev/block/mapper/{}", &extra_apk_names[i]);
582 let apk_pubkey = get_public_key_from_apk(&mount_path, extra_root_hashes_trustful[i])?;
583 Ok(ApkData { root_hash: extra_root_hash, pubkey: apk_pubkey })
584 })
585 .collect::<Result<Vec<_>>>()?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900586
587 info!("payload verification successful. took {:#?}", start_time.elapsed().unwrap());
588
Andrew Scull34916a72022-01-30 21:34:24 +0000589 // Use the salt from a verified instance, or generate a salt for a new instance.
590 let salt = if let Some(saved_data) = saved_data {
591 saved_data.salt.clone()
592 } else {
593 let mut salt = vec![0u8; 64];
594 salt.as_mut_slice().try_fill(&mut rand::thread_rng())?;
595 salt
596 };
597
Jiyong Parkf7dea252021-09-08 01:42:54 +0900598 // At this point, we can ensure that the root_hash from the idsig file is trusted, either by
599 // fully verifying the APK or by comparing it with the saved root_hash.
Jooyung Han7a343f92021-09-08 22:53:11 +0900600 Ok(MicrodroidData {
Andrew Scull34916a72022-01-30 21:34:24 +0000601 salt,
Inseob Kim197748b2021-12-01 19:49:00 +0900602 apk_data: ApkData { root_hash: root_hash_from_idsig, pubkey: main_apk_pubkey },
603 extra_apks_data,
Jooyung Han7a343f92021-09-08 22:53:11 +0900604 apex_data: apex_data_from_payload,
605 })
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900606}
607
Inseob Kim197748b2021-12-01 19:49:00 +0900608fn mount_extra_apks(config: &VmPayloadConfig) -> Result<()> {
609 // For now, only the number of apks is important, as the mount point and dm-verity name is fixed
610 for i in 0..config.extra_apks.len() {
611 let mount_dir = format!("/mnt/extra-apk/{}", i);
612 create_dir(Path::new(&mount_dir)).context("Failed to create mount dir for extra apks")?;
613
614 // don't wait, just detach
Andrew Scullcc339a12022-07-04 12:44:19 +0000615 let noexec = true;
Inseob Kim197748b2021-12-01 19:49:00 +0900616 run_zipfuse(
Andrew Scullcc339a12022-07-04 12:44:19 +0000617 noexec,
Inseob Kim197748b2021-12-01 19:49:00 +0900618 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:extra_apk_file:s0",
619 Path::new(&format!("/dev/block/mapper/extra-apk-{}", i)),
620 Path::new(&mount_dir),
621 )
622 .context("Failed to zipfuse extra apks")?;
623 }
624
625 Ok(())
626}
627
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900628// Waits until linker config is generated
629fn wait_for_apex_config_done() -> Result<()> {
630 let mut prop = PropertyWatcher::new(APEX_CONFIG_DONE_PROP)?;
631 loop {
632 prop.wait()?;
Andrew Scull4b5369f2022-01-28 13:47:20 +0000633 if system_properties::read_bool(APEX_CONFIG_DONE_PROP, false)? {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900634 break;
635 }
636 }
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900637 Ok(())
638}
639
Alice Wang89cff012022-09-26 10:05:16 +0000640fn get_apk_root_hash_from_idsig<P: AsRef<Path>>(idsig_path: P) -> Result<Box<RootHash>> {
641 Ok(V4Signature::from_idsig_path(idsig_path)?.hashing_info.raw_root_hash)
Jiyong Park21ce2c52021-08-28 02:32:17 +0900642}
643
Inseob Kim197748b2021-12-01 19:49:00 +0900644fn get_public_key_from_apk(apk: &str, root_hash_trustful: bool) -> Result<Box<[u8]>> {
645 if !root_hash_trustful {
646 verify(apk).context(MicrodroidError::PayloadVerificationFailed(format!(
647 "failed to verify {}",
648 apk
649 )))
650 } else {
651 get_public_key_der(apk)
652 }
653}
654
Alan Stokes1f417c92022-09-29 15:13:28 +0100655fn load_config(payload_metadata: PayloadMetadata) -> Result<VmPayloadConfig> {
656 match payload_metadata {
657 PayloadMetadata::config_path(path) => {
658 let path = Path::new(&path);
659 info!("loading config from {:?}...", path);
660 let file = ioutil::wait_for_file(path, WAIT_TIMEOUT)?;
661 Ok(serde_json::from_reader(file)?)
662 }
663 PayloadMetadata::config(payload_config) => {
664 let task = Task {
665 type_: TaskType::MicrodroidLauncher,
666 command: payload_config.payload_binary_path,
667 args: payload_config.args.into_vec(),
668 };
669 Ok(VmPayloadConfig {
670 os: OsConfig { name: "microdroid".to_owned() },
671 task: Some(task),
672 apexes: vec![],
673 extra_apks: vec![],
674 prefer_staged: false,
675 export_tombstones: false,
676 enable_authfs: false,
677 })
678 }
679 }
Jooyung Han634e2d72021-06-10 16:27:38 +0900680}
681
Jiyong Park202856e2022-08-22 16:04:26 +0900682/// Loads the crashkernel into memory using kexec if the VM is loaded with `crashkernel=' parameter
683/// in the cmdline.
684fn load_crashkernel_if_supported() -> Result<()> {
685 let supported = std::fs::read_to_string("/proc/cmdline")?.contains(" crashkernel=");
686 info!("ramdump supported: {}", supported);
687 if supported {
688 let status = Command::new("/system/bin/kexec_load").status()?;
689 if !status.success() {
690 return Err(anyhow!("Failed to load crashkernel: {:?}", status));
691 }
692 }
693 Ok(())
694}
695
Jiyong Park8611a6c2021-07-09 18:17:44 +0900696/// Executes the given task. Stdout of the task is piped into the vsock stream to the
697/// virtualizationservice in the host side.
Jooyung Han5c6d4172021-12-06 14:17:52 +0900698fn exec_task(task: &Task, service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900699 info!("executing main task {:?}...", task);
Inseob Kim86ca0162021-10-20 02:21:02 +0000700 let mut command = build_command(task)?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900701
702 info!("notifying payload started");
Inseob Kimc7d28c72021-10-25 14:28:10 +0000703 service.notifyPayloadStarted()?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900704
Inseob Kim86ca0162021-10-20 02:21:02 +0000705 let exit_status = command.spawn()?.wait()?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900706 exit_status.code().ok_or_else(|| anyhow!("Failed to get exit_code from the paylaod."))
Jooyung Han347d9f22021-05-28 00:05:14 +0900707}
Jooyung Han634e2d72021-06-10 16:27:38 +0900708
709fn build_command(task: &Task) -> Result<Command> {
Inseob Kim7f61fe72021-08-20 20:50:47 +0900710 const VMADDR_CID_HOST: u32 = 2;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900711
712 let mut command = match task.type_ {
Jooyung Han634e2d72021-06-10 16:27:38 +0900713 TaskType::Executable => {
714 let mut command = Command::new(&task.command);
715 command.args(&task.args);
716 command
717 }
718 TaskType::MicrodroidLauncher => {
719 let mut command = Command::new("/system/bin/microdroid_launcher");
720 command.arg(find_library_path(&task.command)?).args(&task.args);
721 command
722 }
Inseob Kim7f61fe72021-08-20 20:50:47 +0900723 };
724
Inseob Kimd0587562021-09-01 21:27:32 +0900725 match VsockStream::connect_with_cid_port(VMADDR_CID_HOST, VM_STREAM_SERVICE_PORT as u32) {
Inseob Kim7f61fe72021-08-20 20:50:47 +0900726 Ok(stream) => {
727 // SAFETY: the ownership of the underlying file descriptor is transferred from stream
728 // to the file object, and then into the Command object. When the command is finished,
729 // the file descriptor is closed.
730 let file = unsafe { File::from_raw_fd(stream.into_raw_fd()) };
731 command
732 .stdin(Stdio::from(file.try_clone()?))
733 .stdout(Stdio::from(file.try_clone()?))
734 .stderr(Stdio::from(file));
735 }
736 Err(e) => {
737 error!("failed to connect to virtualization service: {}", e);
738 // Don't fail hard here. Even if we failed to connect to the virtualizationservice,
739 // we keep executing the task. This can happen if the owner of the VM doesn't register
740 // callback to accept the stream. Use /dev/null as the stream so that the task can
741 // make progress without waiting for someone to consume the output.
742 command.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
743 }
744 }
745
746 Ok(command)
Jooyung Han634e2d72021-06-10 16:27:38 +0900747}
748
749fn find_library_path(name: &str) -> Result<String> {
750 let mut watcher = PropertyWatcher::new("ro.product.cpu.abilist")?;
751 let value = watcher.read(|_name, value| Ok(value.trim().to_string()))?;
752 let abi = value.split(',').next().ok_or_else(|| anyhow!("no abilist"))?;
753 let path = format!("/mnt/apk/lib/{}/{}", abi, name);
754
755 let metadata = fs::metadata(&path)?;
756 if !metadata.is_file() {
757 bail!("{} is not a file", &path);
758 }
759
760 Ok(path)
761}
Jiyong Park21ce2c52021-08-28 02:32:17 +0900762
763fn to_hex_string(buf: &[u8]) -> String {
764 buf.iter().map(|b| format!("{:02X}", b)).collect()
765}