summaryrefslogtreecommitdiffstats
path: root/roles/ssh/README.md
diff options
context:
space:
mode:
authorAhmed Abdelhalim <[email protected]>2025-08-11 00:32:01 +0200
committerAhmed Abdelhalim <[email protected]>2025-08-11 00:32:01 +0200
commitc89c0b2d8af32d6f3f4f2b42efc6a9511fa4aefc (patch)
tree43c4e64ec450e05787fa35906d2ec4327b4df09c /roles/ssh/README.md
parentb9b0620b988870525b9972b537b8e22a0c6499af (diff)
Add ssh role
Diffstat (limited to 'roles/ssh/README.md')
-rw-r--r--roles/ssh/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/roles/ssh/README.md b/roles/ssh/README.md
new file mode 100644
index 00000000..7786808a
--- /dev/null
+++ b/roles/ssh/README.md
@@ -0,0 +1,23 @@
+# Ansible Role: ssh
+
+This role configure the ssh functionality of a linux distro with hardening
+
+## Role Variables
+
+- `username` the user account to be added to the ssh allowed users.
+- `ssh_port` the port number to be enabled for ssh (default: 2222)
+
+## Internals
+
+- ensure that ssh packages is installed and enabled
+- configure ssh host keys
+- configure ssh defaults
+ - disable keyboard interactive authentication
+ - disable PAM authentication
+- configure ssh authentication policy (hardened)
+ - configure custom ssh port
+ - disable password authentication
+ - require public key authentication
+ - disable root login
+- add user (username) to allowed authentication users
+- TBA: `fail2ban`