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.
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/schema. To best understand the expressiveness that is afforded to you by osquery, consider the following SQL queries:
SELECT * FROM users;
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, 10.13
- Any 64bit Linux OS with
glibc >= 2.13and
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 16.04, CentOS 6.5 and 7
- Apple macOS 10.13
- 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
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
By contributing to osquery you agree that your contributions will be licensed as defined on the LICENSE file.
We keep track of security announcements in our tagged version release notes on GitHub. We aggregate these into SECURITY.md too.
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. Development and usage discussion is happening in the osquery Slack, grab an invite automatically here!