[Filebeat] Enable HMAC Signature Validation for http_endpoint input #24918

SpencerLN · 2021-04-02T21:24:50Z

What does this PR do?

Adds the option of HMAC signature validation for the http_endpoint input. This PR adds support for sha1 and sha256 based HMAC validation and allows flexible configuration of the header containing the signature, the key, and an optional prefix.

Why is it important?

Many webhook senders offer this as the only method of authenticating that the method was actually sent from them, for example, GitHub and Dropbox. This enables future modules to receive events from these types of senders and allows users the flexibility to configure their own inputs in the meantime.

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have made corresponding change to the default configuration files
I have added tests that prove my fix is effective or that my feature works
I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

[ ]

How to test this PR locally

This PR can be tested locally by configuring a webhook sender to send events to your machine. I personally used ngrok to expose the appropriate port from Filebeat, but there are other options. One simple sender to use for testing is configuring a webhook on any GitHub repo.

https://docs.github.com/en/developers/webhooks-and-events/creating-webhooks#exposing-localhost-to-the-internet

Related issues

Closes Support HMAC Validation for Filebeat http_endpoint input #24917

elasticmachine · 2021-04-02T22:19:24Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Build Cause: Pull request #24918 updated
Start Time: 2021-05-12T23:07:23.693+0000
Duration: 107 min 27 sec
Commit: 892b00e

Test stats 🧪

Test	Results
Failed	0
Passed	7031
Skipped	1193
Total	8224

Trends 🧪

💚 Flaky test report

Tests succeeded.

Expand to view the summary

Test stats 🧪

Test	Results
Failed	0
Passed	7031
Skipped	1193
Total	8224

mergify · 2021-04-07T16:26:54Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b add-hmac-validation upstream/add-hmac-validation
git merge upstream/master
git push upstream add-hmac-validation

elasticmachine · 2021-04-07T16:40:29Z

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

x-pack/filebeat/input/http_endpoint/config.go

P1llus · 2021-05-10T08:02:54Z

@SpencerLN Would you mind fixing the conflict with the changelog?

P1llus

It does LGTM, have you tested this for example with Github @SpencerLN ?

It looks better than my older implementation here: https://github.com/elastic/beats/pull/20744/files

SpencerLN · 2021-05-10T14:07:52Z

It does LGTM, have you tested this for example with Github @SpencerLN ?

It looks better than my older implementation here: https://github.com/elastic/beats/pull/20744/files

@P1llus I wrote this with GitHub in mind and that was what I did my primary testing with.

The conflict for the changelog should be resolved now; is there anything else I should take care of? I wasn't sure if I needed to add different labels for Mergify to work.

P1llus · 2021-05-10T14:51:41Z

It does LGTM, have you tested this for example with Github @SpencerLN ?
It looks better than my older implementation here: https://github.com/elastic/beats/pull/20744/files

@P1llus I wrote this with GitHub in mind and that was what I did my primary testing with.

The conflict for the changelog should be resolved now; is there anything else I should take care of? I wasn't sure if I needed to add different labels for Mergify to work.

Just need to confirm a few things with @andrewkroh in terms of how the response body is read, and if we can still get this to work if we wanted to read the body further in the future (like body validation logic, middleware etc), (should be okay because of the NopCloser).

After that we can add the labels for you.

mergify · 2021-05-12T10:45:21Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b add-hmac-validation upstream/add-hmac-validation
git merge upstream/master
git push upstream add-hmac-validation

Error strings should not be capitalized. https://github.com/golang/go/wiki/CodeReviewComments#error-strings

Use Go's JSON encoder to ensure proper escaping.

Validate the HMAC header before progressing to the HMAC calculation. Avoid copying body contents twice.

andrewkroh

Thank you for including tests with this change.

x-pack/filebeat/input/http_endpoint/validate.go

andrewkroh

I pushed an update to address the comments I made.

I also changed error messages that were capitalized as an unrelated cleanup.

…24918) * Enable HMAC Signature Validation for http_endpoint input * Fix error message for invalid HmacType * Update changelog * Correct variable names to better follow conventions * Don't capitalize error messages Error strings should not be capitalized. https://github.com/golang/go/wiki/CodeReviewComments#error-strings * Avoid manual JSON encoding Use Go's JSON encoder to ensure proper escaping. * Refactor HMAC validation Validate the HMAC header before progressing to the HMAC calculation. Avoid copying body contents twice. * Fix changelog merge * Add punctuation to docs Co-authored-by: Andrew Kroh <[email protected]> (cherry picked from commit 68d8948)

