Skip to content

feat: adding new modes to gappairing for future enhancements in secureconnections #912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

feat: adding new modes to gappairing for future enhancements in secureconnections #912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
a417192
Work towards improving pairing security requirements
XavierBernhardt-Philips Jun 2, 2025
645ebe1
Better enum naming for ConnectionMode and ManInTheMiddleMode
MiquelJayson-Philips Jun 6, 2025
f470d63
Renamed notRequired to Disabled
MiquelJayson-Philips Jun 6, 2025
f3e8678
Rename values in SecureConnectionMode enum
MiquelJayson-Philips Jun 13, 2025
3adc019
Refactoring SecureConnectionMode and MITMMODE into 2 functions
XavierBernhardt-Philips Jun 16, 2025
5afb95c
refactoring
XavierBernhardt-Philips Jun 18, 2025
1e16bc3
Merge branch 'main' into feature/pairing-security-requirements
XavierBernhardt-Philips Jun 18, 2025
1459c1d
fixed compile error
XavierBernhardt-Philips Jun 18, 2025
4199635
Removed bracket
MiquelJayson-Philips Jun 19, 2025
6cad9a7
Merge commit 'c20c83ea909ca2e1a7ef8a07bb5cfe91144bf3a7'
XavierBernhardt-Philips Jul 2, 2025
76a781c
revert changes to gap
MiquelJayson-Philips Jul 14, 2025
18f12a1
Merge branch 'main' into feature/156620_revert_gap_sc
MiquelJayson-Philips Jul 16, 2025
d6edad6
cleanup
MiquelJayson-Philips Jul 17, 2025
eb79daa
cleanup
MiquelJayson-Philips Jul 17, 2025
ebeec25
pr comments
MiquelJayson-Philips Jul 24, 2025
143ec43
Update SetSecurityMode to include new SC and MITM
MiquelJayson-Philips Jul 24, 2025
6da3197
update mock
MiquelJayson-Philips Jul 24, 2025
330a9aa
add not supported mitm mode
MiquelJayson-Philips Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions services/ble/Gap.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ namespace services
GapPairingObserver::Subject().AllowPairing(allow);
}

void GapPairingDecorator::SetSecurityMode(SecurityMode mode, SecurityLevel level)
void GapPairingDecorator::SetSecurityMode(services::GapPairing::SecureConnectionMode secureConnectionMode, services::GapPairing::ManInTheMiddleMode mitmMode)
{
GapPairingObserver::Subject().SetSecurityMode(mode, level);
GapPairingObserver::Subject().SetSecurityMode(secureConnectionMode, mitmMode);
}

void GapPairingDecorator::SetIoCapabilities(IoCapabilities caps)
Expand Down
21 changes: 16 additions & 5 deletions services/ble/Gap.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,13 +128,24 @@ namespace services
level4,
};

virtual void Pair() = 0;
enum class SecureConnectionMode : uint8_t
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we have the same three options for mitm and secureconnections:
notSupported,
supported,
enforced,

For some vendors, such as ST, we might not have the implementation for all combinations, which is fine.

{
notSupported,
supported,
enforced,
};

virtual void AllowPairing(bool allow) = 0;
enum class ManInTheMiddleMode : uint8_t
{
disabled,
enforced,
notSupported
};

virtual void SetSecurityMode(SecurityMode mode, SecurityLevel level) = 0;
virtual void Pair() = 0;
virtual void AllowPairing(bool allow) = 0;
virtual void SetSecurityMode(SecureConnectionMode secureConnectionMode, ManInTheMiddleMode mitmMode) = 0;
virtual void SetIoCapabilities(IoCapabilities caps) = 0;

