autossh
Version information
This version is compatible with:
- ,
Start using this module
Add this module to your Puppetfile:
mod 'gerardcl-autossh', '1.2.5'Learn more about managing modules with a PuppetfileDocumentation
autossh
The autossh module facilitates the automated management of ssh based port forward between nodes. The ssh tunnels are run via the 'autossh' wrapper which starts/monitors and restarts the tunnels if and when they close. This service:
- Installs the required package support.
- Configures the 'autossh' configuration file.
- Creates a system initialization script (init script).
- exports resources to automate the configuration of the 'remote' nodes.
- automatically configures remote nodes to provide a secure tunnel capability.
Original module was initially based on the following module(s) from the puppet forge:
- agronaught/puppet-autossh
However this module has been rewritten to provide:
- Support for multiple tunnels on any given host.
- Support for Hiera integration
- Support for configuration of the 'tunnel endpoint'
- Secure configuration of the tunnel endpoint.
- Customization of the important ssh configurations for the ssh tunnels.
As tested this module can support any number of ssh tunnels on any given host, and automatically synchronizes the tunnel endpoints providing both nodes connect to the same puppetdb.
The 'autossh' service provides a reliability and monitoring capability for the ssh tunnels, this includes monitoring the link via a separate 'monitoring ports' if configured and automatically restarting the ssh session if it fails due to an abnormal termination or error detected on the monitoring port. I'm gradually adding more functionality here to support customization of the ssh parameters to watch this space as the module develops.
Management of the private key is left to you as care needs to be taken to ensure this private key is adequately protected. I've encrypted the private key using eyaml and find this a convenient approach but that does depend on having hiera configured correctly.
Classes
autossh
The 'autossh' class configures the autossh environment, installs the required package support, and configures the global ssh options to be applied to ssh sessions.
This class needs to be run on all nodes using autossh.
Class {'::autossh':
}
user
The linux user account to be used to run the ssh sessions. We recommend using the default, that defaults to autossh user. You can distinguish different tunnels by the tunnel name.
autossh_package
The autossh rpm package name. Default uses already available rpm. Current version is latest stable, version 1.4.
init_template
The template to use for the system init script. Shouldn't need to change this.
enable
Enable/Disable this package and service. This functionality is gradually being added, not overly useful right now.
ssh_reuse_established_connections
Enables ssh connection reuse if an established connection already exists to the target host. This can speed up the time it takes to make the connection, note that this is only supported on 'openssh' > 5.5
ssh_enable_compression
Enables/Disables ssh compression in the tunnel. Connections over slow links may benefit from compression, local lan connections are probably better off without it.
ssh_ciphers
Sets the cipher ordering for the ssh sessions. The default is from 'fastest' to 'slowest'.
ssh_stricthostkeychecking
By default host key checking is disabled to enable connections to proceed without error. Without this setting an admin would need to ensure the target server was in the known hosts file.
ssh_tcpkeepalives
Enable/Disable TCP Keepalives to prevent firewalls from closing the tunnel.
server_alive_interval
Autossh server alive interval. Defaults to 30 seconds.
server_alive_count_max
Autossh server alive per interval counter. Defaults to 3.
autossh::tunnel
Create a tunnel on the host including the necessary init scripts to start and stop the service. Optionally ssh parameters can be customised on a per host basis.
autossh::tunnel { 'port_25_tunnel_to_server1':
port => '25',
hostport => '25',
remote_ssh_host => 'server1',
pubkey => 'ssh-dss <OMITTED>'
}
user
The linux user account to be used to run the ssh sessions. We recommend using the default, that defaults to autossh user. You can distinguish different tunnels by the tunnel name. Must be the same as the one used by autossh class.
tunnel_type
The direction of the ssh tunnel. 'forward' for 'host --> target' and 'reverse' for 'target' --> 'host'
port
The local port to be used for the ssh tunnel
hostport
The remote port to be used for the ssh tunnel
remote_ssh_host
The remote host/ip to connect to for the tunnel.
remote_ssh_port
The remote port to connect to for the tunnel.
monitor_port
The port(s) to use for the autossh monitoring functionality. 2 ports are actually used, the base port and the base port + 1 (.i.e. 20000 and 20001).
pubkey
The public key to use for the authentication of this connection.
enable
Enable/Disable this package and service. This functionality is gradually being added, not overly useful right now.
enable_host_ssh_config
Enable host specific ssh configurations. This will override the global settings created in the autossh class.
ssh_reuse_established_connections
Enables ssh connection reuse if an established connection already exists to the target host. This can speed up the time it takes to make the connection, note that this is only supported on 'openssh' > 5.5
ssh_enable_compression
Enables/Disables ssh compression in the tunnel. Connections over slow links may benefit from compression, local lan connections are probably better off without it.
ssh_ciphers
Sets the cipher ordering for the ssh sessions. The default is from 'fastest' to 'slowest'.
ssh_stricthostkeychecking
By default host key checking is disabled to enable connections to proceed without error. Without this setting an admin would need to ensure the target server was in the known hosts file.
ssh_tcpkeepalives
Enable/Disable TCP Keepalives to prevent firewalls from closing the tunnel.
server_alive_interval
Autossh server alive interval. Defaults to 30 seconds.
server_alive_count_max
Autossh server alive per interval counter. Defaults to 3.
autossh::endpoint
Configure the endpoint (target) for an ssh connection. This class is run on the destination nodes for any ssh tunnels.
autossh::endpoint { 'createtunnels':
user => 'autossh',
host => 'server1.foo.bar',
}
user
The linux user account to be used to run the ssh sessions. We recommend using the default, that defaults to autossh user. You can distinguish different tunnels by the tunnel name. Must be the same as the one used by autossh class.
host
The hostname/ip address specified in the 'authssh::tunnel', this is used to filter the tunnel::endpoint exported resources.
Examples
Simple Example
The simple example creates a single ssh tunnel between two nodes, starting at the origin and terminating at the 'destination' using DSL only:
Prepare Private/Public Keys
Generate the necessary private and public keys for the ssh sessions. The private key will need to be placed in the '.ssh' folder for the run user (default: /home/autossh/.ssh/) and the public key used when configuring the service.
Origin Node
class { '::autossh':
}
autossh::tunnel { 'port_25_tunnel_to_server1':
port => '25',
hostport => '25',
remote_ssh_host => 'server1',
pubkey => 'ssh-dss <OMITTED>'
}
Destination Node
class { '::autossh':
}
autossh::endpoint { 'load ssh endpoints':
host => 'server1',
}
Complex Example
The following example creates multiple ssh port forwards between two nodes, the Origin and Destination using DSL and Hiera. This example also includes the installation of the private key which is stored using hiera-eyaml and default values to reduce the specific instance configuration.
Role - Origin Node
$autossh_user = hiera('autossh::user')
class { '::autossh':
user => $autossh_user
}
$autossh_key = hiera('autossh::privkey')
file { "/home/${autossh_user}/.ssh/id_dsa":
ensure => file,
owner => $autossh_user,
group => $autossh_user,
mode => "0400",
content => $autossh_key,
replace => no,
}
$tunnels = hiera_hash('autossh::tunnels')
$defaults = hiera_hash('autossh::defaults')
create_resources('autossh::tunnel',$tunnels,$defaults)
}
Profile - Origin Node
autossh::tunnels:
tunnel_pmaster:
port: 8140
hostport: 8140
remote_ssh_host: 172.16.255.2
tunnel_smtp:
port: 25
hostport: 1125
remote_ssh_host: 172.16.255.2
autossh::user: 'autossh'
autossh::privkey: ENC[PKCS7, OMITTED]
autossh::defaults:
pubkey: ssh-dss OMITTED
tunnel_type: reverse
user: autossh
remote_ssh_port: 22
monitor_port: 0
enable: true
Role - Destination Node
class capability::autosshtarget {
$autossh_user = hiera('autossh::user')
class { '::autossh':
user => $autossh_user
}
$autossh_hostip = hiera('autossh::hostip')
autossh::endpoint{'load autossh enpoint details':
user => $autossh_user,
host => $autossh_hostip,
}
Profile - Destination Node
autossh::hostip: 172.16.255.2
autossh::user: 'autossh'
autossh::pubkey: 'ssh-dss OMITTED'
Dependencies
- puppetlabs-stdlib (>= 4.3.0)
- puppetlabs-concat (>= 1.1.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.