summaryrefslogtreecommitdiff
path: root/doc/minidentd.html
blob: 007326c1de7876ba964586be8f65c27c85df10c2 (plain)
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
<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta http-equiv="Content-Language" content="en" />
    <title>s6-networking: the minidentd program</title>
    <meta name="Description" content="s6-networking: the minidentd program" />
    <meta name="Keywords" content="s6-networking minidentd identd ident server rfc 1413" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="index.html">s6-networking</a><br />
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> The <tt>minidentd</tt> program </h1>

<p>
<tt>minidentd</tt> is a small
<a href="https://cr.yp.to/proto/ucspi.txt">UCSPI</a> server application
that answers IDENT requests.
</p>

<h2> Interface </h2>

<pre>
     minidentd [ -v ] [ -n | -i | -r ] [ -y <em>file</em> ] [ -t <em>timeout</em> ]
</pre>

<p>
<tt>minidentd</tt> reads a series of IDENT requests on stdin and answers
them on stdout. It logs what it's doing on stderr. The environment
variables <em>x</em>LOCALIP and <em>x</em>REMOTEIP, where <em>x</em> is
the value of the PROTO environment variable, must contain the IDENT
server address and the IDENT client address, respectively.
</p>

<p>
 minidentd exits 0 on success, 100 on a usage error and 111 on a system
call failure.
</p>

<p>
 minidentd does not contact the network directly. It's meant to
run under a superserver like
<a href="s6-tcpserver.html">s6-tcpserver</a>. minidentd will
work with IPv4 as well as IPv6.
</p>

<h2> Options </h2>

<ul>
 <li> <tt>-v</tt>&nbsp;: verbose mode. Log queries and replies.. </li>
 <li> <tt>-n</tt>&nbsp;: send ERROR&nbsp;:&nbsp;HIDDEN-USER replies if
the user has a <tt>.ident</tt> file in his home directory. </li>
 <li> <tt>-i</tt>&nbsp;: user-defined answers. The first 14 chars of the
user's <tt>.ident</tt> file, up to EOF or newline, are used instead of
the user name. If the file exists and is empty, send
ERROR&nbsp;:&nbsp;HIDDEN-USER. If it doesn't exist, send a normal reply. </li>
 <li> <tt>-r</tt>&nbsp;: send random replies. </li>
 <li> <tt>-y&nbsp;<em>file</em></tt>&nbsp;: valid with <tt>-n</tt> or <tt>-i</tt>.
Use <em>file</em> instead of <tt>.ident</tt>. </li>
 <li> <tt>-t&nbsp;<em>timeout</em></tt>&nbsp;: close connection after
<em>timeout</em> milliseconds without a client request. </li>
</ul>

<h2> Notes </h2>

<ul>
 <li> minidentd works only under Linux (2.2 or later);
on other systems, it will compile and run, but report an error for every
request.
The problem is that <em>there is no portable Unix way</em> of listing active
outgoing TCP connections with the relevant uids. On Linux, minidentd parses
the <tt>/proc/net/tcp</tt> or <tt>/proc/net/tcp6</tt> virtual file. Other
systems have their own way of doing this, if you want your system to be
supported by minidentd, please contact the author. </li>
</ul>

</body>
</html>