Skip to content
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

feat(pp): log redaction #785

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(pp): log redaction #785

wants to merge 1 commit into from

Conversation

favonia
Copy link
Owner

@favonia favonia commented Jul 1, 2024

Close #649.

  • Define all "private" data types
  • Implement the redaction of domain
    • Domains in config.Print
  • Check the redaction of token
  • The data type dns-resource-id
    • Zone IDs and record IDs in api
  • The data type linux-id
    • user IDs
    • group IDs
  • Implement the un-redaction (for min mode)
    • Reveal URLs of custom provider
    • Reveal shoutrrr service URLs
    • Reveal Cloudflare tokens
    • Reveal Healthchecks URLs
    • Reveal Uptime Kuma URLs
  • Warn about revealing tokens
  • Warn about weird configurations (e.g., hiding IPs while Proxied=false)
  • Document the new option

@favonia favonia changed the title feat(pp): WIP: log redaction feat(pp): log redaction Jul 1, 2024
@favonia favonia marked this pull request as draft July 1, 2024 12:26
Copy link

codecov bot commented Jul 1, 2024

Codecov Report

Attention: Patch coverage is 46.96970% with 35 lines in your changes missing coverage. Please review.

Project coverage is 89.09%. Comparing base (3b42131) to head (8cfecb6).
Report is 1 commits behind head on main.

Files Patch % Lines
internal/config/env_base.go 10.52% 17 Missing ⚠️
internal/config/config_print.go 28.57% 4 Missing and 6 partials ⚠️
internal/pp/fmt.go 83.33% 5 Missing ⚠️
internal/config/config_read.go 0.00% 2 Missing ⚠️
cmd/ddns/ddns.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #785      +/-   ##
==========================================
- Coverage   90.48%   89.09%   -1.39%     
==========================================
  Files          52       52              
  Lines        2196     2228      +32     
==========================================
- Hits         1987     1985       -2     
- Misses        198      226      +28     
- Partials       11       17       +6     
Flag Coverage Δ
unittests 89.09% <46.96%> (-1.39%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

Ability to hide or obfuscate IP addresses in logs
1 participant