logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

pam_echo - PAM module for printing text messages

Author

       Thorsten Kukuk <kukuk@thkukuk.de>

Linux-PAM                                          07/03/2025                                        PAM_ECHO(8)

Description

       The pam_echo PAM module is for printing text messages to inform user about special things. Sequences
       starting with the % character are interpreted in the following way:

       %H
           The name of the remote host (PAM_RHOST).

       %h
           The name of the local host.

       %s
           The service name (PAM_SERVICE).

       %t
           The name of the controlling terminal (PAM_TTY).

       %U
           The remote user name (PAM_RUSER).

       %u
           The local user name (PAM_USER).

       All other sequences beginning with % expands to the characters following the % character.

Examples

       For an example of the use of this module, we show how it may be used to print information about good
       passwords:

           password optional pam_echo.so file=/usr/share/doc/good-password.txt
           password required pam_unix.so

Module Types Provided

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

Name

       pam_echo - PAM module for printing text messages

Options

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

Return Values

       PAM_BUF_ERR
           Memory buffer error.

       PAM_SUCCESS
           Message was successful printed.

       PAM_IGNORE
           PAM_SILENT flag was given or message file does not exist, no message printed.

See Also

pam.conf(8), pam.d(5), pam(7)

Synopsis

pam_echo.so [file=/path/message]

See Also