sherlock

mirror of https://github.com/sherlock-project/sherlock synced 2024-11-22 20:03:03 +00:00

No description

Find a file

Christopher K. Hoadley 77d62bca10 Fix Error When csv Is Written When Username Is Illegal For A Site This problem happens during the write to the CSV. There are various results that are gathered during the query for the existence of a given site, and they are always expected to exist in the results dictionary. However, if a given user name has an illegal format for a given site, then the query is not even attempted. Which leaves some keys in the dictionary undefined. The solution is to define these keys even in the case where the username has an illegal format.		2019-07-16 06:35:57 -05:00
screenshot	Remove weird text in the gif file.	2019-03-09 15:04:55 +08:00
tests	Update tests.all.SherlockDetectTests so it will only run tests against the detection methods.	2019-07-14 18:31:55 -05:00
.dockerignore	ISSUE-238 Improved build steps in Dockerfile to allow caching and improved docker instructions	2019-07-13 22:18:18 +02:00
.gitignore	Added Steam Group support, Added .ideadir to .gitignore	2019-02-03 14:01:27 -05:00
.travis.yml	Travis CI's default distro is now Xenial	2019-07-15 13:30:34 +02:00
CODE_OF_CONDUCT.md	Add CODE_OF_CONDUCT.md	2019-01-05 00:45:54 +03:30
CONTRIBUTING.md	Add note about adult sites.	2019-07-12 05:52:17 -05:00
data.json	Fix Virgool	2019-07-15 21:23:31 +10:00
Dockerfile	ISSUE-238 Improved build steps in Dockerfile to allow caching and improved docker instructions	2019-07-13 22:18:18 +02: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	Try to back out "Fix stray f's that break on Linux" #198 . The user was getting a syntax error from the format strings (probably from using an old version of Python). But, blindly removing the f-strings broke the actual functionality.	2019-05-15 07:39:39 -05:00
README.md	Merge branch 'pr/n239_krufab'	2019-07-14 11:16:32 -05:00
removed_sites.md	On 2019-04-02, Google shutdown Google Plus. While the content for some users is available after that point, it is going away. And, no one will be able to create a new account. So, there is no value is keeping it in Sherlock.	2019-04-07 20:49:09 -05:00
requirements.txt	Update requirements.txt	2019-01-25 12:50:50 +00:00
sherlock.py	Fix Error When csv Is Written When Username Is Illegal For A Site	2019-07-16 06:35:57 -05:00
site_list.py	Change method used to get site ranking. Not only has alexa.com changed the format of their web site, they also seem to have gotten even more picky about people scraping it. So, use their API to query the site data.	2019-05-28 07:26:30 -05:00
sites.md	Update site list and ranking. Update version.	2019-07-14 11:02:36 -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.6.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 to search for user:

python3 sherlock.py user123

All of the accounts found will be stored in a text file with the username (e.g user123.txt).

To search for more that user:

python3 sherlock.py user1 user2 user3

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 -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

It is possible to 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 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 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.

NOTE: Sherlock is not accepting adult sites in the standard list.

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.