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.

Sign up for GitHub

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

Jump to bottom

Redact HTTP dumps #130

Merged
merged 2 commits into from
Apr 21, 2023
Merged

Redact HTTP dumps #130

merged 2 commits into from
Apr 21, 2023

Conversation

john-odonnell
Copy link
Contributor

Desired Outcome

Please describe the desired outcome for this PR. Said another way, what was
the original request that resulted in these code changes? Feel free to copy
this information from the connected issue.

Implemented Changes

Describe how the desired outcome above has been achieved with this PR. In
particular, consider:

  • What's changed? Why were these changes made?
  • How should the reviewer approach this PR, especially if manual tests are required?
  • Are there relevant screenshots you can add to the PR description?

Connected Issue/Story

Resolves #[relevant GitHub issue(s), e.g. 76]

CyberArk internal issue ID: [insert issue ID]

Definition of Done

At least 1 todo must be completed in the sections below for the PR to be
merged.

Changelog

  • The CHANGELOG has been updated, or
  • This PR does not include user-facing changes and doesn't require a
    CHANGELOG update

Test coverage

  • This PR includes new unit and integration tests to go with the code
    changes, or
  • The changes in this PR do not require tests

Documentation

  • Docs (e.g. READMEs) were updated in this PR
  • A follow-up issue to update official docs has been filed here: [insert issue ID]
  • This PR does not require updating any documentation

Behavior

  • This PR changes product behavior and has been reviewed by a PO, or
  • These changes are part of a larger initiative that will be reviewed later, or
  • No behavior was changed with this PR

Security

  • Security architect has reviewed the changes in this PR,
  • These changes are part of a larger initiative with a separate security review, or
  • There are no security aspects to these changes

@john-odonnell john-odonnell requested a review from a team as a code owner April 20, 2023 19:50
codeclimate[bot]
codeclimate bot reviewed Apr 20, 2023
View reviewed changes
pkg/utils/http_dump_transport_test.go
"github.com/stretchr/testify/assert"
)

func TestDumpTransport(t *testing.T) {
Copy link

Choose a reason for hiding this comment

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

Function TestDumpTransport has 86 lines of code (exceeds 70 allowed). Consider refactoring.

szh
szh reviewed Apr 21, 2023
View reviewed changes
pkg/utils/http_dump_transport.go
return false, rc, err
}

return rx.Match(content.Bytes()), io.NopCloser(&content), nil
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we print [REDACTED] here like we do for the Auth header? Right now it just prints nothing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Definitely can - just pushed this. I was using httputil.DumpX's built-in body redaction, which is an empty body.

szh
szh reviewed Apr 21, 2023
View reviewed changes
Copy link
Contributor

@szh szh 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, just needs a changelog entry

pkg/utils/http_dump_transport.go Outdated Show resolved Hide resolved
codeclimate[bot]
codeclimate bot reviewed Apr 21, 2023
View reviewed changes
pkg/utils/http_dump_transport_test.go
"github.com/stretchr/testify/assert"
)

func TestDumpTransport(t *testing.T) {
Copy link

Choose a reason for hiding this comment

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

Function TestDumpTransport has 88 lines of code (exceeds 70 allowed). Consider refactoring.

pkg/utils/http_dump_transport.go Outdated Show resolved Hide resolved
@john-odonnell john-odonnell force-pushed the redact-debug branch 2 times, most recently from 2581bae to a2d0720 Compare April 21, 2023 15:15
szh
szh approved these changes Apr 21, 2023
View reviewed changes
Copy link
Contributor

@szh szh left a comment

Choose a reason for hiding this comment

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

LGTM

@codeclimate
Copy link

codeclimate bot commented Apr 21, 2023

Code Climate has analyzed commit 0f0dda4 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 85.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 82.2% (0.7% change).

View more on Code Climate.

@szh szh merged commit 8ade942 into master Apr 21, 2023
@szh szh deleted the redact-debug branch April 21, 2023 15:25
@john-odonnell john-odonnell mentioned this pull request Apr 21, 2023
Merged
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@codeclimate codeclimate[bot] codeclimate[bot] left review comments

@szh szh szh approved these changes

Assignees
No one assigned
Labels
kind/security security/medium severity/medium
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@john-odonnell @szh