跳转到主要内容

Sherlock:跨社交网络查找用户名

项目描述



通过社交网络 查找 用户名对应的社交媒体账号
Website docker image

安装    |    使用    |    Docker说明    |    贡献

安装

# 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

使用

$ python3 sherlock --help
usage: sherlock [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT]
                [--output OUTPUT] [--tor] [--unique-tor] [--csv]
                [--site SITE_NAME] [--proxy PROXY_URL] [--json JSON_FILE]
                [--timeout TIMEOUT] [--print-all] [--print-found] [--no-color]
                [--browse] [--local]
                USERNAMES [USERNAMES ...]

Sherlock: Find Usernames Across Social Networks (Version 0.14.2)

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 (xslx).
  --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.

搜索单个用户

python3 sherlock user123

搜索多个用户

python3 sherlock user1 user2 user3

找到的账号将存储在带有对应用户名的单个文本文件中(例如 user123.txt)。

Anaconda(Windows)说明

如果您在Windows上使用Anaconda,使用'python3'可能不起作用。请改用'python'。

Docker说明

如果已安装docker,您可以构建一个镜像并以容器形式运行。

docker build -t mysherlock-image .

镜像构建完成后,可以通过运行以下命令调用sherlock

docker run --rm -t mysherlock-image user123

可选的 --rm 标志在完成时删除容器文件系统,以防止碎片累积。请参阅: https://docs.docker.net.cn/engine/reference/run/#clean-up---rm

可选的-t标志分配一个伪TTY,允许彩色输出。参见:https://docs.docker.net.cn/engine/reference/run/#foreground

使用以下命令访问保存的结果

docker run --rm -t -v "$PWD/results:/opt/sherlock/results" mysherlock-image -o /opt/sherlock/results/text.txt user123

-v "$PWD/results:/opt/sherlock/results"选项告诉docker在当前工作目录中创建(或使用)results文件夹,并将其挂载到docker容器中的/opt/sherlock/results-o /opt/sherlock/results/text.txt选项告诉sherlock输出结果。

或者您可以使用"Docker Hub"运行sherlock

docker run theyahya/sherlock user123

使用docker-compose

您可以从仓库中使用docker-compose.yml文件,并使用此命令

docker-compose run sherlock -o /opt/sherlock/results/text.txt user123

贡献

我们非常希望您能帮助我们一起开发Sherlock。每一份贡献都极具价值!

以下是我们希望您能帮忙的一些事情

[1] 请参阅添加新站点的Wiki条目以了解相关问题。

测试

感谢您为Sherlock做出贡献!

在创建新的开发pull request之前,请运行测试以确保一切正常工作。在开始开发前运行测试也是一个好主意,以区分您环境和Sherlock软件之间的问题。

以下是一个运行Sherlock所有测试的命令行示例。这个调用隐藏了Sherlock通常输出的进度文本,而是显示了测试的详细输出。

$ cd sherlock/sherlock
$ python3 -m unittest tests.all --verbose

请注意,我们目前有100%的测试覆盖率。不幸的是,Sherlock检查的一些站点并不总是可靠的,所以通常会得到响应问题。任何连接问题都会在测试中显示为警告而不是真正的错误。

如果某些站点由于连接问题(站点宕机、维护等)而失败,您可以通过创建一个包含要忽略的站点列表的tests/.excluded_sites文件来从测试中排除它们(每行一个站点名称)。

随着时间的推移的Star数量

Stargazers over time

许可

MIT © Sherlock项目
原始创建者 - Siddharth Dushantha

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

sherlock-hunt-0.16.0.tar.gz (21.8 kB 查看哈希)

上传时间:

构建分布

sherlock_hunt-0.16.0-py3-none-any.whl (22.0 kB 查看哈希)

上传时间: Python 3

由...