-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.html
485 lines (467 loc) · 17.2 KB
/
README.html
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2022-02-09 Wed 02:28 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>bestwhois - a command-line whois-like client for the WHOIS and WHOIS History APIs by WhoisXML API Inc.</title>
<meta name="generator" content="Org mode" />
<meta name="author" content="WhoisXML API, Inc." />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { width: 90%; }
/*]]>*/-->
</style>
<script type="text/javascript">
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2019 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="content">
<h1 class="title">bestwhois - a command-line whois-like client for the WHOIS and WHOIS History APIs by WhoisXML API Inc.</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgd460417">1. About</a></li>
<li><a href="#orgab23b20">2. Installation</a>
<ul>
<li><a href="#org3fdf284">2.1. Prerequisites</a></li>
<li><a href="#orgb32a639">2.2. Running the program</a></li>
</ul>
</li>
<li><a href="#org8589272">3. Quick start</a></li>
<li><a href="#orgdd7af70">4. Specifications</a>
<ul>
<li><a href="#org97effc8">4.1. Command-line options</a></li>
<li><a href="#org934e24c">4.2. Output</a></li>
<li><a href="#org26034c1">4.3. Return codes</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-orgd460417" class="outline-2">
<h2 id="orgd460417"><span class="section-number-2">1</span> About</h2>
<div class="outline-text-2" id="text-1">
<p>
The 'bestwhois' command-line utility make queries through the API
service provided by WhoisXML API, Inc. It is intended as a replacement
of the standard 'whois' command for domain and IP WHOIS queries, to
provide accurate queries from our WHOIS database via the WHOIS API
(<a href="https://whoisapi.whoisxmlapi.com">https://whoisapi.whoisxmlapi.com</a>). In addition it can yield historic
WHOIS records for domains by invoking the WHOIS history API
(<a href="https://whois-history-api.whoisxmlapi.com">https://whois-history-api.whoisxmlapi.com</a>).
</p>
<p>
By default it gives a pretty-printed human-readable JSON output, which
is at least as readable and definitely more structured as the standard
textual output of WHOIS. Optionally it can also print a textual output
which is closer to usual WHOIS.
</p>
<p>
The use of the utility requires a subscription to the Whois API, see
its details at <a href="https://whoisapi.whoisxmlapi.com">https://whoisxmlapi.com</a>. A free subscription
is also available.
</p>
</div>
</div>
<div id="outline-container-orgab23b20" class="outline-2">
<h2 id="orgab23b20"><span class="section-number-2">2</span> Installation</h2>
<div class="outline-text-2" id="text-2">
</div>
<div id="outline-container-org3fdf284" class="outline-3">
<h3 id="org3fdf284"><span class="section-number-3">2.1</span> Prerequisites</h3>
<div class="outline-text-3" id="text-2-1">
<ul class="org-ul">
<li>The program is written in series 3 Python, so it has to be installed</li>
</ul>
<p>
on your system to run. It has been tested with version >= 3.6.
</p>
<ul class="org-ul">
<li>It depends also on the pygments, argparse, and requests
packages. You may install these with the package manager of your OS
(e.g. apt), or using Python's package manager, 'pip', by doing</li>
</ul>
<div class="org-src-container">
<pre class="src src-bash">pip3 install pygments argparse requests
</pre>
</div>
<p>
in your shell or Windows command line. If you want to query for
domains with national characters with Unicode encoding, you also need
the <code>idna</code> package:
</p>
<div class="org-src-container">
<pre class="src src-bash">pip3 install idna
</pre>
</div>
</div>
</div>
<div id="outline-container-orgb32a639" class="outline-3">
<h3 id="orgb32a639"><span class="section-number-3">2.2</span> Running the program</h3>
<div class="outline-text-3" id="text-2-2">
<p>
<b>Windows users</b> have to rename the file "bestwhois" to "bestwhois.py"
</p>
<div class="org-src-container">
<pre class="src src-bash">move bestwhois bestwhois.py
</pre>
</div>
<p>
and use it as bestwhois.py. When first running, it has to associated
with Python in this environment.
</p>
<p>
Apart from this, all you need is a valid API key which can be obtained
after registration. You may specify this for the program in various
ways:
</p>
<ul class="org-ul">
<li>With the –api-key= command-line option</li>
<li>Writing the API key single-line into a text file (named rc file in
what follows), and specifying the location with the –rcfile= option</li>
<li>Naming the rc file ".bestwhoisrc", and putting it
to your home directory or next to the script. We recommend to
withdraw read permissions from other files on this.</li>
<li>Putting the rc file to /etc/bestwhoisrc .</li>
</ul>
<p>
The program currently uses the same API key for both the WHOIS API and
the WHOIS History API. If your key is not valid for either of these,
an error will produced.
</p>
</div>
</div>
</div>
<div id="outline-container-org8589272" class="outline-2">
<h2 id="org8589272"><span class="section-number-2">3</span> Quick start</h2>
<div class="outline-text-2" id="text-3">
<p>
Having a proper rc file, the program should simply run from
command-line. You may want to put it to some location in the path,
e.g. to /usr/local/bin on UNIX-flavor systems. Just try
</p>
<div class="org-src-container">
<pre class="src src-bash">bestwhois domainwhoisdatabase.com
</pre>
</div>
<p>
(Or
</p>
<div class="org-src-container">
<pre class="src src-bash">bestwhois.py domainwhoisdatabase.com
</pre>
</div>
<p>
on Windows).
</p>
<p>
A help is available with the –help option.
</p>
<p>
Some further examples:
</p>
<ul class="org-ul">
<li>A simple WHOIS query with text output:</li>
</ul>
<div class="org-src-container">
<pre class="src src-bash">bestwhois --text domainwhoisdatabase.com
</pre>
</div>
<ul class="org-ul">
<li>Simple WHOIS query with raw text fields fully included:</li>
</ul>
<div class="org-src-container">
<pre class="src src-bash">bestwhois --fullrawtext domainwhoisdatabase.com
</pre>
</div>
<ul class="org-ul">
<li>IP WHOIS query with non-colored output:</li>
</ul>
<div class="org-src-container">
<pre class="src src-bash">bestwhois --nocolor 104.27.154.235
</pre>
</div>
<ul class="org-ul">
<li>Full history query:</li>
</ul>
<div class="org-src-container">
<pre class="src src-bash">bestwhois --history domainwhoisdatabase.com
</pre>
</div>
<ul class="org-ul">
<li>History query with date restrictions:</li>
</ul>
<div class="org-src-container">
<pre class="src src-bash">bestwhois domainwhoisdatabase.com --created-date-from 2000-01-01 --expired-date-to 2020-01-01
</pre>
</div>
<ul class="org-ul">
<li>Query a domain with national characters (the two lines are equivalent):</li>
</ul>
<div class="org-src-container">
<pre class="src src-bash">bestwhois москва.рф
bestwhois xn--80adxhks.xn--p1ai
</pre>
</div>
</div>
</div>
<div id="outline-container-orgdd7af70" class="outline-2">
<h2 id="orgdd7af70"><span class="section-number-2">4</span> Specifications</h2>
<div class="outline-text-2" id="text-4">
</div>
<div id="outline-container-org97effc8" class="outline-3">
<h3 id="org97effc8"><span class="section-number-3">4.1</span> Command-line options</h3>
<div class="outline-text-3" id="text-4-1">
<p>
A full list of command-line options can be obtained by invoking the
program with the –help option.
</p>
<p>
Note: the options marked with "(history)" in their description imply
the use of the WHOIS History API instead of the WHOIS API.
</p>
</div>
</div>
<div id="outline-container-org934e24c" class="outline-3">
<h3 id="org934e24c"><span class="section-number-3">4.2</span> Output</h3>
<div class="outline-text-3" id="text-4-2">
<p>
The output consists of parsed WHOIS records as specified by the
command-line options. The default is a colorized JSON-like text. On
Windows consoles, coloring is not supported.
</p>
<p>
If there are no WHOIS records in the output of the API, the output of
the API is printed.
</p>
</div>
</div>
<div id="outline-container-org26034c1" class="outline-3">
<h3 id="org26034c1"><span class="section-number-3">4.3</span> Return codes</h3>
<div class="outline-text-3" id="text-4-3">
<dl class="org-dl">
<dt><code>0</code></dt><dd>Normal termination.</dd>
<dt><code>1</code></dt><dd>Error in the API call. Typical reasons: bad API key, nonexistent domain name in the History API.</dd>
<dt><code>2</code></dt><dd>No WHOIS records in the reply.</dd>
<dt><code>3</code></dt><dd>Tried to query a domain with Unicode national characters and the <code>idna</code> package is not installed.</dd>
</dl>
</div>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="date">Date: v 0.1.0, 2022.02.08.</p>
<p class="author">Author: WhoisXML API, Inc.</p>
<p class="date">Created: 2022-02-09 Wed 02:28</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>