pam_echo(8)

1PAM_ECHO(8)                    Linux-PAM Manual                    PAM_ECHO(8)
2
3
4

NAME

6       pam_echo - PAM module for printing text messages
7

SYNOPSIS

9       pam_echo.so [file=/path/message]
10

DESCRIPTION

12       The pam_echo PAM module is for printing text messages to inform user
13       about special things. Sequences starting with the % character are
14       interpreted in the following way:
15
16       %H
17           The name of the remote host (PAM_RHOST).
18
19       %h
20           The name of the local host.
21
22       %s
23           The service name (PAM_SERVICE).
24
25       %t
26           The name of the controlling terminal (PAM_TTY).
27
28       %U
29           The remote user name (PAM_RUSER).
30
31       %u
32           The local user name (PAM_USER).
33
34       All other sequences beginning with % expands to the characters
35       following the % character.
36

OPTIONS

38       file=/path/message
39           The content of the file /path/message will be printed with the PAM
40           conversion function as PAM_TEXT_INFO.
41

MODULE TYPES PROVIDED

43       All module types (auth, account, password and session) are provided.
44

RETURN VALUES

46       PAM_BUF_ERR
47           Memory buffer error.
48
49       PAM_SUCCESS
50           Message was successful printed.
51
52       PAM_IGNORE
53           PAM_SILENT flag was given or message file does not exist, no
54           message printed.
55

EXAMPLES

57       For an example of the use of this module, we show how it may be used to
58       print information about good passwords:
59
60           password optional pam_echo.so file=/usr/share/doc/good-password.txt
61           password required pam_unix.so
62
63
64

AUTHOR

69       Thorsten Kukuk <kukuk@thkukuk.de>
70
71
72
73Linux-PAM                         05/07/2023                       PAM_ECHO(8)