mirror of
https://github.com/sherlock-project/sherlock
synced 2024-11-27 22:30:30 +00:00
215 lines
8.8 KiB
Markdown
215 lines
8.8 KiB
Markdown
<p align=center>
|
|
|
|
<img src="https://user-images.githubusercontent.com/27065646/53551960-ae4dff80-3b3a-11e9-9075-cef786c69364.png"/>
|
|
|
|
<br>
|
|
<span>Hunt down social media accounts by username across <a href="https://github.com/theyahya/sherlock/blob/master/sites.md">social networks</a></span>
|
|
<br>
|
|
<a target="_blank" href="https://www.python.org/downloads/" title="Python version"><img src="https://img.shields.io/badge/python-%3E=_3.6-green.svg"></a>
|
|
<a target="_blank" href="LICENSE" title="License: MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
|
|
<a target="_blank" href="https://travis-ci.com/TheYahya/sherlock/" title="Build Status"><img src="https://travis-ci.com/TheYahya/sherlock.svg?branch=master"></a>
|
|
<a target="_blank" href="https://twitter.com/intent/tweet?text=%F0%9F%94%8E%20Find%20usernames%20across%20social%20networks%20&url=https://github.com/sherlock-project/sherlock&hashtags=hacking,%20osint,%20bugbounty,%20reconnaissance" title="Share on Tweeter"><img src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social"></a>
|
|
<a target="_blank" href="http://sherlock-project.github.io/"><img alt="Website" src="https://img.shields.io/website-up-down-green-red/http/sherlock-project.github.io/..svg"></a>
|
|
<a target="_blank" href="https://microbadger.com/images/theyahya/sherlock"><img alt="docker image" src="https://images.microbadger.com/badges/version/theyahya/sherlock.svg"></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="#demo">Demo</a>
|
|
|
|
|
<a href="#installation">Installation</a>
|
|
|
|
|
<a href="#usage">Usage</a>
|
|
|
|
|
<a href="#docker-notes">Docker Notes</a>
|
|
|
|
|
<a href="#adding-new-sites">Adding New Sites</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://asciinema.org/a/223115">
|
|
<img src="./images/sherlock_preview.gif"/>
|
|
</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
## Demo
|
|
|
|
Use this link to test Sherlock directly in your browser:
|
|
https://elody.com/scenario/plan/16/
|
|
|
|
## Installation
|
|
|
|
**NOTE**: Python 3.6 or higher is required.
|
|
|
|
```bash
|
|
# clone the repo
|
|
$ git clone https://github.com/sherlock-project/sherlock.git
|
|
|
|
# change the working directory to sherlock
|
|
$ cd sherlock
|
|
|
|
# install python3 and python3-pip if they are not installed
|
|
|
|
# install the requirements
|
|
$ python3 -m pip install -r requirements.txt
|
|
```
|
|
[](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/sherlock-project/sherlock&tutorial=README.md)
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
$ python3 sherlock.py --help
|
|
usage: sherlock.py [-h] [--version] [--verbose] [--rank]
|
|
[--folderoutput FOLDEROUTPUT] [--output OUTPUT] [--tor]
|
|
[--unique-tor] [--csv] [--site SITE_NAME]
|
|
[--proxy PROXY_URL] [--json JSON_FILE]
|
|
[--proxy_list PROXY_LIST] [--check_proxies CHECK_PROXY]
|
|
[--timeout TIMEOUT] [--print-found]
|
|
USERNAMES [USERNAMES ...]
|
|
|
|
Sherlock: Find Usernames Across Social Networks (Version 0.10.1)
|
|
|
|
positional arguments:
|
|
USERNAMES One or more usernames to check with social networks.
|
|
|
|
optional arguments:
|
|
-h, --help show this help message and exit
|
|
--version Display version information and dependencies.
|
|
--verbose, -v, -d, --debug
|
|
Display extra debugging information and metrics.
|
|
--rank, -r Present websites ordered by their Alexa.com global
|
|
rank in popularity.
|
|
--folderoutput FOLDEROUTPUT, -fo FOLDEROUTPUT
|
|
If using multiple usernames, the output of the results
|
|
will be saved to this folder.
|
|
--output OUTPUT, -o OUTPUT
|
|
If using single username, the output of the result
|
|
will be saved to this file.
|
|
--tor, -t Make requests over Tor; increases runtime; requires
|
|
Tor to be installed and in system path.
|
|
--unique-tor, -u Make requests over Tor with new Tor circuit after each
|
|
request; increases runtime; requires Tor to be
|
|
installed and in system path.
|
|
--csv Create Comma-Separated Values (CSV) File.
|
|
--site SITE_NAME Limit analysis to just the listed sites. Add multiple
|
|
options to specify more than one site.
|
|
--proxy PROXY_URL, -p PROXY_URL
|
|
Make requests over a proxy. e.g.
|
|
socks5://127.0.0.1:1080
|
|
--json JSON_FILE, -j JSON_FILE
|
|
Load data from a JSON file or an online, valid, JSON
|
|
file.
|
|
--proxy_list PROXY_LIST, -pl PROXY_LIST
|
|
Make requests over a proxy randomly chosen from a list
|
|
generated from a .csv file.
|
|
--check_proxies CHECK_PROXY, -cp CHECK_PROXY
|
|
To be used with the '--proxy_list' parameter. The
|
|
script will check if the proxies supplied in the .csv
|
|
file are working and anonymous.Put 0 for no limit on
|
|
successfully checked proxies, or another number to
|
|
institute a limit.
|
|
--timeout TIMEOUT Time (in seconds) to wait for response to requests.
|
|
Default timeout of 60.0s.A longer timeout will be more
|
|
likely to get results from slow sites.On the other
|
|
hand, this may cause a long delay to gather all
|
|
results.
|
|
--print-found Do not output sites where the username was not found.
|
|
```
|
|
|
|
To search for only one user:
|
|
```
|
|
python3 sherlock.py user123
|
|
```
|
|
|
|
To search for more than one user:
|
|
```
|
|
python3 sherlock.py user1 user2 user3
|
|
```
|
|
|
|
Accounts found will be stored in an individual text file with the corresponding username (e.g ```user123.txt```).
|
|
|
|
## Anaconda (Windows) Notes
|
|
If you are using Anaconda in Windows, using 'python3' might not work. Use 'python' instead.
|
|
|
|
## Docker Notes
|
|
If docker is installed you can build an image and run this as a container.
|
|
|
|
```
|
|
docker build -t mysherlock-image .
|
|
```
|
|
|
|
Once the image is built, sherlock can be invoked by running the following:
|
|
|
|
```
|
|
docker run --rm -t mysherlock-image user123
|
|
```
|
|
|
|
The optional ```--rm``` flag removes the container filesystem on completion to prevent cruft build-up. See: https://docs.docker.com/engine/reference/run/#clean-up---rm
|
|
|
|
The optional ```-t``` flag allocates a pseudo-TTY which allows colored output. See: https://docs.docker.com/engine/reference/run/#foreground
|
|
|
|
Use the following command to access the saved results:
|
|
|
|
```
|
|
docker run --rm -t -v "$PWD/results:/opt/sherlock/results" mysherlock-image -o /opt/sherlock/results/text.txt user123
|
|
```
|
|
|
|
The ```-v "$PWD/results:/opt/sherlock/results"``` option tells docker to create (or use) the folder `results` in the
|
|
present working directory and to mount it at `/opt/sherlock/results` on the docker container.
|
|
The `-o /opt/sherlock/results/text.txt` option tells `sherlock` to output the result.
|
|
|
|
Or you can use "Docker Hub" to run `sherlock`:
|
|
```
|
|
docker run theyahya/sherlock user123
|
|
```
|
|
|
|
### Using `docker-compose`
|
|
|
|
You can use the `docker-compose.yml` file from the repository and use this command:
|
|
|
|
```
|
|
docker-compose run sherlock -o /opt/sherlock/results/text.txt user123
|
|
```
|
|
|
|
## Adding New Sites
|
|
|
|
Please look at the Wiki entry on
|
|
[adding new sites](https://github.com/TheYahya/sherlock/wiki/Adding-Sites-To-Sherlock)
|
|
to understand the issues.
|
|
|
|
**NOTE**: Sherlock is not accepting adult sites in the standard list.
|
|
|
|
## Tests
|
|
Thank you for contributing to Sherlock!
|
|
|
|
Before creating a pull request with new development, please run the tests
|
|
to ensure that everything is working great. It would also be a good idea to run the tests
|
|
before starting development to distinguish problems between your
|
|
environment and the Sherlock software.
|
|
|
|
The following is an example of the command line to run all the tests for
|
|
Sherlock. This invocation hides the progress text that Sherlock normally
|
|
outputs, and instead shows the verbose output of the tests.
|
|
|
|
```
|
|
$ python3 -m unittest tests.all --buffer --verbose
|
|
```
|
|
|
|
Note that we do currently have 100% test coverage. Unfortunately, some of
|
|
the sites that Sherlock checks are not always reliable, so it is common
|
|
to get response errors.
|
|
|
|
If some sites are failing due to conection problems (site is down, in maintainence, etc)
|
|
you can exclude them from tests by creating a `tests/.excluded_sites` file with a
|
|
list of sites to ignore (one site name per line).
|
|
|
|
## Stargazers over time
|
|
|
|
[](https://starcharts.herokuapp.com/TheYahya/sherlock)
|
|
|
|
## License
|
|
|
|
MIT © Sherlock Project<br/>
|
|
Original Creator - [Siddharth Dushantha](https://github.com/sdushantha)
|