open-source-mirrors
/
sherlock
mirror of https://github.com/sherlock-project/sherlock
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
🔎 Hunt down social media accounts by username across social networks
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
480 Commits
2 Branches
0 Tags
37 MiB
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0f8e734d78'
${ noResults }
Go to file
Christopher K. Hoadley 0f8e734d78
Bump version. 		5 years ago
screenshot Organize image directory => screenshot. 5 years ago
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. 5 years ago
.dockerignore Adding docker support 5 years ago
.gitignore Added Steam Group support, Added .ideadir to .gitignore 5 years ago
.travis.yml Test files names do not comply with pytest discovery 5 years ago
CODE_OF_CONDUCT.md Add CODE_OF_CONDUCT.md 5 years ago
CONTRIBUTING.md Add Contribution File 5 years ago
Dockerfile Move to multi-stage docker build 5 years ago
LICENSE Update LICENSE 6 years ago
README.md Bump version. 5 years ago
data.json Provide valid claimed username. It appears that @zero77 just cloned an existing entry and did not really run the tests. 5 years ago
install_packages.sh Fix typo 5 years ago
load_proxies.py Function 'check_proxy_list' which checks anonimity of each proxy contained in a list of named tuples. Proxies are checked by using the 'check_proxy' function. 5 years ago
requirements.txt Update requirements.txt 5 years ago
sherlock.py Bump version. 5 years ago
site_list.py Fix issue with site name and url 5 years ago
sites.md Update rank information and supported site list. 5 years ago

README.md

Sherlock Build Status

Find usernames across social networks

Installation

NOTE: Python 3.6 or higher is required.

# clone the repo
$ git clone https://github.com/TheYahya/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.3)

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.

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 the tests are very much a work in progress. Significant work is required to get full test coverage. But, the current tests are working properly, and will be expanded as time goes by.

Original creator of Sherlock

Siddharth Dushantha (sdushantha)

License

MIT © Yahya SayadArbabi