sherlock

mirror of https://github.com/sherlock-project/sherlock synced 2024-11-27 06:10:34 +00:00

No description

Find a file

Christopher K. Hoadley 9f0b7550d8 Merge remote-tracking branch 'origin/master'		2019-04-07 11:27:24 -05:00
screenshot	Remove weird text in the gif file.	2019-03-09 15:04:55 +08:00
tests	Add test to ensure that all sites have test data. If they do not, then the person running the tests will be able to see the list of sites missing coverage.	2019-02-09 23:34:09 -06:00
.dockerignore	Adding docker support	2018-12-31 14:53:27 -06:00
.gitignore	Added Steam Group support, Added .ideadir to .gitignore	2019-02-03 14:01:27 -05:00
.travis.yml	Test files names do not comply with pytest discovery	2019-01-22 10:35:55 +01:00
CODE_OF_CONDUCT.md	Add CODE_OF_CONDUCT.md	2019-01-05 00:45:54 +03:30
CONTRIBUTING.md	Add Contribution File	2019-02-02 22:11:05 -06:00
data.json	Update rank and version information.	2019-04-07 11:26:11 -05:00
Dockerfile	Move to multi-stage docker build	2019-01-31 16:11:12 -05:00
install_packages.sh	Fix typo	2019-01-26 11:20:36 +00:00
LICENSE	Update LICENSE	2018-12-24 19:50:49 +01:00
load_proxies.py	Remove duplicate import.	2019-03-08 19:44:50 +08:00
README.md	Merge remote-tracking branch 'origin/master'	2019-04-07 11:27:24 -05:00
removed_sites.md	Added younow.com support	2019-03-31 15:59:12 +02:00
requirements.txt	Update requirements.txt	2019-01-25 12:50:50 +00:00
sherlock.py	Update rank and version information.	2019-04-07 11:26:11 -05:00
site_list.py	Fixed mixed of tabs and spaces in a single file.	2019-03-09 19:33:42 +08:00
sites.md	Update rank and version information.	2019-04-07 11:26:11 -05:00

README.md

Find usernames across social networks

Installation

NOTE: Python 3.6 or higher is required.

# 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 not exist

# install the requirements
$ pip3 install -r requirements.txt

Usage

$ 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]
                   USERNAMES [USERNAMES ...]

Sherlock: Find Usernames Across Social Networks (Version 0.5.9)

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 at this folder.
  --output OUTPUT, -o OUTPUT
                        If using single username, the output of the result
                        will be saved at 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.
  --print-found
			Prints only found messages. Errors, and invalid
			username errors will not appear.

For example, run python3 sherlock.py user123, and all of the accounts found will be stored in a text file with the username (e.g user123.txt).

Docker Notes

If you have docker 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 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

One caveat is the text file that is created will only exist in the container so you will not be able to get at that.

Or you can simply use "Docker Hub" to run sherlock:

docker run theyahya/sherlock user123

Adding New Sites

Please look at the Wiki entry on adding new sites to understand the issues.

Tests

If you are contributing to Sherlock, then Thank You!

Before creating a pull request with new development, please run the tests to ensure that all is well. 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 not uncommon to get response errors.