man-pages/man8/pam_echo.8.html
2021-03-31 01:06:50 +01:00

204 lines
3.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of PAM_ECHO</TITLE>
</HEAD><BODY>
<H1>PAM_ECHO</H1>
Section: Linux-PAM Manual (8)<BR>Updated: 05/18/2017<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
pam_echo - PAM module for printing text messages
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<DL COMPACT>
<DT id="1">
<B>pam_echo.so</B> [file=<I>/path/message</I>]
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<DD>The
<I>pam_echo</I>
PAM module is for printing text messages to inform user about special things. Sequences starting with the
<I>%</I>
character are interpreted in the following way:
<P>
<I>%H</I>
<DL COMPACT><DT id="2"><DD>
The name of the remote host (PAM_RHOST).
</DL>
<P>
<I>%h</I>
<DL COMPACT><DT id="3"><DD>
The name of the local host.
</DL>
<P>
<I>%s</I>
<DL COMPACT><DT id="4"><DD>
The service name (PAM_SERVICE).
</DL>
<P>
<I>%t</I>
<DL COMPACT><DT id="5"><DD>
The name of the controlling terminal (PAM_TTY).
</DL>
<P>
<I>%U</I>
<DL COMPACT><DT id="6"><DD>
The remote user name (PAM_RUSER).
</DL>
<P>
<I>%u</I>
<DL COMPACT><DT id="7"><DD>
The local user name (PAM_USER).
</DL>
<P>
All other sequences beginning with
<I>%</I>
expands to the characters following the
<I>%</I>
character.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
<B>file=</B><B></B><I>/path/message</I>
<DL COMPACT><DT id="8"><DD>
The content of the file
/path/message
will be printed with the PAM conversion function as PAM_TEXT_INFO.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>MODULE TYPES PROVIDED</H2>
<P>
All module types (<B>auth</B>,
<B>account</B>,
<B>password</B>
and
<B>session</B>) are provided.
<A NAME="lbAG">&nbsp;</A>
<H2>RETURN VALUES</H2>
<P>
PAM_BUF_ERR
<DL COMPACT><DT id="9"><DD>
Memory buffer error.
</DL>
<P>
PAM_SUCCESS
<DL COMPACT><DT id="10"><DD>
Message was successful printed.
</DL>
<P>
PAM_IGNORE
<DL COMPACT><DT id="11"><DD>
PAM_SILENT flag was given or message file does not exist, no message printed.
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>EXAMPLES</H2>
<P>
For an example of the use of this module, we show how it may be used to print information about good passwords:
<P>
<DL COMPACT><DT id="12"><DD>
<PRE>
password optional pam_echo.so file=/usr/share/doc/good-password.txt
password required pam_unix.so
</PRE>
</DL>
<P>
<A NAME="lbAI">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?8+pam.conf">pam.conf</A></B>(8),
<B><A HREF="/cgi-bin/man/man2html?5+pam.d">pam.d</A></B>(5),
<B><A HREF="/cgi-bin/man/man2html?7+pam">pam</A></B>(7)
<A NAME="lbAJ">&nbsp;</A>
<H2>AUTHOR</H2>
<P>
Thorsten Kukuk &lt;<A HREF="mailto:kukuk@thkukuk.de">kukuk@thkukuk.de</A>&gt;
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="13"><A HREF="#lbAB">NAME</A><DD>
<DT id="14"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="15"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="16"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="17"><A HREF="#lbAF">MODULE TYPES PROVIDED</A><DD>
<DT id="18"><A HREF="#lbAG">RETURN VALUES</A><DD>
<DT id="19"><A HREF="#lbAH">EXAMPLES</A><DD>
<DT id="20"><A HREF="#lbAI">SEE ALSO</A><DD>
<DT id="21"><A HREF="#lbAJ">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:14 GMT, March 31, 2021
</BODY>
</HTML>