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

[Filebeat][ATP Module]Setting user agent field required by the API #20440

Merged
merged 3 commits into from
Aug 5, 2020
Merged

[Filebeat][ATP Module]Setting user agent field required by the API #20440

merged 3 commits into from
Aug 5, 2020

Conversation

P1llus
Copy link
Member

@P1llus P1llus commented Aug 5, 2020 •
edited by andrewkroh
Loading

What does this PR do?

Vendor modules are required to include a header for tracking purposes

Why is it important?

The header set is a requirement to use the ATP/MTP API. https://docs.microsoft.com/en-us/windows/security/threat-protection/microsoft-defender-atp/get-started-partner-integration

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.

@P1llus P1llus requested a review from adriansr August 5, 2020 07:57
@elasticmachine
Copy link
Collaborator

Pinging @elastic/siem (Team:SIEM)

@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Aug 5, 2020
adriansr
adriansr suggested changes Aug 5, 2020
View reviewed changes
Copy link
Contributor

@adriansr adriansr left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This is failing for me:

Exiting: Failed to start crawler: creating module reloader failed: required 'object', but found 'string' in field 'http_headers'

It seemed to work when I added the | tojson suggested below. Got this:

GET /?%24filter=lastUpdateTime+gt+2020-08-05T08%3A01%3A03.001739Z HTTP/1.1
Host: localhost:8888
User-Agent: MdatpPartner-Elastic-Filebeat/1.0.0
Accept: application/json
Content-Type: application/json
Accept-Encoding: gzip
Connection: close

x-pack/filebeat/module/microsoft/defender_atp/config/atp.yml Outdated
@@ -11,7 +11,7 @@ url: {{ .url }}
oauth2: {{ .oauth2 | tojson }}
oauth2.provider: azure
oauth2.azure.resource: https://api.securitycenter.windows.com/

http_headers: {{ .http_headers }}
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this should be {{ .http_headers | tojson }}

@elasticmachine
Copy link
Collaborator

elasticmachine commented Aug 5, 2020 •
edited by jenkins-beats-ci bot
Loading

