Skip to content

Commit 9b9dbe5

Browse files
rseldnermergify[bot]
rseldner
authored and
mergify[bot]
committed
[doc] Noted blocklisted files are quarantined (#5918)
* Update configure-integration-policy.asciidoc - Noted we quarantine blocklisted files Explicitly noted block listed files are quarantined * Fix typo * Apply change to serverless docs --------- Co-authored-by: Joe Peeples <[email protected]> (cherry picked from commit 6e01499) # Conflicts: # docs/serverless/edr-install-config/configure-endpoint-integration-policy.mdx
1 parent 0443794 commit 9b9dbe5

File tree

2 files changed

+280
-1
lines changed

2 files changed

+280
-1
lines changed

‎docs/getting-started/configure-integration-policy.asciidoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ image::images/install-endpoint/malware-protection.png[Detail of malware protecti
8484
[[manage-quarantined-files]]
8585
=== Manage quarantined files
8686

87-
When *Prevent* is enabled for malware protection, {elastic-defend} will quarantine any malicious file it finds. Specifically {elastic-defend} will remove the file from its current location, encrypt it with the encryption key `ELASTIC`, move it to a different folder, and rename it as a GUID string, such as `318e70c2-af9b-4c3a-939d-11410b9a112c`.
87+
When *Prevent* is enabled for malware protection, {elastic-defend} will quarantine any malicious file it finds (this includes files defined in the <<blocklist>>). Specifically {elastic-defend} will remove the file from its current location, encrypt it with the encryption key `ELASTIC`, move it to a different folder, and rename it as a GUID string, such as `318e70c2-af9b-4c3a-939d-11410b9a112c`.
8888

8989
The quarantine folder location varies by operating system:
9090

‎docs/serverless/edr-install-config/configure-endpoint-integration-policy.mdx‎

Lines changed: 279 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,279 @@
1+
---
2+
slug: /serverless/security/configure-endpoint-integration-policy
3+
title: Configure an integration policy for ((elastic-defend))
4+
description: Configure settings on an ((elastic-defend)) integration policy.
5+
tags: [ 'serverless', 'security', 'how-to' ]
6+
status: in review
7+
---
8+
9+
<DocBadge template="technical preview" />
10+
<div id="configure-endpoint-integration-policy"></div>
11+
12+
After the ((agent)) is installed with the ((elastic-defend)) integration, several protections features — including
13+
preventions against malware, ransomware, memory threats, and malicious behavior — are automatically enabled
14+
on protected hosts (most features require the Endpoint Protection Essentials or Endpoint Protection Complete <DocLink slug="/serverless/elasticsearch/manage-project" text="project feature"/>). If needed, you can update the
15+
integration policy to configure protection settings, event collection, antivirus settings, trusted applications,
16+
event filters, host isolation exceptions, and blocked applications to meet your organization's security needs.
17+
18+
You can also create multiple ((elastic-defend)) integration policies to maintain unique configuration profiles. To create an additional ((elastic-defend)) integration policy, go to **Project settings** → **Integrations**, then follow the steps for <DocLink slug="/serverless/security/install-edr" section="add-the-((elastic-defend))-integration">adding the ((elastic-defend)) integration</DocLink>.
19+
20+
<DocCallOut title="Requirements">
21+
22+
You must have the appropriate user role to configure an integration policy.
23+
24+
</DocCallOut>
25+
26+
{/* Commented out because APIs are not exposed in initial serverless release. We can uncommment this and add a link to API docs once APIs are available.
27+
<DocCallOut title="Tip">
28+
In addition to configuring an {elastic-defend} policy through the ((elastic-sec)) UI, you can create and customize an ((elastic-defend)) policy through the API.
29+
</DocCallOut>
30+
*/}
31+
32+
To configure an integration policy:
33+
34+
1. Go to **Assets** → **Endpoints** → **Policies** to view the **Policies** page.
35+
1. Select the integration policy you want to configure. The integration policy configuration page appears.
36+
1. On the **Policy settings** tab, review and configure the following settings as appropriate:
37+
38+
* <DocLink slug="/serverless/security/configure-endpoint-integration-policy" section="malware-protection">Malware protection</DocLink>
39+
* <DocLink slug="/serverless/security/configure-endpoint-integration-policy" section="ransomware-protection">Ransomware protection</DocLink>
40+
* <DocLink slug="/serverless/security/configure-endpoint-integration-policy" section="memory-threat-protection">Memory threat protection</DocLink>
41+
* <DocLink slug="/serverless/security/configure-endpoint-integration-policy" section="malicious-behavior-protection">Malicious behavior protection</DocLink>
42+
* <DocLink slug="/serverless/security/configure-endpoint-integration-policy" section="attack-surface-reduction">Attack surface reduction</DocLink>
43+
* <DocLink slug="/serverless/security/configure-endpoint-integration-policy" section="event-collection">Event collection</DocLink>
44+
* <DocLink slug="/serverless/security/configure-endpoint-integration-policy" section="register-as-antivirus">Register ((elastic-sec)) as antivirus (optional)</DocLink>
45+
* <DocLink slug="/serverless/security/configure-endpoint-integration-policy" section="advanced-policy-settings-optional">Advanced policy settings (optional)</DocLink>
46+
* <DocLink slug="/serverless/security/configure-endpoint-integration-policy" section="save-the-general-policy-settings">Save the general policy settings</DocLink>
47+
48+
1. Click the **Trusted applications**, **Event filters**, **Host isolation exceptions**, and **Blocklist** tabs to review the endpoint policy artifacts assigned to this integration policy (for more information, refer to <DocLink slug="/serverless/security/trusted-applications">trusted applications</DocLink>, <DocLink slug="/serverless/security/event-filters">event filters</DocLink>, <DocLink slug="/serverless/security/host-isolation-exceptions">host isolation exceptions</DocLink>, and <DocLink slug="/serverless/security/blocklist">blocklist</DocLink>). On these tabs, you can:
49+
50+
* Expand and view an artifact — Click the arrow next to its name.
51+
* View an artifact's details — Click the actions menu (<DocIcon type="boxesHorizontal" title="Actions menu" size="m" />), then select **View full details**.
52+
* Unassign an artifact — Click the actions menu (<DocIcon type="boxesHorizontal" title="Actions menu" size="m" />),
53+
then select **Remove from policy**. This does not delete the artifact; this just unassigns it from the current policy.
54+
* Assign an existing artifact — Click **Assign _x_ to policy**,
55+
then select an item from the flyout. This view lists any existing artifacts that aren't already assigned to the current policy.
56+
57+
<DocCallOut title="Note">
58+
You can't create a new endpoint policy artifact while configuring an integration policy.
59+
To create a new artifact, go to its main page in the ((security-app)) (for example,
60+
to create a new trusted application, go to **Assets** → **Endpoints** → **Trusted applications**).
61+
</DocCallOut>
62+
63+
1. Click the **Protection updates** tab to configure how ((elastic-defend)) receives updates from Elastic with the latest threat detections, malware models, and other protection artifacts. Refer to <DocLink slug="/serverless/security/protection-artifact-control"/> for more information.
64+
65+
<div id="malware-protection"></div>
66+
67+
## Malware protection
68+
69+
((elastic-defend)) malware prevention detects and stops malicious attacks by using a <DocLink slug="/serverless/security/detection-engine-overview" section="machine-learning-model">machine learning model</DocLink>
70+
that looks for static attributes to determine if a file is malicious or benign.
71+
72+
By default, malware protection is enabled on Windows, macOS, and Linux hosts.
73+
To disable malware protection, turn off the **Malware protections** toggle.
74+
75+
<DocCallOut title="Requirements">
76+
77+
Malware protection requires the Endpoint Protection Essentials <DocLink slug="/serverless/elasticsearch/manage-project" text="project feature"/>.
78+
79+
</DocCallOut>
80+
81+
Malware protection levels are:
82+
83+
* **Detect**: Detects malware on the host and generates an alert. The agent will **not** block malware.
84+
You must pay attention to and analyze any malware alerts that are generated.
85+
86+
* **Prevent** (Default): Detects malware on the host, blocks it from executing, and generates an alert.
87+
88+
These additional options are available for malware protection:
89+
90+
* **Blocklist**: Enable or disable the <DocLink slug="/serverless/security/blocklist">blocklist</DocLink> for all hosts associated with this ((elastic-defend)) policy. The blocklist allows you to prevent specified applications from running on hosts, extending the list of processes that ((elastic-defend)) considers malicious.
91+
92+
* **Scan files upon modification**: By default, ((elastic-defend)) scans files every time they're modified, which can be resource-intensive on hosts where files are frequently modified, such as servers and developer machines. Turn off this option to only scan files when they're executed. ((elastic-defend)) will continue to identify malware as it attempts to run, providing a robust level of protection while improving endpoint performance.
93+
94+
Select **Notify user** to send a push notification in the host operating system when activity is detected or prevented. Notifications are enabled by default for the **Prevent** option.
95+
96+
<DocCallOut title="Tip">
97+
Endpoint Protection Complete customers can customize these notifications using the `Elastic Security {action} {filename}` syntax.
98+
</DocCallOut>
99+
100+
![Detail of malware protection section.](../images/configure-endpoint-integration-policy/-getting-started-install-endpoint-malware-protection.png)
101+
102+
<div id="manage-quarantined-files"></div>
103+
104+
### Manage quarantined files
105+
106+
When **Prevent** is enabled for malware protection, ((elastic-defend)) will quarantine any malicious file it finds (this includes files defined in the <DocLink slug="/serverless/security/blocklist">blocklist</DocLink>). Specifically ((elastic-defend)) will remove the file from its current location, encrypt it with the encryption key `ELASTIC`, move it to a different folder, and rename it as a GUID string, such as `318e70c2-af9b-4c3a-939d-11410b9a112c`.
107+
108+
The quarantine folder location varies by operating system:
109+
110+
- macOS: `/System/Volumes/Data/.equarantine`
111+
- Linux: `.equarantine` at the root of the mount point of the file being quarantined
112+
- Windows - ((elastic-defend)) versions 8.5 and later: `[DriveLetter:]\.quarantine`, unless the files are from the `C:` drive. These files are moved to `C:\Program Files\Elastic\Endpoint\state\.equarantine`.
113+
- Windows - ((elastic-defend)) versions 8.4 and earlier: `[DriveLetter:]\.quarantine`, for any drive
114+
115+
To restore a quarantined file to its original state and location, <DocLink slug="/serverless/security/add-exceptions">add an exception</DocLink> to the rule that identified the file as malicious. If the exception would've stopped the rule from identifying the file as malicious, ((elastic-defend)) restores the file.
116+
117+
You can access a quarantined file by using the `get-file` <DocLink slug="/serverless/security/response-actions" section="response-action-commands">response action command</DocLink> in the response console. To do this, copy the path from the alert's **Quarantined file path** field (`file.Ext.quarantine_path`), which appears under **Highlighted fields** in the alert details flyout. Then paste the value into the `--path` parameter. This action doesn't restore the file to its original location, so you will need to do this manually.
118+
119+
<DocCallOut title="Note">
120+
Response actions and the response console UI are Endpoint Protection Complete <DocLink slug="/serverless/elasticsearch/manage-project" text="project features"/>.
121+
</DocCallOut>
122+
123+
<div id="ransomware-protection"></div>
124+
125+
## Ransomware protection
126+
127+
Behavioral ransomware prevention detects and stops ransomware attacks on Windows systems by
128+
analyzing data from low-level system processes. It is effective across an array of widespread
129+
ransomware families — including those targeting the system’s master boot record.
130+
131+
<DocCallOut title="Requirements">
132+
133+
Ransomware protection requires the Endpoint Protection Essentials <DocLink slug="/serverless/elasticsearch/manage-project" text="project feature"/>.
134+
135+
</DocCallOut>
136+
137+
Ransomware protection levels are:
138+
139+
* **Detect**: Detects ransomware on the host and generates an alert. ((elastic-defend))
140+
will **not** block ransomware. You must pay attention to and analyze any ransomware alerts that are generated.
141+
142+
* **Prevent** (Default): Detects ransomware on the host, blocks it from executing,
143+
and generates an alert.
144+
145+
When ransomware protection is enabled, canary files placed in targeted locations on your hosts provide an early warning system for potential ransomware activity. When a canary file is modified, Elastic Defend immediately generates a ransomware alert. If **prevent** ransomware is active, ((elastic-defend)) terminates the process that modified the file.
146+
147+
Select **Notify user** to send a push notification in the host operating system when activity is detected or prevented. Notifications are enabled by default for the **Prevent** option.
148+
149+
<DocCallOut title="Tip">
150+
Endpoint Protection Complete customers can customize these notifications using the `Elastic Security {action} {filename}` syntax.
151+
</DocCallOut>
152+
153+
![Detail of ransomware protection section.](../images/configure-endpoint-integration-policy/-getting-started-install-endpoint-ransomware-protection.png)
154+
155+
<div id="memory-protection"></div>
156+
157+
## Memory threat protection
158+
159+
Memory threat protection detects and stops in-memory threats, such as shellcode injection,
160+
which are used to evade traditional file-based detection techniques.
161+
162+
<DocCallOut title="Requirements">
163+
164+
Memory threat protection requires the Endpoint Protection Essentials <DocLink slug="/serverless/elasticsearch/manage-project" text="project feature"/>.
165+
166+
</DocCallOut>
167+
168+
Memory threat protection levels are:
169+
170+
* **Detect**: Detects memory threat activity on the host and generates an alert.
171+
((elastic-defend)) will **not** block the in-memory activity. You must pay attention to and analyze any alerts that are generated.
172+
173+
* **Prevent** (Default): Detects memory threat activity on the host, forces the process
174+
or thread to stop, and generates an alert.
175+
176+
Select **Notify user** to send a push notification in the host operating system when activity is detected or prevented. Notifications are enabled by default for the **Prevent** option.
177+
178+
<DocCallOut title="Tip">
179+
Endpoint Protection Complete customers can customize these notifications using the `Elastic Security {action} {rule}` syntax.
180+
</DocCallOut>
181+
182+
![Detail of memory protection section.](../images/configure-endpoint-integration-policy/-getting-started-install-endpoint-memory-protection.png)
183+
184+
<div id="behavior-protection"></div>
185+
186+
## Malicious behavior protection
187+
188+
Malicious behavior protection detects and stops threats by monitoring the behavior
189+
of system processes for suspicious activity. Behavioral signals are much more difficult
190+
for adversaries to evade than traditional file-based detection techniques.
191+
192+
<DocCallOut title="Requirements">
193+
194+
Malicious behavior protection requires the Endpoint Protection Essentials <DocLink slug="/serverless/elasticsearch/manage-project" text="project feature"/>.
195+
196+
</DocCallOut>
197+
198+
Malicious behavior protection levels are:
199+
200+
* **Detect**: Detects malicious behavior on the host and generates an alert.
201+
((elastic-defend)) will **not** block the malicious behavior. You must pay attention to and analyze any alerts that are generated.
202+
203+
* **Prevent** (Default): Detects malicious behavior on the host, forces the process to stop,
204+
and generates an alert.
205+
206+
Select whether you want to use **Reputation service** for additional protection. Elastic's reputation service leverages our extensive threat intelligence knowledge to make high confidence real-time prevention decisions. For example, reputation service can detect suspicious downloads of binaries with low or malicious reputation. Endpoints communicate with the reputation service directly at https://cloud.security.elastic.co.
207+
208+
Select **Notify user** to send a push notification in the host operating system when activity is detected or prevented. Notifications are enabled by default for the **Prevent** option.
209+
210+
<DocCallOut title="Tip">
211+
Endpoint Protection Complete customers can customize these notifications using the `Elastic Security {action} {rule}` syntax.
212+
</DocCallOut>
213+
214+
![Detail of behavior protection section.](../images/configure-endpoint-integration-policy/-getting-started-install-endpoint-behavior-protection.png)
215+
216+
<div id="attack-surface-reduction"></div>
217+
218+
## Attack surface reduction
219+
220+
This section helps you reduce vulnerabilities that attackers can target on Windows endpoints.
221+
222+
<DocCallOut title="Requirements">
223+
224+
Attack surface reduction requires the Endpoint Protection Essentials <DocLink slug="/serverless/elasticsearch/manage-project" text="project feature"/>.
225+
226+
</DocCallOut>
227+
228+
* **Credential hardening**: Prevents attackers from stealing credentials stored in Windows system process memory. Turn on the toggle to remove any overly permissive access rights that aren't required for standard interaction with the Local Security Authority Subsystem Service (LSASS). This feature enforces the principle of least privilege without interfering with benign system activity that is related to LSASS.
229+
230+
![Detail of attack surface reduction section.](../images/configure-endpoint-integration-policy/-getting-started-install-endpoint-attack-surface-reduction.png)
231+
232+
<div id="event-collection"></div>
233+
234+
## Event collection
235+
236+
In the **Settings** section, select which categories of events to collect on each operating system.
237+
Most categories are collected by default, as seen below.
238+
239+
![Detail of event collection section.](../images/configure-endpoint-integration-policy/-getting-started-install-endpoint-event-collection.png)
240+
241+
<div id="register-as-antivirus"></div>
242+
243+
## Register ((elastic-sec)) as antivirus (optional)
244+
245+
With ((elastic-defend)) version 7.10 or later on Windows 7 or later, you can
246+
register ((elastic-sec)) as your hosts' antivirus software by enabling **Register as antivirus**.
247+
248+
<DocCallOut title="Note">
249+
Windows Server is not supported. Antivirus registration requires Windows Security Center, which is not included in Windows Server operating systems.
250+
</DocCallOut>
251+
252+
By default, the **Sync with malware protection level** is selected to automatically set antivirus registration to match how you've configured ((elastic-defend))'s <DocLink slug="/serverless/security/configure-endpoint-integration-policy" section="malware-protection">malware protection</DocLink>. If malware protection is turned on _and_ set to **Prevent**, antivirus registration will also be enabled; in any other case, antivirus registration will be disabled.
253+
254+
If you don't want to sync antivirus registration, you can set it manually with **Enabled** or **Disabled**.
255+
256+
![Detail of Register as antivirus option.](../images/configure-endpoint-integration-policy/-getting-started-register-as-antivirus.png)
257+
258+
<div id="adv-policy-settings"></div>
259+
260+
## Advanced policy settings (optional)
261+
262+
Users with unique configuration and security requirements can select **Show advanced settings**
263+
to configure the policy to support advanced use cases. Hover over each setting to view its description.
264+
265+
<DocCallOut title="Note">
266+
Advanced settings are not recommended for most users.
267+
</DocCallOut>
268+
269+
This section includes:
270+
271+
* <DocLink slug="/serverless/security/endpoint-diagnostic-data">Turn off diagnostic data for ((elastic-defend))</DocLink>
272+
* <DocLink slug="/serverless/security/self-healing-rollback">Configure self-healing rollback for Windows endpoints</DocLink>
273+
* <DocLink slug="/serverless/security/linux-file-monitoring">Configure Linux file system monitoring</DocLink>
274+
275+
<div id="save-policy"></div>
276+
277+
## Save the general policy settings
278+
279+
After you have configured the general settings on the **Policy settings** tab, click **Save**. A confirmation message appears.

0 commit comments

Comments
 (0)