From 03345db36ebcf9603ff6424ab05069d5208ef727 Mon Sep 17 00:00:00 2001 From: Patrik Dominik Pordi <119634185+patrikpordi@users.noreply.github.com> Date: Tue, 8 Apr 2025 18:37:14 -0600 Subject: [PATCH] Added Flight REview for Encrypted logs (#24690) * Added Flight REview for Encrypted logs * Subedit --------- Co-authored-by: Hamish Willee --- docs/en/dev_log/log_encryption.md | 26 +++++++++++++++++++++ docs/en/getting_started/flight_reporting.md | 10 +++++--- 2 files changed, 33 insertions(+), 3 deletions(-) diff --git a/docs/en/dev_log/log_encryption.md b/docs/en/dev_log/log_encryption.md index 9e8f1aeb7b..a2d3122390 100644 --- a/docs/en/dev_log/log_encryption.md +++ b/docs/en/dev_log/log_encryption.md @@ -372,3 +372,29 @@ This section explains how you might manually run the same steps as the script (s ```sh CONFIG_PUBLIC_KEY1="../../../keys/public/public_key.pub" ``` + +## Flight Review & Encrypted logs + +If your logs are secret enough to require encryption it is likely that you will not trust them on the public [Flight Review](../getting_started/flight_reporting.md) server (this is not particularly hardened against data loss or theft). + +::: info +The public [Flight Review](../getting_started/flight_reporting.md) service does not support encrypted logs. +If you wish to use the service you can use the tools here to download and decrypt the files first. +::: + +This section explains how you can host a _private_ instance of the Flight Review server. +This can use logs that you have downloaded and decrypted yourself, or you can include your private key in the server for automatic decryption of logs on upload. + +The steps are: + +1. Follow the Flight Review [installation and setup](https://github.com/PX4/flight_review?tab=readme-ov-file#installation-and-setup) instructions to clone and setup the server. +2. Put your private key in the source code at: `flight_review/app/private_key/private_key.pem` +3. Add this key location into the server config file: `flight_review/app/config_default.ini`. + + The line to add should look something like this (for the file above): + + ```sh + ulge_private_key = ../private_key/private_key.pem + ``` + +4. Follow the Flight Review Instructions to start your server. diff --git a/docs/en/getting_started/flight_reporting.md b/docs/en/getting_started/flight_reporting.md index 9b2670c4ef..23482c5c19 100644 --- a/docs/en/getting_started/flight_reporting.md +++ b/docs/en/getting_started/flight_reporting.md @@ -13,6 +13,11 @@ Logs can be downloaded using [QGroundControl](http://qgroundcontrol.com/): **[An ![Flight Log Download](../../assets/qgc/analyze/log_download.jpg) +::: tip +Encrypted logs cannot be downloaded with QGroundControl, or uploaded to the public Flight Review service. +The easiest way to download and extract encrypted logs is to use the [Log Encryption Tools](../dev_log/log_encryption.md). +You can also host a [private Flight Review server](../dev_log/log_encryption.md#flight-review-encrypted-logs) that automatically decrypts logs on upload using your private key. +::: ## Analyzing the Logs @@ -25,9 +30,9 @@ After upload you'll be emailed a link to the analysis page for the log. There are many other great tools for visualising and analysing PX4 Logs. For more information see: [Flight Analysis](../dev_log/flight_log_analysis.md). ::: - + :::tip -If you have a constant high-rate MAVLink connection to the vehicle (not just a telemetry link) then you can use *QGroundControl* to automatically upload logs directly to *Flight Review*. +If you have a constant high-rate MAVLink connection to the vehicle (not just a telemetry link) then you can use _QGroundControl_ to automatically upload logs directly to _Flight Review_. For more information see [Settings > MAVLink Settings > MAVLink 2 Logging (PX4 only)](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/settings_view/mavlink.html#logging). ::: @@ -35,7 +40,6 @@ For more information see [Settings > MAVLink Settings > MAVLink 2 Logging (PX4 o The [Flight Review](http://logs.px4.io) log file link can be shared for discussion in the [support forums](../contribute/support.md#forums-and-chat) or a [Github issue](../index.md#reporting-bugs-issues). - ## Log Configuration The logging system is configured by default to collect sensible logs for use with [Flight Review](http://logs.px4.io).