osquery Cookbook

This cookbook includes recipes and resources to install, configure, and start Facebook's osquery. osquery is an operating system instrumentation framework for OS X/macOS, Windows, and Linux.

Supported

Platforms

• Ubuntu: 12.04, 14.04, 16.04
• Centos/Redhat: 6.5, 7.0
• OS X

Chef

• Chef 11+

Cookbooks

• apt

Usage

• Include osquery::default in your node's run_list
• Override attributes to fit your desired setup

Recipes

default

The default recipe determines if a node is within the supported platform list and includes the one of the platform specific recipes to setup osquery.

centos/ubuntu/mac_os_x

• Install osquery via package (rpm, deb, or pkg)
• Setup syslog ingestion if enabled
• Create configuration file(s)
• Start/enable osqueryd service

Attributes

attributes/default.rb:

Default attributes control the version to install, syslog configuration, and whether or not to use Facebook's Apt/Yum repo or your own internal repo.

attributes/config.rb:

Config attributes add options to the osquery config options key. This includes logger plugins, config plugin, splay, worker threads, and more.

attributes/schedule.rb:

Schedule attributes control the main osquery query schedule. You can add additional queries this way:

default['osquery']['schedule']['query_name'] = {
  query: 'SELECT * FROM table_name;',
  interval: '86400',
  description: 'my new query'
}

attributes/file_paths.rb:

File integrity monitoring paths.

attributes/decorators.rb:

Decorator query options.

Custom Resources

osquery_conf: creates osquery config from selected options and packs

• actions: :create or :delete
• schedule: (required) Hash of scheduled queries to run
• fim_paths: (optional) Hash of file integrity monitoring path descriptions and array of their paths
• packs: (optional) List of osquery packs to install. Based on filenames ending in *.conf in pack_source/packs
• pack_source: (optional) Cookbook source for osquery packs
• The daemon configuration is compiled from the node['osquery']['options'] attributes.

create:

osquery_conf osquery_config_path do
  action      :create
  schedule    node['osquery']['schedule']
  fim_paths   node['osquery']['file_paths']
  fim_exclude_paths   node['osquery']['exclude_paths']
  packs       node['osquery']['packs']
  pack_source node['osquery']['pack_source']
  decorators  node['osquery']['decorators']
end

delete:

osquery_conf 'delete osquery config' do
  action :delete
end

osquery_install: installs osquery on centos/redhat, ubuntu, or os x

• actions:
  • :install_ubuntu, :install_centos, :install_os_x
  • :remove_ubuntu, :remove_centos, :remove_os_x
• version: (required - name attribute) string of the osquery version to install

install:

osquery_install node['osquery']['version'] do
  action :install_ubuntu
end

remove:

osquery_install node['osquery']['version'] do
  action :remove_ubuntu
end

osquery_syslog: creates osquery syslog config file

• actions: :create or :delete
• syslog_file: (required - name attribute) filename of the osquery syslog config
• pipe_filter: the filter expression for routing events into the syslog pipe
• pipe_path: the fifo pipe path
• note: this resource installs rsyslog if not already configured

install:

osquery_syslog node['osquery']['syslog']['filename'] do
  pipe_filter node['osquery']['syslog']['pipe_filter']
  pipe_path   node['osquery']['options']['syslog_pipe_path']
  action      :create
  only_if     { node['osquery']['syslog']['enabled'] }
  notifies    :restart, "service[#{osquery_daemon}]"
end

delete:

osquery_syslog node['osquery']['syslog']['filename'] do
  action   :delete
  notifies :restart, "service[#{osquery_daemon}]"
end

Testing

Run rake to execute:

• foodcritic
• rubocop
• chefspec

Run kitchen verify to run Inspec integration tests

• Requirements: VirtualBox with Extension Pack (for the OS X vm)

Contributing

1. Fork the repository on Github.
2. Create a named feature branch (like add_component_x).
3. Write your change.
4. Write tests for your change.
5. Run the tests, ensuring they all pass (rubocop; rspec).
6. Submit a Pull Request using Github.

License and Authors

• Authors: Jack Naglieri ([email protected])

Copyright 2013-2014 Jack Naglieri <[email protected]>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.