Skip to content
SQL powered operating system instrumentation, monitoring, and analytics.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add task issue template (#4901) Aug 13, 2018
cmake Explicitly add BUILD_TESTING CMake option (#5627) Jul 10, 2019
docs windows: updating more references to osquery installation path (#5580) Jun 5, 2019
mode Reduce number of configurations on system.py Mar 18, 2019
osquery Replacing sync calls by async ones and some cleanup (#5606) Jul 17, 2019
packs detects when a proc is tapping keyboard event (#5345) Jan 15, 2019
plugins Add CMake support Jun 27, 2019
specs windows/certificates: Fix enumeration bugs, add columns (#5631) Jul 16, 2019
tests Disable InterfaceDetailsTest.test_sanity test on Windows Jul 9, 2019
third-party Fix prepare_for_ide target on macOS and Windows (#5618) Jun 30, 2019
tools buck: fixing up buck config generation script for use on Windows (#5623) Jul 5, 2019
.buckconfig Move build system to BUCK Dec 7, 2018
.clang-format format: Remove Cpp restriction (#3521) Aug 2, 2017
.gitignore release: prepping for osquery 3.4.0 release on Windows Jun 21, 2019
.watchmanconfig watcher: Do not initialize the config in watcher (#3403) Jun 14, 2017
BUILD.md Update README and BUILD with CMake instructions Jun 27, 2019
CMakeLists.txt Add CMake support Jun 27, 2019
CODEOWNERS Initial codeowners (#5603) Jun 26, 2019
CODE_OF_CONDUCT.md Update osquery code of conduct to reference Facebook policy (#5459) Feb 20, 2019
CONTRIBUTING.md Cleanup grammar, acronyms in CONTRIBUTING (#5432) Feb 12, 2019
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 Move build system to BUCK Dec 7, 2018
README.md Add Azure Pipelines status badges to the README (#5607) Jun 29, 2019
SECURITY.md security: Update SECURITY.md with recent merges (#3787) Oct 5, 2017
SUPPORT.md Improve SUPPORT.md (#4835) Aug 8, 2018
Vagrantfile Move build system to BUCK Dec 7, 2018
azure-pipelines.yml Add buck builds on Azure Pipelines (#5632) Jul 12, 2019
mkdocs.yml Removing macOS kernel module (#4572) Jun 17, 2018

README.md

osquery

osquery logo

osquery is a SQL powered operating system instrumentation, monitoring, and analytics framework.
Available for Linux, macOS, Windows and FreeBSD.

Platform Build status
MacOS 10.14 Build Status Homepage: https://osquery.io
Ubuntu 18.04 Build Status Downloads: https://osquery.io/downloads
Windows Server 2016 Build Status Tables: https://osquery.io/schema
FreeBSD 11 N/A Packs: https://osquery.io/packs
Guide: https://osquery.readthedocs.org
Slack Status https://osquery-slack.herokuapp.com

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 macOS 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

Download & Install

To download the latest stable builds and for repository information and installation instructions visit https://osquery.io/downloads.

Build from source

Building osquery from source is encouraged! Check out our build guide.

Also check out our contributing guide and join the community on Slack.

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 our blog post Bug Hunting osquery.

Learn more

If you're interested in learning more about osquery read the launch blog post for background on the project, visit the users guide.

Development and usage discussion is happening in the osquery Slack, grab an invite automatically here!

You can’t perform that action at this time.