libexec/fingerd/fingerd.8

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