Skip to content

Add Authorization Bearer token pattern #124

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

Merged
GrantBirki merged 4 commits into from
May 26, 2025
Merged

Add Authorization Bearer token pattern #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c2a11cb
Add Authorization Bearer token pattern
rewinfrey May 20, 2025
a20d6a8
Link to the Bearer token spec
rewinfrey May 20, 2025
75f477e
add an extra test around the case of the bearing token header (insens…
GrantBirki May 26, 2025
f7042d2
add more bearer token edge cases
GrantBirki May 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion lib/patterns/default.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ module Patterns
# Vault Tokens
# https://github.com/hashicorp/vault/issues/27151
/[sbr]\.[a-zA-Z0-9]{24,}/, # <= 1.9.x
/hv[sbr]\.[a-zA-Z0-9]{24,}/ # >= 1.10
/hv[sbr]\.[a-zA-Z0-9]{24,}/, # >= 1.10

# Authorization bearer tokens
Comment thread
GrantBirki marked this conversation as resolved.
# https://datatracker.ietf.org/doc/html/rfc6750#section-2.1
/(?i)authorization:\s+bearer\s+[A-Za-z0-9\-_\.=~+\/]+/,
].freeze
end
45 changes: 45 additions & 0 deletions spec/lib/redacting_logger_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,51 @@
case: "redacts a RubyGems token",
message: "using rubygems token: rubygems_0123456789abcdef0123456789abcdef0123456789abcdef",
expected_message: "using rubygems token: [REDACTED]"
},
{
case: "redacts authorization bearer token",
message: '-H "Authorization: Bearer ab123456789a1abcd1~_.-+456ABCDE=" -H "Content-Type: application/json"',
expected_message: '-H "[REDACTED]" -H "Content-Type: application/json"'
},
{
case: "redacts authorization bearer token with case insensitivity",
message: '-H "authorizAtion: beaRer ab123456789a1abcd1~_.-+456ABCDE=" -H "Content-Type: application/json"',
expected_message: '-H "[REDACTED]" -H "Content-Type: application/json"'
},
{
case: "redacts authorization bearer token with extra spaces and tabs",
message: "authorization: bearer abcd1234",
expected_message: "[REDACTED]"
},
{
case: "redacts authorization bearer token with special characters",
message: "authorization: bearer aBcD-_=~+/1234",
expected_message: "[REDACTED]"
},
{
case: "redacts authorization bearer token at start of string",
message: "authorization: bearer tokenatstart",
expected_message: "[REDACTED]"
},
{
case: "redacts authorization bearer token at end of string",
message: "some text authorization: bearer tokenatend",
expected_message: "some text [REDACTED]"
},
{
case: "redacts multiple authorization bearer tokens in one string",
message: "authorization: bearer token1 and authorization: bearer token2",
expected_message: "[REDACTED] and [REDACTED]"
},
{
case: "redacts authorization bearer token with minimum plausible length",
message: "authorization: bearer a",
expected_message: "[REDACTED]"
},
{
case: "redacts authorization bearer token with maximum plausible length",
message: "authorization: bearer #{'a' * 256}",
expected_message: "[REDACTED]"
}
].each do |test|
it "redacts #{test[:case]}" do
Expand Down