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
- Puppet >= 5.5.10 < 7.0.0
- AmazonLinux,CentOS,Debian,OracleLinux,RedHat,SLES,windows,Ubuntu
Tasks:
- backup_assessor
- ciscat_scan
You'll need Puppet Enterprise to use this module. You may also evaluate this module with Puppet Bolt for up to 90 days.Learn More
Start using this module
Documentation
Puppet Comply
Puppet Comply is a tool that assesses the infrastructure you manage with Puppet Enterprise against CIS Benchmarks — the best practices for securely configuring systems from the Center for Internet Security (CIS).
Installing
This Module is required by the Puppet Comply product and should only be used as per the complete install instructions
Obtaining the Product
Reference
Table of Contents
Classes
comply
: Installs scarp and ciscat on a nodecomply::scanners::ciscat
: Installs a JRE
Classes
comply
Installs scarp and ciscat on a node
Examples
Use defaults
include comply
Mange packages elsewhere
class { 'comply':
linux_manage_unzip => false,
windows_manage_jre8 => false,
}
Parameters
The following parameters are available in the comply
class.
linux_manage_unzip
Data type: Boolean
Determines if this module should manage the installation of unzip on Linux
Default value: true
windows_manage_jre8
Data type: Boolean
Determines if this module should manage the installation of jre8 on Windows
Default value: true
scanner_source
Data type: Pattern[/(\d+\.\d+.\d+)/]
This is a file resource so you can use different kinds of file paths. https://puppet.com/docs/puppet/5.5/types/file.html#file-attribute-source Supplies the storage location (URL) for the scanner. Required eg 'https://artifactory.delivery.puppetlabs.net/artifactory/generic__local/compliance/scanners/Assessor-CLI-v4.0.24.zip'
Default value: undef
comply::scanners::ciscat
CIS CAT Pro scanner requies a JRE as a prerequisite
Examples
include comply::scanners::ciscat
Mange packages elsewhere
class { 'comply::ciscat':
linux_manage_unzip => false,
windows_manage_jre8 => false,
}
Parameters
The following parameters are available in the comply::scanners::ciscat
class.
linux_manage_unzip
Data type: Boolean
Determines if this module should manage the installation of unzip on Linux
Default value: $comply::linux_manage_unzip
windows_manage_jre8
Data type: Boolean
Determines if this module should manage the installation of jre8 on Windows
Default value: $comply::windows_manage_jre8
scanner_source
Data type: Pattern[/(\d+\.\d+.\d+)/]
Supplies the storage location (URL) for the scanner. Required
Default value: $comply::scanner_source
What are tasks?
Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.
Tasks in this module release
Change log
All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v1.0.0 (2020-12-02)
Added
- (Feat) Report now points theQ #300 (Ioannis-Karasavvaidis)
Fixed
- (CISC-946) adding the appropriate license file #301 (tphoney)
- (CISC-871) Add Settings table to Hasura #294 (eimlav)
v0.9.0 (2020-11-25)
Added
- (CISC-917) remove un-needed files from resultant module #290 (tphoney)
- (CISC-837) adding more OSes to scanner support #283 (tphoney)
- (CISC-762) Add docker pepper secret #275 (HelenCampbell)
- (CISC-845) remove the app_stack class #274 (tphoney)
- (CISC-780) changing to 4.0.24 of the CIS scanner #271 (tphoney)
- (CISC-734) config for secure/insecure report sending #270 (tphoney)
- (CISC-757) adding watcher to the stack #267 (tphoney)
- (CISC-733,CISC-758,CISC-759) Enable Authentication #266 (Ioannis-Karasavvaidis)
- (CISC-723,CISC-726,CISC-727,CISC-729,CISC-730,CISC-731) Get gatekeeper and identity services into our stack #264 (Ioannis-Karasavvaidis)
- (CISC-722) Random Password generator #262 (Ioannis-Karasavvaidis)
- (CISC-743) [module] Docker secrets to store sensitive stack information #261 (Ioannis-Karasavvaidis)
- (CISC-739) Update scarp api base uri. #258 (tphoney)
- (CISC-745) [module] Pass module version to UI #256 (Ioannis-Karasavvaidis)
- (CISC-712) task to allow upgrades of the assessor #255 (tphoney)
- (CISC-655) move to 4.0.23 of the assessor #248 (tphoney)
- (CISC-688) Ciscat scan custom_profile_id and scan_type params #247 (HelenCampbell)
Fixed
- (CISC-893) use certname as a param when pushing reports #292 (tphoney)
- (CISC-893) use certnames not hostnames #291 (tphoney)
- (CISC-844) removing the cis scanner from the module #284 (tphoney)
- (CISC-889) pass the fqdn with the report #281 (tphoney)
- (CISC-862) [Task] task reports back to a hardcoded port. #279 (Ioannis-Karasavvaidis)
- (CISC-794) Fix custom profile usage in ciscat task #268 (eimlav)
- (CISC-740) allow setting of pe tls checks in scarp #265 (tphoney)
- (CISC-744) improve error message/handing for ciscat scan #259 (tphoney)
- (CISC-747) update hasura metadata for profile_rule table #257 (tphoney)
v0.8.0 (2020-09-17)
Added
- (CISC-661,CISC-665) Add graphQL Layer into our stack, import graphql metadata into production #244 (Ioannis-Karasavvaidis)
Fixed
- (CISC-683) ciscat task set java memory options, fqdn match in lowercase #249 (tphoney)
- (CISC-672) Fix path issues in script.sh #245 (eimlav)
v0.7.0 (2020-08-27)
Added
- (CISC-615) Use string for scan_hash in ciscat task #237 (HelenCampbell)
- (CISC-457) ciscat scan task allows a hash of benchmark/profile #229 (tphoney)
- (CISC-491) add release helper action #226 (maxiegit)
Fixed
- (CISC-622) Modify ciscat to negate need to reboot on Windows #238 (eimlav)
- (CISC-402) Add idempotency check for Assessor-CLI installation #235 (eimlav)
v0.6.0 (2020-07-17)
Added
- (CISC-534) add assessor version fact and tests #228 (tphoney)
- (CISC-480) add more ubuntu OSes #225 (tphoney)
Fixed
- (CISC-459) Improve error reporting when Java is not present #224 (da-ar)
- (bugfix) Fix
image\_helper.sh
issue with Postgres image #223 (da-ar)
v0.5.1 (2020-06-15)
Fixed
v0.5.0 (2020-06-03)
Added
- (feat) Make scarp address configurable #204 (tphoney)
- (CISC-377) add extra oses to scanner matrix #199 (maxiegit)
Fixed
v0.4.0 (2020-05-27)
Added
v0.3.0 (2020-05-14)
Added
- (feat) adding postgres to the application stack #193 (tphoney)
- (CISC-292) Automate comply tar upload #185 (maxiegit)
Fixed
- (bugfix) Limit profile values in ciscat scan task #189 (tom-krieger)
v0.2.1 (2020-04-20)
Added
- (feat) initial commit, of using a single task for scanning and uploading #184 (tphoney)
- (CISC-284) Switch to change log generator #183 (maxiegit)
0.2.0 (2020-04-14)
UNCATEGORIZED PRS; LABEL THEM ON GITHUB
- (CISC-281) Changes for the Beta #181 (da-ar)
- 0.2.0 release prep #180 (tphoney)
- Adding the terms of service #179 (tphoney)
- 🙅 Beta switch #178 (da-ar)
alpha-0.1.0 (2020-04-08)
UNCATEGORIZED PRS; LABEL THEM ON GITHUB
- Fix: Add mapping to Windows 2019 benchmark file #174 (kreeuwijk)
- (CISC-282) Add guard for Java prerequisite #172 (da-ar)
- (CISC-273) task_helper will use correct exit_status #171 (da-ar)
- (bugfix) use 'value' in targets response #165 (tphoney)
- (CISC-254) Use artifactory to get scarpy #163 (tphoney)
- (maint) Update readme #160 (da-ar)
- (CISC-261) use pe + agent instead of upload and puppet apply #159 (maxiegit)
- (maint) Update comply-ui to use HOST_FQDN #157 (da-ar)
- Automatic scarp 0.0.32 update #156 (ComplianceService)
- (CISC-251) fixing acceptance / integration tests and better error checking in demo plans #155 (tphoney)
- Combining modules and updating code #153 (genebean)
- (CISC-217) Helper script for deploying alpha stack to private registry #151 (da-ar)
- Automatic scarp 0.0.31 update #150 (ComplianceService)
- (CISC-220) clean demo setup #149 (tphoney)
- (CSC-218) simplify install of comply UI stack #148 (tphoney)
- Automatic scarp 0.0.30 update #146 (ComplianceService)
- (feat) enable trusted external facts #145 (tphoney)
- (CISC-211) Remove Authentication for Scarp temporarily #144 (HelenCampbell)
- (feat) pre-populate scarp with some scan results #143 (tphoney)
- quick fix for extend vm rake task #142 (da-ar)
- (maint) Fix integration tests for multinode #141 (da-ar)
- (CISC-203) Update scan plan to find comply stack #140 (da-ar)
- (CISC-204) adding the ciscat scanner to the module #139 (tphoney)
- (CISC-203) Update Beta to allow Comply Stack to run on standalone node #138 (da-ar)
- (cisc-202) update the customer install steps for the Alpha #137 (tphoney)
- (feat) move the comply stack to its own machine #136 (tphoney)
- (CISC-130) Customer install workflow #135 (da-ar)
- [CISC-185] Remove version numbers from benchmarks #134 (maxiegit)
- (maint) rename the demo setup to make more sense #129 (tphoney)
- (maint) Update scarp to convert reports to sumstats long #124 (da-ar)
- (CISC-170) Add integration tests for comply UI #123 (da-ar)
- (CISC-169) Enable deployment of compliance ui stack #122 (da-ar)
- [CISC-164] Auto update scarp from artifactory #121 (maxiegit)
- (bugfix) use OS specific tempdir for scan results #120 (tphoney)
- [CISC-162] move rbac token retrieval to spec helper #118 (maxiegit)
- Fix typo on line 101 #116 (kreeuwijk)
- (CISC-141) Enable SSL verified connections #115 (da-ar)
- Better messaging for extending the vmlife rake task #114 (tphoney)
- (CISC-139)puppet agents do not autostart, caused timing issues #113 (tphoney)
- Use choco's own installer and pin Java to jre8 #112 (kreeuwijk)
- [CISC-140] Add integration tests for scarp integration #111 (maxiegit)
- Don't use content param #110 (kreeuwijk)
- (CISC-124) Simple rake task to extend the life of demo VM's #108 (tphoney)
- whitespace cleanup in the readme #107 (tphoney)
- Readme updates for docker stack #106 (da-ar)
- clarify the docker image vs docker compose instructions #105 (tphoney)
- tweaks to docker initialization #104 (da-ar)
- update to SSL cert generation #103 (da-ar)
- Setup docker on PE for scarp server #102 (tphoney)
- change the dgraph port in docker-compose #101 (tphoney)
- Volumes #100 (da-ar)
- Ignore docker volumes #99 (da-ar)
- latest scarp 0.0.27 #98 (tphoney)
- automate the startup of scarp in docker (#95) #97 (da-ar)
- fix docker readme help #96 (tphoney)
- automate the startup of scarp in docker #95 (da-ar)
- Dgraph setup for the docker-compose stack #94 (tphoney)
- Send scan to scarp container #93 (tphoney)
- Integration test changes #91 (da-ar)
- First attempt at getting scarp in a container #89 (tphoney)
- Adding the latest version of Scarp #88 (tphoney)
- (CISC-111) install comply bash script #87 (Lavinia-Dan)
- Fix to get Lidar demo plan working #86 (HelenCampbell)
- [CISC-128] Remove splunk user guide, add UI Hacking devenv #85 (maxiegit)
- (CISC-129) Update latest docker-compose file #84 (HelenCampbell)
- (CISC-96) Installing scarp by default with comply #83 (HelenCampbell)
- (Docs) splunk and lidar documentation for the demo #82 (tphoney)
- (CISC-92) Module should retrieve CIS scanner from URL #81 (Lavinia-Dan)
- Update the readme for github workflow #80 (tphoney)
- (CISC-91) Make pdk build module ignore demo plans #78 (HelenCampbell)
- Integration tests via GitHub Actions #77 (da-ar)
- (CISC-45) Build the module as part of the demo setup #76 (da-ar)
- readme updates #75 (davidmalloncares)
- (CISC-114) Hardening of tests and documentation addition #73 (HelenCampbell)
- [CISC-117] Fix invalid scanner names defaulting to oscap #72 (maxiegit)
- [CISC-88] add profile parameter #71 (maxiegit)
- (CISC-115) target_roles helper function and initial integration tests #69 (da-ar)
- amend the readme for scan_plan #68 (tphoney)
- [CISC-76] add cross compiled scarp for windows and linux #67 (maxiegit)
- remove a blank line from the readme #66 (tphoney)
- (CISC-69) adding github actions #65 (tphoney)
- (maint) readme updates #64 (da-ar)
- [CISC-104] Additional splunk dashboard updates to automation #63 (HelenCampbell)
- [CISC-108] Scarp install testing and file rename #62 (maxiegit)
- (CISC-78) clean up trusted external facts for comply #60 (tphoney)
- (CISC-107) Apply Lidar config to PE server only #59 (da-ar)
- [CISC-100] add splunk customer setup to readme #58 (maxiegit)
- (CISC-101) initial commit for adding lidar #57 (tphoney)
- [CISC-73]Add PQL querying for target nodes #56 (maxiegit)
- (CISC-85) Ensure the task fails if the scan fails to complete correctly #55 (da-ar)
- (CISC-106) fail hard for oscap scans, for unsupported OSes #54 (tphoney)
- (CISC-105) remove puppet agent -t from compliance_scan and document. #53 (tphoney)
- Clean up tasks for compliance_scan #52 (da-ar)
- [CISS-64] Fix overall compliance chart for new json #51 (maxiegit)
- (CISC-72) Add ability to define scan targets #50 (HelenCampbell)
- [CISC-64] add percentage compliancy to splunk table #49 (maxiegit)
- (CISC-84) Fixing the output to be true json in the scan result file #48 (HelenCampbell)
- (CISC-36) initial attempt at running ciscat workbenches #47 (tphoney)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppet/archive (>= 4.3.0 < 5.0.0)
- puppetlabs/chocolatey (>= 5.0.0 < 6.0.0)
- puppetlabs/inifile (>= 4.1.0 < 5.0.0)
- puppetlabs/java (>= 6.0.1 < 7.0.0)
- puppetlabs/ruby_task_helper (>= 0.4.0 < 1.0.0)
- puppetlabs/stdlib (>= 5.0.0 < 7.0.0)
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 [yyyy] [name of copyright owner] 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.