lglass.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>Lglass | dn42 wiki</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <meta name="robots" content="index, follow">
  8. <meta name="keywords" content="dn42,wiki,routing,bgp">
  9. <link rel="canonical" href="https://dn42.obl.ong/howto/lglass.html">
  10. <link rel="icon" type="image/x-icon" href="/favicon.ico">
  11. <link rel="shortcut icon" type="image/x-icon" href="/favicon.ico">
  12. <link rel="author" type="text/html" href="/docs/people">
  13. <link rel="stylesheet" href="/css/normalize.css">
  14. <link rel="stylesheet" href="/css/simple.min.css">
  15. <link rel="stylesheet" href="/css/style.css">
  16. <link rel="stylesheet" href="/css/menu.css">
  17. </head>
  18. <body>
  19. <header>
  20. <b>dn42 wiki / Lglass</b>
  21. <div id="dn42_header">
  22. <p><a href="/"><img src="/dn42.png" alt="dn42" /></a></p>
  23. </div>
  24. </header>
  25. <main>
  26. <p>lglass is a Python software package designed for Internet Registries like the DN42. You can generate zone files for DNS and rDNS IPv4/v6, and handle the registry. It is available on GitHub as free software:</p>
  27. <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>git clone git://github.com/fritz0705/lglass.git
  28. </code></pre></div></div>
  29. <h2 id="links">Links</h2>
  30. <ul>
  31. <li><a href="https://github.com/fritz0705/lglass">Fritz Gihub repo</a></li>
  32. <li><a href="http://lglass.flonet.dn42/">lglass Manual</a></li>
  33. </ul>
  34. <h2 id="running-your-own-whois-daemon">Running your own Whois daemon</h2>
  35. <p>lglass provides an event-based whois daemon with internal caching, which was written in Python. It is very simple to run an instance:</p>
  36. <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>./bin/lglass-whoisd
  37. </code></pre></div></div>
  38. <p>without the configfile:</p>
  39. <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>./bin/lglass-regtool whoisd <span class="nt">-H</span> <span class="nv">$HOST</span> <span class="nt">-p</span> <span class="nv">$PORT</span>
  40. </code></pre></div></div>
  41. <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>usage: lglass-whoisd [-h] [-4] [-6] [--host HOST] [--port PORT]
  42. [--cidr] [--no-cidr] [--inverse] [--no-inverse]
  43. optional arguments:
  44. -h, --help show this help message and exit
  45. -4 Listen on IPv4
  46. -6 Listen on IPv6
  47. --host HOST, -H HOST Listen on host
  48. --port PORT, -p PORT Listen on port
  49. --cidr, -c Perform CIDR matching on queries
  50. --no-cidr Do not perform CIDR matching on queries
  51. --inverse, -i Perform inverse matching on queries
  52. --no-inverse Do not perform inverse matching on queries
  53. </code></pre></div></div>
  54. <h2 id="generate-zone-files">Generate zone files</h2>
  55. <p>lglass also provides a script to generate zone files from the registry. It’s named zonegen.py and requires a registry dump from Monotone.</p>
  56. <p>To generate DNS zones:</p>
  57. <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>./bin/lglass-zonegen <span class="nt">-d</span> <span class="nv">$PATH_TO_DATA_DIR</span> <span class="nt">-n</span> ns1... <span class="nt">-n</span> ns2... <span class="nt">-e</span> foo.bar.com dns <span class="nt">-z</span> dn42
  58. </code></pre></div></div>
  59. <p>To generate IPv4 rDNS zones:</p>
  60. <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>./bin/lglass-zonegen <span class="nt">-d</span> <span class="nv">$PATH_TO_DATA_DIR</span> <span class="nt">-n</span> ns1... <span class="nt">-n</span> ns2... <span class="nt">-e</span> foo.bar.com rdns4 <span class="nt">-N</span> 172.22.0.0/16
  61. </code></pre></div></div>
  62. <p>To generate IPv6 rDNS zones:</p>
  63. <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>./bin/lglass-zonegen <span class="nt">-d</span> <span class="nv">$PATH_TO_DATA_DIR</span> <span class="nt">-n</span> ns1... <span class="nt">-n</span> ns2... <span class="nt">-e</span> foo.bar.com rdns6 <span class="nt">-N</span> fd00::/8
  64. </code></pre></div></div>
  65. <h2 id="reformat-rpsl-files">Reformat RPSL files</h2>
  66. <p>You can also reformat RPSL files using lglass by using the lglass.rpsl module:</p>
  67. <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>./bin/lglass-rpsl &lt; <span class="nv">$DATA</span>/inetnum/172.22.0.53_32
  68. </code></pre></div></div>
  69. <p>lglass.rpsl also supports in-place operation:</p>
  70. <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>./bin/lglass-rpsl <span class="nt">-i</span> <span class="nv">$DATA</span>/inetnum/172.22.0.53_32
  71. </code></pre></div></div>
  72. <p>This opens the file, reads the content into memory, seeks to position 0, writes the formatted object and truncates the file.
  73. Simple web interface</p>
  74. <p>lglass also comes with a simple web interface written in Python3 using Bottle and Jinja2. It also provides a binary to run it using wsgiref:</p>
  75. <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>./bin/lglass-web
  76. </code></pre></div></div>
  77. <p>Furthermore you can use any WSGI server like Gunicorn by using lglass.web.application:app as WSGI callback. You can provide a path to the configuration file in the environment variable <code class="language-plaintext highlighter-rouge">LGLASS_WEB_CFG</code>.</p>
  78. <h2 id="configuration">Configuration</h2>
  79. <p>The configuration file format is JSON and allows configuration of the database chain, the listen parameters, the custom messages and the process management.</p>
  80. <table>
  81. <thead>
  82. <tr>
  83. <th>Option</th>
  84. <th style="text-align: left">Meaning</th>
  85. </tr>
  86. </thead>
  87. <tbody>
  88. <tr>
  89. <td>listen.host</td>
  90. <td style="text-align: left">IP address for listening socket (Default: ::)</td>
  91. </tr>
  92. <tr>
  93. <td>listen.port</td>
  94. <td style="text-align: left">TCP port for listening socket (Default: 4343)</td>
  95. </tr>
  96. <tr>
  97. <td>listen.protocol</td>
  98. <td style="text-align: left">Protocol for listening socket (4 or 6, by default 6)</td>
  99. </tr>
  100. <tr>
  101. <td>database</td>
  102. <td style="text-align: left">Array of database URLs to initialize database chain</td>
  103. </tr>
  104. <tr>
  105. <td>database.types</td>
  106. <td style="text-align: left">Array of object types in database (Default: undefined) <br />Default chain:<br />[<br /> “whois+lglass.database.file+file:.”,<br /> “whois+lglass.database.cidr+cidr:”,<br /> “whois+lglass.database.schema+schema:”,<br /> “whois+lglass.database.cache+cached:”<br />]</td>
  107. </tr>
  108. <tr>
  109. <td>messages.preamble</td>
  110. <td style="text-align: left">String preamble for whois responses</td>
  111. </tr>
  112. <tr>
  113. <td>messages.help</td>
  114. <td style="text-align: left">String help message for help requests</td>
  115. </tr>
  116. <tr>
  117. <td>process.user</td>
  118. <td style="text-align: left">User to change after initialization</td>
  119. </tr>
  120. <tr>
  121. <td>process.group</td>
  122. <td style="text-align: left">Group to change after initialization</td>
  123. </tr>
  124. <tr>
  125. <td>process.pidfile</td>
  126. <td style="text-align: left">Path to PID file</td>
  127. </tr>
  128. </tbody>
  129. </table>
  130. <h2 id="rpsl">RPSL</h2>
  131. <ul>
  132. <li>Routing Policy Specification Language <a href="https://tools.ietf.org/html/rfc2622">RFC2622</a></li>
  133. <li>Routing Policy Specification Language next generation (RPSLng) <a href="https://tools.ietf.org/html/rfc4012">RFC4012</a></li>
  134. <li><a href="http://www.ripe.net/data-tools/db/rpsl">http://www.ripe.net/data-tools/db/rpsl</a></li>
  135. <li><a href="http://www.ripe.net/data-tools/db/rpsl/transition-to-rpsl-version-of-the-ripe-database">http://www.ripe.net/data-tools/db/rpsl/transition-to-rpsl-version-of-the-ripe-database</a></li>
  136. </ul>
  137. <div id="menu-container" class="menu-container">
  138. <hr>
  139. <div id="menu" class="menu">
  140. <ul>
  141. <li><a href="/Home">Home</a>
  142. <ul>
  143. <li><a href="/howto/Getting-Started">Getting Started</a></li>
  144. <li><a href="/howto/Registry-Authentication">Registry Authentication</a></li>
  145. <li><a href="/howto/Address-Space">Address Space</a></li>
  146. <li><a href="/howto/BGP-communities">BGP communities</a></li>
  147. <li><a href="/FAQ">FAQ</a></li>
  148. </ul>
  149. </li>
  150. <li>How-To
  151. <ul>
  152. <li><a href="/howto/wireguard">Wireguard</a></li>
  153. <li><a href="/howto/openvpn">Openvpn</a></li>
  154. <li><a href="/howto/IPsec-with-PublicKeys">IPsec With Public Keys</a></li>
  155. <li><a href="/howto/tinc">Tinc</a></li>
  156. <li><a href="/howto/GRE-on-FreeBSD">GRE on FreeBSD</a></li>
  157. <li><a href="/howto/GRE-on-OpenBSD">GRE on OpenBSD</a></li>
  158. <li><a href="/howto/IPv6-Multicast">IPv6 Multicast (PIM-SM)</a></li>
  159. <li><a href="/howto/multicast">SSM Multicast</a></li>
  160. <li><a href="/howto/mpls">MPLS</a></li>
  161. <li><a href="/howto/Bird2">Bird2</a></li>
  162. <li><a href="/howto/frr">FRRouting</a></li>
  163. <li><a href="/howto/OpenBGPD">OpenBGPD</a></li>
  164. <li><a href="/howto/mikrotik">Mikrotik RouterOS</a></li>
  165. <li><a href="/howto/EdgeOS-Config">EdgeRouter</a></li>
  166. <li><a href="/howto/Static-routes-on-Windows">Static routes on Windows</a></li>
  167. <li><a href="/howto/networksettings">Universal Network Requirements</a></li>
  168. <li><a href="/howto/vyos1.4.x">VyOS</a></li>
  169. <li><a href="/howto/nixos">NixOS</a></li>
  170. </ul>
  171. </li>
  172. <li>Services
  173. <ul>
  174. <li><a href="/services/IRC">IRC</a></li>
  175. <li><a href="/services/Whois">Whois registry</a></li>
  176. <li><a href="/services/DNS">DNS</a></li>
  177. <li><a href="/services/IX-Collection">IX Collection</a></li>
  178. <li><a href="/services/Clearnet-Domains">Public DNS</a></li>
  179. <li><a href="/services/Looking-Glasses">Looking Glasses</a></li>
  180. <li><a href="/services/Automatic-Peering">Automatic Peering</a></li>
  181. <li><a href="/services/Repository-Mirrors">Repository Mirrors</a></li>
  182. <li><a href="/services/Distributed-Wiki">Distributed Wiki</a></li>
  183. <li><a href="/services/Certificate-Authority">Certificate Authority</a></li>
  184. <li><a href="/services/Route-Collector">Route Collector</a></li>
  185. </ul>
  186. </li>
  187. <li>Internal
  188. <ul>
  189. <li><a href="/internal/Internal-Services">Internal services</a></li>
  190. <li><a href="/internal/Interconnections">Interconnections</a></li>
  191. <li><a href="/internal/APIs">APIs</a></li>
  192. <li><a href="/internal/ShowAndTell">Show and Tell</a></li>
  193. <li><a href="/internal/Historical-Services">Historical services</a></li>
  194. </ul>
  195. </li>
  196. <li>Historical
  197. <ul>
  198. <li><a href="/historical/Bird">Bird 1</a></li>
  199. <li><a href="/historical/Quagga">Quagga</a></li>
  200. </ul>
  201. </li>
  202. <li>External Tools
  203. <ul>
  204. <li><a href="https://paste.dn42.us">Paste Board</a></li>
  205. <li><a href="https://git.dn42.dev">Git Repositories</a></li>
  206. </ul>
  207. </li>
  208. </ul>
  209. <hr />
  210. </div>
  211. </div>
  212. </main>
  213. <footer><div class="center">
  214. <div id="dn42_footer">
  215. <table>
  216. <tbody>
  217. <tr>
  218. <td>Hosted by: <a href="mailto:dn42@burble.com">BURBLE-MNT</a>, <a href="mailto:nurtic-vibe@grmml.net">GRMML-MNT</a>, <a href="mailto:xuu@dn42.us">XUU-MNT</a>, <a href="mailto:janeric@ortgies.it">JAN-MNT</a>, <a href="mailto:lare@lare.cc">LARE-MNT</a>, <a href="mailto:danny@saru.moe">SARU-MNT</a>, <a href="mailto:androw95220@gmail.com">ANDROW-MNT</a>, <a href="mailto:dn42@mk16.de">MARK22K-MNT</a></td>
  219. <td>Accessible via: <a href="https://wiki.dn42">dn42</a>, <a href="https://dn42.dev/">dn42.dev</a>, <a href="https://dn42.eu/">dn42.eu</a>, <a href="https://wiki.dn42.us/">wiki.dn42.us</a>, <a href="https://dn42.de/">dn42.de</a> (IPv6-only), <a href="https://dn42.cc/">dn42.cc</a> (wiki-ng), <a href="https://dn42.wiki/">dn42.wiki</a>, <a href="https://dn42.pp.ua/">dn42.pp.ua</a>, <a href="https://dn42.obl.ong/">dn42.obl.ong</a></td>
  220. </tr>
  221. </tbody>
  222. </table>
  223. </div>
  224. </div>
  225. </footer>
  226. </body>
  227. </html>