xref: /openbsd/libexec/fingerd/fingerd.8 (revision 07ea8d15)
1.\"	$OpenBSD: fingerd.8,v 1.4 1996/12/08 13:29:53 downsj 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.4 1996/12/08 13:29:53 downsj Exp $
36.\"
37.Dd June 4, 1993
38.Dt FINGERD 8
39.Os BSD 4.3
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 Fingerd
55is a simple protocol based on
56.%T RFC1196
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 Fingerd
67listens for
68.Tn TCP
69requests at port 79.
70Once connected it reads a single command line
71terminated by a
72.Aq Tn CRLF
73which is passed to
74.Xr finger 1 .
75.Nm Fingerd
76closes its connections as soon as the output is finished.
77.Pp
78If the line is null (i.e. just a
79.Aq Tn CRLF
80is sent) then
81.Xr finger
82returns a
83.Dq default
84report that lists all people logged into
85the system at that moment.
86.Pp
87If a user name is specified (e.g.
88.Pf eric Aq Tn CRLF )
89then the
90response lists more extended information for only that particular user,
91whether logged in or not.
92Allowable
93.Dq names
94in the command line include both
95.Dq login names
96and
97.Dq user names .
98If a name is ambiguous, all possible derivations are returned.
99.Pp
100The following options may be passed to
101.Nm fingerd
102as server program arguments in
103.Pa /etc/inetd.conf :
104.Bl -tag -width Ds
105.It Fl s
106Enable secure mode.
107Forwarding of queries to other remote hosts is denied.
108.It Fl l
109Enable logging.
110The name of the host originating the query is reported via
111.Xr syslog 3
112at LOG_NOTICE priority.
113.It Fl u
114Queries without a user name are rejected.
115.It Fl m
116Prevent matching of
117.Ar user
118names.
119.Ar User
120is usually a login name; however, matching will also be done on the
121users' real names, unless the
122.Fl m
123option is supplied.
124.It Fl M
125Enables matching of
126.Ar user
127names.  This is disabled by default if the system is running YP.
128.It Fl p
129Prevents
130.Nm finger
131from displaying the contents of the
132.Dq Pa .plan
133and
134.Dq Pa .project
135files.
136.It Fl S
137Prints user information in short mode, one line per user.
138This overrides the
139.Dq Pa Whois switch
140that may be passed in from the remote client.
141.It Fl P
142Use an alternate program as the local information provider.
143The default local program
144executed by
145.Nm fingerd
146is
147.Xr finger 1 .
148By specifying a customized local server,
149this option allows a system manager
150to have more control over what information is
151provided to remote sites.
152.El
153.Sh SEE ALSO
154.Xr finger 1
155.Sh BUGS
156Connecting directly to the server from a
157.Tn TIP
158or an equally narrow-minded
159.Tn TELNET Ns \-protocol
160user program can result
161in meaningless attempts at option negotiation being sent to the
162server, which will foul up the command line interpretation.
163.Nm Fingerd
164should be taught to filter out
165.Tn IAC Ns \'s
166and perhaps even respond
167negatively
168.Pq Tn IAC WON'T
169to all option commands received.
170.Sh HISTORY
171The
172.Nm
173command appeared in
174.Bx 4.3 .
175