…24918) (#25702) * Enable HMAC Signature Validation for http_endpoint input * Fix error message for invalid HmacType * Update changelog * Correct variable names to better follow conventions * Don't capitalize error messages Error strings should not be capitalized. https://github.com/golang/go/wiki/CodeReviewComments#error-strings * Avoid manual JSON encoding Use Go's JSON encoder to ensure proper escaping. * Refactor HMAC validation Validate the HMAC header before progressing to the HMAC calculation. Avoid copying body contents twice. * Fix changelog merge * Add punctuation to docs Co-authored-by: Andrew Kroh <[email protected]> (cherry picked from commit 68d8948) Co-authored-by: Spencer Niemi <[email protected]>

SpencerLN added enhancement needs_backport PR is waiting to be backported to other branches. labels Apr 2, 2021

botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Apr 2, 2021

SpencerLN changed the title ~~Enable HMAC Signature Validation for http_endpoint input~~ [Filebeat] Enable HMAC Signature Validation for http_endpoint input Apr 7, 2021

SpencerLN added the Team:Security-External Integrations label Apr 7, 2021

botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Apr 7, 2021

marc-gr requested a review from P1llus April 15, 2021 11:28

andrewkroh requested a review from marc-gr May 3, 2021 14:49

andrewkroh reviewed May 3, 2021

View reviewed changes

x-pack/filebeat/input/http_endpoint/config.go Outdated Show resolved Hide resolved

P1llus reviewed May 10, 2021

View reviewed changes

SpencerLN and others added 7 commits May 12, 2021 18:56

Enable HMAC Signature Validation for http_endpoint input

56f980e

Fix error message for invalid HmacType

2efadf5

Update changelog

25c3ed6

Correct variable names to better follow conventions

9e7875f

Don't capitalize error messages

21a00cd

Error strings should not be capitalized. https://github.com/golang/go/wiki/CodeReviewComments#error-strings

Avoid manual JSON encoding

711293e

Use Go's JSON encoder to ensure proper escaping.

Refactor HMAC validation

d19ebd8

Validate the HMAC header before progressing to the HMAC calculation. Avoid copying body contents twice.

andrewkroh requested changes May 12, 2021

View reviewed changes

andrewkroh force-pushed the add-hmac-validation branch from 0fe36d0 to d19ebd8 Compare May 12, 2021 23:02

andrewkroh added 2 commits May 12, 2021 19:03

Fix changelog merge

46ca419

Add punctuation to docs

892b00e

andrewkroh approved these changes May 12, 2021

View reviewed changes

andrewkroh merged commit 68d8948 into elastic:master May 13, 2021

andrewkroh added the backport-v7.14.0 Automated backport with mergify label May 13, 2021

mergify bot mentioned this pull request May 13, 2021

[7.x](backport #24918) [Filebeat] Enable HMAC Signature Validation for http_endpoint input #25702

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Filebeat] Enable HMAC Signature Validation for http_endpoint input #24918

[Filebeat] Enable HMAC Signature Validation for http_endpoint input #24918

SpencerLN commented Apr 2, 2021 •

edited

Loading

elasticmachine commented Apr 2, 2021 •

edited by jenkins-beats-ci bot

Loading

Build stats

Test stats 🧪

Trends 🧪

Test stats 🧪

mergify bot commented Apr 7, 2021

elasticmachine commented Apr 7, 2021

P1llus commented May 10, 2021

P1llus left a comment

SpencerLN commented May 10, 2021

P1llus commented May 10, 2021

mergify bot commented May 12, 2021

andrewkroh left a comment

andrewkroh left a comment

[Filebeat] Enable HMAC Signature Validation for http_endpoint input #24918

[Filebeat] Enable HMAC Signature Validation for http_endpoint input #24918

Conversation

SpencerLN commented Apr 2, 2021 • edited Loading

What does this PR do?

Why is it important?

Checklist

Author's Checklist

How to test this PR locally

Related issues

elasticmachine commented Apr 2, 2021 • edited by jenkins-beats-ci bot Loading

💚 Build Succeeded

Build stats

Test stats 🧪

Trends 🧪

💚 Flaky test report

Test stats 🧪

mergify bot commented Apr 7, 2021

elasticmachine commented Apr 7, 2021

P1llus commented May 10, 2021

P1llus left a comment

Choose a reason for hiding this comment

SpencerLN commented May 10, 2021

P1llus commented May 10, 2021

mergify bot commented May 12, 2021

andrewkroh left a comment

Choose a reason for hiding this comment

andrewkroh left a comment

Choose a reason for hiding this comment

SpencerLN commented Apr 2, 2021 •

edited

Loading

elasticmachine commented Apr 2, 2021 •

edited by jenkins-beats-ci bot

Loading