mirror of
https://github.com/valitydev/osquery-1.git
synced 2024-11-06 17:45:22 +00:00
118 lines
7.9 KiB
Markdown
118 lines
7.9 KiB
Markdown
# osquery
|
|
|
|
<p align="center">
|
|
<img align="center" src="https://github.com/facebook/osquery/raw/master/docs/img/logo-2x-dark.png" alt="osquery logo" width="200"/>
|
|
|
|
<p align="center">
|
|
osquery is an operating system instrumentation framework for OS X/macOS, Windows, and Linux. <br/>
|
|
The tools make low-level operating system analytics and monitoring both performant and intuitive.
|
|
|
|
| Platform | Build status | | | |
|
|
|----------|---------------|---|---|---|
|
|
MacOS 10.13 | [](https://jenkins.osquery.io/job/osqueryMasterBuildMacOS/) | | **Homepage:** | https://osquery.io
|
|
CentOS 6.x | [](https://jenkins.osquery.io/job/osqueryMasterBuildCentOS6/) | | **Downloads:** | https://osquery.io/downloads
|
|
CentOS 7.x | [](https://jenkins.osquery.io/job/osqueryMasterBuildCentOS7/) | | **Tables:** | https://osquery.io/schema
|
|
Ubuntu 14.04 | [](https://jenkins.osquery.io/job/osqueryMasterBuildUbuntu14/) | | **Packs:** | [https://osquery.io/packs](https://github.com/facebook/osquery/tree/master/packs)
|
|
Ubuntu 16.04 | [](https://jenkins.osquery.io/job/osqueryMasterBuildUbuntu16/) | | **Guide:** | https://osquery.readthedocs.org
|
|
Windows 2016 | [](https://jenkins.osquery.io/job/osqueryMasterBuildWindows2016/) | | [](https://osquery-slack.herokuapp.com) | https://osquery-slack.herokuapp.com
|
|
Windows 10 | [](https://jenkins.osquery.io/job/osqueryMasterBuildWindows10/) | | |
|
|
FreeBSD 11 | [](https://jenkins.osquery.io/job/osqueryMasterBuildFreeBSD11/) | | |
|
|
|
|
There are many additional [continuous build jobs](https://jenkins.osquery.io/) 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](https://osquery.io/schema/). To best understand the expressiveness that is afforded to you by osquery, consider the following SQL queries:
|
|
|
|
List the [`users`](https://osquery.io/schema/current#users):
|
|
```sql
|
|
SELECT * FROM users;
|
|
```
|
|
|
|
Check the [`processes`](https://osquery.io/schema/current#processes) that have a deleted executable:
|
|
```sql
|
|
SELECT * FROM processes WHERE on_disk = 0;
|
|
```
|
|
|
|
Get the process name, port, and PID, for processes listening on all interfaces:
|
|
```sql
|
|
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:
|
|
```sql
|
|
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:
|
|
|
|
```sql
|
|
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:
|
|
|
|
```sql
|
|
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](https://osquery.readthedocs.org/en/latest/introduction/using-osqueryi/) shell
|
|
* executed via a [scheduler](https://osquery.readthedocs.org/en/latest/introduction/using-osqueryd/) 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](https://osquery.io/downloads/). Windows 10, 8, Server 2012 and 2016 packages are published to [Chocolatey](https://chocolatey.org/packages/osquery).
|
|
|
|
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.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](https://osquery.readthedocs.org/en/latest/development/building/) 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.13
|
|
- Windows 10 and Server 2016
|
|
|
|
## File Integrity Monitoring (FIM)
|
|
|
|
osquery provides several [FIM features](http://osquery.readthedocs.org/en/stable/deployment/file-integrity-monitoring/) 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`](https://osquery.io/schema/current#file_events) or [`yara_events`](https://osquery.io/schema/current#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](http://osquery.readthedocs.org/en/stable/development/pubsub-framework/) 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](https://github.com/facebook/osquery/blob/master/SECURITY.md) too.
|
|
|
|
Facebook has a [bug bounty](https://www.facebook.com/whitehat/) 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](https://www.facebook.com/notes/facebook-bug-bounty/bug-hunting-osquery/954850014529225).
|
|
|
|
## Learn more
|
|
|
|
Read the [launch blog post](https://code.facebook.com/posts/844436395567983/introducing-osquery/) for background on the project.
|
|
If you're interested in learning more about osquery, visit the [users guide](https://osquery.readthedocs.org/). Development and usage discussion is happening in the osquery Slack, grab an invite automatically [here](https://slack.osquery.io)!
|