Jooyung Han | 347d9f2 | 2021-05-28 00:05:14 +0900 | [diff] [blame] | 1 | // 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 Scull | d64ae7d | 2022-10-05 17:41:43 +0000 | [diff] [blame] | 17 | mod dice; |
Jiyong Park | 21ce2c5 | 2021-08-28 02:32:17 +0900 | [diff] [blame] | 18 | mod instance; |
Jooyung Han | f48ceb4 | 2021-06-01 18:00:04 +0900 | [diff] [blame] | 19 | mod ioutil; |
Jooyung Han | 7a343f9 | 2021-09-08 22:53:11 +0900 | [diff] [blame] | 20 | mod payload; |
Seungjae Yoo | fd9a062 | 2022-10-14 10:01:29 +0900 | [diff] [blame] | 21 | mod procutil; |
Keir Fraser | 933f0ac | 2022-10-12 08:23:28 +0000 | [diff] [blame] | 22 | mod swap; |
Alice Wang | 59a9e56 | 2022-10-04 15:24:10 +0000 | [diff] [blame] | 23 | mod vm_payload_service; |
Jooyung Han | 347d9f2 | 2021-05-28 00:05:14 +0900 | [diff] [blame] | 24 | |
Andrew Scull | d64ae7d | 2022-10-05 17:41:43 +0000 | [diff] [blame] | 25 | use crate::dice::{DiceContext, DiceDriver}; |
Inseob Kim | e379e7d | 2022-07-22 18:55:18 +0900 | [diff] [blame] | 26 | use crate::instance::{ApexData, ApkData, InstanceDisk, MicrodroidData, RootHash}; |
Alice Wang | 59a9e56 | 2022-10-04 15:24:10 +0000 | [diff] [blame] | 27 | use crate::vm_payload_service::register_vm_payload_service; |
Alan Stokes | 2bead0d | 2022-09-05 16:58:34 +0100 | [diff] [blame] | 28 | use android_system_virtualizationcommon::aidl::android::system::virtualizationcommon::ErrorCode::ErrorCode; |
Seungjae Yoo | fd9a062 | 2022-10-14 10:01:29 +0900 | [diff] [blame] | 29 | use android_system_virtualmachineservice::aidl::android::system::virtualmachineservice::{ |
| 30 | IVirtualMachineService::{ |
| 31 | IVirtualMachineService, VM_BINDER_SERVICE_PORT, VM_STREAM_SERVICE_PORT, |
| 32 | }, |
| 33 | VirtualMachineCpuStatus::VirtualMachineCpuStatus, |
| 34 | VirtualMachineMemStatus::VirtualMachineMemStatus, |
Alan Stokes | 2bead0d | 2022-09-05 16:58:34 +0100 | [diff] [blame] | 35 | }; |
Jooyung Han | dd0a173 | 2021-11-23 15:26:20 +0900 | [diff] [blame] | 36 | use anyhow::{anyhow, bail, ensure, Context, Error, Result}; |
Alice Wang | 1bf3d78 | 2022-09-28 07:56:36 +0000 | [diff] [blame] | 37 | use apkverify::{get_public_key_der, verify, V4Signature}; |
Andrew Scull | d64ae7d | 2022-10-05 17:41:43 +0000 | [diff] [blame] | 38 | use binder::{ProcessState, Strong}; |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 39 | use diced_utils::cbor::{encode_header, encode_number}; |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 40 | use glob::glob; |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 41 | use itertools::sorted; |
Andrew Scull | 684590f | 2022-01-27 16:14:26 +0000 | [diff] [blame] | 42 | use log::{error, info}; |
Alan Stokes | 0d1ef78 | 2022-09-27 13:46:35 +0100 | [diff] [blame] | 43 | use microdroid_metadata::{write_metadata, Metadata, PayloadMetadata}; |
Seungjae Yoo | fd9a062 | 2022-10-14 10:01:29 +0900 | [diff] [blame] | 44 | use microdroid_payload_config::{OsConfig, Task, TaskType, VmPayloadConfig}; |
Andrew Scull | a0d1b1a | 2022-05-24 19:32:47 +0000 | [diff] [blame] | 45 | use openssl::sha::Sha512; |
Jooyung Han | 4a9b3bf | 2021-09-10 17:19:00 +0900 | [diff] [blame] | 46 | use payload::{get_apex_data_from_payload, load_metadata, to_metadata}; |
Seungjae Yoo | fd9a062 | 2022-10-14 10:01:29 +0900 | [diff] [blame] | 47 | use procutil::{get_cpu_time, get_mem_info}; |
Andrew Scull | 34916a7 | 2022-01-30 21:34:24 +0000 | [diff] [blame] | 48 | use rand::Fill; |
Andrew Walbran | 7eb5ca4 | 2022-08-08 15:33:34 +0000 | [diff] [blame] | 49 | use rpcbinder::get_vsock_rpc_interface; |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 50 | use rustutils::system_properties; |
Joel Galenson | 482704c | 2021-07-29 15:53:53 -0700 | [diff] [blame] | 51 | use rustutils::system_properties::PropertyWatcher; |
Alan Stokes | 3ba10fd | 2022-10-06 15:46:51 +0100 | [diff] [blame] | 52 | use std::borrow::Cow::{Borrowed, Owned}; |
Andrew Scull | b2f4447 | 2022-01-21 14:41:34 +0000 | [diff] [blame] | 53 | use std::convert::TryInto; |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 54 | use std::fs::{self, create_dir, File, OpenOptions}; |
Inseob Kim | 11f40d0 | 2022-06-13 17:16:00 +0900 | [diff] [blame] | 55 | use std::io::Write; |
Inseob Kim | c7d28c7 | 2021-10-25 14:28:10 +0000 | [diff] [blame] | 56 | use std::os::unix::io::{FromRawFd, IntoRawFd}; |
Jooyung Han | f48ceb4 | 2021-06-01 18:00:04 +0900 | [diff] [blame] | 57 | use std::path::Path; |
Inseob Kim | 217038e | 2021-11-25 11:15:06 +0900 | [diff] [blame] | 58 | use std::process::{Child, Command, Stdio}; |
Jiyong Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 59 | use std::str; |
Seungjae Yoo | fd9a062 | 2022-10-14 10:01:29 +0900 | [diff] [blame] | 60 | use std::thread; |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 61 | use std::time::{Duration, SystemTime}; |
Jiyong Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 62 | use vsock::VsockStream; |
Jooyung Han | 634e2d7 | 2021-06-10 16:27:38 +0900 | [diff] [blame] | 63 | |
| 64 | const WAIT_TIMEOUT: Duration = Duration::from_secs(10); |
Seungjae Yoo | 2b893b9 | 2022-10-26 14:29:27 +0900 | [diff] [blame^] | 65 | const SENDING_VM_STATUS_CYCLE_PERIOD: Duration = Duration::from_secs(60); |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 66 | const MAIN_APK_PATH: &str = "/dev/block/by-name/microdroid-apk"; |
| 67 | const MAIN_APK_IDSIG_PATH: &str = "/dev/block/by-name/microdroid-apk-idsig"; |
| 68 | const MAIN_APK_DEVICE_NAME: &str = "microdroid-apk"; |
| 69 | const EXTRA_APK_PATH_PATTERN: &str = "/dev/block/by-name/extra-apk-*"; |
| 70 | const EXTRA_IDSIG_PATH_PATTERN: &str = "/dev/block/by-name/extra-idsig-*"; |
Jooyung Han | 19c1d6c | 2021-08-06 14:08:16 +0900 | [diff] [blame] | 71 | const DM_MOUNTED_APK_PATH: &str = "/dev/block/mapper/microdroid-apk"; |
Inseob Kim | 217038e | 2021-11-25 11:15:06 +0900 | [diff] [blame] | 72 | const APKDMVERITY_BIN: &str = "/system/bin/apkdmverity"; |
| 73 | const ZIPFUSE_BIN: &str = "/system/bin/zipfuse"; |
Andrew Scull | ab72ec5 | 2022-03-14 09:10:52 +0000 | [diff] [blame] | 74 | const AVF_STRICT_BOOT: &str = "/sys/firmware/devicetree/base/chosen/avf,strict-boot"; |
| 75 | const AVF_NEW_INSTANCE: &str = "/sys/firmware/devicetree/base/chosen/avf,new-instance"; |
Inseob Kim | e379e7d | 2022-07-22 18:55:18 +0900 | [diff] [blame] | 76 | const DEBUG_MICRODROID_NO_VERIFIED_BOOT: &str = |
| 77 | "/sys/firmware/devicetree/base/virtualization/guest/debug-microdroid,no-verified-boot"; |
Jooyung Han | 347d9f2 | 2021-05-28 00:05:14 +0900 | [diff] [blame] | 78 | |
Inseob Kim | 1b95f2e | 2021-08-19 13:17:40 +0900 | [diff] [blame] | 79 | /// The CID representing the host VM |
| 80 | const VMADDR_CID_HOST: u32 = 2; |
| 81 | |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 82 | const APEX_CONFIG_DONE_PROP: &str = "apex_config.done"; |
Andrew Scull | 65ddfc4 | 2022-02-14 21:03:58 +0000 | [diff] [blame] | 83 | const APP_DEBUGGABLE_PROP: &str = "ro.boot.microdroid.app_debuggable"; |
Alan Stokes | 60f8220 | 2022-10-07 16:40:07 +0100 | [diff] [blame] | 84 | const APK_MOUNT_DONE_PROP: &str = "microdroid_manager.apk.mounted"; |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 85 | |
Inseob Kim | 11f40d0 | 2022-06-13 17:16:00 +0900 | [diff] [blame] | 86 | // SYNC WITH virtualizationservice/src/crosvm.rs |
| 87 | const FAILURE_SERIAL_DEVICE: &str = "/dev/ttyS1"; |
| 88 | |
Jooyung Han | dd0a173 | 2021-11-23 15:26:20 +0900 | [diff] [blame] | 89 | #[derive(thiserror::Error, Debug)] |
| 90 | enum MicrodroidError { |
Inseob Kim | 11f40d0 | 2022-06-13 17:16:00 +0900 | [diff] [blame] | 91 | #[error("Cannot connect to virtualization service: {0}")] |
| 92 | FailedToConnectToVirtualizationService(String), |
Jooyung Han | dd0a173 | 2021-11-23 15:26:20 +0900 | [diff] [blame] | 93 | #[error("Payload has changed: {0}")] |
| 94 | PayloadChanged(String), |
| 95 | #[error("Payload verification has failed: {0}")] |
| 96 | PayloadVerificationFailed(String), |
Jooyung Han | 5c6d417 | 2021-12-06 14:17:52 +0900 | [diff] [blame] | 97 | #[error("Payload config is invalid: {0}")] |
| 98 | InvalidConfig(String), |
Jooyung Han | dd0a173 | 2021-11-23 15:26:20 +0900 | [diff] [blame] | 99 | } |
| 100 | |
Seungjae Yoo | 2b893b9 | 2022-10-26 14:29:27 +0900 | [diff] [blame^] | 101 | fn send_vm_status(service: &Strong<dyn IVirtualMachineService>) -> Result<()> { |
| 102 | // Collect VM CPU time information and creating VmCpuStatus atom for metrics. |
| 103 | let cpu_time = get_cpu_time()?; |
| 104 | let vm_cpu_status = VirtualMachineCpuStatus { |
| 105 | cpu_time_user: cpu_time.user, |
| 106 | cpu_time_nice: cpu_time.nice, |
| 107 | cpu_time_sys: cpu_time.sys, |
| 108 | cpu_time_idle: cpu_time.idle, |
| 109 | }; |
| 110 | service.notifyCpuStatus(&vm_cpu_status).expect("Can't send information about VM CPU status"); |
| 111 | |
| 112 | // Collect VM memory information and creating VmMemStatus atom for metrics. |
| 113 | let mem_info = get_mem_info()?; |
| 114 | let vm_mem_status = VirtualMachineMemStatus { |
| 115 | mem_total: mem_info.total, |
| 116 | mem_free: mem_info.free, |
| 117 | mem_available: mem_info.available, |
| 118 | mem_buffer: mem_info.buffer, |
| 119 | mem_cached: mem_info.cached, |
| 120 | }; |
| 121 | service.notifyMemStatus(&vm_mem_status).expect("Can't send information about VM memory status"); |
| 122 | |
| 123 | Ok(()) |
| 124 | } |
| 125 | |
| 126 | fn send_vm_status_periodically() -> Result<()> { |
Seungjae Yoo | fd9a062 | 2022-10-14 10:01:29 +0900 | [diff] [blame] | 127 | let service = get_vms_rpc_binder() |
| 128 | .context("cannot connect to VirtualMachineService") |
| 129 | .map_err(|e| MicrodroidError::FailedToConnectToVirtualizationService(e.to_string()))?; |
| 130 | |
Seungjae Yoo | fd9a062 | 2022-10-14 10:01:29 +0900 | [diff] [blame] | 131 | loop { |
Seungjae Yoo | 2b893b9 | 2022-10-26 14:29:27 +0900 | [diff] [blame^] | 132 | send_vm_status(&service)?; |
| 133 | thread::sleep(SENDING_VM_STATUS_CYCLE_PERIOD); |
Seungjae Yoo | fd9a062 | 2022-10-14 10:01:29 +0900 | [diff] [blame] | 134 | } |
| 135 | } |
| 136 | |
Alan Stokes | 2bead0d | 2022-09-05 16:58:34 +0100 | [diff] [blame] | 137 | fn translate_error(err: &Error) -> (ErrorCode, String) { |
Jooyung Han | dd0a173 | 2021-11-23 15:26:20 +0900 | [diff] [blame] | 138 | if let Some(e) = err.downcast_ref::<MicrodroidError>() { |
| 139 | match e { |
Alan Stokes | 2bead0d | 2022-09-05 16:58:34 +0100 | [diff] [blame] | 140 | MicrodroidError::PayloadChanged(msg) => (ErrorCode::PAYLOAD_CHANGED, msg.to_string()), |
Jooyung Han | dd0a173 | 2021-11-23 15:26:20 +0900 | [diff] [blame] | 141 | MicrodroidError::PayloadVerificationFailed(msg) => { |
Alan Stokes | 2bead0d | 2022-09-05 16:58:34 +0100 | [diff] [blame] | 142 | (ErrorCode::PAYLOAD_VERIFICATION_FAILED, msg.to_string()) |
Jooyung Han | dd0a173 | 2021-11-23 15:26:20 +0900 | [diff] [blame] | 143 | } |
Alan Stokes | 2bead0d | 2022-09-05 16:58:34 +0100 | [diff] [blame] | 144 | MicrodroidError::InvalidConfig(msg) => { |
| 145 | (ErrorCode::PAYLOAD_CONFIG_INVALID, msg.to_string()) |
| 146 | } |
Inseob Kim | 11f40d0 | 2022-06-13 17:16:00 +0900 | [diff] [blame] | 147 | |
| 148 | // Connection failure won't be reported to VS; return the default value |
| 149 | MicrodroidError::FailedToConnectToVirtualizationService(msg) => { |
Alan Stokes | 2bead0d | 2022-09-05 16:58:34 +0100 | [diff] [blame] | 150 | (ErrorCode::UNKNOWN, msg.to_string()) |
Inseob Kim | 11f40d0 | 2022-06-13 17:16:00 +0900 | [diff] [blame] | 151 | } |
Jooyung Han | dd0a173 | 2021-11-23 15:26:20 +0900 | [diff] [blame] | 152 | } |
| 153 | } else { |
Alan Stokes | 2bead0d | 2022-09-05 16:58:34 +0100 | [diff] [blame] | 154 | (ErrorCode::UNKNOWN, err.to_string()) |
Jooyung Han | dd0a173 | 2021-11-23 15:26:20 +0900 | [diff] [blame] | 155 | } |
| 156 | } |
| 157 | |
Inseob Kim | 11f40d0 | 2022-06-13 17:16:00 +0900 | [diff] [blame] | 158 | fn write_death_reason_to_serial(err: &Error) -> Result<()> { |
| 159 | let death_reason = if let Some(e) = err.downcast_ref::<MicrodroidError>() { |
Alan Stokes | 3ba10fd | 2022-10-06 15:46:51 +0100 | [diff] [blame] | 160 | Borrowed(match e { |
Inseob Kim | 11f40d0 | 2022-06-13 17:16:00 +0900 | [diff] [blame] | 161 | MicrodroidError::FailedToConnectToVirtualizationService(_) => { |
| 162 | "MICRODROID_FAILED_TO_CONNECT_TO_VIRTUALIZATION_SERVICE" |
| 163 | } |
| 164 | MicrodroidError::PayloadChanged(_) => "MICRODROID_PAYLOAD_HAS_CHANGED", |
| 165 | MicrodroidError::PayloadVerificationFailed(_) => { |
| 166 | "MICRODROID_PAYLOAD_VERIFICATION_FAILED" |
| 167 | } |
| 168 | MicrodroidError::InvalidConfig(_) => "MICRODROID_INVALID_PAYLOAD_CONFIG", |
Alan Stokes | 3ba10fd | 2022-10-06 15:46:51 +0100 | [diff] [blame] | 169 | }) |
Inseob Kim | 11f40d0 | 2022-06-13 17:16:00 +0900 | [diff] [blame] | 170 | } else { |
Alan Stokes | 3ba10fd | 2022-10-06 15:46:51 +0100 | [diff] [blame] | 171 | // Send context information back after a separator, to ease diagnosis. |
| 172 | // These errors occur before the payload runs, so this should not leak sensitive |
| 173 | // information. |
| 174 | Owned(format!("MICRODROID_UNKNOWN_RUNTIME_ERROR|{:?}", err)) |
Inseob Kim | 11f40d0 | 2022-06-13 17:16:00 +0900 | [diff] [blame] | 175 | }; |
| 176 | |
| 177 | let death_reason_bytes = death_reason.as_bytes(); |
| 178 | let mut sent_total = 0; |
| 179 | while sent_total < death_reason_bytes.len() { |
| 180 | // TODO(b/220071963): Sometimes, sending more than 16 bytes at once makes MM hang. |
| 181 | let begin = sent_total; |
| 182 | let end = std::cmp::min(begin.saturating_add(16), death_reason_bytes.len()); |
| 183 | OpenOptions::new() |
| 184 | .read(false) |
| 185 | .write(true) |
| 186 | .open(FAILURE_SERIAL_DEVICE)? |
| 187 | .write_all(&death_reason_bytes[begin..end])?; |
| 188 | sent_total = end; |
| 189 | } |
| 190 | |
| 191 | Ok(()) |
| 192 | } |
| 193 | |
Inseob Kim | 1b95f2e | 2021-08-19 13:17:40 +0900 | [diff] [blame] | 194 | fn get_vms_rpc_binder() -> Result<Strong<dyn IVirtualMachineService>> { |
Andrew Walbran | 7eb5ca4 | 2022-08-08 15:33:34 +0000 | [diff] [blame] | 195 | get_vsock_rpc_interface(VMADDR_CID_HOST, VM_BINDER_SERVICE_PORT as u32) |
Andrew Walbran | c4ce787 | 2022-07-29 11:26:41 +0000 | [diff] [blame] | 196 | .context("Cannot connect to RPC service") |
Inseob Kim | 1b95f2e | 2021-08-19 13:17:40 +0900 | [diff] [blame] | 197 | } |
| 198 | |
Inseob Kim | 437f105 | 2022-06-21 11:30:22 +0900 | [diff] [blame] | 199 | fn main() -> Result<()> { |
| 200 | scopeguard::defer! { |
| 201 | info!("Shutting down..."); |
Jooyung Han | bfe086f | 2021-10-28 10:15:45 +0900 | [diff] [blame] | 202 | if let Err(e) = system_properties::write("sys.powerctl", "shutdown") { |
| 203 | error!("failed to shutdown {:?}", e); |
| 204 | } |
Jooyung Han | 311b120 | 2021-09-14 22:00:16 +0900 | [diff] [blame] | 205 | } |
Inseob Kim | 437f105 | 2022-06-21 11:30:22 +0900 | [diff] [blame] | 206 | |
| 207 | try_main().map_err(|e| { |
| 208 | error!("Failed with {:?}.", e); |
| 209 | if let Err(e) = write_death_reason_to_serial(&e) { |
| 210 | error!("Failed to write death reason {:?}", e); |
| 211 | } |
| 212 | e |
| 213 | }) |
Jooyung Han | 311b120 | 2021-09-14 22:00:16 +0900 | [diff] [blame] | 214 | } |
| 215 | |
| 216 | fn try_main() -> Result<()> { |
Andrew Scull | e127cff | 2022-02-15 15:34:04 +0000 | [diff] [blame] | 217 | let _ = kernlog::init(); |
Jooyung Han | 347d9f2 | 2021-05-28 00:05:14 +0900 | [diff] [blame] | 218 | info!("started."); |
| 219 | |
Jiyong Park | 202856e | 2022-08-22 16:04:26 +0900 | [diff] [blame] | 220 | load_crashkernel_if_supported().context("Failed to load crashkernel")?; |
| 221 | |
Keir Fraser | 933f0ac | 2022-10-12 08:23:28 +0000 | [diff] [blame] | 222 | swap::init_swap().context("Failed to initialise swap")?; |
| 223 | info!("swap enabled."); |
| 224 | |
Inseob Kim | 11f40d0 | 2022-06-13 17:16:00 +0900 | [diff] [blame] | 225 | let service = get_vms_rpc_binder() |
| 226 | .context("cannot connect to VirtualMachineService") |
| 227 | .map_err(|e| MicrodroidError::FailedToConnectToVirtualizationService(e.to_string()))?; |
Seungjae Yoo | fd9a062 | 2022-10-14 10:01:29 +0900 | [diff] [blame] | 228 | |
| 229 | thread::spawn(move || { |
Seungjae Yoo | 2b893b9 | 2022-10-26 14:29:27 +0900 | [diff] [blame^] | 230 | if let Err(e) = send_vm_status_periodically() { |
Seungjae Yoo | fd9a062 | 2022-10-14 10:01:29 +0900 | [diff] [blame] | 231 | error!("failed to get virtual machine status: {:?}", e); |
| 232 | } |
| 233 | }); |
| 234 | |
Jooyung Han | 5c6d417 | 2021-12-06 14:17:52 +0900 | [diff] [blame] | 235 | match try_run_payload(&service) { |
| 236 | Ok(code) => { |
| 237 | info!("notifying payload finished"); |
| 238 | service.notifyPayloadFinished(code)?; |
| 239 | if code == 0 { |
| 240 | info!("task successfully finished"); |
| 241 | } else { |
| 242 | error!("task exited with exit code: {}", code); |
| 243 | } |
| 244 | Ok(()) |
| 245 | } |
| 246 | Err(err) => { |
Jooyung Han | 5c6d417 | 2021-12-06 14:17:52 +0900 | [diff] [blame] | 247 | let (error_code, message) = translate_error(&err); |
| 248 | service.notifyError(error_code, &message)?; |
| 249 | Err(err) |
| 250 | } |
Jooyung Han | dd0a173 | 2021-11-23 15:26:20 +0900 | [diff] [blame] | 251 | } |
| 252 | } |
| 253 | |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 254 | fn dice_derivation( |
Andrew Scull | d64ae7d | 2022-10-05 17:41:43 +0000 | [diff] [blame] | 255 | dice: DiceDriver, |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 256 | verified_data: &MicrodroidData, |
| 257 | payload_metadata: &PayloadMetadata, |
Andrew Scull | d64ae7d | 2022-10-05 17:41:43 +0000 | [diff] [blame] | 258 | ) -> Result<DiceContext> { |
Andrew Scull | b2f4447 | 2022-01-21 14:41:34 +0000 | [diff] [blame] | 259 | // Calculate compound digests of code and authorities |
Andrew Scull | a0d1b1a | 2022-05-24 19:32:47 +0000 | [diff] [blame] | 260 | let mut code_hash_ctx = Sha512::new(); |
| 261 | let mut authority_hash_ctx = Sha512::new(); |
Andrew Scull | b2f4447 | 2022-01-21 14:41:34 +0000 | [diff] [blame] | 262 | code_hash_ctx.update(verified_data.apk_data.root_hash.as_ref()); |
| 263 | authority_hash_ctx.update(verified_data.apk_data.pubkey.as_ref()); |
Inseob Kim | b2519c5 | 2022-04-14 02:10:09 +0900 | [diff] [blame] | 264 | for extra_apk in &verified_data.extra_apks_data { |
Andrew Scull | b2f4447 | 2022-01-21 14:41:34 +0000 | [diff] [blame] | 265 | code_hash_ctx.update(extra_apk.root_hash.as_ref()); |
| 266 | authority_hash_ctx.update(extra_apk.pubkey.as_ref()); |
| 267 | } |
Inseob Kim | b2519c5 | 2022-04-14 02:10:09 +0900 | [diff] [blame] | 268 | for apex in &verified_data.apex_data { |
Andrew Scull | b2f4447 | 2022-01-21 14:41:34 +0000 | [diff] [blame] | 269 | code_hash_ctx.update(apex.root_digest.as_ref()); |
| 270 | authority_hash_ctx.update(apex.public_key.as_ref()); |
| 271 | } |
Andrew Scull | a0d1b1a | 2022-05-24 19:32:47 +0000 | [diff] [blame] | 272 | let code_hash = code_hash_ctx.finish(); |
| 273 | let authority_hash = authority_hash_ctx.finish(); |
Andrew Scull | b2f4447 | 2022-01-21 14:41:34 +0000 | [diff] [blame] | 274 | |
| 275 | // { |
| 276 | // -70002: "Microdroid payload", |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 277 | // ? -71000: tstr // payload_config_path |
| 278 | // ? -71001: PayloadConfig |
Andrew Scull | b2f4447 | 2022-01-21 14:41:34 +0000 | [diff] [blame] | 279 | // } |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 280 | // PayloadConfig = { |
| 281 | // 1: tstr // payload_binary_path |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 282 | // } |
| 283 | |
Andrew Scull | b2f4447 | 2022-01-21 14:41:34 +0000 | [diff] [blame] | 284 | let mut config_desc = vec![ |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 285 | 0xa2, // map(2) |
| 286 | 0x3a, 0x00, 0x01, 0x11, 0x71, // -70002 |
| 287 | 0x72, 0x4d, 0x69, 0x63, 0x72, 0x6f, 0x64, 0x72, 0x6f, 0x69, 0x64, 0x20, 0x70, 0x61, 0x79, |
| 288 | 0x6c, 0x6f, 0x61, 0x64, // "Microdroid payload" |
Andrew Scull | b2f4447 | 2022-01-21 14:41:34 +0000 | [diff] [blame] | 289 | ]; |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 290 | |
| 291 | match payload_metadata { |
| 292 | PayloadMetadata::config_path(payload_config_path) => { |
| 293 | encode_negative_number(-71000, &mut config_desc)?; |
| 294 | encode_tstr(payload_config_path, &mut config_desc)?; |
| 295 | } |
| 296 | PayloadMetadata::config(payload_config) => { |
| 297 | encode_negative_number(-71001, &mut config_desc)?; |
| 298 | encode_header(5, 1, &mut config_desc)?; // map(1) |
| 299 | encode_number(1, &mut config_desc)?; |
| 300 | encode_tstr(&payload_config.payload_binary_path, &mut config_desc)?; |
| 301 | } |
| 302 | } |
Andrew Scull | b2f4447 | 2022-01-21 14:41:34 +0000 | [diff] [blame] | 303 | |
Andrew Scull | 65ddfc4 | 2022-02-14 21:03:58 +0000 | [diff] [blame] | 304 | // Check app debuggability, conervatively assuming it is debuggable |
| 305 | let app_debuggable = system_properties::read_bool(APP_DEBUGGABLE_PROP, true)?; |
| 306 | |
Andrew Scull | b2f4447 | 2022-01-21 14:41:34 +0000 | [diff] [blame] | 307 | // Send the details to diced |
Andrew Scull | d64ae7d | 2022-10-05 17:41:43 +0000 | [diff] [blame] | 308 | let hidden = verified_data.salt.clone().try_into().unwrap(); |
| 309 | dice.derive(code_hash, &config_desc, authority_hash, app_debuggable, hidden) |
Andrew Scull | b2f4447 | 2022-01-21 14:41:34 +0000 | [diff] [blame] | 310 | } |
| 311 | |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 312 | fn encode_tstr(tstr: &str, buffer: &mut Vec<u8>) -> Result<()> { |
| 313 | let bytes = tstr.as_bytes(); |
| 314 | encode_header(3, bytes.len().try_into().unwrap(), buffer)?; |
| 315 | buffer.extend_from_slice(bytes); |
| 316 | Ok(()) |
| 317 | } |
| 318 | |
| 319 | fn encode_negative_number(n: i64, buffer: &mut dyn Write) -> Result<()> { |
| 320 | ensure!(n < 0); |
| 321 | let n = -1 - n; |
| 322 | encode_header(1, n.try_into().unwrap(), buffer) |
| 323 | } |
| 324 | |
Andrew Scull | ab72ec5 | 2022-03-14 09:10:52 +0000 | [diff] [blame] | 325 | fn is_strict_boot() -> bool { |
| 326 | Path::new(AVF_STRICT_BOOT).exists() |
| 327 | } |
| 328 | |
| 329 | fn is_new_instance() -> bool { |
| 330 | Path::new(AVF_NEW_INSTANCE).exists() |
| 331 | } |
| 332 | |
Inseob Kim | e379e7d | 2022-07-22 18:55:18 +0900 | [diff] [blame] | 333 | fn is_verified_boot() -> bool { |
| 334 | !Path::new(DEBUG_MICRODROID_NO_VERIFIED_BOOT).exists() |
| 335 | } |
| 336 | |
Jooyung Han | 5c6d417 | 2021-12-06 14:17:52 +0900 | [diff] [blame] | 337 | fn try_run_payload(service: &Strong<dyn IVirtualMachineService>) -> Result<i32> { |
Jooyung Han | 311b120 | 2021-09-14 22:00:16 +0900 | [diff] [blame] | 338 | let metadata = load_metadata().context("Failed to load payload metadata")?; |
Andrew Scull | d64ae7d | 2022-10-05 17:41:43 +0000 | [diff] [blame] | 339 | let dice = DiceDriver::new(Path::new("/dev/open-dice0")).context("Failed to load DICE")?; |
Jooyung Han | 19c1d6c | 2021-08-06 14:08:16 +0900 | [diff] [blame] | 340 | |
Jooyung Han | 311b120 | 2021-09-14 22:00:16 +0900 | [diff] [blame] | 341 | let mut instance = InstanceDisk::new().context("Failed to load instance.img")?; |
Andrew Scull | d64ae7d | 2022-10-05 17:41:43 +0000 | [diff] [blame] | 342 | let saved_data = |
| 343 | instance.read_microdroid_data(&dice).context("Failed to read identity data")?; |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 344 | |
Andrew Scull | ab72ec5 | 2022-03-14 09:10:52 +0000 | [diff] [blame] | 345 | if is_strict_boot() { |
| 346 | // Provisioning must happen on the first boot and never again. |
| 347 | if is_new_instance() { |
| 348 | ensure!( |
| 349 | saved_data.is_none(), |
| 350 | MicrodroidError::InvalidConfig("Found instance data on first boot.".to_string()) |
| 351 | ); |
| 352 | } else { |
| 353 | ensure!( |
| 354 | saved_data.is_some(), |
| 355 | MicrodroidError::InvalidConfig("Instance data not found.".to_string()) |
| 356 | ); |
| 357 | }; |
| 358 | } |
| 359 | |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 360 | // Verify the payload before using it. |
Inseob Kim | 11f40d0 | 2022-06-13 17:16:00 +0900 | [diff] [blame] | 361 | let verified_data = verify_payload(&metadata, saved_data.as_ref()) |
| 362 | .context("Payload verification failed") |
| 363 | .map_err(|e| MicrodroidError::PayloadVerificationFailed(e.to_string()))?; |
Inseob Kim | e379e7d | 2022-07-22 18:55:18 +0900 | [diff] [blame] | 364 | |
| 365 | // In case identity is ignored (by debug policy), we should reuse existing payload data, even |
| 366 | // when the payload is changed. This is to keep the derived secret same as before. |
| 367 | let verified_data = if let Some(saved_data) = saved_data { |
| 368 | if !is_verified_boot() { |
| 369 | if saved_data != verified_data { |
| 370 | info!("Detected an update of the payload, but continue (regarding debug policy)") |
| 371 | } |
| 372 | } else { |
| 373 | ensure!( |
| 374 | saved_data == verified_data, |
| 375 | MicrodroidError::PayloadChanged(String::from( |
| 376 | "Detected an update of the payload which isn't supported yet." |
| 377 | )) |
| 378 | ); |
| 379 | info!("Saved data is verified."); |
| 380 | } |
| 381 | saved_data |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 382 | } else { |
Jooyung Han | 7a343f9 | 2021-09-08 22:53:11 +0900 | [diff] [blame] | 383 | info!("Saving verified data."); |
Andrew Scull | d64ae7d | 2022-10-05 17:41:43 +0000 | [diff] [blame] | 384 | instance |
| 385 | .write_microdroid_data(&verified_data, &dice) |
| 386 | .context("Failed to write identity data")?; |
Inseob Kim | e379e7d | 2022-07-22 18:55:18 +0900 | [diff] [blame] | 387 | verified_data |
| 388 | }; |
Jooyung Han | 19c1d6c | 2021-08-06 14:08:16 +0900 | [diff] [blame] | 389 | |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 390 | let payload_metadata = metadata.payload.ok_or_else(|| { |
| 391 | MicrodroidError::InvalidConfig("No payload config in metadata".to_string()) |
| 392 | })?; |
Alan Stokes | 0d1ef78 | 2022-09-27 13:46:35 +0100 | [diff] [blame] | 393 | |
Inseob Kim | b2519c5 | 2022-04-14 02:10:09 +0900 | [diff] [blame] | 394 | // To minimize the exposure to untrusted data, derive dice profile as soon as possible. |
| 395 | info!("DICE derivation for payload"); |
Andrew Scull | d64ae7d | 2022-10-05 17:41:43 +0000 | [diff] [blame] | 396 | let dice = dice_derivation(dice, &verified_data, &payload_metadata)?; |
Inseob Kim | b2519c5 | 2022-04-14 02:10:09 +0900 | [diff] [blame] | 397 | |
Jooyung Han | a6d11eb | 2021-09-10 11:48:05 +0900 | [diff] [blame] | 398 | // Before reading a file from the APK, start zipfuse |
Inseob Kim | 217038e | 2021-11-25 11:15:06 +0900 | [diff] [blame] | 399 | run_zipfuse( |
Alan Stokes | 60f8220 | 2022-10-07 16:40:07 +0100 | [diff] [blame] | 400 | MountForExec::Allowed, |
Inseob Kim | 217038e | 2021-11-25 11:15:06 +0900 | [diff] [blame] | 401 | "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:system_file:s0", |
| 402 | Path::new("/dev/block/mapper/microdroid-apk"), |
| 403 | Path::new("/mnt/apk"), |
Alan Stokes | 60f8220 | 2022-10-07 16:40:07 +0100 | [diff] [blame] | 404 | Some(APK_MOUNT_DONE_PROP), |
Inseob Kim | 217038e | 2021-11-25 11:15:06 +0900 | [diff] [blame] | 405 | ) |
| 406 | .context("Failed to run zipfuse")?; |
Jiyong Park | 21ce2c5 | 2021-08-28 02:32:17 +0900 | [diff] [blame] | 407 | |
Andrew Scull | 4d262dc | 2022-10-21 13:14:33 +0000 | [diff] [blame] | 408 | // Restricted APIs are only allowed to be used by platform or test components. Infer this from |
| 409 | // the use of a VM config file since those can only be used by platform and test components. |
| 410 | let allow_restricted_apis = match payload_metadata { |
| 411 | PayloadMetadata::config_path(_) => true, |
| 412 | PayloadMetadata::config(_) => false, |
| 413 | }; |
| 414 | |
Alan Stokes | 3ba10fd | 2022-10-06 15:46:51 +0100 | [diff] [blame] | 415 | let config = load_config(payload_metadata).context("Failed to load payload metadata")?; |
Shikha Panwar | 6f03c94 | 2022-04-13 20:26:50 +0000 | [diff] [blame] | 416 | |
Alan Stokes | 01b3ef0 | 2022-09-22 17:43:24 +0100 | [diff] [blame] | 417 | let task = config |
| 418 | .task |
| 419 | .as_ref() |
| 420 | .ok_or_else(|| MicrodroidError::InvalidConfig("No task in VM config".to_string()))?; |
| 421 | |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 422 | if config.extra_apks.len() != verified_data.extra_apks_data.len() { |
| 423 | return Err(anyhow!( |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 424 | "config expects {} extra apks, but found {}", |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 425 | config.extra_apks.len(), |
| 426 | verified_data.extra_apks_data.len() |
| 427 | )); |
| 428 | } |
| 429 | mount_extra_apks(&config)?; |
Jooyung Han | 634e2d7 | 2021-06-10 16:27:38 +0900 | [diff] [blame] | 430 | |
Jooyung Han | 5c6d417 | 2021-12-06 14:17:52 +0900 | [diff] [blame] | 431 | // Wait until apex config is done. (e.g. linker configuration for apexes) |
| 432 | // TODO(jooyung): wait until sys.boot_completed? |
| 433 | wait_for_apex_config_done()?; |
| 434 | |
Inseob Kim | cd9c1dd | 2022-07-13 17:13:45 +0900 | [diff] [blame] | 435 | // Start tombstone_transmit if enabled |
| 436 | if config.export_tombstones { |
Alan Stokes | 01b3ef0 | 2022-09-22 17:43:24 +0100 | [diff] [blame] | 437 | control_service("start", "tombstone_transmit")?; |
Inseob Kim | cd9c1dd | 2022-07-13 17:13:45 +0900 | [diff] [blame] | 438 | } else { |
Alan Stokes | 01b3ef0 | 2022-09-22 17:43:24 +0100 | [diff] [blame] | 439 | control_service("stop", "tombstoned")?; |
Inseob Kim | cd9c1dd | 2022-07-13 17:13:45 +0900 | [diff] [blame] | 440 | } |
| 441 | |
Alan Stokes | 01b3ef0 | 2022-09-22 17:43:24 +0100 | [diff] [blame] | 442 | // Start authfs if enabled |
| 443 | if config.enable_authfs { |
| 444 | control_service("start", "authfs_service")?; |
| 445 | } |
| 446 | |
Alan Stokes | 60f8220 | 2022-10-07 16:40:07 +0100 | [diff] [blame] | 447 | // Wait until zipfuse has mounted the APK so we can access the payload |
| 448 | wait_for_property_true(APK_MOUNT_DONE_PROP).context("Failed waiting for APK mount done")?; |
| 449 | |
Andrew Scull | 4d262dc | 2022-10-21 13:14:33 +0000 | [diff] [blame] | 450 | register_vm_payload_service(allow_restricted_apis, service.clone(), dice)?; |
Alice Wang | 59a9e56 | 2022-10-04 15:24:10 +0000 | [diff] [blame] | 451 | ProcessState::start_thread_pool(); |
Alan Stokes | 3ba10fd | 2022-10-06 15:46:51 +0100 | [diff] [blame] | 452 | |
| 453 | system_properties::write("dev.bootcomplete", "1").context("set dev.bootcomplete")?; |
Seungjae Yoo | 2b893b9 | 2022-10-26 14:29:27 +0900 | [diff] [blame^] | 454 | send_vm_status(service)?; |
Alan Stokes | 3ba10fd | 2022-10-06 15:46:51 +0100 | [diff] [blame] | 455 | |
| 456 | exec_task(task, service).context("Failed to run payload") |
Alan Stokes | 01b3ef0 | 2022-09-22 17:43:24 +0100 | [diff] [blame] | 457 | } |
| 458 | |
| 459 | fn control_service(action: &str, service: &str) -> Result<()> { |
| 460 | system_properties::write(&format!("ctl.{}", action), service) |
| 461 | .with_context(|| format!("Failed to {} {}", action, service)) |
Jooyung Han | 347d9f2 | 2021-05-28 00:05:14 +0900 | [diff] [blame] | 462 | } |
| 463 | |
Inseob Kim | 217038e | 2021-11-25 11:15:06 +0900 | [diff] [blame] | 464 | struct ApkDmverityArgument<'a> { |
| 465 | apk: &'a str, |
| 466 | idsig: &'a str, |
| 467 | name: &'a str, |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 468 | saved_root_hash: Option<&'a RootHash>, |
Inseob Kim | 217038e | 2021-11-25 11:15:06 +0900 | [diff] [blame] | 469 | } |
| 470 | |
| 471 | fn run_apkdmverity(args: &[ApkDmverityArgument]) -> Result<Child> { |
| 472 | let mut cmd = Command::new(APKDMVERITY_BIN); |
| 473 | |
| 474 | cmd.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null()); |
| 475 | |
| 476 | for argument in args { |
| 477 | cmd.arg("--apk").arg(argument.apk).arg(argument.idsig).arg(argument.name); |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 478 | if let Some(root_hash) = argument.saved_root_hash { |
| 479 | cmd.arg(&to_hex_string(root_hash)); |
| 480 | } else { |
| 481 | cmd.arg("none"); |
| 482 | } |
Inseob Kim | 217038e | 2021-11-25 11:15:06 +0900 | [diff] [blame] | 483 | } |
| 484 | |
| 485 | cmd.spawn().context("Spawn apkdmverity") |
| 486 | } |
| 487 | |
Alan Stokes | 60f8220 | 2022-10-07 16:40:07 +0100 | [diff] [blame] | 488 | enum MountForExec { |
| 489 | Allowed, |
| 490 | Disallowed, |
| 491 | } |
| 492 | |
| 493 | fn run_zipfuse( |
| 494 | noexec: MountForExec, |
| 495 | option: &str, |
| 496 | zip_path: &Path, |
| 497 | mount_dir: &Path, |
| 498 | ready_prop: Option<&str>, |
| 499 | ) -> Result<Child> { |
Andrew Scull | cc339a1 | 2022-07-04 12:44:19 +0000 | [diff] [blame] | 500 | let mut cmd = Command::new(ZIPFUSE_BIN); |
Alan Stokes | 60f8220 | 2022-10-07 16:40:07 +0100 | [diff] [blame] | 501 | if let MountForExec::Disallowed = noexec { |
Andrew Scull | cc339a1 | 2022-07-04 12:44:19 +0000 | [diff] [blame] | 502 | cmd.arg("--noexec"); |
| 503 | } |
Alan Stokes | 60f8220 | 2022-10-07 16:40:07 +0100 | [diff] [blame] | 504 | if let Some(property_name) = ready_prop { |
| 505 | cmd.args(["-p", property_name]); |
| 506 | } |
Andrew Scull | cc339a1 | 2022-07-04 12:44:19 +0000 | [diff] [blame] | 507 | cmd.arg("-o") |
Inseob Kim | 217038e | 2021-11-25 11:15:06 +0900 | [diff] [blame] | 508 | .arg(option) |
| 509 | .arg(zip_path) |
| 510 | .arg(mount_dir) |
| 511 | .stdin(Stdio::null()) |
| 512 | .stdout(Stdio::null()) |
| 513 | .stderr(Stdio::null()) |
| 514 | .spawn() |
| 515 | .context("Spawn zipfuse") |
| 516 | } |
| 517 | |
Inseob Kim | e379e7d | 2022-07-22 18:55:18 +0900 | [diff] [blame] | 518 | fn write_apex_payload_data( |
| 519 | saved_data: Option<&MicrodroidData>, |
| 520 | apex_data_from_payload: &[ApexData], |
| 521 | ) -> Result<()> { |
| 522 | if let Some(saved_apex_data) = saved_data.map(|d| &d.apex_data) { |
| 523 | // We don't support APEX updates. (assuming that update will change root digest) |
| 524 | ensure!( |
| 525 | saved_apex_data == apex_data_from_payload, |
| 526 | MicrodroidError::PayloadChanged(String::from("APEXes have changed.")) |
| 527 | ); |
| 528 | let apex_metadata = to_metadata(apex_data_from_payload); |
| 529 | // Pass metadata(with public keys and root digests) to apexd so that it uses the passed |
| 530 | // metadata instead of the default one (/dev/block/by-name/payload-metadata) |
| 531 | OpenOptions::new() |
| 532 | .create_new(true) |
| 533 | .write(true) |
| 534 | .open("/apex/vm-payload-metadata") |
| 535 | .context("Failed to open /apex/vm-payload-metadata") |
| 536 | .and_then(|f| write_metadata(&apex_metadata, f))?; |
| 537 | } |
| 538 | Ok(()) |
| 539 | } |
| 540 | |
Jooyung Han | 7a343f9 | 2021-09-08 22:53:11 +0900 | [diff] [blame] | 541 | // Verify payload before executing it. For APK payload, Full verification (which is slow) is done |
| 542 | // when the root_hash values from the idsig file and the instance disk are different. This function |
| 543 | // returns the verified root hash (for APK payload) and pubkeys (for APEX payloads) that can be |
| 544 | // saved to the instance disk. |
| 545 | fn verify_payload( |
| 546 | metadata: &Metadata, |
| 547 | saved_data: Option<&MicrodroidData>, |
| 548 | ) -> Result<MicrodroidData> { |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 549 | let start_time = SystemTime::now(); |
| 550 | |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 551 | // Verify main APK |
Jooyung Han | 7a343f9 | 2021-09-08 22:53:11 +0900 | [diff] [blame] | 552 | let root_hash = saved_data.map(|d| &d.apk_data.root_hash); |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 553 | let root_hash_from_idsig = get_apk_root_hash_from_idsig(MAIN_APK_IDSIG_PATH)?; |
Jiyong Park | f7dea25 | 2021-09-08 01:42:54 +0900 | [diff] [blame] | 554 | let root_hash_trustful = root_hash == Some(&root_hash_from_idsig); |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 555 | |
Jiyong Park | f7dea25 | 2021-09-08 01:42:54 +0900 | [diff] [blame] | 556 | // If root_hash can be trusted, pass it to apkdmverity so that it uses the passed root_hash |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 557 | // instead of the value read from the idsig file. |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 558 | let main_apk_argument = { |
| 559 | ApkDmverityArgument { |
| 560 | apk: MAIN_APK_PATH, |
| 561 | idsig: MAIN_APK_IDSIG_PATH, |
| 562 | name: MAIN_APK_DEVICE_NAME, |
| 563 | saved_root_hash: if root_hash_trustful { |
| 564 | Some(root_hash_from_idsig.as_ref()) |
| 565 | } else { |
| 566 | None |
| 567 | }, |
| 568 | } |
| 569 | }; |
| 570 | let mut apkdmverity_arguments = vec![main_apk_argument]; |
| 571 | |
| 572 | // Verify extra APKs |
| 573 | // For now, we can't read the payload config, so glob APKs and idsigs. |
| 574 | // Later, we'll see if it matches with the payload config. |
| 575 | |
| 576 | // sort globbed paths to match apks (extra-apk-{idx}) and idsigs (extra-idsig-{idx}) |
| 577 | // e.g. "extra-apk-0" corresponds to "extra-idsig-0" |
| 578 | let extra_apks = |
| 579 | sorted(glob(EXTRA_APK_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>(); |
| 580 | let extra_idsigs = |
| 581 | sorted(glob(EXTRA_IDSIG_PATH_PATTERN)?.collect::<Result<Vec<_>, _>>()?).collect::<Vec<_>>(); |
| 582 | if extra_apks.len() != extra_idsigs.len() { |
| 583 | return Err(anyhow!( |
| 584 | "Extra apks/idsigs mismatch: {} apks but {} idsigs", |
| 585 | extra_apks.len(), |
| 586 | extra_idsigs.len() |
| 587 | )); |
| 588 | } |
| 589 | let extra_apks_count = extra_apks.len(); |
| 590 | |
| 591 | let (extra_apk_names, extra_root_hashes_from_idsig): (Vec<_>, Vec<_>) = extra_idsigs |
| 592 | .iter() |
| 593 | .enumerate() |
| 594 | .map(|(i, extra_idsig)| { |
| 595 | ( |
| 596 | format!("extra-apk-{}", i), |
Alice Wang | 89cff01 | 2022-09-26 10:05:16 +0000 | [diff] [blame] | 597 | get_apk_root_hash_from_idsig(extra_idsig) |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 598 | .expect("Can't find root hash from extra idsig"), |
| 599 | ) |
| 600 | }) |
| 601 | .unzip(); |
| 602 | |
| 603 | let saved_extra_root_hashes: Vec<_> = saved_data |
| 604 | .map(|d| d.extra_apks_data.iter().map(|apk_data| &apk_data.root_hash).collect()) |
| 605 | .unwrap_or_else(Vec::new); |
| 606 | let extra_root_hashes_trustful: Vec<_> = extra_root_hashes_from_idsig |
| 607 | .iter() |
| 608 | .enumerate() |
| 609 | .map(|(i, root_hash_from_idsig)| { |
| 610 | saved_extra_root_hashes.get(i).copied() == Some(root_hash_from_idsig) |
| 611 | }) |
| 612 | .collect(); |
| 613 | |
| 614 | for i in 0..extra_apks_count { |
| 615 | apkdmverity_arguments.push({ |
| 616 | ApkDmverityArgument { |
| 617 | apk: extra_apks[i].to_str().unwrap(), |
| 618 | idsig: extra_idsigs[i].to_str().unwrap(), |
| 619 | name: &extra_apk_names[i], |
| 620 | saved_root_hash: if extra_root_hashes_trustful[i] { |
| 621 | Some(&extra_root_hashes_from_idsig[i]) |
| 622 | } else { |
| 623 | None |
| 624 | }, |
| 625 | } |
| 626 | }); |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 627 | } |
| 628 | |
| 629 | // Start apkdmverity and wait for the dm-verify block |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 630 | let mut apkdmverity_child = run_apkdmverity(&apkdmverity_arguments)?; |
Jooyung Han | 7a343f9 | 2021-09-08 22:53:11 +0900 | [diff] [blame] | 631 | |
Jooyung Han | c8deb47 | 2021-09-13 13:48:25 +0900 | [diff] [blame] | 632 | // While waiting for apkdmverity to mount APK, gathers public keys and root digests from |
| 633 | // APEX payload. |
Jooyung Han | 7a343f9 | 2021-09-08 22:53:11 +0900 | [diff] [blame] | 634 | let apex_data_from_payload = get_apex_data_from_payload(metadata)?; |
Inseob Kim | e379e7d | 2022-07-22 18:55:18 +0900 | [diff] [blame] | 635 | |
| 636 | // Writing /apex/vm-payload-metadata is to verify that the payload isn't changed. |
| 637 | // Skip writing it if the debug policy ignoring identity is on |
| 638 | if is_verified_boot() { |
| 639 | write_apex_payload_data(saved_data, &apex_data_from_payload)?; |
Jooyung Han | 4a9b3bf | 2021-09-10 17:19:00 +0900 | [diff] [blame] | 640 | } |
Inseob Kim | e379e7d | 2022-07-22 18:55:18 +0900 | [diff] [blame] | 641 | |
Jooyung Han | 4a9b3bf | 2021-09-10 17:19:00 +0900 | [diff] [blame] | 642 | // Start apexd to activate APEXes |
| 643 | system_properties::write("ctl.start", "apexd-vm")?; |
Jooyung Han | 7a343f9 | 2021-09-08 22:53:11 +0900 | [diff] [blame] | 644 | |
Inseob Kim | 217038e | 2021-11-25 11:15:06 +0900 | [diff] [blame] | 645 | // TODO(inseob): add timeout |
| 646 | apkdmverity_child.wait()?; |
Jooyung Han | 19c1d6c | 2021-08-06 14:08:16 +0900 | [diff] [blame] | 647 | |
Jiyong Park | f7dea25 | 2021-09-08 01:42:54 +0900 | [diff] [blame] | 648 | // Do the full verification if the root_hash is un-trustful. This requires the full scanning of |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 649 | // the APK file and therefore can be very slow if the APK is large. Note that this step is |
Jiyong Park | f7dea25 | 2021-09-08 01:42:54 +0900 | [diff] [blame] | 650 | // taken only when the root_hash is un-trustful which can be either when this is the first boot |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 651 | // of the VM or APK was updated in the host. |
| 652 | // TODO(jooyung): consider multithreading to make this faster |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 653 | let main_apk_pubkey = get_public_key_from_apk(DM_MOUNTED_APK_PATH, root_hash_trustful)?; |
| 654 | let extra_apks_data = extra_root_hashes_from_idsig |
| 655 | .into_iter() |
| 656 | .enumerate() |
| 657 | .map(|(i, extra_root_hash)| { |
| 658 | let mount_path = format!("/dev/block/mapper/{}", &extra_apk_names[i]); |
| 659 | let apk_pubkey = get_public_key_from_apk(&mount_path, extra_root_hashes_trustful[i])?; |
| 660 | Ok(ApkData { root_hash: extra_root_hash, pubkey: apk_pubkey }) |
| 661 | }) |
| 662 | .collect::<Result<Vec<_>>>()?; |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 663 | |
| 664 | info!("payload verification successful. took {:#?}", start_time.elapsed().unwrap()); |
| 665 | |
Andrew Scull | 34916a7 | 2022-01-30 21:34:24 +0000 | [diff] [blame] | 666 | // Use the salt from a verified instance, or generate a salt for a new instance. |
| 667 | let salt = if let Some(saved_data) = saved_data { |
| 668 | saved_data.salt.clone() |
| 669 | } else { |
| 670 | let mut salt = vec![0u8; 64]; |
| 671 | salt.as_mut_slice().try_fill(&mut rand::thread_rng())?; |
| 672 | salt |
| 673 | }; |
| 674 | |
Jiyong Park | f7dea25 | 2021-09-08 01:42:54 +0900 | [diff] [blame] | 675 | // At this point, we can ensure that the root_hash from the idsig file is trusted, either by |
| 676 | // fully verifying the APK or by comparing it with the saved root_hash. |
Jooyung Han | 7a343f9 | 2021-09-08 22:53:11 +0900 | [diff] [blame] | 677 | Ok(MicrodroidData { |
Andrew Scull | 34916a7 | 2022-01-30 21:34:24 +0000 | [diff] [blame] | 678 | salt, |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 679 | apk_data: ApkData { root_hash: root_hash_from_idsig, pubkey: main_apk_pubkey }, |
| 680 | extra_apks_data, |
Jooyung Han | 7a343f9 | 2021-09-08 22:53:11 +0900 | [diff] [blame] | 681 | apex_data: apex_data_from_payload, |
| 682 | }) |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 683 | } |
| 684 | |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 685 | fn mount_extra_apks(config: &VmPayloadConfig) -> Result<()> { |
| 686 | // For now, only the number of apks is important, as the mount point and dm-verity name is fixed |
| 687 | for i in 0..config.extra_apks.len() { |
| 688 | let mount_dir = format!("/mnt/extra-apk/{}", i); |
| 689 | create_dir(Path::new(&mount_dir)).context("Failed to create mount dir for extra apks")?; |
| 690 | |
| 691 | // don't wait, just detach |
| 692 | run_zipfuse( |
Alan Stokes | 60f8220 | 2022-10-07 16:40:07 +0100 | [diff] [blame] | 693 | MountForExec::Disallowed, |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 694 | "fscontext=u:object_r:zipfusefs:s0,context=u:object_r:extra_apk_file:s0", |
| 695 | Path::new(&format!("/dev/block/mapper/extra-apk-{}", i)), |
| 696 | Path::new(&mount_dir), |
Alan Stokes | 60f8220 | 2022-10-07 16:40:07 +0100 | [diff] [blame] | 697 | None, |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 698 | ) |
| 699 | .context("Failed to zipfuse extra apks")?; |
| 700 | } |
| 701 | |
| 702 | Ok(()) |
| 703 | } |
| 704 | |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 705 | // Waits until linker config is generated |
| 706 | fn wait_for_apex_config_done() -> Result<()> { |
Alan Stokes | 60f8220 | 2022-10-07 16:40:07 +0100 | [diff] [blame] | 707 | wait_for_property_true(APEX_CONFIG_DONE_PROP).context("Failed waiting for apex config done") |
| 708 | } |
| 709 | |
| 710 | fn wait_for_property_true(property_name: &str) -> Result<()> { |
| 711 | let mut prop = PropertyWatcher::new(property_name)?; |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 712 | loop { |
| 713 | prop.wait()?; |
Alan Stokes | 60f8220 | 2022-10-07 16:40:07 +0100 | [diff] [blame] | 714 | if system_properties::read_bool(property_name, false)? { |
Jiyong Park | bb4a987 | 2021-09-06 15:59:21 +0900 | [diff] [blame] | 715 | break; |
| 716 | } |
| 717 | } |
Jooyung Han | 19c1d6c | 2021-08-06 14:08:16 +0900 | [diff] [blame] | 718 | Ok(()) |
| 719 | } |
| 720 | |
Alice Wang | 89cff01 | 2022-09-26 10:05:16 +0000 | [diff] [blame] | 721 | fn get_apk_root_hash_from_idsig<P: AsRef<Path>>(idsig_path: P) -> Result<Box<RootHash>> { |
| 722 | Ok(V4Signature::from_idsig_path(idsig_path)?.hashing_info.raw_root_hash) |
Jiyong Park | 21ce2c5 | 2021-08-28 02:32:17 +0900 | [diff] [blame] | 723 | } |
| 724 | |
Inseob Kim | 197748b | 2021-12-01 19:49:00 +0900 | [diff] [blame] | 725 | fn get_public_key_from_apk(apk: &str, root_hash_trustful: bool) -> Result<Box<[u8]>> { |
| 726 | if !root_hash_trustful { |
| 727 | verify(apk).context(MicrodroidError::PayloadVerificationFailed(format!( |
| 728 | "failed to verify {}", |
| 729 | apk |
| 730 | ))) |
| 731 | } else { |
| 732 | get_public_key_der(apk) |
| 733 | } |
| 734 | } |
| 735 | |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 736 | fn load_config(payload_metadata: PayloadMetadata) -> Result<VmPayloadConfig> { |
| 737 | match payload_metadata { |
| 738 | PayloadMetadata::config_path(path) => { |
| 739 | let path = Path::new(&path); |
| 740 | info!("loading config from {:?}...", path); |
Alan Stokes | 3ba10fd | 2022-10-06 15:46:51 +0100 | [diff] [blame] | 741 | let file = ioutil::wait_for_file(path, WAIT_TIMEOUT) |
| 742 | .with_context(|| format!("Failed to read {:?}", path))?; |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 743 | Ok(serde_json::from_reader(file)?) |
| 744 | } |
| 745 | PayloadMetadata::config(payload_config) => { |
| 746 | let task = Task { |
| 747 | type_: TaskType::MicrodroidLauncher, |
| 748 | command: payload_config.payload_binary_path, |
Alan Stokes | 1f417c9 | 2022-09-29 15:13:28 +0100 | [diff] [blame] | 749 | }; |
| 750 | Ok(VmPayloadConfig { |
| 751 | os: OsConfig { name: "microdroid".to_owned() }, |
| 752 | task: Some(task), |
| 753 | apexes: vec![], |
| 754 | extra_apks: vec![], |
| 755 | prefer_staged: false, |
| 756 | export_tombstones: false, |
| 757 | enable_authfs: false, |
| 758 | }) |
| 759 | } |
| 760 | } |
Jooyung Han | 634e2d7 | 2021-06-10 16:27:38 +0900 | [diff] [blame] | 761 | } |
| 762 | |
Jiyong Park | 202856e | 2022-08-22 16:04:26 +0900 | [diff] [blame] | 763 | /// Loads the crashkernel into memory using kexec if the VM is loaded with `crashkernel=' parameter |
| 764 | /// in the cmdline. |
| 765 | fn load_crashkernel_if_supported() -> Result<()> { |
| 766 | let supported = std::fs::read_to_string("/proc/cmdline")?.contains(" crashkernel="); |
| 767 | info!("ramdump supported: {}", supported); |
| 768 | if supported { |
| 769 | let status = Command::new("/system/bin/kexec_load").status()?; |
| 770 | if !status.success() { |
| 771 | return Err(anyhow!("Failed to load crashkernel: {:?}", status)); |
| 772 | } |
| 773 | } |
| 774 | Ok(()) |
| 775 | } |
| 776 | |
Jiyong Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 777 | /// Executes the given task. Stdout of the task is piped into the vsock stream to the |
| 778 | /// virtualizationservice in the host side. |
Jooyung Han | 5c6d417 | 2021-12-06 14:17:52 +0900 | [diff] [blame] | 779 | fn exec_task(task: &Task, service: &Strong<dyn IVirtualMachineService>) -> Result<i32> { |
Jiyong Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 780 | info!("executing main task {:?}...", task); |
Inseob Kim | 86ca016 | 2021-10-20 02:21:02 +0000 | [diff] [blame] | 781 | let mut command = build_command(task)?; |
Inseob Kim | 7f61fe7 | 2021-08-20 20:50:47 +0900 | [diff] [blame] | 782 | |
| 783 | info!("notifying payload started"); |
Inseob Kim | c7d28c7 | 2021-10-25 14:28:10 +0000 | [diff] [blame] | 784 | service.notifyPayloadStarted()?; |
Inseob Kim | 7f61fe7 | 2021-08-20 20:50:47 +0900 | [diff] [blame] | 785 | |
Inseob Kim | 86ca016 | 2021-10-20 02:21:02 +0000 | [diff] [blame] | 786 | let exit_status = command.spawn()?.wait()?; |
Seungjae Yoo | 2b893b9 | 2022-10-26 14:29:27 +0900 | [diff] [blame^] | 787 | send_vm_status(service)?; |
Jooyung Han | 5c6d417 | 2021-12-06 14:17:52 +0900 | [diff] [blame] | 788 | exit_status.code().ok_or_else(|| anyhow!("Failed to get exit_code from the paylaod.")) |
Jooyung Han | 347d9f2 | 2021-05-28 00:05:14 +0900 | [diff] [blame] | 789 | } |
Jooyung Han | 634e2d7 | 2021-06-10 16:27:38 +0900 | [diff] [blame] | 790 | |
| 791 | fn build_command(task: &Task) -> Result<Command> { |
Inseob Kim | 7f61fe7 | 2021-08-20 20:50:47 +0900 | [diff] [blame] | 792 | const VMADDR_CID_HOST: u32 = 2; |
Inseob Kim | 7f61fe7 | 2021-08-20 20:50:47 +0900 | [diff] [blame] | 793 | |
| 794 | let mut command = match task.type_ { |
Alan Stokes | 52d3c72 | 2022-10-04 17:27:13 +0100 | [diff] [blame] | 795 | TaskType::Executable => Command::new(&task.command), |
Jooyung Han | 634e2d7 | 2021-06-10 16:27:38 +0900 | [diff] [blame] | 796 | TaskType::MicrodroidLauncher => { |
| 797 | let mut command = Command::new("/system/bin/microdroid_launcher"); |
Alan Stokes | 52d3c72 | 2022-10-04 17:27:13 +0100 | [diff] [blame] | 798 | command.arg(find_library_path(&task.command)?); |
Jooyung Han | 634e2d7 | 2021-06-10 16:27:38 +0900 | [diff] [blame] | 799 | command |
| 800 | } |
Inseob Kim | 7f61fe7 | 2021-08-20 20:50:47 +0900 | [diff] [blame] | 801 | }; |
| 802 | |
Inseob Kim | d058756 | 2021-09-01 21:27:32 +0900 | [diff] [blame] | 803 | match VsockStream::connect_with_cid_port(VMADDR_CID_HOST, VM_STREAM_SERVICE_PORT as u32) { |
Inseob Kim | 7f61fe7 | 2021-08-20 20:50:47 +0900 | [diff] [blame] | 804 | Ok(stream) => { |
| 805 | // SAFETY: the ownership of the underlying file descriptor is transferred from stream |
| 806 | // to the file object, and then into the Command object. When the command is finished, |
| 807 | // the file descriptor is closed. |
| 808 | let file = unsafe { File::from_raw_fd(stream.into_raw_fd()) }; |
| 809 | command |
| 810 | .stdin(Stdio::from(file.try_clone()?)) |
| 811 | .stdout(Stdio::from(file.try_clone()?)) |
| 812 | .stderr(Stdio::from(file)); |
| 813 | } |
| 814 | Err(e) => { |
| 815 | error!("failed to connect to virtualization service: {}", e); |
| 816 | // Don't fail hard here. Even if we failed to connect to the virtualizationservice, |
| 817 | // we keep executing the task. This can happen if the owner of the VM doesn't register |
| 818 | // callback to accept the stream. Use /dev/null as the stream so that the task can |
| 819 | // make progress without waiting for someone to consume the output. |
| 820 | command.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null()); |
| 821 | } |
| 822 | } |
| 823 | |
| 824 | Ok(command) |
Jooyung Han | 634e2d7 | 2021-06-10 16:27:38 +0900 | [diff] [blame] | 825 | } |
| 826 | |
| 827 | fn find_library_path(name: &str) -> Result<String> { |
| 828 | let mut watcher = PropertyWatcher::new("ro.product.cpu.abilist")?; |
| 829 | let value = watcher.read(|_name, value| Ok(value.trim().to_string()))?; |
| 830 | let abi = value.split(',').next().ok_or_else(|| anyhow!("no abilist"))?; |
| 831 | let path = format!("/mnt/apk/lib/{}/{}", abi, name); |
| 832 | |
Alan Stokes | 3ba10fd | 2022-10-06 15:46:51 +0100 | [diff] [blame] | 833 | let metadata = fs::metadata(&path).with_context(|| format!("Unable to access {}", path))?; |
Jooyung Han | 634e2d7 | 2021-06-10 16:27:38 +0900 | [diff] [blame] | 834 | if !metadata.is_file() { |
| 835 | bail!("{} is not a file", &path); |
| 836 | } |
| 837 | |
| 838 | Ok(path) |
| 839 | } |
Jiyong Park | 21ce2c5 | 2021-08-28 02:32:17 +0900 | [diff] [blame] | 840 | |
| 841 | fn to_hex_string(buf: &[u8]) -> String { |
| 842 | buf.iter().map(|b| format!("{:02X}", b)).collect() |
| 843 | } |