Skip to content

Commit 2ca351a

Browse files
authored
Siem guide 7.x (#376)
* Add siem guide for 7.x * Remove additional beta notice
1 parent ebcb71f commit 2ca351a

File tree

10 files changed

+319
-44
lines changed

10 files changed

+319
-44
lines changed

docs/en/siem/images/add-data.png

116 KB
Loading

docs/en/siem/images/hosts-ui.png

150 KB
Loading

docs/en/siem/images/network-ui.png

110 KB
Loading
109 KB
Loading
31.6 KB
Loading
218 KB
Loading

docs/en/siem/index.asciidoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
:doctype: book
2-
:siem-soln-cap: SIEM Monitoring
3-
:siem-soln: SIEM monitoring
2+
:siem-soln: SIEM
3+
:siem-app: SIEM app
44
:siem-ui: SIEM UI
55

6-
= SIEM Solution Guide
76

8-
//include::{asciidoc-dir}/../../shared/versions.asciidoc[]
7+
= SIEM Guide (Beta)
8+
9+
include::{asciidoc-dir}/../../shared/versions.asciidoc[]
910

1011
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
1112

1213
include::overview.asciidoc[]
1314

14-
//include::installation.asciidoc[]
15+
include::installation.asciidoc[]
1516

16-
//include::siem-ui.asciidoc[]
17+
include::siem-ui.asciidoc[]
1718

docs/en/siem/installation.asciidoc

Lines changed: 70 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,10 @@
44

55
beta[]
66

7-
To get up and running with security monitoring, you need:
7+
You need:
88

9-
* An Elasticsearch cluster and Kibana (version 6.x or later) with a basic
10-
license. To learn how to get started quickly, see
11-
{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}].
9+
* An *Elasticsearch* cluster and *Kibana* (version 7.2 or later) with a basic
10+
license. See {stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}].
1211
+
1312
[TIP]
1413
==============
@@ -19,24 +18,82 @@ https://www.elastic.co/cloud/elasticsearch-service/signup[Try the {es}
1918
Service for free].
2019
==============
2120

22-
* {beats} shippers (version 6.x or later) installed on each system you want to
21+
* *{beats}* shippers (version 7.x or later) installed for each system you want to
2322
monitor
2423

2524
You might need to modify UI settings in {kib} to change default behaviors,
26-
such as the index pattern used to query the data, and the timestamp field used
27-
for sorting. For more information, see {kib}.
25+
such as the index pattern used to query the data. For more information, see {kib}.
2826

2927
[float]
3028
[[install-beats]]
3129
=== Install {beats} shippers
3230

33-
To populate the security UI with metrics and
34-
log data, you need to install and configure the following shippers:
31+
To populate the {siem-app} with hosts and network security events, you need to install and
32+
configure Beats on the systems from which you want to ingest security events:
3533

