Version information
Start using this module
Add this module to your Puppetfile:
mod 'geoffwilliams-ssh', '2.0.1'
Learn more about managing modules with a PuppetfileDocumentation
ssh
Table of Contents
- Description
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
Manage SSH with Puppet on AIX, Solaris and RHEL
Usage
See reference and examples
Limitations
- Not supported by Puppet, Inc.
Development
PRs accepted :)
Testing
This module supports testing using PDQTest.
Test can be executed with:
bundle install
make
See .travis.yml
for a working CI example
Reference
Classes
ssh
: Install and manage ssh daemon with Puppet.
Classes
ssh
Package installation is determined automatically on RedHat or you may supply a
valid package name in package_name
. Where additional information is required
for package installation (eg location of package file when using rpm directly)
then this can be passed using manual_package
. This is a requirement for AIX
and Solaris.
This module only rewrites the parts the of the sshd_config
file you tell it to
in order to preserve defaults/fixes from the vendor. Where explicit
configuration is required, it should be passed in the settings
hash.
Augeaus SSH provider is used to perform the re-write of the sshd_config
file
- See also https://forge.puppet.com/herculesteam/augeasproviders_ssh https://forge.puppet.com/herculesteam/augeasproviders_core
Examples
Install SSH server using the defaults
include ssh
Configure SSH server but don't perform any software installation
class { "ssh":
manage_package => false,
}
Install and configure SSH server but don't touch the service
class { "ssh":
manage_service => false,
}
Install and configure SSH server but disable root logins and enable debug logging
class { "ssh":
settings => {
"permit_root_login" => "no",
"log_level" => "DEBUG",
},
}
Install and configure SSH server on AIX
class { "ssh":
manual_package => {
"provider" => "rpm",
"package_name" => "megacorp_ssh",
"source" => "/tmp/megacorp_ssh.rpm"
},
}
Hiera data for some common settings (supported keys are those allowed by ssh itself)
ssh::settings:
Banner: "/etc/issue.net"
Protocol: "2"
MaxAuthTries: "4"
PermitRootLogin: "no"
Ciphers:
- "aes128-ctr"
- "aes192-ctr"
- "aes256-ctr"
ClientAliveInterval: "300"
ClientAliveCountMax: "1"
Parameters
The following parameters are available in the ssh
class.
manage_package
Data type: Boolean
true
to manage package installation otherwise false
Default value: true
manage_service
Data type: Boolean
true
to manage the service otherwise false
Default value: true
service_name
Data type: String
name of the SSH service on this system
service_ensure
Data type: Enum["stopped", "running"]
State to ensure the ssh service to
Default value: "running"
service_enable
Data type: Boolean
true
to enable the service on boot, false
to leave
it alone
Default value: true
manual_package
Data type: Optional[Hash]
Hash of additional properties for the package
resource. Required on AIX and Solaris
Default value: undef
auto_install
Data type: Boolean
true
if we can install automatically without having to
specify package details manually. Normally autodetected
package_name
Data type: String
Name of package to install. On Solaris and AIX, you must ensure the name you supply here matches that described in any package file you try to install in order to avoid idempotency errors when puppet cant detect that the package has already been installed
config_file_name
Data type: String
Full path of SSHD config file to write
Default value: "/etc/ssh/sshd_config"
config_file_group
Data type: String
Group ownership for SSHD config file
config_file_mode
Data type: String
Permissions for SSHD config file
manage_service
True if we should manage the SSHD service with Puppet
Default value: true
service_name
Name of the SSHD service on this system
service_title
Data type: String
Default value: "sshd"
settings
Data type: Hash[String,Variant[String,Array[String]]]
Default value: {}
1.0.0 2018-04-14
Breaking changes for those using ssh::install and ssh::config classes individually:
- These classes were removed
- Module simplified and functionality moved to ssh class
- Hiera keynames changed due to above
Testing:
- Update to latest PDQTest
- Update acceptance tests to check SSH service operational
- Extra test for manual installation (AIX/Solaris)
- Removed and regenerated the rspec tests for simplicity
Documentation:
- ...There is documentation now ;-)
Dependencies
- puppetlabs-stdlib (>= 4.15.0)
- herculesteam-augeasproviders_ssh (2.5.3)
- herculesteam-augeasproviders_core (2.1.4)
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.