aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBastien Nocera <hadess@hadess.net>2020-03-04 12:50:29 +0100
committerAndreas Schneider <asn@samba.org>2020-03-19 12:43:28 +0100
commit00c1573119ca5eb909b800f4d85f939518e1e3a0 (patch)
tree1dfc4fcf504f745beb246767feb818e1ad92af92
parentb3151fa71d9ff5432eb0a3645e4406277f992ecc (diff)
downloadpam_wrapper-00c1573119ca5eb909b800f4d85f939518e1e3a0.tar.gz
pam_wrapper-00c1573119ca5eb909b800f4d85f939518e1e3a0.tar.xz
pam_wrapper-00c1573119ca5eb909b800f4d85f939518e1e3a0.zip
doc: Add pam_chatty man page source
Signed-off-by: Bastien Nocera <hadess@hadess.net> Reviewed-by: Andreas Schneider <asn@samba.org> Reviewed-by: Ralph Boehme <slow@samba.org>
-rw-r--r--doc/pam_chatty.8.txt46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/pam_chatty.8.txt b/doc/pam_chatty.8.txt
new file mode 100644
index 0000000..a30f2cd
--- /dev/null
+++ b/doc/pam_chatty.8.txt
@@ -0,0 +1,46 @@
+pam_chatty(8)
+===============
+:revdate: 2020-03-05
+
+NAME
+----
+
+pam_chatty - A PAM test module that generates PAM info and error messages.
+
+SYNOPSIS
+--------
+pam_chatty.so [...]
+
+DESCRIPTION
+-----------
+The *pam_chatty* module makes it easy to replicate the behaviour of PAM
+modules that generate a lot of output, in order to ensure that PAM clients
+react as expected.
+
+IMPORTANT
+---------
+pam_chatty is a *test tool*. It should be considered completely insecure
+and never used outside test environments! As you'll see when reading
+description of the options, many of them don't make any sense
+in the real world and were added just to make tests possible.
+
+The pam_chatty module generates a lot of PAM info and error output, when
+its authentication method is called, and then returns success.
+
+OPTIONS
+-------
+* *num_lines=NUMBER* - the number of lines of messages to output, for each
+one of the enabled types of messages selected.
+
+* *error* - whether to output error level messages.
+
+* *info* - whether to output info level messages.
+
+MODULE TYPES PROVIDED
+---------------------
+Only the *auth* module type is supported.
+
+EXAMPLE
+-------
+[source,bash]
+auth required pam_chatty.so num_lines=16 info error