SQL powered operating system instrumentation, monitoring, and analytics.
Go to file
Teddy Reed 64e4afa136 Merge pull request #1294 from theopolis/relax_test_timesouts
Relax extensions and shell timeouts
2015-07-02 13:50:07 -07:00
CMake manually specify device-mapper, treating amazon as rhel7 2015-07-01 22:06:08 -04:00
docs README updates 2015-07-01 23:47:41 -07:00
include/osquery [#1277] Forward status logs to osqueryd workers 2015-07-01 15:26:26 -07:00
osquery Merge pull request #1286 from theopolis/relay_status_logs 2015-07-02 10:33:58 -07:00
specs Yara events was not building 2015-06-29 14:45:31 -07:00
sysroots/linux/linux/netfilter_ipv4 Remove patching for sysroot 2015-05-08 19:16:33 -07:00
third-party@d155fd9571 [Fix #1154] Clean up CMake messages and check TP 2015-05-23 17:15:28 -07:00
tools Merge pull request #1294 from theopolis/relax_test_timesouts 2015-07-02 13:50:07 -07:00
.clang-format Remove clang-format parameters that break clang-format 3.4 2014-11-03 10:12:12 -08:00
.gitignore add libcrypysetup-dev library 2015-04-24 17:01:14 -07:00
.gitmodules removing lib submodule 2014-09-23 18:50:10 -07:00
CMakeLists.txt Limit scope of git/tag version defines. 2015-06-12 10:10:20 -07:00
CONTRIBUTING.md Update the contributing docs git workflow 2015-06-20 15:55:44 -04:00
Doxyfile Add some osquery-theme to API docs 2015-04-06 01:21:10 -07:00
LICENSE legal stuff 2014-10-07 00:07:32 -07:00
Makefile Easier build host-based sync 2015-05-05 15:15:45 -07:00
mkdocs.yml README updates 2015-07-01 23:47:41 -07:00
osquery.thrift Extension-dependent config/logger plugins 2015-03-13 12:01:30 -07:00
PATENTS Update patent grant 2015-04-10 11:49:33 -07:00
README.md README updates 2015-07-01 23:47:41 -07:00
requirements.txt Respect external CMake C/CXX flags 2015-03-01 21:19:31 -07:00
Vagrantfile Pack and testing fixups 2015-05-28 12:17:27 -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
RHEL 6.5 Build Status
RHEL 7.0 Build Status Homepage: https://osquery.io
CentOS 6.5 Build Status Downloads: https://osquery.io/downloads
CentOS 7.0 Build Status Tables: https://osquery.io/tables
Ubuntu 12.04 Build Status Guide: https://osquery.readthedocs.org
Ubuntu 14.04 Build Status
OS X 10.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 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, which are listening on all interfaces:

SELECT DISTINCT process.name, listening.port, process.pid
FROM processes AS process
JOIN listening_ports AS listening ON process.pid = listening.pid
WHERE listening.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 = 'true' AND keep_alive = 'true')
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!

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.