Skip to content

Commit 8e18315

Browse files
Someguy123Someguy123
committed
v1.0.0 - Initial release of scandomain
0 parents  commit 8e18315

File tree

4 files changed

+507
-0
lines changed

4 files changed

+507
-0
lines changed

‎LICENSE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
LICENSE.txt

‎LICENSE.txt

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
+===================================================+
2+
| © 2023 Privex Inc. |
3+
| https://www.privex.io |
4+
+===================================================+
5+
| |
6+
| ScanDomain tool |
7+
| License: X11/MIT |
8+
| |
9+
| Core Developer(s): |
10+
| |
11+
| (+) Chris (@someguy123) [Privex] |
12+
| |
13+
+===================================================+
14+
15+
ScanDomain tool - A bash tool (wraps 'dig') to make querying multiple record types / domains at once easier
16+
Copyright (c) 2023 Privex Inc. ( https://www.privex.io )
17+
18+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
19+
files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy,
20+
modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
21+
Software is furnished to do so, subject to the following conditions:
22+
23+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of
24+
the Software.
25+
26+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
27+
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
28+
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
29+
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
30+
31+
Except as contained in this notice, the name(s) of the above copyright holders shall not be used in advertising or
32+
otherwise to promote the sale, use or other dealings in this Software without prior written authorization.
33+

‎README.md

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
# Privex CLI Domain Record Scanner
2+
3+
![GitHub last commit](https://img.shields.io/github/last-commit/Privex/scandomain)
4+
5+
A bash tool to make querying multiple record types / multiple domains from the CLI much easier, with the ability to display the records
6+
in several different formats.
7+
8+
This tool wraps `dig`, if you don't have `dig` installed, it's usually available under the package name `bind-tools` or `dnstools` in
9+
most OS package managers.
10+
11+
12+
![Screenshot of scandomain commands](https://i.imgur.com/P3vygTz.png)
13+
14+
15+
```text
16+
17+
+===================================================+
18+
| © 2023 Privex Inc. |
19+
| https://www.privex.io |
20+
+===================================================+
21+
| |
22+
| ScanDomain tool |
23+
| License: X11/MIT |
24+
| |
25+
| Core Developer(s): |
26+
| |
27+
| (+) Chris (@someguy123) [Privex] |
28+
| |
29+
+===================================================+
30+
31+
ScanDomain tool - A bash tool (wraps 'dig') to make querying multiple record types / domains at once easier
32+
Copyright (c) 2023 Privex Inc. ( https://www.privex.io )
33+
34+
```
35+
36+
## Quickstart
37+
38+
```sh
39+
# Via wget
40+
wget -O /usr/local/bin/scandomain https://github.com/Privex/scandomain/raw/master/scandomain
41+
# Via curl
42+
curl -fsSL https://github.com/Privex/scandomain/raw/master/scandomain -o /usr/local/bin/scandomain
43+
44+
# Make it executable
45+
chmod +x /usr/local/bin/scandomain
46+
47+
# Run it :)
48+
scandomain privex.io
49+
scandomain --help
50+
```
51+
52+
## Install
53+
54+
### Dependencies
55+
56+
- Bash (4.x recommended - standard on Linux systems, not standard on BSD systems)
57+
- `dig` (can be found in the package `bind-tools` or `dnstools`)
58+
59+
For debian/ubuntu based systems:
60+
61+
```sh
62+
apt update
63+
apt install bind-tools
64+
```
65+
66+
For FreeBSD and some other BSDs:
67+
68+
```sh
69+
pkg install bash bind-tools
70+
```
71+
72+
For macOS:
73+
74+
```sh
75+
brew install bash bind-tools
76+
```
77+
78+
### Install directly into your bin folder using wget/curl
79+
80+
If you're able to write to /usr/local/bin:
81+
82+
```sh
83+
# Via wget
84+
wget -O /usr/local/bin/scandomain https://github.com/Privex/scandomain/raw/master/scandomain
85+
# Via curl
86+
curl -fsSL https://github.com/Privex/scandomain/raw/master/scandomain -o /usr/local/bin/scandomain
87+
88+
# Make it executable
89+
chmod +x /usr/local/bin/scandomain
90+
```
91+
92+
If you can't / don't want to install globally, you can install it locally into
93+
your `~/.local/bin` folder - just make sure it's in your `PATH`:
94+
95+
```sh
96+
# Via wget
97+
wget -O ~/.local/bin/scandomain https://github.com/Privex/scandomain/raw/master/scandomain
98+
# Via curl
99+
curl -fsSL https://github.com/Privex/scandomain/raw/master/scandomain -o ~/.local/bin/scandomain
100+
101+
# Make it executable
102+
chmod +x ~/.local/bin/scandomain
103+
```
104+
105+
### Install by cloning the Git repo
106+
107+
Alternatively, if you prefer, you can clone the repo and install from the cloned Git repo instead.
108+
109+
This may be helpful if you want to use a specific tag, make it easier to update in the future
110+
using `git pull`, or so you have the README and LICENSE on hand locally :)
111+
112+
```sh
113+
git clone https://github.com/Privex/scandomain.git
114+
cd scandomin
115+
116+
# If you're able to write to /usr/local/bin
117+
install scandomain /usr/local/bin/
118+
119+
# If you can't / don't want to install globally, you can install it locally into
120+
# your ~/.local/bin folder - just make sure it's in your PATH
121+
install scandomain ~/.local/bin/
122+
123+
# If you don't have the 'install' command, you can simply cp it, just make
124+
# sure to chmod +x it
125+
cp -v scandomain /usr/local/bin/
126+
chmod +x /usr/local/bin/scandomain
127+
# Or install into your user bin folder:
128+
cp -v scandomain ~/.local/bin/
129+
chmod +x ~/.local/bin/scandomain
130+
131+
# Alternatively, you can run it straight from the repo folder!
132+
./scandomain example.com
133+
./scandomain --help
134+
```
135+
136+
## Examples
137+
138+
View the built-in help, which includes usage examples, flags/switches/arguments, etc:
139+
140+
```sh
141+
scandomain --help
142+
```
143+
144+
Fetch the default record types (a aaaa ns mx soa txt) for privex.io
145+
146+
```sh
147+
scandomain privex.io
148+
```
149+
150+
Fetch the default record types (a aaaa ns mx soa txt) for privex.io in compact + quiet mode
151+
152+
```sh
153+
scandomain -c -q privex.io
154+
```
155+
156+
Fetch the default record types (a aaaa ns mx soa txt) for privex.io using nameserver 185.130.44.20
157+
158+
```sh
159+
scandomain privex.io @185.130.44.20
160+
```
161+
162+
Fetch just A + AAAA in flat mode for privex.io, google.com, and example.com
163+
164+
```sh
165+
scandomain -f -r a,aaaa privex.io google.com example.com
166+
```
167+
168+
Fetch just A + AAAA for example.com from nameserver 9.9.9.9 and validate + return DNSSEC record
169+
170+
```sh
171+
scandomain -r a,aaaa +dnssec example.com @9.9.9.9
172+
```
173+
174+
## License
175+
176+
OpenAlias.py is released under the X11 / MIT License, see `LICENSE` for more info.
177+
178+
## Thanks for reading!
179+
180+
**If this project has helped you, consider [grabbing a VPS or Dedicated Server from Privex](https://www.privex.io) -**
181+
**prices start at as little as US$0.99/mo (we take cryptocurrency!)**
182+
183+
You can also donate cryptocurrency to us using our OpenAlias address `privex.io` :)
184+
185+
**Standard crypto donation addresses:**
186+
187+
```yaml
188+
BTC: bc1q6tc5wutnm25uhvemq9x7602uaskt8f3jxfygmjurzl5nthc3pyuqkv9qp9
189+
BCH: bitcoincash:qr6ss5pnnx9wad32j7lhulwp6k6we60gyuzsqc6pyj
190+
LTC: MDRRb9pdLs6nXQ91VNfJEN68ohHSwWvscv
191+
XMR: 85foJVKQTTihMoGWuC6Xm5XLktRWNHPjtb5vz7JmLays92jPbSQUxfE6AqK5pz6QanSJ6rV64pbmn85nFEzkb5fQCm2Q17P
192+
ETH: 0x2e8687E5349f38e833F9111b25761B903902AdC0
193+
DOGE: D9XEBJF55kN3XWEdDr5Z19GHMmgh7nrsEQ
194+
HIVE/HBD: privex
195+
EOS: privexinceos
196+
```
197+

0 commit comments

Comments
 (0)