Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnnymast/redbox-whois
An Open source whois library
https://github.com/johnnymast/redbox-whois
recon reconnaissance services whois whois-lookup
Last synced: 30 days ago
JSON representation
An Open source whois library
- Host: GitHub
- URL: https://github.com/johnnymast/redbox-whois
- Owner: johnnymast
- License: mit
- Created: 2023-04-07T10:04:07.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-06T16:47:54.000Z (3 months ago)
- Last Synced: 2024-12-09T03:08:10.527Z (about 2 months ago)
- Topics: recon, reconnaissance, services, whois, whois-lookup
- Language: PHP
- Homepage: https://github.com/johnnymast/redbox-whois
- Size: 84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Redbox-whois
[](https://packagist.org/packages/redbox/whois)
[](https://github.com/johnnymast/redbox-whois/actions/workflows/Tests.yml)
[](https://github.com/johnnymast/redbox-whois/actions/workflows/Phpcs.yaml)
[](https://github.com/johnnymast/redbox-whois/actions/workflows/pest-coverage.yaml)
This is a Whois library I wrote to use for reconnaissance missions for my pen testing efforts. You could use it yourself because I made it easy to use.
## Installation
```bash
$ composer require redbox/whois
```
## Usage
The package is flexible and easy to use. Here are a few examples of how you could use the package.
### Simple static call
```php
use Redbox\Whois\Exceptions\WhoisException;
use Redbox\Whois\WhoisClient;
try {
$whois = WhoisClient::domain('google.com')
->getOutput();
echo $whois;
} catch (WhoisException $e) {
echo $e->getMessage();
}
```
### Use it without the static call
The static call mentioned above is just a clever wrapper around the lookup function. You can instantiate the WhoisClient
yourself and call the lookup function. Note as well we are using the getOutput() function to get the output of the
lookup.
```php
use Redbox\Whois\Exceptions\WhoisException;
use Redbox\Whois\WhoisClient;
try {
$whois = new WhoisClient();
$result = $whois->lookup('google.nl')
->getOutput();
echo $result;
} catch (WhoisException $e) {
echo $e->getMessage();
}
```
### Save the output to a file
The saveOutput function has an optional parameter: the path to the file. If you do not specify a path the
output will be stored as whois.txt. The saveOutput function will return the WhoisClient object so you can chain it with
getOutput() if you wish.
```php
use Redbox\Whois\Exceptions\WhoisException;
use Redbox\Whois\WhoisClient;
try {
$whois = new WhoisClient();
$output = $whois->lookup('google.fr')
->saveOutput('output.txt')
->getOutput();
echo $output;;
} catch (WhoisException $e) {
echo $e->getMessage();
}
```
## Special thanks
I needed a [list](https://github.com/johnnymast/redbox-whois/blob/master/src/Servers.php) of TLDs and their whois servers.
This list of servers I found in the [PHP WHOIS](https://github.com/io-developer/php-whois) project. If you are looking for even more options to configure, check out that project.
Besides more options, it will also support php versions ranging from 5.6 to the latest and current PHP version.
# The MIT License (MIT)
Copyright (c) 2023 Johnny Mast
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.