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

Log debug information upon possible secret key corruption #3651

Merged
merged 1 commit into from
Apr 28, 2024

Conversation

nscuro
Copy link
Member

@nscuro nscuro commented Apr 28, 2024

Description

Logs debug information upon possible secret key corruption.

I was not able to reproduce the issue in question, so it's impossible to know why some users are experiencing secret decryption failures out of the blue.

If for whatever reason the secret key in-memory gets corrupted, we now try to reload it from disk once, and log a warning about it.

If on the other hand the encrypted value itself got corrupted (perhaps due to some bug in DataNucleus), we log a warning about that as well.

In both cases, the warning logs contain a reference to issue #2366.

Addressed Issue

Relates to #2366

Additional Details

Checklist

  • I have read and understand the contributing guidelines
  • This PR fixes a defect, and I have provided tests to verify that the fix is effective
  • This PR implements an enhancement, and I have provided tests to verify that it works as intended
  • This PR introduces changes to the database model, and I have added corresponding update logic
  • This PR introduces new or alters existing behavior, and I have updated the documentation accordingly

I was not able to reproduce the issue in question, so it's impossible to know why some users are experiencing secret decryption failures out of the blue.

If for whatever reason the secret key in-memory gets corrupted, we now try to reload it from disk once, and log a warning about it.

If on the other hand the encrypted value itself got corrupted (perhaps due to some bug in DataNucleus), we log a warning about that as well.

In both cases, the warning logs contain a reference to issue DependencyTrack#2366.

Relates to DependencyTrack#2366

Signed-off-by: nscuro <nscuro@protonmail.com>
@nscuro nscuro added this to the 4.11 milestone Apr 28, 2024
Copy link

codacy-production bot commented Apr 28, 2024

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -1.00%) 70.00% (target: 70.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (7404d62) 21988 16469 74.90%
Head commit (05afa08) 22018 (+30) 16491 (+22) 74.90% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#3651) 40 28 70.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy will stop sending the deprecated coverage status from June 5th, 2024. Learn more

@nscuro nscuro merged commit 64d0bbb into DependencyTrack:master Apr 28, 2024
11 of 12 checks passed
@nscuro nscuro deleted the issue-2366 branch April 28, 2024 19:54
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant