Defined Type: ssh::server

Defined in:
manifests/server.pp

Overview

Define: ssh::server

Define to create or remove a ssh daemon.  This differes from previous
methods of managing the ssh daemon in that it facilitates daemons that
run on alternate ports as well as the default daemon.

Parameters

The following parameters are recognized by ssh::server

acceptenv

Specifies what environment variables sent by the client will be copied into the session’s environ(7). See SendEnv in ssh_config(5) for how to configure the client. Note that environment passing is only supported for protocol 2. Variables are specified by name, which may contain the wildcard characters * and ? Multiple environment variables may be separated by whitespace or spread across multiple AcceptEnv directives. Be warned that some environment variables could be used to bypass restricted user environments. For this reason, care should be taken in the use of this directive. The default is not to accept any environment variables.

addressfamily

Specifies which address family should be used by sshd(8). Valid arguments are “any”, “inet” (use IPv4 only), or “inet6” (use IPv6 only). The default is “any”

allowagentforwarding

Specifies whether ssh-agent(1) forwarding is permitted. The default is ‘yes’. Note that disabling agent forwarding does not improve security unless users are also denied shell access, as they can always install their own forwarders.

allowgroups

This keyword can be followed by an array of group name patterns If specified, login is allowed only for users whose primary group or supplementary group list matches one of the patterns. ‘*’ and ‘?’ can be used as wildcards in the patterns. Only group names are valid; a numerical group ID is not recognized. By default, login is allowed for all groups.

allowtcpforwarding

Specifies whether TCP forwarding is permitted. Note that disabling TCP forwarding does not improve security unless users are also denied shell access, as they can always install their own forwarders. The default is not to permit TCP forwarding.

allowhosts

This keyword can be followed by an array of host and/or network patterns. If specified, iptables rules are created to restrict access to be only from the defined sources. Note: the iptables class must be defined before this will be enforced.

allowusers

This keyword can be followed by an array of user name patterns. If specified, login is allowed only for user names that match one of the patterns. Only user names are valid; a numerical user ID is not recognized. By default, login is allowed for all users. If the pattern takes the form USER@HOST then USER and HOST are separately checked, restricting logins to particular users from particular hosts. The allow/deny directives are processed in the following order: DenyUsers, AllowUsers, DenyGroups, and finally AllowGroups.

authorizedkeysfile

Specifies the file that contains the public keys that can be used for user authentication. The format is described in the AUTHORIZED_KEYS FILE FORMAT section of sshd(8). AuthorizedKeysFile may contain tokens of the form %T which are substituted during connection setup. The following tokens are defined: %% is replaced by a literal ‘%’, %h is replaced by the home directory of the user being authenticated, and %u is replaced by the username of that user. After expansion, AuthorizedKeysFile is taken to be an absolute path or one relative to the user’s home directory. Multiple files may be listed, separated by whitespace. The default will resolve to ‘.ssh/authorized_keys .ssh/authorized_keys2’.

banner

The contents of the specified file are sent to the remote user before authentication is allowed. If the argument is ‘none’ then no banner is displayed. This option is only available for protocol version 2. By default, no banner is displayed. The default is to use /etc/issue.

challengeresponseauthentication

Specifies whether challenge response authentication is allowed. All authentication styles from login.conf(5) are supported. The default is “true”.

chrootdirectory

Specifies the pathname of a directory to chroot(2) to after authentication. All components of the pathname must be root- owned directories that are not writable by any other user or group. After the chroot, sshd(8) changes the working directory to the user’s home directory.

The pathname may contain the following tokens that are expanded at runtime once the connecting user has been authenticated: %% is replaced by a literal ‘%’, %h is replaced by the home directory of the user being authenticated, and %u is replaced by the username of that user.

The ChrootDirectory must contain the necessary files and directories to support the user’s session. For an interactive session this requires at least a shell, typically sh(1), and basic /dev nodes such as null(4), zero(4), stdin(4), stdout(4), stderr(4), arandom(4) and tty(4) devices. For file transfer sessions using ‘sftp’, no additional configuration of the environment is necessary if the in-process sftp server is used, though sessions which use logging do require /dev/log inside the chroot directory (see sftp-server(8) for details).

The default is not to chroot(2).

ciphers

Specifies the ciphers allowed for protocol version 2. Multiple ciphers must be comma-separated. The supported ciphers are ‘3des-cbc’, ‘aes128-cbc’, ‘aes192-cbc’, ‘aes256-cbc’, ‘aes128-ctr’, ‘aes192-ctr’, ‘aes256-ctr’, ‘arcfour128’, ‘arcfour256’, ‘arcfour’, ‘blowfish-cbc’, and ‘cast128-cbc’.

The default is: ‘aes256-ctr’, ‘aes192-ctr’, ‘aes128-ctr’

clientalivecountmax

Sets the number of client alive messages (see below) which may be sent without sshd(8) receiving any messages back from the client. If this threshold is reached while client alive messages are being sent, sshd will disconnect the client, terminating the session. It is important to note that the use of client alive messages is very different from TCPKeepAlive (below). The client alive messages are sent through the encrypted channel and therefore will not be spoofable. The TCP keepalive option enabled by TCPKeepAlive is spoofable. The client alive mechanism is valuable when the client or server depend on knowing when a connection has become inactive.

The default value is 0. If ClientAliveInterval (see below) is set to 15, and ClientAliveCountMax is left at the default, unresponsive SSH clients will be disconnected after approximately 45 seconds. This option applies to protocol version 2 only.

clientaliveinterval

Sets a timeout interval in seconds after which if no data has been received from the client, sshd(8) will send a message through the encrypted channel to request a response from the client. The default is 0, indicating that these messages will not be sent to the client. This option applies to protocol version 2 only. The default is 300.

compression

Specifies whether compression is allowed, or delayed until the user has authenticated successfully. The argument must be ‘yes’, ‘delayed’, or ‘no’. The default is ‘delayed’.

debianbanner

Specifies whether the distribution-specified extra version suffix is included during initial protocol handshake. The default is ‘yes’.

denygroups

This keyword can be followed by an array of group name patterns. Login is disallowed for users whose primary group or supplementary group list matches one of the patterns. ‘*’ and ‘?’ can be used as wildcards in the patterns. Only group names are valid; a numerical group ID is not recognized. By default, login is allowed for all groups.

denyusers

This keyword can be followed by a list of user name patterns, Login is disallowed for user names that match one of the patterns. ‘*’ and ‘?’ can be used as wildcards in the patterns. Only user names are valid; a numerical user ID is not recognized. By default, login is allowed for all users. If the pattern takes the form USER@HOST then USER and HOST are separately checked, restricting logins to particular users from particular hosts. Specifying a command of “internal-sftp” will force the use of an in-process sftp server that requires no support files when used with ChrootDirectory.

Default: ‘adm’, ‘admin’, ‘administrator’, ‘Administrator’,

'anonymous', 'apache',      'at',            'avahi',
'backup',    'beagleindex', 'bin',           'cvs',
'daemon',    'demo',        'dnsmasq',       'fax',
'fetchmail', 'files',       'ftp',           'ftpuser',
'games',     'gdm',         'git-daemon',    'gnats',
'guest',     'haldaemon',   'icecream',      'info',
'irc',       'libuuid',     'list',          'lp',
'mail',      'man',         'messagebus',    'mysql',
'nagios',    'news',        'nobody',        'ntp',
'oprofile',  'oracle',      'polkituser',    'postfix',
'postgres',  'proxy',       'pulse',         'puppet',
'sshd',      'support',     'suse-ncc',      'sync',
'sys',       'test',        'testuser',      'user',
'uucp',      'uuidd',       'webmaster',     'www',
'www-data',  'wwwrun'
dsakey

Specifies a file containing the private host DSA key used by SSH. Note that sshd(8) will refuse to use a file if it is group/world- accessible. Default: /etc/ssh/ssh_host_dsa_key

ensure

Specifies whether to enable or disable the ssh daemon. The possible values are ‘present’ and ‘absent’. If the value is ‘absent’ all related files for the instance are removed. The default is ‘present’

forcecommand

