freebsd-dev/libexec/fingerd/fingerd.8

.\" Copyright (c) 1980, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)fingerd.8	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd November 19, 2014
.Dt FINGERD 8
.Os
.Sh NAME
.Nm fingerd
.Nd remote user information server
.Sh SYNOPSIS
.Nm
.Op Fl d
.Op Fl k
.Op Fl s
.Op Fl l
.Op Fl p Ar filename
.Sh DESCRIPTION
The
.Nm
utility uses a simple protocol based on
.%T RFC1196
that provides an interface to
.Xr finger 1
at several network sites.
It is supposed to return a friendly,
human-oriented status report on either the system at the moment
or a particular person in depth.
There is no required format and the
protocol consists mostly of specifying a single
.Dq "command line" ,
thus,
.Nm
can also be used to implement other protocols in conjunction with the
.Fl p
flag.
.Pp
The
.Nm
utility is started by
.Xr inetd 8 ,
which listens for
.Tn TCP
requests at port 79.
Once connected it reads a single command line
terminated by a
.Aq Tn CRLF
which is passed to
.Xr finger 1 .
The
.Nm
utility closes its connections as soon as the output is finished.
.Pp
If the line is null (i.e., just a
.Aq Tn CRLF
is sent) then
.Xr finger 1
returns a
.Dq default
report that lists all people logged into
the system at that moment.
.Pp
If a user name is specified (e.g.,\&
.Pf eric Aq Tn CRLF )
then the
response lists more extended information for only that particular user,
whether logged in or not.
Allowable
.Dq names
in the command line include both
.Dq login names
and
.Dq user names .
If a name is ambiguous, all possible derivations are returned.
.Pp
The following options may be passed to
.Nm
as server program arguments in
.Pa /etc/inetd.conf :
.Bl -tag -width indent
.It Fl d
Enable debugging mode.
In debugging mode,
.Nm
will not attempt any network-related operations on
.Va stdin ,
and it will print the full
.Nm finger
command line
to
.Va stderr
before executing it.
.It Fl k
Suppress login information.
See the description of the
.Fl k
option in
.Xr finger 1
for details.
.It Fl s
Enable secure mode.
Queries without a user name are rejected and
forwarding of queries to other remote hosts is denied.
.It Fl l
Enable logging.
The name of the host originating the query is reported via
.Xr syslog 3
at LOG_NOTICE priority.
.It Fl p
Use an alternate program as the local information provider.
The default local program
executed by
.Nm
is
.Xr finger 1 .
By specifying a customized local server,
this option allows a system manager
to have more control over what information is
provided to remote sites.
If
.Fl p
is specified,
.Nm
will also set the environment variable
.Ev FINGERD_REMOTE_HOST
to the name of the host making the request.
.El
.Sh SEE ALSO
.Xr finger 1 ,
.Xr inetd 8
.Sh HISTORY
The
.Nm
utility appeared in
.Bx 4.3 .
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.\" Copyright (c) 1980, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Remove the 3rd clause ("advertising clause") of the BSD license as permitted by the University of Berkeley on July 22, 1999. Reviewed by: imp MFC after: 1 week 2014-02-17 22:27:32 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)fingerd.8 8.1 (Berkeley) 6/4/93`
Add $FreeBSD$ lines to man pages that are missing them to make it easier for translation teams. PR: docs/13418 Submitted by: Alexey Zelkin <phantom@cris.net> 1999-08-28 23:10:20 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.\"`
I agree w/ tedu that this isn't a Bug.. it's like complaining that you can't use an ssh client to fetch a web page... Submitted by: tedu (via -tech) 2014-11-20 04:15:58 +00:00			`.Dd November 19, 2014`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Dt FINGERD 8`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 10:49:54 +00:00			`.Os`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Sh NAME`
			`.Nm fingerd`
			`.Nd remote user information server`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 14:42:24 +00:00			`.Nm`
Add a debugging option (-d) Add a -k option which fingerd(8) passes through to finger(1). MFC after: 2 weeks 2010-04-01 13:11:39 +00:00			`.Op Fl d`
			`.Op Fl k`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Op Fl s`
			`.Op Fl l`
			`.Op Fl p Ar filename`
			`.Sh DESCRIPTION`
The .Nm utility 2002-07-06 19:19:48 +00:00			`The`
			`.Nm`
Correct wrong grammar from previous commit. Note that fingerd is not limited to being an interface to finger(1), see -p flag. Remove a reference to name(?) program we don't have. Submitted by: wollman 2002-07-21 13:02:13 +00:00			`utility uses a simple protocol based on`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.%T RFC1196`
Correct wrong grammar from previous commit. Note that fingerd is not limited to being an interface to finger(1), see -p flag. Remove a reference to name(?) program we don't have. Submitted by: wollman 2002-07-21 13:02:13 +00:00			`that provides an interface to`
			`.Xr finger 1`
mdoc(7) police: nits. 2002-08-13 11:11:32 +00:00			`at several network sites.`
			`It is supposed to return a friendly,`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`human-oriented status report on either the system at the moment`
			`or a particular person in depth.`
			`There is no required format and the`
			`protocol consists mostly of specifying a single`
