xref: /openbsd/usr.sbin/identd/identd.8 (revision 4cc355a6)
1.\"   $OpenBSD: identd.8,v 1.11 2013/07/17 15:38:47 okan Exp $
2.\"
3.\" Copyright (c) 2013 David Gwynne <dlg@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: July 17 2013 $
18.Dt IDENTD 8
19.Os
20.Sh NAME
21.Nm identd
22.Nd Identification Protocol daemon
23.Sh SYNOPSIS
24.Nm
25.Op Fl 46deHhNn
26.Op Fl l Ar address
27.Op Fl t Ar timeout
28.Sh DESCRIPTION
29.Nm
30is a server which implements the Identification Protocol as specified in
31RFC 1413.
32.Pp
33.Nm
34operates by looking up specific TCP/IP connections and returning
35the name of the user running the process responsible for the connection.
36.Pp
37The options are as follows:
38.Bl -tag -width Ds
39.It Fl 4
40Forces
41.Nm
42to use IPv4 addresses only.
43.It Fl 6
44Forces
45.Nm
46to use IPv6 addresses only.
47.It Fl d
48Do not daemonize.
49If this option is specified,
50.Nm
51will run in the foreground and log to stderr.
52.It Fl e
53Always return
54.Dq UNKNOWN-ERROR
55instead of the
56.Dq NO-USER
57or
58.Dq INVALID-PORT
59errors.
60.It Fl H
61Hide information about existing and non-existent users.
62This flag implies
63.Fl h .
64.It Fl h
65Hide the actual information about the user by providing an opaque
66token instead.
67This token is entered into the local system logs
68so that the administrator can later discover who the real user was.
69.It Fl l Ar address
70Listen on the specified address.
71By default
72.Nm
73listens on wildcard addresses.
74.It Fl N
75When replying with a user name or ID, first
76check for a file
77.Pa .noident
78in the user's home directory.
79If this file is accessible, return
80.Dq HIDDEN-USER
81instead of the normal USERID response.
82.It Fl n
83Always return UID numbers instead of usernames.
84.It Fl t Ar timeout
85Specifies the idle timeout for client connections,
86in seconds.
87The default timeout is 120 seconds.
88.El
89.\" .Sh SEE ALSO
90.Sh STANDARDS
91.Rs
92.%A M. St. Johns
93.%D February 1993
94.%R RFC 1413
95.%T Identification Protocol
96.Re
97.Sh HISTORY
98The
99.Nm
100command was originally a process run via
101.Xr inetd 8 .
102It was rewritten for
103.Ox 5.4
104as a persistent non-blocking daemon.
105