blob: 4c96c0ae41d241dfdd7ae79e40c164a0d0018bb1 [file] [log] [blame]
// Copyright 2018 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "bredr_connection_manager.h"
#include <zircon/assert.h>
#include "src/connectivity/bluetooth/core/bt-host/common/log.h"
#include "src/connectivity/bluetooth/core/bt-host/common/status.h"
#include "src/connectivity/bluetooth/core/bt-host/gap/peer_cache.h"
#include "src/connectivity/bluetooth/core/bt-host/hci/connection.h"
#include "src/connectivity/bluetooth/core/bt-host/hci/hci.h"
#include "src/connectivity/bluetooth/core/bt-host/hci/hci_constants.h"
#include "src/connectivity/bluetooth/core/bt-host/hci/sequential_command_runner.h"
#include "src/connectivity/bluetooth/core/bt-host/hci/status.h"
#include "src/connectivity/bluetooth/core/bt-host/hci/transport.h"
#include "src/connectivity/bluetooth/core/bt-host/l2cap/l2cap.h"
#include "src/connectivity/bluetooth/core/bt-host/l2cap/types.h"
namespace bt {
namespace gap {
using std::unique_ptr;
using ConnectionState = Peer::ConnectionState;
namespace {
// This procedure can continue to operate independently of the existence of an
// BrEdrConnectionManager instance, which will begin to disable Page Scan as it shuts down.
void SetPageScanEnabled(bool enabled, fxl::RefPtr<hci::Transport> hci,
async_dispatcher_t* dispatcher, hci::StatusCallback cb) {
ZX_DEBUG_ASSERT(cb);
auto read_enable = hci::CommandPacket::New(hci::kReadScanEnable);
auto finish_enable_cb = [enabled, dispatcher, hci, finish_cb = std::move(cb)](
auto, const hci::EventPacket& event) mutable {
if (hci_is_error(event, WARN, "gap-bredr", "read scan enable failed")) {
finish_cb(event.ToStatus());
return;
}
auto params = event.return_params<hci::ReadScanEnableReturnParams>();
uint8_t scan_type = params->scan_enable;
if (enabled) {
scan_type |= static_cast<uint8_t>(hci::ScanEnableBit::kPage);
} else {
scan_type &= ~static_cast<uint8_t>(hci::ScanEnableBit::kPage);
}
auto write_enable =
hci::CommandPacket::New(hci::kWriteScanEnable, sizeof(hci::WriteScanEnableCommandParams));
write_enable->mutable_payload<hci::WriteScanEnableCommandParams>()->scan_enable = scan_type;
hci->command_channel()->SendCommand(
std::move(write_enable), dispatcher,
[cb = std::move(finish_cb)](auto, const hci::EventPacket& event) { cb(event.ToStatus()); });
};
hci->command_channel()->SendCommand(std::move(read_enable), dispatcher,
std::move(finish_enable_cb));
}
} // namespace
BrEdrConnection::BrEdrConnection(BrEdrConnectionManager* connection_manager, PeerId peer_id,
std::unique_ptr<hci::Connection> link,
std::optional<Request> request)
: peer_id_(peer_id),
link_(std::move(link)),
pairing_state_(peer_id, link_.get(),
[peer_id, mgr = connection_manager](auto, hci::Status status) {
if (!status) {
mgr->Disconnect(peer_id);
}
}),
request_(std::move(request)),
domain_(std::nullopt) {
link_->set_peer_disconnect_callback(
fit::bind_member(connection_manager, &BrEdrConnectionManager::OnPeerDisconnect));
}
BrEdrConnection::~BrEdrConnection() {
if (request_.has_value()) {
// Connection never completed so signal the requester(s).
request_->NotifyCallbacks(hci::Status(HostError::kNotSupported), [] { return nullptr; });
}
}
void BrEdrConnection::Start(data::Domain& domain) {
ZX_ASSERT_MSG(!domain_.has_value(), "Start on a connection that's already started");
domain_ = std::ref(domain);
// Fulfill and clear request so that the dtor does not signal requester(s) with errors.
if (auto request = std::exchange(request_, std::nullopt); request.has_value()) {
request->NotifyCallbacks(hci::Status(), [this] { return this; });
}
}
void BrEdrConnection::OpenL2capChannel(l2cap::PSM psm, l2cap::ChannelParameters params,
data::Domain::SocketCallback cb,
async_dispatcher_t* dispatcher) {
if (!domain_.has_value()) {
// Connection is not yet ready for L2CAP; return a ZX_HANDLE_INVALID socket.
bt_log(INFO, "gap-bredr", "Connection to %s not complete; canceling socket to PSM %.4x",
bt_str(peer_id()), psm);
async::PostTask(dispatcher, [cb = std::move(cb), handle = link().handle()]() {
cb(l2cap::ChannelSocket(), handle);
});
return;
}
bt_log(SPEW, "gap-bredr", "opening l2cap channel on %#.4x for %s", psm, bt_str(peer_id()));
domain_->get().OpenL2capChannel(link().handle(), psm, params, std::move(cb), dispatcher);
}
hci::CommandChannel::EventHandlerId BrEdrConnectionManager::AddEventHandler(
const hci::EventCode& code, hci::CommandChannel::EventCallback cb) {
auto self = weak_ptr_factory_.GetWeakPtr();
auto event_id = hci_->command_channel()->AddEventHandler(
code,
[self, callback = std::move(cb)](const auto& event) {
if (self) {
return callback(event);
}
return hci::CommandChannel::EventCallbackResult::kRemove;
},
dispatcher_);
ZX_DEBUG_ASSERT(event_id);
event_handler_ids_.push_back(event_id);
return event_id;
}
BrEdrConnectionManager::BrEdrConnectionManager(fxl::RefPtr<hci::Transport> hci,
PeerCache* peer_cache, DeviceAddress local_address,
fbl::RefPtr<data::Domain> data_domain,
bool use_interlaced_scan)
: hci_(hci),
cache_(peer_cache),
local_address_(local_address),
data_domain_(data_domain),
interrogator_(cache_, hci_, async_get_default_dispatcher()),
page_scan_interval_(0),
page_scan_window_(0),
use_interlaced_scan_(use_interlaced_scan),
request_timeout_(kBrEdrCreateConnectionTimeout),
dispatcher_(async_get_default_dispatcher()),
weak_ptr_factory_(this) {
ZX_DEBUG_ASSERT(hci_);
ZX_DEBUG_ASSERT(cache_);
ZX_DEBUG_ASSERT(data_domain_);
ZX_DEBUG_ASSERT(dispatcher_);
hci_cmd_runner_ = std::make_unique<hci::SequentialCommandRunner>(dispatcher_, hci_);
// Register event handlers
AddEventHandler(hci::kAuthenticationCompleteEventCode,
fit::bind_member(this, &BrEdrConnectionManager::OnAuthenticationComplete));
AddEventHandler(hci::kConnectionCompleteEventCode,
fit::bind_member(this, &BrEdrConnectionManager::OnConnectionComplete));
AddEventHandler(hci::kConnectionRequestEventCode,
fit::bind_member(this, &BrEdrConnectionManager::OnConnectionRequest));
AddEventHandler(hci::kIOCapabilityRequestEventCode,
fit::bind_member(this, &BrEdrConnectionManager::OnIoCapabilityRequest));
AddEventHandler(hci::kIOCapabilityResponseEventCode,
fit::bind_member(this, &BrEdrConnectionManager::OnIoCapabilityResponse));
AddEventHandler(hci::kLinkKeyRequestEventCode,
fit::bind_member(this, &BrEdrConnectionManager::OnLinkKeyRequest));
AddEventHandler(hci::kLinkKeyNotificationEventCode,
fit::bind_member(this, &BrEdrConnectionManager::OnLinkKeyNotification));
AddEventHandler(hci::kSimplePairingCompleteEventCode,
fit::bind_member(this, &BrEdrConnectionManager::OnSimplePairingComplete));
AddEventHandler(hci::kUserConfirmationRequestEventCode,
fit::bind_member(this, &BrEdrConnectionManager::OnUserConfirmationRequest));
AddEventHandler(hci::kUserPasskeyRequestEventCode,
fit::bind_member(this, &BrEdrConnectionManager::OnUserPasskeyRequest));
AddEventHandler(hci::kUserPasskeyNotificationEventCode,
fit::bind_member(this, &BrEdrConnectionManager::OnUserPasskeyNotification));
}
BrEdrConnectionManager::~BrEdrConnectionManager() {
if (pending_request_ && pending_request_->Cancel())
SendCreateConnectionCancelCommand(pending_request_->peer_address());
// Disconnect any connections that we're holding.
connections_.clear();
// Become unconnectable
SetPageScanEnabled(/*enabled=*/false, hci_, dispatcher_, [](const auto) {});
// Remove all event handlers
for (auto handler_id : event_handler_ids_) {
hci_->command_channel()->RemoveEventHandler(handler_id);
}
}
void BrEdrConnectionManager::SetConnectable(bool connectable, hci::StatusCallback status_cb) {
auto self = weak_ptr_factory_.GetWeakPtr();
if (!connectable) {
auto not_connectable_cb = [self, cb = std::move(status_cb)](const auto& status) {
if (self) {
self->page_scan_interval_ = 0;
self->page_scan_window_ = 0;
} else if (status) {
cb(hci::Status(HostError::kFailed));
return;
}
cb(status);
};
SetPageScanEnabled(/*enabled=*/false, hci_, dispatcher_, std::move(not_connectable_cb));
return;
}
WritePageScanSettings(
hci::kPageScanR1Interval, hci::kPageScanR1Window, use_interlaced_scan_,
[self, cb = std::move(status_cb)](const auto& status) mutable {
if (bt_is_error(status, WARN, "gap-bredr", "Write Page Scan Settings failed")) {
cb(status);
return;
}
if (!self) {
cb(hci::Status(HostError::kFailed));
return;
}
SetPageScanEnabled(/*enabled=*/true, self->hci_, self->dispatcher_, std::move(cb));
});
}
void BrEdrConnectionManager::SetPairingDelegate(fxl::WeakPtr<PairingDelegate> delegate) {
pairing_delegate_ = std::move(delegate);
for (auto& [handle, connection] : connections_) {
connection.pairing_state().SetPairingDelegate(pairing_delegate_);
}
}
PeerId BrEdrConnectionManager::GetPeerId(hci::ConnectionHandle handle) const {
auto it = connections_.find(handle);
if (it == connections_.end()) {
return kInvalidPeerId;
}
auto* peer = cache_->FindByAddress(it->second.link().peer_address());
ZX_DEBUG_ASSERT_MSG(peer, "Couldn't find peer for handle %#.4x", handle);
return peer->identifier();
}
void BrEdrConnectionManager::Pair(PeerId peer_id, hci::StatusCallback callback) {
auto conn_pair = FindConnectionById(peer_id);
if (!conn_pair) {
bt_log(WARN, "gap-bredr", "can't pair to peer_id %s: connection not found", bt_str(peer_id));
callback(hci::Status(HostError::kNotFound));
return;
}
auto& [handle, connection] = *conn_pair;
if (!connection->link().ltk()) {
auto pairing_callback = [pair_callback = std::move(callback)](auto, hci::Status status) {
pair_callback(status);
};
if (!InitiatesPairing(peer_id, connection, handle, std::move(pairing_callback))) {
bt_log(INFO, "gap-bredr",
"pairing to peer_id %s already in progress, call again to initiate pairing",
bt_str(peer_id));
}
} else {
// Already paired, return success status
callback(hci::Status());
}
}
bool BrEdrConnectionManager::OpenL2capChannel(PeerId peer_id, l2cap::PSM psm,
l2cap::ChannelParameters params, SocketCallback cb,
async_dispatcher_t* dispatcher) {
auto conn_pair = FindConnectionById(peer_id);
if (!conn_pair) {
bt_log(SPEW, "gap-bredr", "can't open l2cap %s: connection not found", bt_str(peer_id));
return false;
}
auto& [handle, connection] = *conn_pair;
if (!connection->link().ltk()) {
// Connection doesn't have a key, initiate pairing.
auto self = weak_ptr_factory_.GetWeakPtr();
auto retry_cb = [peer_id, psm, params, cb = std::move(cb), dispatcher, self](
auto, hci::Status status) mutable {
bt_log(SPEW, "gap-bredr", "got pairing status %s, %sretrying socket to %s", bt_str(status),
status ? "" : "not ", bt_str(peer_id));
if (!status) {
// Report the failure to the user with a ZX_HANDLE_INVALID socket.
async::PostTask(dispatcher, [cb = std::move(cb)]() { cb(l2cap::ChannelSocket()); });
return;
}
if (self) {
// We should now have an LTK so try again.
self->OpenL2capChannel(peer_id, psm, params, std::move(cb), dispatcher);
}
};
if (!InitiatesPairing(peer_id, connection, handle, std::move(retry_cb))) {
bt_log(SPEW, "gap-bredr", "pairing ongoing to peer %s, waiting for result", bt_str(peer_id));
}
return true;
}
connection->OpenL2capChannel(
psm, params,
[cb = std::move(cb)](auto chan_sock, auto /*handle*/) { cb(std::move(chan_sock)); },
dispatcher);
return true;
}
BrEdrConnectionManager::SearchId BrEdrConnectionManager::AddServiceSearch(
const UUID& uuid, std::unordered_set<sdp::AttributeId> attributes,
BrEdrConnectionManager::SearchCallback callback) {
return discoverer_.AddSearch(uuid, std::move(attributes), std::move(callback));
}
bool BrEdrConnectionManager::RemoveServiceSearch(SearchId id) {
return discoverer_.RemoveSearch(id);
}
bool BrEdrConnectionManager::Disconnect(PeerId peer_id) {
if (connection_requests_.find(peer_id) != connection_requests_.end()) {
bt_log(WARN, "gap-bredr", "Can't disconnect peer %s because it's being connected to",
bt_str(peer_id));
return false;
}
auto conn_pair = FindConnectionById(peer_id);
if (!conn_pair) {
bt_log(INFO, "gap-bredr", "No need to disconnect peer (id: %s): It is not connected",
bt_str(peer_id));
return true;
}
auto [handle, connection] = *conn_pair;
CleanUpConnection(handle, std::move(connections_.extract(handle).mapped()));
return true;
}
void BrEdrConnectionManager::WritePageScanSettings(uint16_t interval, uint16_t window,
bool interlaced, hci::StatusCallback cb) {
auto self = weak_ptr_factory_.GetWeakPtr();
if (!hci_cmd_runner_->IsReady()) {
// TODO(jamuraa): could run the three "settings" commands in parallel and
// remove the sequence runner.
cb(hci::Status(HostError::kInProgress));
return;
}
auto write_activity = hci::CommandPacket::New(hci::kWritePageScanActivity,
sizeof(hci::WritePageScanActivityCommandParams));
auto* activity_params =
write_activity->mutable_payload<hci::WritePageScanActivityCommandParams>();
activity_params->page_scan_interval = htole16(interval);
activity_params->page_scan_window = htole16(window);
hci_cmd_runner_->QueueCommand(
std::move(write_activity), [self, interval, window](const hci::EventPacket& event) {
if (!self || hci_is_error(event, WARN, "gap-bredr", "write page scan activity failed")) {
return;
}
self->page_scan_interval_ = interval;
self->page_scan_window_ = window;
bt_log(SPEW, "gap-bredr", "page scan activity updated");
});
auto write_type =
hci::CommandPacket::New(hci::kWritePageScanType, sizeof(hci::WritePageScanTypeCommandParams));
auto* type_params = write_type->mutable_payload<hci::WritePageScanTypeCommandParams>();
type_params->page_scan_type =
(interlaced ? hci::PageScanType::kInterlacedScan : hci::PageScanType::kStandardScan);
hci_cmd_runner_->QueueCommand(
std::move(write_type), [self, interlaced](const hci::EventPacket& event) {
if (!self || hci_is_error(event, WARN, "gap-bredr", "write page scan type failed")) {
return;
}
self->page_scan_type_ =
(interlaced ? hci::PageScanType::kInterlacedScan : hci::PageScanType::kStandardScan);
bt_log(SPEW, "gap-bredr", "page scan type updated");
});
hci_cmd_runner_->RunCommands(std::move(cb));
}
std::optional<std::pair<hci::ConnectionHandle, BrEdrConnection*>>
BrEdrConnectionManager::FindConnectionById(PeerId peer_id) {
auto it = std::find_if(connections_.begin(), connections_.end(),
[peer_id](const auto& c) { return c.second.peer_id() == peer_id; });
if (it == connections_.end()) {
return std::nullopt;
}
auto& [handle, conn] = *it;
ZX_ASSERT(conn.link().ll_type() != hci::Connection::LinkType::kLE);
return std::pair(handle, &conn);
}
std::optional<std::pair<hci::ConnectionHandle, BrEdrConnection*>>
BrEdrConnectionManager::FindConnectionByAddress(const DeviceAddressBytes& bd_addr) {
auto* const peer = cache_->FindByAddress(DeviceAddress(DeviceAddress::Type::kBREDR, bd_addr));
if (!peer) {
return std::nullopt;
}
return FindConnectionById(peer->identifier());
}
Peer* BrEdrConnectionManager::FindOrInitPeer(DeviceAddress addr) {
Peer* peer = cache_->FindByAddress(addr);
if (!peer) {
peer = cache_->NewPeer(addr, /*connectable*/ true);
}
return peer;
}
// Build connection state for a new connection and begin interrogation. L2CAP is not enabled for
// this link but pairing is allowed before interrogation completes.
void BrEdrConnectionManager::InitializeConnection(DeviceAddress addr,
hci::ConnectionHandle connection_handle) {
// TODO(BT-288): support non-master connections.
auto link = hci::Connection::CreateACL(connection_handle, hci::Connection::Role::kMaster,
local_address_, addr, hci_);
Peer* const peer = FindOrInitPeer(addr);
// We should never have more than one link to a given peer
ZX_DEBUG_ASSERT(!FindConnectionById(peer->identifier()));
peer->MutBrEdr().SetConnectionState(ConnectionState::kInitializing);
// The controller has completed the HCI connection procedure, so the connection request can no
// longer be failed by a lower layer error. Now tie error reporting of the request to the lifetime
// of the connection state object (BrEdrConnection RAII).
auto request_node = connection_requests_.extract(peer->identifier());
std::optional<BrEdrConnection::Request> request =
request_node ? std::move(request_node.mapped()) : std::optional<BrEdrConnection::Request>();
const hci::ConnectionHandle handle = link->handle();
BrEdrConnection& connection =
connections_
.try_emplace(handle, this, peer->identifier(), std::move(link), std::move(request))
.first->second;
connection.pairing_state().SetPairingDelegate(pairing_delegate_);
// Interrogate this peer to find out its version/capabilities.
auto self = weak_ptr_factory_.GetWeakPtr();
interrogator_.Start(peer->identifier(), handle, [peer, self, handle](auto status) {
if (!self) {
return;
}
if (bt_is_error(status, WARN, "gap-bredr", "interrogate failed, dropping connection")) {
// If this connection was locally requested, requester(s) are notified by the disconnection.
self->Disconnect(peer->identifier());
return;
}
bt_log(SPEW, "gap-bredr", "interrogation complete for %#.4x", handle);
self->CompleteConnectionSetup(peer, handle);
});
// If this was our in-flight request, close it
if (pending_request_.has_value() && addr == pending_request_->peer_address()) {
pending_request_.reset();
}
TryCreateNextConnection();
}
// Finish connection setup after a successful interrogation.
void BrEdrConnectionManager::CompleteConnectionSetup(Peer* peer, hci::ConnectionHandle handle) {
auto self = weak_ptr_factory_.GetWeakPtr();
auto connections_iter = connections_.find(handle);
if (connections_iter == connections_.end()) {
bt_log(WARN, "gap-bredr", "Connection to complete not found, handle: %#.4x", handle);
return;
}
BrEdrConnection& conn_state = connections_iter->second;
if (conn_state.peer_id() != peer->identifier()) {
bt_log(WARN, "gap-bredr",
"Connection %#.4x is no longer to peer %s (now to %s), ignoring interrogation result",
handle, bt_str(peer->identifier()), bt_str(conn_state.peer_id()));
return;
}
hci::Connection* const connection = &conn_state.link();
auto error_handler = [self, peer_id = peer->identifier(), connection = connection->WeakPtr()] {
if (!self || !connection)
return;
bt_log(WARN, "gap-bredr", "Link error received, closing connection %#.4x",
connection->handle());
self->Disconnect(peer_id);
};
// TODO(37650): Implement this callback as a call to InitiatePairing().
auto security_callback = [](hci::ConnectionHandle handle, sm::SecurityLevel level, auto cb) {
bt_log(INFO, "gap-bredr", "Ignoring security upgrade request; not implemented");
cb(sm::Status(HostError::kNotSupported));
};
// Register with L2CAP to handle services on the ACL signaling channel.
data_domain_->AddACLConnection(handle, connection->role(), error_handler,
std::move(security_callback));
peer->MutBrEdr().SetConnectionState(ConnectionState::kConnected);
if (discoverer_.search_count()) {
data_domain_->OpenL2capChannel(
handle, l2cap::kSDP, l2cap::ChannelParameters(),
[self, peer_id = peer->identifier()](auto channel) {
if (!self)
return;
if (!channel) {
bt_log(ERROR, "gap", "failed to create l2cap channel for SDP (peer id: %s)",
bt_str(peer_id));
return;
}
auto client = sdp::Client::Create(std::move(channel));
self->discoverer_.StartServiceDiscovery(peer_id, std::move(client));
},
dispatcher_);
}
conn_state.Start(*data_domain_);
}
hci::CommandChannel::EventCallbackResult BrEdrConnectionManager::OnAuthenticationComplete(
const hci::EventPacket& event) {
ZX_DEBUG_ASSERT(event.event_code() == hci::kAuthenticationCompleteEventCode);
const auto& params = event.params<hci::AuthenticationCompleteEventParams>();
auto iter = connections_.find(params.connection_handle);
if (iter == connections_.end()) {
bt_log(SPEW, "gap-bredr", "ignoring authentication complete for %#.04x",
params.connection_handle);
return hci::CommandChannel::EventCallbackResult::kContinue;
}
hci::StatusCode status_code;
event.ToStatusCode(&status_code);
iter->second.pairing_state().OnAuthenticationComplete(status_code);
return hci::CommandChannel::EventCallbackResult::kContinue;
}
hci::CommandChannel::EventCallbackResult BrEdrConnectionManager::OnConnectionRequest(
const hci::EventPacket& event) {
ZX_DEBUG_ASSERT(event.event_code() == hci::kConnectionRequestEventCode);
const auto& params = event.params<hci::ConnectionRequestEventParams>();
std::string link_type_str = params.link_type == hci::LinkType::kACL ? "ACL" : "(e)SCO";
bt_log(TRACE, "gap-bredr", "%s conn request from %s (%s)", link_type_str.c_str(),
params.bd_addr.ToString().c_str(), params.class_of_device.ToString().c_str());
if (params.link_type == hci::LinkType::kACL) {
// Accept the connection, performing a role switch. We receive a
// Connection Complete event when the connection is complete, and finish
// the link then.
bt_log(INFO, "gap-bredr", "accept incoming connection");
auto accept = hci::CommandPacket::New(hci::kAcceptConnectionRequest,
sizeof(hci::AcceptConnectionRequestCommandParams));
auto accept_params = accept->mutable_payload<hci::AcceptConnectionRequestCommandParams>();
accept_params->bd_addr = params.bd_addr;
accept_params->role = hci::ConnectionRole::kMaster;
hci_->command_channel()->SendCommand(std::move(accept), dispatcher_, nullptr,
hci::kCommandStatusEventCode);
return hci::CommandChannel::EventCallbackResult::kContinue;
}
// Reject this connection.
bt_log(INFO, "gap-bredr", "reject unsupported connection");
auto reject = hci::CommandPacket::New(hci::kRejectConnectionRequest,
sizeof(hci::RejectConnectionRequestCommandParams));
auto reject_params = reject->mutable_payload<hci::RejectConnectionRequestCommandParams>();
reject_params->bd_addr = params.bd_addr;
reject_params->reason = hci::StatusCode::kConnectionRejectedBadBdAddr;
hci_->command_channel()->SendCommand(std::move(reject), dispatcher_, nullptr,
hci::kCommandStatusEventCode);
return hci::CommandChannel::EventCallbackResult::kContinue;
}
hci::CommandChannel::EventCallbackResult BrEdrConnectionManager::OnConnectionComplete(
const hci::EventPacket& event) {
ZX_DEBUG_ASSERT(event.event_code() == hci::kConnectionCompleteEventCode);
const auto& params = event.params<hci::ConnectionCompleteEventParams>();
auto connection_handle = letoh16(params.connection_handle);
DeviceAddress addr(DeviceAddress::Type::kBREDR, params.bd_addr);
bt_log(TRACE, "gap-bredr", "%s connection complete (status %#.2x, handle: %#.4x)",
bt_str(params.bd_addr), params.status, connection_handle);
if (pending_request_ && pending_request_->peer_address() == addr) {
auto status = hci::Status(params.status);
status = pending_request_->CompleteRequest(status);
if (!status) {
OnConnectFailure(status, pending_request_->peer_id());
}
}
if (params.link_type != hci::LinkType::kACL) {
// Drop the connection if we don't support it.
return hci::CommandChannel::EventCallbackResult::kContinue;
}
if (!hci_is_error(event, WARN, "gap-bredr", "connection error")) {
InitializeConnection(addr, connection_handle);
}
return hci::CommandChannel::EventCallbackResult::kContinue;
}
void BrEdrConnectionManager::OnPeerDisconnect(const hci::Connection* connection) {
auto handle = connection->handle();
auto it = connections_.find(handle);
if (it == connections_.end()) {
bt_log(SPEW, "gap-bredr", "disconnect from unknown handle %#.4x", handle);
return;
}
auto conn = std::move(it->second);
connections_.erase(it);
bt_log(INFO, "gap-bredr", "peer %s disconnected (handle: %#.4x)", bt_str(conn.peer_id()), handle);
CleanUpConnection(handle, std::move(conn));
}
void BrEdrConnectionManager::CleanUpConnection(hci::ConnectionHandle handle, BrEdrConnection conn) {
auto* peer = cache_->FindByAddress(conn.link().peer_address());
ZX_DEBUG_ASSERT_MSG(peer, "Couldn't find peer for handle: %#.4x", handle);
peer->MutBrEdr().SetConnectionState(ConnectionState::kNotConnected);
data_domain_->RemoveConnection(handle);
// |conn| is destroyed when it goes out of scope.
}
hci::CommandChannel::EventCallbackResult BrEdrConnectionManager::OnIoCapabilityRequest(
const hci::EventPacket& event) {
ZX_DEBUG_ASSERT(event.event_code() == hci::kIOCapabilityRequestEventCode);
const auto& params = event.params<hci::IOCapabilityRequestEventParams>();
auto conn_pair = FindConnectionByAddress(params.bd_addr);
if (!conn_pair) {
bt_log(ERROR, "gap-bredr", "got %s for unconnected addr %s", __func__, bt_str(params.bd_addr));
SendIoCapabilityRequestNegativeReply(params.bd_addr, hci::StatusCode::kPairingNotAllowed);
return hci::CommandChannel::EventCallbackResult::kContinue;
}
auto [handle, conn_ptr] = *conn_pair;
auto reply = conn_ptr->pairing_state().OnIoCapabilityRequest();
if (!reply) {
SendIoCapabilityRequestNegativeReply(params.bd_addr, hci::StatusCode::kPairingNotAllowed);
return hci::CommandChannel::EventCallbackResult::kContinue;
}
const hci::IOCapability io_capability = *reply;
// TODO(BT-8): Add OOB status from PeerCache.
const uint8_t oob_data_present = 0x00; // None present.
// TODO(BT-656): Determine this based on the service requirements.
const hci::AuthRequirements auth_requirements =
io_capability == hci::IOCapability::kNoInputNoOutput
? hci::AuthRequirements::kGeneralBonding
: hci::AuthRequirements::kMITMGeneralBonding;
SendIoCapabilityRequestReply(params.bd_addr, io_capability, oob_data_present, auth_requirements);
return hci::CommandChannel::EventCallbackResult::kContinue;
}
hci::CommandChannel::EventCallbackResult BrEdrConnectionManager::OnIoCapabilityResponse(
const hci::EventPacket& event) {
ZX_DEBUG_ASSERT(event.event_code() == hci::kIOCapabilityResponseEventCode);
const auto& params = event.params<hci::IOCapabilityResponseEventParams>();
auto conn_pair = FindConnectionByAddress(params.bd_addr);
if (!conn_pair) {
bt_log(INFO, "gap-bredr", "got %s for unconnected addr %s", __func__, bt_str(params.bd_addr));
return hci::CommandChannel::EventCallbackResult::kContinue;
}
conn_pair->second->pairing_state().OnIoCapabilityResponse(params.io_capability);
return hci::CommandChannel::EventCallbackResult::kContinue;
}
hci::CommandChannel::EventCallbackResult BrEdrConnectionManager::OnLinkKeyRequest(
const hci::EventPacket& event) {
ZX_DEBUG_ASSERT(event.event_code() == hci::kLinkKeyRequestEventCode);
const auto& params = event.params<hci::LinkKeyRequestParams>();
DeviceAddress addr(DeviceAddress::Type::kBREDR, params.bd_addr);
auto* peer = cache_->FindByAddress(addr);
if (!peer || !peer->bredr() || !peer->bredr()->bonded()) {
bt_log(INFO, "gap-bredr", "no bonded peer with address %s found", addr.ToString().c_str());
auto reply = hci::CommandPacket::New(hci::kLinkKeyRequestNegativeReply,
sizeof(hci::LinkKeyRequestNegativeReplyCommandParams));
auto reply_params = reply->mutable_payload<hci::LinkKeyRequestNegativeReplyCommandParams>();
reply_params->bd_addr = params.bd_addr;
SendCommandWithStatusCallback(std::move(reply), nullptr);
return hci::CommandChannel::EventCallbackResult::kContinue;
}
auto peer_id = peer->identifier();
bt_log(INFO, "gap-bredr", "recalling link key for bonded peer %s", bt_str(peer_id));
auto reply = hci::CommandPacket::New(hci::kLinkKeyRequestReply,
sizeof(hci::LinkKeyRequestReplyCommandParams));
auto reply_params = reply->mutable_payload<hci::LinkKeyRequestReplyCommandParams>();
reply_params->bd_addr = params.bd_addr;
const sm::LTK& link_key = *peer->bredr()->link_key();
ZX_DEBUG_ASSERT(link_key.security().enc_key_size() == 16);
const auto& hci_key = link_key.key();
const auto& key_value = hci_key.value();
std::copy(key_value.begin(), key_value.end(), reply_params->link_key);
const auto link_key_type = link_key.security().GetLinkKeyType();
ZX_ASSERT(link_key_type.has_value());
auto handle = FindConnectionById(peer_id);
if (!handle) {
bt_log(WARN, "gap-bredr", "can't find connection for ltk (id: %s)", bt_str(peer_id));
} else {
handle->second->link().set_bredr_link_key(hci_key, link_key_type.value());
}
SendCommandWithStatusCallback(std::move(reply), nullptr);
return hci::CommandChannel::EventCallbackResult::kContinue;
}
hci::CommandChannel::EventCallbackResult BrEdrConnectionManager::OnLinkKeyNotification(
const hci::EventPacket& event) {
ZX_DEBUG_ASSERT(event.event_code() == hci::kLinkKeyNotificationEventCode);
const auto& params = event.params<hci::LinkKeyNotificationEventParams>();
DeviceAddress addr(DeviceAddress::Type::kBREDR, params.bd_addr);
bt_log(TRACE, "gap-bredr", "got link key (type %u) for address %s", params.key_type,
addr.ToString().c_str());
auto* peer = cache_->FindByAddress(addr);
if (!peer) {
bt_log(WARN, "gap-bredr", "no known peer with address %s found; link key not stored",
addr.ToString().c_str());
return hci::CommandChannel::EventCallbackResult::kContinue;
}
auto key_type = hci::LinkKeyType{params.key_type};
sm::SecurityProperties sec_props;
if (key_type == hci::LinkKeyType::kChangedCombination) {
if (!peer->bredr() || !peer->bredr()->bonded()) {
bt_log(WARN, "gap-bredr", "can't update link key of unbonded peer %s",
bt_str(peer->identifier()));
return hci::CommandChannel::EventCallbackResult::kContinue;
}
// Reuse current properties
ZX_DEBUG_ASSERT(peer->bredr()->link_key());
sec_props = peer->bredr()->link_key()->security();
key_type = *sec_props.GetLinkKeyType();
} else {
sec_props = sm::SecurityProperties(key_type);
}
auto peer_id = peer->identifier();
if (sec_props.level() == sm::SecurityLevel::kNoSecurity) {
bt_log(WARN, "gap-bredr", "link key for peer %s has insufficient security; not stored",
bt_str(peer_id));
return hci::CommandChannel::EventCallbackResult::kContinue;
}
UInt128 key_value;
std::copy(params.link_key, &params.link_key[key_value.size()], key_value.begin());
hci::LinkKey hci_key(key_value, 0, 0);
sm::LTK key(sec_props, hci_key);
auto handle = FindConnectionById(peer_id);
if (!handle) {
bt_log(WARN, "gap-bredr", "can't find current connection for ltk (id: %s)", bt_str(peer_id));
} else {
handle->second->link().set_bredr_link_key(hci_key, key_type);
handle->second->pairing_state().OnLinkKeyNotification(key_value, key_type);
}
if (!cache_->StoreBrEdrBond(addr, key)) {
bt_log(ERROR, "gap-bredr", "failed to cache bonding data (id: %s)", bt_str(peer_id));
}
return hci::CommandChannel::EventCallbackResult::kContinue;
}
hci::CommandChannel::EventCallbackResult BrEdrConnectionManager::OnSimplePairingComplete(
const hci::EventPacket& event) {
ZX_DEBUG_ASSERT(event.event_code() == hci::kSimplePairingCompleteEventCode);
const auto& params = event.params<hci::SimplePairingCompleteEventParams>();
auto conn_pair = FindConnectionByAddress(params.bd_addr);
if (!conn_pair) {
bt_log(INFO, "gap-bredr", "got %s for unconnected addr %s", __func__, bt_str(params.bd_addr));
return hci::CommandChannel::EventCallbackResult::kContinue;
}
conn_pair->second->pairing_state().OnSimplePairingComplete(params.status);
return hci::CommandChannel::EventCallbackResult::kContinue;
}
hci::CommandChannel::EventCallbackResult BrEdrConnectionManager::OnUserConfirmationRequest(
const hci::EventPacket& event) {
ZX_DEBUG_ASSERT(event.event_code() == hci::kUserConfirmationRequestEventCode);
const auto& params = event.params<hci::UserConfirmationRequestEventParams>();
auto conn_pair = FindConnectionByAddress(params.bd_addr);
if (!conn_pair) {
bt_log(INFO, "gap-bredr", "got %s for unconnected addr %s", __func__, bt_str(params.bd_addr));
SendUserConfirmationRequestNegativeReply(params.bd_addr);
return hci::CommandChannel::EventCallbackResult::kContinue;
}
auto confirm_cb = [this, self = weak_ptr_factory_.GetWeakPtr(),
bd_addr = params.bd_addr](bool confirm) {
if (!self) {
return;
}
if (confirm) {
SendUserConfirmationRequestReply(bd_addr);
} else {
SendUserConfirmationRequestNegativeReply(bd_addr);
}
};
conn_pair->second->pairing_state().OnUserConfirmationRequest(letoh32(params.numeric_value),
std::move(confirm_cb));
return hci::CommandChannel::EventCallbackResult::kContinue;
}
hci::CommandChannel::EventCallbackResult BrEdrConnectionManager::OnUserPasskeyRequest(
const hci::EventPacket& event) {
ZX_DEBUG_ASSERT(event.event_code() == hci::kUserPasskeyRequestEventCode);
const auto& params = event.params<hci::UserPasskeyRequestEventParams>();
auto conn_pair = FindConnectionByAddress(params.bd_addr);
if (!conn_pair) {
bt_log(INFO, "gap-bredr", "got %s for unconnected addr %s", __func__, bt_str(params.bd_addr));
SendUserPasskeyRequestNegativeReply(params.bd_addr);
return hci::CommandChannel::EventCallbackResult::kContinue;
}
auto passkey_cb = [this, self = weak_ptr_factory_.GetWeakPtr(),
bd_addr = params.bd_addr](std::optional<uint32_t> passkey) {
if (!self) {
return;
}
if (passkey) {
SendUserPasskeyRequestReply(bd_addr, *passkey);
} else {
SendUserPasskeyRequestNegativeReply(bd_addr);
}
};
conn_pair->second->pairing_state().OnUserPasskeyRequest(std::move(passkey_cb));
return hci::CommandChannel::EventCallbackResult::kContinue;
}
hci::CommandChannel::EventCallbackResult BrEdrConnectionManager::OnUserPasskeyNotification(
const hci::EventPacket& event) {
ZX_DEBUG_ASSERT(event.event_code() == hci::kUserPasskeyNotificationEventCode);
const auto& params = event.params<hci::UserPasskeyNotificationEventParams>();
auto conn_pair = FindConnectionByAddress(params.bd_addr);
if (!conn_pair) {
bt_log(INFO, "gap-bredr", "got %s for unconnected addr %s", __func__, bt_str(params.bd_addr));
return hci::CommandChannel::EventCallbackResult::kContinue;
}
conn_pair->second->pairing_state().OnUserPasskeyNotification(letoh32(params.numeric_value));
return hci::CommandChannel::EventCallbackResult::kContinue;
}
bool BrEdrConnectionManager::Connect(PeerId peer_id, ConnectResultCallback on_connection_result) {
Peer* peer = cache_->FindById(peer_id);
if (!peer) {
bt_log(WARN, "gap-bredr", "peer not found (id: %s)", bt_str(peer_id));
return false;
}
if (peer->technology() == TechnologyType::kLowEnergy) {
bt_log(ERROR, "gap-bredr", "peer does not support BrEdr: %s", peer->ToString().c_str());
return false;
}
// Br/Edr peers should always be connectable by definition
ZX_ASSERT(peer->connectable());
// Succeed immediately if there is already an active connection.
auto conn = FindConnectionById(peer_id);
if (conn) {
async::PostTask(dispatcher_,
[conn = conn->second, on_result = std::move(on_connection_result)]() mutable {
on_result(hci::Status(), conn);
});
return true;
}
// If we are already waiting to connect to |peer_id| then we store
// |on_connection_result| to be processed after the connection attempt
// completes (in either success of failure).
auto pending_iter = connection_requests_.find(peer_id);
if (pending_iter != connection_requests_.end()) {
pending_iter->second.AddCallback(std::move(on_connection_result));
return true;
}
// If we are not already connected or pending, initiate a new connection
peer->MutBrEdr().SetConnectionState(ConnectionState::kInitializing);
connection_requests_.try_emplace(peer_id, peer->address(), std::move(on_connection_result));
TryCreateNextConnection();
return true;
}
void BrEdrConnectionManager::TryCreateNextConnection() {
// There can only be one outstanding BrEdr CreateConnection request at a time
if (pending_request_)
return;
if (connection_requests_.empty()) {
bt_log(SPEW, "gap-bredr", "no pending requests remaining");
return;
}
Peer* peer = nullptr;
for (auto& request : connection_requests_) {
const auto& next_peer_addr = request.second.address();
peer = cache_->FindByAddress(next_peer_addr);
if (peer && peer->bredr())
break;
}
auto self = weak_ptr_factory_.GetWeakPtr();
auto on_failure = [self](hci::Status status, auto peer_id) {
if (self && !status) {
self->OnConnectFailure(status, peer_id);
}
};
auto on_timeout = [self] {
if (self)
self->OnRequestTimeout();
};
if (peer) {
pending_request_.emplace(peer->identifier(), peer->address(), on_timeout);
pending_request_->CreateConnection(
hci_->command_channel(), dispatcher_, peer->bredr()->clock_offset(),
peer->bredr()->page_scan_repetition_mode(), request_timeout_, on_failure);
} else {
// If there are no pending requests for peers which are in the cache, try
// to connect to a peer which has left the cache, in case it is still
// possible
auto request = connection_requests_.begin();
if (request != connection_requests_.end()) {
auto identifier = request->first;
auto address = request->second.address();
pending_request_.emplace(identifier, address, on_timeout);
pending_request_->CreateConnection(hci_->command_channel(), dispatcher_, std::nullopt,
std::nullopt, request_timeout_, on_failure);
}
}
}
void BrEdrConnectionManager::OnConnectFailure(hci::Status status, PeerId peer_id) {
// The request failed or timed out.
bt_log(ERROR, "gap-bredr", "failed to connect to peer (id: %s)", bt_str(peer_id));
Peer* peer = cache_->FindById(peer_id);
// The peer may no longer be in the cache by the time this function is called
if (peer) {
peer->MutBrEdr().SetConnectionState(ConnectionState::kNotConnected);
}
pending_request_.reset();
// Notify the matching pending callbacks about the failure.
auto request = connection_requests_.extract(peer_id);
ZX_DEBUG_ASSERT(request);
request.mapped().NotifyCallbacks(status, [] { return nullptr; });
// Process the next pending attempt.
TryCreateNextConnection();
}
void BrEdrConnectionManager::OnRequestTimeout() {
if (pending_request_) {
pending_request_->Timeout();
SendCreateConnectionCancelCommand(pending_request_->peer_address());
}
}
void BrEdrConnectionManager::SendCreateConnectionCancelCommand(DeviceAddress addr) {
auto cancel = hci::CommandPacket::New(hci::kCreateConnectionCancel,
sizeof(hci::CreateConnectionCancelCommandParams));
auto params = cancel->mutable_payload<hci::CreateConnectionCancelCommandParams>();
params->bd_addr = addr.value();
hci_->command_channel()->SendCommand(
std::move(cancel), dispatcher_, [](auto, const hci::EventPacket& event) {
hci_is_error(event, WARN, "hci-bredr", "failed to cancel connection request");
});
}
void BrEdrConnectionManager::SendIoCapabilityRequestReply(DeviceAddressBytes bd_addr,
hci::IOCapability io_capability,
uint8_t oob_data_present,
hci::AuthRequirements auth_requirements,
hci::StatusCallback cb) {
auto packet = hci::CommandPacket::New(hci::kIOCapabilityRequestReply,
sizeof(hci::IOCapabilityRequestReplyCommandParams));
auto params = packet->mutable_payload<hci::IOCapabilityRequestReplyCommandParams>();
params->bd_addr = bd_addr;
params->io_capability = io_capability;
params->oob_data_present = oob_data_present;
params->auth_requirements = auth_requirements;
SendCommandWithStatusCallback(std::move(packet), std::move(cb));
}
void BrEdrConnectionManager::SendIoCapabilityRequestNegativeReply(DeviceAddressBytes bd_addr,
hci::StatusCode reason,
hci::StatusCallback cb) {
auto packet = hci::CommandPacket::New(hci::kIOCapabilityRequestNegativeReply,
sizeof(hci::IOCapabilityRequestNegativeReplyCommandParams));
auto params = packet->mutable_payload<hci::IOCapabilityRequestNegativeReplyCommandParams>();
params->bd_addr = bd_addr;
params->reason = reason;
SendCommandWithStatusCallback(std::move(packet), std::move(cb));
}
void BrEdrConnectionManager::SendUserConfirmationRequestReply(DeviceAddressBytes bd_addr,
hci::StatusCallback cb) {
auto packet = hci::CommandPacket::New(hci::kUserConfirmationRequestReply,
sizeof(hci::UserConfirmationRequestReplyCommandParams));
packet->mutable_payload<hci::UserConfirmationRequestReplyCommandParams>()->bd_addr = bd_addr;
SendCommandWithStatusCallback(std::move(packet), std::move(cb));
}
void BrEdrConnectionManager::SendUserConfirmationRequestNegativeReply(DeviceAddressBytes bd_addr,
hci::StatusCallback cb) {
auto packet =
hci::CommandPacket::New(hci::kUserConfirmationRequestNegativeReply,
sizeof(hci::UserConfirmationRequestNegativeReplyCommandParams));
packet->mutable_payload<hci::UserConfirmationRequestNegativeReplyCommandParams>()->bd_addr =
bd_addr;
SendCommandWithStatusCallback(std::move(packet), std::move(cb));
}
void BrEdrConnectionManager::SendUserPasskeyRequestReply(DeviceAddressBytes bd_addr,
uint32_t numeric_value,
hci::StatusCallback cb) {
auto packet = hci::CommandPacket::New(hci::kUserPasskeyRequestReply,
sizeof(hci::UserPasskeyRequestReplyCommandParams));
auto params = packet->mutable_payload<hci::UserPasskeyRequestReplyCommandParams>();
params->bd_addr = bd_addr;
params->numeric_value = htole32(numeric_value);
SendCommandWithStatusCallback(std::move(packet), std::move(cb));
}
void BrEdrConnectionManager::SendUserPasskeyRequestNegativeReply(DeviceAddressBytes bd_addr,
hci::StatusCallback cb) {
auto packet = hci::CommandPacket::New(hci::kUserPasskeyRequestNegativeReply,
sizeof(hci::UserPasskeyRequestNegativeReplyCommandParams));
packet->mutable_payload<hci::UserPasskeyRequestNegativeReplyCommandParams>()->bd_addr = bd_addr;
SendCommandWithStatusCallback(std::move(packet), std::move(cb));
}
void BrEdrConnectionManager::SendCommandWithStatusCallback(
std::unique_ptr<hci::CommandPacket> command_packet, hci::StatusCallback cb) {
hci::CommandChannel::CommandCallback command_cb;
if (cb) {
command_cb = [cb = std::move(cb)](auto, const hci::EventPacket& event) {
cb(event.ToStatus());
};
}
hci_->command_channel()->SendCommand(std::move(command_packet), dispatcher_,
std::move(command_cb));
}
bool BrEdrConnectionManager::InitiatesPairing(PeerId peer_id, BrEdrConnection* connection,
hci::ConnectionHandle handle,
PairingState::StatusCallback pairing_callback) {
if (connection->pairing_state().InitiatePairing(std::move(pairing_callback)) ==
PairingState::InitiatorAction::kSendAuthenticationRequest) {
auto auth_request = hci::CommandPacket::New(hci::kAuthenticationRequested,
sizeof(hci::AuthenticationRequestedCommandParams));
auth_request->mutable_payload<hci::AuthenticationRequestedCommandParams>()->connection_handle =
htole16(handle);
bt_log(SPEW, "gap-bredr", "sending auth request to peer %s", bt_str(peer_id));
hci_->command_channel()->SendCommand(std::move(auth_request), dispatcher_, nullptr);
return true;
}
return false;
}
} // namespace gap
} // namespace bt