| // Copyright 2021, The Android Open Source Project |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| //! This module implements IKeystoreMaintenance AIDL interface. |
| |
| use crate::database::{KeyEntryLoadBits, KeyType}; |
| use crate::error::map_km_error; |
| use crate::error::map_or_log_err; |
| use crate::error::Error; |
| use crate::globals::get_keymint_device; |
| use crate::globals::{DB, LEGACY_IMPORTER, SUPER_KEY}; |
| use crate::ks_err; |
| use crate::permission::{KeyPerm, KeystorePerm}; |
| use crate::super_key::{SuperKeyManager, UserState}; |
| use crate::utils::{ |
| check_get_app_uids_affected_by_sid_permissions, check_key_permission, |
| check_keystore_permission, uid_to_android_user, watchdog as wd, |
| }; |
| use android_hardware_security_keymint::aidl::android::hardware::security::keymint::{ |
| IKeyMintDevice::IKeyMintDevice, SecurityLevel::SecurityLevel, |
| }; |
| use android_security_maintenance::aidl::android::security::maintenance::IKeystoreMaintenance::{ |
| BnKeystoreMaintenance, IKeystoreMaintenance, |
| }; |
| use android_security_maintenance::binder::{ |
| BinderFeatures, Interface, Result as BinderResult, Strong, ThreadState, |
| }; |
| use android_system_keystore2::aidl::android::system::keystore2::KeyDescriptor::KeyDescriptor; |
| use android_system_keystore2::aidl::android::system::keystore2::ResponseCode::ResponseCode; |
| use anyhow::{Context, Result}; |
| use keystore2_crypto::Password; |
| |
| /// Reexport Domain for the benefit of DeleteListener |
| pub use android_system_keystore2::aidl::android::system::keystore2::Domain::Domain; |
| |
| /// The Maintenance module takes a delete listener argument which observes user and namespace |
| /// deletion events. |
| pub trait DeleteListener { |
| /// Called by the maintenance module when an app/namespace is deleted. |
| fn delete_namespace(&self, domain: Domain, namespace: i64) -> Result<()>; |
| /// Called by the maintenance module when a user is deleted. |
| fn delete_user(&self, user_id: u32) -> Result<()>; |
| } |
| |
| /// This struct is defined to implement the aforementioned AIDL interface. |
| pub struct Maintenance { |
| delete_listener: Box<dyn DeleteListener + Send + Sync + 'static>, |
| } |
| |
| impl Maintenance { |
| /// Create a new instance of Keystore Maintenance service. |
| pub fn new_native_binder( |
| delete_listener: Box<dyn DeleteListener + Send + Sync + 'static>, |
| ) -> Result<Strong<dyn IKeystoreMaintenance>> { |
| Ok(BnKeystoreMaintenance::new_binder( |
| Self { delete_listener }, |
| BinderFeatures { set_requesting_sid: true, ..BinderFeatures::default() }, |
| )) |
| } |
| |
| fn on_user_password_changed(user_id: i32, password: Option<Password>) -> Result<()> { |
| // Check permission. Function should return if this failed. Therefore having '?' at the end |
| // is very important. |
| check_keystore_permission(KeystorePerm::ChangePassword).context(ks_err!())?; |
| |
| let mut skm = SUPER_KEY.write().unwrap(); |
| |
| if let Some(pw) = password.as_ref() { |
| DB.with(|db| { |
| skm.unlock_unlocked_device_required_keys(&mut db.borrow_mut(), user_id as u32, pw) |
| }) |
| .context(ks_err!("unlock_unlocked_device_required_keys failed"))?; |
| } |
| |
| if let UserState::BeforeFirstUnlock = DB |
| .with(|db| skm.get_user_state(&mut db.borrow_mut(), &LEGACY_IMPORTER, user_id as u32)) |
| .context(ks_err!("Could not get user state while changing password!"))? |
| { |
| // Error - password can not be changed when the device is locked |
| return Err(Error::Rc(ResponseCode::LOCKED)).context(ks_err!("Device is locked.")); |
| } |
| |
| DB.with(|db| match password { |
| Some(pass) => { |
| skm.init_user(&mut db.borrow_mut(), &LEGACY_IMPORTER, user_id as u32, &pass) |
| } |
| None => { |
| // User transitioned to swipe. |
| skm.reset_user(&mut db.borrow_mut(), &LEGACY_IMPORTER, user_id as u32) |
| } |
| }) |
| .context(ks_err!("Failed to change user password!")) |
| } |
| |
| fn add_or_remove_user(&self, user_id: i32) -> Result<()> { |
| // Check permission. Function should return if this failed. Therefore having '?' at the end |
| // is very important. |
| check_keystore_permission(KeystorePerm::ChangeUser).context(ks_err!())?; |
| |
| DB.with(|db| { |
| SUPER_KEY.write().unwrap().remove_user( |
| &mut db.borrow_mut(), |
| &LEGACY_IMPORTER, |
| user_id as u32, |
| ) |
| }) |
| .context(ks_err!("Trying to delete keys from db."))?; |
| self.delete_listener |
| .delete_user(user_id as u32) |
| .context(ks_err!("While invoking the delete listener.")) |
| } |
| |
| fn init_user_super_keys( |
| &self, |
| user_id: i32, |
| password: Password, |
| allow_existing: bool, |
| ) -> Result<()> { |
| // Permission check. Must return on error. Do not touch the '?'. |
| check_keystore_permission(KeystorePerm::ChangeUser).context(ks_err!())?; |
| |
| let mut skm = SUPER_KEY.write().unwrap(); |
| DB.with(|db| { |
| skm.initialize_user( |
| &mut db.borrow_mut(), |
| &LEGACY_IMPORTER, |
| user_id as u32, |
| &password, |
| allow_existing, |
| ) |
| }) |
| .context(ks_err!("Failed to initialize user super keys")) |
| } |
| |
| // Deletes all auth-bound keys when the user's LSKF is removed. |
| fn on_user_lskf_removed(user_id: i32) -> Result<()> { |
| // Permission check. Must return on error. Do not touch the '?'. |
| check_keystore_permission(KeystorePerm::ChangePassword).context(ks_err!())?; |
| |
| LEGACY_IMPORTER |
| .bulk_delete_user(user_id as u32, true) |
| .context(ks_err!("Failed to delete legacy keys."))?; |
| |
| DB.with(|db| db.borrow_mut().unbind_auth_bound_keys_for_user(user_id as u32)) |
| .context(ks_err!("Failed to delete auth-bound keys.")) |
| } |
| |
| fn clear_namespace(&self, domain: Domain, nspace: i64) -> Result<()> { |
| // Permission check. Must return on error. Do not touch the '?'. |
| check_keystore_permission(KeystorePerm::ClearUID).context("In clear_namespace.")?; |
| |
| LEGACY_IMPORTER |
| .bulk_delete_uid(domain, nspace) |
| .context(ks_err!("Trying to delete legacy keys."))?; |
| DB.with(|db| db.borrow_mut().unbind_keys_for_namespace(domain, nspace)) |
| .context(ks_err!("Trying to delete keys from db."))?; |
| self.delete_listener |
| .delete_namespace(domain, nspace) |
| .context(ks_err!("While invoking the delete listener.")) |
| } |
| |
| fn call_with_watchdog<F>(sec_level: SecurityLevel, name: &'static str, op: &F) -> Result<()> |
| where |
| F: Fn(Strong<dyn IKeyMintDevice>) -> binder::Result<()>, |
| { |
| let (km_dev, _, _) = |
| get_keymint_device(&sec_level).context(ks_err!("getting keymint device"))?; |
| |
| let _wp = wd::watch_millis_with("In call_with_watchdog", 500, move || { |
| format!("Seclevel: {:?} Op: {}", sec_level, name) |
| }); |
| map_km_error(op(km_dev)).with_context(|| ks_err!("calling {}", name))?; |
| Ok(()) |
| } |
| |
| fn call_on_all_security_levels<F>(name: &'static str, op: F) -> Result<()> |
| where |
| F: Fn(Strong<dyn IKeyMintDevice>) -> binder::Result<()>, |
| { |
| let sec_levels = [ |
| (SecurityLevel::TRUSTED_ENVIRONMENT, "TRUSTED_ENVIRONMENT"), |
| (SecurityLevel::STRONGBOX, "STRONGBOX"), |
| ]; |
| sec_levels.iter().try_fold((), |_result, (sec_level, sec_level_string)| { |
| let curr_result = Maintenance::call_with_watchdog(*sec_level, name, &op); |
| match curr_result { |
| Ok(()) => log::info!( |
| "Call to {} succeeded for security level {}.", |
| name, |
| &sec_level_string |
| ), |
| Err(ref e) => log::error!( |
| "Call to {} failed for security level {}: {}.", |
| name, |
| &sec_level_string, |
| e |
| ), |
| } |
| curr_result |
| }) |
| } |
| |
| fn early_boot_ended() -> Result<()> { |
| check_keystore_permission(KeystorePerm::EarlyBootEnded) |
| .context(ks_err!("Checking permission"))?; |
| log::info!("In early_boot_ended."); |
| |
| if let Err(e) = |
| DB.with(|db| SuperKeyManager::set_up_boot_level_cache(&SUPER_KEY, &mut db.borrow_mut())) |
| { |
| log::error!("SUPER_KEY.set_up_boot_level_cache failed:\n{:?}\n:(", e); |
| } |
| Maintenance::call_on_all_security_levels("earlyBootEnded", |dev| dev.earlyBootEnded()) |
| } |
| |
| fn migrate_key_namespace(source: &KeyDescriptor, destination: &KeyDescriptor) -> Result<()> { |
| let calling_uid = ThreadState::get_calling_uid(); |
| |
| match source.domain { |
| Domain::SELINUX | Domain::KEY_ID | Domain::APP => (), |
| _ => { |
| return Err(Error::Rc(ResponseCode::INVALID_ARGUMENT)) |
| .context(ks_err!("Source domain must be one of APP, SELINUX, or KEY_ID.")); |
| } |
| }; |
| |
| match destination.domain { |
| Domain::SELINUX | Domain::APP => (), |
| _ => { |
| return Err(Error::Rc(ResponseCode::INVALID_ARGUMENT)) |
| .context(ks_err!("Destination domain must be one of APP or SELINUX.")); |
| } |
| }; |
| |
| let user_id = uid_to_android_user(calling_uid); |
| |
| let super_key = SUPER_KEY.read().unwrap().get_after_first_unlock_key_by_user_id(user_id); |
| |
| DB.with(|db| { |
| let (key_id_guard, _) = LEGACY_IMPORTER |
| .with_try_import(source, calling_uid, super_key, || { |
| db.borrow_mut().load_key_entry( |
| source, |
| KeyType::Client, |
| KeyEntryLoadBits::NONE, |
| calling_uid, |
| |k, av| { |
| check_key_permission(KeyPerm::Use, k, &av)?; |
| check_key_permission(KeyPerm::Delete, k, &av)?; |
| check_key_permission(KeyPerm::Grant, k, &av) |
| }, |
| ) |
| }) |
| .context(ks_err!("Failed to load key blob."))?; |
| { |
| db.borrow_mut().migrate_key_namespace(key_id_guard, destination, calling_uid, |k| { |
| check_key_permission(KeyPerm::Rebind, k, &None) |
| }) |
| } |
| }) |
| } |
| |
| fn delete_all_keys() -> Result<()> { |
| // Security critical permission check. This statement must return on fail. |
| check_keystore_permission(KeystorePerm::DeleteAllKeys) |
| .context(ks_err!("Checking permission"))?; |
| log::info!("In delete_all_keys."); |
| |
| Maintenance::call_on_all_security_levels("deleteAllKeys", |dev| dev.deleteAllKeys()) |
| } |
| |
| fn get_app_uids_affected_by_sid( |
| user_id: i32, |
| secure_user_id: i64, |
| ) -> Result<std::vec::Vec<i64>> { |
| // This method is intended to be called by Settings and discloses a list of apps |
| // associated with a user, so it requires the "android.permission.MANAGE_USERS" |
| // permission (to avoid leaking list of apps to unauthorized callers). |
| check_get_app_uids_affected_by_sid_permissions().context(ks_err!())?; |
| DB.with(|db| db.borrow_mut().get_app_uids_affected_by_sid(user_id, secure_user_id)) |
| .context(ks_err!("Failed to get app UIDs affected by SID")) |
| } |
| } |
| |
| impl Interface for Maintenance {} |
| |
| impl IKeystoreMaintenance for Maintenance { |
| fn onUserPasswordChanged(&self, user_id: i32, password: Option<&[u8]>) -> BinderResult<()> { |
| log::info!( |
| "onUserPasswordChanged(user={}, password.is_some()={})", |
| user_id, |
| password.is_some() |
| ); |
| let _wp = wd::watch("IKeystoreMaintenance::onUserPasswordChanged"); |
| map_or_log_err(Self::on_user_password_changed(user_id, password.map(|pw| pw.into())), Ok) |
| } |
| |
| fn onUserAdded(&self, user_id: i32) -> BinderResult<()> { |
| log::info!("onUserAdded(user={user_id})"); |
| let _wp = wd::watch("IKeystoreMaintenance::onUserAdded"); |
| map_or_log_err(self.add_or_remove_user(user_id), Ok) |
| } |
| |
| fn initUserSuperKeys( |
| &self, |
| user_id: i32, |
| password: &[u8], |
| allow_existing: bool, |
| ) -> BinderResult<()> { |
| log::info!("initUserSuperKeys(user={user_id}, allow_existing={allow_existing})"); |
| let _wp = wd::watch("IKeystoreMaintenance::initUserSuperKeys"); |
| map_or_log_err(self.init_user_super_keys(user_id, password.into(), allow_existing), Ok) |
| } |
| |
| fn onUserRemoved(&self, user_id: i32) -> BinderResult<()> { |
| log::info!("onUserRemoved(user={user_id})"); |
| let _wp = wd::watch("IKeystoreMaintenance::onUserRemoved"); |
| map_or_log_err(self.add_or_remove_user(user_id), Ok) |
| } |
| |
| fn onUserLskfRemoved(&self, user_id: i32) -> BinderResult<()> { |
| log::info!("onUserLskfRemoved(user={user_id})"); |
| let _wp = wd::watch("IKeystoreMaintenance::onUserLskfRemoved"); |
| map_or_log_err(Self::on_user_lskf_removed(user_id), Ok) |
| } |
| |
| fn clearNamespace(&self, domain: Domain, nspace: i64) -> BinderResult<()> { |
| log::info!("clearNamespace({domain:?}, nspace={nspace})"); |
| let _wp = wd::watch("IKeystoreMaintenance::clearNamespace"); |
| map_or_log_err(self.clear_namespace(domain, nspace), Ok) |
| } |
| |
| fn earlyBootEnded(&self) -> BinderResult<()> { |
| log::info!("earlyBootEnded()"); |
| let _wp = wd::watch("IKeystoreMaintenance::earlyBootEnded"); |
| map_or_log_err(Self::early_boot_ended(), Ok) |
| } |
| |
| fn migrateKeyNamespace( |
| &self, |
| source: &KeyDescriptor, |
| destination: &KeyDescriptor, |
| ) -> BinderResult<()> { |
| log::info!("migrateKeyNamespace(src={source:?}, dest={destination:?})"); |
| let _wp = wd::watch("IKeystoreMaintenance::migrateKeyNamespace"); |
| map_or_log_err(Self::migrate_key_namespace(source, destination), Ok) |
| } |
| |
| fn deleteAllKeys(&self) -> BinderResult<()> { |
| log::warn!("deleteAllKeys()"); |
| let _wp = wd::watch("IKeystoreMaintenance::deleteAllKeys"); |
| map_or_log_err(Self::delete_all_keys(), Ok) |
| } |
| |
| fn getAppUidsAffectedBySid( |
| &self, |
| user_id: i32, |
| secure_user_id: i64, |
| ) -> BinderResult<std::vec::Vec<i64>> { |
| log::info!("getAppUidsAffectedBySid(secure_user_id={secure_user_id:?})"); |
| let _wp = wd::watch("IKeystoreMaintenance::getAppUidsAffectedBySid"); |
| map_or_log_err(Self::get_app_uids_affected_by_sid(user_id, secure_user_id), Ok) |
| } |
| } |