xref: /freebsd/lib/libpam/modules/pam_echo/pam_echo.8 (revision f0adf7f5cdd241db2f2c817683191a6ef64a4e95)
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.\" $FreeBSD$
34.\"
35.Dd February 6, 2003
36.Dt PAM_ECHO 8
37.Os
38.Sh NAME
39.Nm pam_echo
40.Nd Echo PAM module
41.Sh SYNOPSIS
42.Op Ar service-name
43.Ar module-type
44.Ar control-flag
45.Pa pam_echo
46.Op Ar arguments
47.Sh DESCRIPTION
48The echo service module for PAM displays its arguments to the user,
49separated by spaces, using the current conversation function.
50.Pp
51If the
52.Cm %
53character occurs anywhere in the arguments to
54.Nm ,
55it is assumed to introduce one of the following escape sequences:
56.Bl -tag -width 4n
57.It Cm %H
58The name of the host on which the client runs
59.Pq Dv PAM_RHOST .
60.\".It Cm %h
61.\"The name of the host on which the server runs.
62.It Cm %s
63The current service name
64.Pq Dv PAM_SERVICE .
65.It Cm %t
66The name of the controlling tty
67.Pq Dv PAM_TTY .
68.It Cm %U
69The applicant's user name
70.Pq Dv PAM_RUSER .
71.It Cm %u
72The target account's user name
73.Pq Dv PAM_USER .
74.El
75.Pp
76Any other two-character sequence beginning with
77.Cm %
78expands to the character following the
79.Cm %
80character.
81.Sh SEE ALSO
82.Xr pam.conf 5 ,
83.Xr pam 8
84.Sh AUTHORS
85The
86.Nm
87module and this manual page were developed for the
88.Fx
89Project by
90ThinkSec AS and NAI Labs, the Security Research Division of Network
91Associates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
92.Pq Dq CBOSS ,
93as part of the DARPA CHATS research program.
94