virtual void AuthenticateWithPasskey(uint32_t passkey) = 0;
virtual void NumericComparisonConfirm(bool accept) = 0;
};
Expand All @@ -154,7 +165,7 @@ namespace services
// Implementation of GapPairing
void Pair() override;
void AllowPairing(bool allow) override;
void SetSecurityMode(SecurityMode mode, SecurityLevel level) override;
void SetSecurityMode(services::GapPairing::SecureConnectionMode secureConnectionMode, services::GapPairing::ManInTheMiddleMode mitmMode) override;
void SetIoCapabilities(IoCapabilities caps) override;
void AuthenticateWithPasskey(uint32_t passkey) override;
void NumericComparisonConfirm(bool accept) override;
Expand Down
27 changes: 13 additions & 14 deletions services/ble/Gap.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,24 +70,23 @@ message AdvertisementType
AdvertisementTypeEnum type = 1;
}

message SecurityModeAndLevel
message SecureConnectionAndManInTheMiddleMode
{
enum SecurityLevelEnum
enum SecureConnectionModeEnum
{
none = 0;
unauthenticatedPairing = 1;
authenticatedPairing = 2;
authenticatedPairingWithLE = 3;
notSupported = 0;
supported = 1;
enforced = 2;
}

enum SecurityModeEnum
enum ManInTheMiddleModeEnum
{
mode1 = 0;
mode2 = 1;
disabledMode = 0;
enforcedMode = 1;
notSupportedMode = 2;
}

SecurityModeEnum mode = 1;
SecurityLevelEnum level = 2;
SecureConnectionModeEnum secureConnectionMode = 1;
ManInTheMiddleModeEnum mitmMode = 2;
}

message AddressType
Expand Down Expand Up @@ -192,9 +191,9 @@ service GapPeripheral
rpc SetAdvertisementData(AdvertisementData) returns (Nothing) { option (method_id) = 3; }
rpc SetScanResponseData(AdvertisementData) returns (Nothing) { option (method_id) = 4; }
rpc SetAllowPairing(BoolValue) returns (Nothing) { option (method_id) = 5; }
rpc SetSecurityMode(SecurityModeAndLevel) returns (Nothing) { option (method_id) = 6; }
rpc SetIoCapabilities(IoCapabilities) returns (Nothing) { option (method_id) = 7; }
rpc RemoveAllBonds(Nothing) returns (Nothing) { option (method_id) = 8; }
rpc SetSecurityMode(SecureConnectionAndManInTheMiddleMode) returns (Nothing) { option (method_id) = 11; }

// Allowed states: advertising
rpc GetResolvableAddress(Nothing) returns (Nothing) { option (method_id) = 9; }
Expand Down Expand Up @@ -225,14 +224,14 @@ service GapCentral
// Allowed states: connected
rpc Pair(Nothing) returns (Nothing) { option (method_id) = 6; }

rpc SetSecurityMode(SecurityModeAndLevel) returns (Nothing) { option (method_id) = 7; }
rpc SetIoCapabilities(IoCapabilities) returns (Nothing) { option (method_id) = 8; }
rpc AuthenticateWithPasskey(UInt32Value) returns (Nothing) { option (method_id) = 9; }
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; }
rpc SetSecurityMode(SecureConnectionAndManInTheMiddleMode) returns (Nothing) { option (method_id) = 15; }
}

service GapPeripheralResponse
Expand Down
2 changes: 1 addition & 1 deletion services/ble/test_doubles/GapPairingMock.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ namespace services
public:
MOCK_METHOD(void, Pair, ());
MOCK_METHOD(void, AllowPairing, (bool allow));
MOCK_METHOD(void, SetSecurityMode, (SecurityMode mode, SecurityLevel level));
MOCK_METHOD(void, SetSecurityMode, (SecureConnectionMode secureConnectionMode, ManInTheMiddleMode mitmMode));
MOCK_METHOD(void, SetIoCapabilities, (IoCapabilities caps));
MOCK_METHOD(void, AuthenticateWithPasskey, (uint32_t passkey));
MOCK_METHOD(void, NumericComparisonConfirm, (bool accept));
Expand Down
Loading