-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into improve-ui-doc-viewer
- Loading branch information
Showing
639 changed files
with
7,245 additions
and
5,192 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
22 changes: 22 additions & 0 deletions
22
...beddable/public/kibana-plugin-plugins-embeddable-public.useembeddablefactory.md
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,22 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) > [useEmbeddableFactory](./kibana-plugin-plugins-embeddable-public.useembeddablefactory.md) | ||
|
|
||
| ## useEmbeddableFactory() function | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| export declare function useEmbeddableFactory<I extends EmbeddableInput>({ input, factory, onInputUpdated, }: EmbeddableRendererWithFactory<I>): readonly [ErrorEmbeddable | IEmbeddable<I, import("./i_embeddable").EmbeddableOutput> | undefined, boolean, string | undefined]; | ||
| ``` | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | { input, factory, onInputUpdated, } | <code>EmbeddableRendererWithFactory<I></code> | | | ||
|
|
||
| <b>Returns:</b> | ||
|
|
||
| `readonly [ErrorEmbeddable | IEmbeddable<I, import("./i_embeddable").EmbeddableOutput> | undefined, boolean, string | undefined]` | ||
|
|
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
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 |
|---|---|---|
| @@ -1,60 +1,164 @@ | ||
| [chapter] | ||
| [role="xpack"] | ||
| [[xpack-siem]] | ||
| = Elastic Security | ||
| = Elastic Security overview | ||
| ++++ | ||
| <titleabbrev>Security</titleabbrev> | ||
| ++++ | ||
|
|
||
| [partintro] | ||
| -- | ||
| https://www.elastic.co/security[Elastic Security] combines SIEM threat detection features with endpoint | ||
| prevention and response capabilities in one solution. These analytical and | ||
| protection capabilities, leveraged by the speed and extensibility of | ||
| Elasticsearch, enable analysts to defend their organization from threats before | ||
| damage and loss occur. | ||
|
|
||
| Elastic Security combines SIEM threat detection features with endpoint | ||
| prevention and response capabilities in one solution, including: | ||
| Elastic Security provides the following security benefits and capabilities: | ||
|
|
||
| * A detection engine to identify attacks and system misconfiguration | ||
| * A detection engine to identify attacks and system misconfigurations | ||
| * A workspace for event triage and investigations | ||
| * Interactive visualizations to investigate process relationships | ||
| * Embedded case management and automated actions | ||
| * Detection of signatureless attacks with prebuilt {ml} anomaly jobs and | ||
| detection rules | ||
| * Inbuilt case management with automated actions | ||
| * Detection of signatureless attacks with prebuilt machine learning anomaly jobs | ||
| and detection rules | ||
|
|
||
| [role="screenshot"] | ||
| image::siem/images/overview-ui.png[Elastic Security in Kibana] | ||
|
|
||
| [float] | ||
| == Add data | ||
|
|
||
| Kibana provides step-by-step instructions to help you add data. The | ||
| {security-guide}[Security Guide] is a good source for more | ||
| detailed information and instructions. | ||
|
|
||
| [float] | ||
| === {Beats} | ||
|
|
||
| https://www.elastic.co/products/beats/auditbeat[{auditbeat}], | ||
| https://www.elastic.co/products/beats/filebeat[{filebeat}], | ||
| https://www.elastic.co/products/beats/winlogbeat[{winlogbeat}], and | ||
| https://www.elastic.co/products/beats/packetbeat[{packetbeat}] | ||
| send security events and other data to Elasticsearch. | ||
| [discrete] | ||
| == Elastic Security components and workflow | ||
|
|
||
| The default index patterns for Elastic Security events are `auditbeat-*`, `winlogbeat-*`, | ||
| `filebeat-*`, `packetbeat-*`, `endgame-*`, `logs-*`, and `apm-*-transaction*`. To change the default pattern patterns, go to *Stack Management > Advanced Settings > securitySolution:defaultIndex*. | ||
| The following diagram provides a comprehensive illustration of the Elastic Security workflow. | ||
|
|
||
| [float] | ||
| === Elastic Security endpoint agent | ||
|
|
||
| The agent detects and protects against malware, and ships host and network | ||
| events directly to Elastic Security. | ||
|
|
||
| [float] | ||
| === Elastic Common Schema (ECS) for normalizing data | ||
|
|
||
| The {ecs-ref}[Elastic Common Schema (ECS)] defines a common set of fields to be | ||
| used for storing event data in Elasticsearch. ECS helps users normalize their | ||
| event data to better analyze, visualize, and correlate the data represented in | ||
| their events. | ||
|
|
||
| Elastic Security can ingest and normalize events from ECS-compatible data sources. | ||
| [role="screenshot"] | ||
| image::../siem/images/workflow.png[] | ||
|
|
||
| Here's an overview of the flow and its components: | ||
|
|
||
| * Data is shipped from your hosts to {es} via beat modules and the Elastic https://www.elastic.co/endpoint-security/[Endpoint Security agent integration]. This integration provides capabilities such as collecting events, detecting and preventing {security-guide}/detection-engine-overview.html#malware-prevention[malicious activity], and artifact delivery. The {fleet-guide}/fleet-overview.html[{fleet}] app is used to | ||
| install and manage agents and integrations on your hosts. | ||
| + | ||
| The Endpoint Security integration ships the following data sets: | ||
| + | ||
| *** *Windows*: Process, network, file, DNS, registry, DLL and driver loads, | ||
| malware security detections | ||
| *** *Linux/macOS*: Process, network, file | ||
| + | ||
| * https://www.elastic.co/integrations?solution=security[Beat modules]: {beats} | ||
| are lightweight data shippers. Beat modules provide a way of collecting and | ||
| parsing specific data sets from common sources, such as cloud and OS events, | ||
| logs, and metrics. Common security-related modules are listed {security-guide}/ingest-data.html#enable-beat-modules[here]. | ||
| * The {security-app} in {kib} is used to manage the *Detection engine*, | ||
| *Cases*, and *Timeline*, as well as administer hosts running Endpoint Security: | ||
| ** Detection engine: Automatically searches for suspicious host and network | ||
| activity via the following: | ||
| *** {security-guide}/detection-engine-overview.html#detection-engine-overview[Detection rules]: Periodically search the data | ||
| ({es} indices) sent from your hosts for suspicious events. When a suspicious | ||
| event is discovered, a detection alert is generated. External systems, such as | ||
| Slack and email, can be used to send notifications when alerts are generated. | ||
| You can create your own rules and make use of our {security-guide}/prebuilt-rules.html[prebuilt ones]. | ||
| *** {security-guide}/detections-ui-exceptions.html[Exceptions]: Reduce noise and the number of | ||
| false positives. Exceptions are associated with rules and prevent alerts when | ||
| an exception's conditions are met. *Value lists* contain source event | ||
| values that can be used as part of an exception's conditions. When | ||
| Elastic {endpoint-sec} is installed on your hosts, you can add malware exceptions | ||
| directly to the endpoint from the Security app. | ||
| *** {security-guide}/machine-learning.html#included-jobs[{ml-cap} jobs]: Automatic anomaly detection of host and | ||
| network events. Anomaly scores are provided per host and can be used with | ||
| detection rules. | ||
| ** {security-guide}/timelines-ui.html[Timeline]: Workspace for investigating alerts and events. | ||
| Timelines use queries and filters to drill down into events related to | ||
| a specific incident. Timeline templates are attached to rules and use predefined | ||
| queries when alerts are investigated. Timelines can be saved and shared with | ||
| others, as well as attached to Cases. | ||
| ** {security-guide}/cases-overview.html[Cases]: An internal system for opening, tracking, and sharing | ||
| security issues directly in the Security app. Cases can be integrated with | ||
| external ticketing systems. | ||
| ** {security-guide}/admin-page-ov.html[Administration]: View and manage hosts running {endpoint-sec}. | ||
|
|
||
| {security-guide}/ingest-data.html[Ingest data to Elastic Security] and {security-guide}/install-endpoint.html[Configure and install the Elastic Endpoint integration] describe how to ship security-related | ||
| data to {es}. | ||
|
|
||
|
|
||
| For more background information, see: | ||
|
|
||
| * https://www.elastic.co/products/elasticsearch[{es}]: A real-time, | ||
| distributed storage, search, and analytics engine. {es} excels at indexing | ||
| streams of semi-structured data, such as logs or metrics. | ||
| * https://www.elastic.co/products/kibana[{kib}]: An open-source analytics and | ||
| visualization platform designed to work with {es}. You use {kib} to search, | ||
| view, and interact with data stored in {es} indices. You can easily compile | ||
| advanced data analysis and visualize your data in a variety of charts, tables, | ||
| and maps. | ||
|
|
||
| [discrete] | ||
| === Compatibility with cold tier nodes | ||
|
|
||
| Cold tier is a {ref}/data-tiers.html[data tier] that holds time-series data that is accessed only occasionally. In {stack} version >=7.11.0, {elastic-sec} supports cold tier data for the following {es} indices: | ||
|
|
||
| * Index patterns specified in `securitySolution:defaultIndex` | ||
| * Index patterns specified in the definitions of detection rules, except for indicator match rules | ||
| * Index patterns specified in the data sources selector on various {security-app} pages | ||
|
|
||
| {elastic-sec} does NOT support cold tier data for the following {es} indices: | ||
|
|
||
| * Index patterns controlled by {elastic-sec}, including signals and list indices | ||
| * Index patterns specified in indicator match rules | ||
|
|
||
| Using cold tier data for unsupported indices may result in detection rule timeouts and overall performance degradation. | ||
|
|
||
| [discrete] | ||
| [[self-protection]] | ||
| ==== Elastic Endpoint self-protection | ||
|
|
||
| Self-protection means that {elastic-endpoint} has guards against users and attackers that may try to interfere with its functionality. This protection feature is consistently enhanced to prevent attackers who may attempt to use newer, more sophisticated tactics to interfere with the {elastic-endpoint}. Self-protection is enabled by default when {elastic-endpoint} installs on supported platforms, listed below. | ||
|
|
||
| Self-protection is enabled on the following 64-bit Windows versions: | ||
|
|
||
| * Windows 8.1 | ||
| * Windows 10 | ||
| * Windows Server 2012 R2 | ||
| * Windows Server 2016 | ||
| * Windows Server 2019 | ||
|
|
||
| And on the following macOS versions: | ||
|
|
||
| * macOS 10.15 (Catalina) | ||
| * macOS 11 (Big Sur) | ||
|
|
||
| NOTE: Other Windows and macOS variants (and all Linux distributions) do not have self-protection. | ||
|
|
||
| For {stack} version >= 7.11.0, self-protection defines the following permissions: | ||
|
|
||
| * Users -- even Administrator/root -- *cannot* delete {elastic-endpoint} files (located at `c:\Program Files\Elastic\Endpoint` on Windows, and `/Library/Elastic/Endpoint` on macOS). | ||
| * Users *cannot* terminate the {elastic-endpoint} program or service. | ||
| * Administrator/root users *can* read the endpoint's files. On Windows, the easiest way to read Endpoint files is to start an Administrator `cmd.exe` prompt. On macOS, an Administrator can use the `sudo` command. | ||
| * Administrator/root users *can* stop the {elastic-agent}'s service. On Windows, run the `sc stop "Elastic Agent"` command. On macOS, run the `sudo launchctl stop elastic-agent` command. | ||
|
|
||
|
|
||
| [discrete] | ||
| [[siem-integration]] | ||
| === Integration with other Elastic products | ||
|
|
||
| You can use {elastic-sec} with other Elastic products and features to help you | ||
| identify and investigate suspicious activity: | ||
|
|
||
| * https://www.elastic.co/products/stack/machine-learning[{ml-cap}] | ||
| * https://www.elastic.co/products/stack/alerting[Alerting] | ||
| * https://www.elastic.co/products/stack/canvas[Canvas] | ||
|
|
||
| [discrete] | ||
| [[data-sources]] | ||
| === APM transaction data sources | ||
|
|
||
| By default, {elastic-sec} monitors {apm-app-ref}/apm-getting-started.html[APM] | ||
| `apm-*-transaction*` indices. To add additional APM indices, update the | ||
| index patterns in the `securitySolution:defaultIndex` setting ({kib} -> Stack Management -> Advanced Settings -> `securitySolution:defaultIndex`). | ||
|
|
||
| -- | ||
| [discrete] | ||
| [[ecs-compliant-reqs]] | ||
| === ECS compliance data requirements | ||
|
|
||
| The {ecs-ref}[Elastic Common Schema (ECS)] defines a common set of fields used for | ||
| storing event data in Elasticsearch. ECS helps users normalize their event data | ||
| to better analyze, visualize, and correlate the data represented in their | ||
| events. {elastic-sec} supports events and indicator index data from any ECS-compliant data source. | ||
|
|
||
| include::siem-ui.asciidoc[] | ||
| include::machine-learning.asciidoc[] | ||
| IMPORTANT: {elastic-sec} requires {ecs-ref}[ECS-compliant data]. If you use third-party data collectors to ship data to {es}, the data must be mapped to ECS. | ||
| {security-guide}/siem-field-reference.html[Elastic Security ECS field reference] lists ECS fields used in {elastic-sec}. |
Oops, something went wrong.