Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hueristiq/xsubfind3r
A command-line utility designed to help you discover subdomains for a given domain in a simple, efficient way. It works by gathering information from a variety of passive sources, meaning it doesn't interact directly with the target but instead gathers data that is already publicly available.
https://github.com/hueristiq/xsubfind3r
asset-discovery bug-bounty bug-bounty-tools docker docker-image ethical-hacking ethical-hacking-tools go golang osint osint-tools penetration-testing penetration-testing-tools reconnaissance red-team-tools red-teaming subdomain-discovery subdomain-enumeration
Last synced: about 3 hours ago
JSON representation
A command-line utility designed to help you discover subdomains for a given domain in a simple, efficient way. It works by gathering information from a variety of passive sources, meaning it doesn't interact directly with the target but instead gathers data that is already publicly available.
- Host: GitHub
- URL: https://github.com/hueristiq/xsubfind3r
- Owner: hueristiq
- License: mit
- Created: 2021-05-13T05:51:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-20T17:04:14.000Z (17 days ago)
- Last Synced: 2024-10-21T18:49:34.990Z (16 days ago)
- Topics: asset-discovery, bug-bounty, bug-bounty-tools, docker, docker-image, ethical-hacking, ethical-hacking-tools, go, golang, osint, osint-tools, penetration-testing, penetration-testing-tools, reconnaissance, red-team-tools, red-teaming, subdomain-discovery, subdomain-enumeration
- Language: Go
- Homepage: https://github.com/hueristiq/xsubfind3r
- Size: 370 KB
- Stars: 105
- Watchers: 4
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# X Subdomain Finder (`xsubfind3r`)
 [](https://goreportcard.com/report/github.com/hueristiq/xsubfind3r) [](https://github.com/hueristiq/xsubfind3r/releases) [](https://github.com/hueristiq/xsubfind3r/issues?q=is:issue+is:open) [](https://github.com/hueristiq/xsubfind3r/issues?q=is:issue+is:closed) [](https://github.com/hueristiq/xsubfind3r/blob/master/LICENSE)  [](https://github.com/hueristiq/xsubfind3r/blob/master/CONTRIBUTING.md)
`xsubfind3r` is a command-line utility designed to discover subdomains for a given domain in a simple, efficient way. It works by gathering information from a variety of passive sources, meaning it doesn't interact directly with the target but instead gathers data that is already publicly available. This makes `xsubfind3r` a powerful tool for security researchers, IT professionals, and anyone looking to gain insights into the subdomains associated with a domain.
## Resource
* [Features](#features)
* [Installation](#installation)
* [Install release binaries (Without Go Installed)](#install-release-binaries-without-go-installed)
* [Install source (With Go Installed)](#install-source-with-go-installed)
* [`go install ...`](#go-install)
* [`go build ...`](#go-build)
* [Install on Docker (With Docker Installed)](#install-on-docker-with-docker-installed)
* [Post Installation](#post-installation)
* [Usage](#usage)
* [Contributing](#contributing)
* [Licensing](#licensing)
* [Credits](#credits)
* [Contributors](#contributors)
* [Similar Projects](#similar-projects)
## Features
* Fetches subdomains from multiple online passive sources to provide extensive results
* Supports `stdin` and `stdout` for easy integration in automated workflows
* Cross-Platform (Windows, Linux, and macOS)
## Installation
### Install release binaries (Without Go Installed)
Visit the [releases page](https://github.com/hueristiq/xsubfind3r/releases) and find the appropriate archive for your operating system and architecture. Download the archive from your browser or copy its URL and retrieve it with `wget` or `curl`:
* ...with `wget`:
```bash
wget https://github.com/hueristiq/xsubfind3r/releases/download/v/xsubfind3r--linux-amd64.tar.gz
```
* ...or, with `curl`:
```bash
curl -OL https://github.com/hueristiq/xsubfind3r/releases/download/v/xsubfind3r--linux-amd64.tar.gz
```
...then, extract the binary:
```bash
tar xf xsubfind3r--linux-amd64.tar.gz
```
> [!TIP]
> The above steps, download and extract, can be combined into a single step with this onliner
>
> ```bash
> curl -sL https://github.com/hueristiq/xsubfind3r/releases/download/v/xsubfind3r--linux-amd64.tar.gz | tar -xzv
> ```
> [!NOTE]
> On Windows systems, you should be able to double-click the zip archive to extract the `xsubfind3r` executable.
...move the `xsubfind3r` binary to somewhere in your `PATH`. For example, on GNU/Linux and OS X systems:
```bash
sudo mv xsubfind3r /usr/local/bin/
```
> [!NOTE]
> Windows users can follow [How to: Add Tool Locations to the PATH Environment Variable](https://msdn.microsoft.com/en-us/library/office/ee537574(v=office.14).aspx) in order to add `xsubfind3r` to their `PATH`.
### Install source (With Go Installed)
Before you install from source, you need to make sure that Go is installed on your system. You can install Go by following the [official instructions](https://go.dev/doc/install) for your operating system. For this, we will assume that Go is already installed.
#### `go install ...`
```bash
go install -v github.com/hueristiq/xsubfind3r/cmd/xsubfind3r@latest
```
#### `go build ...`
* Clone the repository
```bash
git clone https://github.com/hueristiq/xsubfind3r.git
```
* Build the utility
```bash
cd xsubfind3r/cmd/xsubfind3r && \
go build .
```
* Move the `xsubfind3r` binary to somewhere in your `PATH`. For example, on GNU/Linux and OS X systems:
```bash
sudo mv xsubfind3r /usr/local/bin/
```
Windows users can follow [How to: Add Tool Locations to the PATH Environment Variable](https://msdn.microsoft.com/en-us/library/office/ee537574(v=office.14).aspx) in order to add `xsubfind3r` to their `PATH`.
> [!CAUTION]
> While the development version is a good way to take a peek at `xsubfind3r`'s latest features before they get released, be aware that it may have bugs. Officially released versions will generally be more stable.
### Install on Docker (With Docker Installed)
If you have Docker installed, you can use `xsubfind3r` using it's image:
* Pull the docker image using:
```bash
docker pull hueristiq/xsubfind3r:latest
```
* Run `xsubfind3r` using the image:
```bash
docker run --rm hueristiq/xsubfind3r:latest -h
```
## Post Installation
`xsubfind3r` will work right after [installation](#installation). However, some sources require API keys to work. These keys can be added to a configuration file at `$HOME/.config/xsubfind3r/config.yaml`, created upon first run, or set as environment variables.
Example of environment variables for API keys:
```bash
XSUBFIND3R_KEYS_BEVIGIL=your_bevigil_key
XSUBFIND3R_KEYS_CENSYS=your_censys_key
```
## Usage
To start using `xsubfind3r`, open your terminal and run the following command for a list of options:
```bash
xsubfind3r -h
```
Here's what the help message looks like:
```text
_ __ _ _ _____
__ _____ _ _| |__ / _(_)_ __ __| |___ / _ __
\ \/ / __| | | | '_ \| |_| | '_ \ / _` | |_ \| '__|
> <\__ \ |_| | |_) | _| | | | | (_| |___) | |
/_/\_\___/\__,_|_.__/|_| |_|_| |_|\__,_|____/|_|
v0.9.1
USAGE:
xsubfind3r [OPTIONS]
CONFIGURATION:
-c, --configuration string configuration file (default: $HOME/.config/xsubfind3r/config.yaml)
INPUT:
-d, --domain string[] target domain
-l, --list string target domains list file path
TIP: For multiple input domains use comma(,) separated value with `-d`,
specify multiple `-d`, load from file with `-l` or load from stdin.
SOURCES:
--sources bool list supported sources
-u, --sources-to-use string[] comma(,) separated sources to use
-e, --sources-to-exclude string[] comma(,) separated sources to exclude
OUTPUT:
--monochrome bool display no color output
-o, --output string output subdomains file path
-O, --output-directory string output subdomains directory path
-s, --silent bool display output subdomains only
-v, --verbose bool display verbose output
```
For example, to discover subdomains for `example.com`:
```bash
xsubfind3r -d example.com
```
You can also use multiple domains by separating them with commas or providing a list from a file.
## Contributing
We welcome contributions! Feel free to submit [Pull Requests](https://github.com/hueristiq/xsubfind3r/pulls) or report [Issues](https://github.com/hueristiq/xsubfind3r/issues). For more details, check out the [contribution guidelines](https://github.com/hueristiq/xsubfind3r/blob/master/CONTRIBUTING.md).
## Licensing
This utility is licensed under the [MIT license](https://opensource.org/license/mit). You are free to use, modify, and distribute it, as long as you follow the terms of the license. You can find the full license text in the repository - [Full MIT license text](https://github.com/hueristiq/xsubfind3r/blob/master/LICENSE).
## Credits
### Contributors
A huge thanks to all the contributors who have helped make `xsubfind3r` what it is today!
[](https://github.com/hueristiq/xsubfind3r/graphs/contributors)
### Similar Projects
If you're interested in more utilities like this, check out:
[assetfinder](https://github.com/tomnomnom/assetfinder) ◇ [amass](https://github.com/owasp-amass/amass) ◇ [subfinder](https://github.com/projectdiscovery/subfinder)