Version information
This version is compatible with:
- Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.5.0 < 7.0.0
- Amazon, , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'threatstack-threatstack', '2.0.12'
Learn more about managing modules with a PuppetfileDocumentation
Threat Stack Puppet Module
Puppet manifests to deploy the Threat Stack server agent.
Threat Stack is a continuous cloud security monitoring service. It aims to provide an organization greater security, compliance, and operational efficiency. Threat Stack customers can use this module to deploy the agent and register hosts.
For more see https://www.threatstack.com.
Platforms
- Amazon Linux 1 & 2
- CentOS
- Debian
- RedHat
- Ubuntu
- Windows
Classes
threatstack
- Main classthreatstack::apt
(private) - Setup apt repository configuration and package installthreatstack::configure
(private) - Register and configure the agent with the Threat Stack servicethreatstack::msi
(private) - Dummy repo class for Windows installsthreatstack::package
(private) - Install the Threat Stack agentthreatstack::params
(private) - Default setup valuesthreatstack::service
(private) - Manage the Threat Stack servicethreatstack::site
(private) - Used by Puppet test-kitchenthreatstack::sysmon
(private) - Installs sysmon service and default config on Windowsthreatstack::yum
(private) - Setup yum repository configuration and package install
Parameters
threatstack::deploy_key
[required] - Set the deploy key for registering the agent.threatstack::rulesets
[optional array] - Set the ruleset or rulesets the node will be added to (Default: 'Base Rule Set').threatstack::configure_agent
[optiona bool] - Set to false to just install agent without configuring. Useful for image building.threatstack::agent_config_args
[optional array of hashes] - Extra arguments to pass during agent activation. Useful for enabling new platform features.threatstack::disable_auditd
[optional bool] - Disableauditd
service to avoid installation issues. (Default is 'true' on RHEL-like OSes.)threatstack::enable_sysmon
[optional bool] - used viathreatstack::sysmon
to enable sysmon service on Windows hoststhreatstack::extra_args
[optional array of hashes] - optional array of hashes to define setup options for the threatstack agent (Default:undef
)threatstack::confdir
[optional string] - path to config directory for the threatstack service (Default: '/opt/threatstack/etc')threatstack::ts_hostname
[optional string] - hostname of your node (Default:$::fqdn
)threatstack::gpg_key
[optional string] - gpg key url for use with yum/apt repos (Default: set inthreatstack::params
based on operating system)threatstack::package_version
[optional string] - version of thethreatstack-agent
package to install (Default:installed
)threatstack::repo_class
[optional string] - name of puppet class that configures the threatstack package repo (Default: eitherthreatstack::apt
orthreatstack::yum
, set inthreatstack::params
based on operating system)threatstack::repo_url
[optional string] - url used by threatstack package repo (Default: defined inthreatstack::params
for Debian and RedHat operating system families.)threatstack::repo_enabled
[optional string] - enable/disable the threatstack repo (Default: defined inthreatstack::params
for RedHat operating system families.)threatstack::windows_download_url
[optional string] - url used to download Threatstack Agent MSI on Windowsthreatstack::windows_install_options
[optional array] - Windows MSI install optionsthreatstack::windows_ts_package
[optional string] - Windows MSI package name
Example usage
Below are some examples for how to use this module.
Standard usage
Supply your Threat Stack deploy key, and if you choose, an array of rulesets.
class { '::threatstack':
deploy_key => 'MyDeployKey',
ruleset => ['MyRuleset']
}
Using a package mirror
If you manage your own package repository from which you deploy the agent package then supply repo_url
and gpg_key
.
class { '::threatstack':
deploy_key => 'MyDeployKey',
ruleset => ['MyRuleset'],
repo_url => 'https://my-mirror.example.com/centos-6'
gpg_key => 'https://my-mirror.example.com/RPM-GPG-KEY-THREATSTACK'
}
Agent installation into golden image
If installing the agent into an image that will be deployed for multiple instances, configure the class to not configure the agent while creating the image. If the agent is registered and configured in the golden image then events and alerting will not be correct.
class { '::threatstack':
configure_agent => false,
}
Testing
Run the following to perform basic spec testing.
bundle install
bundle exec rake spec
Integration testing requires setting TS_DEPLOY_KEY
in the environment to a valid key value for tests to succeed.
export TS_DEPLOY_KEY='<deploy_key>'
bundle exec kitchen test
Contributing enhancements/fixes
See the CONTRIBUTING document for details.
Change log
We'll track changes here starting with details about the 2.0 release and reference to earlier releases.
2.0.11
- switched to using simp/auditd to deal with
auditd
- the kemra102/auditd module appears to be abandoned and doesn't support RHEL 8
2.0.10
Added
- updated README with support for
- Debian 10
- Ubuntu 20.04
- CentOS/RedHat 8
- updated tests for newer distros
- added optional parameter to enable/disable yum repo on rhel
2.0.9
Fixed
- merged PR simplifying ruleset args
2.0.8
Fixed
- merged PR fixing amazon linux 1/upstart service compatibility
- also uses
remote_file
vs.file
resource in windows manifest - merged PR defaulting to default apt keyserver
- thanks @carthik and @amlodzianowski!
2.0.7
Changed
- use a service resource to manage auditd vs. an exec
2.0.6
Added
- added basic support for downloading, configuring, installing, running windows agent
2.0.2
Fixed
- fixed amazon linux 1 support and tests
2.0.1
Changed
- added optional parameter
disable_auditd
to handle issues users reported installing on RHEL-like OSes
Fixed
- fixed amazon linux 2 yum repo assignment
2.0
This release tracks the release of the Threat Stack Agent 2.0
NOTE: To install/configure/run Threat Stack Agent < 2.0, please keep using the 1.8.1 release of this module. Module version 2.0 supports Threat Stack Agent 2.0 and above, only.
Changed
- module depends on puppetlabs/apt and puppetlabs/stdlib
- paths and
tsagent
related commands are changed to reflect new layout in packages - dropped support for TS Agent < 2.0 in this module
- agent package repos are completely separate
- supported OSes:
- Debian 8, 9
- Ubuntu 16.04, 18.04
- RedHat 7
- CentOS 7
- Amazon Linux
- targets support for Puppet 5.x
Fixed
- cleaned up code
- used
apt_source
resource instead ofexec
s - updated spec tests
1.8.1
Fixed
- use
operatingsystem
fact to ensure Amazon Linux can install yum repos
Dependencies
- puppetlabs/stdlib (>= 4.2.2)
- puppetlabs/apt (>= 6.2.1)
- lwf/remote_file (>= 1.1.3)
- puppet/archive (>= 4.3.0)
- simp/auditd (>= 8.6.1)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2015 Threat Stack 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.