SQL powered operating system instrumentation, monitoring, and analytics.
C++ CMake Objective-C++ C Makefile Thrift Shell
Latest commit b2a90cd Jan 17, 2017 @theopolis theopolis committed on GitHub Do not control stderr teeing automatically (#2919)
Permalink
Failed to load latest commit information.
CMake Simplify Registry and plugin concepts (#2887) Jan 7, 2017
docs Documentation and steps for dependency bottles (#2886) Dec 31, 2016
external Introduce 'external' project builds: make externals (#2385) Aug 17, 2016
include/osquery Superfluous "d" in a doc block (#2911) Jan 17, 2017
kernel [Fix #2696] Add kernel development mode check to OS X (#2735) Nov 10, 2016
osquery Do not control stderr teeing automatically (#2919) Jan 18, 2017
packs add launchd name for OSX_Keydnap (#2899) Jan 10, 2017
specs [windows] arp_cache virtual table (#2839) Jan 11, 2017
third-party @ 6893f56 deps: Bump SQLite version 3.15.2 on all platforms (#2822) Dec 2, 2016
tools [Fix #2912] Close initial Python thrift connections (#2913) Jan 15, 2017
.clang-format Fix code auditing job and disable Homebrew auto-update (#2392) Aug 17, 2016
.gitignore Upgrade LLVM to 3.8.1 on Linux (#2436) Sep 2, 2016
.gitmodules removing lib submodule Sep 24, 2014
CMakeLists.txt Simplify Registry and plugin concepts (#2887) Jan 7, 2017
CONTRIBUTING.md Migrate from Open Code of Conduct to Contributor Covenant Mar 29, 2016
Doxyfile Add clang-format rules from 3.6 (#2360) Aug 15, 2016
LICENSE [osquery] Update copyright headers to new format. Feb 11, 2016
Makefile make docs: Use build/docs folder (#2894) Jan 7, 2017
PATENTS Update patent grant Apr 10, 2015
README.md clearer statement about getting started when building from source (#2818 Dec 2, 2016
Vagrantfile Add Ubuntu Xenial 16.04 build support (#2089) May 12, 2016
mkdocs.yml Various fixes and updates to the wiki (#2740) Nov 12, 2016
osquery.thrift Add shutdown method to extensions (#2224) Jul 6, 2016
requirements.txt make docs: Use build/docs folder (#2894) Jan 7, 2017

README.md

osquery

osquery logo

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

Platform Build status
macOS 10.12 Build Status Homepage: https://osquery.io
CentOS 6.x Build Status Downloads: https://osquery.io/downloads
CentOS 7.x Build Status Tables: https://osquery.io/tables
Ubuntu 14.04 Build Status Packs: https://osquery.io/packs
Ubuntu 16.04 Build Status Guide: https://osquery.readthedocs.org
Windows 2016 Build Status Slack Status https://osquery-slack.herokuapp.com
Windows 10 Build Status

There are many additional continuous build jobs that perform dynamic and static analysis, test the package build process, rebuild dependencies from source, assure deterministic build on macOS and Linux, fuzz test the virtual tables, and build on several other platforms not included above. Code safety, testing rigor, data integrity, and a friendly development community are our primary goals.

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 builds for OS X (pkg) and Linux (deb/rpm), as well as yum and apt repository information visit https://osquery.io/downloads. Windows 10, 8, Server 2012 and 2016 packages are published to Chocolatey.

The list of supported platforms for running osquery is massive:

  • Apple OS X 10.10, 10.11, and macOS 10.12
  • Any 64bit Linux OS with glibc >= 2.13 and zlib >= 1.2
  • Windows 10, 8, Server 2012, and 2016

Building from source

Building osquery from source is encouraged! Check out the documentation to get started and join our developer community by giving us feedback in Github issues or submitting pull requests!

We officially support a subset of OS versions for building because it is rather intense.

  • Ubuntu 14.04 and 16.04, CentOS 6.5 and 7
  • Apple macOS 10.12
  • Windows 10 and Server 2016

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/!