xref: /netbsd-src/lib/libpam/modules/pam_echo/pam_echo.8 (revision 9601c032f2246b74d756ed05b35310ddd1f8324a)
1*9601c032Sjoerg.\" $NetBSD: pam_echo.8,v 1.3 2010/05/13 23:07:46 joerg Exp $
26f11bdf1Schristos.\" Copyright (c) 2001,2003 Networks Associates Technology, Inc.
36f11bdf1Schristos.\" All rights reserved.
46f11bdf1Schristos.\"
56f11bdf1Schristos.\" Portions of this software were developed for the FreeBSD Project by
66f11bdf1Schristos.\" ThinkSec AS and NAI Labs, the Security Research Division of Network
76f11bdf1Schristos.\" Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
86f11bdf1Schristos.\" ("CBOSS"), as part of the DARPA CHATS research program.
96f11bdf1Schristos.\"
106f11bdf1Schristos.\" Redistribution and use in source and binary forms, with or without
116f11bdf1Schristos.\" modification, are permitted provided that the following conditions
126f11bdf1Schristos.\" are met:
136f11bdf1Schristos.\" 1. Redistributions of source code must retain the above copyright
146f11bdf1Schristos.\"    notice, this list of conditions and the following disclaimer.
156f11bdf1Schristos.\" 2. Redistributions in binary form must reproduce the above copyright
166f11bdf1Schristos.\"    notice, this list of conditions and the following disclaimer in the
176f11bdf1Schristos.\"    documentation and/or other materials provided with the distribution.
186f11bdf1Schristos.\" 3. The name of the author may not be used to endorse or promote
196f11bdf1Schristos.\"    products derived from this software without specific prior written
206f11bdf1Schristos.\"    permission.
216f11bdf1Schristos.\"
226f11bdf1Schristos.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
236f11bdf1Schristos.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
246f11bdf1Schristos.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
256f11bdf1Schristos.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
266f11bdf1Schristos.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
276f11bdf1Schristos.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
286f11bdf1Schristos.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
296f11bdf1Schristos.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
306f11bdf1Schristos.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
316f11bdf1Schristos.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
326f11bdf1Schristos.\" SUCH DAMAGE.
336f11bdf1Schristos.\"
346f11bdf1Schristos.\" $FreeBSD: src/lib/libpam/modules/pam_echo/pam_echo.8,v 1.4 2004/07/02 23:52:16 ru Exp $
356f11bdf1Schristos.\"
366f11bdf1Schristos.Dd February 6, 2003
376f11bdf1Schristos.Dt PAM_ECHO 8
386f11bdf1Schristos.Os
396f11bdf1Schristos.Sh NAME
406f11bdf1Schristos.Nm pam_echo
416f11bdf1Schristos.Nd Echo PAM module
426f11bdf1Schristos.Sh SYNOPSIS
436f11bdf1Schristos.Op Ar service-name
446f11bdf1Schristos.Ar module-type
456f11bdf1Schristos.Ar control-flag
466f11bdf1Schristos.Pa pam_echo
476f11bdf1Schristos.Op Ar arguments
486f11bdf1Schristos.Sh DESCRIPTION
496f11bdf1SchristosThe echo service module for PAM displays its arguments to the user,
506f11bdf1Schristosseparated by spaces, using the current conversation function.
516f11bdf1Schristos.Pp
526f11bdf1SchristosIf the
536f11bdf1Schristos.Cm %
546f11bdf1Schristoscharacter occurs anywhere in the arguments to
556f11bdf1Schristos.Nm ,
566f11bdf1Schristosit is assumed to introduce one of the following escape sequences:
576f11bdf1Schristos.Bl -tag -width 4n
586f11bdf1Schristos.It Cm %H
596f11bdf1SchristosThe name of the host on which the client runs
606f11bdf1Schristos.Pq Dv PAM_RHOST .
616f11bdf1Schristos.\".It Cm %h
626f11bdf1Schristos.\"The name of the host on which the server runs.
636f11bdf1Schristos.It Cm %s
646f11bdf1SchristosThe current service name
656f11bdf1Schristos.Pq Dv PAM_SERVICE .
666f11bdf1Schristos.It Cm %t
676f11bdf1SchristosThe name of the controlling tty
686f11bdf1Schristos.Pq Dv PAM_TTY .
69*9601c032Sjoerg.It Cm \&%U
706f11bdf1SchristosThe applicant's user name
716f11bdf1Schristos.Pq Dv PAM_RUSER .
726f11bdf1Schristos.It Cm %u
736f11bdf1SchristosThe target account's user name
746f11bdf1Schristos.Pq Dv PAM_USER .
756f11bdf1Schristos.El
766f11bdf1Schristos.Pp
776f11bdf1SchristosAny other two-character sequence beginning with
786f11bdf1Schristos.Cm %
796f11bdf1Schristosexpands to the character following the
806f11bdf1Schristos.Cm %
816f11bdf1Schristoscharacter.
826f11bdf1Schristos.Sh SEE ALSO
836f11bdf1Schristos.Xr pam.conf 5 ,
846f11bdf1Schristos.Xr pam 8
856f11bdf1Schristos.Sh AUTHORS
866f11bdf1SchristosThe
876f11bdf1Schristos.Nm
886f11bdf1Schristosmodule and this manual page were developed for the
896f11bdf1Schristos.Fx
906f11bdf1SchristosProject by
916f11bdf1SchristosThinkSec AS and NAI Labs, the Security Research Division of Network
926f11bdf1SchristosAssociates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
936f11bdf1Schristos.Pq Dq CBOSS ,
946f11bdf1Schristosas part of the DARPA CHATS research program.
95