cloudflare: move HTTP request debugging to httputil
#1164
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Within the library, we provide a way to output the HTTP interactions that the library makes. We previously used a custom approach and format the output. Even though it works, there are better approaches using `httputil.DumpRequestOut` and `httputil.DumpResponseOut` for dumping the HTTP interactions. Alongside this work, we're adding support for redacting sensitive values in the HTTP interactions. This is useful for both this library and the consumers of this library (like the Terraform Provider) to prevent leaking sensitive information in logs. Closes cloudflare#1143
jacobbednarz
force-pushed
the
automatically-redact-known-sensitive-http-headers
branch
from
09e67f6 to
fdc3a7d
Compare
|
changelog detected ✅ |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1164 +/- ##
==========================================
- Coverage 49.40% 49.28% -0.13%
==========================================
Files 127 128 +1
Lines 12290 12416 +126
==========================================
+ Hits 6072 6119 +47
- Misses 4840 4896 +56
- Partials 1378 1401 +23 ☔ View full report in Codecov by Sentry. |
jacobbednarz
deleted the
automatically-redact-known-sensitive-http-headers
branch
|
This functionality has been released in v0.58.1. For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you! |
jacobbednarz
added a commit
to cloudflare/terraform-provider-cloudflare
that referenced
this pull request
Jan 4, 2023
As of cloudflare/cloudflare-go#1164 we have the ability to use the inbuilt logger for redacting sensitive HTTP headers. Previously, we were discarding the provided logger due to instantiating a new `cleanhttp` client to use however, with this change we are now using the cloudflare-go logger for HTTP interactions inside the Terraform Core sink. By default we redact the values found in the following HTTP headers (not the headers themselves) in the entire HTTP interaction: - `X-Auth-Email` - `X-Auth-Key` - `X-Auth-User-Service-Key` - `Authorization` And here is an example of the logger in action for `TF_LOG=DEBUG`. ``` 2023-01-05T06:49:41.208221+11:00 [DEBUG] cloudflare GET /client/v4/zones/0da42c8d2132a9ddaf714f9e7c920711/access/apps/dec500cc-4eb3-4c64-b10d-1fce8f686339 HTTP/1.1 Host: api.cloudflare.com User-Agent: terraform/1.3.6 terraform-plugin-sdk/2.10.1 terraform-provider-cloudflare/dev Content-Type: application/json X-Auth-Email: [redacted] X-Auth-Key: [redacted] Accept-Encoding: gzip 2023-01-05T06:49:41.208221+11:00 [DEBUG] cloudflare HTTP/1.1 200 OK Transfer-Encoding: chunked Cf-Cache-Status: DYNAMIC Cf-Ray: 78467fb52e4baaf9-SYD Connection: keep-alive ... { "result": { "id": "dec500cc-4eb3-4c64-b10d-1fce8f686339", "uid": "dec500cc-4eb3-4c64-b10d-1fce8f686339", // .. "http_only_cookie_attribute": false }, "success": true, "errors": [], "messages": [] } ```
ivan-section-io
pushed a commit
to section/cloudflare-go
that referenced
this pull request
Jan 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Within the library, we provide a way to output the HTTP interactions that the library makes. We previously used a custom approach and format the output. Even though it works, there are better approaches using
httputil.DumpRequestOutandhttputil.DumpResponseOutfor dumping the HTTP interactions.Alongside this work, we're adding support for redacting sensitive values in the HTTP interactions. This is useful for both this library and the consumers of this library (like the Terraform Provider) to prevent leaking sensitive information in logs.
Closes #1143