Skip to content
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.

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

Fix DevicePairingDelegate::OnPairingComplete is not called if pairing code is wrong #36139

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

evg-trushkin
Copy link

Only the DevicePairingDelegate::OnStatusUpdate(Status::SecurePairingFailed) callback will be called in case of pairing device with wrong manual code. The signature of OnStatusUpdate() does not include CHIP_ERROR.

Seems that the correct behavior is to call DevicePairingDelegate::OnPairingComplete(error) as well.
Error will likely hold CHIP Error 0x00000032: Timeout.

This way looking at OnPairingComplete, OnCommissioningSuccess and OnCommissioningFailure is enough to keep track on commissioning process. And all of them provide CHIP_ERROR for diagnostics.

Copy link

Review changes with SemanticDiff.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Evgeny Trushkin seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

github-actions bot commented Oct 18, 2024

PR #36139: Size comparison from 2574847 to 9607577

Full report (79 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
platform target config section 2574847 9607577 change % change
bl602 lighting-app bl602+mfd+littlefs+rpc FLASH 1350008 1350008 0 0.0
RAM 104120 104120 0 0.0
bl702 lighting-app bl702+eth FLASH 647788 647788 0 0.0
RAM 25233 25233 0 0.0
bl702+wifi FLASH 825274 825274 0 0.0
RAM 13965 13965 0 0.0
bl706+mfd+rpc+littlefs FLASH 1054200 1054200 0 0.0
RAM 23821 23821 0 0.0
bl702l lighting-app bl702l+mfd+littlefs FLASH 975048 975048 0 0.0
RAM 16468 16468 0 0.0
cc13x4_26x4 lighting-app LP_EM_CC1354P10_6 FLASH 829564 829564 0 0.0
RAM 123452 123452 0 0.0
lock-ftd LP_EM_CC1354P10_6 FLASH 814872 814872 0 0.0
RAM 125332 125332 0 0.0
pump-app LP_EM_CC1354P10_6 FLASH 761460 761460 0 0.0
RAM 113824 113824 0 0.0
pump-controller-app LP_EM_CC1354P10_6 FLASH 745704 745704 0 0.0
RAM 114016 114016 0 0.0
cc32xx air-purifier CC3235SF_LAUNCHXL FLASH 617258 617258 0 0.0
RAM 205908 205908 0 0.0
lock CC3235SF_LAUNCHXL FLASH 657306 657306 0 0.0
RAM 206060 206060 0 0.0
cyw30739 light CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 678589 678589 0 0.0
RAM 78668 78668 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 698433 698433 0 0.0
RAM 81300 81300 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 698433 698433 0 0.0
RAM 81300 81300 0 0.0
CYW930739M2EVB-02 unknown 2040 2040 0 0.0
FLASH 655377 655377 0 0.0
RAM 73736 73736 0 0.0
light-switch CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 614933 614933 0 0.0
RAM 71628 71628 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 634569 634569 0 0.0
RAM 74180 74180 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 634569 634569 0 0.0
RAM 74180 74180 0 0.0
lock CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 634213 634213 0 0.0
RAM 74676 74676 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 653921 653921 0 0.0
RAM 77228 77228 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 653921 653921 0 0.0
RAM 77228 77228 0 0.0
thermostat CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 609525 609525 0 0.0
RAM 68764 68764 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 629385 629385 0 0.0
RAM 71396 71396 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 629385 629385 0 0.0
RAM 71396 71396 0 0.0
efr32 lock-app BRD4187C FLASH 925248 925248 0 0.0
RAM 159708 159708 0 0.0
BRD4338a FLASH 741432 741424 -8 -0.0
RAM 231008 231008 0 0.0
window-app BRD4187C FLASH 1018236 1018236 0 0.0
RAM 128052 128052 0 0.0
esp32 all-clusters-app c3devkit DRAM 95256 95256 0 0.0
FLASH 1539960 1539960 0 0.0
IRAM 82538 82538 0 0.0
m5stack DRAM 116192 116192 0 0.0
FLASH 1550166 1550166 0 0.0
IRAM 117039 117039 0 0.0
linux air-purifier-app debug unknown 4688 4688 0 0.0
FLASH 2781371 2781371 0 0.0
RAM 129520 129520 0 0.0
all-clusters-app debug unknown 5528 5528 0 0.0
FLASH 6092494 6092494 0 0.0
RAM 524000 524000 0 0.0
all-clusters-minimal-app debug unknown 5424 5424 0 0.0
FLASH 5423070 5423070 0 0.0
RAM 242416 242416 0 0.0
bridge-app debug unknown 5408 5408 0 0.0
FLASH 4752000 4752000 0 0.0
RAM 218384 218384 0 0.0
chip-tool debug unknown 5960 5960 0 0.0
FLASH 13162792 13162892 100 0.0
RAM 584562 584562 0 0.0
chip-tool-ipv6only arm64 unknown 21408 21408 0 0.0
FLASH 11721136 11721216 80 0.0
RAM 635488 635488 0 0.0
fabric-admin debug unknown 5792 5792 0 0.0
FLASH 1139087 11390971 100 0.0
RAM 584954 584954 0 0.0
fabric-bridge-app debug unknown 4632 4632 0 0.0
FLASH 4578396 4578396 0 0.0
RAM 205336 205336 0 0.0
lighting-app debug+rpc+ui unknown 6056 6056 0 0.0
FLASH 5693921 5693921 0 0.0
RAM 228488 228488 0 0.0
lock-app debug unknown 5344 5344 0 0.0
FLASH 4801546 4801546 0 0.0
RAM 204472 204472 0 0.0
ota-provider-app debug unknown 4720 4720 0 0.0
FLASH 4430928 4430928 0 0.0
RAM 198192 198192 0 0.0
ota-requestor-app debug unknown 4656 4656 0 0.0
FLASH 4569694 4569694 0 0.0
RAM 202760 202760 0 0.0
shell debug unknown 4216 4216 0 0.0
FLASH 3115997 3115997 0 0.0
RAM 160368 160368 0 0.0
thermostat-no-ble arm64 unknown 9448 9448 0 0.0
FLASH 4319968 4319968 0 0.0
RAM 242896 242896 0 0.0
tv-app debug unknown 5624 5624 0 0.0
FLASH 6032021 6032117 96 0.0
RAM 596416 596416 0 0.0
tv-casting-app debug unknown 5208 5208 0 0.0
FLASH 11367981 11367981 0 0.0
RAM 675936 675936 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 FLASH 915528 915528 0 0.0
RAM 143357 143357 0 0.0
nrf7002dk_nrf5340_cpuapp FLASH 885992 885992 0 0.0
RAM 141496 141496 0 0.0
all-clusters-minimal-app nrf52840dk_nrf52840 FLASH 848936 848936 0 0.0
RAM 142265 142265 0 0.0
nxp contact k32w0+release FLASH 582296 582296 0 0.0
RAM 70948 70948 0 0.0
mcxw71+release FLASH 596928 596928 0 0.0
RAM 63184 63184 0 0.0
light k32w0+release FLASH 618932 618932 0 0.0
RAM 70412 70412 0 0.0
k32w1+release FLASH 683160 683160 0 0.0
RAM 48816 48816 0 0.0
lock mcxw71+release FLASH 705552 705552 0 0.0
RAM 67324 67324 0 0.0
psoc6 all-clusters cy8ckit_062s2_43012 FLASH 1647604 1647604 0 0.0
RAM 212408 212408 0 0.0
all-clusters-minimal cy8ckit_062s2_43012 FLASH 1553684 1553684 0 0.0
RAM 209208 209208 0 0.0
light cy8ckit_062s2_43012 FLASH 1468004 1468004 0 0.0
RAM 201200 201200 0 0.0
lock cy8ckit_062s2_43012 FLASH 1464980 1464980 0 0.0
RAM 225560 225560 0 0.0
qpg lighting-app qpg6105+debug FLASH 660600 660600 0 0.0
RAM 105396 105396 0 0.0
lock-app qpg6105+debug FLASH 618612 618612 0 0.0
RAM 99864 99864 0 0.0
stm32 light STM32WB5MM-DK FLASH 481936 481936 0 0.0
RAM 144844 144844 0 0.0
telink air-quality-sensor-app tlsr9528a_retention FLASH 621050 621050 0 0.0
RAM 50648 50648 0 0.0
all-clusters-app tlsr9118bdk40d FLASH 689468 689468 0 0.0
RAM 149492 149492 0 0.0
all-clusters-minimal-app tlsr9528a FLASH 782434 782434 0 0.0
RAM 111440 111440 0 0.0
bridge-app tlsr9258a FLASH 681164 681164 0 0.0
RAM 91304 91304 0 0.0
contact-sensor-app tlsr9528a_retention FLASH 620814 620814 0 0.0
RAM 50600 50600 0 0.0
light-switch-app-ota-shell-factory-data tlsr9528a FLASH 708794 708794 0 0.0
RAM 73940 73940 0 0.0
lighting-app-ota-factory-data tlsr9118bdk40d FLASH 625764 625764 0 0.0
RAM 144468 144468 0 0.0
lighting-app-ota-rpc-factory-data-4mb tlsr9518adk80d FLASH 811772 811772 0 0.0
RAM 99100 99100 0 0.0
lock-app-dfu tlsr9528a FLASH 656720 656720 0 0.0
RAM 66660 66660 0 0.0
ota-requestor-app tlsr9258a FLASH 697142 697142 0 0.0
RAM 90896 90896 0 0.0
pump-app-usb tlsr9518adk80d FLASH 634452 634452 0 0.0
RAM 55476 55476 0 0.0
pump-controller-app tlsr9518adk80d FLASH 611650 611650 0 0.0
RAM 52720 52720 0 0.0
shell tlsr9518adk80d FLASH 467872 467872 0 0.0
RAM 68168 68168 0 0.0
smoke_co_alarm-app tlsr9528a_retention FLASH 627964 627964 0 0.0
RAM 52320 52320 0 0.0
temperature-measurement-app-mars-ota tlsr9518adk80d FLASH 653782 653782 0 0.0
RAM 56268 56268 0 0.0
thermostat tlsr9518adk80d FLASH 638392 638392 0 0.0
RAM 53112 53112 0 0.0
window-covering tlsr9118bdk40d FLASH 524508 524508 0 0.0
RAM 97444 97444 0 0.0
tizen all-clusters-app arm unknown 4912 4912 0 0.0
FLASH 1729608 1729608 0 0.0
RAM 90108 90108 0 0.0
chip-tool-ubsan arm unknown 10792 10792 0 0.0
FLASH 18329494 18329574 80 0.0
RAM 7970692 7970712 20 0.0

mPairingDelegate->OnPairingComplete(status);
}
}
if (CHIP_NO_ERROR != status && mPairingDelegate != nullptr)
Copy link
Contributor

Choose a reason for hiding this comment

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

The actual behavior here is very complicated (e.g. if your pairing code is right but the device is not advertising that's the same situation as wrong pairing code!), and worse yet existing clients depend on it, so probably cannot be changed without breaking lots of shipping software.

The right answer here is that we should have a sane error reporting API, not what we have right now, but we should be extremely careful about any changes to the existing behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants