feat: add support to resolve MAC address (#792)

* Add support to resolve MAC address

Return the resolved MAC address instead of the random public one

* Changes after sync up with Oguzcan

* fix code review

* new solution

* fix code review

* Add support to return resolve MAC address

Return the resolved MAC address instead of the random one

Author: cassio-lazaro

services/ble/Gap.cpp

@@ -84,6 +84,11 @@ namespace services
         return GapBondingObserver::Subject().GetNumberOfBonds();
     }
 
+    bool GapBondingDecorator::IsDeviceBonded(hal::MacAddress address, GapDeviceAddressType addressType) const
+    {
+        return GapBondingObserver::Subject().IsDeviceBonded(address, addressType);
+    }
+
     void GapPeripheralDecorator::StateChanged(GapState state)
     {
         GapPeripheral::NotifyObservers([&state](auto& obs)
@@ -178,6 +183,11 @@ namespace services
         GapCentralObserver::Subject().StopDeviceDiscovery();
     }
 
+    infra::Optional<hal::MacAddress> GapCentralDecorator::ResolvePrivateAddress(hal::MacAddress address) const
+    {
+        return GapCentralObserver::Subject().ResolvePrivateAddress(address);
+    }
+
     GapAdvertisingDataParser::GapAdvertisingDataParser(infra::ConstByteRange data)
         : data(data)
     {}
@@ -242,16 +252,12 @@ namespace infra
         return stream;
     }
 
-    TextOutputStream& operator<<(TextOutputStream& stream, const services::GapAdvertisingEventAddressType& addressType)
+    TextOutputStream& operator<<(TextOutputStream& stream, const services::GapDeviceAddressType& addressType)
     {
-        if (addressType == services::GapAdvertisingEventAddressType::publicDeviceAddress)
+        if (addressType == services::GapDeviceAddressType::publicAddress)
             stream << "Public Device Address";
-        else if (addressType == services::GapAdvertisingEventAddressType::randomDeviceAddress)
-            stream << "Random Device Address";
-        else if (addressType == services::GapAdvertisingEventAddressType::publicIdentityAddress)
-            stream << "Public Identity Address";
         else
-            stream << "Random Identity Address";
+            stream << "Random Device Address";
 
         return stream;
     }

services/ble/Gap.hpp

@@ -7,7 +7,7 @@
 #include "infra/util/ByteRange.hpp"
 #include "infra/util/EnumCast.hpp"
 #include "infra/util/Observer.hpp"
-#include <array>
+#include "infra/util/Optional.hpp"
 
 namespace services
 {
@@ -41,14 +41,6 @@ namespace services
         scanResponse,
     };
 
-    enum class GapAdvertisingEventAddressType : uint8_t
-    {
-        publicDeviceAddress,
-        randomDeviceAddress,
-        publicIdentityAddress,
-        randomIdentityAddress
-    };
-
     enum class GapAdvertisementDataType : uint8_t
     {
         unknownType = 0x00u,
@@ -201,6 +193,7 @@ namespace services
 
         virtual std::size_t GetMaxNumberOfBonds() const = 0;
         virtual std::size_t GetNumberOfBonds() const = 0;
+        virtual bool IsDeviceBonded(hal::MacAddress address, GapDeviceAddressType addressType) const = 0;
     };
 
     class GapBondingDecorator
@@ -218,6 +211,7 @@ namespace services
         void RemoveOldestBond() override;
         std::size_t GetMaxNumberOfBonds() const override;
         std::size_t GetNumberOfBonds() const override;
+        bool IsDeviceBonded(hal::MacAddress address, GapDeviceAddressType addressType) const override;
     };
 
     class GapPeripheral;
@@ -292,7 +286,7 @@ namespace services
     struct GapAdvertisingReport
     {
         GapAdvertisingEventType eventType;
-        GapAdvertisingEventAddressType addressType;
+        GapDeviceAddressType addressType;
         hal::MacAddress address;
         infra::BoundedVector<uint8_t>::WithMaxSize<GapPeripheral::maxAdvertisementDataSize> data;
         int32_t rssi;
@@ -320,6 +314,7 @@ namespace services
         virtual void SetAddress(hal::MacAddress macAddress, GapDeviceAddressType addressType) = 0;
         virtual void StartDeviceDiscovery() = 0;
         virtual void StopDeviceDiscovery() = 0;
+        virtual infra::Optional<hal::MacAddress> ResolvePrivateAddress(hal::MacAddress address) const = 0;
     };
 
     class GapCentralDecorator
@@ -340,13 +335,14 @@ namespace services
         void SetAddress(hal::MacAddress macAddress, GapDeviceAddressType addressType) override;
         void StartDeviceDiscovery() override;
         void StopDeviceDiscovery() override;
