.github | ||
defaults | ||
handlers | ||
meta | ||
tasks | ||
templates | ||
vars | ||
.gitignore | ||
.yamllint | ||
LICENCE | ||
README.md |
OpenSSH Server
Ansible role to configure the OpenSSH Server SSHD
.
The main goal of this role is to manage the sshd.conf file. And some additional parts like deploying the defined ssh host keys at the configured path.
Pro Tipp
Use Eliptic cureve cryptografie for your ssh keys:
ssh-keygen -t ed25519
The default values of this role will only allow ed25519 keys. But you can change that obviously if you like.
combinations
It is highly recomended to use this role together with a role to manage users and to manage the sshd configuration.
The following roles are tested in combination and work well - at least for the user DO1JLR:
- github.com/chaos-bodensee/role-manage_users
- github.com/chaos-bodensee/role-ssh_authorized_keys
- github.com/roles-ansible/ansible_role_sshd (this one)
Some Variables explained
Remember: Have a look into defaults/main.yml
for all possible variables.
-
SSH Port
The OpenSSH Port is defined with the variablesshd__port: 22
. Change it if you wish. -
Allowed Users and Groups
The default users that are allowd to login come from theusers: {}
list.
The sameusers: {}
variable is used in the other recomended ssh roles.
A example to allow the login for the users and groups calledl3d
andottojo
are:
users:
l3d:
- l3d
ottojo:
- ottojo@uni
- ottojo@home
-
SSH Login via Passwort
The SSH Passwort auth is set to false viasshd__password_authentication: false
. This won't allow you to use your passwort to login via SSH. -
Manage SSH Key Types
By default this role configure which ssh key types are allowed to login. If you don't want to define that change thesshd__manage_key_types: true
variable. -
Define allowed ssh key types
The allowed SSH Key Types are defined with this list. Some of them are commented out.
Please not that by defualt onlyed25519
keys are allowed. Keep that in mind if you are using a rsa key.
sshd__key_types:
- 'ed25519'
# - 'rsa'
# - 'ecdsa'
# - 'dsa' # (do not use!)
-
Advanced SSH Algorithm Settings
You can define the used Key and Kex Algorithm here to. For the default values and some examples for the variablessshd__key_algorithmus
andsshd__kex_algorithmus
have a look intodefaults/main.yml
. -
force new SSH Features
If you know that you use a ssh version>8
you can optionally define it withtrue/false
with thesshd__version_is_above_eight
variable.
Files
The main task of this role is to configure the sshd.conf
file.
References
Testing
This role is tested with some linting tests. Sadly I don't know how to run this role in a docker container because systemd is involved... If you have ideas how to improve testing please dend me a message, open a issue or Pull Request. If you want to find out more about our tests, please have a look at the github marketplace.
test status | Github Marketplace |
---|---|
publish-ansible-role-to-galaxy | |
yamllint-github-action | |
ansible-lint action |