Forces the execution of the command specified by ForceCommand, ignoring any command supplied by the client and ~/.ssh/rc if present. The command is invoked by using the user’s login shell with the -c option. This applies to shell, command, or subsystem execution. It is most useful inside a Match block. The command originally supplied by the client is available in the SSH_ORIGINAL_COMMAND environment variable. Specifying a command of ‘internal-sftp’ will force the use of an in-process sftp server that requires no support files when used with ChrootDirectory.

gatewayports

Specifies whether remote hosts are allowed to connect to ports forwarded for the client. By default, sshd(8) binds remote port forwardings to the loopback address. This prevents other remote hosts from connecting to forwarded ports. GatewayPorts can be used to specify that sshd should allow remote port forwardings to bind to non-loopback addresses, thus allowing other hosts to connect. The argument may be ‘false’ to force remote port forwardings to be available to the local host only, ‘true’ to force remote port forwardings to bind to the wildcard address, or ‘clientspecified’ to allow the client to select the address to which the forwarding is bound. The default is ‘false’.

gssapiauthentication

Specifies whether user authentication based on GSSAPI is allowed. The default is ‘no’. Note that this option applies to protocol version 2 only.

gssapikeyexchange

Specifies whether key exchange based on GSSAPI is allowed. GSSAPI key exchange doesn’t rely on ssh keys to verify host identity. The default is ‘no’. Note that this option applies to protocol version 2 only.

gssapicleanupcredentials

Specifies whether to automatically destroy the user’s credentials cache on logout. The default is ‘yes’. Note that this option applies to protocol version 2 only.

gssapistrictacceptorcheck

Determines whether to be strict about the identity of the GSSAPI acceptor a client authenticates against. If ‘yes’ then the client must authenticate against the host service on the current hostname. If ‘no’ then the client may authenticate against any service key stored in the machine’s default store. This facility is provided to assist with operation on multi homed machines. The default is ‘yes’. Note that this option applies only to protocol version 2 GSSAPI connections, and setting it to ‘no’ may only work with recent Kerberos GSSAPI libraries.

gssapistorecredentialsonrekey

Controls whether the user’s GSSAPI credentials should be updated following a successful connection rekeying. This option can be used to accepted renewed or updated credentials from a compatible client. The default is ‘no’.

hostbasedauthentication

Specifies whether rhosts or /etc/hosts.equiv authentication together with successful public key client host authentication is allowed (host-based authentication). This option is similar to RhostsRSAAuthentication and applies to protocol version 2 only. The default is ‘no’.

hostbasedusesnamefrompacketonly

Specifies whether or not the server will attempt to perform a reverse name lookup when matching the name in the ~/.shosts, ~/.rhosts, and /etc/hosts.equiv files during HostbasedAuthentication. A setting of ‘yes’ means that sshd(8) uses the name supplied by the client rather than attempting to resolve the name from the TCP connection itself. The default is ‘no’.

hostcertificate

Specifies a file containing a public host certificate. The certificate’s public key must match a private host key already specified by HostKey. The default behaviour of sshd(8) is not to load any certificates.

ignorerhosts

Specifies that .rhosts and .shosts files will not be used in RhostsRSAAuthentication or HostbasedAuthentication.

/etc/hosts.equiv and /etc/ssh/shosts.equiv are still used. The default is ‘yes’.

ignoreuserknownhosts

Specifies whether sshd(8) should ignore the user’s ~/.ssh/known_hosts during RhostsRSAAuthentication or HostbasedAuthentication. The default is ‘no’.

kerberosauthentication

Specifies whether the password provided by the user for PasswordAuthentication will be validated through the Kerberos KDC. To use this option, the server needs a Kerberos servtab which allows the verification of the KDC’s identity. The default is ‘no’.

kerberosgetafstoken

If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire an AFS token before accessing the user’s home directory. The default is ‘no’.

kerberosorlocalpasswd

If password authentication through Kerberos fails then the password will be validated via any additional local mechanism such as /etc/passwd. The default is ‘yes’.

kerberosticketcleanup

Specifies whether to automatically destroy the user’s ticket cache file on logout. The default is ‘yes’.

keyregenerationinterval

In protocol version 1, the ephemeral server key is automatically regenerated after this many seconds (if it has been used). The purpose of regeneration is to prevent decrypting captured sessions by later breaking into the machine and stealing the keys. The key is never stored anywhere. If the value is 0, the key is never regenerated. The default is 3600 (seconds).

listenaddress

Specifies the local addresses sshd(8) should listen on. The following forms may be used:

listenaddress => host|IPv4_addr|IPv6_addr listenaddress => host|IPv4_addr:port listenaddress => [host|IPv6_addr]:port

If port is not specified, sshd will listen on the address and all prior Port options specified. The default is to listen on all local addresses. Multiple ListenAddress options are permitted. Additionally, any Port options must precede this option for non- port qualified addresses.

logingracetime

The server disconnects after this time if the user has not successfully logged in. If the value is 0, there is no time limit. The default is 120 seconds.

log_level

Gives the verbosity level that is used when logging messages from sshd(8). The possible values are: QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. The default is VERBOSE. DEBUG and DEBUG1 are equivalent. DEBUG2 and DEBUG3 each specify higher levels of debugging output. Logging with a DEBUG level violates the privacy of users and is not recommended.

macs

Specifies the available MAC (message authentication code) algorithms. The MAC algorithm is used in protocol version 2 for data integrity protection. Multiple algorithms must be comma-separated. The default is:

hmac-md5,hmac-sha1,umac-64@openssh.com,
hmac-ripemd160,hmac-sha1-96,hmac-md5-96
match_address

Default: empty

match_groups

Default: empty

match_hosts

Default: empty

match_users

Default: empty

maxauthtries

Specifies the maximum number of authentication attempts permitted per connection. Once the number of failures reaches half this value, additional failures are logged. The default is 6.

maxsessions

Specifies the maximum number of open sessions permitted per network connection. The default is 1.

maxstartups

Specifies the maximum number of concurrent unauthenticated connections to the SSH daemon. Additional connections will be dropped until authentication succeeds or the LoginGraceTime expires for a connection. The default is 10:30:100.

Alternatively, random early drop can be enabled by specifying the three colon separated values ‘start:rate:full’ (e.g. “10:30:60”). sshd(8) will refuse connection attempts with a probability of ‘rate/100’ (30%) if there are currently ‘start’ (10) unauthenticated connections. The probability increases linearly and all connection attempts are refused if the number of unauthenticated connections reaches ‘full’ (60).

pamradiusauth

Specifies whether RADIUS authentication is to be included in the PAM authentication file. The default is ‘false’.

passwordauthentication

Specifies whether password authentication is allowed. The default is ‘true’.

permitblacklistedkeys

Specifies whether sshd(8) should allow keys recorded in its blacklist of known-compromised keys (see ssh-vulnkey(1)). If ‘yes’, then attempts to authenticate with compromised keys will be logged but accepted. If ‘no’, then attempts to authenticate with compromised keys will be rejected. The default is ‘no’.

permitemptypasswords

When password authentication is allowed, it specifies whether the server allows login to accounts with empty password strings. The default is ‘no’.

permitopen

Specifies the destinations to which TCP port forwarding is permitted. The forwarding specification must be one of the following forms:

permitopen => [ host:port ]
permitopen => [ IPv4_addr:port ]
permitopen => [ [IPv6_addr]:port ]

Multiple forwards may be specified by separating them with whitespace. An argument of ‘any’ can be used to remove all restrictions and permit any forwarding requests. An argument of ‘none’ can be used to prohibit all forwarding requests. By default all port forwarding requests are permitted.

permitrootlogin

Specifies whether root can log in using ssh(1). The argument Specifies whether root can log in using ssh(1). The argument must be ‘yes’, ‘without-password’, ‘forced-commands-only’, or ‘no’. The default is ‘yes’.

If this option is set to ‘without-password’, password authentication is disabled for root. If this option is set to ‘forced-commands-only’, root login with public key authentication will be allowed, but only if the command option has been specified (which may be useful for taking remote backups even if root login is normally not allowed). All other authentication methods are disabled for root.

If this option is set to ‘no’, root is not allowed to log in.

permittunnel

Specifies whether tun(4) device forwarding is allowed. The argument must be ‘yes’, ‘point-to-point’ (layer 3), ‘ethernet’ (layer 2), or ‘no’. Specifying ‘yes’ permits both ‘point-to-point’ and ‘ethernet’. The default is ‘no’.

