Document and improve permission checks when running socket metricset from Docker #12039

jsoriano · 2019-05-02T23:53:36Z

Update instructions for system/socket metricset on Docker. And base
permission checks on capabilities rather than on the effective uid.
Running a process as root doesn't mean that it has all privileges,
specially when run as container.

Fix #11929

jsoriano · 2019-05-02T23:56:07Z

libbeat/common/seccomp/policy_linux_amd64.go

@@ -34,6 +34,7 @@ func init() {
 					"arch_prctl",
 					"bind",
 					"brk",
+					"capget",


@andrewkroh I didn't manage to update these files with make seccomp, it created new include files under metricbeat.
I have added this by hand here.

That's fine this file was created by merging all of the syscalls from each Beat, and then sanity checking the list.

andrewkroh

This is a nice improvement. 👍

metricbeat/docs/running-on-docker.asciidoc

andrewkroh · 2019-05-03T13:51:29Z

libbeat/common/seccomp/policy_linux_amd64.go

@@ -34,6 +34,7 @@ func init() {
 					"arch_prctl",
 					"bind",
 					"brk",
+					"capget",


That's fine this file was created by merging all of the syscalls from each Beat, and then sanity checking the list.

libbeat/common/capabilities_linux.go

metricbeat/module/system/socket/socket.go

…rent user

jsoriano · 2019-05-03T17:40:59Z

@andrewkroh thanks for your comments! This would be ready for another look.

exekias · 2019-05-06T08:30:39Z

metricbeat/docs/running-on-docker.asciidoc

@@ -41,6 +42,11 @@ of the container. They can be mounted at any location.
 to make this file contain the host's network devices is to use the `--net=host`
 flag. This is due to Linux namespacing; simply bind mounting the host's `/proc`
 to `/hostfs/proc` is not sufficient.
+<5> The <<metricbeat-metricset-system-socket,system socket metricset>> needs to


perhaps you can say this module is not enabled by default?, to avoid any doubt

exekias · 2019-05-06T08:31:30Z

metricbeat/docs/running-on-docker.asciidoc

@@ -19,6 +19,7 @@ docker run \
  --mount type=bind,source=/sys/fs/cgroup,target=/hostfs/sys/fs/cgroup,readonly \ <2>
  --mount type=bind,source=/,target=/hostfs,readonly \ <3>
  --net=host \ <4>
+  --user root --cap-add sys_ptrace --cap-add dac_read_search \ <5>


This is not needed with default settings, I wonder if it adding these here will mislead users to always add this capabilities

The comment does mention that this is for the system/socket metricset, which is probably enough. Also, I wouldn't be surprised if other metricsets have similar permissions issues that we haven't discovered.

…r-docs

fearful-symmetry · 2019-05-06T14:27:25Z

metricbeat/docs/running-on-docker.asciidoc

@@ -19,6 +19,7 @@ docker run \
  --mount type=bind,source=/sys/fs/cgroup,target=/hostfs/sys/fs/cgroup,readonly \ <2>
  --mount type=bind,source=/,target=/hostfs,readonly \ <3>
  --net=host \ <4>
+  --user root --cap-add sys_ptrace --cap-add dac_read_search \ <5>


The comment does mention that this is for the system/socket metricset, which is probably enough. Also, I wouldn't be surprised if other metricsets have similar permissions issues that we haven't discovered.

fearful-symmetry · 2019-05-06T14:29:29Z

metricbeat/module/system/socket/_meta/docs.asciidoc

@@ -20,8 +20,8 @@ metricbeat.modules:
 `period` value than the other metricsets.

 The metricset reports the process that has the socket open. In order to provide
-this information, Metricbeat must be running as root. Root access is also
-required to read the file descriptor information of other processes.
+this information for all processes in the system, Metricbeat must be run with


We may want to specify that this is required if we're running in docker/not as root, lest users get confused and think there's something special they need to do if they're running a 'normal' install from an RPM or something.

jsoriano · 2019-05-06T14:54:49Z

@exekias @fearful-symmetry thanks for your reviews, I have done some changes in docs to be more explicit on when these privileges are required, let me know what you think.

…r-docs

jsoriano · 2019-05-08T09:21:33Z

jenkins, test this again please

…r-docs

jsoriano · 2019-05-09T14:33:21Z

Failures in travis don't seem related

…from Docker (elastic#12039) Update instructions for system/socket metricset on Docker. And base permission checks on capabilities rather than on the effective uid. Running a process as root doesn't mean that it has all privileges, specially when run as container.

* Use time.Duration directly in GetStartTimeEndTime function (#12033) * Remove convertPeriodToDuration and use duration directly in GetStartTimeEndTime * Pass period in time.Duration type * Fix memory leak in Filebeat pipeline acker (#12063) * Fix memory leak in Filebeat pipeline acker Before this change acker goroutine was kept forever as processed events count was not correctly updated. Filebeat sends an empty event to update file states, this event is not published, but treated as dropped, without updating counters. This change makes sures that `a.events` count gets updated for dropped events also, so the acker gets closed after all ACKs happen. * Add convert processor (#11686) The `convert` processor converts a field in the event to a different type, such as converting a string to an integer. For a full description of the processor's capabilities see the included documentation. Closes #8124 * Update docs.asciidoc (#11852) (#12045) * Update docs.asciidoc Added in a short note on a few of the other configurable variables. * Make update * Remove systemd v233 requirement because it's no longer true (#12076) * Don't generate autodiscover config when no port matches host hints (#12086) On metricbeat, when the host autodiscover hint is used, and it includes the port, one of the exposed ports has to match with the one in the hint. If not, no configuration should be generated. If it is generated, it will have empty hosts, what would lead to unexpected errors as the seen in #8264. * Fix transptest testing (#12091) Rewrite test for more clarity ensuring that the server and listeners are stopped before the test function returns (cause for the case condition). Each test has it's very own socks5 server now. Tests not requiring a proxy don't spin up one. * Refactor and add tests for template and ilm handling. (#12065) Refactor and add more tests related to setting up template and ilm policy. Ensure template and ilm-policy is exported despite enabled=false setting. * [Auditbeat] Login: Fix re-read of utmp files (#12028) The `login` dataset is not using the previous file offset when reading new entries in a utmp file. As a result, whenever a new login event occurs, all records are re-read. Also expands the documentation, moves test files to testdata/, and adds a test case that adds a utmp record to the test file and re-reads it to make sure this bug does not happen again. * [Metricbeat][postgresql] Update lib/pq to fix #11393 (#12094) This updates github.com/lib/pq to the latest version to fix a socket leak when SSL is not enabled on the PostgreSQL server. Fixes #11393 * Make breaking changes separate files (#12002) * Change image references to use block syntax not inline (#11911) * Change image references to use block syntax not inline * Fix format for inline links * Revert "Make breaking changes separate files (#12002)" (#12116) This reverts commit c17586a. * fix queue.spool.write.flush.events config type (#12080) * Revert printing template and policy name on export. (#12067) Ensures behavior on running the `export` cmd does not change compared to last released version. * [Filebeat] Add -expected files by default (#12041) So far expected files in Filebeat tests were only generated and compared when a file exists. This changes to create a generated for all example logs. This will add a few more files to the repository but I think there the benefits outweight the costs as it means the modules are tested in more detail. Also minor changes will be detected easier. * Update vendored gosigar to 0.10.2 (#12101) #11924 duplicated some code from go-sysinfo that is affected by a memory leak (fixed in #12100) In this case, only master is affected as the PR that introduced the leaky gosigar wasn't backported. * Fix various memory leaks under Windows (#12100) A function in go-sysinfo used under Windows to split a command-line into arguments was leaking memory. This code was used in various places: add_process_metadata processor. (enabled by default in all Beats) Packetbeat's process monitor. (disabled by default). Auditbeat's system/process metricset. This PR updates vendored go-sysinfo to the most recent version, which fixes the leak. * New processor extract_array (#11761) This adds a new processor, extract_array, that allows accessing values inside arrays and copying them to target fields. * [Heartbeat] Remove not needed flags from setup command (#11856) The setup command until now contained all the possible options from the other Beats. As Heartbeat does not ship anymore with dashboards, the --dashboards command is not needed anymore and is only confusing. I also removed all the other commands except `--ilm-policy` and `--template`. I'm not aware that `--pipelines` or `--machine-learning` would be used. Here the comparison between `./heartbeat setup -h` from before and after. Before: ``` This command does initial setup of the environment: * Index mapping template in Elasticsearch to ensure fields are mapped. * Kibana dashboards (where available). * ML jobs (where available). * Ingest pipelines (where available). * ILM policy (for Elasticsearch 6.5 and newer). Usage: heartbeat setup [flags] Flags: --dashboards Setup dashboards -h, --help help for setup --ilm-policy Setup ILM policy --machine-learning Setup machine learning job configurations --pipelines Setup Ingest pipelines --template Setup index template ``` After: ``` This command does initial setup of the environment: * Index mapping template in Elasticsearch to ensure fields are mapped. * ILM Policy Usage: heartbeat setup [flags] Flags: -h, --help help for setup --ilm-policy Setup ILM policy --template Setup index template ``` In this PR I did not include a check for the config option `setup.dashboards` to make sure they are not there like apm-server does (https://github.com/elastic/apm-server/blob/2baefab778fdfe70c47bc2fb488677b2e43e4635/beater/beater.go#L60) as I don't think it's necessary. * Skip Windows testing if magefile.go does not exist (#12099) Changes the jenkins_ci.ps1 script to skip testing when magefile.go does not exist. This will allow us to add projects like x-pack/winlogbeat to the test matrix because not all branches have an x-pack/winlogbeat/magefile.go file. * Fix goroutine leak on initialization failures of log input (#12125) Outlets are created during log input initialization, and if it fails they were never freed. Handle this case. * Document and improve permission checks when running socket metricset from Docker (#12039) Update instructions for system/socket metricset on Docker. And base permission checks on capabilities rather than on the effective uid. Running a process as root doesn't mean that it has all privileges, specially when run as container. * [metricbeat] added CPU usage check to docker memory stats (#12062) * Change type from scaled_float to long and add format (#11982) * Change type from scaled_float to long and add format * [libbeat] Add unit tests for libbeat's client proxy settings (#12044) These tests set up server listeners and create libbeat clients with varying proxy settings, and verify that the clients ping the correct target URL. This is a preparation for #11713, since most of the logic (and work) is in testing the proxy settings; the much simpler PR adding the proxy-disable flag will be a followup to this one, to keep the functional changes isolated in case of rollbacks etc. * [Metricbeat](Etcd-Leader)Followers wont report leader metrics (#12004) * manage leader metricset so that followers don't report errors nor events * add debug message when skipping leader events from non leader members * Add package libbeat/common/cleanup (#12134) * Add package libbeat/common/cleanup The cleanup package adds helpers for deferred optional cleanup on errors. For example: ``` ok := False defer cleanup.IfNot(&ok, func() { ... }) // continue initialization ok = True return // some value ``` * Add changelog entry * [docs] add make fmt to contributing guide (#12118) * Move one changelog entry from breaking change to bug fix (#12146) * Sysmon and Security "modules" for Winlogbeat (#11651) Add pipelines for the Security and Sysmon event logs The Security processor handles just three events to start with - 4624, 4625, and 4648. These are event.category=authentication events. The Sysmon processor handles all event IDs found in the sysmon manifest (sysmon -s). It moves the event_data fields that are in ECS and does some type conversions. * [Auditbeat] Process: Add hash of executable (#11722) Adds the hash(es) of the process executable to `process.hash.*`. The default is to add SHA-1 only as `process.hash.sha1`. * [Docs] Comment out section that contains bad link (#12152) * [Filebeat] Introduce UTC as default timezone for modules tests (#12120) Currently all our modules have convert_timezone disable by default. The reason in 6.x for this was probably that 6.0 did not support convert_timezone and we did not want to introduce a breaking changes. New modules should have convert_timezone enabled by default. If a module has convert_timezone enabled by default the tests will fail as it takes the timezone of the local computer. To circumvent this, this PR sets the timezone of the tests to UTC so the same time zone is always used. No generated files were changed in this PR as all modules have convert_timezone off by default. But it will affect #12079 and #12032 * Add number of goroutines to reported metrics (#12135) * Add minimal ES template functionality. (#12103) When loading a template without fields, create a minimal template only applying given configuration, without any default values for mappings and settings. This allows to create additional templates only defining specific values. * Refactor logging in pgsql module (#12151) Guard debug logging statements with "isDebug" checks. And switch the module over to using named loggers. Fixes #12150 * Ignore doc type in ES search API for ES 8 (#12171) * [Docs] Make breaking changes separate files for each version (#12173) * [Filebeat] module for palo_alto (pan-os) logs (#11999) This is a module for Palo Alto Networks PAN-OS logs received via Syslog. It has been tested with logs for PAN-OS version 7.1 to 9.0. However, it is expected to work with earlier versions as the log format is compatible. * [cmd setup] Add and deprecate setup cmds for index handling (#12132) Deprecate `setup --template` and `setup --ilm` in favour of newly introduced `setup --index-management` command. Fix bug in template and write alias creation order to ensure creating properly managed indices. implements #12095 Co-authored-by: [email protected] * Zdd zfs beat (#12136) Querying ZFS Storage and Pool Status * [metricbeat] Expand metricbeat dev guide for testing (#12105) * update dev guide to add examples and expand testing * Bugfix set template.order to 1 by default. (#12160) To ensure default order is not changed to 0, set it to 1 in default config. * [Auditbeat] Fix issues with multiple calls to rpmReadConfigFiles (#12168) This patch fixes two issues in Auditbeat's system/package on RPM distros: - Multiple calls to rpmReadConfigFiles lead to a crash (segmentation fault). It is necessary to call rpmFreeRpmrc after each call to rpmReadConfigFiles. See [1] for a similar issue. - In addition, it is also necessary to call rpmFreeMacros (when available) to avoid leaking memory after each rpmReadConfigFiles call. 1: https://lists.fedorahosted.org/pipermail/anaconda-patches/2015-February/015826.html Fixes #12147 * [Filebeat] Palo_alto module improvements (#12182) This PR adds some missing features to the recently merged palo_alto module: Dashboards (One for traffic logs, one for threats). Sets network.type to either ipv4 or ipv6. Renames palo_alto.pan_os.threat_file_or_url to palo_alto.pan_os.threat.resource. Splits palo_alto.pan_os.threat_id into palo_alto.pan_os.threat.id and palo_alto.pan_os.threat.name. * Add mesosbeat to the community beats (#12185) * Missing module.yml.disabled file for palo_alto (#12191) * [Filebeat] Add RabbitMQ module (#12032) * Parses single and multiline messages from [RabbitMQ's unified log file](https://www.rabbitmq.com/logging.html#log-file-location) * `var.paths` uses the `RABBITMQ_LOGS` env variable if present * `var.convert_timezone` (enabled by default since the [timestamps are localtime by default](https://github.com/erlang-lager/lager#universal-time)) * No dashboard * Tested with ``` ~/go/src/github.com/elastic/beats/x-pack/filebeat [master @ 092a3f5] ✓ ‣ MODULES_PATH=./module GENERATE=1 INTEGRATION_TESTS=1 TESTING_FILEBEAT_MODULES=rabbitmq nosetests tests/system/test_xpack_modules.py -v test_fileset_file_0_rabbitmq (test_xpack_modules.XPackTest) ... ok ---------------------------------------------------------------------- Ran 1 test in 3.320s OK ``` * [metricbeat] Add linux sockstat data to socket_summary metricset (#12050) * add sockstat data to socket_summary * Fix goroutine leak on non-explicit finalization of log inputs (#12164) If log inputs were finished because their context, or one of their ouleters have been finished, then it wasn't stopping its harvesters, leaking resources. * [Metricbeat] CoreDNS module: Add Kibana Dashboard (#11619) * [Metricbeat] CoreDNS module: Add Kibana Dashboard Fixes #10432. * [Libbeat][Metricbeat]Add IgnoreAllErrors to schema.Conv object (#12089) * schema conv option for ignore all errors Co-Authored-By: Jaime Soriano Pastor <[email protected]> * Add `container` input, deprecate `docker` in favor of it (#12162) Add `container` input, deprecate `docker` in favor of it This change adds a new container input for better support of CRI based scenarios. `docker` input was acting as a catch all input for all container related cases, but its config options were very opinionated towards Docker, with some issues: * `containers.ids` setting was good to abstract logs path, but we have seen many cases were logs are not under default location, or follow a different path pattern (ie CRI logs). * `containers.*` settings have shown counter intuitive for many users, in many cases we have seen people writing `container.*` instead, ending up in a config error. * Some existing settings (`combine_partials`, `cri.parse_flags`) were introduced as a way to offer a backwards compatible upgrades, but it doesn't really make sense to disable them, as they handle actual format behaviors. This new `container` input offers the same wrapper to read log files from containers with the following changes: * It exposes `paths` as the `log` input, instead of `containers.ids` and `containers.path`. * `parse_flags` and `combine_partials` are hardcoded, as there is no good reason to disable them. * `stream` selector is still available, under root settings. * It allows to select the log format (also atodetect it), giving room for future format changes. `format` can be `auto` (default), `docker` and `CRI`. Example configurations: Get Docker logs: ``` filebeat.inputs: - type: container paths: - /var/lib/docker/containers/*/*.log ``` Get Kubernetes logs: ``` filebeat.inputs: - type: container paths: - /var/log/pods/*/*/*.log # this could also be used: #- /var/log/containers/*.log ``` Previous `docker` input is deprecated in favor of this, to be removed in 8.0 * [Auditbeat] Fix formatting of config files on macOS and Windows (#12148) Fixes formatting of auditbeat.yml and auditbeat.reference.yml across platforms. * [libbeat] Escape BOM on JsonReader before trying to decode line (#11661) * fix json bom + testing * Set beat ID in registries after loading meta file (#12180) * Reset beat ID in registries in case loaded from meta file * Set, not reset * Adding CHANGELOG entry * [Filebeat] Move dashboards from 8 to 7 directory (#12217) The CoreDNS and Envoyproxy dashboard were in the 8 instead of 7 directory. This PR fixes this. * adjust doc

jsoriano added 5 commits May 2, 2019 23:12

Update instructions for socket metricset on Docker

3d0ec54

Check capabilities instead of root euid for sockets

5e8f1b7

Move capabilities getter to libbeat

ed44cb5

Change cap data abstractions

f31754e

Document and refactor

342a802

jsoriano added enhancement docs libbeat Metricbeat Metricbeat [zube]: In Review labels May 2, 2019

jsoriano requested a review from fearful-symmetry May 2, 2019 23:53

jsoriano requested review from a team as code owners May 2, 2019 23:53

jsoriano self-assigned this May 2, 2019

jsoriano commented May 2, 2019

View reviewed changes

jsoriano changed the title ~~System socket docker docs~~ Document and improve permission checks when running socket metricset from Docker May 3, 2019

andrewkroh reviewed May 3, 2019

View reviewed changes

jsoriano added 8 commits May 3, 2019 17:40

Add specific capabilities instead of full privileges

e8115d7

Use sysinfo instead of syscall for capabilities

7a35630

When running non-privileged, get info from all processes owned by cur…

8c81f67

…rent user

Add changelog

fd291bb

Revert unneeded changes to seccomp

35989a4

Add lines removed by mistake

b50265a

Update metricset description too

f3ff338

Fix goimports

ebdb20e

exekias reviewed May 6, 2019

View reviewed changes

jsoriano added the Team:Integrations Label for the Integrations team label May 6, 2019

zube bot removed the [zube]: In Review label May 6, 2019

zube bot added the [zube]: Inbox label May 6, 2019

jsoriano added [zube]: In Review and removed [zube]: Inbox labels May 6, 2019

Merge remote-tracking branch 'origin/master' into system-socket-docke…

32518ce

…r-docs

fearful-symmetry reviewed May 6, 2019

View reviewed changes

jsoriano added 2 commits May 6, 2019 16:49

Rephrase documentation changes after review feedback

7ac29c5

Typos

3f29501

fearful-symmetry approved these changes May 6, 2019

View reviewed changes

jsoriano added 2 commits May 7, 2019 10:58

Merge remote-tracking branch 'origin/master' into system-socket-docke…

6d8a735

…r-docs

Add build restrictions for windows

0cccca3

exekias approved these changes May 7, 2019

View reviewed changes

Merge remote-tracking branch 'origin/master' into system-socket-docke…

f61add0

…r-docs

jsoriano merged commit 2cbdc9a into elastic:master May 9, 2019

jsoriano deleted the system-socket-docker-docs branch May 9, 2019 14:52

zube bot added [zube]: Done and removed [zube]: In Review labels May 9, 2019

andresrc removed the [zube]: Done label May 20, 2019

jsoriano mentioned this pull request Nov 4, 2019

Document metrics / metricsets that require specific permissions and / or running as root #14385

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document and improve permission checks when running socket metricset from Docker #12039

Document and improve permission checks when running socket metricset from Docker #12039

jsoriano commented May 2, 2019 •

edited by zube bot

Loading

jsoriano May 2, 2019

andrewkroh May 3, 2019

andrewkroh left a comment

andrewkroh May 3, 2019

jsoriano commented May 3, 2019

exekias May 6, 2019

exekias May 6, 2019

fearful-symmetry May 6, 2019

fearful-symmetry May 6, 2019

fearful-symmetry May 6, 2019

jsoriano commented May 6, 2019

jsoriano commented May 8, 2019

jsoriano commented May 9, 2019

Document and improve permission checks when running socket metricset from Docker #12039

Document and improve permission checks when running socket metricset from Docker #12039

Conversation

jsoriano commented May 2, 2019 • edited by zube bot Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andrewkroh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsoriano commented May 3, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsoriano commented May 6, 2019

jsoriano commented May 8, 2019

jsoriano commented May 9, 2019

jsoriano commented May 2, 2019 •

edited by zube bot

Loading