summaryrefslogtreecommitdiffstats
path: root/system/pam_ssh_agent_auth/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/pam_ssh_agent_auth/README')
-rw-r--r--system/pam_ssh_agent_auth/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/system/pam_ssh_agent_auth/README b/system/pam_ssh_agent_auth/README
new file mode 100644
index 0000000000..138f027d4c
--- /dev/null
+++ b/system/pam_ssh_agent_auth/README
@@ -0,0 +1,9 @@
+This module provides authentication via ssh-agent.
+
+It may take 5 arguments, file=/path/to/authorized_keys, debug,
+allow_user_owned_authorized_keys_file,
+authorized_keys_command=/path/to/command and
+authorized_keys_user=username. If an ssh-agent listening at
+SSH_AUTH_SOCK can successfully authenticate that it has the secret key
+for a public key in the specified file, authentication is granted,
+otherwise authentication fails.