x-pack/packetbeat: add licensing notices and information for Npcap #29303

efd6 · 2021-12-06T23:33:42Z

What does this PR do?

This adds licensing notices and information for #29112.

Why is it important?

This information is a legal requirement for distributing OEM Npcap. The PR is split to ease review.

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

Confirm that the wording and locations of license information agrees with required licensing policy.

How to test this PR locally

This PR is almost entirely English semantics, comprehension is testing.

Only the final commit in this PR is new. The remainder are from #29112.

Related issues

Depends x-pack/packetbeat: install Npcap at start-up when required #29112

Use cases

N/A

Screenshots

N/A

Logs

N/A

elasticmachine · 2021-12-06T23:33:44Z

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

Makefile

efd6 · 2021-12-06T23:53:45Z

x-pack/packetbeat/LICENSE-Npcap.txt

@@ -0,0 +1,228 @@
+


Is this directory the right place for this or should it go in the root with additional words to note who it's relevant to — it probably already needs some of that to note that it's only relevant to Windows users. Note that currently this file doe not get placed on the target system — should it be?

efd6 · 2021-12-06T23:54:22Z

x-pack/packetbeat/magefile.go

+		// Explicitly hold at ELv1 to satisfy Npcap licensing on Windows.
+		// Do not alter this without checking with the licensing policy.


Is this wording OK?

efd6 · 2021-12-07T00:03:09Z

x-pack/packetbeat/npcap/installer/LICENSE

@@ -0,0 +1,229 @@
+--------------------------------------------------------------------------------


This is a place-holder file. It should probably also have a link to the canonical license file to avoid risk of errors.

elasticmachine · 2021-12-07T03:34:05Z

💚 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

Start Time: 2022-01-12T23:07:26.781+0000
Duration: 253 min 27 sec
Commit: a58e5e5

Test stats 🧪

Test	Results
Failed	0
Passed	47877
Skipped	4284
Total	52161

💚 Flaky test report

Tests succeeded.

🤖 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!)

Makefile

wip

Also make test failures log mock installer output.

andrewkroh · 2021-12-14T13:14:56Z

/test

andrewkroh · 2021-12-14T13:15:19Z

/package

dev-tools/packaging/package_test.go

efd6 · 2021-12-15T04:09:51Z

x-pack/packetbeat/magefile.go

@@ -32,6 +32,11 @@ func init() {

 	devtools.BeatDescription = "Packetbeat analyzes network traffic and sends the data to Elasticsearch."
 	devtools.BeatLicense = "Elastic License"
+	if devtools.Platform.GOOS == "windows" {


While debugging the license checking issues I found that this is not run during packaging. This means that this hold won't constrain the license note customisation though it will prevent escape of the actual installer. Is this a problem and if it is where would be the best equivalent place in the packaging code path?

I think this block is not necessary (or I don't understand something). All artifacts produced by running mage package from beats/x-pack/packetbeat directory are ELv1 (and all artifacts from beats/packetbeat are ASL2).

OK. This was a defensive inclusion in case beats/x-pack/packetbeat was moved to ELv2 which was something that was raised as a concern.

efd6 · 2021-12-16T04:14:33Z

/test

efd6 · 2021-12-16T06:57:05Z

/test

andrewkroh · 2021-12-16T20:10:43Z

/package

Also hold license at ELv1.

efd6 · 2022-01-27T06:34:34Z

Abandoned in favour of #29112.

efd6 added enhancement Team:Security-External Integrations backport-v8.0.0 Automated backport with mergify 8.1-candidate labels Dec 6, 2021

efd6 requested a review from a team as a code owner December 6, 2021 23:33

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 Dec 6, 2021

efd6 mentioned this pull request Dec 6, 2021

x-pack/packetbeat: install Npcap at start-up when required #29112

Merged

6 tasks

efd6 commented Dec 6, 2021

View reviewed changes

efd6 commented Dec 7, 2021

View reviewed changes

efd6 force-pushed the npcap/installer_licensing branch from b159725 to d4c2496 Compare December 9, 2021 01:45

efd6 requested a review from a team as a code owner December 9, 2021 01:45

efd6 force-pushed the npcap/installer_licensing branch 2 times, most recently from 1344a47 to 3bc0aa7 Compare December 12, 2021 23:44

andrewkroh reviewed Dec 13, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

efd6 added 11 commits December 14, 2021 15:22

packetbeat: add npcap installer hooks

8e1bfe1

wip

packetbeat: use a remote registry

e58c832

packetbeat: allow specification of Npcap install location

59a33e6

Also make test failures log mock installer output.

packetbeat: fix error handling and make failure an option

0be3fa5

add changelog line

9100816

improve error reporting

ed25fa3

restrict oem npcap installation to elastic licensed use

f464744

add logic for installing from embedded byte artifact

21d4931

make npcap installer code visible from x-pack

dfc114b

allow installation of npcap from embedded npcap installer

2b16d6c

reload npcap dll on install

4c1ceae

efd6 force-pushed the npcap/installer_licensing branch from 7f35287 to 0c806cc Compare December 14, 2021 04:55

andrewkroh added the Packaging label Dec 14, 2021

test config file contents

bc8149e

efd6 force-pushed the npcap/installer_licensing branch 2 times, most recently from 8260116 to 3f24c09 Compare December 14, 2021 08:16

efd6 force-pushed the npcap/installer_licensing branch from 3f24c09 to 436d960 Compare December 14, 2021 23:27

efd6 requested a review from andrewkroh December 15, 2021 01:10

This comment has been minimized.

Sign in to view

andrewkroh reviewed Dec 15, 2021

View reviewed changes

dev-tools/packaging/package_test.go Outdated Show resolved Hide resolved

efd6 force-pushed the npcap/installer_licensing branch from 436d960 to eb6c75b Compare December 15, 2021 04:02

efd6 commented Dec 15, 2021

View reviewed changes

This comment has been minimized.

Sign in to view

efd6 force-pushed the npcap/installer_licensing branch from 4ab7896 to ecd9308 Compare December 16, 2021 08:49

andrewkroh added the Packetbeat label Dec 16, 2021

efd6 and others added 6 commits January 13, 2022 09:34

log pcap version for windows platforms

784353b

x-pack/packetbeat: add license notices

5222fc2

Also hold license at ELv1.

remove license hold

64ec3b5

experiment: always write notice but conditionally add npcap licenses

636cfaa

Create PackageDir before WriteFile

ac71149

bump Npcap version

a58e5e5

efd6 force-pushed the npcap/installer_licensing branch from e475abf to a58e5e5 Compare January 12, 2022 23:07

efd6 closed this Jan 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

x-pack/packetbeat: add licensing notices and information for Npcap #29303

x-pack/packetbeat: add licensing notices and information for Npcap #29303

efd6 commented Dec 6, 2021

elasticmachine commented Dec 6, 2021

efd6 Dec 6, 2021 •

edited

Loading

efd6 Dec 6, 2021

efd6 Dec 7, 2021

elasticmachine commented Dec 7, 2021 •

edited by jenkins-beats-ci bot

Loading

Build stats

Test stats 🧪

This comment has been minimized.

This comment has been minimized.

andrewkroh commented Dec 14, 2021

andrewkroh commented Dec 14, 2021

This comment has been minimized.

This comment has been minimized.

efd6 Dec 15, 2021

andrewkroh Dec 15, 2021 •

edited

Loading

efd6 Dec 15, 2021

This comment has been minimized.

This comment has been minimized.

efd6 commented Dec 16, 2021

efd6 commented Dec 16, 2021

andrewkroh commented Dec 16, 2021

efd6 commented Jan 27, 2022

		// Explicitly hold at ELv1 to satisfy Npcap licensing on Windows.
		// Do not alter this without checking with the licensing policy.

		@@ -0,0 +1,229 @@
		--------------------------------------------------------------------------------

x-pack/packetbeat: add licensing notices and information for Npcap #29303

x-pack/packetbeat: add licensing notices and information for Npcap #29303

Conversation

efd6 commented Dec 6, 2021

What does this PR do?

Why is it important?

Checklist

Author's Checklist

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

elasticmachine commented Dec 6, 2021

efd6 Dec 6, 2021 • edited Loading

Choose a reason for hiding this comment

efd6 Dec 6, 2021

Choose a reason for hiding this comment

efd6 Dec 7, 2021

Choose a reason for hiding this comment

elasticmachine commented Dec 7, 2021 • edited by jenkins-beats-ci bot Loading

💚 Build Succeeded

Build stats

Test stats 🧪

💚 Flaky test report

🤖 GitHub comments

This comment has been minimized.

This comment has been minimized.

andrewkroh commented Dec 14, 2021

andrewkroh commented Dec 14, 2021

This comment has been minimized.

This comment has been minimized.

efd6 Dec 15, 2021

Choose a reason for hiding this comment

andrewkroh Dec 15, 2021 • edited Loading

Choose a reason for hiding this comment

efd6 Dec 15, 2021

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

efd6 commented Dec 16, 2021

efd6 commented Dec 16, 2021

andrewkroh commented Dec 16, 2021

efd6 commented Jan 27, 2022

efd6 Dec 6, 2021 •

edited

Loading

elasticmachine commented Dec 7, 2021 •

edited by jenkins-beats-ci bot

Loading

andrewkroh Dec 15, 2021 •

edited

Loading