Cleanup README by removing usage section
Removed detailed usage instructions and examples for Sublist3r from README.
This commit is contained in:
parent
8eebb04dad
commit
b1e5d33eff
114
README.md
114
README.md
|
|
@ -37,117 +37,3 @@ pip install -r requirements.txt || true
|
||||||
# run tests
|
# run tests
|
||||||
pytest -q
|
pytest -q
|
||||||
|
|
||||||
Usage
|
|
||||||
|
|
||||||
Command line
|
|
||||||
|
|
||||||
# basic usage
|
|
||||||
python3 ./sublist3r.py -d example.com
|
|
||||||
|
|
||||||
# use the console script after activating venv
|
|
||||||
sublist3r -d example.com -t 10 -o results.txt
|
|
||||||
|
|
||||||
Options
|
|
||||||
|
|
||||||
-d, --domain Domain name to enumerate subdomains of
|
|
||||||
|
|
||||||
-b, --bruteforce Enable the subbrute bruteforce module
|
|
||||||
|
|
||||||
-p, --ports Scan found subdomains against specific TCP ports
|
|
||||||
|
|
||||||
-v, --verbose Enable verbose mode and display results in realtime
|
|
||||||
|
|
||||||
-t, --threads Number of threads to use for bruteforce or lookups
|
|
||||||
|
|
||||||
-e, --engines Comma separated list of search engines to use
|
|
||||||
|
|
||||||
-o, --output Save results to a text file
|
|
||||||
|
|
||||||
-h, --help Show help and exit
|
|
||||||
|
|
||||||
Examples
|
|
||||||
|
|
||||||
# show help
|
|
||||||
python3 sublist3r.py -h
|
|
||||||
|
|
||||||
# enumerate subdomains
|
|
||||||
python3 sublist3r.py -d example.com
|
|
||||||
|
|
||||||
# enumerate and scan ports 80 and 443
|
|
||||||
python3 sublist3r.py -d example.com -p 80,443
|
|
||||||
|
|
||||||
# enable bruteforce
|
|
||||||
python3 sublist3r.py -b -d example.com
|
|
||||||
|
|
||||||
|
|
||||||
Using Sublist3r as a module
|
|
||||||
|
|
||||||
import sublist3r
|
|
||||||
|
|
||||||
subdomains = sublist3r.main(
|
|
||||||
domain="example.com",
|
|
||||||
no_threads=40,
|
|
||||||
savefile="example_subdomains.txt",
|
|
||||||
ports=None,
|
|
||||||
silent=False,
|
|
||||||
verbose=False,
|
|
||||||
enable_bruteforce=False,
|
|
||||||
engines=None
|
|
||||||
)
|
|
||||||
|
|
||||||
print(len(subdomains), "unique subdomains found")
|
|
||||||
|
|
||||||
Return value The main function returns a set of unique subdomain strings.
|
|
||||||
|
|
||||||
Dependencies and supported Python versions
|
|
||||||
Supported Python This fork targets Python 3.8 or newer.
|
|
||||||
|
|
||||||
Key dependencies
|
|
||||||
|
|
||||||
requests
|
|
||||||
|
|
||||||
dnspython
|
|
||||||
|
|
||||||
beautifulsoup4
|
|
||||||
|
|
||||||
Install dependencies with:
|
|
||||||
pip install -r requirements.txt
|
|
||||||
Add or update requirements.txt with pinned minimums for reproducible installs.
|
|
||||||
|
|
||||||
Tests and CI
|
|
||||||
This fork includes unit tests and small repro scripts under tests/ and a GitHub Actions workflow at .github/workflows/ci.yml that runs pytest on push and pull requests.
|
|
||||||
|
|
||||||
Run tests locally:
|
|
||||||
pytest -q
|
|
||||||
|
|
||||||
License
|
|
||||||
This project is licensed under the GNU GPL v2. See the LICENSE file for details.
|
|
||||||
|
|
||||||
Credits
|
|
||||||
|
|
||||||
TheRook — subbrute integration and bruteforce approach
|
|
||||||
|
|
||||||
Bitquark — inspiration for the subbrute wordlist
|
|
||||||
|
|
||||||
Ahmed Aboul-Ela — original Sublist3r project
|
|
||||||
|
|
||||||
Contributing
|
|
||||||
|
|
||||||
If you want to contribute, please:
|
|
||||||
|
|
||||||
Fork the repository and create a feature branch.
|
|
||||||
|
|
||||||
Add tests for new behavior.
|
|
||||||
|
|
||||||
Open a pull request with a clear description and reproduction steps.
|
|
||||||
|
|
||||||
See CONTRIBUTING.md for more details.
|
|
||||||
|
|
||||||
Changelog
|
|
||||||
Unreleased
|
|
||||||
|
|
||||||
Defensive DNSdumpster CSRF extraction and fallback parsing.
|
|
||||||
|
|
||||||
Nameserver validation to avoid dnspython errors.
|
|
||||||
|
|
||||||
Unit tests and CI added.
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue