summaryrefslogtreecommitdiff
path: root/doc/index.html
blob: ecaa6a7607b827751268375bf5fb64b916499e48 (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
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
<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>shibari - a collection of DNS tools </title>
    <meta name="Description" content="shibari - a collection of DNS tools" />
    <meta name="Keywords" content="shibari s6-dns DNS resolution server unix linux laurent bercot ska skarnet" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> shibari </h1>

<h2> What is it&nbsp;? </h2>

<p>
 shibari is a collection of DNS tools for Unix systems, as an
alternative to BIND, Unbound, djbdns or other similar suites of
programs.
</p>

<p>
 It is an ongoing project; at the moment, only a DNS server is
provided (one program to serve over TCP, another to serve over UDP).
Currently, it relies on the
<a href="//skarnet.org/software/s6-dns/">s6-dns</a> library, but it
aims to integrate it over time, and eventually completely replace
s6-dns (which is a badly named software collection, because despite
being written by the same author and with the same mindset, it is not
part of the s6 project).
</p>

<h3> Why "shibari"? </h3>

<p>
 There's a de facto tradition that DNS software should have a name
related to binding. shibari is the most pleasant of them.
</p>

<hr />

<h2> Installation </h2>

<h3> Requirements </h3>

<ul>
 <li> A POSIX-compliant system with a standard C development environment </li>
 <li> GNU make, version 3.81 or later </li>
 <li> <a href="//skarnet.org/software/skalibs/">skalibs</a> version
2.14.2.0 or later. It's a build-time requirement. It's also a run-time
requirement if you link against the shared version of the skalibs library. </li>
 <li> <a href="//skarnet.org/software/s6/">s6</a> version
2.13.0.0 or later. It's a build-time requirement. It's also a run-time
requirement if you link against the shared version of the s6 library. That
library is used for the access control and client location features in
<a href="shibari-server-udp.html">shibari-server-udp</a>. </li>
 <li> (for now) <a href="//skarnet.org/software/s6-dns/">s6-dns</a> version
2.3.7.2 or later. It's a build-time requirement. It's also a run-time
requirement if you link against the shared version of the s6-dns library. </li>
</ul>

<h3> Licensing </h3>

<p>
 shibari is free software. It is available under the
<a href="https://opensource.org/licenses/ISC">ISC license</a>.
</p>

<h3> Download </h3>

<ul>
 <li> The current released version of shibari is <a href="shibari-0.0.1.1.tar.gz">0.0.1.1</a>. </li>
 <li> You can checkout a copy of the
<a href="//git.skarnet.org/cgi-bin/cgit.cgi/shibari/">shibari
git repository</a>:
<pre> git clone git://git.skarnet.org/shibari </pre> </li>
 <li> There's also a
<a href="https://github.com/skarnet/shibari">GitHub mirror</a>
of the shibari git repository. </li>
</ul>

<h3> Build and installation </h3>

<ul>
 <li> See the enclosed INSTALL file for build and installation details. </li>
</ul>

<h3> Upgrade notes </h3>

<ul>
 <li> <a href="upgrade.html">This page</a> lists the differences to be aware of between
the previous versions of shibari and the current one. </li>
</ul>

<hr />

<h2> Reference </h2>

<h3> Commands </h3>

<p>
 All these commands exit 111 if they encounter a temporary error or
hardware error, and
100 if they encounter a permanent error - such as a misuse. Short-lived
commands exit 0 on success. Other exit codes are documented in the
relevant page.
</p>

<!--
<h4> Command-line DNS clients programs </h4>

<ul>
</ul>

<h4> Caches </h4>

<ul>
</ul>
-->

<h4> Servers </h4>

<ul>
 <li> The <a href="shibari-server-tcp.html">shibari-server-tcp</a> program </li>
 <li> The <a href="shibari-server-udp.html">shibari-server-udp</a> program </li>
</ul>

<!--
<h4> Filtering tools </h4>

<ul>
</ul>

<h4> Command-line qualification </h4>

<ul>
</ul>

<h4> DNS analysis and debug tools </h4>

<ul>
</ul>

<h4> Miscellaneous utilities </h4>

<h3> Libraries </h3>

<h4> Protocol implementation and synchronous resolution </h4>

<ul>
</ul>

<h4> Asynchronous resolution </h4>

<ul>
</ul>
-->

<hr />

<a name="related">
<h2> Related resources </h2>
</a>

<h3> shibari discussion </h3>

<ul>
 <li> <tt>shibari</tt> is discussed on the
<a href="//skarnet.org/lists/#skaware">skaware</a> mailing-list. </li>
 <li> It can also be discussed on the
<a href="https://cr.yp.to/lists.html#dns">cr.yp.to dns mailing-list</a>. </li>
</ul>

<h3> Similar work </h3>

<ul>
 <li> <a href="https://www.isc.org/software/bind">BIND</a> </li>
 <li> <a href="https://nlnetlabs.nl/projects/unbound/about/">Unbound</a> </li>
 <li> <a href="https://cr.yp.to/djbdns.html">djbdns</a> </li>
</ul>

</body>
</html>