Back to Beats

This file is generated! See ext/osquery-extension/cmd/gentables.

x-pack/osquerybeat/ext/osquery-extension/README.md

9.4.03.9 KB
Original Source

This file is generated! See ext/osquery-extension/cmd/gentables.

<!-- DO NOT EDIT MANUALLY. Update specs/templates and re-run gentables. -->

Osquery Extension for Elastic

This osquery extension provides additional custom tables that enhance osquery's capabilities with Elastic-specific functionality. The extension is designed to work seamlessly with Osquerybeat and provides deep system insights across Linux, macOS, and Windows platforms.

Overview

The extension adds several custom tables to osquery that provide:

  • Browser history analysis across multiple browsers
  • Host system information access from containers (groups, users, processes)
  • Deep file analysis and security auditing on macOS
  • Windows Amcache inventory and normalized application view
  • Windows Jump List parsing for recent and pinned entries

Supported Platforms

NameTypeLinuxmacOSWindows
elastic_amcache_applicationtable
elastic_amcache_application_filetable
elastic_amcache_application_shortcuttable
elastic_amcache_applications_viewview
elastic_amcache_device_pnptable
elastic_amcache_driver_binarytable
elastic_amcache_driver_packagetable
elastic_browser_historytable
elastic_file_analysistable
elastic_host_groupstable
elastic_host_processestable
elastic_host_userstable
elastic_jumpliststable
host_groupsview
host_processesview
host_usersview

Tables

Views


Building and Installation

Build the Extension

From the osquerybeat directory:

bash
# Build for current platform
mage buildext

# The extension binary will be created at:
# Linux: ext/osquery-extension/build/linux/osquery-extension
# macOS: ext/osquery-extension/build/darwin/osquery-extension
# Windows: ext/osquery-extension/build/windows/osquery-extension.ext

Using with Osquery

The extension is automatically loaded by Osquerybeat. To use it manually with osquery:

bash
# Start osquery with the extension
osqueryi --extension /path/to/osquery-extension [--allow-unsafe]

# Verify tables are loaded
osqueryi> .tables
  => elastic_browser_history

# Query the tables
osqueryi> SELECT * FROM elastic_browser_history LIMIT 10;

Additional Resources

  • Table Documentation: docs/ - Detailed documentation for each table including configuration, examples, and security considerations
  • Development: See the main beats documentation
  • Osquery: osquery.io