File: oidentd.8.adoc

package info (click to toggle)
oidentd 3.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,324 kB
  • sloc: sh: 4,582; ansic: 4,062; yacc: 477; lex: 341; makefile: 84
file content (201 lines) | stat: -rw-r--r-- 7,177 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
////
Copyright (c)  2019  Janik Rabe

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the file 'COPYING.DOC'
////

oidentd(8)
==========
:doctype:      manpage
:man manual:   oidentd User Manual
:man source:   oidentd
:reproducible: yes
:revdate:      2023-03-11
:sysconfdir:   /etc


NAME
----

oidentd - flexible, RFC 1413 compliant Ident daemon with NAT support


SYNOPSIS
--------

*oidentd* ['OPTIONS']


DESCRIPTION
-----------

*oidentd* implements the Identification Protocol as described in RFC 1413.  By
default, *oidentd* replies with the username of the owner of connections.  This
behavior can be altered in *oidentd.conf*(5) and by using the options specified
in this document.


OPTIONS
-------

*-a, --address*='ADDRESS'::
  Bind to the specified address.  This option causes *oidentd* to listen for
  incoming connections only on the specified address or addresses instead of on
  all interfaces.  This option may be specified more than once to configure
  multiple addresses.

*-c, --charset*='CHARSET'::
  Inform clients that Ident replies use the specified character set as defined
  in RFC 1340 or its successors.  The default is not to send a character set to
  clients.

*-C, --config*='FILE'::
  Use the specified system-wide configuration file.  If this option is not
  given, *oidentd* defaults to *{sysconfdir}/oidentd.conf*.  The format of the
  system-wide configuration file is described in *oidentd.conf*(5).

*-d, --debug*::
  Show debug messages, including detailed lookup information that may be useful
  for diagnosing issues with failed lookups.  This option is only available if
  *oidentd* was compiled with debugging support.

*-e, --error*::
  Hide error messages, returning *UNKNOWN-ERROR* for all errors.  This includes
  the *NO-USER*, *HIDDEN-USER* and *INVALID-PORT* errors.  This option may be
  used to conceal the fact that *oidentd* is hiding Ident responses for a user.

*-f, --forward*=['PORT']::
  Forward requests for hosts masquerading through the server *oidentd* is
  running on to the host that established the corresponding connection.  The
  target host must be running *oidentd* with the *--proxy* option, or some
  Ident server returning static responses regardless of the query.  If no port
  is specified, the default Ident port (113) is used.  If forwarding fails,
  *oidentd* falls back to the response specified in *oidentd_masq.conf*(5).
  This option implies *--masquerade*.  The *--masquerade-first* option can be
  used to forward queries only if no response was specified in
  *oidentd_masq.conf*(5).

*-g, --group*='GROUP|GID'::
  Run as the specified group or GID.  If this option is not given, *oidentd*
  falls back to running as "oidentd", "nobody", "nogroup" or GID 65534, in this
  order.  On systems that require *oidentd* to run as the superuser, a warning
  is shown and the group is not changed automatically.

*-h, --help*::
  Print a summary of options and exit.

*-i, --foreground*::
  Do not fork to background.  This option may be useful for debugging, or for
  running *oidentd* from a service manager like *systemd*(1) with
  *Type=simple*.

*-I, --stdio*::
  Read a single Ident query from standard input, write the response to standard
  output, then exit.  This option may be useful for debugging, or when running
  *oidentd* from a listener daemon such as *xinetd*(8).

*-l, --limit*='MAX'::
  Limit the maximum number of concurrent connections to the specified value.
  Further connections beyond this limit will be closed immediately without
  spawning a new process.  If this option is not specified, no limit is
  enforced.

*-m, --masquerade*::
  Enable support for NAT connections, allowing Ident lookups intended for hosts
  masquerading through the server running *oidentd*.  Ident responses for NAT
  connections can be configured in the *oidentd_masq.conf*(5) configuration
  file.

*-M, --masquerade-first*::
  If an entry matching the target host exists in the *oidentd_masq.conf*(5)
  configuration file, return the configured Ident response instead of
  forwarding the query.  With this option, queries are forwarded only if no
  static response has been configured.  If this option is not specified, the
  default behavior of *--forward* is to forward queries before checking the
  *oidentd_masq.conf*(5) file.  This option implies *--forward* and
  *--masquerade*.

*-o, --other*=['OS']::
  Set an alternative operating system string to send alongside Ident responses.
  Note that some clients may interpret queries as having failed when an unknown
  operating system is returned.  If this option is not specified, the value
  *UNIX* is used.  If this option is specified without an argument, *OTHER* is
  returned.

*-p, --port*='PORT'::
  Listen on the specified port instead of port 113.

*-P, --proxy*='ORIGIN'::
  Allow the specified host to forward queries to this instance using the
  *--forward* option.  If *--reply* is not specified, this option must be
  enabled for *oidentd* to correctly handle forwarded connections.

*-q, --quiet*::
  Suppress normal logging, showing only critical messages.

*-r, --reply*='REPLY'::
  When a lookup fails, send the specified Ident response as if it had
  succeeded.

*-R, --reply-all*='REPLY'::
  Send the specified reply in response to all well-formed queries.  When this
  option is used, the configuration files are not read and connection lookups
  are never performed.  Privileged initialization is not performed on systems
  that would otherwise require it, so unprivileged users can run oidentd with
  this option as long as they have permission to bind the requested port.

*-S, --nosyslog*::
  Log messages to the standard error stream, even if it is not a terminal.  If
  standard error is a terminal, messages are written to it by default.

*-t, --timeout*='SECONDS'::
  Close connections if no Ident query is received within the specified number
  of seconds.  By default, connections are closed after 30 seconds.

*-u, --user*='USER|UID'::
  Run as the specified user or UID.  If this option is not given, *oidentd*
  falls back to running as "oidentd", "nobody" or UID 65534, in this order.  On
  systems that require *oidentd* to run as the superuser, a warning is shown
  and the user is not changed automatically.

*-v, --version*::
  Print version and build information and exit.


FILES
-----

*{sysconfdir}/oidentd.conf*::
  System-wide configuration file; see *oidentd.conf*(5).

*~/.config/oidentd.conf*, *~/.oidentd.conf*::
  User configuration files; see *oidentd.conf*(5).

*{sysconfdir}/oidentd_masq.conf*::
  Masquerading configuration file; see *oidentd_masq.conf*(5).


AUTHOR
------

mailto:info@janikrabe.com[Janik Rabe]::
  https://janikrabe.com

Originally written by Ryan McCabe.


BUGS
----

Please report any bugs to mailto:info@janikrabe.com[Janik Rabe].


SEE ALSO
--------

*oidentd.conf*(5)
*oidentd_masq.conf*(5)