permituserenvironment

Specifies whether ~/.ssh/environment and environment= options in ~/.ssh/authorized_keys are processed by sshd(8). The default is ‘no’. Enabling environment processing may enable users to bypass access restrictions in some configurations using mechanisms such as LD_PRELOAD.

port

Specifies the port number that sshd(8) listens on. The default is 22. Multiple options of this type are permitted. See also listenaddress..

printlastlog

Specifies whether sshd should print the date and time of the last user login when a user logs in interactively. The default is “true”.

printmotd

Specifies whether sshd should print /etc/motd when a user logs in interactively. (On some systems it is also printed by the shell, /etc/profile, or equivalent.) The default is “true”.

protocol

Specifies the protocol versions sshd supports. The possible val- ues are “1” and “2”. Multiple versions must be comma-separated. The default is “2”. Note that the order of the protocol list does not indicate preference, because the client selects among multiple protocol versions offered by the server. Specifying “2,1” is identical to “1,2”.

pubkeyauthentication

Specifies whether public key authentication is allowed. The default is ‘false’. Note that this option applies to protocol version 2 only.

revokedkeys

Specifies a list of revoked public keys. Keys listed in this file will be refused for public key authentication. Note that if this file is not readable, then public key authentication will be refused for all users.

rhostsrsaauthentication

Specifies whether rhosts or /etc/hosts.equiv authentication together with successful RSA host authentication is allowed. The default is ‘no’. This option applies to protocol version 1 only.

rsaauthentication

Specifies whether pure RSA authentication is allowed. The default is ‘yes’. This option applies to protocol version 1 only.

rsakey

Specifies a file containing the private host RSA key used by SSH. NOTE: This parameter has been temporarily disabled Default: /etc/ssh/ssh_host_rsa_key

serverkeybits

Defines the number of bits in the ephemeral protocol version 1 server key. The minimum value is 512, and the default is 1024.

strictmodes

Specifies whether sshd(8) should check file modes and ownership of the user’s files and home directory before accepting login. This is normally desirable because novices sometimes accidentally leave their directory or files world-writable. The default is ‘yes’.

Note that this does not apply to ChrootDirectory, whose permissions and ownership are checked unconditionally.

subsystem

Configures an external subsystem (e.g. file transfer daemon). Arguments should be a subsystem name and a command (with optional arguments) to execute upon subsystem request.

The command sftp-server(8) implements the ‘sftp’ file transfer subsystem.

Alternately the name ‘internal-sftp’ implements an in-process ‘sftp’ server. This may simplify configurations using ChrootDirectory to force a different filesystem root on clients.

By default no subsystems are defined. Note that this option applies to protocol version 2 only.

syslogfacility

Gives the facility code that is used when logging messages from sshd(8). The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. The default is AUTH.

tcpkeepalive

Specifies whether the system should send TCP keepalive messages to the other side. If they are sent, death of the connection or crash of one of the machines will be properly noticed. However, this means that connections will die if the route is down tem- porarily, and some people find it annoying. On the other hand, if TCP keepalives are not sent, sessions may hang indefinitely on the server, leaving “ghost” users and consuming server resources.

The default is “true” (to send TCP keepalive messages), and the server will notice if the network goes down or the client host crashes. This avoids infinitely hanging sessions.

To disable TCP keepalive messages, the value should be set to “false”.

titlesuffix

Specifies whether the title should be used as the suffix. If set to ‘true’ the title will be used otherwise the port number will be used. The default is ‘false’.

trustedusercakeys

Specifies a file containing public keys of certificate authorities that are trusted to sign user certificates for authentication. Keys are listed one per line; empty lines and comments starting with # are allowed. If a certificate is presented for authentication and has its signing CA key listed in this file, then it may be used for authentication for any user listed in the certificate’s principals list. Note that certificates that lack a list of principals will not be permitted for authentication using TrustedUserCAKeys. For more details on certificates, see the CERTIFICATES section in ssh-keygen(1).

usedns

Specifies whether sshd(8) should look up the remote host name and check that the resolved host name for the remote IP address maps back to the very same IP address. The default is ‘yes’.

uselogin

Specifies whether login(1) is used for interactive login sessions. The default is ‘no’. Note that login(1) is never used for remote command execution. Note also, that if this is enabled, X11Forwarding will be disabled because login(1) does not know how to handle xauth(1) cookies. If UsePrivilegeSeparation is specified, it will be disabled after authentication.

usepam

Enables the Pluggable Authentication Module interface. If set to ‘true’ this will enable PAM authentication using ChallengeResponseAuthentication and PasswordAuthentication in addition to PAM account and session module processing for all authentication types. The default is ‘true’.

useprivilegeseparation

Specifies whether sshd(8) separates privileges by creating an unprivileged child process to deal with incoming network traffic. After successful authentication, another process will be created that has the privilege of the authenticated user. The goal of privilege separation is to prevent privilege escalation by containing any corruption within the unprivileged processes. The default is ‘yes’.

x11displayoffset

Specifies the first display number available for sshd(8)‘s X11 forwarding. This prevents sshd from interfering with real X11 servers. The default is 10.

x11forwarding

Specifies whether X11 forwarding is permitted. The argument must be ‘true’ or ‘false’. The default is ‘false’.

x11uselocalhost

Specifies whether sshd(8) should bind the X11 forwarding server to the loopback address or to the wildcard address. By default, sshd binds the forwarding server to the loopback address and sets the hostname part of the DISPLAY environment variable to ‘localhost’. This prevents remote hosts from connecting to the proxy display. However, some older X11 clients may not function with this configuration. X11UseLocalhost may be set to ‘no’ to specify that the forwarding server should be bound to the wildcard address. The argument must be ‘yes’ or ‘no’. The default is ‘yes’.

xauthlocation

Specifies the full pathname of the xauth(1) program. The default is /usr/bin/xauth.

Variables

deny_users
os

Lowercase operating system name used to ensure that referenced filenames which are OS specific remain constant even if Puppet and Facter change case over time.

sftp_server

Full path to the sftp-server binary

ssh_add_runlevel_cmd

Command to add the daemon to the appropriate runlevels

sshd_binary

Full path to the sshd binary

sshd_config

Full path to the sshd_config file

ssh_default

Full path to the options file

ssh_del_runlevel_cmd

Command to remove the daemon from all runlevels

sshd_name

Name of the sshd_binary without the path

sshd_pam

Full path to the pam.d file

sshd_privdir
sshd_rcfile

Full path to the rc file for running the daemon at boot

sshd_service

Name of the sshd service

ssh_hasrestart

Whethere or not the service honors the restart argument

ssh_init

Full path to the init.d file

ssh_norun

Full path to the file which indicates that the daemon should not be started.

ssh_start

Command to be used to start the service

ssh_status

Command to be used to check the status of the service

ssh_stop

Command to be used to stop the service

Examples

