blob: 49dcacba3b28853d971248ff049fa94f8574911b [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;
Alice Wang59a9e562022-10-04 15:24:10 +000021mod vm_payload_service;
Jooyung Han347d9f22021-05-28 00:05:14 +090022
Andrew Sculld64ae7d2022-10-05 17:41:43 +000023use crate::dice::{DiceContext, DiceDriver};
Inseob Kime379e7d2022-07-22 18:55:18 +090024use crate::instance::{ApexData, ApkData, InstanceDisk, MicrodroidData, RootHash};
Alice Wang59a9e562022-10-04 15:24:10 +000025use crate::vm_payload_service::register_vm_payload_service;
Alan Stokes2bead0d2022-09-05 16:58:34 +010026use android_system_virtualizationcommon::aidl::android::system::virtualizationcommon::ErrorCode::ErrorCode;
27use android_system_virtualmachineservice::aidl::android::system::virtualmachineservice::IVirtualMachineService::{
28 VM_BINDER_SERVICE_PORT, VM_STREAM_SERVICE_PORT, IVirtualMachineService,
29};
Jooyung Handd0a1732021-11-23 15:26:20 +090030use anyhow::{anyhow, bail, ensure, Context, Error, Result};
Alice Wang1bf3d782022-09-28 07:56:36 +000031use apkverify::{get_public_key_der, verify, V4Signature};
Andrew Sculld64ae7d2022-10-05 17:41:43 +000032use binder::{ProcessState, Strong};
Alan Stokes1f417c92022-09-29 15:13:28 +010033use diced_utils::cbor::{encode_header, encode_number};
Inseob Kim197748b2021-12-01 19:49:00 +090034use glob::glob;
Inseob Kim197748b2021-12-01 19:49:00 +090035use itertools::sorted;
Andrew Scull684590f2022-01-27 16:14:26 +000036use log::{error, info};
Alan Stokes0d1ef782022-09-27 13:46:35 +010037use microdroid_metadata::{write_metadata, Metadata, PayloadMetadata};
Alan Stokes1f417c92022-09-29 15:13:28 +010038use microdroid_payload_config::{Task, TaskType, VmPayloadConfig, OsConfig};
Andrew Sculla0d1b1a2022-05-24 19:32:47 +000039use openssl::sha::Sha512;
Jooyung Han4a9b3bf2021-09-10 17:19:00 +090040use payload::{get_apex_data_from_payload, load_metadata, to_metadata};
Andrew Scull34916a72022-01-30 21:34:24 +000041use rand::Fill;
Andrew Walbran7eb5ca42022-08-08 15:33:34 +000042use rpcbinder::get_vsock_rpc_interface;
Jiyong Parkbb4a9872021-09-06 15:59:21 +090043use rustutils::system_properties;
Joel Galenson482704c2021-07-29 15:53:53 -070044use rustutils::system_properties::PropertyWatcher;
Andrew Scullb2f44472022-01-21 14:41:34 +000045use std::convert::TryInto;
Inseob Kim197748b2021-12-01 19:49:00 +090046use std::fs::{self, create_dir, File, OpenOptions};
Inseob Kim11f40d02022-06-13 17:16:00 +090047use std::io::Write;
Inseob Kimc7d28c72021-10-25 14:28:10 +000048use std::os::unix::io::{FromRawFd, IntoRawFd};
Jooyung Hanf48ceb42021-06-01 18:00:04 +090049use std::path::Path;
Inseob Kim217038e2021-11-25 11:15:06 +090050use std::process::{Child, Command, Stdio};
Jiyong Park8611a6c2021-07-09 18:17:44 +090051use std::str;
Jiyong Parkbb4a9872021-09-06 15:59:21 +090052use std::time::{Duration, SystemTime};
Jiyong Park8611a6c2021-07-09 18:17:44 +090053use vsock::VsockStream;
Jooyung Han634e2d72021-06-10 16:27:38 +090054
55const WAIT_TIMEOUT: Duration = Duration::from_secs(10);
Inseob Kim197748b2021-12-01 19:49:00 +090056const MAIN_APK_PATH: &str = "/dev/block/by-name/microdroid-apk";
57const MAIN_APK_IDSIG_PATH: &str = "/dev/block/by-name/microdroid-apk-idsig";
58const MAIN_APK_DEVICE_NAME: &str = "microdroid-apk";
59const EXTRA_APK_PATH_PATTERN: &str = "/dev/block/by-name/extra-apk-*";
60const EXTRA_IDSIG_PATH_PATTERN: &str = "/dev/block/by-name/extra-idsig-*";
Jooyung Han19c1d6c2021-08-06 14:08:16 +090061const DM_MOUNTED_APK_PATH: &str = "/dev/block/mapper/microdroid-apk";
Inseob Kim217038e2021-11-25 11:15:06 +090062const APKDMVERITY_BIN: &str = "/system/bin/apkdmverity";
63const ZIPFUSE_BIN: &str = "/system/bin/zipfuse";
Andrew Scullab72ec52022-03-14 09:10:52 +000064const AVF_STRICT_BOOT: &str = "/sys/firmware/devicetree/base/chosen/avf,strict-boot";
65const AVF_NEW_INSTANCE: &str = "/sys/firmware/devicetree/base/chosen/avf,new-instance";
Inseob Kime379e7d2022-07-22 18:55:18 +090066const DEBUG_MICRODROID_NO_VERIFIED_BOOT: &str =
67 "/sys/firmware/devicetree/base/virtualization/guest/debug-microdroid,no-verified-boot";
Jooyung Han347d9f22021-05-28 00:05:14 +090068
Inseob Kim1b95f2e2021-08-19 13:17:40 +090069/// The CID representing the host VM
70const VMADDR_CID_HOST: u32 = 2;
71
Jiyong Parkbb4a9872021-09-06 15:59:21 +090072const APEX_CONFIG_DONE_PROP: &str = "apex_config.done";
Andrew Scull65ddfc42022-02-14 21:03:58 +000073const APP_DEBUGGABLE_PROP: &str = "ro.boot.microdroid.app_debuggable";
Jiyong Parkbb4a9872021-09-06 15:59:21 +090074
Inseob Kim11f40d02022-06-13 17:16:00 +090075// SYNC WITH virtualizationservice/src/crosvm.rs
76const FAILURE_SERIAL_DEVICE: &str = "/dev/ttyS1";
77
Jooyung Handd0a1732021-11-23 15:26:20 +090078#[derive(thiserror::Error, Debug)]
79enum MicrodroidError {
Inseob Kim11f40d02022-06-13 17:16:00 +090080 #[error("Cannot connect to virtualization service: {0}")]
81 FailedToConnectToVirtualizationService(String),
Jooyung Handd0a1732021-11-23 15:26:20 +090082 #[error("Payload has changed: {0}")]
83 PayloadChanged(String),
84 #[error("Payload verification has failed: {0}")]
85 PayloadVerificationFailed(String),
Jooyung Han5c6d4172021-12-06 14:17:52 +090086 #[error("Payload config is invalid: {0}")]
87 InvalidConfig(String),
Jooyung Handd0a1732021-11-23 15:26:20 +090088}
89
Alan Stokes2bead0d2022-09-05 16:58:34 +010090fn translate_error(err: &Error) -> (ErrorCode, String) {
Jooyung Handd0a1732021-11-23 15:26:20 +090091 if let Some(e) = err.downcast_ref::<MicrodroidError>() {
92 match e {
Alan Stokes2bead0d2022-09-05 16:58:34 +010093 MicrodroidError::PayloadChanged(msg) => (ErrorCode::PAYLOAD_CHANGED, msg.to_string()),
Jooyung Handd0a1732021-11-23 15:26:20 +090094 MicrodroidError::PayloadVerificationFailed(msg) => {
Alan Stokes2bead0d2022-09-05 16:58:34 +010095 (ErrorCode::PAYLOAD_VERIFICATION_FAILED, msg.to_string())
Jooyung Handd0a1732021-11-23 15:26:20 +090096 }
Alan Stokes2bead0d2022-09-05 16:58:34 +010097 MicrodroidError::InvalidConfig(msg) => {
98 (ErrorCode::PAYLOAD_CONFIG_INVALID, msg.to_string())
99 }
Inseob Kim11f40d02022-06-13 17:16:00 +0900100
101 // Connection failure won't be reported to VS; return the default value
102 MicrodroidError::FailedToConnectToVirtualizationService(msg) => {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100103 (ErrorCode::UNKNOWN, msg.to_string())
Inseob Kim11f40d02022-06-13 17:16:00 +0900104 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900105 }
106 } else {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100107 (ErrorCode::UNKNOWN, err.to_string())
Jooyung Handd0a1732021-11-23 15:26:20 +0900108 }
109}
110
Inseob Kim11f40d02022-06-13 17:16:00 +0900111fn write_death_reason_to_serial(err: &Error) -> Result<()> {
112 let death_reason = if let Some(e) = err.downcast_ref::<MicrodroidError>() {
113 match e {
114 MicrodroidError::FailedToConnectToVirtualizationService(_) => {
115 "MICRODROID_FAILED_TO_CONNECT_TO_VIRTUALIZATION_SERVICE"
116 }
117 MicrodroidError::PayloadChanged(_) => "MICRODROID_PAYLOAD_HAS_CHANGED",
118 MicrodroidError::PayloadVerificationFailed(_) => {
119 "MICRODROID_PAYLOAD_VERIFICATION_FAILED"
120 }
121 MicrodroidError::InvalidConfig(_) => "MICRODROID_INVALID_PAYLOAD_CONFIG",
122 }
123 } else {
124 "MICRODROID_UNKNOWN_RUNTIME_ERROR"
125 };
126
127 let death_reason_bytes = death_reason.as_bytes();
128 let mut sent_total = 0;
129 while sent_total < death_reason_bytes.len() {
130 // TODO(b/220071963): Sometimes, sending more than 16 bytes at once makes MM hang.
131 let begin = sent_total;
132 let end = std::cmp::min(begin.saturating_add(16), death_reason_bytes.len());
133 OpenOptions::new()
134 .read(false)
135 .write(true)
136 .open(FAILURE_SERIAL_DEVICE)?
137 .write_all(&death_reason_bytes[begin..end])?;
138 sent_total = end;
139 }
140
141 Ok(())
142}
143
Inseob Kim1b95f2e2021-08-19 13:17:40 +0900144fn get_vms_rpc_binder() -> Result<Strong<dyn IVirtualMachineService>> {
Andrew Walbran7eb5ca42022-08-08 15:33:34 +0000145 get_vsock_rpc_interface(VMADDR_CID_HOST, VM_BINDER_SERVICE_PORT as u32)
Andrew Walbranc4ce7872022-07-29 11:26:41 +0000146 .context("Cannot connect to RPC service")
Inseob Kim1b95f2e2021-08-19 13:17:40 +0900147}
148
Inseob Kim437f1052022-06-21 11:30:22 +0900149fn main() -> Result<()> {
150 scopeguard::defer! {
151 info!("Shutting down...");
Jooyung Hanbfe086f2021-10-28 10:15:45 +0900152 if let Err(e) = system_properties::write("sys.powerctl", "shutdown") {
153 error!("failed to shutdown {:?}", e);
154 }
Jooyung Han311b1202021-09-14 22:00:16 +0900155 }
Inseob Kim437f1052022-06-21 11:30:22 +0900156
157 try_main().map_err(|e| {
158 error!("Failed with {:?}.", e);
159 if let Err(e) = write_death_reason_to_serial(&e) {
160 error!("Failed to write death reason {:?}", e);
161 }
162 e
163 })
Jooyung Han311b1202021-09-14 22:00:16 +0900164}
165
166fn try_main() -> Result<()> {
Andrew Sculle127cff2022-02-15 15:34:04 +0000167 let _ = kernlog::init();
Jooyung Han347d9f22021-05-28 00:05:14 +0900168 info!("started.");
169
Jiyong Park202856e2022-08-22 16:04:26 +0900170 load_crashkernel_if_supported().context("Failed to load crashkernel")?;
171
Inseob Kim11f40d02022-06-13 17:16:00 +0900172 let service = get_vms_rpc_binder()
173 .context("cannot connect to VirtualMachineService")
174 .map_err(|e| MicrodroidError::FailedToConnectToVirtualizationService(e.to_string()))?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900175 match try_run_payload(&service) {
176 Ok(code) => {
177 info!("notifying payload finished");
178 service.notifyPayloadFinished(code)?;
179 if code == 0 {
180 info!("task successfully finished");
181 } else {
182 error!("task exited with exit code: {}", code);
183 }
184 Ok(())
185 }
186 Err(err) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900187 let (error_code, message) = translate_error(&err);
188 service.notifyError(error_code, &message)?;
189 Err(err)
190 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900191 }
192}
193
Alan Stokes1f417c92022-09-29 15:13:28 +0100194fn dice_derivation(
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000195 dice: DiceDriver,
Alan Stokes1f417c92022-09-29 15:13:28 +0100196 verified_data: &MicrodroidData,
197 payload_metadata: &PayloadMetadata,
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000198) -> Result<DiceContext> {
Andrew Scullb2f44472022-01-21 14:41:34 +0000199 // Calculate compound digests of code and authorities
Andrew Sculla0d1b1a2022-05-24 19:32:47 +0000200 let mut code_hash_ctx = Sha512::new();
201 let mut authority_hash_ctx = Sha512::new();
Andrew Scullb2f44472022-01-21 14:41:34 +0000202 code_hash_ctx.update(verified_data.apk_data.root_hash.as_ref());
203 authority_hash_ctx.update(verified_data.apk_data.pubkey.as_ref());
Inseob Kimb2519c52022-04-14 02:10:09 +0900204 for extra_apk in &verified_data.extra_apks_data {
Andrew Scullb2f44472022-01-21 14:41:34 +0000205 code_hash_ctx.update(extra_apk.root_hash.as_ref());
206 authority_hash_ctx.update(extra_apk.pubkey.as_ref());
207 }
Inseob Kimb2519c52022-04-14 02:10:09 +0900208 for apex in &verified_data.apex_data {
Andrew Scullb2f44472022-01-21 14:41:34 +0000209 code_hash_ctx.update(apex.root_digest.as_ref());
210 authority_hash_ctx.update(apex.public_key.as_ref());
211 }
Andrew Sculla0d1b1a2022-05-24 19:32:47 +0000212 let code_hash = code_hash_ctx.finish();
213 let authority_hash = authority_hash_ctx.finish();
Andrew Scullb2f44472022-01-21 14:41:34 +0000214
215 // {
216 // -70002: "Microdroid payload",
Alan Stokes1f417c92022-09-29 15:13:28 +0100217 // ? -71000: tstr // payload_config_path
218 // ? -71001: PayloadConfig
Andrew Scullb2f44472022-01-21 14:41:34 +0000219 // }
Alan Stokes1f417c92022-09-29 15:13:28 +0100220 // PayloadConfig = {
221 // 1: tstr // payload_binary_path
222 // // TODO(b/249064104 Either include args, or deprecate them
223 // }
224
Andrew Scullb2f44472022-01-21 14:41:34 +0000225 let mut config_desc = vec![
Alan Stokes1f417c92022-09-29 15:13:28 +0100226 0xa2, // map(2)
227 0x3a, 0x00, 0x01, 0x11, 0x71, // -70002
228 0x72, 0x4d, 0x69, 0x63, 0x72, 0x6f, 0x64, 0x72, 0x6f, 0x69, 0x64, 0x20, 0x70, 0x61, 0x79,
229 0x6c, 0x6f, 0x61, 0x64, // "Microdroid payload"
Andrew Scullb2f44472022-01-21 14:41:34 +0000230 ];
Alan Stokes1f417c92022-09-29 15:13:28 +0100231
232 match payload_metadata {
233 PayloadMetadata::config_path(payload_config_path) => {
234 encode_negative_number(-71000, &mut config_desc)?;
235 encode_tstr(payload_config_path, &mut config_desc)?;
236 }
237 PayloadMetadata::config(payload_config) => {
238 encode_negative_number(-71001, &mut config_desc)?;
239 encode_header(5, 1, &mut config_desc)?; // map(1)
240 encode_number(1, &mut config_desc)?;
241 encode_tstr(&payload_config.payload_binary_path, &mut config_desc)?;
242 }
243 }
Andrew Scullb2f44472022-01-21 14:41:34 +0000244
Andrew Scull65ddfc42022-02-14 21:03:58 +0000245 // Check app debuggability, conervatively assuming it is debuggable
246 let app_debuggable = system_properties::read_bool(APP_DEBUGGABLE_PROP, true)?;
247
Andrew Scullb2f44472022-01-21 14:41:34 +0000248 // Send the details to diced
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000249 let hidden = verified_data.salt.clone().try_into().unwrap();
250 dice.derive(code_hash, &config_desc, authority_hash, app_debuggable, hidden)
Andrew Scullb2f44472022-01-21 14:41:34 +0000251}
252
Alan Stokes1f417c92022-09-29 15:13:28 +0100253fn encode_tstr(tstr: &str, buffer: &mut Vec<u8>) -> Result<()> {
254 let bytes = tstr.as_bytes();
255 encode_header(3, bytes.len().try_into().unwrap(), buffer)?;
256 buffer.extend_from_slice(bytes);
257 Ok(())
258}
259
260fn encode_negative_number(n: i64, buffer: &mut dyn Write) -> Result<()> {
261 ensure!(n < 0);
262 let n = -1 - n;
263 encode_header(1, n.try_into().unwrap(), buffer)
264}
265
Andrew Scullab72ec52022-03-14 09:10:52 +0000266fn is_strict_boot() -> bool {
267 Path::new(AVF_STRICT_BOOT).exists()
268}
269
270fn is_new_instance() -> bool {
271 Path::new(AVF_NEW_INSTANCE).exists()
272}
273
Inseob Kime379e7d2022-07-22 18:55:18 +0900274fn is_verified_boot() -> bool {
275 !Path::new(DEBUG_MICRODROID_NO_VERIFIED_BOOT).exists()
276}
277
Jooyung Han5c6d4172021-12-06 14:17:52 +0900278fn try_run_payload(service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jooyung Han311b1202021-09-14 22:00:16 +0900279 let metadata = load_metadata().context("Failed to load payload metadata")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000280 let dice = DiceDriver::new(Path::new("/dev/open-dice0")).context("Failed to load DICE")?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900281
Jooyung Han311b1202021-09-14 22:00:16 +0900282 let mut instance = InstanceDisk::new().context("Failed to load instance.img")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000283 let saved_data =
284 instance.read_microdroid_data(&dice).context("Failed to read identity data")?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900285
Andrew Scullab72ec52022-03-14 09:10:52 +0000286 if is_strict_boot() {
287 // Provisioning must happen on the first boot and never again.
288 if is_new_instance() {
289 ensure!(
290 saved_data.is_none(),
291 MicrodroidError::InvalidConfig("Found instance data on first boot.".to_string())
292 );
293 } else {
294 ensure!(
295 saved_data.is_some(),
296 MicrodroidError::InvalidConfig("Instance data not found.".to_string())
297 );
298 };
299 }
300
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900301 // Verify the payload before using it.
Inseob Kim11f40d02022-06-13 17:16:00 +0900302 let verified_data = verify_payload(&metadata, saved_data.as_ref())
303 .context("Payload verification failed")
304 .map_err(|e| MicrodroidError::PayloadVerificationFailed(e.to_string()))?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900305
306 // In case identity is ignored (by debug policy), we should reuse existing payload data, even
307 // when the payload is changed. This is to keep the derived secret same as before.
308 let verified_data = if let Some(saved_data) = saved_data {
309 if !is_verified_boot() {
310 if saved_data != verified_data {
311 info!("Detected an update of the payload, but continue (regarding debug policy)")
312 }
313 } else {
314 ensure!(
315 saved_data == verified_data,
316 MicrodroidError::PayloadChanged(String::from(
317 "Detected an update of the payload which isn't supported yet."
318 ))
319 );
320 info!("Saved data is verified.");
321 }
322 saved_data
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900323 } else {
Jooyung Han7a343f92021-09-08 22:53:11 +0900324 info!("Saving verified data.");
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000325 instance
326 .write_microdroid_data(&verified_data, &dice)
327 .context("Failed to write identity data")?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900328 verified_data
329 };
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900330
Alan Stokes1f417c92022-09-29 15:13:28 +0100331 let payload_metadata = metadata.payload.ok_or_else(|| {
332 MicrodroidError::InvalidConfig("No payload config in metadata".to_string())
333 })?;
Alan Stokes0d1ef782022-09-27 13:46:35 +0100334
Inseob Kimb2519c52022-04-14 02:10:09 +0900335 // To minimize the exposure to untrusted data, derive dice profile as soon as possible.
336 info!("DICE derivation for payload");
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000337 let dice = dice_derivation(dice, &verified_data, &payload_metadata)?;
Inseob Kimb2519c52022-04-14 02:10:09 +0900338
Jooyung Hana6d11eb2021-09-10 11:48:05 +0900339 // Before reading a file from the APK, start zipfuse
Andrew Scullcc339a12022-07-04 12:44:19 +0000340 let noexec = false;
Inseob Kim217038e2021-11-25 11:15:06 +0900341 run_zipfuse(
Andrew Scullcc339a12022-07-04 12:44:19 +0000342 noexec,
Inseob Kim217038e2021-11-25 11:15:06 +0900343 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:system_file:s0",
344 Path::new("/dev/block/mapper/microdroid-apk"),
345 Path::new("/mnt/apk"),
346 )
347 .context("Failed to run zipfuse")?;
Jiyong Park21ce2c52021-08-28 02:32:17 +0900348
Alan Stokes1f417c92022-09-29 15:13:28 +0100349 let config = load_config(payload_metadata)?;
Shikha Panwar6f03c942022-04-13 20:26:50 +0000350
Alan Stokes01b3ef02022-09-22 17:43:24 +0100351 let task = config
352 .task
353 .as_ref()
354 .ok_or_else(|| MicrodroidError::InvalidConfig("No task in VM config".to_string()))?;
355
Inseob Kim197748b2021-12-01 19:49:00 +0900356 if config.extra_apks.len() != verified_data.extra_apks_data.len() {
357 return Err(anyhow!(
Alan Stokes1f417c92022-09-29 15:13:28 +0100358 "config expects {} extra apks, but found {}",
Inseob Kim197748b2021-12-01 19:49:00 +0900359 config.extra_apks.len(),
360 verified_data.extra_apks_data.len()
361 ));
362 }
363 mount_extra_apks(&config)?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900364
Jooyung Han5c6d4172021-12-06 14:17:52 +0900365 // Wait until apex config is done. (e.g. linker configuration for apexes)
366 // TODO(jooyung): wait until sys.boot_completed?
367 wait_for_apex_config_done()?;
368
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900369 // Start tombstone_transmit if enabled
370 if config.export_tombstones {
Alan Stokes01b3ef02022-09-22 17:43:24 +0100371 control_service("start", "tombstone_transmit")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900372 } else {
Alan Stokes01b3ef02022-09-22 17:43:24 +0100373 control_service("stop", "tombstoned")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900374 }
375
Alan Stokes01b3ef02022-09-22 17:43:24 +0100376 // Start authfs if enabled
377 if config.enable_authfs {
378 control_service("start", "authfs_service")?;
379 }
380
Victor Hsieh8d006ba2022-05-02 09:42:02 -0700381 system_properties::write("dev.bootcomplete", "1").context("set dev.bootcomplete")?;
Andrew Sculld64ae7d2022-10-05 17:41:43 +0000382 register_vm_payload_service(service.clone(), dice)?;
Alice Wang59a9e562022-10-04 15:24:10 +0000383 ProcessState::start_thread_pool();
Alan Stokes01b3ef02022-09-22 17:43:24 +0100384 exec_task(task, service)
385}
386
387fn control_service(action: &str, service: &str) -> Result<()> {
388 system_properties::write(&format!("ctl.{}", action), service)
389 .with_context(|| format!("Failed to {} {}", action, service))
Jooyung Han347d9f22021-05-28 00:05:14 +0900390}
391
Inseob Kim217038e2021-11-25 11:15:06 +0900392struct ApkDmverityArgument<'a> {
393 apk: &'a str,
394 idsig: &'a str,
395 name: &'a str,
Inseob Kim197748b2021-12-01 19:49:00 +0900396 saved_root_hash: Option<&'a RootHash>,
Inseob Kim217038e2021-11-25 11:15:06 +0900397}
398
399fn run_apkdmverity(args: &[ApkDmverityArgument]) -> Result<Child> {
400 let mut cmd = Command::new(APKDMVERITY_BIN);
401
402 cmd.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
403
404 for argument in args {
405 cmd.arg("--apk").arg(argument.apk).arg(argument.idsig).arg(argument.name);
Inseob Kim197748b2021-12-01 19:49:00 +0900406 if let Some(root_hash) = argument.saved_root_hash {
407 cmd.arg(&to_hex_string(root_hash));
408 } else {
409 cmd.arg("none");
410 }
Inseob Kim217038e2021-11-25 11:15:06 +0900411 }
412
413 cmd.spawn().context("Spawn apkdmverity")
414}
415
Andrew Scullcc339a12022-07-04 12:44:19 +0000416fn run_zipfuse(noexec: bool, option: &str, zip_path: &Path, mount_dir: &Path) -> Result<Child> {
417 let mut cmd = Command::new(ZIPFUSE_BIN);
418 if noexec {
419 cmd.arg("--noexec");
420 }
421 cmd.arg("-o")
Inseob Kim217038e2021-11-25 11:15:06 +0900422 .arg(option)
423 .arg(zip_path)
424 .arg(mount_dir)
425 .stdin(Stdio::null())
426 .stdout(Stdio::null())
427 .stderr(Stdio::null())
428 .spawn()
429 .context("Spawn zipfuse")
430}
431
Inseob Kime379e7d2022-07-22 18:55:18 +0900432fn write_apex_payload_data(
433 saved_data: Option<&MicrodroidData>,
434 apex_data_from_payload: &[ApexData],
435) -> Result<()> {
436 if let Some(saved_apex_data) = saved_data.map(|d| &d.apex_data) {
437 // We don't support APEX updates. (assuming that update will change root digest)
438 ensure!(
439 saved_apex_data == apex_data_from_payload,
440 MicrodroidError::PayloadChanged(String::from("APEXes have changed."))
441 );
442 let apex_metadata = to_metadata(apex_data_from_payload);
443 // Pass metadata(with public keys and root digests) to apexd so that it uses the passed
444 // metadata instead of the default one (/dev/block/by-name/payload-metadata)
445 OpenOptions::new()
446 .create_new(true)
447 .write(true)
448 .open("/apex/vm-payload-metadata")
449 .context("Failed to open /apex/vm-payload-metadata")
450 .and_then(|f| write_metadata(&apex_metadata, f))?;
451 }
452 Ok(())
453}
454
Jooyung Han7a343f92021-09-08 22:53:11 +0900455// Verify payload before executing it. For APK payload, Full verification (which is slow) is done
456// when the root_hash values from the idsig file and the instance disk are different. This function
457// returns the verified root hash (for APK payload) and pubkeys (for APEX payloads) that can be
458// saved to the instance disk.
459fn verify_payload(
460 metadata: &Metadata,
461 saved_data: Option<&MicrodroidData>,
462) -> Result<MicrodroidData> {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900463 let start_time = SystemTime::now();
464
Inseob Kim197748b2021-12-01 19:49:00 +0900465 // Verify main APK
Jooyung Han7a343f92021-09-08 22:53:11 +0900466 let root_hash = saved_data.map(|d| &d.apk_data.root_hash);
Inseob Kim197748b2021-12-01 19:49:00 +0900467 let root_hash_from_idsig = get_apk_root_hash_from_idsig(MAIN_APK_IDSIG_PATH)?;
Jiyong Parkf7dea252021-09-08 01:42:54 +0900468 let root_hash_trustful = root_hash == Some(&root_hash_from_idsig);
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900469
Jiyong Parkf7dea252021-09-08 01:42:54 +0900470 // 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 +0900471 // instead of the value read from the idsig file.
Inseob Kim197748b2021-12-01 19:49:00 +0900472 let main_apk_argument = {
473 ApkDmverityArgument {
474 apk: MAIN_APK_PATH,
475 idsig: MAIN_APK_IDSIG_PATH,
476 name: MAIN_APK_DEVICE_NAME,
477 saved_root_hash: if root_hash_trustful {
478 Some(root_hash_from_idsig.as_ref())
479 } else {
480 None
481 },
482 }
483 };
484 let mut apkdmverity_arguments = vec![main_apk_argument];
485
486 // Verify extra APKs
487 // For now, we can't read the payload config, so glob APKs and idsigs.
488 // Later, we'll see if it matches with the payload config.
489
490 // sort globbed paths to match apks (extra-apk-{idx}) and idsigs (extra-idsig-{idx})
491 // e.g. "extra-apk-0" corresponds to "extra-idsig-0"
492 let extra_apks =
493 sorted(glob(EXTRA_APK_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
494 let extra_idsigs =
495 sorted(glob(EXTRA_IDSIG_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
496 if extra_apks.len() != extra_idsigs.len() {
497 return Err(anyhow!(
498 "Extra apks/idsigs mismatch: {} apks but {} idsigs",
499 extra_apks.len(),
500 extra_idsigs.len()
501 ));
502 }
503 let extra_apks_count = extra_apks.len();
504
505 let (extra_apk_names, extra_root_hashes_from_idsig): (Vec<_>, Vec<_>) = extra_idsigs
506 .iter()
507 .enumerate()
508 .map(|(i, extra_idsig)| {
509 (
510 format!("extra-apk-{}", i),
Alice Wang89cff012022-09-26 10:05:16 +0000511 get_apk_root_hash_from_idsig(extra_idsig)
Inseob Kim197748b2021-12-01 19:49:00 +0900512 .expect("Can't find root hash from extra idsig"),
513 )
514 })
515 .unzip();
516
517 let saved_extra_root_hashes: Vec<_> = saved_data
518 .map(|d| d.extra_apks_data.iter().map(|apk_data| &apk_data.root_hash).collect())
519 .unwrap_or_else(Vec::new);
520 let extra_root_hashes_trustful: Vec<_> = extra_root_hashes_from_idsig
521 .iter()
522 .enumerate()
523 .map(|(i, root_hash_from_idsig)| {
524 saved_extra_root_hashes.get(i).copied() == Some(root_hash_from_idsig)
525 })
526 .collect();
527
528 for i in 0..extra_apks_count {
529 apkdmverity_arguments.push({
530 ApkDmverityArgument {
531 apk: extra_apks[i].to_str().unwrap(),
532 idsig: extra_idsigs[i].to_str().unwrap(),
533 name: &extra_apk_names[i],
534 saved_root_hash: if extra_root_hashes_trustful[i] {
535 Some(&extra_root_hashes_from_idsig[i])
536 } else {
537 None
538 },
539 }
540 });
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900541 }
542
543 // Start apkdmverity and wait for the dm-verify block
Inseob Kim197748b2021-12-01 19:49:00 +0900544 let mut apkdmverity_child = run_apkdmverity(&apkdmverity_arguments)?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900545
Jooyung Hanc8deb472021-09-13 13:48:25 +0900546 // While waiting for apkdmverity to mount APK, gathers public keys and root digests from
547 // APEX payload.
Jooyung Han7a343f92021-09-08 22:53:11 +0900548 let apex_data_from_payload = get_apex_data_from_payload(metadata)?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900549
550 // Writing /apex/vm-payload-metadata is to verify that the payload isn't changed.
551 // Skip writing it if the debug policy ignoring identity is on
552 if is_verified_boot() {
553 write_apex_payload_data(saved_data, &apex_data_from_payload)?;
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900554 }
Inseob Kime379e7d2022-07-22 18:55:18 +0900555
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900556 // Start apexd to activate APEXes
557 system_properties::write("ctl.start", "apexd-vm")?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900558
Inseob Kim217038e2021-11-25 11:15:06 +0900559 // TODO(inseob): add timeout
560 apkdmverity_child.wait()?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900561
Jiyong Parkf7dea252021-09-08 01:42:54 +0900562 // Do the full verification if the root_hash is un-trustful. This requires the full scanning of
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900563 // 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 +0900564 // 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 +0900565 // of the VM or APK was updated in the host.
566 // TODO(jooyung): consider multithreading to make this faster
Inseob Kim197748b2021-12-01 19:49:00 +0900567 let main_apk_pubkey = get_public_key_from_apk(DM_MOUNTED_APK_PATH, root_hash_trustful)?;
568 let extra_apks_data = extra_root_hashes_from_idsig
569 .into_iter()
570 .enumerate()
571 .map(|(i, extra_root_hash)| {
572 let mount_path = format!("/dev/block/mapper/{}", &extra_apk_names[i]);
573 let apk_pubkey = get_public_key_from_apk(&mount_path, extra_root_hashes_trustful[i])?;
574 Ok(ApkData { root_hash: extra_root_hash, pubkey: apk_pubkey })
575 })
576 .collect::<Result<Vec<_>>>()?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900577
578 info!("payload verification successful. took {:#?}", start_time.elapsed().unwrap());
579
Andrew Scull34916a72022-01-30 21:34:24 +0000580 // Use the salt from a verified instance, or generate a salt for a new instance.
581 let salt = if let Some(saved_data) = saved_data {
582 saved_data.salt.clone()
583 } else {
584 let mut salt = vec![0u8; 64];
585 salt.as_mut_slice().try_fill(&mut rand::thread_rng())?;
586 salt
587 };
588
Jiyong Parkf7dea252021-09-08 01:42:54 +0900589 // At this point, we can ensure that the root_hash from the idsig file is trusted, either by
590 // fully verifying the APK or by comparing it with the saved root_hash.
Jooyung Han7a343f92021-09-08 22:53:11 +0900591 Ok(MicrodroidData {
Andrew Scull34916a72022-01-30 21:34:24 +0000592 salt,
Inseob Kim197748b2021-12-01 19:49:00 +0900593 apk_data: ApkData { root_hash: root_hash_from_idsig, pubkey: main_apk_pubkey },
594 extra_apks_data,
Jooyung Han7a343f92021-09-08 22:53:11 +0900595 apex_data: apex_data_from_payload,
596 })
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900597}
598
Inseob Kim197748b2021-12-01 19:49:00 +0900599fn mount_extra_apks(config: &VmPayloadConfig) -> Result<()> {
600 // For now, only the number of apks is important, as the mount point and dm-verity name is fixed
601 for i in 0..config.extra_apks.len() {
602 let mount_dir = format!("/mnt/extra-apk/{}", i);
603 create_dir(Path::new(&mount_dir)).context("Failed to create mount dir for extra apks")?;
604
605 // don't wait, just detach
Andrew Scullcc339a12022-07-04 12:44:19 +0000606 let noexec = true;
Inseob Kim197748b2021-12-01 19:49:00 +0900607 run_zipfuse(
Andrew Scullcc339a12022-07-04 12:44:19 +0000608 noexec,
Inseob Kim197748b2021-12-01 19:49:00 +0900609 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:extra_apk_file:s0",
610 Path::new(&format!("/dev/block/mapper/extra-apk-{}", i)),
611 Path::new(&mount_dir),
612 )
613 .context("Failed to zipfuse extra apks")?;
614 }
615
616 Ok(())
617}
618
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900619// Waits until linker config is generated
620fn wait_for_apex_config_done() -> Result<()> {
621 let mut prop = PropertyWatcher::new(APEX_CONFIG_DONE_PROP)?;
622 loop {
623 prop.wait()?;
Andrew Scull4b5369f2022-01-28 13:47:20 +0000624 if system_properties::read_bool(APEX_CONFIG_DONE_PROP, false)? {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900625 break;
626 }
627 }
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900628 Ok(())
629}
630
Alice Wang89cff012022-09-26 10:05:16 +0000631fn get_apk_root_hash_from_idsig<P: AsRef<Path>>(idsig_path: P) -> Result<Box<RootHash>> {
632 Ok(V4Signature::from_idsig_path(idsig_path)?.hashing_info.raw_root_hash)
Jiyong Park21ce2c52021-08-28 02:32:17 +0900633}
634
Inseob Kim197748b2021-12-01 19:49:00 +0900635fn get_public_key_from_apk(apk: &str, root_hash_trustful: bool) -> Result<Box<[u8]>> {
636 if !root_hash_trustful {
637 verify(apk).context(MicrodroidError::PayloadVerificationFailed(format!(
638 "failed to verify {}",
639 apk
640 )))
641 } else {
642 get_public_key_der(apk)
643 }
644}
645
Alan Stokes1f417c92022-09-29 15:13:28 +0100646fn load_config(payload_metadata: PayloadMetadata) -> Result<VmPayloadConfig> {
647 match payload_metadata {
648 PayloadMetadata::config_path(path) => {
649 let path = Path::new(&path);
650 info!("loading config from {:?}...", path);
651 let file = ioutil::wait_for_file(path, WAIT_TIMEOUT)?;
652 Ok(serde_json::from_reader(file)?)
653 }
654 PayloadMetadata::config(payload_config) => {
655 let task = Task {
656 type_: TaskType::MicrodroidLauncher,
657 command: payload_config.payload_binary_path,
658 args: payload_config.args.into_vec(),
659 };
660 Ok(VmPayloadConfig {
661 os: OsConfig { name: "microdroid".to_owned() },
662 task: Some(task),
663 apexes: vec![],
664 extra_apks: vec![],
665 prefer_staged: false,
666 export_tombstones: false,
667 enable_authfs: false,
668 })
669 }
670 }
Jooyung Han634e2d72021-06-10 16:27:38 +0900671}
672
Jiyong Park202856e2022-08-22 16:04:26 +0900673/// Loads the crashkernel into memory using kexec if the VM is loaded with `crashkernel=' parameter
674/// in the cmdline.
675fn load_crashkernel_if_supported() -> Result<()> {
676 let supported = std::fs::read_to_string("/proc/cmdline")?.contains(" crashkernel=");
677 info!("ramdump supported: {}", supported);
678 if supported {
679 let status = Command::new("/system/bin/kexec_load").status()?;
680 if !status.success() {
681 return Err(anyhow!("Failed to load crashkernel: {:?}", status));
682 }
683 }
684 Ok(())
685}
686
Jiyong Park8611a6c2021-07-09 18:17:44 +0900687/// Executes the given task. Stdout of the task is piped into the vsock stream to the
688/// virtualizationservice in the host side.
Jooyung Han5c6d4172021-12-06 14:17:52 +0900689fn exec_task(task: &Task, service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900690 info!("executing main task {:?}...", task);
Inseob Kim86ca0162021-10-20 02:21:02 +0000691 let mut command = build_command(task)?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900692
693 info!("notifying payload started");
Inseob Kimc7d28c72021-10-25 14:28:10 +0000694 service.notifyPayloadStarted()?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900695
Inseob Kim86ca0162021-10-20 02:21:02 +0000696 let exit_status = command.spawn()?.wait()?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900697 exit_status.code().ok_or_else(|| anyhow!("Failed to get exit_code from the paylaod."))
Jooyung Han347d9f22021-05-28 00:05:14 +0900698}
Jooyung Han634e2d72021-06-10 16:27:38 +0900699
700fn build_command(task: &Task) -> Result<Command> {
Inseob Kim7f61fe72021-08-20 20:50:47 +0900701 const VMADDR_CID_HOST: u32 = 2;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900702
703 let mut command = match task.type_ {
Jooyung Han634e2d72021-06-10 16:27:38 +0900704 TaskType::Executable => {
705 let mut command = Command::new(&task.command);
706 command.args(&task.args);
707 command
708 }
709 TaskType::MicrodroidLauncher => {
710 let mut command = Command::new("/system/bin/microdroid_launcher");
711 command.arg(find_library_path(&task.command)?).args(&task.args);
712 command
713 }
Inseob Kim7f61fe72021-08-20 20:50:47 +0900714 };
715
Inseob Kimd0587562021-09-01 21:27:32 +0900716 match VsockStream::connect_with_cid_port(VMADDR_CID_HOST, VM_STREAM_SERVICE_PORT as u32) {
Inseob Kim7f61fe72021-08-20 20:50:47 +0900717 Ok(stream) => {
718 // SAFETY: the ownership of the underlying file descriptor is transferred from stream
719 // to the file object, and then into the Command object. When the command is finished,
720 // the file descriptor is closed.
721 let file = unsafe { File::from_raw_fd(stream.into_raw_fd()) };
722 command
723 .stdin(Stdio::from(file.try_clone()?))
724 .stdout(Stdio::from(file.try_clone()?))
725 .stderr(Stdio::from(file));
726 }
727 Err(e) => {
728 error!("failed to connect to virtualization service: {}", e);
729 // Don't fail hard here. Even if we failed to connect to the virtualizationservice,
730 // we keep executing the task. This can happen if the owner of the VM doesn't register
731 // callback to accept the stream. Use /dev/null as the stream so that the task can
732 // make progress without waiting for someone to consume the output.
733 command.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
734 }
735 }
736
737 Ok(command)
Jooyung Han634e2d72021-06-10 16:27:38 +0900738}
739
740fn find_library_path(name: &str) -> Result<String> {
741 let mut watcher = PropertyWatcher::new("ro.product.cpu.abilist")?;
742 let value = watcher.read(|_name, value| Ok(value.trim().to_string()))?;
743 let abi = value.split(',').next().ok_or_else(|| anyhow!("no abilist"))?;
744 let path = format!("/mnt/apk/lib/{}/{}", abi, name);
745
746 let metadata = fs::metadata(&path)?;
747 if !metadata.is_file() {
748 bail!("{} is not a file", &path);
749 }
750
751 Ok(path)
752}
Jiyong Park21ce2c52021-08-28 02:32:17 +0900753
754fn to_hex_string(buf: &[u8]) -> String {
755 buf.iter().map(|b| format!("{:02X}", b)).collect()
756}