SQL powered operating system instrumentation, monitoring, and analytics.
Go to file
2016-11-14 15:17:46 -08:00
CMake Update dependency build flows on Linux and OS X (#2730) 2016-11-10 08:14:26 -08:00
docs Various fixes and updates to the wiki (#2740) 2016-11-11 22:13:51 -08:00
external Introduce 'external' project builds: make externals (#2385) 2016-08-17 13:33:28 -07:00
include/osquery [Fix #2656] Refactor events_optimize to act per-query (#2665) 2016-11-05 22:03:45 -07:00
kernel [Fix #2696] Add kernel development mode check to OS X (#2735) 2016-11-09 22:07:19 -08:00
osquery [Fix #2733] Updated users table to parse all user profiles (#2737) 2016-11-12 19:49:33 -05:00
packs add osx komplex query (#2570) 2016-09-29 07:25:26 -07:00
specs New table: sudoers (#2686) 2016-11-12 16:32:42 -05:00
third-party@2610167fe8 Update third-party for Win10 building and add .patch to gitignore (#2250) 2016-07-15 10:55:28 -07:00
tools deps: Bottle updates for OS X: augeas, libxml2 (#2756) 2016-11-14 15:17:46 -08:00
.clang-format Fix code auditing job and disable Homebrew auto-update (#2392) 2016-08-17 16:00:30 -07:00
.gitignore Upgrade LLVM to 3.8.1 on Linux (#2436) 2016-09-02 07:59:10 -07:00
.gitmodules removing lib submodule 2014-09-23 18:50:10 -07:00
CMakeLists.txt Minor reorganization of osqueryi linking (#2724) 2016-11-06 01:17:48 -08:00
CONTRIBUTING.md Migrate from Open Code of Conduct to Contributor Covenant 2016-03-29 16:22:06 -07:00
Doxyfile Add clang-format rules from 3.6 (#2360) 2016-08-15 01:33:17 -07:00
LICENSE [osquery] Update copyright headers to new format. 2016-02-11 11:48:58 -08:00
Makefile Update dependency build flows on Linux and OS X (#2730) 2016-11-10 08:14:26 -08:00
mkdocs.yml Various fixes and updates to the wiki (#2740) 2016-11-11 22:13:51 -08:00
osquery.thrift Add shutdown method to extensions (#2224) 2016-07-06 12:23:24 -07:00
PATENTS Update patent grant 2015-04-10 11:49:33 -07:00
README.md docs: Windows 10 badge/install/flags (#2531) 2016-09-27 02:27:41 -07:00
requirements.txt Add wiki build to make docs and verify in CI (#2279) 2016-07-27 15:25:17 -07:00
Vagrantfile Add Ubuntu Xenial 16.04 build support (#2089) 2016-05-12 08:47:05 -07:00

osquery

osquery logo

osquery is an operating system instrumentation framework for OS X and Linux.
The tools make low-level operating system analytics and monitoring both performant and intuitive.

Platform Build status
OS X 10.9 Build Status Homepage: https://osquery.io
OS X 10.10/11 Build Status Downloads: https://osquery.io/downloads
CentOS 6.x Build Status Tables: https://osquery.io/tables
CentOS 7.x Build Status Packs: https://osquery.io/packs
Ubuntu 12.04 Build Status Guide: https://osquery.readthedocs.org
Ubuntu 14.04 Build Status Slack Status https://osquery-slack.herokuapp.com
Ubuntu 16.04 Build Status
Windows 10 Build Status

What is osquery?

osquery exposes an operating system as a high-performance relational database. This allows you to write SQL-based queries to explore operating system data. With osquery, SQL tables represent abstract concepts such as running processes, loaded kernel modules, open network connections, browser plugins, hardware events or file hashes.

SQL tables are implemented via a simple plugin and extensions API. A variety of tables already exist and more are being written: https://osquery.io/tables. To best understand the expressiveness that is afforded to you by osquery, consider the following SQL queries:

List the users:

SELECT * FROM users;

Check the processes that have a deleted executable:

SELECT * FROM processes WHERE on_disk = 0;

Get the process name, port, and PID, for processes listening on all interfaces:

SELECT DISTINCT processes.name, listening_ports.port, processes.pid
  FROM listening_ports JOIN processes USING (pid)
  WHERE listening_ports.address = '0.0.0.0';

Find every OS X LaunchDaemon that launches an executable and keeps it running:

SELECT name, program || program_arguments AS executable
  FROM launchd
  WHERE (run_at_load = 1 AND keep_alive = 1)
  AND (program != '' OR program_arguments != '');

Check for ARP anomalies from the host's perspective:

SELECT address, mac, COUNT(mac) AS mac_count
  FROM arp_cache GROUP BY mac
  HAVING count(mac) > 1;

Alternatively, you could also use a SQL sub-query to accomplish the same result:

SELECT address, mac, mac_count
  FROM
    (SELECT address, mac, COUNT(mac) AS mac_count FROM arp_cache GROUP BY mac)
  WHERE mac_count > 1;

These queries can be:

  • performed on an ad-hoc basis to explore operating system state using the osqueryi shell
  • executed via a scheduler to monitor operating system state across a set of hosts
  • launched from custom applications using osquery Thrift APIs

Downloads / Install

For latest stable and nightly builds for OS X and Linux (deb/rpm), as well as yum and apt repository information visit https://osquery.io/downloads. For installation information for FreeBSD, which is supported by the osquery community, see the wiki.

Building from source

Building osquery from source is encouraged! Join our developer community by giving us feedback in Github issues or submitting pull requests!

File Integrity Monitoring (FIM)

osquery provides several FIM features too! Just as OS concepts are represented in tabular form, the daemon can track OS events and later expose them in a table. Tables like file_events or yara_events can be selected to retrieve buffered events.

The configuration allows you to organize files and directories for monitoring. Those sets can be paired with lists of YARA signatures or configured for additional monitoring such as access events.

Process and socket auditing

There are several forms of eventing in osquery along with file modifications and accesses. These range from disk mounts, network reconfigurations, hardware attach and detaching, and process starting. For a complete set review the table documentation and look for names with the _events suffix.

Vulnerabilities

Facebook has a bug bounty program that includes osquery. If you find a security vulnerability in osquery, please submit it via the process outlined on that page and do not file a public issue. For more information on finding vulnerabilities in osquery, see a recent blog post about bug-hunting osquery.

Learn more

Read the launch blog post for background on the project. If you're interested in learning more about osquery, visit the users guide and browse our RFC-labeled Github issues. Development and usage discussion is happing in the osquery Slack, grab an invite automatically: https://osquery-slack.herokuapp.com/!