Manage ssh client and server.
This module is based on the OpenSSH v7.0 implementation. All parameters that are described in the
man pages are available to this module with the exception of the Match parameter. Some SSH
implementations do provide extra features and use additional parameters. These deviations can
still be managed with the help of the $custom
parameter. This freetext parameter allows you to add
any lines to ssh_config and sshd_config that you wish to.
This module may be used with a simple include ::ssh
The ssh::config_entry
defined type may be used directly and is used to manage
Host entries in a personal ~/.ssh/config
file.
This module officially supports the platforms listed in the
metadata.json
. It does not fail on unsupported platforms and has been
known to work on many, many platforms since its creation in 2010.
- Archlinux
- Debian 10
- Debian 11
- EL 7
- EL 8
- EL 9
- Ubuntu 18.04 LTS
- Ubuntu 20.04 LTS
- Ubuntu 22.04 LTS
- Solaris 10
- Solaris 11
If you use the Sun Solaris SSH, please keep in mind that not all parameters can be used.
Unsupported parameters for ssh_config: AddressFamily, Tunnel, TunnelDevice, PermitLocalCommand, HashKnownHosts
Unsupported parameters for sshd_config: KerberosOrLocalPasswd, KerberosTicketCleanup, KerberosGetAFSToken, TCPKeepAlive, ShowPatchLevel, MaxSessions, PermitTunnel
A value of undef
will use the defaults specified by the module. See data/os/
for the actual
default settings for supported operating systems.
Please keep in mind that this module does not include any sanity checks. Depending on the set parameters or values and the running version of SSH the resulting configuration could stop SSH from working.
See REFERENCE.md for a list of all parameters.
The hash ssh::keys is passed to ssh_authorized_key type. Because of this, you may specify any valid parameter for ssh_authorized_key. See the Type Reference for a complete list.
Push authorized key "root_for_userX" and remove key "root_for_userY" through Hiera.
ssh::keys:
root_for_userX:
ensure: present
user: root
type: dsa
key: AAAA...==
apachehup:
ensure: present
user: apachehup
type: rsa
key: 'AAAA...=='
options: 'command="/sbin/service httpd restart"'
root_for_userY:
ensure: absent
user: root
Manage config entries in a personal ssh/config file.
Ssh::Config_entry {
ensure => present,
path => '/home/jenkins/.ssh/config',
owner => 'jenkins',
group => 'jenkins',
}
ssh::config_entry { 'jenkins *':
host => '*',
lines => [
' ForwardX11 no',
' StrictHostKeyChecking no',
],
order => '10',
}
ssh::config_entry { 'jenkins github.com':
host => 'github.com',
lines => [" IdentityFile /home/jenkins/.ssh/jenkins-gihub.key"],
order => '20',
}
SSH supports configuration files in .d directories via the include
directive. This module enables you to also manage these files. You need to set directives for the server (eg: /etc/ssh/sshd_config.d) and client (eg: /etc/ssh/ssh_config.d) part seperatly as they support different directives.
You can activate the management by ensuring $include
is defined and pass a hash with the needed SSH directives and their values.
Directives can be passed as hash via the $ssh::config_files
and $ssh::server::config_files
parameters. Directives passed as hash via lines
will be checked for correct names and values. Directives passed as array via custom
will not be checked and will be added to the configuration file. Similar to the main configuration files.
Different file permissions can be specified via owner
, group
, or mode
.
You can remove a file by setting ensure
to absent
.
Manage the client configuration file /etc/ssh/ssh_config.d/50-redhat.conf with some directives and default file permissions (0644 root:root).
ssh::include: /etc/ssh/ssh_config.d/*.conf
ssh::config_files:
'50-redhat':
lines:
Match: 'final all'
Include: '/etc/crypto-policies/back-ends/openssh.config'
GSSAPIAuthentication: 'yes'
ForwardX11Trusted: 'yes'
Manage the server configuration file /etc/ssh/sshd_config.d/50-redhat.conf with some directives and default file permissions (0600 root:root).
ssh::server::include: /etc/ssh/sshd_config.d/*.conf
ssh::server::config_files:
'50-redhat':
lines:
Include: '/etc/crypto-policies/back-ends/opensshserver.config'
SyslogFacility: 'AUTHPRIV'
ChallengeResponseAuthentication: 'no'
GSSAPIAuthentication: 'yes'
GSSAPICleanupCredentials: 'no'
UsePAM: 'yes'
X11Forwarding: 'yes'
PrintMotd: 'no'
You can also specify different file permissions by setting $owner, $group, or $mode accordingly:
ssh::include: /etc/ssh/ssh_config.d/*.conf
ssh::config_files:
'50-redhat':
owner: 'name'
group: 'group'
mode: '0664'
lines:
Match: 'final all'
GSSAPIAuthentication: 'yes'
Using directives that are not supported by this module:
ssh::include: /etc/ssh/ssh_config.d/*.conf
ssh::config_files:
'50-redhat':
custom:
- 'Directive1 Value1'
- 'Directive2 Value2'
Remove the file /etc/ssh/ssh_config.d/50-redhat.conf:
ssh::include: /etc/ssh/ssh_config.d/*.conf
ssh::config_files:
'50-redhat':
ensure: 'absent'
The SSH module v4 was completely rewritten. In this process all parameters for the SSH configuration files have been renamed. Users that want to upgrade need to change their running configuration. To make your upgrade easier there is a list of old and new parameter names. Consult UPGRADING.md
Please check CONTRIBUTING.md