node myhost {
    # default ssh running on port 22
    ssh::server { 'ssh.": }

    # Remove the daemon running on port 222
    ssh::server { 'defunct':
        ensure => 'absent',
        port   => 222,
    }

    # ssh daemon running on port 2222
    ssh::server { 'internal': port => 2222 }

    # ssh daemon running on port 22223 which also
    # permits root to log in.
    ssh::server { 'special':
        port            => 22223,
        permitrootlogin => true,
    }

    # ssh daemon running on port 1234 which uses
    # the Match directive.
    ssh::server { 'chroot':
        port      => 1234,
        matchuser => {
            'user1' => {
                'ChrootDirectory' => '/home/chroot/user1'
            },
            'user2' => {
                'ChrootDirectory'    => '/home/chroot/user2',
                'AllowTCPForwarding' => 'yes'
            },
        }
    }
}

Supported Operating Systems

Primary development is done on Debian and then validated
against other operating systems.  The current list of
supported operating systems is:

* Centos
* Debian
* Fedora
* FreeBSD
* OpenSUSE
* OpenBSD
* RedHat
* SLES
* Ubuntu

Diagnostics

*non-fatal errors*

An error message will be displayed in red when the operating system is not known to ssh::server.

*fatal errors*

ssh::server will issue a fatal error when one of the parameters contains invalid value.

Alternate ports

Daemons listening on alternate ports are suffixed with either the port
number or the title for clarity.  Set titlesuffix => true if you want
to use the dameon's title rather than the port number.

example:
    # port suffix
    /etc/ssh/sshd_config_2222
    /usr/sbin/sshd_2222
    /etc/init.d/ssh_2222

    # title suffix
    /etc/ssh/sshd_config_special
    /usr/sbin/sshd_special
    /etc/init.d/ssh_special

SSH Host Keys

ssh::server handles the server host keys in the following fashion:

    * generate RSA and DSA keys if they don't exist
    * copy RSA and DSA keys from the client 'private' area if they exist
    * ensure permission and ownership of RSA and DSA keys

All instances of sshd will use the same set of host keys.  You will need
to specify the host key parameters (rsakey and dsakey) If you want to use
a different set of keys for a daemon listening on an alternate port.

SELinux

ssh::server will ensure that the listening ports are added to the selinux
policy.  This is accomplished by using the semanage(8) command which MUST
be installed on the system.  If semanage(8) is not installed ssh::server
will not attempt to add the port and incomming connections will fail.

Authors

Bennett Samowich <bennett@foolean.org>
Copyright (c) 2013 Foolean.org

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.

Parameters:

  • ensure (Any) (defaults to: 'present')
  • acceptenv (Any) (defaults to: [ 'LANG', 'LC_*' ])
  • addressfamily (Any) (defaults to: 'any')
  • allowagentforwarding (Any) (defaults to: true)
  • allowgroups (Any) (defaults to: false)
  • allowhosts (Any) (defaults to: false)
  • allowtcpforwarding (Any) (defaults to: false)
  • allowusers (Any) (defaults to: false)
  • authorizedkeysfile (Any) (defaults to: '%h/.ssh/authorized_keys')
  • banner (Any) (defaults to: '/etc/issue.net')
  • challengresponseauthentication (Any) (defaults to: false)
  • chrootdirectory (Any) (defaults to: false)
  • ciphers (Any) (defaults to: [ 'aes256-ctr', 'aes192-ctr', 'aes128-ctr' ])
  • clientalivecountmax (Any) (defaults to: '0')
  • clientaliveinterval (Any) (defaults to: '300')
  • compression (Any) (defaults to: 'delayed')
  • debianbanner (Any) (defaults to: true)
  • debug (Any) (defaults to: false)
  • denygroups (Any) (defaults to: false)
  • denyusers (Any) (defaults to: [ 'adm', 'admin', 'administrator', 'Administrator', 'anonymous', 'apache', 'at', 'avahi', 'backup', 'beagleindex', 'bin', 'cvs', 'daemon', 'demo', 'dnsmasq', 'fax', 'fetchmail', 'files', 'ftp', 'ftpuser', 'games', 'gdm', 'git-daemon', 'gnats', 'guest', 'haldaemon', 'icecream', 'info', 'irc', 'libuuid', 'list', 'lp', 'mail', 'man', 'messagebus', 'mysql', 'nagios', 'news', 'nobody', 'ntp', 'oprofile', 'oracle', 'polkituser', 'postfix', 'postgres', 'proxy', 'pulse', 'puppet', 'sshd', 'support', 'suse-ncc', 'sync', 'sys', 'test', 'testuser', 'user', 'uucp', 'uuidd', 'webmaster', 'www', 'www-data', 'wwwrun' ])
  • dsakey (Any) (defaults to: '/etc/ssh/ssh_host_dsa_key')
  • forcecommand (Any) (defaults to: false)
  • gatewayports (Any) (defaults to: false)
  • gssapiauthentication (Any) (defaults to: false)
  • gssapikeyexchange (Any) (defaults to: false)
  • gssapicleanupcredentials (Any) (defaults to: true)
  • gssapistrictacceptorcheck (Any) (defaults to: true)
  • gssapistorecredentialsonrekey (Any) (defaults to: false)
  • hostbasedauthentication (Any) (defaults to: false)
  • hostbasedusesnamefrompacketonly (Any) (defaults to: false)
  • hostcertificate (Any) (defaults to: false)
  • ignorerhosts (Any) (defaults to: true)
  • ignoreuserknownhosts (Any) (defaults to: false)
  • kerberosauthentication (Any) (defaults to: false)
  • kerberosgetafstoken (Any) (defaults to: false)
  • kerberosorlocalpasswd (Any) (defaults to: true)
  • kerberosticketcleanup (Any) (defaults to: true)
  • keyregenerationinterval (Any) (defaults to: '3600')
  • listenaddress (Any) (defaults to: [])
  • logingracetime (Any) (defaults to: '30')
  • log_level (Any) (defaults to: 'VERBOSE')
  • macs (Any) (defaults to: [ 'hmac-sha1', 'hmac-sha1-96' ])
  • match_address (Any) (defaults to: [])
  • match_group (Any) (defaults to: [])
  • match_host (Any) (defaults to: [])
  • match_users (Any) (defaults to: [])
  • maxauthtries (Any) (defaults to: '6')
  • maxsessions (Any) (defaults to: '1')
  • maxstartups (Any) (defaults to: '10:30:100')
  • pamradiusauth (Any) (defaults to: false)
  • passwordauthentication (Any) (defaults to: true)
  • permitblacklistedkeys (Any) (defaults to: false)
  • permitrootlogin (Any) (defaults to: false)
  • permitemptypasswords (Any) (defaults to: false)
  • permitopen (Any) (defaults to: [])
  • permittunnel (Any) (defaults to: false)
  • permituserenvironment (Any) (defaults to: false)
  • port (Any) (defaults to: '22')
  • printlastlog (Any) (defaults to: true)
  • printmotd (Any) (defaults to: false)
  • protocol (Any) (defaults to: '2')
  • pubkeyauthentication (Any) (defaults to: false)
  • remove (Any) (defaults to: false)
  • revokedkeys (Any) (defaults to: false)
  • rhostsrsaauthentication (Any) (defaults to: false)
  • rsaauthentication (Any) (defaults to: false)
  • rsakey (Any) (defaults to: '/etc/ssh/ssh_host_rsa_key')
  • serverkeybits (Any) (defaults to: '2048')
  • strictmodes (Any) (defaults to: true)
  • syslogfacility (Any) (defaults to: 'AUTH')
  • subsystem (Any) (defaults to: false)
  • tcpkeepalive (Any) (defaults to: true)
  • titlesuffix (Any) (defaults to: false)
  • trustedusercakeys (Any) (defaults to: false)
  • usedns (Any) (defaults to: true)
  • uselogin (Any) (defaults to: false)
  • usepam (Any) (defaults to: true)
  • useprivilegeseparation (Any) (defaults to: true)
  • x11displayoffset (Any) (defaults to: '10')
  • x11forwarding (Any) (defaults to: false)
  • x11uselocalhost (Any) (defaults to: true)
  • xauthlocation (Any) (defaults to: '/usr/bin/xauth')


809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
# File 'manifests/server.pp', line 809

define ssh::server (
    $ensure                             = 'present',
    $acceptenv                          = [ 'LANG', 'LC_*' ],
    $addressfamily                      = 'any',
    $allowagentforwarding               = true,
    $allowgroups                        = false,
    $allowhosts                         = false,
    $allowtcpforwarding                 = false,
    $allowusers                         = false,
    $authorizedkeysfile                 = '%h/.ssh/authorized_keys',
    $banner                             = '/etc/issue.net',
    $challengresponseauthentication     = false,
    $chrootdirectory                    = false,
    $ciphers                            = [ 'aes256-ctr', 'aes192-ctr', 'aes128-ctr' ],
    $clientalivecountmax                = '0',
    $clientaliveinterval                = '300',
    $compression                        = 'delayed',
    $debianbanner                       = true,
    $debug                              = false,
    $denygroups                         = false,
    $denyusers                          = [
        'adm',       'admin',       'administrator', 'Administrator',
        'anonymous', 'apache',      'at',            'avahi',
        'backup',    'beagleindex', 'bin',           'cvs',
        'daemon',    'demo',        'dnsmasq',       'fax',
        'fetchmail', 'files',       'ftp',           'ftpuser',
        'games',     'gdm',         'git-daemon',    'gnats',
        'guest',     'haldaemon',   'icecream',      'info',
        'irc',       'libuuid',     'list',          'lp',
        'mail',      'man',         'messagebus',    'mysql',
        'nagios',    'news',        'nobody',        'ntp',
        'oprofile',  'oracle',      'polkituser',    'postfix',
        'postgres',  'proxy',       'pulse',         'puppet',
        'sshd',      'support',     'suse-ncc',      'sync',
        'sys',       'test',        'testuser',      'user',
        'uucp',      'uuidd',       'webmaster',     'www',
        'www-data',  'wwwrun'
    ],
    $dsakey                             = '/etc/ssh/ssh_host_dsa_key',
    $forcecommand                       = false,
    $gatewayports                       = false,
    $gssapiauthentication               = false,
    $gssapikeyexchange                  = false,
    $gssapicleanupcredentials           = true,
    $gssapistrictacceptorcheck          = true,
    $gssapistorecredentialsonrekey      = false,
    $hostbasedauthentication            = false,
    $hostbasedusesnamefrompacketonly    = false,
    $hostcertificate                    = false,
    $ignorerhosts                       = true,
    $ignoreuserknownhosts               = false,
    $kerberosauthentication             = false,
    $kerberosgetafstoken                = false,
    $kerberosorlocalpasswd              = true,
    $kerberosticketcleanup              = true,
    $keyregenerationinterval            = '3600',
    $listenaddress                      = [],
    $logingracetime                     = '30',
    $log_level                          = 'VERBOSE',
    $macs                               = [ 'hmac-sha1', 'hmac-sha1-96' ],
    $match_address                      = [],
    $match_group                        = [],
    $match_host                         = [],
    $match_users                        = [],
    $maxauthtries                       = '6',
    $maxsessions                        = '1',
    $maxstartups                        = '10:30:100',
    $pamradiusauth                      = false,
    $passwordauthentication             = true,
    $permitblacklistedkeys              = false,
    $permitrootlogin                    = false,
    $permitemptypasswords               = false,
    $permitopen                         = [],
    $permittunnel                       = false,
    $permituserenvironment              = false,
    $port                               = '22',
    $printlastlog                       = true,
    $printmotd                          = false,
    $protocol                           = '2',
    $pubkeyauthentication               = false,
    $remove                             = false,
    $revokedkeys                        = false,
    $rhostsrsaauthentication            = false,
    $rsaauthentication                  = false,
    $rsakey                             = '/etc/ssh/ssh_host_rsa_key',
    $serverkeybits                      = '2048',
    $strictmodes                        = true,
    $syslogfacility                     = 'AUTH',
    $subsystem                          = false,
    $tcpkeepalive                       = true,
    $titlesuffix                        = false,
    $trustedusercakeys                  = false,
    $usedns                             = true,
    $uselogin                           = false,
    $usepam                             = true,
    $useprivilegeseparation             = true,
    $x11displayoffset                   = '10',
    $x11forwarding                      = false,
    $x11uselocalhost                    = true,
    $xauthlocation                      = '/usr/bin/xauth'
)
{
    # Make sure the client is installed
    require ssh::client

    # Make sure the package is installed
    require ssh::package

    # Parameter validation
    # NOTE: Configuration file directive validation is handled
    #       within the templates.  This validation is for flow
    #       related parameters.
    if ! ( $ensure in [ 'absent','present' ] ) {
        fail( 'ensure must be "absent" or "present"' )
    }

    # For port tcp/22, use the standard filenames.  For any other port
    # append the port number to the filenames
    if $port == 22 {
        $suffix = ''
    } else {
        if $titlesuffix {
            $tag = $title
        } else {
            $tag = $port
        }

        # FreeBSD and OpenBSD's rc.d system doesn't like the
        # extra '_' character that we use in the suffix
        $suffix = $::operatingsystem ? {
            'freebsd' => $tag,
            'openbsd' => $tag,
            default   => "_${tag}"
        }
    }

    # We need to make sure our operating system is defined
    # and we don't want to do anything if the package hasn't
    # been defined either.
    if $ssh::package::os_defined {
        $ok = $::operatingsystem ? {
            'centos'   => true,
            'debian'   => true,
            'fedora'   => true,
            'freebsd'  => true,
            'openbsd'  => true,
            'opensuse' => true,
            'redhat'   => true,
            'sles'     => true,
            'ubuntu'   => true,
            default    => false,
        }
    } else {
        $ok = false
    }

    # ... and if not, throw an error and skip the rest
    if ! $ok {
        notify { "${title}_${::operatingsystem}_unknown":
            loglevel => 'alert',
            message  => "Unknown OS '${::operatingsystem}', skipping server configuration",
        }
    } else {

        # Path to the defaults file
        $ssh_default = $::operatingsystem ? {
            'centos'   => '/etc/sysconfig/sshd',
            'debian'   => '/etc/default/ssh',
            'fedora'   => '/etc/sysconfig/sshd',
            'opensuse' => '/etc/sysconfig/ssh',
            'redhat'   => '/etc/sysconfig/sshd',
            'sles'     => '/etc/sysconfig/sshd',
            'ubuntu'   => '/etc/default/ssh',
            default    => '',
        }

        # Path to the init file
        $ssh_init = $::operatingsystem ? {
            'centos'   => '/etc/init.d/sshd',
            'debian'   => '/etc/init.d/ssh',
            'fedora'   => '/etc/init.d/sshd',
            'freebsd'  => '/etc/rc.d/sshd',
            'openbsd'  => '/etc/rc.d/sshd',
            'opensuse' => '/etc/init.d/sshd',
            'redhat'   => '/etc/init.d/sshd',
            'sles'     => '/etc/init.d/sshd',
            'ubuntu'   => '/etc/init.d/ssh',
            default    => '',
        }

        # Path to chrooted init file ( so far only Ubuntu uses this )
        $ssh_conf = $::operatingsystem ? {
            'ubuntu' => "/etc/init/ssh${suffix}.conf",
            default  => '',
        }

        # Tickler file to tell sshd not to run ( mostly a Debian/Ubuntu thing )
        $ssh_norun = $::operatingsystem ? {
            'debian' => '/etc/ssh/sshd_not_to_be_run',
            'ubuntu' => '/etc/ssh/sshd_not_to_be_run',
            default  => '',
        }

        # Name of the sshd binary
        $sshd_name = $::operatingsystem ? {
            default => 'sshd',
        }

        # Path to the sshd binary
        $sshd_binary = $::operatingsystem ? {
            default => '/usr/sbin/sshd',
        }

        # Path to the sshd configuration file
        $sshd_config = $::operatingsystem ? {
            default => '/etc/ssh/sshd_config',
        }

        # Path to the PAM file for sshd
        $sshd_pam = $::operatingsystem ? {
            'freebsd' => '',
            'openbsd' => '',
            default   => '/etc/pam.d/sshd',
        }

        # Path to the privilege separation director
        $sshd_privdir = $::operatingsystem ? {
            'debian' => '/var/run/ssh',
            'ubuntu' => '/var/run/sshd',
            default  => '',
        }

        # Path to the deny_users file (for pam_listfile)
        $deny_users = $::operatingsystem ? {
            'freebsd' => '',
            'openbsd' => '',
            default   => '/etc/ssh/deny_users',
        }

        # Service name
        $sshd_service = $::operatingsystem ? {
            'centos'   => 'sshd',
            'debian'   => 'ssh',
            'fedora'   => 'sshd',
            'freebsd'  => 'sshd',
            'openbsd'  => 'sshd',
            'opensuse' => 'sshd',
            'redhat'   => 'sshd',
            'sles'     => 'sshd',
            'ubuntu'   => 'ssh',
            default    => '',
        }

        # Service start argument
        $ssh_start = $::operatingsystem ? {
            'freebsd' => 'onestart',
            default   => 'start',
        }

        # Service stop argument
        $ssh_stop = $::operatingsystem ? {
            'freebsd' => 'onestop',
            default   => 'stop',
        }

        # Service status argument
        $ssh_status = $::operatingsystem ? {
            'freebsd' => 'onestatus',
            'openbsd' => 'check',
            default   => 'status',
        }

        # Does the service honor the restart command
        $ssh_hasrestart = $::operatingsystem ? {
            'openbsd' => false,
            default   => true,
        }

        # SELinux port context
        $seport_context = $::operatingsystem ? {
            'freebsd' => '',
            'openbsd' => '',
            default   => 'ssh_port_t',
        }

        # Path to the SFTP server
        if $subsystem {
            $sftp_server = $subsystem
        } else {
            $sftp_server = $::operatingsystem ? {
                'centos'   => '/usr/lib/openssh/sftp-server',
                'debian'   => '/usr/lib/openssh/sftp-server',
                'fedora'   => '/usr/lib/openssh/sftp-server',
                'freebsd'  => '/usr/libexec/sftp-server',
                'openbsd'  => '/usr/libexec/sftp-server',
                'opensuse' => '/usr/lib/ssh/sftp-server',
                'redhat'   => '/usr/lib/openssh/sftp-server',
                'sles'     =>  $::architecture ? {
                    'x86_64' => '/usr/lib64/ssh/sftp-server',
                    default  => '/usr/lib/ssh/sftp-server',
                },
                'ubuntu'   => '/usr/lib/openssh/sftp-server',
                default    => '',
            }
        }

        # Command to enable sshd at boot
        $ssh_add_runlevel_cmd = $::operatingsystem ? {
            'centos'   => "chkconfig --add ${sshd_service}${suffix}",
            'debian'   => "update-rc.d ${sshd_service}${suffix} defaults",
            'fedora'   => "chkconfig --add ${sshd_service}${suffix}",
            'opensuse' => "chkconfig --add ${sshd_service}${suffix}",
            'redhat'   => "chkconfig --add ${sshd_service}${suffix}",
            'sles'     => "chkconfig --add ${sshd_service}${suffix}",
            'ubuntu'   => "update-rc.d ${sshd_service}${suffix} defaults",
            default    => '',
        }

        # Command to disable sshd from starting at boot
        $ssh_del_runlevel_cmd = $::operatingsystem ? {
            'centos'   => "chkconfig --del ${sshd_service}${suffix}",
            'debian'   => "update-rc.d ${sshd_service}${suffix} remove",
            'fedora'   => "chkconfig --del ${sshd_service}${suffix}",
            'redhat'   => "chkconfig --del ${sshd_service}${suffix}",
            'opensuse' => "chkconfig --del ${sshd_service}${suffix}",
            'sles'     => "chkconfig --del ${sshd_service}${suffix}",
            'ubuntu'   => "update-rc.d ${sshd_service}${suffix} remove",
            default    => '',
        }

        # rc file used to determin if sshd is enabled at boot or not
        $sshd_rcfile = $::operatingsystem ? {
            'centos'   => '/etc/rc2.d/S55sshd',
            'debian'   => '/etc/rc2.d/S03ssh',
            'fedora'   => '/etc/rc2.d/S55sshd',
            'redhat'   => '/etc/rc2.d/S55sshd',
            'opensuse' => '/etc/init.d/rc3.d/S07sshd',
            'sles'     => '/etc/init.d/rc3.d/S07sshd',
            'ubuntu'   => '/etc/rc2.d/S20ssh',
            default    => '',
        }

        # Lowercase copy of operating system
        $os = $::operatingsystem ? {
            'centos'   => 'centos',
            'debian'   => 'debian',
            'fedora'   => 'fedora',
            'redhat'   => 'redhat',
            'freebsd'  => 'freebsd',
            'openbsd'  => 'openbsd',
            'opensuse' => 'opensuse',
            'sles'     => 'sles',
            'ubuntu'   => 'ubuntu',
            default    => '',
        }

        # If we're creating the daemon (e.g. not removing it)...
        if $ensure == 'present' {
            if ( defined( File['/etc/iptables.d'] ) ) {
                file { "/etc/iptables.d/80_${sshd_service}${suffix}_${port}":
                    owner   => 'root',
                    group   => 'root',
                    mode    => '0400',
                    content => template( "${module_name}/etc/iptables.d/80_sshd" ),
                    notify  => Exec['reload-iptables'],
                }
            }

            # Create the sshd_config for this server
            file { "${sshd_config}${suffix}":
                ensure   => present,
                mode     => '0444',
                owner    => $ssh::user,
                group    => $ssh::group,
                content  => template( "${module_name}/etc/ssh/sshd_config" ),
                notify   => Service["${sshd_service}${suffix}"],
                require  => Package['ssh-server-package'],
            }

            # Create a defaults file
            case $::operatingsystem {
                'centos','debian','fedora','opensuse','redhat', 'sles','ubuntu': {
                    file { "${ssh_default}${suffix}":
                        mode     => '0444',
                        owner    => $ssh::user,
                        group    => $ssh::group,
                        content  => template( "${module_name}/${ssh_default}" ),
                        notify   => Service["${sshd_service}${suffix}"],
                        require  => Package['ssh-server-package'],
                    }
                }
                default: {}
            }

            # Create an init script
            file { "${ssh_init}${suffix}":
                mode     => '0555',
                owner    => $ssh::user,
                group    => $ssh::group,
                content  => template( "${module_name}/${ssh_init}-${os}" ),
                notify   => Service["${sshd_service}${suffix}"],
                require  => Package['ssh-server-package'],
            }

            # Ubuntu uses /etc/init/ssh for chrooted environments
            case $::operatingsystem {
                'ubuntu': {
                    file { $ssh_conf:
                        mode     => '0444',
                        owner    => $ssh::user,
                        group    => $ssh::group,
                        content  => template( "${module_name}/etc/init/ssh.conf" ),
                        before   => Service["${sshd_service}${suffix}"],
                        require  => Package['ssh-server-package'],
                    }
                }
                default: {}
            }

            # Create a PAM configuration
            case $::operatingsystem {
                'centos','debian','fedora','opensuse','redhat','sles','ubuntu': {
                    file { "${sshd_pam}${suffix}":
                        mode     => '0444',
                        owner    => $ssh::user,
                        group    => $ssh::group,
                        content  => template( "${module_name}/${sshd_pam}-${os}" ),
                        before   => Service["${sshd_service}${suffix}"],
                        require  => Package['ssh-server-package'],
                    }
                }
                default: {}
            }

            # Create a deny_users file for pam_listfile
            case $::operatingsystem {
                'centos','debian','fedora','opensuse','redhat','sles','ubuntu': {
                    file { "${deny_users}${suffix}":
                        mode     => '0444',
                        owner    => $ssh::user,
                        group    => $ssh::group,
                        content  => template( "${module_name}/etc/ssh/deny_users" ),
                        before   => Service["${sshd_service}${suffix}"],
                        require  => Package['ssh-server-package'],
                    }
                }
                default: {}
            }

            # Symlink to the real sshd or set the permissions on the binary
            if $port != '22' {
                file { "${sshd_binary}${suffix}":
                    ensure   => 'link',
                    target   => '/usr/sbin/sshd',
                    before   => Service["${sshd_service}${suffix}"],
                    require  => Package['ssh-server-package'],
                }
            } else {
                file { "${sshd_binary}${suffix}":
                    mode     => '0755',
                    owner    => $ssh::user,
                    group    => $ssh::group,
                    before   => Service["${sshd_service}${suffix}"],
                    require  => Package['ssh-server-package'],
                }
            }

            # Generate the RSA key if it doesn't exist
            if ( ! defined( Exec["generate-${rsakey}"] )) {
                exec { "generate-${rsakey}":
                    path    => [ '/usr/bin' ],
                    command => "ssh-keygen -t rsa -b 4096 -f ${rsakey}",
                    creates => "${rsakey}",
                    notify  => Service["${sshd_service}${suffix}"],
                    require => Package['ssh-server-package'],
                }
            } else {
                if $debug {
                    notify { "generate-${rsakey}${suffix}":
                        loglevel => 'warning',
                        message  => "DEBUG: Exec[generate-${rsakey}] already defined, skipping",
                    }
                }
            }

            # Generate the DSA key if it doesn't exist
            if ( ! defined( Exec["generate-${dsakey}"] )) {
                exec { "generate-${dsakey}":
                    path    => [ '/usr/bin' ],
                    command => "ssh-keygen -t dsa -b 1024 -f ${dsakey}",
                    creates => "${dsakey}",
                    notify  => Service["${sshd_service}${suffix}"],
                    require => Package['ssh-server-package'],
                }
            } else {
                if $debug {
                    notify { "generate-${dsakey}${suffix}":
                        loglevel => 'warning',
                        message  => "DEBUG: Exec[generate-${dsakey}] already defined, skipping",
                    }
                }
            }

            # Copy the RSA host private key
            if ( ! defined( File[$rsakey] )) {
                $rsa_pri_key = file(
                    "${ssh::site_private_path}/${rsakey}",
                    "${settings::vardir}/private/${::fqdn}/${rsakey}",
                    "${settings::vardir}/hosts/${::fqdn}/${rsakey}",
                    "${settings::vardir}/nodefile/${::fqdn}/${rsakey}",
                    "${settings::vardir}/dist/${::fqdn}/${rsakey}",
                    '/dev/null'
                )
                if ( $rsa_pri_key ) {
                    file { $rsakey:
                        mode    => '0400',
                        owner   => $ssh::user,
                        group   => $ssh::group,
                        content => $rsa_pri_key,
                        notify  => Service["${sshd_service}${suffix}"],
                        require => [
                            Package['ssh-server-package'],
                            Exec["generate-${rsakey}"],
                        ],
                    }
                } else {
                    file { "${rsakey}":
                        mode  => '0400',
                        owner => $ssh::user,
                        group => $ssh::group,
                        require => [
                            Package['ssh-server-package'],
                            Exec["generate-${rsakey}"],
                        ],
                    }
                }
            } else {
                if $debug {
                    notify { "file-${rsakey}${suffix}":
                        loglevel => 'warning',
                        message  => "DEBUG: File[${rsakey}] already defined, skipping",
                    }
                }
            }

            # Copy the RSA host public key
            if ( ! defined( File["${rsakey}.pub"] )) {
                $rsa_pub_key = file(
                    "${ssh::site_private_path}/${rsakey}.pub",
                    "${settings::vardir}/private/${::fqdn}/${rsakey}.pub",
                    "${settings::vardir}/hosts/${::fqdn}/${rsakey}.pub",
                    "${settings::vardir}/nodefile/${::fqdn}/${rsakey}.pub",
                    "${settings::vardir}/dist/${::fqdn}/${rsakey}.pub",
                    '/dev/null'
                )
                if ( $rsa_pub_key ) {
                    file { "${rsakey}.pub":
                        mode    => '0444',
                        owner   => $ssh::user,
                        group   => $ssh::group,
                        content => $rsa_pub_key,
                        notify  => Service["${sshd_service}${suffix}"],
                        require => [
                            Package['ssh-server-package'],
                            Exec["generate-${rsakey}"],
                        ],
                    }
                } else {
                    file { "${rsakey}.pub":
                        mode  => '0444',
                        owner => $ssh::user,
                        group => $ssh::group,
                        require => [
                            Package['ssh-server-package'],
                            Exec["generate-${rsakey}"],
                        ],
                    }
                }
            } else {
                if $debug {
                    notify { "file-${rsakey}${suffix}.pub":
                        loglevel => 'warning',
                        message  => "DEBUG: File[${rsakey}.pub] already defined, skipping",
                    }
                }
            }

            # Copy the DSA host private key
            if ( ! defined( File[$dsakey] )) {
                $dsa_pri_key = file(
                    "${ssh::site_private_path}/${dsakey}",
                    "${settings::vardir}/private/${::fqdn}/${dsakey}",
                    "${settings::vardir}/hosts/${::fqdn}/${dsakey}",
                    "${settings::vardir}/nodefile/${::fqdn}/${dsakey}",
                    "${settings::vardir}/dist/${::fqdn}/${dsakey}",
                    '/dev/null'
                )
                if ( $dsa_pri_key ) {
                    file { $dsakey:
                        mode    => '0400',
                        owner   => $ssh::user,
                        group   => $ssh::group,
                        content => $dsa_pri_key,
                        notify  => Service["${sshd_service}${suffix}"],
                        require => [
                            Package['ssh-server-package'],
                            Exec["generate-${dsakey}"],
                        ],
                    }
                } else {
                    file { "${dsakey}":
                        mode  => '0400',
                        owner => $ssh::user,
                        group => $ssh::group,
                        require => [
                            Package['ssh-server-package'],
                            Exec["generate-${dsakey}"],
                        ],
                    }
                }
            } else {
                if $debug {
                    notify { "file-${dsakey}${suffix}":
                        loglevel => 'warning',
                        message  => "DEBUG: File[${dsakey}] already defined, skipping",
                    }
                }
            }

            # Copy the DSA host public key
            if ( ! defined( File["${dsakey}.pub"] )) {
                $dsa_pub_key = file(
                    "${ssh::site_private_path}/${dsakey}.pub",
                    "${settings::vardir}/private/${::fqdn}/${dsakey}.pub",
                    "${settings::vardir}/hosts/${::fqdn}/${dsakey}.pub",
                    "${settings::vardir}/nodefile/${::fqdn}/${dsakey}.pub",
                    "${settings::vardir}/dist/${::fqdn}/${dsakey}.pub",
                    '/dev/null'
                )
                if ( $dsa_pub_key ) {
                    file { "${dsakey}.pub":
                        mode    => '0444',
                        owner   => $ssh::user,
                        group   => $ssh::group,
                        content => $dsa_pub_key,
                        notify  => Service["${sshd_service}${suffix}"],
                        require => [
                            Package['ssh-server-package'],
                            Exec["generate-${dsakey}"],
                        ],
                    }
                } else {
                    file { "${dsakey}.pub":
                        mode  => '0444',
                        owner => $ssh::user,
                        group => $ssh::group,
                        require => [
                            Package['ssh-server-package'],
                            Exec["generate-${dsakey}"],
                        ],
                    }
                }
            } else {
                if $debug {
                    notify { "file-${dsakey}${suffix}.pub":
                        loglevel => 'warning',
                        message  => "DEBUG: File[${dsakey}.pub] already defined, skipping",
                    }
                }
            }

            # Add this port to selinux.
            # The unless stanza checks for three things:
            #   * semanage exists
            #   * sestatus doesn't report disabled
            #   * semanage doesn't show that the context already exists
            exec { "add-semanage-port-${port}":
                path    => [ '/sbin', '/usr/sbin', '/bin', '/usr/bin' ],
                command => "semanage port -a -t ${seport_context} -p tcp ${port}",
                unless  => "test ! -f /usr/sbin/semanage || sestatus | grep -i 'disabled' || semanage port -l | grep \"^${seport_context}.*${port}\"",
                notify  => Service["${sshd_service}${suffix}"],
            }

            # Add this daemon to the run levels
            case $::operatingsystem {
                'centos','debian','fedora','opensuse','redhat','sles','ubuntu': {
                    exec { "add-runlevels-${sshd_service}${suffix}":
                        path     => '/sbin:/usr/sbin:/bin:/usr/bin',
                        command  => $ssh_add_runlevel_cmd,
                        notify   => Service["${sshd_service}${suffix}"],
                        unless   => "ls /etc/rc2.d/S[0-9][0-9]${sshd_service}",
                        require  => [
                                Package['ssh-server-package'],
                                File["${ssh_init}${suffix}"],
                        ],
                    }
                }

                'freebsd': {
                    exec { "enable-${sshd_service}${suffix}":
                        command => "/bin/cat /etc/rc.conf | /usr/bin/awk '{ if ( /^${sshd_service}${suffix}_enable.*/ ) { found=1; print \"${sshd_service}${suffix}_enable=\\\"YES\\\"\"; } else { print; } } END { if (!found) { print \"${sshd_service}${suffix}_enable=\\\"YES\\\"\" }}' > /etc/rc.conf.puppet && /bin/mv /etc/rc.conf.puppet /etc/rc.conf",
                        unless  => "/usr/bin/grep \"^${sshd_service}${suffix}_enable=\" /etc/rc.conf",
                        before  => Exec["add-runlevels-${sshd_service}${suffix}"],
                    }
                    exec { "add-runlevels-${sshd_service}${suffix}":
                        command => "/bin/cat /etc/rc.conf.local | /usr/bin/awk '{ if ( /^${sshd_service}${suffix}_flags.*/ ) { found=1; print \"${sshd_service}${suffix}_flags=\\\"-f ${sshd_config}${suffix}\\\"\"; } else { print; } } END { if (!found) { print \"${sshd_service}${suffix}_flags=\\\"-f ${sshd_config}${suffix}\\\"\" }}' > /etc/rc.conf.local.puppet && /bin/mv /etc/rc.conf.local.puppet /etc/rc.conf.local",
                        unless  => "/usr/bin/grep \"^${sshd_service}${suffix}_flags=\\\"-f ${sshd_config}${suffix}\\\"\" /etc/rc.conf.local",
                        before  => Service["${sshd_service}${suffix}"],
                        require => Exec["enable-${sshd_service}${suffix}"],
                    }
                }

                'openbsd': {
                    # OpenBSD manages services using rc.conf.local
                    exec { "add-runlevels-${sshd_service}${suffix}":
                        command => "/bin/cat /etc/rc.conf.local | /usr/bin/awk '{ if ( /^${sshd_service}${suffix}_.*/ ) { found=1; print \"${sshd_service}${suffix}_flags=\\\"-f ${sshd_config}${suffix}\\\"\"; } else { print; } } END { if (!found) { print \"${sshd_service}${suffix}_flags=\\\"-f ${sshd_config}${suffix}\\\"\" }}' > /etc/rc.conf.local.puppet && /bin/mv /etc/rc.conf.local.puppet /etc/rc.conf.local",
                        unless  => "/usr/bin/grep \"^${sshd_service}${suffix}_flags=\\\"-f ${sshd_config}${suffix}\\\"\" /etc/rc.conf.local",
                    }
                }
                default: {}
            }

            # Make sure the service is running.
            service { "${sshd_service}${suffix}":
                ensure     => 'running',
                enable     => true,
                path       => [ '/etc/init.d/', '/etc/rc.d' ],
                hasrestart => $ssh_hasrestart,
                start      => "${ssh_init}${suffix} ${ssh_start}",
                stop       => "${ssh_init}${suffix} ${$ssh_stop}",
                status     => "${ssh_init}${suffix} ${ssh_status}",
                require    => [ Package['ssh-server-package'],
                                File["${sshd_config}${suffix}"],
                                File["${sshd_binary}${suffix}"],
                                Exec["add-runlevels-${sshd_service}${suffix}"],
                                Exec["generate-${rsakey}"],
                                Exec["generate-${dsakey}"],
                            ],
            }
        } else {
            # Stop the daemon
            service { "${sshd_service}${suffix}":
                ensure     => 'stopped',
                enable     => false,
                path       => [ '/etc/init.d/', '/etc/rc.d' ],
                hasrestart => $ssh_hasrestart,
                stop       => "${ssh_init}${suffix} ${$ssh_stop}",
                status     => "${ssh_init}${suffix} ${ssh_status}",
            }

            # Remove the init script for this server
            file { "${ssh_init}${suffix}":
                ensure  => 'absent',
                require => Service["${sshd_service}${suffix}"],
                before  => Exec["del-runlevels-${sshd_service}${suffix}"],
            }

            # Remove the daemon from the run levels
            case $::operatingsystem {
                'centos','debian','fedora','opensuse','redhat','sles','ubuntu': {
                    exec { "del-runlevels-${sshd_service}${suffix}":
                        path    => '/sbin:/usr/sbin:/bin:/usr/bin',
                        command => $ssh_del_runlevel_cmd,
                        onlyif  => "ls /etc/rc2.d/S[0-9][0-9]${sshd_service}",
                        before  => File["${sshd_config}${suffix}"],
                        require => [
                            File["${ssh_init}${suffix}"],
                            Service["${sshd_service}${suffix}"],
                        ],
                    }
                }
                'freebsd': {
                    # FreeBSD manages services using rc.conf and rc.conf.local
                    exec { "disable-${sshd_service}${suffix}":
                        command => "/usr/bin/grep -v \"^${sshd_service}${suffix}_\" /etc/rc.conf > /etc/rc.conf.puppet && /bin/mv /etc/rc.conf.puppet /etc/rc.conf",
                        onlyif  => "/usr/bin/grep \"^${sshd_service}${suffix}_enable=\" /etc/rc.conf",
                    }
                    exec { "del-runlevels-${sshd_service}${suffix}":
                        command => "/usr/bin/grep -v \"^${sshd_service}${suffix}_\" /etc/rc.conf.local > /etc/rc.conf.local.puppet && /bin/mv /etc/rc.conf.local.puppet /etc/rc.conf.local",
                        onlyif  => "/usr/bin/grep \"^${sshd_service}${suffix}_flags=\\\"-f ${sshd_config}${suffix}\\\"\" /etc/rc.conf.local",
                        require => Exec["disable-${sshd_service}${suffix}"],
                    }
                }

                'openbsd': {
                    # OpenBSD manages services using rc.conf.local
                    exec { "del-runlevels-${sshd_service}${suffix}":
                        command => "/usr/bin/grep -v \"^${sshd_service}${suffix}_\" /etc/rc.conf.local > /etc/rc.conf.local.puppet && /bin/mv /etc/rc.conf.local.puppet /etc/rc.conf.local",
                        onlyif  => "/usr/bin/grep \"^${sshd_service}${suffix}_flags=\\\"-f ${sshd_config}${suffix}\\\"\" /etc/rc.conf.local",
                    }
                }
                default: { fail( "can't disable runlevels for ${::operatingsystem}" ) }
            }

            # Remove this port from selinux
            exec { "del-semanage-port-${port}":
                path    => [ '/sbin', '/bin' ],
                command => "semanage port -d -t ${seport_context} -p tcp ${port}",
                onlyif  => "test -f /usr/sbin/semanage && sestatus | grep -i 'enabled' && semanage port -l | grep \"^${seport_context}.*${port}\"",
                require => [
                    Exec["del-runlevels-${sshd_service}${suffix}"],
                    Service["${sshd_service}${suffix}"],
                ],
            }

            # Remove the /etc/default file for this server
            case $::operatingsystem {
                'centos','debian','fedora','opensuse','redhat','sles','ubuntu': {
                    file { "${ssh_default}${suffix}":
                        ensure  => 'absent',
                        require => [
                            Exec["del-runlevels-${sshd_service}${suffix}"],
                            Service["${sshd_service}${suffix}"],
                        ],
                    }
                }
                default: {}
            }

            # Remove the sshd_config for this server
            file { "${sshd_config}${suffix}":
                ensure  => 'absent',
                require => [
                    Exec["del-runlevels-${sshd_service}${suffix}"],
                    Service["${sshd_service}${suffix}"],
                ],
            }

            # Remove Ubuntu's other init script
            case $::operatingsystem {
                'ubuntu': {
                    file { $ssh_conf:
                        ensure  => 'absent',
                        require => [
                            Exec["del-runlevels-${sshd_service}${suffix}"],
                            Service["${sshd_service}${suffix}"],
                        ],
                    }
                }
                default: {}
            }

            # Remove the PAM configuration for this server
            case $::operatingsystem {
                'centos','debian','fedora','opensuse','redhat','sles','ubuntu': {
                    file { "${sshd_pam}${suffix}":
                        ensure  => 'absent',
                        require => [
                            Exec["del-runlevels-${sshd_service}${suffix}"],
                            Service["${sshd_service}${suffix}"],
                        ],
                    }
                }
                default: {}
            }

            # Remove the deny_users file for this server
            case $::operatingsystem {
                'centos','debian','fedora','opensuse','redhat','sles','ubuntu': {
                    file { "${deny_users}${suffix}":
                        ensure  => 'absent',
                        require => [
                            Exec["del-runlevels-${sshd_service}${suffix}"],
                            Service["${sshd_service}${suffix}"],
                        ],
                    }
                }
                default: {}
            }

            # Remove the PID file for this server
            file { "/var/run/${sshd_name}${suffix}.pid":
                ensure  => 'absent',
                require => [
                    Exec["del-runlevels-${sshd_service}${suffix}"],
                    Service["${sshd_service}${suffix}"],
                ],
            }

            # Remove the privilege separation directory
            if $sshd_privdir != '' {
                file { "${sshd_privdir}${suffix}":
                    ensure  => 'absent',
                    require => [
                        Exec["del-runlevels-${sshd_service}${suffix}"],
                        Service["${sshd_service}${suffix}"],
                    ],
                }
            }

            # Remove the sshd_symlink if we were using an alternate port
            if $port != 22 {
                file { "${sshd_binary}${suffix}":
                    ensure  => 'absent',
                    require => [
                        Exec["del-runlevels-${sshd_service}${suffix}"],
                        Service["${sshd_service}${suffix}"],
                    ],
                }
            }
        }
    }
}