xref: /openbsd/libexec/fingerd/fingerd.8 (revision 78b63d65)
1.\"	$OpenBSD: fingerd.8,v 1.12 2001/11/13 14:06:09 mpech Exp $
2.\"
3.\" Copyright (c) 1980, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     from: @(#)fingerd.8	8.1 (Berkeley) 6/4/93
35.\"	$Id: fingerd.8,v 1.12 2001/11/13 14:06:09 mpech Exp $
36.\"
37.Dd June 4, 1993
38.Dt FINGERD 8
39.Os
40.Sh NAME
41.Nm fingerd
42.Nd remote user information server
43.Sh SYNOPSIS
44.Nm fingerd
45.Op Fl s
46.Op Fl l
47.Op Fl u
48.Op Fl m
49.Op Fl M
50.Op Fl p
51.Op Fl S
52.Op Fl P Ar filename
53.Sh DESCRIPTION
54.Nm
55is a simple protocol based on
56.%T RFC1288
57that provides an interface to the
58Name and Finger programs at several network sites.
59The program is supposed to return a friendly,
60human-oriented status report on either the system at the moment
61or a particular person in depth.
62There is no required format and the
63protocol consists mostly of specifying a single
64.Dq command line .
65.Pp
66.Nm
67is started by
68.Xr inetd 8 ,
69which listens for
70.Tn TCP
71requests at port 79.
72Once connected it reads a single command line
73terminated by a
74.Aq Tn CRLF
75which is passed to
76.Xr finger 1 .
77.Nm
78closes its connections as soon as the output is finished.
79.Pp
80If the line is null (i.e., just a
81.Aq Tn CRLF
82is sent) then
83.Xr finger 1
84returns a
85.Dq default
86report that lists all people logged into
87the system at that moment.
88.Pp
89If a user name is specified (e.g.,
90.Pf eric Aq Tn CRLF )
91then the
92response lists more extended information for only that particular user,
93whether logged in or not.
94Allowable
95.Dq names
96in the command line include both
97.Dq login names
98and
99.Dq user names .
100If a name is ambiguous, all possible derivations are returned.
101.Pp
102The following options may be passed to
103.Nm
104as server program arguments in
105.Pa /etc/inetd.conf :
106.Bl -tag -width Ds
107.It Fl s
108Enable secure mode.
109Forwarding of queries to other remote hosts is denied.
110.It Fl l
111Enable logging.
112The name of the host originating the query is reported via
113.Xr syslog 3
114at LOG_NOTICE priority.
115.It Fl u
116Queries without a user name are rejected.
117.It Fl m
118Prevent matching of
119.Ar user
120names.
121.Ar User
122is usually a login name; however, matching will also be done on the
123users' real names, unless the
124.Fl m
125option is supplied.
126.It Fl M
127Enables matching of
128.Ar user
129names.
130This is disabled by default if the system is running YP.
131.It Fl p
132Prevents
133.Nm
134from displaying the contents of the
135.Dq Pa .plan
136and
137.Dq Pa .project
138files.
139.It Fl S
140Prints user information in short mode, one line per user.
141This overrides the
142.Dq Pa Whois switch
143that may be passed in from the remote client.
144.It Fl P Ar filename
145Use an alternate program as the local information provider.
146The default local program
147executed by
148.Nm
149is
150.Xr finger 1 .
151By specifying a customized local server,
152this option allows a system manager
153to have more control over what information is
154provided to remote sites.
155.El
156.Sh SEE ALSO
157.Xr finger 1 ,
158.Xr inetd 8
159.Sh HISTORY
160The
161.Nm
162command appeared in
163.Bx 4.3 .
164.Sh BUGS
165Connecting directly to the server from a
166.Tn TIP
167or an equally narrow-minded
168.Tn TELNET Ns \-protocol
169user program can result
170in meaningless attempts at option negotiation being sent to the
171server, which will foul up the command line interpretation.
172.Nm
173should be taught to filter out
174.Tn IAC Ns \'s
175and perhaps even respond
176negatively
177.Pq Tn IAC WON'T
178to all option commands received.
179