Skip to content

Allow usage of base64url encoding / Issue #34 #45

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

Open
lucabelluccini wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Allow usage of base64url encoding / Issue #34 #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1acc306
Allow usage of base64url encoding / Issue #34
lucabelluccini Oct 11, 2018
b5cdcb2
Update spec/filters/fingerprint_spec.rb
lucabelluccini Apr 13, 2022
ae1d2c2
Merge branch 'main' into issue/34
lucabelluccini Apr 13, 2022
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
10 changes: 10 additions & 0 deletions docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-base64encode>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-base64url>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-concatenate_sources>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-concatenate_all_fields>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-ecs_compatibility>> | <<string,string>>|No
Expand All @@ -79,6 +80,15 @@ filter plugins.
When set to `true`, the `SHA1`, `SHA256`, `SHA384`, `SHA512` and `MD5` fingerprint methods will produce
base64 encoded rather than hex encoded strings.

[id="plugins-{type}s-{plugin}-base64url"]
===== `base64url`

* Value type is <<boolean,boolean>>
* Default value is `false`

Requires `base64encode` to be set to `true`.
When set to `true`, the base64url variant will be used, as described in [RFC4648 section 5](https://tools.ietf.org/html/rfc4648#section-5).

[id="plugins-{type}s-{plugin}-concatenate_sources"]
===== `concatenate_sources`

Expand Down
12 changes: 10 additions & 2 deletions lib/logstash/filters/fingerprint.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ class LogStash::Filters::Fingerprint < LogStash::Filters::Base
# base64 encoded rather than hex encoded strings.
config :base64encode, :validate => :boolean, :default => false

# When set to `true`, the base64url encoder https://tools.ietf.org/html/rfc4648 is used.
# Requires `base64encode` to be enabled.
config :base64url, :validate => :boolean, :default => false

# The fingerprint method to use.
#
# If set to `SHA1`, `SHA256`, `SHA384`, `SHA512`, or `MD5` and a key is set,
Expand Down Expand Up @@ -193,8 +197,12 @@ def fingerprint_openssl(data)
end
else
if @base64encode
hash = OpenSSL::HMAC.digest(digest, @key, data.to_s)
Base64.strict_encode64(hash).force_encoding(Encoding::UTF_8)
hash = OpenSSL::HMAC.digest(@digest, @key, data.to_s)
if @base64url
Base64.urlsafe_encode64(hash).force_encoding(Encoding::UTF_8)
else
Base64.strict_encode64(hash).force_encoding(Encoding::UTF_8)
end
else
OpenSSL::HMAC.hexdigest(digest, @key, data.to_s).force_encoding(Encoding::UTF_8)
end
Expand Down
10 changes: 8 additions & 2 deletions spec/filters/fingerprint_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,16 @@
it "fingerprints the value" do
expect(fingerprint).to eq("NFvsPv8kLVO1aJFsJhCz45PYhda5bWQ/OElP10v0qco=")
end
context "and base64url encoding" do
let(:config) { super().merge("base64url" => true) }
it "fingerprints the value" do
expect(fingerprint).to eq("MzQ1YmVjM2VmZjI0MmQ1M2I1Njg5MTZjMjYxMGIzZTM5M2Q4ODVkNmI5NmQ2NDNmMzg0OTRmZDc0YmY0YTljYQ==")
end
end
end
end
end

end
context "the SHA384 algorithm" do
let(:fingerprint_method) { "SHA384" }
it "fingerprints the value" do
Expand Down