xref: /ohos5.0/base/security/asset/services/core_service/src/common_event/listener.rs

/*
 * Copyright (c) 2023 Huawei Device Co., Ltd.
 * 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 is used to subscribe common event and system ability.

use std::{
    ffi::CStr,
    fs::{self, DirEntry},
    slice,
    sync::Mutex,
    time::{Duration, Instant},
};

use lazy_static::lazy_static;

use asset_common::{AutoCounter, CallingInfo, OwnerType};
use asset_crypto_manager::{crypto_manager::CryptoManager, secret_key::SecretKey};
use asset_db_key_operator::DbKey;
use asset_db_operator::{
    database::Database,
    database_file_upgrade::{construct_splited_db_name, trigger_db_upgrade},
    types::{column, DbMap},
};
use asset_definition::{log_throw_error, ErrCode, Result, SyncType, Value};
use asset_file_operator::{
    ce_operator::is_db_key_cipher_file_exist,
    common::{BACKUP_SUFFIX, CE_ROOT_PATH, DB_SUFFIX, DE_ROOT_PATH},
    de_operator::delete_user_de_dir,
};
use asset_log::{loge, logi, logw};
use asset_plugin::asset_plugin::AssetPlugin;
use asset_sdk::plugin_interface::{
    EventType, ExtDbMap, PARAM_NAME_APP_INDEX, PARAM_NAME_BUNDLE_NAME, PARAM_NAME_IS_HAP, PARAM_NAME_USER_ID,
};

use crate::sys_event::upload_fault_system_event;

/// success code.
const SUCCESS: i32 = 0;
const USER_ID_VEC_BUFFER: u32 = 5;
const MINIMUM_MAIN_USER_ID: i32 = 100;

fn remove_db(file_path: &str, calling_info: &CallingInfo, is_ce: bool) -> Result<()> {
    let db_name = construct_splited_db_name(calling_info.owner_type_enum(), calling_info.owner_info(), is_ce)?;
    for db_path in fs::read_dir(file_path)? {
        let db_path = db_path?;
        let db_file_name = db_path.file_name().to_string_lossy().to_string();
        let origin_db_name = format!("{}{}", db_name, DB_SUFFIX);
        let backup_db_name = format!("{}{}", origin_db_name, BACKUP_SUFFIX);
        if db_file_name == origin_db_name || db_file_name == backup_db_name {
            match fs::remove_file(&db_path.path().to_string_lossy().to_string()) {
                Ok(_) => (),
                Err(e) => {
                    logw!("[WARNING]Remove db:[{}] failed, error code:[{}]", db_file_name, e);
                },
            }
        }
    }
    Ok(())
}

fn delete_in_de_db_on_package_removed(
    calling_info: &CallingInfo,
    delete_cond: &DbMap,
    reverse_condition: &DbMap,
    check_cond: &DbMap,
) -> Result<bool> {
    // Delete non-persistent data in de db.
    let mut de_db =
        Database::build(calling_info.user_id(), calling_info.owner_type_enum(), calling_info.owner_info(), false)?;
    let _ = de_db.delete_datas(delete_cond, Some(reverse_condition), false)?;
    let de_db_data_exists = de_db.is_data_exists(check_cond, false)?;
    // remove db and backup db
    if !de_db_data_exists {
        remove_db(&format!("{}/{}", DE_ROOT_PATH, calling_info.user_id()), calling_info, false)?;
    }
    Ok(de_db_data_exists)
}

fn delete_in_ce_db_on_package_removed(
    calling_info: &CallingInfo,
    delete_cond: &DbMap,
    reverse_condition: &DbMap,
    check_cond: &DbMap,
) -> Result<bool> {
    // Delete non-persistent data in ce db if ce db file exists.
    let mut ce_db =
        Database::build(calling_info.user_id(), calling_info.owner_type_enum(), calling_info.owner_info(), true)?;
    let _ = ce_db.delete_datas(delete_cond, Some(reverse_condition), false)?;
    // Check whether there is still persistent data left in ce db.
    let ce_db_data_exists = ce_db.is_data_exists(check_cond, false)?;
    if !ce_db_data_exists {
        remove_db(&format!("{}/{}/asset_service", CE_ROOT_PATH, calling_info.user_id()), calling_info, false)?;
    }
    Ok(ce_db_data_exists)
}

fn delete_on_package_removed(owner: Vec<u8>, calling_info: &CallingInfo) -> Result<bool> {
    let mut delete_cond = DbMap::new();
    delete_cond.insert(column::OWNER_TYPE, Value::Number(OwnerType::Hap as u32));
    delete_cond.insert(column::OWNER, Value::Bytes(owner.clone()));
    delete_cond.insert(column::IS_PERSISTENT, Value::Bool(false));
    let mut reverse_condition = DbMap::new();
    reverse_condition.insert(column::SYNC_TYPE, Value::Number(SyncType::TrustedAccount as u32));
    let check_cond = DbMap::new();
    let de_db_data_exists =
        delete_in_de_db_on_package_removed(calling_info, &delete_cond, &reverse_condition, &check_cond)?;

    if is_db_key_cipher_file_exist(calling_info.user_id())? {
        let ce_db_data_exists =
            delete_in_ce_db_on_package_removed(calling_info, &delete_cond, &reverse_condition, &check_cond)?;
        Ok(de_db_data_exists || ce_db_data_exists)
    } else {
        Ok(de_db_data_exists)
    }
}

fn clear_cryptos(calling_info: &CallingInfo) {
    let crypto_manager = CryptoManager::get_instance();
    crypto_manager.lock().unwrap().remove_by_calling_info(calling_info);
}

fn delete_data_by_owner(user_id: i32, owner: *const u8, owner_size: u32) {
    let _counter_user = AutoCounter::new();
    let start_time = Instant::now();
    let owner: Vec<u8> = unsafe { slice::from_raw_parts(owner, owner_size as usize).to_vec() };
    let calling_info = CallingInfo::new(user_id, OwnerType::Hap, owner.clone());
    clear_cryptos(&calling_info);
    let res = match delete_on_package_removed(owner, &calling_info) {
        Ok(true) => {
            logi!("The owner wants to retain data after uninstallation. Do not delete key in HUKS!");
            Ok(())
        },
        Ok(false) => SecretKey::delete_by_owner(&calling_info),
        Err(e) => {
            // Report the database operation fault event.
            upload_fault_system_event(&calling_info, start_time, "on_package_removed", &e);
            Ok(())
        },
    };
    if let Err(e) = res {
        // Report the key operation fault event.
        let calling_info = CallingInfo::new_self();
        upload_fault_system_event(&calling_info, start_time, "on_package_removed", &e);
    }
}

pub(crate) extern "C" fn on_package_removed(
    user_id: i32,
    owner: *const u8,
    owner_size: u32,
    bundle_name: *const u8,
    app_index: i32,
) {
    delete_data_by_owner(user_id, owner, owner_size);

    let c_str = unsafe { CStr::from_ptr(bundle_name as _) };
    let bundle_name = match c_str.to_str() {
        Ok(s) => s.to_string(),
        Err(e) => {
            loge!("[FATAL]Parse sting from bundle name failed, error is {}.", e);
            return;
        },
    };

    logi!("[INFO]On app -{}-{}-{}- removed.", user_id, bundle_name, app_index);

    if let Ok(load) = AssetPlugin::get_instance().load_plugin() {
        let mut params = ExtDbMap::new();
        params.insert(PARAM_NAME_USER_ID, Value::Number(user_id as u32));
        params.insert(PARAM_NAME_BUNDLE_NAME, Value::Bytes(bundle_name.as_bytes().to_vec()));

        // only hap package can be removed
        params.insert(PARAM_NAME_IS_HAP, Value::Bool(true));
        params.insert(PARAM_NAME_APP_INDEX, Value::Number(app_index as u32));
        match load.process_event(EventType::OnPackageClear, &params) {
            Ok(()) => logi!("process package remove event success."),
            Err(code) => loge!("process package remove event failed, code: {}", code),
        }
    }
}

extern "C" fn on_user_removed(user_id: i32) {
    let _counter_user = AutoCounter::new();
    let _ = delete_user_de_dir(user_id);
    notify_on_user_removed(user_id);
}

extern "C" fn delete_crypto_need_unlock() {
    let _counter_user = AutoCounter::new();
    let crypto_manager = CryptoManager::get_instance();
    crypto_manager.lock().unwrap().remove_need_device_unlocked();
}

lazy_static! {
    static ref RECORD_TIME: Mutex<Option<Instant>> = Mutex::new(None);
}

async fn backup_db_sync() {
    let _counter_user = AutoCounter::new();
    let cur_time = Instant::now();
    logi!("[INFO]Start backup db.");

    let mut record_time = RECORD_TIME.lock().expect("Failed to lock RECORD_TIME");

    let should_backup = match *record_time {
        Some(ref last_time) => cur_time.duration_since(*last_time) > Duration::new(3600, 0),
        None => true,
    };

    if should_backup {
        *record_time = Some(cur_time);
        if let Err(e) = backup_all_db(&cur_time) {
            let calling_info = CallingInfo::new_self();
            upload_fault_system_event(&calling_info, cur_time, "backup_db", &e);
        }
    }
    logi!("[INFO]Finish backup db.");
}

pub(crate) extern "C" fn backup_db() {
    let _handle = ylong_runtime::spawn(backup_db_sync());
}

pub(crate) extern "C" fn on_app_restore(user_id: i32, bundle_name: *const u8, app_index: i32) {
    let c_str = unsafe { CStr::from_ptr(bundle_name as _) };
    let bundle_name = match c_str.to_str() {
        Ok(s) => s.to_string(),
        Err(e) => {
            loge!("[FATAL]Parse sting from bundle name failed, error is {}.", e);
            return;
        },
    };
    logi!("[INFO]On app -{}-{}- restore.", user_id, bundle_name);

    if let Ok(load) = AssetPlugin::get_instance().load_plugin() {
        let mut params = ExtDbMap::new();
        params.insert(PARAM_NAME_USER_ID, Value::Number(user_id as u32));
        params.insert(PARAM_NAME_BUNDLE_NAME, Value::Bytes(bundle_name.as_bytes().to_vec()));
        params.insert(PARAM_NAME_APP_INDEX, Value::Number(app_index as u32));
        match load.process_event(EventType::OnAppRestore, &params) {
            Ok(()) => logi!("process app restore event success."),
            Err(code) => loge!("process app restore event failed, code: {}", code),
        }
    }
}

pub(crate) extern "C" fn on_user_unlocked(user_id: i32) {
    logi!("[INFO]On user -{}- unlocked.", user_id);

    // Trigger upgrading de db version and key alias
    match trigger_db_upgrade(user_id, false) {
        Ok(()) => logi!("upgrade de db version and key alias on user-unlocked success."),
        Err(e) => loge!("upgrade de db version and key alias on user-unlocked failed, err is: {}", e),
    }

    // Trigger upgrading ce db version and key alias
    match trigger_db_upgrade(user_id, true) {
        Ok(()) => logi!("upgrade ce db version and key alias on user-unlocked success."),
        Err(e) => loge!("upgrade ce db version and key alias on user-unlocked failed, err is: {}", e),
    }

    if let Ok(load) = AssetPlugin::get_instance().load_plugin() {
        let mut params = ExtDbMap::new();
        params.insert(PARAM_NAME_USER_ID, Value::Number(user_id as u32));
        match load.process_event(EventType::OnUserUnlocked, &params) {
            Ok(()) => logi!("process user unlocked event success."),
            Err(code) => loge!("process user unlocked event failed, code: {}", code),
        }
    }
}

pub(crate) fn notify_on_user_removed(user_id: i32) {
    logi!("[INFO]On user remove [{}].", user_id);

    if let Ok(load) = AssetPlugin::get_instance().load_plugin() {
        let mut params = ExtDbMap::new();
        params.insert(PARAM_NAME_USER_ID, Value::Number(user_id as u32));
        match load.process_event(EventType::OnUserRemoved, &params) {
            Ok(()) => logi!("process user removed event success."),
            Err(code) => loge!("process user removed event failed, code: {}", code),
        }
    }
}

pub(crate) extern "C" fn on_schedule_wakeup() {
    logi!("[INFO]On SA wakes up at a scheduled time(36H).");
    let default_user_id = 0;
    let self_bundle_name = "asset_service";

    if let Ok(load) = AssetPlugin::get_instance().load_plugin() {
        let mut params = ExtDbMap::new();
        params.insert(PARAM_NAME_USER_ID, Value::Number(default_user_id as u32));
        params.insert(PARAM_NAME_BUNDLE_NAME, Value::Bytes(self_bundle_name.as_bytes().to_vec()));
        match load.process_event(EventType::Sync, &params) {
            Ok(()) => logi!("process sync ext event success."),
            Err(code) => loge!("process sync ext event failed, code: {}", code),
        }
    }
}

fn backup_de_db_if_accessible(entry: &DirEntry, user_id: i32) -> Result<()> {
    for db_path in fs::read_dir(format!("{}", entry.path().to_string_lossy()))? {
        let db_path = db_path?;
        let db_name = db_path.file_name().to_string_lossy().to_string();
        if db_name.ends_with(DB_SUFFIX) {
            let from_path = db_path.path().to_string_lossy().to_string();
            Database::check_db_accessible(from_path.clone(), user_id, db_name.clone(), None)?;
            let backup_path = format!("{}{}", from_path, BACKUP_SUFFIX);
            fs::copy(from_path, backup_path)?;
        }
    }
    Ok(())
}

fn backup_ce_db_if_accessible(user_id: i32) -> Result<()> {
    if user_id < MINIMUM_MAIN_USER_ID {
        return Ok(());
    }
    let ce_path = format!("{}/{}/asset_service", CE_ROOT_PATH, user_id);
    for db_path in fs::read_dir(ce_path)? {
        let db_path = db_path?;
        let db_name = db_path.file_name().to_string_lossy().to_string();
        if db_name.ends_with(DB_SUFFIX) {
            let from_path = db_path.path().to_string_lossy().to_string();
            let db_key = DbKey::get_db_key(user_id)?;
            Database::check_db_accessible(from_path.clone(), user_id, db_name.clone(), Some(&db_key))?;
            let backup_path = format!("{}{}", from_path, BACKUP_SUFFIX);
            fs::copy(from_path, backup_path)?;
        }
    }

    Ok(())
}

extern "C" {
    fn GetUserIds(userIdsPtr: *mut i32, userIdsSize: *mut u32) -> i32;
    fn GetUsersSize(userIdsSize: *mut u32) -> i32;
}

fn backup_all_db(start_time: &Instant) -> Result<()> {
    // Backup all de db if accessible.
    for entry in fs::read_dir(DE_ROOT_PATH)? {
        let entry = entry?;
        if let Ok(user_id) = entry.file_name().to_string_lossy().to_string().parse::<i32>() {
            if let Err(e) = backup_de_db_if_accessible(&entry, user_id) {
                let calling_info = CallingInfo::new_self();
                upload_fault_system_event(&calling_info, *start_time, &format!("backup_de_db_{}", user_id), &e);
            }
        }
    }

    // Backup all ce db if accessible.
    let mut user_ids_size: u32 = 0;
    let user_ids_size_ptr = &mut user_ids_size;
    let mut ret: i32;
    unsafe {
        ret = GetUsersSize(user_ids_size_ptr);
    }
    if ret != SUCCESS {
        return log_throw_error!(ErrCode::AccountError, "[FATAL][SA]Get users size failed.");
    }

    let mut user_ids: Vec<i32> = vec![0i32; (*user_ids_size_ptr + USER_ID_VEC_BUFFER).try_into().unwrap()];
    let user_ids_ptr = user_ids.as_mut_ptr();
    unsafe {
        ret = GetUserIds(user_ids_ptr, user_ids_size_ptr);
    }
    if ret != SUCCESS {
        return log_throw_error!(ErrCode::AccountError, "[FATAL][SA]Get user IDs failed.");
    }

    let user_ids_slice;
    unsafe {
        user_ids_slice = slice::from_raw_parts_mut(user_ids_ptr, (*user_ids_size_ptr).try_into().unwrap());
    }
    for user_id in user_ids_slice.iter() {
        if let Err(e) = backup_ce_db_if_accessible(*user_id) {
            let calling_info = CallingInfo::new_self();
            upload_fault_system_event(&calling_info, *start_time, &format!("backup_ce_db_{}", *user_id), &e);
        }
    }

    Ok(())
}

#[derive(Clone)]
#[repr(C)]
struct EventCallBack {
    on_package_remove: extern "C" fn(i32, *const u8, u32, *const u8, i32),
    on_user_removed: extern "C" fn(i32),
    on_screen_off: extern "C" fn(),
    on_charging: extern "C" fn(),
    on_app_restore: extern "C" fn(i32, *const u8, i32),
    on_user_unlocked: extern "C" fn(i32),
}

extern "C" {
    fn SubscribeSystemEvent(eventCallBack: EventCallBack) -> bool;
    fn UnSubscribeSystemEvent() -> bool;
}

/// Subscribe to the add and remove events of system abilities.
pub(crate) fn subscribe() {
    unsafe {
        let call_back = EventCallBack {
            on_package_remove: on_package_removed,
            on_user_removed,
            on_screen_off: delete_crypto_need_unlock,
            on_charging: backup_db,
            on_app_restore,
            on_user_unlocked,
        };
        if SubscribeSystemEvent(call_back.clone()) {
            logi!("Subscribe system event success.");
        } else {
            loge!("Subscribe system event failed.")
        }
    }
}

/// Unsubscribe to the add and remove events of system abilities.
pub(crate) fn unsubscribe() {
    unsafe {
        if !UnSubscribeSystemEvent() {
            loge!("Unsubscribe system event failed.")
        }
    }
}