Skip to content

feat(audit): add legend to help text, explaining status meanings#1090

Merged
RoyalOughtness merged 2 commits intosecureblue:livefrom
HastD:audit-legend
Jun 1, 2025
Merged

feat(audit): add legend to help text, explaining status meanings#1090
RoyalOughtness merged 2 commits intosecureblue:livefrom
HastD:audit-legend

Conversation

@HastD
Copy link
Copy Markdown
Collaborator

@HastD HastD commented May 31, 2025

Closes issue #1086. The help text can be viewed by running ujust audit-secureblue --help. Also fixes one status that was missed with the change in #1085.

For reference, this is what the help text looks like as written in this PR:
Screenshot of the help text. Image transcription follows.

A transcription of the above image follows (note that in the actual help text, the status indicators are displayed in the same colors as when the audit script is run):

usage: ujust audit-secureblue [-h] [-s SKIP] [-j]

Audit secureblue configuration for security

options:
  -h, --help       show this help message and exit
  -s, --skip SKIP  skip categories (flatpak,kargs)
  -j, --json       display output as JSON

The following status indicators accompany checks run by the audit script:

[FAIL]: check failed - the configuration may be less secure.
[WARN]: partial failure, or less significant issue detected.
[PASS]: check passed - no problems detected.
[UNKNOWN]: unable to perform check (usually due to a file permission issue).

For flatpak checks, the status indicators have more specific meanings:

[FAIL]: app has permissions that can be used as sandbox escapes, allow it to
        modify its own permissions, or otherwise grant very broad access to the
        system (e.g. access to certain directories, direct D-Bus access, X11).
[WARN]: app has permissions that have some sandbox escape potential or otherwise
        weaken security (e.g. PulseAudio, Bluetooth, not using hardened_malloc).
[INFO]: no potential sandbox escapes detected but some permissions could
        increase attack surface or have privacy implications (e.g. network
        access).
[PASS]: no app permissions flagged (however, not all permissions are audited).

Note that some flatpak apps require broad permissions to function. Permissions
being flagged by the audit script do not necessarily mean that action should be
taken.

Closes issue secureblue#1086. The help text can be viewed by running `ujust
audit-secureblue --help`. Also fixes one status that was missed with the
change in secureblue#1085.

Signed-off-by: Daniel Hast <[email protected]>
@HastD HastD requested a review from RoyalOughtness as a code owner May 31, 2025 21:21
@RoyalOughtness RoyalOughtness enabled auto-merge (squash) June 1, 2025 22:32
@RoyalOughtness RoyalOughtness merged commit 28de008 into secureblue:live Jun 1, 2025
15 of 16 checks passed
@HastD HastD deleted the audit-legend branch June 1, 2025 23:05
RoyalOughtness pushed a commit to RoyalOughtness/secureblue-dev that referenced this pull request Aug 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants