Skip to content

feat: improve pairing security requirements #884

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

Draft
Xavier Bernhardt (XavierBernhardt-Philips) wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

feat: improve pairing security requirements #884

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 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
64afd43
Merge branch 'main' into feature/pairing-security-requirements
XavierBernhardt-Philips Jul 10, 2025
e58827f
Merge branch 'main' into feature/pairing-security-requirements
XavierBernhardt-Philips Jul 22, 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 @@ -36,9 +36,9 @@ namespace services
GapPairingObserver::Subject().AllowPairing(allow);
}

void GapPairingDecorator::SetSecurityMode(SecurityMode mode, SecurityLevel level)
void GapPairingDecorator::SetSecurityRequirements(ConnectionMode connectionMode, ManInTheMiddleMode mitmMode)
{
GapPairingObserver::Subject().SetSecurityMode(mode, level);
GapPairingObserver::Subject().SetSecurityRequirements(connectionMode, mitmMode);
}

void GapPairingDecorator::SetIoCapabilities(IoCapabilities caps)
Expand Down
20 changes: 17 additions & 3 deletions services/ble/Gap.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,25 @@ namespace services
level4,
};

virtual void Pair() = 0;
enum class ConnectionMode
{
legacyOnly = 0,
secureIfSupported = 1, // Fallback to legacy if secure is not supported
secureOnly = 2,
};

enum class ManInTheMiddleMode
{
disabled = 0,
enabled = 1, // Require user to act as out of band authentication
};

virtual void
Pair() = 0;
Comment on lines +145 to +146
Copy link
Contributor

@EkelmansPh EkelmansPh Aug 5, 2025

Choose a reason for hiding this comment

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

Suggested change
virtual void
Pair() = 0;
virtual void Pair() = 0;


virtual void AllowPairing(bool allow) = 0;

virtual void SetSecurityMode(SecurityMode mode, SecurityLevel level) = 0;
virtual void SetSecurityRequirements(ConnectionMode connectionMode, ManInTheMiddleMode mitmMode) = 0;
virtual void SetIoCapabilities(IoCapabilities caps) = 0;

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

message SecurityRequirements {
enum SecureConnectionModeEnum
{
legacyOnly = 0;
secureIfSupported = 1; // Fallback to legacy if secure is not supported
secureOnly = 2;
}

enum ManInTheMiddleModeEnum
{
disabled = 0;
enabled = 1; // Require user to act as out of band authentication
}

SecureConnectionModeEnum connectionMode = 1; // TODO: check if these values are correct
ManInTheMiddleModeEnum mitmMode = 2;
}

message SecurityModeAndLevel
{
enum SecurityLevelEnum
Expand Down Expand Up @@ -192,7 +210,7 @@ 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 SetSecurityRequirements(SecurityRequirements) returns (Nothing) { option (method_id) = 6; }
rpc SetIoCapabilities(IoCapabilities) returns (Nothing) { option (method_id) = 7; }
rpc RemoveAllBonds(Nothing) returns (Nothing) { option (method_id) = 8; }

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

rpc SetSecurityMode(SecurityModeAndLevel) returns (Nothing) { option (method_id) = 7; }
rpc SetSecurityRequirements(SecurityRequirements) 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; }
Expand Down
4 changes: 2 additions & 2 deletions services/ble/test/TestGapPairing.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ namespace services
EXPECT_CALL(gapPairing, AllowPairing(::testing::IsTrue()));
decorator.AllowPairing(true);

EXPECT_CALL(gapPairing, SetSecurityMode(::testing::TypedEq<services::GapPairing::SecurityMode>(services::GapPairing::SecurityMode::mode1), ::testing::TypedEq<services::GapPairing::SecurityLevel>(services::GapPairing::SecurityLevel::level1)));
decorator.SetSecurityMode(services::GapPairing::SecurityMode::mode1, services::GapPairing::SecurityLevel::level1);
EXPECT_CALL(gapPairing, SetSecurityRequirements(::testing::TypedEq<services::GapPairing::ConnectionMode>(services::GapPairing::ConnectionMode::legacyOnly), ::testing::TypedEq<services::GapPairing::ManInTheMiddleMode>(services::GapPairing::ManInTheMiddleMode::disabled)));
decorator.SetSecurityRequirements(services::GapPairing::ConnectionMode::legacyOnly, services::GapPairing::ManInTheMiddleMode::disabled);

EXPECT_CALL(gapPairing, SetIoCapabilities(::testing::TypedEq<services::GapPairing::IoCapabilities>(services::GapPairing::IoCapabilities::none)));
decorator.SetIoCapabilities(services::GapPairing::IoCapabilities::none);
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, SetSecurityRequirements, (ConnectionMode connectionMode, ManInTheMiddleMode mitmMode));
MOCK_METHOD(void, SetIoCapabilities, (IoCapabilities caps));
MOCK_METHOD(void, AuthenticateWithPasskey, (uint32_t passkey));
MOCK_METHOD(void, NumericComparisonConfirm, (bool accept));
Expand Down
Loading