36-
* https://www.elastic.co/products/beats/packetbeat[{packetbeat}] for analyzing
37-
network packets
3834
* https://www.elastic.co/products/beats/filebeat[{filebeat}] for forwarding and
3935
centralizing logs and files
40-
* https://www.elastic.co/products/beats/auditbeat[{auditbeat}] for monitoring
41-
directories for file changes
36+
* https://www.elastic.co/products/beats/auditbeat[{auditbeat}] for collecting security events
37+
* https://www.elastic.co/products/beats/winlogbeat[{winlogbeat}] for centralizing
38+
Windows event logs
39+
* https://www.elastic.co/products/beats/packetbeat[{packetbeat}] for analyzing
40+
network packets
41+
42+
NOTE: {siem-soln} also works with custom and third-party data sources in addition to
43+
those supported by Beats. {ecs-ref}[Elastic Common Schema (ECS)] makes this
44+
possible.
45+
46+
You can install {beats} using a {kib}-based guide or directly from the command line.
47+
48+
[float]
49+
==== Install {beats} using the {kib}-based guide
50+
51+
Follow the instructions in the Add Data section of the {kib} home page. Click
52+
*Add log data* or *Add metrics*, and follow the links for the types of data you
53+
want to collect.
54+
55+
[role="screenshot"]
56+
image::add-data.png[]
57+
58+
[float]
59+
==== Download and install {beats} from the command line
60+
61+
If your data source isn't in the list, or you want to install {beats} the old
62+
fashioned way:
63+
64+
* *{filebeat} and {filebeat} modules.* See the
65+
{filebeat-ref}/filebeat-modules-quickstart.html[{filebeat} modules quick start]
66+
and enable modules for the events you want to collect. If there is no module
67+
for the events you want to collect, see the
68+
{filebeat-ref}/filebeat-getting-started.html[{filebeat} getting started] to
69+
learn how to configure inputs.
70+
71+
* *Auditbeat.* See {auditbeat-ref}/auditbeat-getting-started.html[{auditbeat} getting started].
72+
73+
* *Winlogbeat.* See {winlogbeat-ref}/winlogbeat-getting-started.html[{winlogbeat} getting started].
74+
75+
* *Packetbeat.* See {packetbeat-ref}/packetbeat-getting-started.html[{packetbeat} getting started].
76+
77+
[float]
78+
=== Enable modules and configuration options
79+
80+
For either approach, you need to enable modules in {auditbeat} and {filebeat}
81+
to populate the {SIEM-app} with data.
82+
83+
To populate *Hosts* data, enable these {auditbeat} modules:
84+
85+
* {auditbeat-ref}/auditbeat-module-system.html[System module - Linux, macOS, Win]
86+
* {auditbeat-ref}/auditbeat-module-auditd.html[Auditd module (Linux Kernel Audit info)]
87+
* {auditbeat-ref}/auditbeat-module-file_integrity.html[File integrity module (FIM) - Linux, macOS, Win]
88+
89+
90+
To populate *Network* data, enable these {filebeat} modules:
4291

92+
* https://www.elastic.co/products/beats/filebeat[{filebeat}]
93+
* {filebeat-ref}/filebeat-module-zeek.html[Zeek NMS module]
94+
* {filebeat-ref}/filebeat-module-suricata.html[Suricata IDS module]
95+
* {filebeat-ref}/filebeat-module-iptables.html[Iptables/Ubiquiti module]
96+
* {filebeat-ref}/filebeat-module-coredns.html[CoreDNS module]
97+
* {filebeat-ref}/filebeat-module-envoyproxy.html[Envoy proxy module (Kubernetes)]
98+
* {filebeat-ref}/filebeat-module-panw.html[Palo Alto Networks firewall module]
99+
* {filebeat-ref}//filebeat-module-cisco.html[Cisco ASA firewall module]

docs/en/siem/overview.asciidoc

Lines changed: 88 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,29 @@
11
[[siem-overview]]
2-
//[role="xpack"]
3-
//== Overview
2+
[role="xpack"]
3+
== Overview
44

5-
6-
== Coming soon
7-
8-
Won't be long now!
9-
10-
////
115
beta[]
126

13-
{siem-soln-cap} gives you a comprehensive view into your security operations,
14-
and helps make those insights actionable.
7+
{siem-soln} enables analysis of host-related and network-related security events
8+
as part of alert investigations or interactive threat hunting.
159

16-
The UI in {kib} brings together data from a variety of sources, making it easier
17-
for you to identify and resolve security issues.
10+
The {siem-app} in {kib} provides an interactive workspace for security teams to
11+
triage events and perform initial investigations.
1812

1913
[float]
2014
[[siem-components]]
21-
=== SIEM monitoring components
15+
=== SIEM components
2216

23-
Security monitoring requires the following {stack} components.
17+
SIEM requires the following {stack} components.
2418

2519
image::images/siem-architecture.png[]
2620

27-
*https://www.elastic.co/products/beats[{beats}]* are open source data
28-
shippers that you install as agents on your servers to send operational data to
29-
{es}.
21+
*https://www.elastic.co/products/beats[{beats}]* are open source data shippers
22+
that you install as agents on your systems. {beats} send security events and other
23+
data to {es}.
3024

3125
*https://www.elastic.co/products/elasticsearch[{es}]* is a real-time,
32-
distributed storage, search, and analytics engine. {es} excels is indexing
26+
distributed storage, search, and analytics engine. {es} excels at indexing
3327
streams of semi-structured data, such as logs or metrics.
3428

