-
Notifications
You must be signed in to change notification settings - Fork 439
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial release of Falco integration (#9619)
This is an initial release of a new integration for Falco. It captures events (called Alerts in Falco) that are created by Falco's Rules.
- Loading branch information
Showing
31 changed files
with
5,643 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
Elastic License 2.0 | ||
|
||
URL: https://www.elastic.co/licensing/elastic-license | ||
|
||
## Acceptance | ||
|
||
By using the software, you agree to all of the terms and conditions below. | ||
|
||
## Copyright License | ||
|
||
The licensor grants you a non-exclusive, royalty-free, worldwide, | ||
non-sublicensable, non-transferable license to use, copy, distribute, make | ||
available, and prepare derivative works of the software, in each case subject to | ||
the limitations and conditions below. | ||
|
||
## Limitations | ||
|
||
You may not provide the software to third parties as a hosted or managed | ||
service, where the service provides users with access to any substantial set of | ||
the features or functionality of the software. | ||
|
||
You may not move, change, disable, or circumvent the license key functionality | ||
in the software, and you may not remove or obscure any functionality in the | ||
software that is protected by the license key. | ||
|
||
You may not alter, remove, or obscure any licensing, copyright, or other notices | ||
of the licensor in the software. Any use of the licensor’s trademarks is subject | ||
to applicable law. | ||
|
||
## Patents | ||
|
||
The licensor grants you a license, under any patent claims the licensor can | ||
license, or becomes able to license, to make, have made, use, sell, offer for | ||
sale, import and have imported the software, in each case subject to the | ||
limitations and conditions in this license. This license does not cover any | ||
patent claims that you cause to be infringed by modifications or additions to | ||
the software. If you or your company make any written claim that the software | ||
infringes or contributes to infringement of any patent, your patent license for | ||
the software granted under these terms ends immediately. If your company makes | ||
such a claim, your patent license ends immediately for work on behalf of your | ||
company. | ||
|
||
## Notices | ||
|
||
You must ensure that anyone who gets a copy of any part of the software from you | ||
also gets a copy of these terms. | ||
|
||
If you modify the software, you must include in any modified copies of the | ||
software prominent notices stating that you have modified the software. | ||
|
||
## No Other Rights | ||
|
||
These terms do not imply any licenses other than those expressly granted in | ||
these terms. | ||
|
||
## Termination | ||
|
||
If you use the software in violation of these terms, such use is not licensed, | ||
and your licenses will automatically terminate. If the licensor provides you | ||
with a notice of your violation, and you cease all violation of this license no | ||
later than 30 days after you receive that notice, your licenses will be | ||
reinstated retroactively. However, if you violate these terms after such | ||
reinstatement, any additional violation of these terms will cause your licenses | ||
to terminate automatically and permanently. | ||
|
||
## No Liability | ||
|
||
*As far as the law allows, the software comes as is, without any warranty or | ||
condition, and the licensor will not be liable to you for any damages arising | ||
out of these terms or the use or nature of the software, under any kind of | ||
legal claim.* | ||
|
||
## Definitions | ||
|
||
The **licensor** is the entity offering these terms, and the **software** is the | ||
software the licensor makes available under these terms, including any portion | ||
of it. | ||
|
||
**you** refers to the individual or entity agreeing to these terms. | ||
|
||
**your company** is any legal entity, sole proprietorship, or other kind of | ||
organization that you work for, plus all organizations that have control over, | ||
are under the control of, or are under common control with that | ||
organization. **control** means ownership of substantially all the assets of an | ||
entity, or the power to direct its management and policies by vote, contract, or | ||
otherwise. Control can be direct or indirect. | ||
|
||
**your licenses** are all the licenses granted to you for the software under | ||
these terms. | ||
|
||
**use** means anything you do with the software requiring one of your licenses. | ||
|
||
**trademark** means trademarks, service marks, and similar rights. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
dependencies: | ||
ecs: | ||
reference: git@v8.11.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Falco Integration | ||
This integration allows for the shipping of [Falco](https://falco.org/) alerts to Elastic for observability and organizational awareness. Alerts can then be analyzed by using either the dashboard included with the integration or via the creation of a custom dashboard within Kibana. | ||
|
||
## Data Streams | ||
The Falco integration collects one type of data stream: logs. | ||
|
||
**Logs** The Logs data stream collected by the Falco integration is comprised of Falco Alerts. See more details about Falco Alerts in [Falco's Outputs Documentation](https://falco.org/docs/outputs/). A complete list of potential fields used by this integration can be found in the [Logs reference](#logs-reference) | ||
|
||
## Requirements | ||
|
||
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. | ||
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware. | ||
|
||
Falco must be configured to output alerts to a supported output channel as defined in [Setup](#setup). The system will only receive fields output by Falco's rules. If a rule does not include a desired field the rule must be edited in Falco to add the field. | ||
|
||
This integration is compatible with Falco version 0.37 and above, and should not be expected to perform successfully in lower versions. | ||
|
||
## Setup | ||
|
||
For step-by-step instructions on how to set up an integration, see the {{ url "getting-started-observability" "Getting started" }} guide. | ||
|
||
In order to capture alerts from Falco you **must** configure Falco to output Alerts as JSON to one of the supported channels: [Logfile](#logfile-input) or [TCP Syslog](#tcp-syslog-input). | ||
|
||
**Required:** To configure Falco to output JSON, set the config properties `json_output=true` and `json_include_output_property=true` in Falco's config. See the examples in Falco's [Output Channels documentation](https://falco.org/docs/outputs/channels/#http-output). | ||
|
||
### Logfile Input | ||
|
||
The logfile input reads data from one or more Falco log files using the Elastic Agent. Use this input when the Elastic Agent will be deployed to the same machine as Falco or when Falco's log files are available via a mounted filesystem. | ||
|
||
To use this input Falco must be configured to output alerts to a log file. See Falco's [File Output](https://falco.org/docs/outputs/channels/#file-output) documentation for details. | ||
|
||
### TCP Syslog Input | ||
|
||
The TCP Syslog input allows the Elastic Agent to receive Falco Alerts via remote syslog. Use this input when you want to send data via [Falco Sidekick](https://github.com/falcosecurity/falcosidekick). | ||
|
||
To use this input you will need to deploy the Elastic Agent *first* and then configure and deploy Falco Sidekick to send Alerts to the Agent via Syslog. See [Syslog Output](https://github.com/falcosecurity/falcosidekick/blob/master/docs/outputs/syslog.md) and [Connecting Falco to Sidekick](https://github.com/falcosecurity/falcosidekick?tab=readme-ov-file#connect-falco) for more details. | ||
|
||
## Logs Reference | ||
|
||
### alerts | ||
|
||
Falco alerts can contain a multitude of various fields pertaining to the type of activity on the host machine. | ||
|
||
{{ fields "alerts" }} | ||
|
||
{{ event "alerts" }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
services: | ||
falco-tcp: | ||
image: docker.elastic.co/observability/stream:v0.15.0 | ||
volumes: | ||
- ./sample_syslog:/sample_logs:ro | ||
- ${SERVICE_LOGS_DIR}:/var/log | ||
command: log --start-signal=SIGHUP --delay=5s --addr elastic-agent:9030 -p=tcp /sample_logs/*.log | ||
falco-logfile: | ||
image: alpine | ||
volumes: | ||
- ./sample_logfile:/sample_logs:ro | ||
- ${SERVICE_LOGS_DIR}:/var/log | ||
command: /bin/sh -c "cp /sample_logs/* /var/log/" |
Oops, something went wrong.