+        infra::Optional<hal::MacAddress> ResolvePrivateAddress(hal::MacAddress address) const override;
     };
 }
 
 namespace infra
 {
     infra::TextOutputStream& operator<<(infra::TextOutputStream& stream, const services::GapAdvertisingEventType& eventType);
-    infra::TextOutputStream& operator<<(infra::TextOutputStream& stream, const services::GapAdvertisingEventAddressType& addressType);
+    infra::TextOutputStream& operator<<(infra::TextOutputStream& stream, const services::GapDeviceAddressType& addressType);
     infra::TextOutputStream& operator<<(infra::TextOutputStream& stream, const services::GapState& state);
 }
 

services/ble/Gap.proto

@@ -112,11 +112,16 @@ message AdvertisementData
     bytes data = 1 [(bytes_size) = 31];
 }
 
-message ConnectionParameters
+message PeerNodeParameters
 {
     Address address = 1;
     AddressType addressType = 2;
-    uint32 initiatingTimeoutInMs = 3;
+}
+
+message ConnectionParameters
+{
+    PeerNodeParameters peerParameters = 1;
+    uint32 initiatingTimeoutInMs = 2;
 }
 
 message Passkey
@@ -193,6 +198,7 @@ service GapPeripheral
 
     // Allowed states: advertising
     rpc GetResolvableAddress(Nothing) returns (Nothing) { option (method_id) = 9; }
+    rpc GetIdentityAddress(Nothing) returns (Nothing) { option (method_id) = 10; }
 }
 
 service GapCentral
@@ -225,6 +231,8 @@ service GapCentral
     rpc NumericComparisonConfirm(BoolValue) returns (Nothing) { option (method_id) = 10; }
     rpc RemoveAllBonds(Nothing) returns (Nothing) { option (method_id) = 11; }
     rpc SetDeviceDiscoveryFilter(DeviceDiscoveryFilter) returns (Nothing) { option (method_id) = 12; }
+    rpc ResolvePrivateAddress(Address) returns (Nothing) { option (method_id) = 13; }
+    rpc IsDeviceBonded(PeerNodeParameters) returns (Nothing) { option (method_id) = 14; }
 }
 
 service GapPeripheralResponse
@@ -236,6 +244,7 @@ service GapPeripheralResponse
     rpc StateChanged(State) returns (Nothing) { option (method_id) = 3; }
     rpc ResolvableAddress(Address) returns (Nothing) { option (method_id) = 4; }
     rpc DisplayPasskey(Passkey) returns (Nothing) { option (method_id) = 5; }
+    rpc IdentityAddress(Address) returns (Nothing) { option (method_id) = 6; }
 }
 
 service GapCentralResponse
@@ -249,4 +258,7 @@ service GapCentralResponse
     rpc PairingFailed(PairingStatus) returns (Nothing) { option (method_id) = 5; }
     rpc NumberOfBondsChanged(UInt32Value) returns (Nothing) { option (method_id) = 6; }
     rpc DeviceStarted(Nothing) returns (Nothing) { option (method_id) = 7; }
+    rpc ResolvedPrivateAddress(Address) returns (Nothing) { option (method_id) = 8; }
+    rpc ResolvePrivateAddressFailed(Nothing) returns (Nothing) { option (method_id) = 9; }
+    rpc DeviceBonded(BoolValue) returns (Nothing) { option (method_id) = 10; }
 }

services/ble/test/TestGapBonding.cpp

@@ -41,5 +41,14 @@ namespace services
 
         EXPECT_CALL(gapBonding, GetNumberOfBonds()).WillOnce(testing::Return(5));
         EXPECT_EQ(decorator.GetNumberOfBonds(), 5);
+
+        hal::MacAddress mac = { 0x00, 0x1A, 0x7D, 0xDA, 0x71, 0x13 };
+        services::GapDeviceAddressType addressType = services::GapDeviceAddressType::randomAddress;
+
+        EXPECT_CALL(gapBonding, IsDeviceBonded(mac, addressType)).WillOnce(testing::Return(true));
+        EXPECT_THAT(decorator.IsDeviceBonded(mac, addressType), testing::IsTrue());
+
+        EXPECT_CALL(gapBonding, IsDeviceBonded(mac, addressType)).WillOnce(testing::Return(false));
+        EXPECT_THAT(decorator.IsDeviceBonded(mac, addressType), testing::IsFalse());
     }
 }

services/ble/test/TestGapCentral.cpp

