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 | ||||
| RHEL 7.0 | Homepage: | https://osquery.io | ||
| CentOS 6.5 | Downloads: | https://osquery.io/downloads | ||
| CentOS 7.0 | Tables: | https://osquery.io/tables | ||
| Ubuntu 12.04 | Packs: | https://osquery.io/packs | ||
| Ubuntu 14.04 | Guide: | https://osquery.readthedocs.org | ||
| OS X 10.9 | ||||
| OS X 10.10 |
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 process.name, listening.port, process.pid
FROM listening_ports AS listening
JOIN processes AS process ON listening.pid = process.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
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 osquery from source is encouraged! Join our developer community by giving us feedback in Github issues or submitting pull requests!
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.
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.