blob: 10d6f4633ea0ff586a7406b08cfa36831eef11be [file] [log] [blame]
Janis Danisevskisa75e2082020-10-07 16:44:26 -07001// Copyright 2020, 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//! This module holds global state of Keystore such as the thread local
16//! database connections and connections to services that Keystore needs
17//! to talk to.
18
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +000019use crate::ks_err;
Janis Danisevskis93927dd2020-12-23 12:23:08 -080020use crate::gc::Gc;
Hasini Gunasinghea020b532021-01-07 21:42:35 +000021use crate::legacy_blob::LegacyBlobLoader;
Janis Danisevskis0ffb8a82022-02-06 22:37:21 -080022use crate::legacy_importer::LegacyImporter;
Janis Danisevskisb42fc182020-12-15 08:41:27 -080023use crate::super_key::SuperKeyManager;
Janis Danisevskis2ee014b2021-05-05 14:29:08 -070024use crate::utils::watchdog as wd;
Janis Danisevskis5ed8c532021-01-11 14:19:42 -080025use crate::{async_task::AsyncTask, database::MonotonicRawTime};
Janis Danisevskisba998992020-12-29 16:08:40 -080026use crate::{
27 database::KeystoreDB,
Max Bires8e93d2b2021-01-14 13:17:59 -080028 database::Uuid,
Janis Danisevskis8c6378e2021-01-01 09:30:37 -080029 error::{map_binder_status, map_binder_status_code, Error, ErrorCode},
Janis Danisevskisba998992020-12-29 16:08:40 -080030};
David Drysdalec97eb9e2022-01-26 13:03:48 -080031use crate::km_compat::{KeyMintV1, BacklevelKeyMintWrapper};
Max Bires8e93d2b2021-01-14 13:17:59 -080032use crate::{enforcements::Enforcements, error::map_km_error};
33use android_hardware_security_keymint::aidl::android::hardware::security::keymint::{
Shaquille Johnson8d67b752023-03-31 11:17:34 +010034 IKeyMintDevice::BpKeyMintDevice, IKeyMintDevice::IKeyMintDevice,
35 KeyMintHardwareInfo::KeyMintHardwareInfo, SecurityLevel::SecurityLevel,
Max Bires8e93d2b2021-01-14 13:17:59 -080036};
Janis Danisevskis5f3a0572021-06-18 11:26:42 -070037use android_hardware_security_secureclock::aidl::android::hardware::security::secureclock::{
38 ISecureClock::ISecureClock,
39};
Stephen Crane221bbb52020-12-16 15:52:10 -080040use android_hardware_security_keymint::binder::{StatusCode, Strong};
Janis Danisevskis8c6378e2021-01-01 09:30:37 -080041use android_security_compat::aidl::android::security::compat::IKeystoreCompatService::IKeystoreCompatService;
Janis Danisevskisba998992020-12-29 16:08:40 -080042use anyhow::{Context, Result};
David Drysdale0e45a612021-02-25 17:24:36 +000043use binder::FromIBinder;
Shaquille Johnsond4443c62023-02-23 17:39:24 +000044use binder::get_declared_instances;
Janis Danisevskisb42fc182020-12-15 08:41:27 -080045use lazy_static::lazy_static;
Seth Moorea3e611a2021-05-11 10:07:45 -070046use std::sync::{Arc, Mutex, RwLock};
Janis Danisevskis93927dd2020-12-23 12:23:08 -080047use std::{cell::RefCell, sync::Once};
Janis Danisevskis3f2955c2021-02-02 21:53:35 -080048use std::{collections::HashMap, path::Path, path::PathBuf};
Janis Danisevskis93927dd2020-12-23 12:23:08 -080049
50static DB_INIT: Once = Once::new();
51
52/// Open a connection to the Keystore 2.0 database. This is called during the initialization of
53/// the thread local DB field. It should never be called directly. The first time this is called
54/// we also call KeystoreDB::cleanup_leftovers to restore the key lifecycle invariant. See the
Janis Danisevskis7e8b4622021-02-13 10:01:59 -080055/// documentation of cleanup_leftovers for more details. The function also constructs a blob
56/// garbage collector. The initializing closure constructs another database connection without
57/// a gc. Although one GC is created for each thread local database connection, this closure
58/// is run only once, as long as the ASYNC_TASK instance is the same. So only one additional
59/// database connection is created for the garbage collector worker.
Hasini Gunasinghe3ed5da72021-02-04 15:18:54 +000060pub fn create_thread_local_db() -> KeystoreDB {
Seth Moore472fcbb2021-05-12 10:07:51 -070061 let db_path = DB_PATH.read().expect("Could not get the database directory.");
62
Seth Moore472fcbb2021-05-12 10:07:51 -070063 let mut db = KeystoreDB::new(&db_path, Some(GC.clone())).expect("Failed to open database.");
64
Janis Danisevskis93927dd2020-12-23 12:23:08 -080065 DB_INIT.call_once(|| {
66 log::info!("Touching Keystore 2.0 database for this first time since boot.");
Matthew Maurerd7815ca2021-05-06 21:58:45 -070067 db.insert_last_off_body(MonotonicRawTime::now());
Janis Danisevskis93927dd2020-12-23 12:23:08 -080068 log::info!("Calling cleanup leftovers.");
69 let n = db.cleanup_leftovers().expect("Failed to cleanup database on startup.");
70 if n != 0 {
71 log::info!(
72 concat!(
73 "Cleaned up {} failed entries. ",
74 "This indicates keystore crashed during key generation."
75 ),
76 n
77 );
78 }
Janis Danisevskis93927dd2020-12-23 12:23:08 -080079 });
80 db
81}
Janis Danisevskisa75e2082020-10-07 16:44:26 -070082
83thread_local! {
84 /// Database connections are not thread safe, but connecting to the
85 /// same database multiple times is safe as long as each connection is
86 /// used by only one thread. So we store one database connection per
87 /// thread in this thread local key.
88 pub static DB: RefCell<KeystoreDB> =
Janis Danisevskis93927dd2020-12-23 12:23:08 -080089 RefCell::new(create_thread_local_db());
Janis Danisevskisa75e2082020-10-07 16:44:26 -070090}
Janis Danisevskisb42fc182020-12-15 08:41:27 -080091
Janis Danisevskis5f3a0572021-06-18 11:26:42 -070092struct DevicesMap<T: FromIBinder + ?Sized> {
93 devices_by_uuid: HashMap<Uuid, (Strong<T>, KeyMintHardwareInfo)>,
Max Bires8e93d2b2021-01-14 13:17:59 -080094 uuid_by_sec_level: HashMap<SecurityLevel, Uuid>,
95}
96
Janis Danisevskis5f3a0572021-06-18 11:26:42 -070097impl<T: FromIBinder + ?Sized> DevicesMap<T> {
Max Bires8e93d2b2021-01-14 13:17:59 -080098 fn dev_by_sec_level(
99 &self,
100 sec_level: &SecurityLevel,
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700101 ) -> Option<(Strong<T>, KeyMintHardwareInfo, Uuid)> {
Max Bires8e93d2b2021-01-14 13:17:59 -0800102 self.uuid_by_sec_level.get(sec_level).and_then(|uuid| self.dev_by_uuid(uuid))
103 }
104
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700105 fn dev_by_uuid(&self, uuid: &Uuid) -> Option<(Strong<T>, KeyMintHardwareInfo, Uuid)> {
Max Bires8e93d2b2021-01-14 13:17:59 -0800106 self.devices_by_uuid
107 .get(uuid)
108 .map(|(dev, hw_info)| ((*dev).clone(), (*hw_info).clone(), *uuid))
109 }
110
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700111 fn devices(&self) -> Vec<Strong<T>> {
112 self.devices_by_uuid.values().map(|(dev, _)| dev.clone()).collect()
David Drysdale0e45a612021-02-25 17:24:36 +0000113 }
114
Max Bires8e93d2b2021-01-14 13:17:59 -0800115 /// The requested security level and the security level of the actual implementation may
116 /// differ. So we map the requested security level to the uuid of the implementation
117 /// so that there cannot be any confusion as to which KeyMint instance is requested.
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700118 fn insert(&mut self, sec_level: SecurityLevel, dev: Strong<T>, hw_info: KeyMintHardwareInfo) {
Max Bires8e93d2b2021-01-14 13:17:59 -0800119 // For now we use the reported security level of the KM instance as UUID.
120 // TODO update this section once UUID was added to the KM hardware info.
121 let uuid: Uuid = sec_level.into();
122 self.devices_by_uuid.insert(uuid, (dev, hw_info));
123 self.uuid_by_sec_level.insert(sec_level, uuid);
124 }
125}
126
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700127impl<T: FromIBinder + ?Sized> Default for DevicesMap<T> {
128 fn default() -> Self {
129 Self {
130 devices_by_uuid: HashMap::<Uuid, (Strong<T>, KeyMintHardwareInfo)>::new(),
131 uuid_by_sec_level: Default::default(),
132 }
133 }
Max Biresb2e1d032021-02-08 21:35:05 -0800134}
135
Janis Danisevskisb42fc182020-12-15 08:41:27 -0800136lazy_static! {
Janis Danisevskis3f2955c2021-02-02 21:53:35 -0800137 /// The path where keystore stores all its keys.
Seth Moorea3e611a2021-05-11 10:07:45 -0700138 pub static ref DB_PATH: RwLock<PathBuf> = RwLock::new(
Janis Danisevskis3f2955c2021-02-02 21:53:35 -0800139 Path::new("/data/misc/keystore").to_path_buf());
Janis Danisevskisb42fc182020-12-15 08:41:27 -0800140 /// Runtime database of unwrapped super keys.
Janis Danisevskis0fd25a62022-01-04 19:53:37 -0800141 pub static ref SUPER_KEY: Arc<RwLock<SuperKeyManager>> = Default::default();
Janis Danisevskisba998992020-12-29 16:08:40 -0800142 /// Map of KeyMint devices.
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700143 static ref KEY_MINT_DEVICES: Mutex<DevicesMap<dyn IKeyMintDevice>> = Default::default();
Janis Danisevskisc3a496b2021-01-05 10:37:22 -0800144 /// Timestamp service.
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700145 static ref TIME_STAMP_DEVICE: Mutex<Option<Strong<dyn ISecureClock>>> = Default::default();
Janis Danisevskis93927dd2020-12-23 12:23:08 -0800146 /// A single on-demand worker thread that handles deferred tasks with two different
147 /// priorities.
Janis Danisevskis7e8b4622021-02-13 10:01:59 -0800148 pub static ref ASYNC_TASK: Arc<AsyncTask> = Default::default();
Janis Danisevskis5ed8c532021-01-11 14:19:42 -0800149 /// Singleton for enforcements.
Paul Crowley7c57bf12021-02-02 16:26:57 -0800150 pub static ref ENFORCEMENTS: Enforcements = Default::default();
Hasini Gunasinghea020b532021-01-07 21:42:35 +0000151 /// LegacyBlobLoader is initialized and exists globally.
152 /// The same directory used by the database is used by the LegacyBlobLoader as well.
Hasini Gunasinghe3ed5da72021-02-04 15:18:54 +0000153 pub static ref LEGACY_BLOB_LOADER: Arc<LegacyBlobLoader> = Arc::new(LegacyBlobLoader::new(
Seth Moorea3e611a2021-05-11 10:07:45 -0700154 &DB_PATH.read().expect("Could not get the database path for legacy blob loader.")));
Hasini Gunasinghe3ed5da72021-02-04 15:18:54 +0000155 /// Legacy migrator. Atomically migrates legacy blobs to the database.
Janis Danisevskis0ffb8a82022-02-06 22:37:21 -0800156 pub static ref LEGACY_IMPORTER: Arc<LegacyImporter> =
157 Arc::new(LegacyImporter::new(Arc::new(Default::default())));
Pavel Grafov94243c22021-04-21 18:03:11 +0100158 /// Background thread which handles logging via statsd and logd
159 pub static ref LOGS_HANDLER: Arc<AsyncTask> = Default::default();
Janis Danisevskis3395f862021-05-06 10:54:17 -0700160
161 static ref GC: Arc<Gc> = Arc::new(Gc::new_init_with(ASYNC_TASK.clone(), || {
162 (
163 Box::new(|uuid, blob| {
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700164 let km_dev = get_keymint_dev_by_uuid(uuid).map(|(dev, _)| dev)?;
Janis Danisevskis3395f862021-05-06 10:54:17 -0700165 let _wp = wd::watch_millis("In invalidate key closure: calling deleteKey", 500);
Chris Wailes263de9f2022-08-11 15:00:51 -0700166 map_km_error(km_dev.deleteKey(blob))
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000167 .context(ks_err!("Trying to invalidate key blob."))
Janis Danisevskis3395f862021-05-06 10:54:17 -0700168 }),
Seth Moorea3e611a2021-05-11 10:07:45 -0700169 KeystoreDB::new(&DB_PATH.read().expect("Could not get the database directory."), None)
Janis Danisevskis3395f862021-05-06 10:54:17 -0700170 .expect("Failed to open database."),
171 SUPER_KEY.clone(),
172 )
173 }));
Janis Danisevskisba998992020-12-29 16:08:40 -0800174}
175
David Drysdalec97eb9e2022-01-26 13:03:48 -0800176/// Determine the service name for a KeyMint device of the given security level
177/// which implements at least the specified version of the `IKeyMintDevice`
178/// interface.
Shaquille Johnson8d67b752023-03-31 11:17:34 +0100179fn keymint_service_name(security_level: &SecurityLevel) -> Result<Option<String>> {
180 let keymint_descriptor: &str = <BpKeyMintDevice as IKeyMintDevice>::get_descriptor();
181 let keymint_instances = get_declared_instances(keymint_descriptor).unwrap();
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800182
Max Bires8e93d2b2021-01-14 13:17:59 -0800183 let service_name = match *security_level {
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800184 SecurityLevel::TRUSTED_ENVIRONMENT => {
Joel Galensonec7872a2021-07-02 14:37:10 -0700185 if keymint_instances.iter().any(|instance| *instance == "default") {
Shaquille Johnson8d67b752023-03-31 11:17:34 +0100186 Some(format!("{}/default", keymint_descriptor))
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800187 } else {
188 None
189 }
190 }
191 SecurityLevel::STRONGBOX => {
Joel Galensonec7872a2021-07-02 14:37:10 -0700192 if keymint_instances.iter().any(|instance| *instance == "strongbox") {
Shaquille Johnson8d67b752023-03-31 11:17:34 +0100193 Some(format!("{}/strongbox", keymint_descriptor))
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800194 } else {
195 None
196 }
197 }
Janis Danisevskisba998992020-12-29 16:08:40 -0800198 _ => {
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000199 return Err(Error::Km(ErrorCode::HARDWARE_TYPE_UNAVAILABLE)).context(ks_err!(
Shaquille Johnson8d67b752023-03-31 11:17:34 +0100200 "Trying to find keymint for security level: {:?}",
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000201 security_level
David Drysdalec97eb9e2022-01-26 13:03:48 -0800202 ));
Janis Danisevskisba998992020-12-29 16:08:40 -0800203 }
204 };
205
Shaquille Johnson8d67b752023-03-31 11:17:34 +0100206 Ok(service_name)
David Drysdalec97eb9e2022-01-26 13:03:48 -0800207}
208
209/// Make a new connection to a KeyMint device of the given security level.
210/// If no native KeyMint device can be found this function also brings
211/// up the compatibility service and attempts to connect to the legacy wrapper.
212fn connect_keymint(
213 security_level: &SecurityLevel,
214) -> Result<(Strong<dyn IKeyMintDevice>, KeyMintHardwareInfo)> {
Shaquille Johnson8d67b752023-03-31 11:17:34 +0100215 // Connects to binder to get the current keymint interface and
216 // based on the security level returns a service name to connect
217 // to.
218 let service_name = keymint_service_name(security_level).context(ks_err!("Get service name"))?;
David Drysdalec97eb9e2022-01-26 13:03:48 -0800219
Shaquille Johnson8d67b752023-03-31 11:17:34 +0100220 let (keymint, hal_version) = if let Some(service_name) = service_name {
David Drysdalea6c82a92021-12-06 11:24:26 +0000221 let km: Strong<dyn IKeyMintDevice> =
Janis Danisevskisbf855c02021-06-03 13:05:29 -0700222 map_binder_status_code(binder::get_interface(&service_name))
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000223 .context(ks_err!("Trying to connect to genuine KeyMint service."))?;
David Drysdalea6c82a92021-12-06 11:24:26 +0000224 // Map the HAL version code for KeyMint to be <AIDL version> * 100, so
225 // - V1 is 100
226 // - V2 is 200
Shaquille Johnson8d67b752023-03-31 11:17:34 +0100227 // - V3 is 300
David Drysdalea6c82a92021-12-06 11:24:26 +0000228 // etc.
Shaquille Johnson8d67b752023-03-31 11:17:34 +0100229 let km_version = km.getInterfaceVersion()?;
230 (km, Some(km_version * 100))
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800231 } else {
232 // This is a no-op if it was called before.
233 keystore2_km_compat::add_keymint_device_service();
Janis Danisevskis8c6378e2021-01-01 09:30:37 -0800234
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800235 let keystore_compat_service: Strong<dyn IKeystoreCompatService> =
236 map_binder_status_code(binder::get_interface("android.security.compat"))
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000237 .context(ks_err!("Trying to connect to compat service."))?;
Janis Danisevskisbf855c02021-06-03 13:05:29 -0700238 (
239 map_binder_status(keystore_compat_service.getKeyMintDevice(*security_level))
240 .map_err(|e| match e {
241 Error::BinderTransaction(StatusCode::NAME_NOT_FOUND) => {
242 Error::Km(ErrorCode::HARDWARE_TYPE_UNAVAILABLE)
243 }
244 e => e,
245 })
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000246 .context(ks_err!("Trying to get Legacy wrapper."))?,
Janis Danisevskisbf855c02021-06-03 13:05:29 -0700247 None,
248 )
249 };
Janis Danisevskisba998992020-12-29 16:08:40 -0800250
David Drysdalec97eb9e2022-01-26 13:03:48 -0800251 // If the KeyMint device is back-level, use a wrapper that intercepts and
252 // emulates things that are not supported by the hardware.
253 let keymint = match hal_version {
Shaquille Johnson8d67b752023-03-31 11:17:34 +0100254 Some(300) => {
255 // Current KeyMint version: use as-is as v3 Keymint is current version
256 log::info!(
257 "KeyMint device is current version ({:?}) for security level: {:?}",
258 hal_version,
259 security_level
260 );
261 keymint
262 }
David Drysdalec97eb9e2022-01-26 13:03:48 -0800263 Some(200) => {
Shaquille Johnson8d67b752023-03-31 11:17:34 +0100264 // Previous KeyMint version: use as-is as we don't have any software emulation of v3-specific KeyMint features.
David Drysdalec97eb9e2022-01-26 13:03:48 -0800265 log::info!(
266 "KeyMint device is current version ({:?}) for security level: {:?}",
267 hal_version,
268 security_level
269 );
270 keymint
271 }
272 Some(100) => {
273 // KeyMint v1: perform software emulation.
274 log::info!(
275 "Add emulation wrapper around {:?} device for security level: {:?}",
276 hal_version,
277 security_level
278 );
279 BacklevelKeyMintWrapper::wrap(KeyMintV1::new(*security_level), keymint)
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000280 .context(ks_err!("Trying to create V1 compatibility wrapper."))?
David Drysdalec97eb9e2022-01-26 13:03:48 -0800281 }
282 None => {
283 // Compatibility wrapper around a KeyMaster device: this roughly
284 // behaves like KeyMint V1 (e.g. it includes AGREE_KEY support,
285 // albeit in software.)
286 log::info!(
287 "Add emulation wrapper around Keymaster device for security level: {:?}",
288 security_level
289 );
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000290 BacklevelKeyMintWrapper::wrap(KeyMintV1::new(*security_level), keymint)
291 .context(ks_err!("Trying to create km_compat V1 compatibility wrapper ."))?
David Drysdalec97eb9e2022-01-26 13:03:48 -0800292 }
293 _ => {
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000294 return Err(Error::Km(ErrorCode::HARDWARE_TYPE_UNAVAILABLE)).context(ks_err!(
295 "unexpected hal_version {:?} for security level: {:?}",
296 hal_version,
297 security_level
298 ));
David Drysdalec97eb9e2022-01-26 13:03:48 -0800299 }
300 };
301
Janis Danisevskis2ee014b2021-05-05 14:29:08 -0700302 let wp = wd::watch_millis("In connect_keymint: calling getHardwareInfo()", 500);
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000303 let mut hw_info =
304 map_km_error(keymint.getHardwareInfo()).context(ks_err!("Failed to get hardware info."))?;
Janis Danisevskis2ee014b2021-05-05 14:29:08 -0700305 drop(wp);
Max Bires8e93d2b2021-01-14 13:17:59 -0800306
Janis Danisevskisbf855c02021-06-03 13:05:29 -0700307 // The legacy wrapper sets hw_info.versionNumber to the underlying HAL version like so:
308 // 10 * <major> + <minor>, e.g., KM 3.0 = 30. So 30, 40, and 41 are the only viable values.
David Drysdalea6c82a92021-12-06 11:24:26 +0000309 //
310 // For KeyMint the returned versionNumber is implementation defined and thus completely
311 // meaningless to Keystore 2.0. So set the versionNumber field that is returned to
312 // the rest of the code to be the <AIDL version> * 100, so KeyMint V1 is 100, KeyMint V2 is 200
313 // and so on.
314 //
315 // This ensures that versionNumber value across KeyMaster and KeyMint is monotonically
316 // increasing (and so comparisons like `versionNumber >= KEY_MINT_1` are valid).
Janis Danisevskisbf855c02021-06-03 13:05:29 -0700317 if let Some(hal_version) = hal_version {
318 hw_info.versionNumber = hal_version;
319 }
320
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700321 Ok((keymint, hw_info))
Janis Danisevskisba998992020-12-29 16:08:40 -0800322}
323
324/// Get a keymint device for the given security level either from our cache or
Max Bires8e93d2b2021-01-14 13:17:59 -0800325/// by making a new connection. Returns the device, the hardware info and the uuid.
326/// TODO the latter can be removed when the uuid is part of the hardware info.
327pub fn get_keymint_device(
328 security_level: &SecurityLevel,
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700329) -> Result<(Strong<dyn IKeyMintDevice>, KeyMintHardwareInfo, Uuid)> {
Janis Danisevskisba998992020-12-29 16:08:40 -0800330 let mut devices_map = KEY_MINT_DEVICES.lock().unwrap();
Chris Wailesd5aaaef2021-07-27 16:04:33 -0700331 if let Some((dev, hw_info, uuid)) = devices_map.dev_by_sec_level(security_level) {
Max Bires8e93d2b2021-01-14 13:17:59 -0800332 Ok((dev, hw_info, uuid))
Janis Danisevskisba998992020-12-29 16:08:40 -0800333 } else {
Shaquille Johnsond4443c62023-02-23 17:39:24 +0000334 let (dev, hw_info) =
335 connect_keymint(security_level).context(ks_err!("Cannot connect to Keymint"))?;
Max Bires8e93d2b2021-01-14 13:17:59 -0800336 devices_map.insert(*security_level, dev, hw_info);
337 // Unwrap must succeed because we just inserted it.
338 Ok(devices_map.dev_by_sec_level(security_level).unwrap())
339 }
340}
341
342/// Get a keymint device for the given uuid. This will only access the cache, but will not
343/// attempt to establish a new connection. It is assumed that the cache is already populated
344/// when this is called. This is a fair assumption, because service.rs iterates through all
345/// security levels when it gets instantiated.
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700346pub fn get_keymint_dev_by_uuid(
347 uuid: &Uuid,
348) -> Result<(Strong<dyn IKeyMintDevice>, KeyMintHardwareInfo)> {
Max Bires8e93d2b2021-01-14 13:17:59 -0800349 let devices_map = KEY_MINT_DEVICES.lock().unwrap();
350 if let Some((dev, hw_info, _)) = devices_map.dev_by_uuid(uuid) {
351 Ok((dev, hw_info))
352 } else {
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000353 Err(Error::sys()).context(ks_err!("No KeyMint instance found."))
Janis Danisevskisba998992020-12-29 16:08:40 -0800354 }
Janis Danisevskisb42fc182020-12-15 08:41:27 -0800355}
Janis Danisevskisc3a496b2021-01-05 10:37:22 -0800356
David Drysdale0e45a612021-02-25 17:24:36 +0000357/// Return all known keymint devices.
358pub fn get_keymint_devices() -> Vec<Strong<dyn IKeyMintDevice>> {
359 KEY_MINT_DEVICES.lock().unwrap().devices()
360}
361
Janis Danisevskisc3a496b2021-01-05 10:37:22 -0800362static TIME_STAMP_SERVICE_NAME: &str = "android.hardware.security.secureclock.ISecureClock";
363
364/// Make a new connection to a secure clock service.
365/// If no native SecureClock device can be found brings up the compatibility service and attempts
366/// to connect to the legacy wrapper.
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700367fn connect_secureclock() -> Result<Strong<dyn ISecureClock>> {
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800368 let secureclock_instances =
Shaquille Johnsond4443c62023-02-23 17:39:24 +0000369 get_declared_instances("android.hardware.security.secureclock.ISecureClock").unwrap();
Janis Danisevskisc3a496b2021-01-05 10:37:22 -0800370
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800371 let secure_clock_available =
Joel Galensonec7872a2021-07-02 14:37:10 -0700372 secureclock_instances.iter().any(|instance| *instance == "default");
Janis Danisevskisc3a496b2021-01-05 10:37:22 -0800373
Max Bires130e51b2021-04-05 14:07:20 -0700374 let default_time_stamp_service_name = format!("{}/default", TIME_STAMP_SERVICE_NAME);
375
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800376 let secureclock = if secure_clock_available {
Max Bires130e51b2021-04-05 14:07:20 -0700377 map_binder_status_code(binder::get_interface(&default_time_stamp_service_name))
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000378 .context(ks_err!("Trying to connect to genuine secure clock service."))
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800379 } else {
380 // This is a no-op if it was called before.
381 keystore2_km_compat::add_keymint_device_service();
382
383 let keystore_compat_service: Strong<dyn IKeystoreCompatService> =
384 map_binder_status_code(binder::get_interface("android.security.compat"))
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000385 .context(ks_err!("Trying to connect to compat service."))?;
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800386
387 // Legacy secure clock services were only implemented by TEE.
388 map_binder_status(keystore_compat_service.getSecureClock())
389 .map_err(|e| match e {
390 Error::BinderTransaction(StatusCode::NAME_NOT_FOUND) => {
391 Error::Km(ErrorCode::HARDWARE_TYPE_UNAVAILABLE)
Janis Danisevskisc3a496b2021-01-05 10:37:22 -0800392 }
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800393 e => e,
394 })
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000395 .context(ks_err!("Trying to get Legacy wrapper."))
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800396 }?;
Janis Danisevskisc3a496b2021-01-05 10:37:22 -0800397
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700398 Ok(secureclock)
Janis Danisevskisc3a496b2021-01-05 10:37:22 -0800399}
400
401/// Get the timestamp service that verifies auth token timeliness towards security levels with
402/// different clocks.
Janis Danisevskis5f3a0572021-06-18 11:26:42 -0700403pub fn get_timestamp_service() -> Result<Strong<dyn ISecureClock>> {
Janis Danisevskisc3a496b2021-01-05 10:37:22 -0800404 let mut ts_device = TIME_STAMP_DEVICE.lock().unwrap();
405 if let Some(dev) = &*ts_device {
406 Ok(dev.clone())
407 } else {
Shaquille Johnson9da2e1c2022-09-19 12:39:01 +0000408 let dev = connect_secureclock().context(ks_err!())?;
Janis Danisevskisc3a496b2021-01-05 10:37:22 -0800409 *ts_device = Some(dev.clone());
410 Ok(dev)
411 }
412}
Max Biresb2e1d032021-02-08 21:35:05 -0800413
414static REMOTE_PROVISIONING_HAL_SERVICE_NAME: &str =
415 "android.hardware.security.keymint.IRemotelyProvisionedComponent";
416
Tri Voe8f04442022-12-21 08:53:56 -0800417/// Get the service name of a remotely provisioned component corresponding to given security level.
418pub fn get_remotely_provisioned_component_name(security_level: &SecurityLevel) -> Result<String> {
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800419 let remotely_prov_instances =
Shaquille Johnsond4443c62023-02-23 17:39:24 +0000420 get_declared_instances(REMOTE_PROVISIONING_HAL_SERVICE_NAME).unwrap();
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800421
Tri Voe8f04442022-12-21 08:53:56 -0800422 match *security_level {
Max Biresb2e1d032021-02-08 21:35:05 -0800423 SecurityLevel::TRUSTED_ENVIRONMENT => {
Joel Galensonec7872a2021-07-02 14:37:10 -0700424 if remotely_prov_instances.iter().any(|instance| *instance == "default") {
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800425 Some(format!("{}/default", REMOTE_PROVISIONING_HAL_SERVICE_NAME))
426 } else {
427 None
428 }
Max Biresb2e1d032021-02-08 21:35:05 -0800429 }
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800430 SecurityLevel::STRONGBOX => {
Joel Galensonec7872a2021-07-02 14:37:10 -0700431 if remotely_prov_instances.iter().any(|instance| *instance == "strongbox") {
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800432 Some(format!("{}/strongbox", REMOTE_PROVISIONING_HAL_SERVICE_NAME))
433 } else {
434 None
435 }
Max Biresb2e1d032021-02-08 21:35:05 -0800436 }
Janis Danisevskisef14e1a2021-02-23 23:16:55 -0800437 _ => None,
438 }
439 .ok_or(Error::Km(ErrorCode::HARDWARE_TYPE_UNAVAILABLE))
Tri Voe8f04442022-12-21 08:53:56 -0800440 .context(ks_err!())
441}