Skip to content

Added warning about credentials in debug info #1457

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

Merged
merged 4 commits into from
May 13, 2025

Conversation

ArnyminerZ
Copy link
Member

Purpose

Logs may contain confidential information like passwords or Base64 encoded credentials, people may not know it.

Short description

Added a warning message in the debug information screen to let the user know that log messages can contain credentials, and that they should be really careful while sharing.

Screenshot

Screenshot_20250511_110633

Checklist

  • The PR has a proper title, description and label.
  • I have self-reviewed the PR.
  • I have added documentation to complex functions and functions that can be used by other modules.
  • I have added reasonable tests or consciously decided to not add tests.

Signed-off-by: Arnau Mora <arnyminerz@proton.me>
@ArnyminerZ ArnyminerZ self-assigned this May 11, 2025
@ArnyminerZ ArnyminerZ added the enhancement New feature or request label May 11, 2025
@ArnyminerZ ArnyminerZ linked an issue May 11, 2025 that may be closed by this pull request
@ArnyminerZ ArnyminerZ marked this pull request as ready for review May 11, 2025 09:11
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a warning message to the debug information screen, alerting users that log messages may contain credentials.

  • Adds new string resources for a credentials warning.
  • Introduces a new CardWithImage in the DebugInfoScreen to display the warning, using a password icon.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
app/src/main/res/values/strings.xml Added new string resources for the credentials warning message.
app/src/main/kotlin/at/bitfire/davdroid/ui/DebugInfoScreen.kt Inserts a new CardWithImage to show the credentials warning within the debug info screen.

@rfc2822 rfc2822 requested review from sunkup and removed request for rfc2822 May 11, 2025 11:37
Signed-off-by: Arnau Mora <arnyminerz@proton.me>
sunkup
sunkup previously approved these changes May 12, 2025
Copy link
Member

@sunkup sunkup left a comment

Choose a reason for hiding this comment

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

Looks good to me. Not entirely sure if we should change the icon ... but I think it's fine like this.

Signed-off-by: Arnau Mora <arnyminerz@proton.me>
sunkup
sunkup previously approved these changes May 13, 2025
Copy link
Member

@sunkup sunkup left a comment

Choose a reason for hiding this comment

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

The privacy tip icon is probably what should be used here 👍

@sunkup sunkup requested a review from rfc2822 May 13, 2025 13:26
Copy link
Member

@rfc2822 rfc2822 left a comment

Choose a reason for hiding this comment

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

I have replaced the "alert" by "notice" to make it less negative/alarming

@rfc2822 rfc2822 merged commit fc10a31 into main-ose May 13, 2025
8 checks passed
@rfc2822 rfc2822 deleted the 1455-sanitize-debug-logs branch May 13, 2025 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sanitize Debug Logs
3 participants