xref: /dflybsd-src/lib/libpam/modules/pam_echo/pam_echo.8 (revision c98db40744766ab0803912f29557df02814bcd9d)
1242be47eSzrj.\" Copyright (c) 2001,2003 Networks Associates Technology, Inc.
2242be47eSzrj.\" All rights reserved.
3242be47eSzrj.\"
4242be47eSzrj.\" Portions of this software were developed for the FreeBSD Project by
5242be47eSzrj.\" ThinkSec AS and NAI Labs, the Security Research Division of Network
6242be47eSzrj.\" Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
7242be47eSzrj.\" ("CBOSS"), as part of the DARPA CHATS research program.
8242be47eSzrj.\"
9242be47eSzrj.\" Redistribution and use in source and binary forms, with or without
10242be47eSzrj.\" modification, are permitted provided that the following conditions
11242be47eSzrj.\" are met:
12242be47eSzrj.\" 1. Redistributions of source code must retain the above copyright
13242be47eSzrj.\"    notice, this list of conditions and the following disclaimer.
14242be47eSzrj.\" 2. Redistributions in binary form must reproduce the above copyright
15242be47eSzrj.\"    notice, this list of conditions and the following disclaimer in the
16242be47eSzrj.\"    documentation and/or other materials provided with the distribution.
17242be47eSzrj.\" 3. The name of the author may not be used to endorse or promote
18242be47eSzrj.\"    products derived from this software without specific prior written
19242be47eSzrj.\"    permission.
20242be47eSzrj.\"
21242be47eSzrj.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22242be47eSzrj.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23242be47eSzrj.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24242be47eSzrj.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25242be47eSzrj.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26242be47eSzrj.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27242be47eSzrj.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28242be47eSzrj.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29242be47eSzrj.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30242be47eSzrj.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31242be47eSzrj.\" SUCH DAMAGE.
32242be47eSzrj.\"
33*c98db407SSascha Wildner.\" $FreeBSD: head/lib/libpam/modules/pam_echo/pam_echo.8 203958 2010-02-16 12:29:02Z ru $
34242be47eSzrj.\"
35242be47eSzrj.Dd February 6, 2003
36242be47eSzrj.Dt PAM_ECHO 8
37242be47eSzrj.Os
38242be47eSzrj.Sh NAME
39242be47eSzrj.Nm pam_echo
40242be47eSzrj.Nd Echo PAM module
41242be47eSzrj.Sh SYNOPSIS
42242be47eSzrj.Op Ar service-name
43242be47eSzrj.Ar module-type
44242be47eSzrj.Ar control-flag
45242be47eSzrj.Pa pam_echo
46242be47eSzrj.Op Ar arguments
47242be47eSzrj.Sh DESCRIPTION
48242be47eSzrjThe echo service module for PAM displays its arguments to the user,
49242be47eSzrjseparated by spaces, using the current conversation function.
50242be47eSzrj.Pp
51242be47eSzrjIf the
52242be47eSzrj.Cm %
53242be47eSzrjcharacter occurs anywhere in the arguments to
54242be47eSzrj.Nm ,
55242be47eSzrjit is assumed to introduce one of the following escape sequences:
56242be47eSzrj.Bl -tag -width 4n
57242be47eSzrj.It Cm %H
58242be47eSzrjThe name of the host on which the client runs
59242be47eSzrj.Pq Dv PAM_RHOST .
60242be47eSzrj.\".It Cm %h
61242be47eSzrj.\"The name of the host on which the server runs.
62242be47eSzrj.It Cm %s
63242be47eSzrjThe current service name
64242be47eSzrj.Pq Dv PAM_SERVICE .
65242be47eSzrj.It Cm %t
66242be47eSzrjThe name of the controlling tty
67242be47eSzrj.Pq Dv PAM_TTY .
68*c98db407SSascha Wildner.It Cm \&%U
69242be47eSzrjThe applicant's user name
70242be47eSzrj.Pq Dv PAM_RUSER .
71242be47eSzrj.It Cm %u
72242be47eSzrjThe target account's user name
73242be47eSzrj.Pq Dv PAM_USER .
74242be47eSzrj.El
75242be47eSzrj.Pp
76242be47eSzrjAny other two-character sequence beginning with
77242be47eSzrj.Cm %
78242be47eSzrjexpands to the character following the
79242be47eSzrj.Cm %
80242be47eSzrjcharacter.
81242be47eSzrj.Sh SEE ALSO
82dfc0c85aSSascha Wildner.Xr pam 3 ,
83dfc0c85aSSascha Wildner.Xr pam.conf 5
84242be47eSzrj.Sh AUTHORS
85242be47eSzrjThe
86242be47eSzrj.Nm
87242be47eSzrjmodule and this manual page were developed for the
88242be47eSzrj.Fx
89242be47eSzrjProject by
90242be47eSzrjThinkSec AS and NAI Labs, the Security Research Division of Network
91242be47eSzrjAssociates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
92242be47eSzrj.Pq Dq CBOSS ,
93242be47eSzrjas part of the DARPA CHATS research program.
94