/****************************************************************************** * * Copyright 1999-2012 Broadcom Corporation * * 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 file contains functions for BLE address management. * ******************************************************************************/ #define LOG_TAG "ble" #include "stack/include/btm_ble_addr.h" #include #include #include #include "btm_ble_int.h" #include "btm_dev.h" #include "btm_sec_cb.h" #include "crypto_toolbox/crypto_toolbox.h" #include "hci/controller_interface.h" #include "main/shim/entry.h" #include "stack/btm/btm_int_types.h" #include "stack/include/acl_api.h" #include "stack/include/bt_octets.h" #include "stack/include/btm_ble_privacy.h" #include "types/ble_address_with_type.h" #include "types/raw_address.h" using namespace bluetooth; extern tBTM_CB btm_cb; /******************************************************************************* * Utility functions for Random address resolving ******************************************************************************/ /******************************************************************************* * * Function btm_ble_init_pseudo_addr * * Description This function is used to initialize pseudo address. * If pseudo address is not available, use dummy address * * Returns true is updated; false otherwise. * ******************************************************************************/ bool btm_ble_init_pseudo_addr(tBTM_SEC_DEV_REC* p_dev_rec, const RawAddress& new_pseudo_addr) { if (p_dev_rec->ble.pseudo_addr.IsEmpty()) { p_dev_rec->ble.pseudo_addr = new_pseudo_addr; return true; } return false; } /* Return true if given Resolvable Privae Address |rpa| matches Identity * Resolving Key |irk| */ static bool rpa_matches_irk(const RawAddress& rpa, const Octet16& irk) { /* use the 3 MSB of bd address as prand */ Octet16 rand{}; rand[0] = rpa.address[2]; rand[1] = rpa.address[1]; rand[2] = rpa.address[0]; /* generate X = E irk(R0, R1, R2) and R is random address 3 LSO */ Octet16 x = crypto_toolbox::aes_128(irk, rand); rand[0] = rpa.address[5]; rand[1] = rpa.address[4]; rand[2] = rpa.address[3]; if (memcmp(x.data(), rand.data(), 3) == 0) { // match return true; } // not a match return false; } /** This function checks if a RPA is resolvable by the device key. * Returns true is resolvable; false otherwise. */ bool btm_ble_addr_resolvable(const RawAddress& rpa, tBTM_SEC_DEV_REC* p_dev_rec) { if (!BTM_BLE_IS_RESOLVE_BDA(rpa)) { return false; } if ((p_dev_rec->device_type & BT_DEVICE_TYPE_BLE) && (p_dev_rec->sec_rec.ble_keys.key_type & BTM_LE_KEY_PID)) { if (rpa_matches_irk(rpa, p_dev_rec->sec_rec.ble_keys.irk)) { btm_ble_init_pseudo_addr(p_dev_rec, rpa); return true; } } return false; } /** This function match the random address to the appointed device record, * starting from calculating IRK. If the record index exceeds the maximum record * number, matching failed and send a callback. */ static bool btm_ble_match_random_bda(void* data, void* context) { tBTM_SEC_DEV_REC* p_dev_rec = static_cast(data); RawAddress* random_bda = static_cast(context); if (!(p_dev_rec->device_type & BT_DEVICE_TYPE_BLE) || !(p_dev_rec->sec_rec.ble_keys.key_type & BTM_LE_KEY_PID)) { // Match fails preconditions return true; } if (rpa_matches_irk(*random_bda, p_dev_rec->sec_rec.ble_keys.irk)) { // Matched return false; } // This item not a match, continue iteration return true; } /** This function is called to resolve a random address. * Returns pointer to the security record of the device whom a random address is * matched to. */ tBTM_SEC_DEV_REC* btm_ble_resolve_random_addr(const RawAddress& random_bda) { if (btm_sec_cb.sec_dev_rec == nullptr) { return nullptr; } list_node_t* n = list_foreach(btm_sec_cb.sec_dev_rec, btm_ble_match_random_bda, (void*)&random_bda); return (n == nullptr) ? (nullptr) : (static_cast(list_node(n))); } /******************************************************************************* * address mapping between pseudo address and real connection address ******************************************************************************/ /** Find the security record whose LE identity address is matching */ static tBTM_SEC_DEV_REC* btm_find_dev_by_identity_addr(const RawAddress& bd_addr, uint8_t addr_type) { if (btm_sec_cb.sec_dev_rec == nullptr) { return nullptr; } list_node_t* end = list_end(btm_sec_cb.sec_dev_rec); for (list_node_t* node = list_begin(btm_sec_cb.sec_dev_rec); node != end; node = list_next(node)) { tBTM_SEC_DEV_REC* p_dev_rec = static_cast(list_node(node)); if (p_dev_rec->ble.identity_address_with_type.bda == bd_addr) { if ((p_dev_rec->ble.identity_address_with_type.type & (~BLE_ADDR_TYPE_ID_BIT)) != (addr_type & (~BLE_ADDR_TYPE_ID_BIT))) { log::warn("pseudo->random match with diff addr type: {} vs {}", p_dev_rec->ble.identity_address_with_type.type, addr_type); } /* found the match */ return p_dev_rec; } } return NULL; } /******************************************************************************* * * Function btm_identity_addr_to_random_pseudo * * Description This function map a static BD address to a pseudo random * address in security database. * ******************************************************************************/ bool btm_identity_addr_to_random_pseudo(RawAddress* bd_addr, tBLE_ADDR_TYPE* p_addr_type, bool refresh) { tBTM_SEC_DEV_REC* p_dev_rec = btm_find_dev_by_identity_addr(*bd_addr, *p_addr_type); if (p_dev_rec == nullptr) { return false; } /* evt reported on static address, map static address to random pseudo */ /* if RPA offloading is supported, or 4.2 controller, do RPA refresh */ if (refresh && bluetooth::shim::GetController()->GetLeResolvingListSize() != 0) { btm_ble_read_resolving_list_entry(p_dev_rec); } /* assign the original address to be the current report address */ if (!btm_ble_init_pseudo_addr(p_dev_rec, *bd_addr)) { *bd_addr = p_dev_rec->ble.pseudo_addr; } *p_addr_type = p_dev_rec->ble.AddressType(); return true; } bool btm_identity_addr_to_random_pseudo_from_address_with_type(tBLE_BD_ADDR* address_with_type, bool refresh) { return btm_identity_addr_to_random_pseudo(&(address_with_type->bda), &(address_with_type->type), refresh); } /******************************************************************************* * * Function btm_random_pseudo_to_identity_addr * * Description This function map a random pseudo address to a public * address. random_pseudo is input and output parameter * ******************************************************************************/ bool btm_random_pseudo_to_identity_addr(RawAddress* random_pseudo, tBLE_ADDR_TYPE* p_identity_addr_type) { tBTM_SEC_DEV_REC* p_dev_rec = btm_find_dev(*random_pseudo); if (p_dev_rec != NULL) { if (p_dev_rec->ble.in_controller_list & BTM_RESOLVING_LIST_BIT) { *p_identity_addr_type = p_dev_rec->ble.identity_address_with_type.type; *random_pseudo = p_dev_rec->ble.identity_address_with_type.bda; if (bluetooth::shim::GetController()->SupportsBlePrivacy()) { *p_identity_addr_type |= BLE_ADDR_TYPE_ID_BIT; } return true; } } return false; } /******************************************************************************* * * Function btm_ble_refresh_peer_resolvable_private_addr * * Description This function refresh the currently used resolvable remote * private address into security database and set active * connection address. * ******************************************************************************/ void btm_ble_refresh_peer_resolvable_private_addr(const RawAddress& pseudo_bda, const RawAddress& rpa, tBLE_RAND_ADDR_TYPE rra_type) { tBTM_SEC_DEV_REC* p_sec_rec = btm_find_dev(pseudo_bda); if (p_sec_rec == nullptr) { log::warn("No matching known device in record"); return; } p_sec_rec->ble.cur_rand_addr = rpa; if (rra_type == BTM_BLE_ADDR_PSEUDO) { p_sec_rec->ble.active_addr_type = rpa.IsEmpty() ? BTM_BLE_ADDR_STATIC : BTM_BLE_ADDR_RRA; } else { p_sec_rec->ble.active_addr_type = rra_type; } /* connection refresh remote address */ const auto& identity_address = p_sec_rec->ble.identity_address_with_type.bda; auto identity_address_type = p_sec_rec->ble.identity_address_with_type.type; if (!acl_refresh_remote_address(identity_address, identity_address_type, p_sec_rec->bd_addr, rra_type, rpa)) { // Try looking up the pseudo random address if (!acl_refresh_remote_address(identity_address, identity_address_type, p_sec_rec->ble.pseudo_addr, rra_type, rpa)) { log::error("Unknown device to refresh remote device"); } } } bool maybe_resolve_address(RawAddress* bda, tBLE_ADDR_TYPE* bda_type) { bool is_in_security_db = false; tBLE_ADDR_TYPE peer_addr_type = *bda_type; bool addr_is_rpa = (peer_addr_type == BLE_ADDR_RANDOM && BTM_BLE_IS_RESOLVE_BDA(*bda)); /* We must translate whatever address we received into the "pseudo" address. * i.e. if we bonded with device that was using RPA for first connection, * "pseudo" address is equal to this RPA. If it later decides to use Public * address, or Random Static Address, we convert it into the "pseudo" * address here. */ if (!addr_is_rpa || peer_addr_type & BLE_ADDR_TYPE_ID_BIT) { is_in_security_db = btm_identity_addr_to_random_pseudo(bda, bda_type, true); } /* possiblly receive connection complete with resolvable random while the device has been paired */ if (!is_in_security_db && addr_is_rpa) { tBTM_SEC_DEV_REC* match_rec = btm_ble_resolve_random_addr(*bda); if (match_rec) { log::info("matched/resolved random address:{}", *bda); is_in_security_db = true; match_rec->ble.active_addr_type = BTM_BLE_ADDR_RRA; match_rec->ble.cur_rand_addr = *bda; if (!btm_ble_init_pseudo_addr(match_rec, *bda)) { /* assign the original address to be the current report address */ *bda = match_rec->ble.pseudo_addr; *bda_type = match_rec->ble.AddressType(); } else { *bda = match_rec->bd_addr; } } else { log::info("unable to match/resolve random address:{}", *bda); } } return is_in_security_db; }