mdoc(7) police: nits. 2002-08-13 11:11:32 +00:00			`.Dq "command line" ,`
Correct wrong grammar from previous commit. Note that fingerd is not limited to being an interface to finger(1), see -p flag. Remove a reference to name(?) program we don't have. Submitted by: wollman 2002-07-21 13:02:13 +00:00			`thus,`
			`.Nm`
			`can also be used to implement other protocols in conjunction with the`
			`.Fl p`
			`flag.`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Pp`
The .Nm utility 2002-07-06 19:19:48 +00:00			`The`
			`.Nm`
			`utility is started by`
Correct some misleading text. Submitted by: Klaus Klein <kleink@layla.inka.de> Obtained from: NetBSD-bugs PR#3089 1997-01-08 07:12:47 +00:00			`.Xr inetd 8 ,`
			`which listens for`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Tn TCP`
			`requests at port 79.`
			`Once connected it reads a single command line`
			`terminated by a`
			`.Aq Tn CRLF`
			`which is passed to`
			`.Xr finger 1 .`
The .Nm utility 2002-07-06 19:19:48 +00:00			`The`
			`.Nm`
			`utility closes its connections as soon as the output is finished.`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Pp`
Mechanically kill hard sentence breaks. 2004-07-02 21:28:50 +00:00			`If the line is null (i.e., just a`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Aq Tn CRLF`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`is sent) then`
The .Nm utility 2002-07-06 19:19:48 +00:00			`.Xr finger 1`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`returns a`
			`.Dq default`
			`report that lists all people logged into`
			`the system at that moment.`
			`.Pp`
I agree w/ tedu that this isn't a Bug.. it's like complaining that you can't use an ssh client to fetch a web page... Submitted by: tedu (via -tech) 2014-11-20 04:15:58 +00:00			`If a user name is specified (e.g.,\&`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Pf eric Aq Tn CRLF )`
			`then the`
			`response lists more extended information for only that particular user,`
			`whether logged in or not.`
			`Allowable`
			`.Dq names`
			`in the command line include both`
			`.Dq login names`
			`and`
			`.Dq user names .`
			`If a name is ambiguous, all possible derivations are returned.`
			`.Pp`
			`The following options may be passed to`
Add const to copyright string. Put sccsid under #if 0/#endif control. 1997-11-20 07:26:04 +00:00			`.Nm`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`as server program arguments in`
			`.Pa /etc/inetd.conf :`
Add const to copyright string. Put sccsid under #if 0/#endif control. 1997-11-20 07:26:04 +00:00			`.Bl -tag -width indent`
Add a debugging option (-d) Add a -k option which fingerd(8) passes through to finger(1). MFC after: 2 weeks 2010-04-01 13:11:39 +00:00			`.It Fl d`
			`Enable debugging mode.`
			`In debugging mode,`
			`.Nm`
			`will not attempt any network-related operations on`
			`.Va stdin ,`
			`and it will print the full`
			`.Nm finger`
			`command line`
			`to`
			`.Va stderr`
			`before executing it.`
			`.It Fl k`
			`Suppress login information.`
			`See the description of the`
			`.Fl k`
			`option in`
			`.Xr finger 1`
			`for details.`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.It Fl s`
			`Enable secure mode.`
			`Queries without a user name are rejected and`
			`forwarding of queries to other remote hosts is denied.`
			`.It Fl l`
			`Enable logging.`
			`The name of the host originating the query is reported via`
			`.Xr syslog 3`
			`at LOG_NOTICE priority.`
			`.It Fl p`
			`Use an alternate program as the local information provider.`
			`The default local program`
			`executed by`
Add const to copyright string. Put sccsid under #if 0/#endif control. 1997-11-20 07:26:04 +00:00			`.Nm`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`is`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Xr finger 1 .`
			`By specifying a customized local server,`
			`this option allows a system manager`
			`to have more control over what information is`
			`provided to remote sites.`
When the -p flag is specified, set an environment variable to the name of the remote host (or rather, the name as mangled by realhostname_sa()) so that the process can use it to behave differently depending on the origin on the request. We use this to implement rudimentary visibility control on our user information. Make sure that the child process's standard error goes through the same NVT-ASCII filter as is applied to the standard output. Don't attempt to call logerr() from the child since stdio is not safe in a vforked process. Just write a message to fd 2 instead. (Ideally, the parent would open two pipes, and siphon off our stderr to some place less public, but I have not attempted to do so in this implementation.) 2002-06-26 21:46:56 +00:00			`If`
			`.Fl p`
			`is specified,`
			`.Nm`
			`will also set the environment variable`
			`.Ev FINGERD_REMOTE_HOST`
			`to the name of the host making the request.`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.El`
			`.Sh SEE ALSO`
Correct some misleading text. Submitted by: Klaus Klein <kleink@layla.inka.de> Obtained from: NetBSD-bugs PR#3089 1997-01-08 07:12:47 +00:00			`.Xr finger 1 ,`
			`.Xr inetd 8`
Sort sections. 2005-01-18 09:29:40 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`utility appeared in`
			`.Bx 4.3 .`