blob: 20fc10450cdbb69a87d73ea3d9671a68c654ff40 [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;
Jooyung Han347d9f22021-05-28 00:05:14 +090020
Inseob Kime379e7d2022-07-22 18:55:18 +090021use crate::instance::{ApexData, ApkData, InstanceDisk, MicrodroidData, RootHash};
Andrew Scullb2f44472022-01-21 14:41:34 +000022use android_hardware_security_dice::aidl::android::hardware::security::dice::{
23 Config::Config, InputValues::InputValues, Mode::Mode,
24};
25use android_security_dice::aidl::android::security::dice::IDiceMaintenance::IDiceMaintenance;
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 Walbranc4ce7872022-07-29 11:26:41 +000032use binder::{wait_for_interface, 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";
Alan Stokes60f82202022-10-07 16:40:07 +010074const APK_MOUNT_DONE_PROP: &str = "microdroid_manager.apk.mounted";
Jiyong Parkbb4a9872021-09-06 15:59:21 +090075
Inseob Kim11f40d02022-06-13 17:16:00 +090076// SYNC WITH virtualizationservice/src/crosvm.rs
77const FAILURE_SERIAL_DEVICE: &str = "/dev/ttyS1";
78
Jooyung Handd0a1732021-11-23 15:26:20 +090079#[derive(thiserror::Error, Debug)]
80enum MicrodroidError {
Inseob Kim11f40d02022-06-13 17:16:00 +090081 #[error("Cannot connect to virtualization service: {0}")]
82 FailedToConnectToVirtualizationService(String),
Jooyung Handd0a1732021-11-23 15:26:20 +090083 #[error("Payload has changed: {0}")]
84 PayloadChanged(String),
85 #[error("Payload verification has failed: {0}")]
86 PayloadVerificationFailed(String),
Jooyung Han5c6d4172021-12-06 14:17:52 +090087 #[error("Payload config is invalid: {0}")]
88 InvalidConfig(String),
Jooyung Handd0a1732021-11-23 15:26:20 +090089}
90
Alan Stokes2bead0d2022-09-05 16:58:34 +010091fn translate_error(err: &Error) -> (ErrorCode, String) {
Jooyung Handd0a1732021-11-23 15:26:20 +090092 if let Some(e) = err.downcast_ref::<MicrodroidError>() {
93 match e {
Alan Stokes2bead0d2022-09-05 16:58:34 +010094 MicrodroidError::PayloadChanged(msg) => (ErrorCode::PAYLOAD_CHANGED, msg.to_string()),
Jooyung Handd0a1732021-11-23 15:26:20 +090095 MicrodroidError::PayloadVerificationFailed(msg) => {
Alan Stokes2bead0d2022-09-05 16:58:34 +010096 (ErrorCode::PAYLOAD_VERIFICATION_FAILED, msg.to_string())
Jooyung Handd0a1732021-11-23 15:26:20 +090097 }
Alan Stokes2bead0d2022-09-05 16:58:34 +010098 MicrodroidError::InvalidConfig(msg) => {
99 (ErrorCode::PAYLOAD_CONFIG_INVALID, msg.to_string())
100 }
Inseob Kim11f40d02022-06-13 17:16:00 +0900101
102 // Connection failure won't be reported to VS; return the default value
103 MicrodroidError::FailedToConnectToVirtualizationService(msg) => {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100104 (ErrorCode::UNKNOWN, msg.to_string())
Inseob Kim11f40d02022-06-13 17:16:00 +0900105 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900106 }
107 } else {
Alan Stokes2bead0d2022-09-05 16:58:34 +0100108 (ErrorCode::UNKNOWN, err.to_string())
Jooyung Handd0a1732021-11-23 15:26:20 +0900109 }
110}
111
Inseob Kim11f40d02022-06-13 17:16:00 +0900112fn write_death_reason_to_serial(err: &Error) -> Result<()> {
113 let death_reason = if let Some(e) = err.downcast_ref::<MicrodroidError>() {
114 match e {
115 MicrodroidError::FailedToConnectToVirtualizationService(_) => {
116 "MICRODROID_FAILED_TO_CONNECT_TO_VIRTUALIZATION_SERVICE"
117 }
118 MicrodroidError::PayloadChanged(_) => "MICRODROID_PAYLOAD_HAS_CHANGED",
119 MicrodroidError::PayloadVerificationFailed(_) => {
120 "MICRODROID_PAYLOAD_VERIFICATION_FAILED"
121 }
122 MicrodroidError::InvalidConfig(_) => "MICRODROID_INVALID_PAYLOAD_CONFIG",
123 }
124 } else {
125 "MICRODROID_UNKNOWN_RUNTIME_ERROR"
126 };
127
128 let death_reason_bytes = death_reason.as_bytes();
129 let mut sent_total = 0;
130 while sent_total < death_reason_bytes.len() {
131 // TODO(b/220071963): Sometimes, sending more than 16 bytes at once makes MM hang.
132 let begin = sent_total;
133 let end = std::cmp::min(begin.saturating_add(16), death_reason_bytes.len());
134 OpenOptions::new()
135 .read(false)
136 .write(true)
137 .open(FAILURE_SERIAL_DEVICE)?
138 .write_all(&death_reason_bytes[begin..end])?;
139 sent_total = end;
140 }
141
142 Ok(())
143}
144
Inseob Kim1b95f2e2021-08-19 13:17:40 +0900145fn get_vms_rpc_binder() -> Result<Strong<dyn IVirtualMachineService>> {
Andrew Walbran7eb5ca42022-08-08 15:33:34 +0000146 get_vsock_rpc_interface(VMADDR_CID_HOST, VM_BINDER_SERVICE_PORT as u32)
Andrew Walbranc4ce7872022-07-29 11:26:41 +0000147 .context("Cannot connect to RPC service")
Inseob Kim1b95f2e2021-08-19 13:17:40 +0900148}
149
Inseob Kim437f1052022-06-21 11:30:22 +0900150fn main() -> Result<()> {
151 scopeguard::defer! {
152 info!("Shutting down...");
Jooyung Hanbfe086f2021-10-28 10:15:45 +0900153 if let Err(e) = system_properties::write("sys.powerctl", "shutdown") {
154 error!("failed to shutdown {:?}", e);
155 }
Jooyung Han311b1202021-09-14 22:00:16 +0900156 }
Inseob Kim437f1052022-06-21 11:30:22 +0900157
158 try_main().map_err(|e| {
159 error!("Failed with {:?}.", e);
160 if let Err(e) = write_death_reason_to_serial(&e) {
161 error!("Failed to write death reason {:?}", e);
162 }
163 e
164 })
Jooyung Han311b1202021-09-14 22:00:16 +0900165}
166
167fn try_main() -> Result<()> {
Andrew Sculle127cff2022-02-15 15:34:04 +0000168 let _ = kernlog::init();
Jooyung Han347d9f22021-05-28 00:05:14 +0900169 info!("started.");
170
Jiyong Park202856e2022-08-22 16:04:26 +0900171 load_crashkernel_if_supported().context("Failed to load crashkernel")?;
172
Inseob Kim11f40d02022-06-13 17:16:00 +0900173 let service = get_vms_rpc_binder()
174 .context("cannot connect to VirtualMachineService")
175 .map_err(|e| MicrodroidError::FailedToConnectToVirtualizationService(e.to_string()))?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900176 match try_run_payload(&service) {
177 Ok(code) => {
178 info!("notifying payload finished");
179 service.notifyPayloadFinished(code)?;
180 if code == 0 {
181 info!("task successfully finished");
182 } else {
183 error!("task exited with exit code: {}", code);
184 }
185 Ok(())
186 }
187 Err(err) => {
Jooyung Han5c6d4172021-12-06 14:17:52 +0900188 let (error_code, message) = translate_error(&err);
189 service.notifyError(error_code, &message)?;
190 Err(err)
191 }
Jooyung Handd0a1732021-11-23 15:26:20 +0900192 }
193}
194
Alan Stokes1f417c92022-09-29 15:13:28 +0100195fn dice_derivation(
196 verified_data: &MicrodroidData,
197 payload_metadata: &PayloadMetadata,
198) -> Result<()> {
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
249 let diced =
250 wait_for_interface::<dyn IDiceMaintenance>("android.security.dice.IDiceMaintenance")
251 .context("IDiceMaintenance service not found")?;
252 diced
253 .demoteSelf(&[InputValues {
254 codeHash: code_hash,
255 config: Config { desc: config_desc },
256 authorityHash: authority_hash,
257 authorityDescriptor: None,
Andrew Scull65ddfc42022-02-14 21:03:58 +0000258 mode: if app_debuggable { Mode::DEBUG } else { Mode::NORMAL },
Inseob Kimb2519c52022-04-14 02:10:09 +0900259 hidden: verified_data.salt.clone().try_into().unwrap(),
Andrew Scullb2f44472022-01-21 14:41:34 +0000260 }])
261 .context("IDiceMaintenance::demoteSelf failed")?;
262 Ok(())
263}
264
Alan Stokes1f417c92022-09-29 15:13:28 +0100265fn encode_tstr(tstr: &str, buffer: &mut Vec<u8>) -> Result<()> {
266 let bytes = tstr.as_bytes();
267 encode_header(3, bytes.len().try_into().unwrap(), buffer)?;
268 buffer.extend_from_slice(bytes);
269 Ok(())
270}
271
272fn encode_negative_number(n: i64, buffer: &mut dyn Write) -> Result<()> {
273 ensure!(n < 0);
274 let n = -1 - n;
275 encode_header(1, n.try_into().unwrap(), buffer)
276}
277
Andrew Scullab72ec52022-03-14 09:10:52 +0000278fn is_strict_boot() -> bool {
279 Path::new(AVF_STRICT_BOOT).exists()
280}
281
282fn is_new_instance() -> bool {
283 Path::new(AVF_NEW_INSTANCE).exists()
284}
285
Inseob Kime379e7d2022-07-22 18:55:18 +0900286fn is_verified_boot() -> bool {
287 !Path::new(DEBUG_MICRODROID_NO_VERIFIED_BOOT).exists()
288}
289
Jooyung Han5c6d4172021-12-06 14:17:52 +0900290fn try_run_payload(service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jooyung Han311b1202021-09-14 22:00:16 +0900291 let metadata = load_metadata().context("Failed to load payload metadata")?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900292
Jooyung Han311b1202021-09-14 22:00:16 +0900293 let mut instance = InstanceDisk::new().context("Failed to load instance.img")?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900294 let saved_data = instance.read_microdroid_data().context("Failed to read identity data")?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900295
Andrew Scullab72ec52022-03-14 09:10:52 +0000296 if is_strict_boot() {
297 // Provisioning must happen on the first boot and never again.
298 if is_new_instance() {
299 ensure!(
300 saved_data.is_none(),
301 MicrodroidError::InvalidConfig("Found instance data on first boot.".to_string())
302 );
303 } else {
304 ensure!(
305 saved_data.is_some(),
306 MicrodroidError::InvalidConfig("Instance data not found.".to_string())
307 );
308 };
309 }
310
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900311 // Verify the payload before using it.
Inseob Kim11f40d02022-06-13 17:16:00 +0900312 let verified_data = verify_payload(&metadata, saved_data.as_ref())
313 .context("Payload verification failed")
314 .map_err(|e| MicrodroidError::PayloadVerificationFailed(e.to_string()))?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900315
316 // In case identity is ignored (by debug policy), we should reuse existing payload data, even
317 // when the payload is changed. This is to keep the derived secret same as before.
318 let verified_data = if let Some(saved_data) = saved_data {
319 if !is_verified_boot() {
320 if saved_data != verified_data {
321 info!("Detected an update of the payload, but continue (regarding debug policy)")
322 }
323 } else {
324 ensure!(
325 saved_data == verified_data,
326 MicrodroidError::PayloadChanged(String::from(
327 "Detected an update of the payload which isn't supported yet."
328 ))
329 );
330 info!("Saved data is verified.");
331 }
332 saved_data
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900333 } else {
Jooyung Han7a343f92021-09-08 22:53:11 +0900334 info!("Saving verified data.");
335 instance.write_microdroid_data(&verified_data).context("Failed to write identity data")?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900336 verified_data
337 };
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900338
Alan Stokes1f417c92022-09-29 15:13:28 +0100339 let payload_metadata = metadata.payload.ok_or_else(|| {
340 MicrodroidError::InvalidConfig("No payload config in metadata".to_string())
341 })?;
Alan Stokes0d1ef782022-09-27 13:46:35 +0100342
Inseob Kimb2519c52022-04-14 02:10:09 +0900343 // To minimize the exposure to untrusted data, derive dice profile as soon as possible.
344 info!("DICE derivation for payload");
Alan Stokes1f417c92022-09-29 15:13:28 +0100345 dice_derivation(&verified_data, &payload_metadata)?;
Inseob Kimb2519c52022-04-14 02:10:09 +0900346
Jooyung Hana6d11eb2021-09-10 11:48:05 +0900347 // Before reading a file from the APK, start zipfuse
Inseob Kim217038e2021-11-25 11:15:06 +0900348 run_zipfuse(
Alan Stokes60f82202022-10-07 16:40:07 +0100349 MountForExec::Allowed,
Inseob Kim217038e2021-11-25 11:15:06 +0900350 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:system_file:s0",
351 Path::new("/dev/block/mapper/microdroid-apk"),
352 Path::new("/mnt/apk"),
Alan Stokes60f82202022-10-07 16:40:07 +0100353 Some(APK_MOUNT_DONE_PROP),
Inseob Kim217038e2021-11-25 11:15:06 +0900354 )
355 .context("Failed to run zipfuse")?;
Jiyong Park21ce2c52021-08-28 02:32:17 +0900356
Alan Stokes1f417c92022-09-29 15:13:28 +0100357 let config = load_config(payload_metadata)?;
Shikha Panwar6f03c942022-04-13 20:26:50 +0000358
Alan Stokes01b3ef02022-09-22 17:43:24 +0100359 let task = config
360 .task
361 .as_ref()
362 .ok_or_else(|| MicrodroidError::InvalidConfig("No task in VM config".to_string()))?;
363
Inseob Kim197748b2021-12-01 19:49:00 +0900364 if config.extra_apks.len() != verified_data.extra_apks_data.len() {
365 return Err(anyhow!(
Alan Stokes1f417c92022-09-29 15:13:28 +0100366 "config expects {} extra apks, but found {}",
Inseob Kim197748b2021-12-01 19:49:00 +0900367 config.extra_apks.len(),
368 verified_data.extra_apks_data.len()
369 ));
370 }
371 mount_extra_apks(&config)?;
Jooyung Han634e2d72021-06-10 16:27:38 +0900372
Jooyung Han5c6d4172021-12-06 14:17:52 +0900373 // Wait until apex config is done. (e.g. linker configuration for apexes)
374 // TODO(jooyung): wait until sys.boot_completed?
375 wait_for_apex_config_done()?;
376
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900377 // Start tombstone_transmit if enabled
378 if config.export_tombstones {
Alan Stokes01b3ef02022-09-22 17:43:24 +0100379 control_service("start", "tombstone_transmit")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900380 } else {
Alan Stokes01b3ef02022-09-22 17:43:24 +0100381 control_service("stop", "tombstoned")?;
Inseob Kimcd9c1dd2022-07-13 17:13:45 +0900382 }
383
Alan Stokes01b3ef02022-09-22 17:43:24 +0100384 // Start authfs if enabled
385 if config.enable_authfs {
386 control_service("start", "authfs_service")?;
387 }
388
Alan Stokes60f82202022-10-07 16:40:07 +0100389 // Wait until zipfuse has mounted the APK so we can access the payload
390 wait_for_property_true(APK_MOUNT_DONE_PROP).context("Failed waiting for APK mount done")?;
391
Victor Hsieh8d006ba2022-05-02 09:42:02 -0700392 system_properties::write("dev.bootcomplete", "1").context("set dev.bootcomplete")?;
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
Alan Stokes60f82202022-10-07 16:40:07 +0100425enum MountForExec {
426 Allowed,
427 Disallowed,
428}
429
430fn run_zipfuse(
431 noexec: MountForExec,
432 option: &str,
433 zip_path: &Path,
434 mount_dir: &Path,
435 ready_prop: Option<&str>,
436) -> Result<Child> {
Andrew Scullcc339a12022-07-04 12:44:19 +0000437 let mut cmd = Command::new(ZIPFUSE_BIN);
Alan Stokes60f82202022-10-07 16:40:07 +0100438 if let MountForExec::Disallowed = noexec {
Andrew Scullcc339a12022-07-04 12:44:19 +0000439 cmd.arg("--noexec");
440 }
Alan Stokes60f82202022-10-07 16:40:07 +0100441 if let Some(property_name) = ready_prop {
442 cmd.args(["-p", property_name]);
443 }
Andrew Scullcc339a12022-07-04 12:44:19 +0000444 cmd.arg("-o")
Inseob Kim217038e2021-11-25 11:15:06 +0900445 .arg(option)
446 .arg(zip_path)
447 .arg(mount_dir)
448 .stdin(Stdio::null())
449 .stdout(Stdio::null())
450 .stderr(Stdio::null())
451 .spawn()
452 .context("Spawn zipfuse")
453}
454
Inseob Kime379e7d2022-07-22 18:55:18 +0900455fn write_apex_payload_data(
456 saved_data: Option<&MicrodroidData>,
457 apex_data_from_payload: &[ApexData],
458) -> Result<()> {
459 if let Some(saved_apex_data) = saved_data.map(|d| &d.apex_data) {
460 // We don't support APEX updates. (assuming that update will change root digest)
461 ensure!(
462 saved_apex_data == apex_data_from_payload,
463 MicrodroidError::PayloadChanged(String::from("APEXes have changed."))
464 );
465 let apex_metadata = to_metadata(apex_data_from_payload);
466 // Pass metadata(with public keys and root digests) to apexd so that it uses the passed
467 // metadata instead of the default one (/dev/block/by-name/payload-metadata)
468 OpenOptions::new()
469 .create_new(true)
470 .write(true)
471 .open("/apex/vm-payload-metadata")
472 .context("Failed to open /apex/vm-payload-metadata")
473 .and_then(|f| write_metadata(&apex_metadata, f))?;
474 }
475 Ok(())
476}
477
Jooyung Han7a343f92021-09-08 22:53:11 +0900478// Verify payload before executing it. For APK payload, Full verification (which is slow) is done
479// when the root_hash values from the idsig file and the instance disk are different. This function
480// returns the verified root hash (for APK payload) and pubkeys (for APEX payloads) that can be
481// saved to the instance disk.
482fn verify_payload(
483 metadata: &Metadata,
484 saved_data: Option<&MicrodroidData>,
485) -> Result<MicrodroidData> {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900486 let start_time = SystemTime::now();
487
Inseob Kim197748b2021-12-01 19:49:00 +0900488 // Verify main APK
Jooyung Han7a343f92021-09-08 22:53:11 +0900489 let root_hash = saved_data.map(|d| &d.apk_data.root_hash);
Inseob Kim197748b2021-12-01 19:49:00 +0900490 let root_hash_from_idsig = get_apk_root_hash_from_idsig(MAIN_APK_IDSIG_PATH)?;
Jiyong Parkf7dea252021-09-08 01:42:54 +0900491 let root_hash_trustful = root_hash == Some(&root_hash_from_idsig);
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900492
Jiyong Parkf7dea252021-09-08 01:42:54 +0900493 // 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 +0900494 // instead of the value read from the idsig file.
Inseob Kim197748b2021-12-01 19:49:00 +0900495 let main_apk_argument = {
496 ApkDmverityArgument {
497 apk: MAIN_APK_PATH,
498 idsig: MAIN_APK_IDSIG_PATH,
499 name: MAIN_APK_DEVICE_NAME,
500 saved_root_hash: if root_hash_trustful {
501 Some(root_hash_from_idsig.as_ref())
502 } else {
503 None
504 },
505 }
506 };
507 let mut apkdmverity_arguments = vec![main_apk_argument];
508
509 // Verify extra APKs
510 // For now, we can't read the payload config, so glob APKs and idsigs.
511 // Later, we'll see if it matches with the payload config.
512
513 // sort globbed paths to match apks (extra-apk-{idx}) and idsigs (extra-idsig-{idx})
514 // e.g. "extra-apk-0" corresponds to "extra-idsig-0"
515 let extra_apks =
516 sorted(glob(EXTRA_APK_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
517 let extra_idsigs =
518 sorted(glob(EXTRA_IDSIG_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>();
519 if extra_apks.len() != extra_idsigs.len() {
520 return Err(anyhow!(
521 "Extra apks/idsigs mismatch: {} apks but {} idsigs",
522 extra_apks.len(),
523 extra_idsigs.len()
524 ));
525 }
526 let extra_apks_count = extra_apks.len();
527
528 let (extra_apk_names, extra_root_hashes_from_idsig): (Vec<_>, Vec<_>) = extra_idsigs
529 .iter()
530 .enumerate()
531 .map(|(i, extra_idsig)| {
532 (
533 format!("extra-apk-{}", i),
Alice Wang89cff012022-09-26 10:05:16 +0000534 get_apk_root_hash_from_idsig(extra_idsig)
Inseob Kim197748b2021-12-01 19:49:00 +0900535 .expect("Can't find root hash from extra idsig"),
536 )
537 })
538 .unzip();
539
540 let saved_extra_root_hashes: Vec<_> = saved_data
541 .map(|d| d.extra_apks_data.iter().map(|apk_data| &apk_data.root_hash).collect())
542 .unwrap_or_else(Vec::new);
543 let extra_root_hashes_trustful: Vec<_> = extra_root_hashes_from_idsig
544 .iter()
545 .enumerate()
546 .map(|(i, root_hash_from_idsig)| {
547 saved_extra_root_hashes.get(i).copied() == Some(root_hash_from_idsig)
548 })
549 .collect();
550
551 for i in 0..extra_apks_count {
552 apkdmverity_arguments.push({
553 ApkDmverityArgument {
554 apk: extra_apks[i].to_str().unwrap(),
555 idsig: extra_idsigs[i].to_str().unwrap(),
556 name: &extra_apk_names[i],
557 saved_root_hash: if extra_root_hashes_trustful[i] {
558 Some(&extra_root_hashes_from_idsig[i])
559 } else {
560 None
561 },
562 }
563 });
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900564 }
565
566 // Start apkdmverity and wait for the dm-verify block
Inseob Kim197748b2021-12-01 19:49:00 +0900567 let mut apkdmverity_child = run_apkdmverity(&apkdmverity_arguments)?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900568
Jooyung Hanc8deb472021-09-13 13:48:25 +0900569 // While waiting for apkdmverity to mount APK, gathers public keys and root digests from
570 // APEX payload.
Jooyung Han7a343f92021-09-08 22:53:11 +0900571 let apex_data_from_payload = get_apex_data_from_payload(metadata)?;
Inseob Kime379e7d2022-07-22 18:55:18 +0900572
573 // Writing /apex/vm-payload-metadata is to verify that the payload isn't changed.
574 // Skip writing it if the debug policy ignoring identity is on
575 if is_verified_boot() {
576 write_apex_payload_data(saved_data, &apex_data_from_payload)?;
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900577 }
Inseob Kime379e7d2022-07-22 18:55:18 +0900578
Jooyung Han4a9b3bf2021-09-10 17:19:00 +0900579 // Start apexd to activate APEXes
580 system_properties::write("ctl.start", "apexd-vm")?;
Jooyung Han7a343f92021-09-08 22:53:11 +0900581
Inseob Kim217038e2021-11-25 11:15:06 +0900582 // TODO(inseob): add timeout
583 apkdmverity_child.wait()?;
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900584
Jiyong Parkf7dea252021-09-08 01:42:54 +0900585 // Do the full verification if the root_hash is un-trustful. This requires the full scanning of
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900586 // 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 +0900587 // 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 +0900588 // of the VM or APK was updated in the host.
589 // TODO(jooyung): consider multithreading to make this faster
Inseob Kim197748b2021-12-01 19:49:00 +0900590 let main_apk_pubkey = get_public_key_from_apk(DM_MOUNTED_APK_PATH, root_hash_trustful)?;
591 let extra_apks_data = extra_root_hashes_from_idsig
592 .into_iter()
593 .enumerate()
594 .map(|(i, extra_root_hash)| {
595 let mount_path = format!("/dev/block/mapper/{}", &extra_apk_names[i]);
596 let apk_pubkey = get_public_key_from_apk(&mount_path, extra_root_hashes_trustful[i])?;
597 Ok(ApkData { root_hash: extra_root_hash, pubkey: apk_pubkey })
598 })
599 .collect::<Result<Vec<_>>>()?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900600
601 info!("payload verification successful. took {:#?}", start_time.elapsed().unwrap());
602
Andrew Scull34916a72022-01-30 21:34:24 +0000603 // Use the salt from a verified instance, or generate a salt for a new instance.
604 let salt = if let Some(saved_data) = saved_data {
605 saved_data.salt.clone()
606 } else {
607 let mut salt = vec![0u8; 64];
608 salt.as_mut_slice().try_fill(&mut rand::thread_rng())?;
609 salt
610 };
611
Jiyong Parkf7dea252021-09-08 01:42:54 +0900612 // At this point, we can ensure that the root_hash from the idsig file is trusted, either by
613 // fully verifying the APK or by comparing it with the saved root_hash.
Jooyung Han7a343f92021-09-08 22:53:11 +0900614 Ok(MicrodroidData {
Andrew Scull34916a72022-01-30 21:34:24 +0000615 salt,
Inseob Kim197748b2021-12-01 19:49:00 +0900616 apk_data: ApkData { root_hash: root_hash_from_idsig, pubkey: main_apk_pubkey },
617 extra_apks_data,
Jooyung Han7a343f92021-09-08 22:53:11 +0900618 apex_data: apex_data_from_payload,
619 })
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900620}
621
Inseob Kim197748b2021-12-01 19:49:00 +0900622fn mount_extra_apks(config: &VmPayloadConfig) -> Result<()> {
623 // For now, only the number of apks is important, as the mount point and dm-verity name is fixed
624 for i in 0..config.extra_apks.len() {
625 let mount_dir = format!("/mnt/extra-apk/{}", i);
626 create_dir(Path::new(&mount_dir)).context("Failed to create mount dir for extra apks")?;
627
628 // don't wait, just detach
629 run_zipfuse(
Alan Stokes60f82202022-10-07 16:40:07 +0100630 MountForExec::Disallowed,
Inseob Kim197748b2021-12-01 19:49:00 +0900631 "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:extra_apk_file:s0",
632 Path::new(&format!("/dev/block/mapper/extra-apk-{}", i)),
633 Path::new(&mount_dir),
Alan Stokes60f82202022-10-07 16:40:07 +0100634 None,
Inseob Kim197748b2021-12-01 19:49:00 +0900635 )
636 .context("Failed to zipfuse extra apks")?;
637 }
638
639 Ok(())
640}
641
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900642// Waits until linker config is generated
643fn wait_for_apex_config_done() -> Result<()> {
Alan Stokes60f82202022-10-07 16:40:07 +0100644 wait_for_property_true(APEX_CONFIG_DONE_PROP).context("Failed waiting for apex config done")
645}
646
647fn wait_for_property_true(property_name: &str) -> Result<()> {
648 let mut prop = PropertyWatcher::new(property_name)?;
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900649 loop {
650 prop.wait()?;
Alan Stokes60f82202022-10-07 16:40:07 +0100651 if system_properties::read_bool(property_name, false)? {
Jiyong Parkbb4a9872021-09-06 15:59:21 +0900652 break;
653 }
654 }
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900655 Ok(())
656}
657
Alice Wang89cff012022-09-26 10:05:16 +0000658fn get_apk_root_hash_from_idsig<P: AsRef<Path>>(idsig_path: P) -> Result<Box<RootHash>> {
659 Ok(V4Signature::from_idsig_path(idsig_path)?.hashing_info.raw_root_hash)
Jiyong Park21ce2c52021-08-28 02:32:17 +0900660}
661
Inseob Kim197748b2021-12-01 19:49:00 +0900662fn get_public_key_from_apk(apk: &str, root_hash_trustful: bool) -> Result<Box<[u8]>> {
663 if !root_hash_trustful {
664 verify(apk).context(MicrodroidError::PayloadVerificationFailed(format!(
665 "failed to verify {}",
666 apk
667 )))
668 } else {
669 get_public_key_der(apk)
670 }
671}
672
Alan Stokes1f417c92022-09-29 15:13:28 +0100673fn load_config(payload_metadata: PayloadMetadata) -> Result<VmPayloadConfig> {
674 match payload_metadata {
675 PayloadMetadata::config_path(path) => {
676 let path = Path::new(&path);
677 info!("loading config from {:?}...", path);
678 let file = ioutil::wait_for_file(path, WAIT_TIMEOUT)?;
679 Ok(serde_json::from_reader(file)?)
680 }
681 PayloadMetadata::config(payload_config) => {
682 let task = Task {
683 type_: TaskType::MicrodroidLauncher,
684 command: payload_config.payload_binary_path,
685 args: payload_config.args.into_vec(),
686 };
687 Ok(VmPayloadConfig {
688 os: OsConfig { name: "microdroid".to_owned() },
689 task: Some(task),
690 apexes: vec![],
691 extra_apks: vec![],
692 prefer_staged: false,
693 export_tombstones: false,
694 enable_authfs: false,
695 })
696 }
697 }
Jooyung Han634e2d72021-06-10 16:27:38 +0900698}
699
Jiyong Park202856e2022-08-22 16:04:26 +0900700/// Loads the crashkernel into memory using kexec if the VM is loaded with `crashkernel=' parameter
701/// in the cmdline.
702fn load_crashkernel_if_supported() -> Result<()> {
703 let supported = std::fs::read_to_string("/proc/cmdline")?.contains(" crashkernel=");
704 info!("ramdump supported: {}", supported);
705 if supported {
706 let status = Command::new("/system/bin/kexec_load").status()?;
707 if !status.success() {
708 return Err(anyhow!("Failed to load crashkernel: {:?}", status));
709 }
710 }
711 Ok(())
712}
713
Jiyong Park8611a6c2021-07-09 18:17:44 +0900714/// Executes the given task. Stdout of the task is piped into the vsock stream to the
715/// virtualizationservice in the host side.
Jooyung Han5c6d4172021-12-06 14:17:52 +0900716fn exec_task(task: &Task, service: &Strong<dyn IVirtualMachineService>) -> Result<i32> {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900717 info!("executing main task {:?}...", task);
Inseob Kim86ca0162021-10-20 02:21:02 +0000718 let mut command = build_command(task)?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900719
720 info!("notifying payload started");
Inseob Kimc7d28c72021-10-25 14:28:10 +0000721 service.notifyPayloadStarted()?;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900722
Inseob Kim86ca0162021-10-20 02:21:02 +0000723 let exit_status = command.spawn()?.wait()?;
Jooyung Han5c6d4172021-12-06 14:17:52 +0900724 exit_status.code().ok_or_else(|| anyhow!("Failed to get exit_code from the paylaod."))
Jooyung Han347d9f22021-05-28 00:05:14 +0900725}
Jooyung Han634e2d72021-06-10 16:27:38 +0900726
727fn build_command(task: &Task) -> Result<Command> {
Inseob Kim7f61fe72021-08-20 20:50:47 +0900728 const VMADDR_CID_HOST: u32 = 2;
Inseob Kim7f61fe72021-08-20 20:50:47 +0900729
730 let mut command = match task.type_ {
Jooyung Han634e2d72021-06-10 16:27:38 +0900731 TaskType::Executable => {
732 let mut command = Command::new(&task.command);
733 command.args(&task.args);
734 command
735 }
736 TaskType::MicrodroidLauncher => {
737 let mut command = Command::new("/system/bin/microdroid_launcher");
738 command.arg(find_library_path(&task.command)?).args(&task.args);
739 command
740 }
Inseob Kim7f61fe72021-08-20 20:50:47 +0900741 };
742
Inseob Kimd0587562021-09-01 21:27:32 +0900743 match VsockStream::connect_with_cid_port(VMADDR_CID_HOST, VM_STREAM_SERVICE_PORT as u32) {
Inseob Kim7f61fe72021-08-20 20:50:47 +0900744 Ok(stream) => {
745 // SAFETY: the ownership of the underlying file descriptor is transferred from stream
746 // to the file object, and then into the Command object. When the command is finished,
747 // the file descriptor is closed.
748 let file = unsafe { File::from_raw_fd(stream.into_raw_fd()) };
749 command
750 .stdin(Stdio::from(file.try_clone()?))
751 .stdout(Stdio::from(file.try_clone()?))
752 .stderr(Stdio::from(file));
753 }
754 Err(e) => {
755 error!("failed to connect to virtualization service: {}", e);
756 // Don't fail hard here. Even if we failed to connect to the virtualizationservice,
757 // we keep executing the task. This can happen if the owner of the VM doesn't register
758 // callback to accept the stream. Use /dev/null as the stream so that the task can
759 // make progress without waiting for someone to consume the output.
760 command.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
761 }
762 }
763
764 Ok(command)
Jooyung Han634e2d72021-06-10 16:27:38 +0900765}
766
767fn find_library_path(name: &str) -> Result<String> {
768 let mut watcher = PropertyWatcher::new("ro.product.cpu.abilist")?;
769 let value = watcher.read(|_name, value| Ok(value.trim().to_string()))?;
770 let abi = value.split(',').next().ok_or_else(|| anyhow!("no abilist"))?;
771 let path = format!("/mnt/apk/lib/{}/{}", abi, name);
772
773 let metadata = fs::metadata(&path)?;
774 if !metadata.is_file() {
775 bail!("{} is not a file", &path);
776 }
777
778 Ok(path)
779}
Jiyong Park21ce2c52021-08-28 02:32:17 +0900780
781fn to_hex_string(buf: &[u8]) -> String {
782 buf.iter().map(|b| format!("{:02X}", b)).collect()
783}