Add support for Protected Devices in CLI operations #754
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 tasks
6 tasks
keeramis
force-pushed
the
feature/automatic-service-mode
branch
from
c39a7cc
to
421bc1b
Compare
keeramis
force-pushed
the
feature/automatic-service-mode
branch
from
75dba31
to
29aafdd
Compare
keeramis
changed the title
keeramis
requested review from
monkbroc,
hugomontero,
sergeuz,
wraithan and
Dan-Kouba
and removed request for
Dan-Kouba
keeramis
force-pushed
the
feature/automatic-service-mode
branch
2 times, most recently
from
84e6b36
to
2817a21
Compare
hugomontero
approved these changes
Aug 22, 2024
wraithan
approved these changes
Aug 26, 2024
| return key.makeNewKey({ params: {} }).then(() => { | ||
| expect(utilities.deferredChildProcess).to.have.property('callCount', 3); | ||
| }); | ||
| // TODO: fill these in |
There was a problem hiding this comment.
Was this meant to be completed before merging?
There was a problem hiding this comment.
I left it for a future PR. A lot of these were skipped and I would like to handle this separately because I am not sensing great urgency in fixing these tests. keys commands are used mostly internally by us
keeramis
force-pushed
the
feature/automatic-service-mode
branch
from
cfb0764
to
24e0961
Compare
…y to turn off service mode if needed
keeramis
force-pushed
the
feature/automatic-service-mode
branch
from
24e0961
to
90d80c0
Compare
keeramis
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces support for managing Protected Devices similar to Open Devices. When a device is identified as a Protected Device, CLI puts the device in Service Mode, executes the CLI operation that is run by the user, and re-enables Device Protection on the device (whether the command succeeds or fails).
If the device is in Service Mode, CLI executes the command and enables Device Protection on the device.
A generic wrapper has been implemented to handle both Open and Protected Devices. This wrapper obtains the USB device handle, executes the requested command (e.g.,
particle flash xxx), and, if applicable, handles the transition into Service Mode and re-enables Device Protection after command execution.The output of CLI commands for all device types and platforms remains unchanged, with all handling of Protected Devices occurring seamlessly in the background.
How to Test
Use any device on any platform in any mode (Open / Protected ) and run various CLI commands to ensure proper functionality. Example:
particle flash xxx,particle serial xxx,particle wifi xxxYou can use
particle device-protection --helpto enable Device Protection on your device.Note that if you are testing Protected Devices starting in DFU mode, CLI is expected to fail the command after a 60 sec timeout for devices on device-os 6.1.0 and 6.1.1. Device-OS fixes to handle Protected Devices in DFU mode are deployed in future 6.2.0 (or current develop-6.x branch). Noted here.
Related Issues / Discussions
https://app.shortcut.com/particle/epic/127955
Device Protection Tooling SDD
Completeness