1 /* 2 * Copyright 2020 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 #pragma once 17 18 #include <array> 19 #include <chrono> 20 #include <cstdint> 21 #include <list> 22 #include <memory> 23 #include <mutex> 24 #include <string> 25 #include <vector> 26 27 #include "hci/address.h" 28 #include "module.h" 29 #include "storage/config_cache.h" 30 #include "storage/device.h" 31 #include "storage/mutation.h" 32 33 namespace bluetooth { 34 35 namespace shim { 36 class BtifConfigInterface; 37 } 38 39 namespace security::internal { 40 class SecurityManagerImpl; 41 } 42 43 namespace hci { 44 class AclManager; 45 } 46 47 namespace storage { 48 49 class StorageModule : public bluetooth::Module { 50 public: 51 static const std::string kInfoSection; 52 static const std::string kFileSourceProperty; 53 static const std::string kTimeCreatedProperty; 54 static const std::string kTimeCreatedFormat; 55 56 static const std::string kAdapterSection; 57 58 StorageModule(const StorageModule&) = delete; 59 StorageModule& operator=(const StorageModule&) = delete; 60 61 ~StorageModule(); 62 static const ModuleFactory Factory; 63 64 // Methods to access the storage layer via Device abstraction 65 // - Devices will be lazily created when methods below are called. Hence, no std::optional<> nor nullptr is used in 66 // the return type. User of the API can use the Device object's API to find out if the device has existed before 67 // - Devices with no config values will not be saved to config cache 68 // - Devices that are not paired will also be discarded when stack shutdown 69 70 // Concept: 71 // 72 // BR/EDR Address: 73 // -> Public static address only, begin with 3 byte IEEE assigned OUI number 74 // 75 // BLE Addresses 76 // -> Public Address: begin with IEEE assigned OUI number 77 // -> Static: static public address do not change 78 // -> Private/Variable: We haven't seen private/variable public address yet 79 // -> Random Address: randomly generated, does not begin with IEEE assigned OUI number 80 // -> Static: static random address do not change 81 // -> Private/Variable: private random address changes once so often 82 // -> Resolvable: this address can be resolved into a static address using identity resolving key (IRK) 83 // -> Non-resolvable: this address is for temporary use only, do not save this address 84 // 85 // MAC addresses are six bytes only and hence are only regionally unique 86 87 // Get a device object using the |legacy_key_address|. In legacy config, each device's config is stored in a config 88 // section keyed by a single MAC address. For BR/EDR device, this is straightforward as a BR/EDR device has only a 89 // single public static MAC address. However, for LE devices using private addresses, we only learn its real static 90 // address after pairing. Since we still need to store that device's information prior to pairing, we use the 91 // first-seen address of that device, no matter random private or static public, as a "key" to store that device's 92 // config. This method gives you a device object using this legacy key. If the key does not exist, the device will 93 // be lazily created in the config 94 Device GetDeviceByLegacyKey(hci::Address legacy_key_address); 95 96 // A classic (BR/EDR) or dual mode device can be uniquely located by its classic (BR/EDR) MAC address 97 Device GetDeviceByClassicMacAddress(hci::Address classic_address); 98 99 // A LE or dual mode device can be uniquely located by its identity address that is either: 100 // -> Public static address 101 // -> Random static address 102 // If remote device uses LE random private resolvable address, user of this API must resolve its identity address 103 // before calling this method to get the device object 104 // 105 // Note: A dual mode device's identity address is normally the same as its BR/EDR address, but they can also be 106 // different. Hence, please don't make such assumption and don't use GetDeviceByBrEdrMacAddress() interchangeably 107 Device GetDeviceByLeIdentityAddress(hci::Address le_identity_address); 108 109 // Get a list of bonded devices from config 110 std::vector<Device> GetBondedDevices(); 111 112 // Modify the underlying config by starting a mutation. All entries in the mutation will be applied atomically when 113 // Commit() is called. User should never touch ConfigCache() directly. 114 Mutation Modify(); 115 116 protected: 117 void ListDependencies(ModuleList* list) const override; 118 void Start() override; 119 void Stop() override; 120 std::string ToString() const override; 121 122 friend shim::BtifConfigInterface; 123 friend hci::AclManager; 124 friend security::internal::SecurityManagerImpl; 125 // For unit test only 126 ConfigCache* GetMemoryOnlyConfigCache(); 127 // Normally, underlying config will be saved at most 3 seconds after the first config change in a series of changes 128 // This method triggers the delayed saving automatically, the delay is equal to |config_save_delay_| 129 void SaveDelayed(); 130 // In some cases, one may want to save the config immediately to disk. Call this method with caution as it runs 131 // immediately on the calling thread 132 void SaveImmediately(); 133 // remove all content in this config cache, restore it to the state after the explicit constructor 134 void Clear(); 135 136 // Create the storage module where: 137 // - config_file_path is the path to the config file on disk 138 // - config_save_delay is the duration after which to dump config to disk after SaveDelayed() is 139 // called 140 // - temp_devices_capacity is the number of temporary, typically unpaired devices to hold in a 141 // memory based LRU 142 // - is_restricted_mode and is_single_user_mode are flags from upper layer 143 StorageModule( 144 std::string config_file_path, 145 std::chrono::milliseconds config_save_delay, 146 size_t temp_devices_capacity, 147 bool is_restricted_mode, 148 bool is_single_user_mode); 149 150 bool HasSection(const std::string& section) const; 151 bool HasProperty(const std::string& section, const std::string& property) const; 152 153 std::optional<std::string> GetProperty( 154 const std::string& section, const std::string& property) const; 155 void SetProperty(std::string section, std::string property, std::string value); 156 157 std::vector<std::string> GetPersistentSections() const; 158 159 void RemoveSection(const std::string& section); 160 bool RemoveProperty(const std::string& section, const std::string& property); 161 void ConvertEncryptOrDecryptKeyIfNeeded(); 162 // Remove sections with |property| set 163 void RemoveSectionWithProperty(const std::string& property); 164 165 void SetBool(const std::string& section, const std::string& property, bool value); 166 std::optional<bool> GetBool(const std::string& section, const std::string& property) const; 167 void SetUint64(const std::string& section, const std::string& property, uint64_t value); 168 std::optional<uint64_t> GetUint64(const std::string& section, const std::string& property) const; 169 void SetUint32(const std::string& section, const std::string& property, uint32_t value); 170 std::optional<uint32_t> GetUint32(const std::string& section, const std::string& property) const; 171 void SetInt64(const std::string& section, const std::string& property, int64_t value); 172 std::optional<int64_t> GetInt64(const std::string& section, const std::string& property) const; 173 void SetInt(const std::string& section, const std::string& property, int value); 174 std::optional<int> GetInt(const std::string& section, const std::string& property) const; 175 void SetBin( 176 const std::string& section, const std::string& property, const std::vector<uint8_t>& value); 177 std::optional<std::vector<uint8_t>> GetBin( 178 const std::string& section, const std::string& property) const; 179 180 private: 181 struct impl; 182 mutable std::recursive_mutex mutex_; 183 std::unique_ptr<impl> pimpl_; 184 std::string config_file_path_; 185 std::string config_backup_path_; 186 std::chrono::milliseconds config_save_delay_; 187 size_t temp_devices_capacity_; 188 bool is_restricted_mode_; 189 bool is_single_user_mode_; 190 static bool is_config_checksum_pass(int check_bit); 191 }; 192 193 } // namespace storage 194 } // namespace bluetooth 195