💚 Build Succeeded

Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: [Pull request #20440 updated]

  • Start Time: 2020-08-05T08:37:14.443+0000

  • Duration: 53 min 39 sec

Test stats 🧪

Test Results
Failed 0
Passed 2438
Skipped 397
Total 2835

@adriansr adriansr merged commit 6a9a20e into elastic:master Aug 5, 2020
adriansr pushed a commit to adriansr/beats that referenced this pull request Aug 5, 2020
@P1llus @adriansr
[Filebeat][ATP Module]Setting user agent field required by the API (e…
fb416b8 
…lastic#20440)

Setting user-agent field required by ATP API for monitoring purposes

(cherry picked from commit 6a9a20e)
@adriansr adriansr mentioned this pull request Aug 5, 2020
Merged
5 tasks
@adriansr adriansr added the v7.9.0 label Aug 5, 2020
adriansr added a commit that referenced this pull request Aug 5, 2020
@adriansr @P1llus
[Filebeat][ATP Module]Setting user agent field required by the API (#…
2ee3f83 
…20440) (#20443)

Setting user-agent field required by ATP API for monitoring purposes

(cherry picked from commit 6a9a20e)

Co-authored-by: Marius Iversen <pillus@chasenet.org>
adriansr pushed a commit to adriansr/beats that referenced this pull request Aug 5, 2020
@P1llus @adriansr
[Filebeat][ATP Module]Setting user agent field required by the API (e…
16d3ea5 
…lastic#20440)

Setting user-agent field required by ATP API for monitoring purposes

(cherry picked from commit 6a9a20e)
@adriansr adriansr mentioned this pull request Aug 5, 2020
Merged
5 tasks
@P1llus P1llus deleted the filebeat_atp_user_agent branch August 5, 2020 13:56
adriansr added a commit that referenced this pull request Aug 5, 2020
@adriansr @P1llus
[Filebeat][ATP Module]Setting user agent field required by the API (#…
7e17d1f 
…20440) (#20446)

Setting user-agent field required by ATP API for monitoring purposes

(cherry picked from commit 6a9a20e)

Co-authored-by: Marius Iversen <pillus@chasenet.org>
v1v added a commit to v1v/beats that referenced this pull request Aug 6, 2020
@v1v
Merge remote-tracking branch 'upstream/master' into feature/ci-pipeli…
6fa6d3a 
…ne-2.0

* upstream/master:
  [docs] Promote ingest management to beta (elastic#20295)
  Upgrade elasticsearch client library used in tests (elastic#20405)
  Disable logging when pulling on python integration tests (elastic#20397)
  Remove pillow from testing requirements.txt (elastic#20407)
  [Filebeat][ATP Module]Setting user agent field required by the API (elastic#20440)
  [Ingest Manager] Send datastreams fields (elastic#20402)
  Add event.ingested to all Filebeat modules (elastic#20386)
  [Elastic Agent] Fix agent control socket path to always be less than 107 characters (elastic#20426)
  Improve cgroup_regex docs with examples (elastic#20425)
  Makes `metrics` config option required in app_insights (elastic#20406)
  Ensure install scripts only install if needed (elastic#20349)
  Update container name for the azure filesets (elastic#19899)
  Group same timestamp metrics values in app_insights metricset (elastic#20403)
  add_process_metadata processor adds container id even if process metadata not accessible (elastic#19767)
  Support "cluster" scope in Metricbeat elasticsearch module (elastic#18547)
  [Filebeat][SophosXG Module] Renaming module and fileset (elastic#20396)
  Update Suricata dashboards (elastic#20394)
  [Elastic Agent] Improve version, restart, enroll CLI commands (elastic#20359)
  Prepare home directories for docker images in a different stage (elastic#20356)
v1v added a commit to v1v/beats that referenced this pull request Aug 6, 2020
@v1v
Merge remote-tracking branch 'upstream/master' into fix/ci-tools-inst…
6b99d98 
…allation

* upstream/master: (23 commits)
  [docs] Promote ingest management to beta (elastic#20295)
  Upgrade elasticsearch client library used in tests (elastic#20405)
  Disable logging when pulling on python integration tests (elastic#20397)
  Remove pillow from testing requirements.txt (elastic#20407)
  [Filebeat][ATP Module]Setting user agent field required by the API (elastic#20440)
  [Ingest Manager] Send datastreams fields (elastic#20402)
  Add event.ingested to all Filebeat modules (elastic#20386)
  [Elastic Agent] Fix agent control socket path to always be less than 107 characters (elastic#20426)
  Improve cgroup_regex docs with examples (elastic#20425)
  Makes `metrics` config option required in app_insights (elastic#20406)
  Ensure install scripts only install if needed (elastic#20349)
  Update container name for the azure filesets (elastic#19899)
  Group same timestamp metrics values in app_insights metricset (elastic#20403)
  add_process_metadata processor adds container id even if process metadata not accessible (elastic#19767)
  Support "cluster" scope in Metricbeat elasticsearch module (elastic#18547)
  [Filebeat][SophosXG Module] Renaming module and fileset (elastic#20396)
  Update Suricata dashboards (elastic#20394)
  [Elastic Agent] Improve version, restart, enroll CLI commands (elastic#20359)
  Prepare home directories for docker images in a different stage (elastic#20356)
  New multiline mode in Filebeat: while_pattern (elastic#19662)
  ...
melchiormoulin pushed a commit to melchiormoulin/beats that referenced this pull request Oct 14, 2020
@P1llus @melchiormoulin
[Filebeat][ATP Module]Setting user agent field required by the API (e…
63ee45c 
…lastic#20440)

Setting user-agent field required by ATP API for monitoring purposes
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
@adriansr @P1llus
[Filebeat][ATP Module]Setting user agent field required by the API (e…
9fb18a7 
…lastic#20440) (elastic#20443)

Setting user-agent field required by ATP API for monitoring purposes

(cherry picked from commit 63612b2)

Co-authored-by: Marius Iversen <pillus@chasenet.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adriansr adriansr adriansr approved these changes

Assignees
No one assigned
Labels
enhancement Filebeat Filebeat v7.9.0 v7.10.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@P1llus @elasticmachine @adriansr