SQL powered operating system instrumentation, monitoring, and analytics.
Go to file
Stefano Bonicatti 6e928157b3 Fix ebpf tests failing.
Fix ebpfTests.sysEbpf_null_attr, ebpfTests.sysEbpf_create_map,
ebpfMapTests.int_key_int_value, ebpfMapTests.int_key_struct_value
by running Docker as privileged on Azure Pipelines.

Docker is used only to get a new distribution running, it's not used
for any security purpose, so there's no point in limiting it.
2019-07-09 12:59:45 +02:00
.github Add task issue template (#4901) 2018-08-13 17:13:37 +01:00
cmake Fix detection of some headers on some IDEs (#5619) 2019-06-30 23:24:56 +02:00
docs windows: updating more references to osquery installation path (#5580) 2019-06-05 12:45:40 -07:00
mode Reduce number of configurations on system.py 2019-03-18 14:39:58 -07:00
osquery Fix typo in base64 log message (#5622) 2019-07-03 01:34:25 +02:00
packs detects when a proc is tapping keyboard event (#5345) 2019-01-15 06:43:32 -08:00
plugins Add CMake support 2019-06-26 21:49:06 -04:00
specs Add CMake support 2019-06-26 21:49:06 -04:00
tests Fix wrong error code returned when querying the Windows registry (#5621) 2019-07-01 22:23:02 +02:00
third-party Fix prepare_for_ide target on macOS and Windows (#5618) 2019-06-30 23:02:48 +02:00
tools buck: fixing up buck config generation script for use on Windows (#5623) 2019-07-05 15:49:47 -07:00
.buckconfig Move build system to BUCK 2018-12-07 16:12:35 +00:00
.clang-format format: Remove Cpp restriction (#3521) 2017-08-02 10:32:12 -07:00
.gitignore release: prepping for osquery 3.4.0 release on Windows 2019-06-21 17:25:34 -04:00
.travis.yml travis: Wait for up to 30 minutes for buck build 2019-06-25 08:49:11 -04:00
.watchmanconfig watcher: Do not initialize the config in watcher (#3403) 2017-06-13 17:26:34 -07:00
azure-pipelines.yml Fix ebpf tests failing. 2019-07-09 12:59:45 +02:00
BUILD.md Update README and BUILD with CMake instructions 2019-06-26 21:49:06 -04:00
CMakeLists.txt Add CMake support 2019-06-26 21:49:06 -04:00
CODE_OF_CONDUCT.md Update osquery code of conduct to reference Facebook policy (#5459) 2019-02-20 08:20:40 -08:00
CODEOWNERS Initial codeowners (#5603) 2019-06-26 09:14:13 -04:00
CONTRIBUTING.md Cleanup grammar, acronyms in CONTRIBUTING (#5432) 2019-02-12 06:04:01 -08:00
Doxyfile Add clang-format rules from 3.6 (#2360) 2016-08-15 01:33:17 -07:00
LICENSE Clarify licensing (#4792) 2018-08-02 19:26:40 +01:00
LICENSE-Apache-2.0 Clarify licensing (#4792) 2018-08-02 19:26:40 +01:00
LICENSE-GPL-2.0 Clarify licensing (#4792) 2018-08-02 19:26:40 +01:00
Makefile Move build system to BUCK 2018-12-07 16:12:35 +00:00
mkdocs.yml Removing macOS kernel module (#4572) 2018-06-17 19:21:07 +01:00
README.md Add Azure Pipelines status badges to the README (#5607) 2019-06-29 02:48:26 +02:00
SECURITY.md security: Update SECURITY.md with recent merges (#3787) 2017-10-04 17:28:06 -07:00
SUPPORT.md Improve SUPPORT.md (#4835) 2018-08-08 12:18:57 +01:00
Vagrantfile Move build system to BUCK 2018-12-07 16:12:35 +00:00

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!