-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
dev_log: log encryption update #3468
Conversation
245b7ed
to
3215733
Compare
Thanks @jnippula Looks great. Because the encryption doc was written after v1.15 but applies previous to v1.13 , this change will remove some useful information on the old approach. I've backported the original doc to v1.15 (should appear soon). YOu could, if you wish, link back to that for the original instructions. I'm going to move this to draft so that I don't accidentally merge it. Can you move it back to live when the linked change in the autopilot happens? |
3215733
to
15940c2
Compare
15940c2
to
e00d7de
Compare
e00d7de
to
af38942
Compare
combined .ulge file instead of separate .ulgc/ulgk files
af38942
to
d21192c
Compare
::: info | ||
The encryption algorithm used is set in [SDLOG_ALGORITHM](../advanced_config/parameter_reference.md#SDLOG_ALGORITHM). | ||
At time of writing, only `XChaCha20` is supported (AES can be selected, but there is no implementation). | ||
::: tip |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI, added this tip to note that the encryption has changed.
en/dev_log/log_encryption.md
Outdated
|
||
Note that both files will be downloaded with the `.ulg` suffix. | ||
You can identify the symmetric key file, as it is usually much smaller than the log file (about 300 bytes) | ||
When decrypting a `.uloge` file the script takes 3 arguments: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI, updated instructions to just be how you do it for uloge - makes things a bit simpler, which is the benefit of this whole approach.
I kept the command line instructions, but pushed them below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just minor comment, the encrypted file extension is .ulge, without the 'o' in the middle.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I fixed that
en/releases/main.md
Outdated
@@ -32,7 +32,10 @@ Please continue reading for [upgrade instructions](#upgrade-guide). | |||
- [Battery level estimation improvements](../config/battery.md) ([PX4-Autopilot#23205](https://github.com/PX4/PX4-Autopilot/pull/23205)). | |||
- [Voltage-based estimation with load compensation](../config/battery.md#voltage-based-estimation-with-load-compensation) now uses a real-time estimate of the internal resistance of the battery to compensate voltage drops under load (with increased current), providing a better capacity estimate than with the raw measured voltage. | |||
- Thrust-based load compensation has been removed (along with the `BATn_V_LOAD_DROP` parameters, where `n` is the battery number). | |||
|
|||
- [Log Encryption](../dev_log/log_encryption.html) now generates an encrypted log that contains the public-key-encrypted symmetric key that can be used to decrypt it, instead of putting the key into a separate file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI, I also added this release note. Doing these as we go along makes the release process much less painful :-)
No flaws found |
Documentation update to have combined .ulge file instead of separate .ulgc/ulgk files