SQL powered operating system instrumentation, monitoring, and analytics.
Go to file
Sharvil Shah a713fbcc55 Use mnenomics for process states on Darwin
Process states in `processes` table now use mnemonics instead of the
integer code. They follow closely to the states defined sys/proc.h,
which means processes with state as:

  state    value   meaning                           mnemonic
 -------- ------- --------------------------------- ----------
  SIDL     1       process being created by fork     'I'
  SRUN     2       currently runnable                'R'
  SSLEEP   3       sleeping on an address            'S'
  SSTOP    4       process debugging or suspension   'T'
  SZOMB    5       awaiting collection by parent     'Z'

Note: The mnemonics here will not match up with what `ps` or `top`
reports.

`ps` and `top` queries run state of all Mach Threads (by grabbing a Mach Task)
of a process, and then coalesces it to represent the process state.

This is no longer possible to do by non-Apple signed binaries,
as the only way to a Mach Task (and therefore list of Mach Threads)
is by calling `task_for_pid()`, which no longer works under
System Integrity Protection (SIP) introduced in OS X 10.11
2016-03-09 11:25:58 -08:00
CMake Remove Glog from third-party build 2016-03-07 12:54:00 -08:00
docs Add define to enable SQLite WHERETRACE 2016-03-04 20:41:06 -08:00
include/osquery 1. Reorganize RocksDB database handle into a plugin 2016-03-06 20:40:16 -08:00
kernel [osquery] Update copyright headers to new format. 2016-02-11 11:48:58 -08:00
osquery Use mnenomics for process states on Darwin 2016-03-09 11:25:58 -08:00
packs OSX Keranger detection fix 2016-03-07 09:25:32 -08:00
specs add fan name to fan speeds table 2016-03-03 19:44:53 -05:00
third-party@dcb73fe68d Remove Glog from third-party build 2016-03-07 12:54:00 -08:00
tools Merge pull request #1902 from theopolis/remove_glog 2016-03-07 14:53:32 -08:00
.clang-format Remove clang-format parameters that break clang-format 3.4 2014-11-03 10:12:12 -08:00
.gitignore add libcrypysetup-dev library 2015-04-24 17:01:14 -07:00
.gitmodules removing lib submodule 2014-09-23 18:50:10 -07:00
CMakeLists.txt Remove Glog from third-party build 2016-03-07 12:54:00 -08:00
CONTRIBUTING.md Fix RHEL7 systemd service 2016-01-20 14:31:02 -08:00
Doxyfile Add some osquery-theme to API docs 2015-04-06 01:21:10 -07:00
LICENSE [osquery] Update copyright headers to new format. 2016-02-11 11:48:58 -08:00
Makefile Add define to enable SQLite WHERETRACE 2016-03-04 20:41:06 -08:00
mkdocs.yml Adding deployment debugging documentation 2016-01-20 16:22:32 -08:00
osquery.thrift Extension-dependent config/logger plugins 2015-03-13 12:01:30 -07:00
PATENTS Update patent grant 2015-04-10 11:49:33 -07:00
README.md Updating README for OSX 10.11 and fixing build badge 2016-01-15 12:52:42 -08:00
requirements.txt Custom flaky test marker 2015-11-08 02:29:49 -08:00
Vagrantfile Build on Debian 7 (Wheezy) 2016-01-05 16:31:20 -08:00

osquery

osquery logo

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
OS X 10.9 Build Status Homepage: https://osquery.io
OS X 10.10/11 Build Status Downloads: https://osquery.io/downloads
CentOS 6.5 Build Status Tables: https://osquery.io/tables
CentOS 7.0 Build Status Packs: https://osquery.io/packs
Ubuntu 12.04 Build Status Guide: https://osquery.readthedocs.org
Ubuntu 14.04 Build Status Slack Status https://osquery.slack.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/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 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 = '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

Downloads / Install

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 from source

Building osquery from source is encouraged! Join our developer community by giving us feedback in Github issues or submitting pull requests!

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.

Vulnerabilities

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 and browse our RFC-labeled Github issues. Development and usage discussion is happing in the osquery Slack, grab an invite automatically: https://osquery-slack.herokuapp.com/!