SQL powered operating system instrumentation, monitoring, and analytics.
C++ Python Objective-C++ PowerShell Ruby CMake Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Add task issue template (#4901) Aug 13, 2018
CMake General SMART drive information virtual table (#4133) Jul 13, 2018
docs docs: fix the definition of 'posix' for the platform key (#4899) Aug 13, 2018
external Bundle C++ extensions into a single executable (#4335) Jun 3, 2018
include/osquery fixed move assignment operator for expected (#4906) Aug 14, 2018
osquery tables: Harden SMBIOS data parsing (#4853) Aug 15, 2018
packs Adding OSX Dummy malware to osx-attacks query pack (#4668) Jul 6, 2018
specs tables: fix cpu_physical_cores and cpu_logical_cores on linux (#4848) Aug 14, 2018
third-party @ 32e0146 third-party: updated commit ref of third party submodule (#4487) Jun 6, 2018
tools deps: Add bottle hashes for ssdeep-cpp (#4851) Aug 11, 2018
.clang-format format: Remove Cpp restriction (#3521) Aug 2, 2017
.gitignore build: Update provisioning and build scripts to VS2017 (as per #4151) ( Jun 9, 2018
.gitmodules removing lib submodule Sep 24, 2014
.watchmanconfig watcher: Do not initialize the config in watcher (#3403) Jun 14, 2017
CMakeLists.txt posix treat warnings as errors (#4913) Aug 14, 2018
CODE_OF_CONDUCT.md docs: Move code of conduct to its own file (#4751) Jul 25, 2018
CONTRIBUTING.md Improve contribution guidelines (#4798) Aug 8, 2018
Doxyfile Add clang-format rules from 3.6 (#2360) Aug 15, 2016
LICENSE Clarify licensing (#4792) Aug 2, 2018
LICENSE-Apache-2.0 Clarify licensing (#4792) Aug 2, 2018
LICENSE-GPL-2.0 Clarify licensing (#4792) Aug 2, 2018
Makefile xcode support (#4581) Jun 21, 2018
README.md Cleanup old text from README (#4834) Aug 8, 2018
SECURITY.md security: Update SECURITY.md with recent merges (#3787) Oct 5, 2017
SUPPORT.md Improve SUPPORT.md (#4835) Aug 8, 2018
Vagrantfile Adding ubuntu 18.04 to Vagrantfile (#4447) May 29, 2018
mkdocs.yml Removing macOS kernel module (#4572) Jun 17, 2018
osquery.thrift Add shutdown method to extensions (#2224) Jul 6, 2016
requirements.txt deps: Build for thrift 0.11.0 (#4013) Dec 23, 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/schema
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
FreeBSD 11 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/schema. 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.

License

By contributing to osquery you agree that your contributions will be licensed as defined on the LICENSE file.

Vulnerabilities

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.

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. Development and usage discussion is happening in the osquery Slack, grab an invite automatically here!