@@ -5,7 +5,6 @@
 #include "services/ble/test_doubles/GapCentralMock.hpp"
 #include "services/ble/test_doubles/GapCentralObserverMock.hpp"
 #include "gmock/gmock.h"
-#include <chrono>
 
 namespace services
 {
@@ -49,7 +48,7 @@ namespace services
 
     TEST_F(GapCentralDecoratorTest, forward_device_discovered_event_to_observers)
     {
-        GapAdvertisingReport deviceDiscovered{ GapAdvertisingEventType::advInd, GapAdvertisingEventAddressType::publicDeviceAddress, hal::MacAddress{ 0, 1, 2, 3, 4, 5 }, infra::BoundedVector<uint8_t>::WithMaxSize<GapPeripheral::maxAdvertisementDataSize>{}, -75 };
+        GapAdvertisingReport deviceDiscovered{ GapAdvertisingEventType::advInd, GapDeviceAddressType::publicAddress, hal::MacAddress{ 0, 1, 2, 3, 4, 5 }, infra::BoundedVector<uint8_t>::WithMaxSize<GapPeripheral::maxAdvertisementDataSize>{}, -75 };
 
         EXPECT_CALL(gapObserver, DeviceDiscovered(ObjectContentsEqual(deviceDiscovered)));
 
@@ -80,6 +79,13 @@ namespace services
 
         EXPECT_CALL(gap, StopDeviceDiscovery());
         decorator.StopDeviceDiscovery();
+
+        hal::MacAddress mac = { 0x00, 0x1A, 0x7D, 0xDA, 0x71, 0x13 };
+        EXPECT_CALL(gap, ResolvePrivateAddress(mac)).WillOnce(testing::Return(infra::none));
+        EXPECT_EQ(decorator.ResolvePrivateAddress(mac), infra::none);
+
+        EXPECT_CALL(gap, ResolvePrivateAddress(mac)).WillOnce(testing::Return(infra::MakeOptional(mac)));
+        EXPECT_EQ(decorator.ResolvePrivateAddress(mac), mac);
     }
 
     TEST(GapAdvertisingDataParserTest, payload_too_small)
@@ -167,14 +173,11 @@ namespace services
     {
         infra::StringOutputStream::WithStorage<128> stream;
 
-        services::GapAdvertisingEventAddressType eventAddressTypePublicDevice = services::GapAdvertisingEventAddressType::publicDeviceAddress;
-        services::GapAdvertisingEventAddressType eventAddressTypeRandomDevice = services::GapAdvertisingEventAddressType::randomDeviceAddress;
-        services::GapAdvertisingEventAddressType eventAddressTypePublicIdentity = services::GapAdvertisingEventAddressType::publicIdentityAddress;
-        services::GapAdvertisingEventAddressType eventAddressTypeRandomIdentity = services::GapAdvertisingEventAddressType::randomIdentityAddress;
-
-        stream << eventAddressTypePublicDevice << " " << eventAddressTypeRandomDevice << " " << eventAddressTypePublicIdentity << " " << eventAddressTypeRandomIdentity;
+        services::GapDeviceAddressType eventAddressTypePublicDevice = services::GapDeviceAddressType::publicAddress;
+        services::GapDeviceAddressType eventAddressTypeRandomDevice = services::GapDeviceAddressType::randomAddress;
+        stream << eventAddressTypePublicDevice << " " << eventAddressTypeRandomDevice;
 
-        EXPECT_EQ("Public Device Address Random Device Address Public Identity Address Random Identity Address", stream.Storage());
+        EXPECT_EQ("Public Device Address Random Device Address", stream.Storage());
     }
 
     TEST(GapInsertionOperatorStateTest, state_overload_operator)

services/ble/test_doubles/GapBondingMock.hpp

@@ -14,6 +14,7 @@ namespace services
         MOCK_METHOD(void, RemoveOldestBond, ());
         MOCK_METHOD(std::size_t, GetMaxNumberOfBonds, (), (const));
         MOCK_METHOD(std::size_t, GetNumberOfBonds, (), (const));
+        MOCK_METHOD(bool, IsDeviceBonded, (hal::MacAddress deviceAddress, GapDeviceAddressType addressType), (const));
     };
 }
 

services/ble/test_doubles/GapCentralMock.hpp

@@ -16,6 +16,7 @@ namespace services
         MOCK_METHOD(void, SetAddress, (hal::MacAddress macAddress, GapDeviceAddressType addressType));
         MOCK_METHOD(void, StartDeviceDiscovery, ());
         MOCK_METHOD(void, StopDeviceDiscovery, ());
+        MOCK_METHOD(infra::Optional<hal::MacAddress>, ResolvePrivateAddress, (hal::MacAddress address), (const));
     };
 }