xref: /freebsd/lib/libpam/modules/pam_echo/pam_echo.8 (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
1.\" Copyright (c) 2001,2003 Networks Associates Technology, Inc.
2.\" All rights reserved.
3.\"
4.\" Portions of this software were developed for the FreeBSD Project by
5.\" ThinkSec AS and NAI Labs, the Security Research Division of Network
6.\" Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
7.\" ("CBOSS"), as part of the DARPA CHATS research program.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. The name of the author may not be used to endorse or promote
18.\"    products derived from this software without specific prior written
19.\"    permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31.\" SUCH DAMAGE.
32.\"
33.Dd February 6, 2003
34.Dt PAM_ECHO 8
35.Os
36.Sh NAME
37.Nm pam_echo
38.Nd Echo PAM module
39.Sh SYNOPSIS
40.Op Ar service-name
41.Ar module-type
42.Ar control-flag
43.Pa pam_echo
44.Op Ar arguments
45.Sh DESCRIPTION
46The echo service module for PAM displays its arguments to the user,
47separated by spaces, using the current conversation function.
48.Pp
49If the
50.Cm %
51character occurs anywhere in the arguments to
52.Nm ,
53it is assumed to introduce one of the following escape sequences:
54.Bl -tag -width 4n
55.It Cm %H
56The name of the host on which the client runs
57.Pq Dv PAM_RHOST .
58.\".It Cm %h
59.\"The name of the host on which the server runs.
60.It Cm %s
61The current service name
62.Pq Dv PAM_SERVICE .
63.It Cm %t
64The name of the controlling tty
65.Pq Dv PAM_TTY .
66.It Cm \&%U
67The applicant's user name
68.Pq Dv PAM_RUSER .
69.It Cm %u
70The target account's user name
71.Pq Dv PAM_USER .
72.El
73.Pp
74Any other two-character sequence beginning with
75.Cm %
76expands to the character following the
77.Cm %
78character.
79.Sh SEE ALSO
80.Xr pam.conf 5 ,
81.Xr pam 3
82.Sh AUTHORS
83The
84.Nm
85module and this manual page were developed for the
86.Fx
87Project by
88ThinkSec AS and NAI Labs, the Security Research Division of Network
89Associates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
90.Pq Dq CBOSS ,
91as part of the DARPA CHATS research program.
92