mirror of
https://github.com/sherlock-project/sherlock
synced 2024-11-26 05:40:19 +00:00
184 lines
7.1 KiB
Markdown
184 lines
7.1 KiB
Markdown
<p align=center>
|
|
<br>
|
|
<a href="https://sherlock-project.github.io/" target="_blank"><img src="https://user-images.githubusercontent.com/27065646/53551960-ae4dff80-3b3a-11e9-9075-cef786c69364.png"/></a>
|
|
<br>
|
|
<span>Hunt down social media accounts by username across <a href="https://github.com/sherlock-project/sherlock/blob/master/sites.md">social networks</a></span>
|
|
<br>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="#installation">Installation</a>
|
|
|
|
|
<a href="#usage">Usage</a>
|
|
|
|
|
<a href="#docker-notes">Docker Notes</a>
|
|
|
|
|
<a href="#contributing">Contributing</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img width="70%" height="70%" src="https://user-images.githubusercontent.com/27065646/219638267-a5e11090-aa6e-4e77-87f7-0e95f6ad5978.png"/>
|
|
</a>
|
|
</p>
|
|
|
|
|
|
## Installation
|
|
|
|
```console
|
|
# clone the repo
|
|
$ git clone https://github.com/sherlock-project/sherlock.git
|
|
|
|
# change the working directory to sherlock
|
|
$ cd sherlock
|
|
|
|
# install the requirements
|
|
$ python3 -m pip install -r requirements.txt
|
|
```
|
|
|
|
## Usage
|
|
|
|
```console
|
|
$ python3 sherlock --help
|
|
usage: sherlock [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT]
|
|
[--output OUTPUT] [--tor] [--unique-tor] [--csv] [--xlsx]
|
|
[--site SITE_NAME] [--proxy PROXY_URL] [--json JSON_FILE]
|
|
[--timeout TIMEOUT] [--print-all] [--print-found] [--no-color]
|
|
[--browse] [--local] [--nsfw]
|
|
USERNAMES [USERNAMES ...]
|
|
|
|
Sherlock: Find Usernames Across Social Networks (Version 0.14.3)
|
|
|
|
positional arguments:
|
|
USERNAMES One or more usernames to check with social networks.
|
|
Check similar usernames using {?} (replace to '_', '-', '.').
|
|
|
|
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.
|
|
--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.
|
|
--xlsx Create the standard file for the modern Microsoft Excel
|
|
spreadsheet (xlsx).
|
|
--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.
|
|
--timeout TIMEOUT Time (in seconds) to wait for response to requests (Default: 60)
|
|
--print-all Output sites where the username was not found.
|
|
--print-found Output sites where the username was found.
|
|
--no-color Don't color terminal output
|
|
--browse, -b Browse to all results on default browser.
|
|
--local, -l Force the use of the local data.json file.
|
|
--nsfw Include checking of NSFW sites from default list.
|
|
```
|
|
|
|
To search for only one user:
|
|
```
|
|
python3 sherlock user123
|
|
```
|
|
|
|
To search for more than one user:
|
|
```
|
|
python3 sherlock 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
|
|
```
|
|
|
|
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
|
|
```
|
|
|
|
Docker is instructed to create (or use) the folder `results` in the current working directory and to mount it at `/opt/sherlock/results` on the docker container by using the ```-v "$PWD/results:/opt/sherlock/results"``` options. `Sherlock` is instructed to export the result using the `-o /opt/sherlock/results/text.txt` option.
|
|
|
|
|
|
### 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
|
|
```
|
|
|
|
## Contributing
|
|
We would love to have you help us with the development of Sherlock. Each and every contribution is greatly valued!
|
|
|
|
Here are some things we would appreciate your help on:
|
|
- Addition of new site support ¹
|
|
- Bringing back site support of [sites that have been removed](removed_sites.md) in the past due to false positives
|
|
|
|
[1] Please look at the Wiki entry on [adding new sites](https://github.com/sherlock-project/sherlock/wiki/Adding-Sites-To-Sherlock)
|
|
to understand the issues.
|
|
|
|
## 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.
|
|
|
|
```console
|
|
$ cd sherlock/sherlock
|
|
$ python3 -m unittest tests.all --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 problems. Any problems in connection will show up as
|
|
warnings in the tests instead of true errors.
|
|
|
|
If some sites are failing due to connection problems (site is down, in maintenance, 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).
|
|
|
|
## Star History
|
|
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=sherlock-project/sherlock&type=Date&theme=dark" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=sherlock-project/sherlock&type=Date" />
|
|
<img alt="Sherlock Project Star History Chart" src="https://api.star-history.com/svg?repos=sherlock-project/sherlock&type=Date" />
|
|
</picture>
|
|
|
|
## License
|
|
|
|
MIT © Sherlock Project<br/>
|
|
Original Creator - [Siddharth Dushantha](https://github.com/sdushantha)
|