Skip to content

Commit 16fe6c2

Browse files
narcher7ferullojmikell821
authored
Fix Full Disk Access inaccuracies. (#335)
* Fix Full Disk Access inaccuracies. * Fix typos * Update sensor-full-disk-access.asciidoc * Add system extension instructions * Add image for system extension prompt * Make small tweak to installation instructions about macOS versions * Fix h2 header * Make small editorial updates * Add headers to new sections * Add links to new requirements on install doc * Fix header and version number for system extension * Add clarity to kernal extension prompts * Add clarification around prompts and versioning * Light grammar edits * Fix issue #271 * Add Daniel's feedback * Update docs/getting-started/sensor-full-disk-access.asciidoc Co-authored-by: Daniel Ferullo <56368752+ferullo@users.noreply.github.com> * Update docs/getting-started/sensor-full-disk-access.asciidoc Co-authored-by: Daniel Ferullo <56368752+ferullo@users.noreply.github.com> * Update sensor-full-disk-access.asciidoc * Update docs/getting-started/sensor-full-disk-access.asciidoc Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com> * Update docs/getting-started/sensor-full-disk-access.asciidoc Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com> * Update docs/getting-started/sensor-full-disk-access.asciidoc Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com> * Update docs/getting-started/sensor-full-disk-access.asciidoc Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com> * Replace system-extension image. Give final pieces of feedback * One final tweak * Add back missing word. * Capitalize Full Disk Access * Merge final pieces of feedback Co-authored-by: Daniel Ferullo <56368752+ferullo@users.noreply.github.com> Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
1 parent 6a769b8 commit 16fe6c2

File tree

5 files changed

+91
-14
lines changed

5 files changed

+91
-14
lines changed
103 KB
Loading
97.4 KB
Loading

docs/getting-started/ingest-data.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
To ingest data, you can use:
55

6-
* The Elastic Agent with the **Endpoint Security Integration**, which protects
6+
* The Elastic Agent with the **Elastic Endpoint Integration**, which protects
77
your hosts and sends logs, metrics, and endpoint security data to {es-sec}
88
(see <<install-endpoint>>).
99
* *{beats}* shippers installed for each system you want to monitor.

docs/getting-started/install-endpoint.asciidoc

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ NOTE: Configuring the Endpoint Integration on the Elastic Agent requires that th
1313
[[security-before-you-begin]]
1414
== Before you begin
1515

16-
If you're using the Elastic Agent on macOS Mojave (10.14) or later, ensure that you have enabled <<sensor-full-disk-access,Full Disk Access>>. Lastly, review the <<sec-requirements>>.
16+
Depending on the version of macOS you're using, macOS requires that you give full disk access to different kernels, system extensions, or files. Review <<sensor-full-disk-access>> for details.
1717

1818
[discrete]
1919
[[add-security-integration]]
20-
== Add Elastic Security integration
20+
== Add Elastic Endpoint integration
2121

2222
1. In Kibana, select **Security** > **Administration**. If this is not your first time using Elastic Security, select **Ingest Manager** > **Integrations** and search for "Elastic Endpoint Security".
2323
+
@@ -63,9 +63,9 @@ To unenroll an agent from your host, see {ingest-guide}/unenroll-elastic-agent.h
6363
[[enable-kernel-extension]]
6464
== Enable Elastic Endpoint kernel
6565

66-
When running the {agent} with endpoint integrated on macOS, you might be prompted to approve a kernel extension from "Endgame, Inc". To approve the extension:
66+
When running the {agent} with endpoint integrated on macOS 10.13, 10.14 and 10.15, you will be prompted to approve a kernel extension from "Endgame, Inc". To approve the extension:
6767

68-
TIP: JAMF users can approve the Kernel the same way for the **Elastic Endgame** app.
68+
TIP: Endgame Sensor users can approve the kernel the same way for the **Elastic Endgame** app.
6969

7070
1. Select **Open Security Preferences**. The **Security and Privacy** window opens.
7171
+
@@ -83,7 +83,7 @@ image::images/install-endpoint/unlock-security-panel.png[]
8383
image::images/install-endpoint/allow-endgame.png[]
8484

8585

86-
If the prompt does not appear when trying to run the Elastic Agent:
86+
If the prompt does not appear because you're using a version before macOS Big Sur (11.0), enable the extension by:
8787

8888
1. Open a Terminal application.
8989
2. Enter `kextload /Library/Extension/kendpoint.kext`. Prepend the command with `sudo` if necessary.
@@ -106,3 +106,12 @@ After you have installed the agent, malware prevention is automatically enabled
106106

107107
[role="screenshot"]
108108
image::images/install-endpoint/malware-protection.png[]
109+
110+
[discrete]
111+
[[verify-endpoint-enrollment]]
112+
== Verify Endpoint Enrollment
113+
114+
After installing the {agent}, there's a lag time of several hours between when the Elastic Endpoint begins detecting and sending alerts to {Kibana}. To ensure that the installation of Elastic Endpoint on your host was successful, go to **Administration > Endpoints**. A message appears that says, "Endpoints are enrolling. View agents to track progress".
115+
116+
[role="screenshot"]
117+
image::images/install-endpoint/endpoints-enrolling.png[]
Lines changed: 76 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,93 @@
11
[[sensor-full-disk-access]]
2-
= Enable full disk access
2+
= Enable Full Disk Access
33

4-
Elastic Endpoint Security requires full disk access to protect you from malware and other cybersecurity threats. Full Disk Access permissions is a new privacy feature introduced in macOS Mojave (10.14) that prevents some applications from accessing your data. This means you need to manually grant permission for Elastic Endpoint Security to access these protected areas of your Mac.
4+
Elastic Endpoint Security requires Full Disk Access to protect you from malware and other cybersecurity threats. Full Disk Access permissions is a new privacy feature introduced in macOS Mojave (10.14) that prevents some applications from accessing your data. This means you need to manually grant permission for the Endgame sensor and Elastic Endpoint to access these protected areas of your Mac.
55

6-
This article describes how to enable full disk access for both the Elastic Agent, required in order to enable Elastic Endpoint Security, and the legacy Endgame sensor.
6+
This article describes how to enable Full Disk Access for the required security system extensions, the Elastic Endpoint sensor, and the legacy Endgame sensor.
7+
8+
[discrete]
9+
[[macos-permissions]]
10+
== macOS permissions
11+
12+
The behavior of the Endgame sensor and Elastic Endpoint differs based on your macOS version. MDM/JAMF users can pre-approve all Full Disk Access without granting permission to the sensors. However, depending on the macOS version and sensor type, non-MDM/JAMF users may be prompted to enable Full Disk Access for required security files.
13+
14+
**Endgame Sensor**
15+
16+
- `10.13, 10.14, 10.15`: Users cannot proceed with installation without first granting the sensor the ability to load a <<enable-kernel-extension,kernel extension>>. During installation, you will be prompted to go to **System preferences** and approve loading the kernel. Upon approval, installation proceeds.
17+
18+
- `11.0` (Big Sur): Users cannot proceed with installation without first granting the sensor the ability to load <<system-extension>>. During installation, you will be prompted to go to **System preferences** and approve loading the system extension. Upon approval, a second prompt appears to enable **Network Filtering**. Approve this final prompt for installation to proceed.
19+
+
20+
You also must grant Full Disk Access to `com.endgame.systemextension`.
21+
22+
- `10.14.6+, 10.15, 11.0`: Grant the <<endpoint-endgame-sensor,esensor>> Full Disk Access.
23+
24+
25+
**Elastic Endpoint**
26+
27+
No prompts appear to approve the <<enable-kernel-extension,kernel>>, <<system-extension>>, or <<endpoint-endgame-sensor,elastic-endpoint>>, due to installation happening through the {agent}. After installation, Endpoint policies **will fail** to detect events until you approve and enable kernel or system extension loading and Full Disk Access for each version, as reflected in the **Administration > Endpoints** page of the security application.
28+
29+
- `10.13, 10.14, 10.15`: Approve the <<enable-kernel-extension,kernel-extension>>.
30+
31+
- `11.0` (Big Sur): Give Full Disk Access to the <<system-extension>>, as well as `co.elastic.systemextension`.
32+
33+
- - `10.14.6+, 10.15, 11.0`: Grant the <<endpoint-endgame-sensor,elastic-endpoint>> Full Disk Access.
34+
35+
[discrete]
36+
[[system-extension]]
37+
== System extension
38+
39+
To fully protect endpoints from malware and other cybersecurity threats when using Elastic Endpoint with system extensions, Full Disk Access must be enabled for the system extension during <<install-endpoint,installation>> on macOS Big Sur (11.0) and later.
40+
41+
--
42+
image::images/system-extension-prompt.png[System Extension Prompt]
43+
--
44+
45+
If you select **OK** and continue installation, you'll receive a prompt to **Filter Network Content**. Select **Allow**, and then use the following steps to enable Full Disk Access for the system extension.
746

847
1. Open the **System Preferences** application.
948
+
10-
2. Click **Security and Privacy**. On the Security and Privacy panel, select the **Privacy** tab.
49+
2. Click **Security and Privacy**. On the Security and Privacy panel, select the **Privacy** tab.
1150
+
1251
3. In the left pane, select **Full Disk Access**.
1352
+
1453
--
1554
image::images/select-fda.png[Select Full Disk Access]
1655
--
1756
+
18-
4. In the lower-left corner of the panel, click the **Lock button** and enter your username and password. You can now add the `elastic-agent` or `esensor` file.
57+
4. In the lower-left corner of the panel, click the **Lock button** and enter your username and password.
58+
+
59+
5. Click the + button to view Finder. Find the system extension `com.endgame.systemextension` (Endgame sensor) or `co.elastic.systemextension` (Elastic Endpoint) and select.
60+
61+
The system extension now has Full Disk Access. However, for both the {agent} and Elastic Endgame sensor to detect events from a macOS host, you must enable Full Disk Access for the file most relevant to your security setup.
62+
63+
[discrete]
64+
[[endpoint-endgame-sensor]]
65+
== Elastic Endpoint and Endgame sensor
66+
67+
The `elastic-endpoint` files appear after you've downloaded and installed the {agent} with <<install-endpoint,Endpoint Security Integration>>. Similarly, the `esensor` file for Elastic Endgame appears once you've downloaded the sensor on your host.
68+
69+
70+
1. Open the **System Preferences** application.
71+
+
72+
2. Click **Security and Privacy**. On the Security and Privacy panel, select the **Privacy** tab.
73+
+
74+
3. In the left pane, select **Full Disk Access**.
75+
+
76+
--
77+
image::images/select-fda.png[Select Full Disk Access]
78+
--
79+
+
80+
4. In the lower-left corner of the panel, click the **Lock button** and enter your username and password. You can now add the `elastic-endpoint` or `esensor` file.
81+
82+
5. Click the + button to view Finder. Select the file that pertains most to your Endpoint configuration:
83+
+
84+
- Endpoint Security: Navigate to `/Library/Elastic/Endpoint/` and select the `elastic-endpoint` file.
85+
+
86+
- Elastic Endgame: Navigate to `/Library/Endgame` and select the `esensor` file.
1987

20-
5. Click the + button to view Finder. Navigate to the `/Library/Endgame` directory, select the `elastic-agent` or `esensor` file, and then click *Open*.
88+
6. After you've selected the applicable file, click **Open**.
2189

22-
6. In the **Privacy** tab, confirm that the `elastic-agent` or `esensor` file appears in the list of applications that have full access permission, as seen in the following image:
90+
7. In the **Privacy** tab, confirm that the `elastic-agent` or `esensor` file appears in the list of applications that have Full Disk Access permissions.
2391

2492

25-
Elastic Endpoint Security now has the access required to fully protect your system.
93+
Elastic Endpoint now has the access required to fully protect your system.

0 commit comments

Comments
 (0)