Commit Graph

228 Commits

Author SHA1 Message Date
yying
c97118f2f8 Updates to Windows provisioning document (#2471) 2016-09-19 16:46:43 -07:00
Zachary Wasserman
7adf271570 Remove errant comma in example config JSON (#2474) 2016-09-16 13:20:42 -07:00
Teddy Reed
df1e3b9481 Add make fuzz (#2458) 2016-09-13 20:37:31 -07:00
Teddy Reed
080bc5ed88 Improve verbose logging for several linux event publishers (#2421) 2016-08-29 14:26:25 -07:00
Teddy Reed
02dd921d3b Introduce 'external' project builds: make externals (#2385) 2016-08-17 13:33:28 -07:00
Gary
87bc28e313 Added note to explain results from failed queries (#2376) 2016-08-16 08:39:43 -07:00
Teddy Reed
f93253ec48 Nitpicks and style formatting 2016-08-15 16:07:51 -07:00
Ryan Holeman
a217035d12 Add AWS STS assume role authentication capability 2016-08-15 16:07:51 -07:00
Teddy Reed
a2017f68f1 Add clang-format rules from 3.6 (#2360) 2016-08-15 01:33:17 -07:00
artemdinaburg
6e3f4b8e13 Copy required DLLs into the build directory (#2339) 2016-08-10 16:48:33 -07:00
Teddy Reed
e4dd78ec10 Build documentation for brew-based build (#2305) 2016-07-31 17:10:13 -07:00
yying
af7b910c24 Updated Windows provisioning documentation (#2294) 2016-07-28 12:08:20 -07:00
Zachary Wasserman
a7aac29465 Clarify events and database flags in osqueryi docs (#2269) 2016-07-21 12:53:17 -07:00
Zachary Wasserman
0483bed29d Fix broken links to FIM wiki page (#2272) 2016-07-21 12:33:46 -07:00
Teddy Reed
1e4dcb121b Introduce --audit_allow_sockets for Linux socket_events (#2270) 2016-07-20 23:47:54 -07:00
Teddy Reed
172363d3f5 Fix debug-kernel build and deploy dependencies (#2266) 2016-07-20 17:21:20 -07:00
Teddy Reed
edc3fa5a25 Remove process_file_events subscriber from Linux (#2267) 2016-07-20 17:20:23 -07:00
Nick Anderson
00935e28cc Moved windows provisioning script (#2257) 2016-07-19 16:47:51 -07:00
Peter
51f5fa9095 [#2216] Add notice text for required table predicates (#2225) 2016-07-08 08:33:37 -07:00
Ryan Holeman
88053a08b4 Optional top level decorator functionality (#2177) 2016-07-06 15:31:59 -07:00
d-yokoi
97f2850967 fix a typo error on the doc for building (#2172) 2016-06-19 23:24:42 -07:00
Ryan Holeman
b47f246ab4 Optional randomization of shard ids for AWS Kinesis load balancing (#2157) 2016-06-15 15:29:59 -07:00
Teddy Reed
0beb7efef7 Add process auditing and a SQL intro doc (#2129) 2016-06-01 17:28:51 -07:00
Teddy Reed
de8ef7b627 Update README/wiki for Ubuntu 16.04 (#2126) 2016-05-30 21:17:03 -07:00
Yonas Yanfa
d08e55545a Update index.md to mention support for FreeBSD. (#2118) 2016-05-27 14:01:54 -07:00
Ryan Holeman
e29ad573ef fixed issue with aws logger example for kinesis and firehose (#2102) 2016-05-18 09:21:32 -07:00
Marcin Wielgoszewski
484cf9c919 Add blurb about doorman (#2094) 2016-05-12 15:37:22 -07:00
Teddy Reed
d49c401324 Add decorators to example config (#2082) 2016-05-10 10:07:25 -07:00
Uma Reddy
e86a773a2e Update install-osx.md (#2071)
Add post-install notes for brew-based installs.
2016-05-06 08:31:22 -07:00
Teddy Reed
5a56805970 Introduce --utc flag to convert all calendar UNIX times to UTC (#2064)
Beginning in version 1.8.0 all time uses will converge on an osquery-provided
getUnixTime() API call that returns, by default, UNIX time integers converted
to UTC/GMT. The 'time' table will respond with the parsed time for the
configuration. If the timezone is not UTC then osquery is using localtime.

This configuration option will affect the 'unix_time' response in the 'time'
table. Because of this configurable-effect the table is extended to include
'local_time' which is always the system local UNIX time.
2016-05-03 13:00:31 -07:00
Teddy Reed
b6f09a7ecb Add action for snapshot query results (#2061) 2016-05-03 11:16:22 -07:00
Zachary Wasserman
10781e896e Add wiki docs for AWS logger plugins (#2052) 2016-04-25 16:20:01 -07:00
Mike Arpaia
8e73cf82d2 formatting changes for windows documentation 2016-04-19 10:25:28 -07:00
yying
0c15e1e732 Adding README explaining Windows provisioning and moved Windows provisioning README to development/, added it as link in navbar. Also added a mini-HOWTO section for running the provisioning script.
Adding README explaining Windows provisioning and moved Windows provisioning README to development/, added it as link in navbar.  Also added a mini-HOWTO section for running the provisioning script.
2016-04-19 09:38:18 -07:00
Zachary Wasserman
c4f9c14d5e Add docs for syslog tables 2016-04-05 11:01:10 -07:00
Teddy Reed
2379493721 Introduce decorator queries 2016-03-29 10:03:50 -07:00
Zachary Wasserman
0eff0f2f4e Collection of doc fixes
- Minor fix in creating tables documentation
- Fix docs for join
- Add note about config paths
- Update events docs
- Fix link to query packs
2016-03-25 14:12:41 -07:00
Uma Reddy
e421bfa54b Update extensions.md 2016-03-17 12:47:13 -04:00
Teddy Reed
8c3d2387e9 Add define to enable SQLite WHERETRACE 2016-03-04 20:41:06 -08:00
Teddy Reed
c3abb1ef38 Minor addition to multiple logger wiki docs 2016-02-23 10:42:08 -08:00
Teddy Reed
db3377a536 Merge pull request #1846 from zwass/logger_plugin_doc_edit
Update logger plugin docs
2016-02-12 10:13:20 -08:00
Zachary Wasserman
8eb4d2776b Update logger plugin docs
* Add explanation for how to  use multiple logger plugins
* Add syslog plugin to the (short) list of plugins in the CLI flags
* Make docs consistent by changing uses of "logging plugin" to "logger plugin"
2016-02-11 18:23:25 -08:00
Teddy Reed
089de478cd [#1810] Minor changes to extensions-use docs 2016-02-10 23:39:29 -08:00
Teddy Reed
1328aafcb3 [#1733] Document TLS client-auth and enroll notes 2016-02-01 09:37:10 -08:00
Teddy Reed
d0c550e987 [#1769] Remove reference to passwd_changes 2016-02-01 09:26:23 -08:00
Teddy Reed
b9be0c78a4 Merge pull request #1802 from theopolis/events_max
Add an events_max limit for event buffering
2016-02-01 09:05:59 -08:00
Teddy Reed
f05cc345d3 Add an events_max limit for event buffering 2016-02-01 08:38:58 -08:00
Teddy Reed
1acb5a4df0 [1576] Gate Makefile check for git to non-deps targets 2016-01-30 17:32:00 -08:00
Teddy Reed
95c4d733cc Add and document TLS debug features 2016-01-22 08:59:07 -08:00
Teddy Reed
3c09d69ef0 Remove deps and release from PR builds 2016-01-21 09:37:10 -08:00
Teddy Reed
5e4cba7bb1 Merge pull request #1785 from theopolis/docs_debug2
Add deployment debugging wiki
2016-01-20 17:51:17 -08:00
Teddy Reed
8b1ac7ebaf Adding deployment debugging documentation 2016-01-20 16:22:32 -08:00
Teddy Reed
dfa32d9e7e Update OS X kernel building to include distro 2016-01-19 16:20:16 -08:00
Teddy Reed
ec034e583b Update osquery CLI flags documentation 2016-01-19 15:57:04 -08:00
Teddy Reed
0a7dcbb967 Merge pull request #1719 from jacknagz/osx-config-docs
Resolves #1718: Updated LaunchDaemon and Chef Template
2015-12-11 14:01:58 -08:00
Teddy Reed
98eb6a5055 Reorganize file_events into process_file_events 2015-12-11 00:58:22 -08:00
Jack Naglieri
b396972ef7 Resolves #1718: Updated LaunchDaemon and Chef Template 2015-12-10 19:16:29 -08:00
Teddy Reed
9d394065e3 [#1636] Add simple sharding to packs and pack queries 2015-12-10 10:01:53 -08:00
Teddy Reed
c020bb87b4 Merge pull request #1705 from theopolis/dump
[#1702] Add config and database dumping to stdout
2015-12-06 21:41:31 -08:00
Teddy Reed
eeff5d0bf0 [#1676] Clear node key on node_invalid 2015-12-06 14:28:00 -08:00
Teddy Reed
fef53fa0d0 Add config and database dumping to stdout 2015-12-06 11:01:26 -08:00
Adrian Macneil
1f412a0297 Clarify distributed flags documentation 2015-11-23 12:17:04 -08:00
Teddy Reed
cef8f59054 Merge pull request #1639 from theopolis/cache
Table results caching
2015-11-14 16:22:24 -08:00
Teddy Reed
c2be670806 Table results caching
1. Table implementations (spec files) can mark the table as 'cachable'.
2. Cached results depend on the shortest/quickest interval of scheduled
queries that act on results of the table.
3. The table API generator blocks caching on index/additional/required
table column options.
2015-11-14 15:57:23 -08:00
Andrew Dunham
4ccdcc7864 Allow setting the mode of log files
This also sets the appropriate flags in glog
2015-11-11 11:37:55 -08:00
Teddy Reed
7c70183a87 Merge pull request #1625 from theopolis/pack_delim
Add pack_delimiter option
2015-11-03 21:05:44 -08:00
Sharvil Shah
97adb862ce Update to the correct link, fixes #1627 2015-11-03 04:37:25 -08:00
Teddy Reed
15c4673c5a Add pack_delimiter option 2015-11-02 18:05:46 -08:00
Teddy Reed
ba4eeb6a80 [#1600] Put inotify into a mod-only watch mode 2015-10-27 16:42:21 -07:00
Teddy Reed
c0257aa7d1 Merge pull request #1589 from theopolis/fix_1578
[Fix #1578] Support OPENSSL_NO_SSV3
2015-10-19 11:25:46 -07:00
Teddy Reed
00875988dc Use native OS X version as min ABI 2015-10-18 20:47:09 -07:00
Robert C. Seacord
8030866add Update reading-files.md
The smaller example was not going to compile because kPath was not defined.
2015-10-16 16:10:36 +00:00
Teddy Reed
2e7415f871 Convert wiki to UNIX format and refresh most content 2015-10-15 12:18:16 -07:00
Luis San Martin
0f0d873a96 sudo added as requeriment 2015-10-14 20:05:12 -03:00
Teddy Reed
82b0ccf782 Merge pull request #1553 from arubdesu/docs-darwinSysReqs
explicitly call out OS and requirements at top of OS X install doc
2015-10-13 11:26:32 -07:00
Allister Banks
d79d02dde5 explicitly call out OS compatibility at top of OS X install doc
Reordered install types, Pointed to the CI build status as an indication
of platform support, moved up the line about pkg/lib dependencies
to be after the pkg section. Someone stop Atom from tacking newlines to
the ends of files on save, GitHub, you’re not the boss of me!
2015-10-13 14:10:38 -04:00
Mike Arpaia
dea0b4d1c9 Merge pull request #1542 from keeleysam/keeleysam-patch-1
Use full key for apt
2015-10-12 16:55:18 -07:00
Teddy Reed
b7a2d861bf Build Glog with OS X ABI, add SKIP_BENCHMARK 2015-10-11 14:37:49 -07:00
Mike Arpaia
4d0cd46f42 Merge pull request #1539 from theopolis/nit_101
Minor nits around distributed CLIs
2015-10-09 14:55:05 -07:00
Samuel Keeley
e1b6f917fd Use full key for apt
The 8 digit key is not secure
2015-10-07 16:00:38 -07:00
Dan Farmer
2413615885 Typo in linux installation docs
Added the character "d" to two lines to fix a typo.

From:

sudo service osquery start
sudo service osquery status

To:

sudo service osqueryd start
sudo service osqueryd status
2015-10-06 18:36:18 -07:00
Teddy Reed
689ae4c865 Minor nits around distributed CLIs 2015-10-02 11:33:50 -07:00
Mike Arpaia
aaa03a1058 Distributed queries client-side 2015-09-08 13:33:48 -07:00
Mike Arpaia
a140333441 [fix #1390] query pack re-org
This commit contains the features specified in #1390 as well as a
refactoring of the general osquery configuration code.

The API for the config plugins hasn't changed, although now there's a
`genPack` method that config plugins can implement. If a plugin doesn't
implement `genPack`, then the map<string, string> format cannot be used.
The default config plugin, the filesystem plugin, now implements
`genPack`, so existing query packs code will continue to work as it
always has.

Now many other config plugins can implement custom pack handling for
what makes sense in their context. `genPacks` is not a pure virtual, so
it doesn't have to be implemented in your plugin if you don't want to
use it. Also, more importantly, all config plugins can use the standard
inline pack format if they want to use query packs. Which is awesome.

For more information, refer to #1390, the documentation and the doxygen
comments included with this pull requests, as well as the following
example config which is now supported, regardless of what config plugin
you're using:

```json
{
  "options": {
    "enable_monitor": "true"
  },
  "packs": {
    "core_os_monitoring": {
        "version": "1.4.5",
        "discovery": [
          "select pid from processes where name like '%osqueryd%';"
        ],
        "queries": {
          "kernel_modules": {
              "query": "SELECT name, size FROM kernel_modules;",
              "interval": 600
          },
          "system_controls": {
              "query": "SELECT * FROM system_controls;",
              "interval": 600,
              "snapshot": true,
          },
          "usb_devices": {
              "query": "SELECT * FROM usb_devices;",
              "interval": 600
          }
        }
    },
    "osquery_internal_info": {
        "version": "1.4.5",
        "discovery": [
          "select pid from processes where name like '%osqueryd%';"
        ],
        "queries": {
          "info": {
              "query": "select i.*, p.resident_size, p.user_time, p.system_time, time.minutes as counter from osquery_info i, processes p, time where p.pid = i.pid;",
              "interval": 60,
              "snapshot": true
          },
          "registry": {
              "query": "SELECT * FROM osquery_registry;",
              "interval": 600,
              "snapshot": true
          },
          "schedule": {
              "query": "select name, interval, executions, output_size, wall_time, (user_time/executions) as avg_user_time, (system_time/executions) as avg_system_time, average_memory from osquery_schedule;",
              "interval": 60,
              "snapshot": true
          }
        }
    }
  }
}
```

The `osquery_packs` table was modified to remove the superfluous
columns which could already have been found in `osquery_schedule`. Two
more columns were added in their place, representing stats about pack's
discovery query execution history.

Notably, the internal API for the `osquery::Config` class has changed
rather dramatically as apart of the refactoring. We think this is an
improvement. While strictly adhering to the osquery config plugin
interface will have avoided any compatibility errors, advanced users may
notice compilation errors if they access config data directly. All
internal users of the config have obviously been updated. Yet another
reason to merge your code into mainline; we update it for you when we
refactor!
2015-09-02 10:56:26 -07:00
Teddy Reed
0e16f56c8d Add 'hidden' flags to customize TLS plugins 2015-08-28 12:57:53 -07:00
Kevin Thompson
e8772f2603 Adds an enroll_secret_env flag that allows the user to specify that
the enroll secret for TLS enrollment is stored in an environment
variable rather than a file.
2015-08-25 21:11:19 -05:00
Allister Banks
153fbdff0d osqueryctl subcommand reversed in doc
Yes it immediately told me about it, this is just a docs tweak to
reflect the proper order. 😅
2015-08-19 13:09:25 -04:00
Teddy Reed
b9ded9e7af [#1402] Add notes around pack paths in example.conf 2015-08-12 17:15:42 -07:00
Teddy Reed
ff9cb71628 Various additional tests and benchmarks 2015-07-28 12:26:17 -07:00
Elan Ruusamäe
9a4bc7ede4 Update building.md
fix doc link
2015-07-25 16:49:31 +03:00
Teddy Reed
6104aaebfe Add optional TLS config plugin refresh 2015-07-17 14:59:08 -07:00
Artur Chmiel
c0be6b5ba1 Fixed URLs and some typos in the documentation 2015-07-16 23:17:22 +02:00
Teddy Reed
c269bbeaf3 Rollup of build changes 2015-07-14 13:45:53 -07:00
Michael O'Farrell
276891ad00 Merge pull request #1330 from mofarrell/kernel
Kernel!!!
2015-07-13 17:29:08 -07:00
Artur Chmiel
cb1856654d Various fixes to the documentation 2015-07-11 23:37:25 +02:00
Mike Arpaia
3b11d974fa Merge pull request #1306 from marpaia/email-wiki
Add google group email to the wiki
2015-07-10 01:45:58 -04:00
Michael O'Farrell
0284b9e60d Merge branch 'master' into kernel
Conflicts:
	mkdocs.yml
2015-07-08 10:26:32 -07:00
Teddy Reed
f48619ed28 [#1285, #1276] Faster, optimized subscriber results 2015-07-07 00:59:28 -07:00
Mike Arpaia
8fe1c4029d Add google group email to the wiki
Let's start using our google group for long-form questions so that we
can leave issues for implementation tasks.
2015-07-06 17:24:27 -07:00
Teddy Reed
dd9fa25d78 [Fix #1171, #1089] Add configurable max reads
There are 3 new options that control how files are read:
--read_max: controls the maximum size, in bytes, for file reads. If a file is larger than `read_max` the read will fail.
--read_user_max: similar to `read_max` but applies additional limitations to user-controlled files.
--read_user_links: a boolean control to enable/disable following symlinks for user-controlled files.

Important highlights:
If files exceed the configured max, those reads will fail.
The `read_max` will override `read_user_max` if it is set lower.
A default integer value of `0` will disable the limitations.

The default `read_max` is set to 50M and the default `read_user_max` is 10M.
2015-07-06 00:49:43 -07:00
Mike Arpaia
1a6a6d4a1c README updates
Moving platform specific build instructions to the wiki, to keep the
README brief.
2015-07-01 23:47:41 -07:00
Teddy Reed
757940fe6f Towards CMake-powered kernel extension building 2015-06-30 00:49:16 -07:00
Michael O'Farrell
f4e05b992a Merge branch 'master' into kernel
Conflicts:
	mkdocs.yml
2015-06-26 17:04:42 -07:00
Michael O'Farrell
7adf170540 Base kernel module with circular queue and test. 2015-06-23 16:16:19 -07:00
Teddy Reed
0c6c1e3a62 Various quality control fixes 2015-06-12 01:32:24 -07:00
Teddy Reed
727f5b091f Various table perf improvements and TLS docs 2015-06-05 22:03:15 -07:00
Teddy Reed
a105924804 Move specs to a top-level path, add query examples
1. Example queries will run with an (optional) integration test.
2. Fix bad accesses with OS X package BOMs
3. Move spec files from ./osquery/tables/specs to ./specs
4. Remove server parsers (netlib) from client builds.
2015-06-03 10:39:05 -07:00
Teddy Reed
6591916fed [#1076] RTD wiki article on extensions autoloading 2015-05-28 16:27:29 -07:00
Teddy Reed
b405d9f24a Build/vagrant wiki cleanup
1. Adding us-west-2
2. Support for VPC/subnet options
3. Excluding binary/git dirs from AWS rsync
2015-05-27 11:12:02 -07:00
Blake Frantz
28d9237b50 Amazon EC2-based vagrant targets for RHEL/Amazon Linux
1. added docs for vagrant-aws support in Vagrantfile
2. removed aws target that have local vagrant support. inline-string'd aws.user_data
3. support building rhel6/7 in aws
4. correct aws-rhel6.6 name. it should be rhel6.5
2015-05-26 21:03:10 -07:00
Mike Arpaia
fff36af0af Removing trailing whitespace 2015-05-11 23:31:13 -07:00
Teddy Reed
e01a73b4f3 Schedule monitoring, doc updates, logger plugin fixes 2015-05-03 11:54:15 -07:00
Sharvil Shah
cb396bd7b7 fix 404s as a result of relative links not having .md extension 2015-05-02 04:12:21 -07:00
Sharvil Shah
35c6cb8f39 Fix https mixed content warning by updating image links to https 2015-05-02 03:35:05 -07:00
Teddy Reed
06aa60a127 Merge pull request #1074 from sharvilshah/disable_tables_runtime_flag
[Implements #1016] Disable tables runtime flag
2015-04-30 01:55:03 -07:00
Sharvil Shah
2735e731de Implement --disable_tables runtime flag 2015-04-30 01:41:01 -07:00
John Reese
bc978475c8 Add .py extension to build docs tools/profile 2015-04-29 23:14:34 -07:00
Ari Rubinstein
a69a4b1903 First iteration of FIM documentation 2015-04-29 12:46:51 -07:00
Wesley Shields
f431280c2e Address concerns from Mike.
Mostly cleanup as it moved from a gist to get the word out to docs.

This does assume that the change from file_changes to file_events
in #1049 will happen.
2015-04-28 21:55:22 -04:00
Wesley Shields
5de1f484df First cut at YARA docs. 2015-04-27 23:59:55 -04:00
Shawn Davenport
abdf273f0a Fix install-osx link. 2015-04-25 19:57:07 -07:00
Sharvil Shah
6383a9917f Support setting v.cpus via ENV variable, default fallback to 2
Update docs: mention V_CPUS ENV variable for vagrant

Use OSQUERY_BUILD_CPUS as the ENV var instead of V_CPUS
2015-04-23 14:15:16 -07:00
Teddy Reed
8930f9e692 Documentation updates, separate config/logging pages
Mostly minor documentation/wiki/guide fixes.
The breaks down the "using osqueryd" page into more of a summary
of what the daemon does from a schedule/logging perspective.

The bulk of the "using osqueryd" page now exists in the configuration
deployment page and the new "logging" deployment page.
2015-04-18 22:09:25 -07:00
Mike Arpaia
0745017233 missing quote in docs 2015-04-10 23:31:10 -07:00
Teddy Reed
e69f72cd56 Documentation updates 2015-04-10 14:31:34 -07:00
Teddy Reed
1305a2764a [Fix #964] Restrict apt-sources to arch=amd64 2015-04-08 14:13:01 -07:00
Wesley Shields
c2c6dbd216 Remove MATCHES from docs.
This is not a valid ConstraintOperator.
2015-04-06 20:43:56 -04:00
Teddy Reed
2df9a6558e Add some osquery-theme to API docs 2015-04-06 01:21:10 -07:00