From 5fbc368e46f7aacbc3dbd62cdd9d46d65b4ccdd6 Mon Sep 17 00:00:00 2001 From: Mo Zhu Date: Fri, 7 Jul 2023 09:55:38 -0700 Subject: [PATCH] Warning about installing extension on Chrome browsers (#12596) Co-authored-by: Rachael Shaw --- docs/Using-Fleet/Adding-hosts.md | 7 +++++-- docs/Using-Fleet/ChromeOS.md | 6 +++--- schema/tables/chrome_extensions.yml | 4 +++- schema/tables/disk_info.yml | 5 +++-- schema/tables/geolocation.yml | 2 ++ schema/tables/network_interfaces.yml | 3 ++- schema/tables/os_version.yml | 4 +++- schema/tables/osquery_info.yml | 2 ++ schema/tables/privacy_preferences.yml | 3 ++- schema/tables/screenlock.yml | 5 +++-- schema/tables/system_info.yml | 2 ++ schema/tables/system_state.yml | 2 +- schema/tables/users.yml | 4 +++- 13 files changed, 34 insertions(+), 15 deletions(-) diff --git a/docs/Using-Fleet/Adding-hosts.md b/docs/Using-Fleet/Adding-hosts.md index 7e5744cf77..2850c9b104 100644 --- a/docs/Using-Fleet/Adding-hosts.md +++ b/docs/Using-Fleet/Adding-hosts.md @@ -17,6 +17,7 @@ - [Migrating from plain osquery to osquery installer](#migrating-from-plain-osquery-to-osquery-installer) - [Generate installer](#generate-installer) - [Migrate](#migrate) + - [Add Chromebooks with the fleetd Chrome extension](#add-chromebooks-with-the-fleetd-chrome-extension) - [Grant full disk access to osquery on macOS](#grant-full-disk-access-to-osquery-on-macos) - [Creating the configuration profile](#creating-the-configuration-profile) - [Obtaining identifiers](#obtaining-identifiers) @@ -29,7 +30,7 @@ Fleet gathers information from an [osquery](https://github.com/osquery/osquery) You can also install plain osquery on your hosts and connect to Fleet using osquery's `TLS API` plugins. -> For ChromeOS hosts, the fleetd Chrome extension is installed instead of osquery. This Chrome browser extension is only supported on ChromeOS operating systems that are managed using [Google Admin](https://admin.google.com). +> For ChromeOS hosts, the [fleetd Chrome extension](#add-chromebooks-with-the-fleetd-chrome-extension) is installed instead of osquery. ## Add hosts with Orbit @@ -279,7 +280,9 @@ installation should appear as the same host in the Fleet UI. If other settings a entries will appear in the Fleet UI. The older entries can be automatically cleaned up with the host expiration setting. To configure this setting, in the Fleet UI, head to **Settings > Organization settings > Advanced options**. -## Add Chromebooks with the Fleetd Chrome extension +## Add Chromebooks with the fleetd Chrome extension + +> The fleetd Chrome browser extension is supported on ChromeOS operating systems that are managed using [Google Admin](https://admin.google.com). It is not intended for non-ChromeOS hosts with the Chrome browser installed. Visit the Google Admin console. In the navigation menu, visit Devices > Chrome > Apps & Extensions > Users & browsers. diff --git a/docs/Using-Fleet/ChromeOS.md b/docs/Using-Fleet/ChromeOS.md index c8011d67c6..86dc333306 100644 --- a/docs/Using-Fleet/ChromeOS.md +++ b/docs/Using-Fleet/ChromeOS.md @@ -1,12 +1,12 @@ # ChromeOS +For visibility on ChromeOS hosts, Fleet provides the fleetd Chrome extension which provides similar functionality as osquery on other operating systems. ## Adding ChromeOS hosts to Fleet -Fleet provides a Chrome extension which you can install via Google Admin. - -> For ChromeOS hosts, the fleetd Chrome extension is installed instead of osquery. This Chrome browser extension is only supported on ChromeOS operating systems that are managed using [Google Admin](https://admin.google.com). To learn how to add ChromeOS hosts to Fleet, visit [here](https://fleetdm.com/docs/using-fleet/adding-hosts#add-chromebooks-with-the-fleetd-chrome-extension). +> The fleetd Chrome browser extension is supported on ChromeOS operating systems that are managed using [Google Admin](https://admin.google.com). It is not intended for non-ChromeOS hosts with the Chrome browser installed. + ## Available tables To see the available tables for ChromeOS, visit [here](https://fleetdm.com/tables/chrome_extensions?platformFilter=chrome). diff --git a/schema/tables/chrome_extensions.yml b/schema/tables/chrome_extensions.yml index 5e6fb7cfbf..b6a93c28ac 100644 --- a/schema/tables/chrome_extensions.yml +++ b/schema/tables/chrome_extensions.yml @@ -105,4 +105,6 @@ columns: platforms: - darwin - windows - - linux \ No newline at end of file + - linux +notes: | + - On ChromeOS, this table requires the [fleetd Chrome extension](https://fleetdm.com/docs/using-fleet/chromeos). diff --git a/schema/tables/disk_info.yml b/schema/tables/disk_info.yml index acf35d386b..415048ee2c 100644 --- a/schema/tables/disk_info.yml +++ b/schema/tables/disk_info.yml @@ -46,5 +46,6 @@ columns: platforms: - windows evented: false -notes: >- - - For ChromeOS, this table is not a core osquery table. It is included as part of the Fleetd Chrome extension. Available for Chrome 91+. +notes: | + - On ChromeOS, this table requires the [fleetd Chrome extension](https://fleetdm.com/docs/using-fleet/chromeos). + - Available for ChromeOS 91+. diff --git a/schema/tables/geolocation.yml b/schema/tables/geolocation.yml index 708c2f6c6f..e815d535c2 100644 --- a/schema/tables/geolocation.yml +++ b/schema/tables/geolocation.yml @@ -20,3 +20,5 @@ columns: type: text required: false description: Region +notes: | + - This table is not a core osquery table. This table requires the [fleetd Chrome extension](https://fleetdm.com/docs/using-fleet/chromeos). diff --git a/schema/tables/network_interfaces.yml b/schema/tables/network_interfaces.yml index f6938a6805..b4ed84bcf1 100644 --- a/schema/tables/network_interfaces.yml +++ b/schema/tables/network_interfaces.yml @@ -16,5 +16,6 @@ columns: type: text required: false description: IPv6 address (only available to extensions force-installed by enterprise policy) -notes: >- +notes: | + - This table is not a core osquery table. This table requires the [fleetd Chrome extension](https://fleetdm.com/docs/using-fleet/chromeos). - Requires that the fleetd extension is force-installed by enterprise policy diff --git a/schema/tables/os_version.yml b/schema/tables/os_version.yml index 070e5cae86..66797503e4 100644 --- a/schema/tables/os_version.yml +++ b/schema/tables/os_version.yml @@ -22,4 +22,6 @@ columns: - linux - name: mount_namespace_id platforms: - - linux \ No newline at end of file + - linux +notes: | + - On ChromeOS, this table requires the [fleetd Chrome extension](https://fleetdm.com/docs/using-fleet/chromeos). diff --git a/schema/tables/osquery_info.yml b/schema/tables/osquery_info.yml index 9a1fa5baed..e84662a1ac 100644 --- a/schema/tables/osquery_info.yml +++ b/schema/tables/osquery_info.yml @@ -54,3 +54,5 @@ examples: >- SELECT version FROM osquery_info; ``` +notes: | + - On ChromeOS, this table requires the [fleetd Chrome extension](https://fleetdm.com/docs/using-fleet/chromeos). diff --git a/schema/tables/privacy_preferences.yml b/schema/tables/privacy_preferences.yml index 706c4f7f0f..b8987e019a 100644 --- a/schema/tables/privacy_preferences.yml +++ b/schema/tables/privacy_preferences.yml @@ -1,5 +1,4 @@ name: privacy_preferences -notes: This table is not a core osquery table. It is included as part of the Fleetd Chrome extension. description: Information on Chrome features that can affect a user's privacy, available from the [chrome.privacy APIs](https://developer.chrome.com/docs/extensions/reference/privacy/) platforms: - chrome @@ -85,3 +84,5 @@ columns: description: 1 if enabled else 0 * Available for Chrome 111+ required: false type: integer +notes: | + - This table is not a core osquery table. This table requires the [fleetd Chrome extension](https://fleetdm.com/docs/using-fleet/chromeos). diff --git a/schema/tables/screenlock.yml b/schema/tables/screenlock.yml index a2ebb507c2..22da7609db 100644 --- a/schema/tables/screenlock.yml +++ b/schema/tables/screenlock.yml @@ -4,6 +4,7 @@ platforms: - chrome description: >- Returns if the screen locks automatically and the time, in seconds, it takes until the screen is locked automatically while idle. For macOS, this table will return no results if osquery is running as root. -notes: >- +notes: | - For macOS, this only fetches results for osquery's current logged-in user context. The user must also have recently logged in. - - For ChromeOS, this table is not a core osquery table. It is included as part of the Fleetd Chrome extension. Available for Chrome 73+. + - For ChromeOS, this table requires the [fleetd Chrome extension](https://fleetdm.com/docs/using-fleet/chromeos). + - For ChromeOS, this table is only available for Chrome 73+. diff --git a/schema/tables/system_info.yml b/schema/tables/system_info.yml index f0381404cd..e5c16c16b1 100644 --- a/schema/tables/system_info.yml +++ b/schema/tables/system_info.yml @@ -86,3 +86,5 @@ examples: >- SELECT CPU_type, hardware_vendor, hardware_model, hardware_serial FROM system_info; ``` +notes: | + - This table is not a core osquery table. This table requires the [fleetd Chrome extension](https://fleetdm.com/docs/using-fleet/chromeos). diff --git a/schema/tables/system_state.yml b/schema/tables/system_state.yml index b89780d7b0..323fd7a023 100644 --- a/schema/tables/system_state.yml +++ b/schema/tables/system_state.yml @@ -17,4 +17,4 @@ columns: required: false evented: false notes: >- - - This table is not a core osquery table. It is included as part of the Fleetd Chrome extension. + - This table is not a core osquery table. This table requires the [fleetd Chrome extension](https://fleetdm.com/docs/using-fleet/chromeos). diff --git a/schema/tables/users.yml b/schema/tables/users.yml index e9d7851c3c..574d1d2bf9 100644 --- a/schema/tables/users.yml +++ b/schema/tables/users.yml @@ -60,4 +60,6 @@ columns: platforms: - linux - name: username - description: Username \ No newline at end of file + description: Username +notes: | + - On ChromeOS, this table requires the [fleetd Chrome extension](https://fleetdm.com/docs/using-fleet/chromeos).