blob: ef76b022d002ae8a4b6751c3ffb3cbba57385e71 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id='pam_echo'>
<refmeta>
<refentrytitle>pam_echo</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
</refmeta>
<refnamediv id='pam_echo-name'>
<refname>pam_echo</refname>
<refpurpose>PAM module for printing text messages</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv>
<cmdsynopsis id="pam_echo-cmdsynopsis">
<command>pam_echo.so</command>
<arg choice="opt">
file=<replaceable>/path/message</replaceable>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='pam_echo-description'>
<title>DESCRIPTION</title>
<para>
The <emphasis>pam_echo</emphasis> PAM module is for printing
text messages to inform user about special things. Sequences
starting with the <emphasis>%</emphasis> character are
interpreted in the following way:
</para>
<variablelist>
<varlistentry>
<term><emphasis>%H</emphasis></term>
<listitem>
<para>The name of the remote host (PAM_RHOST).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis>%h</emphasis></term>
<listitem>
<para>The name of the local host.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis>%s</emphasis></term>
<listitem>
<para>The service name (PAM_SERVICE).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis>%t</emphasis></term>
<listitem>
<para>The name of the controlling terminal (PAM_TTY).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis>%U</emphasis></term>
<listitem>
<para>The remote user name (PAM_RUSER).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis>%u</emphasis></term>
<listitem>
<para>The local user name (PAM_USER).</para>
</listitem>
</varlistentry>
</variablelist>
<para>
All other sequences beginning with <emphasis>%</emphasis>
expands to the characters following the <emphasis>%</emphasis>
character.
</para>
</refsect1>
<refsect1 id='pam_echo-options'>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>
<option>file=<replaceable>/path/message</replaceable></option>
</term>
<listitem>
<para>
The content of the file <filename>/path/message</filename>
will be printed with the PAM conversion function as PAM_TEXT_INFO.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="pam_echo-types">
<title>MODULE TYPES PROVIDED</title>
<para>
All module types (<option>auth</option>, <option>account</option>,
<option>password</option> and <option>session</option>) are provided.
</para>
</refsect1>
<refsect1 id="pam_echo-return_values">
<title>RETURN VALUES</title>
<variablelist>
<varlistentry>
<term>PAM_BUF_ERR</term>
<listitem>
<para>
Memory buffer error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_SUCCESS</term>
<listitem>
<para>
Message was successful printed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_IGNORE</term>
<listitem>
<para>
PAM_SILENT flag was given or message file does not
exist, no message printed.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='pam_echo-examples'>
<title>EXAMPLES</title>
<para>
For an example of the use of this module, we show how it may be
used to print information about good passwords:
<programlisting>
password optional pam_echo.so file=/usr/share/doc/good-password.txt
password required pam_unix.so
</programlisting>
</para>
</refsect1>
<refsect1 id='pam_echo-see_also'><title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>pam.conf</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
</citerefentry></para>
</refsect1>
<refsect1 id='pam_echo-author'>
<title>AUTHOR</title>
<para>Thorsten Kukuk <kukuk@thkukuk.de></para>
</refsect1>
</refentry>
|
