ssh-hardening (Ansible Role)
Attention: This role has been migrated to our hardening-collection:
Please open any issues and pull requests there!
Requirements
Role Variables
network_ipv6_enable
- Default: false
- Description: true if IPv6 is needed.
ssh_listen_to must also be set to listen to IPv6 addresses (for example [::]).
ssh_server_ports
- Default: ['22']
- Description: ports on which ssh-server should listen
ssh_client_port
- Default: '22'
- Description: port to which ssh-client should connect
ssh_listen_to
- Default: ['0.0.0.0']
- Description: one or more ip addresses, to which ssh-server should listen to. Default is all IPv4 adresses, but should be configured to specific addresses for security reasons!
ssh_host_key_files
- Default: []
- Description: Host keys for sshd. If empty ['/etc/ssh/ssh_host_rsa_key', '/etc/ssh/ssh_host_ecdsa_key', '/etc/ssh/ssh_host_ed25519_key'] will be used, as far as supported by the installed sshd version
ssh_host_key_algorithms
- Default: []
- Description: Host key algorithms that the server offers. If empty the default list will be used, otherwise overrides the setting with specified list of algorithms
ssh_client_alive_interval
- Default: 600
- Description: specifies an interval for sending keepalive messages
ssh_client_alive_count
- Default: 3
- Description: defines how often keep-alive messages are sent
ssh_permit_tunnel
- Default: false
- Description: true if SSH Port Tunneling is required
ssh_remote_hosts
- Default: []
- Description: one or more hosts and their custom options for the ssh-client. Default is empty. See examples in
defaults/main.yml.
ssh_permit_root_login
- Default: no
- Description: Disable root-login. Set to
without-password or yes to enable root-login
ssh_allow_tcp_forwarding
- Default: no
- Description:
'no' to disable TCP Forwarding. Set to 'yes' to allow TCP Forwarding. If you are using OpenSSH >= 6.2 version, you can specify 'yes', 'no', 'all' or 'local'.
Note: values passed to this variable must be strings, thus values 'yes' and 'no' should be passed with quotes.
ssh_gateway_ports
- Default:
false
- Description:
false to disable binding forwarded ports to non-loopback addresses. Set to true to force binding on wildcard address. Set to clientspecified to allow the client to specify which address to bind to.
ssh_allow_agent_forwarding
- Default: false
- Description: false to disable Agent Forwarding. Set to true to allow Agent Forwarding.
ssh_x11_forwarding
- Default: false
- Description: false to disable X11 Forwarding. Set to true to allow X11 Forwarding.
ssh_pam_support
- Default: true
- Description: true if SSH has PAM support.
ssh_use_pam
- Default: true
- Description: false to disable pam authentication.
ssh_gssapi_support
- Default: false
- Description: true if SSH has GSSAPI support.
ssh_kerberos_support
- Default: true
- Description: true if SSH has Kerberos support.
ssh_deny_users
- Default: ''
- Description: if specified, login is disallowed for user names that match one of the patterns.
ssh_allow_users
- Default: ''
- Description: if specified, login is allowed only for user names that match one of the patterns.
ssh_deny_groups
- Default: ''
- Description: if specified, login is disallowed for users whose primary group or supplementary group list matches one of the patterns.
ssh_allow_groups
- Default: ''
- Description: if specified, login is allowed only for users whose primary group or supplementary group list matches one of the patterns.
ssh_authorized_keys_file
- Default: ''
- Description: change default file that contains the public keys that can be used for user authentication.
ssh_trusted_user_ca_keys_file
- Default: ''
- Description: specifies the file containing trusted certificate authorities public keys used to sign user certificates.
ssh_trusted_user_ca_keys
- Default: []
- Description: set the trusted certificate authorities public keys used to sign user certificates. Only used if
ssh_trusted_user_ca_keys_file is set.
ssh_authorized_principals_file
- Default: ''
- Description: specifies the file containing principals that are allowed. Only used if
ssh_trusted_user_ca_keys_file is set.
ssh_authorized_principals
- Default: []
- Description: list of hashes containing file paths and authorized principals, see
default_custom.yml for all options. Only used if ssh_authorized_principals_file is set.
ssh_print_motd
- Default: false
- Description: false to disable printing of the MOTD
ssh_print_pam_motd
- Default: false
- Description: false to disable printing of the MOTD via pam (Debian and Ubuntu)
ssh_print_last_log
- Default: false
- Description: false to disable display of last login information
sftp_enabled
- Default: false
- Description: true to enable sftp configuration
sftp_umask
- Default: '0027'
- Description: Specifies the umask for sftp
sftp_chroot
- Default: true
- Description: false to disable chroot for sftp
sftp_chroot_dir
- Default: /home/%u
- Description: change default sftp chroot location
ssh_client_roaming
- Default: false
- Description: enable experimental client roaming
sshd_moduli_file
- Default: '/etc/ssh/moduli'
- Description: path to the SSH moduli file
sshd_moduli_minimum
- Default: 2048
- Description: remove Diffie-Hellman parameters smaller than the defined size to mitigate logjam
ssh_challengeresponseauthentication
- Default: false
- Description: Specifies whether challenge-response authentication is allowed (e.g. via PAM)
ssh_client_password_login
- Default: false
- Description:
true to allow password-based authentication with the ssh client
ssh_server_password_login
- Default: false
- Description:
true to allow password-based authentication with the ssh server
ssh_banner
- Default:
false
- Description:
true to print a banner on login
ssh_banner_path
- Default: '/etc/sshd/banner.txt'
- Description: path to the SSH banner file
ssh_client_hardening
- Default:
true
- Description:
false to stop harden the client
ssh_client_port
- Default:
'22'
- Description: Specifies the port number to connect on the remote host.
ssh_client_compression
- Default:
false
- Description: Specifies whether the client requests compression.
ssh_compression
- Default:
false
- Description: Specifies whether server-side compression is enabled after the user has authenticated successfully.
ssh_login_grace_time
- Default:
30s
- Description: specifies the time allowed for successful authentication to the SSH server
ssh_max_auth_retries
- Default:
2
- Description: Specifies the maximum number of authentication attempts permitted per connection.
ssh_max_sessions
- Default:
10
- Description: Specifies the maximum number of open sessions permitted from a given connection.
ssh_print_debian_banner
- Default:
false
- Description:
true to print debian specific banner
ssh_server_enabled
- Default:
true
- Description:
false to disable the opensshd server
ssh_server_hardening
- Default:
true
- Description:
false to stop harden the server
ssh_server_match_address
- Default: ''
- Description: Introduces a conditional block. If all of the criteria on the Match line are satisfied, the keywords on the following lines override those set in the global section of the config file, until either another Match line or the end of the file.
ssh_server_match_group
dev-sec/ansible-ssh-hardening