3529
*https://www.elastic.co/products/kibana[{kib}]* is an open source analytics and
@@ -38,5 +32,79 @@ view, and interact with data stored in {es} indices. You can easily perform
3832
advanced data analysis and visualize your data in a variety of charts, tables,
3933
and maps.
4034

41-
{kib} {siem-ui} provides a dedicated user interface for visualizing host security.
42-
////
35+
The {siem-app} in {kib} provides a dedicated user interface for analyzing and
36+
investigating host and network security events.
37+
38+
[float]
39+
[[siem-integration]]
40+
==== Additional Elastic components
41+
42+
You can use {siem-soln} with other Elastic products and features to help you
43+
identify and investigate suspicious activity:
44+
45+
* https://www.elastic.co/products/stack/machine-learning[{ml-cap}]
46+
* https://www.elastic.co/products/stack/alerting[Alerting]
47+
* https://www.elastic.co/products/stack/canvas[Canvas]
48+
49+
[float]
50+
[[data-sources]]
51+
=== Data sources
52+
53+
SIEM can ingest and analyze data from a variety of sources, including Beats
54+
and Beats modules, and third-party collectors mapped to the {ecs-ref}[Elastic
55+
Common Schema (ECS)].
56+
57+
[float]
58+
[[hosts-data-sources]]
59+
==== Hosts data sources
60+
61+
* https://www.elastic.co/products/beats/auditbeat[{auditbeat}]
62+
** {auditbeat-ref}/auditbeat-module-system.html[System module - Linux, macOS, Win]
63+
*** packages
64+
*** processes
65+
*** logins
66+
*** sockets
67+
*** users and groups
68+
** {auditbeat-ref}/auditbeat-module-auditd.html[Auditd module (Linux Kernel Audit info)]
69+
** {auditbeat-ref}/auditbeat-module-file_integrity.html[File integrity module (FIM) - Linux, macOS, Win]
70+
* https://www.elastic.co/products/beats/filebeat[{filebeat}]
71+
** system logs (auth logs) - Linux
72+
** Santa - macOS
73+
* https://www.elastic.co/products/beats/winlogbeat[{winlogbeat}]
74+
** Windows event logs - Windows
75+
76+
[float]
77+
[[network-data-sources]]
78+
==== Network data sources
79+
80+
* https://www.elastic.co/products/beats/packetbeat[{packetbeat}]
81+
** Flows
82+
** DNS
83+
** other protocols
84+
* https://www.elastic.co/products/beats/filebeat[{filebeat}]
85+
** {filebeat-ref}/filebeat-module-zeek.html[Zeek NMS module]
86+
** {filebeat-ref}/filebeat-module-suricata.html[Suricata IDS module]
87+
** {filebeat-ref}/filebeat-module-iptables.html[Iptables/Ubiquiti module]
88+
** {filebeat-ref}/filebeat-module-coredns.html[CoreDNS module]
89+
** {filebeat-ref}/filebeat-module-envoyproxy.html[Envoy proxy module (Kubernetes)]
90+
** {filebeat-ref}/filebeat-module-panw.html[Palo Alto Networks firewall module]
91+
** {filebeat-ref}//filebeat-module-cisco.html[Cisco ASA firewall module]
92+
93+
[float]
94+
[[ecs]]
95+
==== Elastic Common Schema (ECS) for normalizing data
96+
97+
The {ecs-ref}[Elastic Common Schema (ECS)] defines a common set of fields to be used for
98+
storing event data in Elasticsearch. ECS helps users normalize their event data
99+
to better analyze, visualize, and correlate the data represented in their
100+
events.
101+
102+
{siem-soln} can ingest and normalize events from ECS-compatible data sources.
103+
104+
[float]
105+
[[host_id]]
106+
===== Host identification
107+
All Beats use the `add_host_metadata` processor to add the `host.name` field to
108+
events. The default value is `host.name`, but you can change it in Beats
109+
processor settings.
110+

0 commit comments

Comments
 (0)