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

logging: mask authorization header value in debug logs #4496

Merged
merged 1 commit into from Mar 26, 2022
Merged

logging: mask authorization header value in debug logs #4496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 23 additions & 7 deletions plugins/rest/rest.go
View file
Open in desktop
Expand Up @@ -293,16 +293,19 @@ func (c Client) Do(ctx context.Context, method, path string) (*http.Response, er
return nil, err
}

c.loggerFields = map[string]interface{}{
"method": method,
"url": url,
"headers": req.Header,
}
if c.logger.GetLevel() >= logging.Debug {
c.loggerFields = map[string]interface{}{
"method": method,
"url": url,
"headers": withMaskedAuthorizationHeader(req.Header),
}

c.logger.WithFields(c.loggerFields).Debug("Sending request.")
c.logger.WithFields(c.loggerFields).Debug("Sending request.")
}

resp, err := httpClient.Do(req)
if resp != nil {

if resp != nil && c.logger.GetLevel() >= logging.Debug {
// Only log for debug purposes. If an error occurred, the caller should handle
// that. In the non-error case, the caller may not do anything.
c.loggerFields["status"] = resp.Status
Expand All @@ -312,3 +315,16 @@ func (c Client) Do(ctx context.Context, method, path string) (*http.Response, er

return resp, err
}

func withMaskedAuthorizationHeader(headers http.Header) http.Header {
Copy link
Member

Choose a reason for hiding this comment

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

Can we make this more generic ? For ex.

func maskHeader(headers http.Header, headerName, headerValue string) http.Header {
     // some logic
}

We could also just remove the header instead of redacting the value but no strong opinion on that.

Copy link
Member Author

Choose a reason for hiding this comment

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

We sure could, but given how it's not a public function and currently only masking a single header, I think we could make it generic if/when that's needed.

authzHeader := headers.Get("Authorization")
if authzHeader != "" {
masked := make(http.Header)
for k, v := range headers {
masked[k] = v
}
masked.Set("Authorization", "REDACTED")
return masked
}
return headers
}
50 changes: 50 additions & 0 deletions plugins/rest/rest_test.go
View file
Open in desktop
Expand Up @@ -34,9 +34,12 @@ import (
"github.com/open-policy-agent/opa/internal/jwx/jwa"
"github.com/open-policy-agent/opa/internal/jwx/jws"
"github.com/open-policy-agent/opa/keys"
"github.com/open-policy-agent/opa/logging"

"github.com/open-policy-agent/opa/internal/version"
"github.com/open-policy-agent/opa/util/test"

testlogger "github.com/open-policy-agent/opa/logging/test"
)

const keyID = "key1"
Expand Down Expand Up @@ -1514,6 +1517,53 @@ func TestS3SigningInstantiationInitializesLogger(t *testing.T) {
}
}

func TestDebugLoggingRequestMaskAuthorizationHeader(t *testing.T) {
token := "secret"
ts := testServer{t: t, expBearerToken: token}
ts.start()
defer ts.stop()

config := fmt.Sprintf(`{
"name": "foo",
"url": %q,
"credentials": {
"bearer": {
"token": %q
}
}
}`, ts.server.URL, token)
client, err := New([]byte(config), map[string]*keys.Config{})
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}

logger := testlogger.New()
logger.SetLevel(logging.Debug)
client.logger = logger

ctx := context.Background()
if _, err := client.Do(ctx, "GET", "test"); err != nil {
t.Fatalf("Unexpected error: %v", err)
}

var reqLogFound bool
for _, entry := range logger.Entries() {
if entry.Fields["headers"] != nil {
headers := entry.Fields["headers"].(http.Header)
authzHeader := headers.Get("Authorization")
if authzHeader != "" {
reqLogFound = true
if authzHeader != "REDACTED" {
t.Errorf("Excpected redacted Authorization header value, got %v", authzHeader)
}
}
}
}
if !reqLogFound {
t.Fatalf("Expected log entry from request")
}
}

func newTestClient(t *testing.T, ts *testServer, certPath string, keypath string) *Client {
config := fmt.Sprintf(`{
"name": "foo",
Expand Down