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.

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

packetbeat: allow user to prevent Npcap installation on Windows #34428

Merged
merged 2 commits into from
Feb 3, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Jan 30, 2023

What does this PR do?

Allow user to prevent Npcap installation on Windows.

Why is it important?

Some users depend on software that uses Npcap pinned to other versions.

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

Test locally on a windows machine with no npcap installed, and running with .\packetbeat -e -d '*' (binary must have been built with npcap installer asset in place) with the following packetbeat.yml.

packetbeat.interfaces.device: default_route

packetbeat.npcap:
  never_install: true

packetbeat.interfaces.poll_default_route: 1m

packetbeat.interfaces.internal_networks:
  - private

packetbeat.flows:
  timeout: 30s
  period: 10s

packetbeat.protocols:
- type: icmp
  # Enable ICMPv4 and ICMPv6 monitoring. The default is true.
  enabled: true

output.file:
  path: "./"
  filename: packetbeat-test

You will see the following two lines in the output

{"log.level":"warn","@timestamp":"2023-01-30T23:11:39.642-0800","log.logger":"npcap_install","log.origin":{"file.name":"beater/install_npcap.go","file.line":67},"message":"npcap installation/upgrade disabled by user","service.name":"packetbeat","ecs.version":"1.6.0"}
{"log.level":"warn","@timestamp":"2023-01-30T23:11:39.642-0800","log.logger":"npcap","log.origin":{"file.name":"beater/install_npcap.go","file.line":47},"message":"no version available for npcap","service.name":"packetbeat","ecs.version":"1.6.0"}

and then will shortly after packetbeat will terminate with

{"log.level":"error","@timestamp":"2023-01-30T23:11:39.673-0800","log.origin":{"file.name":"instance/beat.go","file.line":1070},"message":"Exiting: failed to get device list: couldn't load wpcap.dll","service.name":"packetbeat","ecs.version":"1.6.0"}
Exiting: failed to get device list: couldn't load wpcap.dll

Related issues

Use cases

Screenshots

Logs

@efd6 efd6 self-assigned this Jan 30, 2023
@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 Jan 30, 2023
@efd6 efd6 force-pushed the 34420-npcap branch 2 times, most recently from 18d4f5a to 267d4cc Compare January 30, 2023 23:51
@elasticmachine
Copy link
Collaborator

elasticmachine commented Jan 31, 2023

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-02-02T22:02:15.325+0000

  • Duration: 47 min 33 sec

Test stats 🧪

Test Results
Failed 0
Passed 1742
Skipped 19
Total 1761

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@efd6 efd6 marked this pull request as ready for review January 31, 2023 00:43
@efd6 efd6 requested a review from a team as a code owner January 31, 2023 00:43
@elasticmachine
Copy link
Collaborator

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

Copy link
Member

@andrewkroh andrewkroh left a comment

Choose a reason for hiding this comment

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

This option should be added to the asciidocs so that it's present in the website docs. What's here looks good.

@efd6 efd6 requested a review from andrewkroh February 2, 2023 23:11
@efd6 efd6 merged commit 23c2c42 into elastic:main Feb 3, 2023
@clakra
Copy link

clakra commented Apr 9, 2023

Hello,
will this option also be available in the Network Packet Capture integration of the elastic-agent ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.7-candidate backport-skip Skip notification from the automated backport with mergify enhancement Packetbeat
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Packetbeat] Disable install/auto-update of npcap
4 participants