.. raw:: html

.. image:: ./pictures/logo.png

.. raw:: html

Jok3r v3 beta

.. image:: https://img.shields.io/badge/python-3.6-blue.svg :target: https://www.python.org/downloads/release/python-366/ :alt: Python 3.6

.. image:: https://readthedocs.org/projects/jok3r/badge/?version=latest :target: https://jok3r.readthedocs.io/en/latest/ :alt: Documentation ReadTheDocs

.. image:: https://img.shields.io/microbadger/image-size/koutto/jok3r.svg :target: https://hub.docker.com/r/koutto/jok3r/ :alt: Docker Size

.. image:: https://img.shields.io/docker/cloud/build/koutto/jok3r.svg :alt: Docker Build Status

.. raw:: html

网络与Web渗透测试自动化框架

www.jok3r-framework.com

警告：项目仍处于v3 Beta版本。仍在积极开发中，可能存在错误。

大量测试正在进行中：详见 https://github.com/koutto/jok3r/blob/master/tests/TESTS.rst。欢迎提出想法、报告错误、贡献代码！

.. contents:: :local: :depth: 1

============= 概述

Jok3r 是一个 Python3 CLI 应用程序，旨在帮助渗透测试人员进行网络基础设施和Web黑盒安全测试。

目标是在网络/Web渗透测试中尽可能节省时间，通过自动化尽可能多的安全测试来快速识别低挂果漏洞，从而将更多时间用于更有趣和棘手的事情！

它基于这样一个观察结果：目前存在许多针对常见网络服务的黑客开源工具/脚本（来自各种来源），可以执行从指纹识别到利用的各种任务。因此，Jok3r 的想法是将这些开源工具以智能方式组合起来，以获取更相关的成果。

============= 功能特性

渗透测试工具箱管理

• 工具选择：整合来自不同来源的50+个开源工具与脚本。
• 基于Docker：应用打包在运行Kali OS的Docker镜像中，可在Docker Hub获取。
• 开箱即用：所有工具及依赖均已安装，只需拉取Docker镜像并运行新容器。
• 更新简便：仅需运行一条命令即可轻松保持整个工具箱最新。
• 易于定制：通过简单配置文件轻松添加/移除工具。

网络基础设施安全评估

• 支持多种服务：针对最常见的TCP/UDP服务（HTTP、FTP、SSH、SMB、Oracle、MS-SQL、MySQL、PostgreSQL、VNC等）。
• 工具协同：每个安全检查由工具箱中的某个工具执行。攻击通过链式安全检查实施。
• 上下文感知：根据目标上下文（即检测到的技术、凭据、漏洞等）选择并调整要运行的安全检查。
• 侦察：自动对目标服务进行指纹识别（产品检测）。
• CVE查询：当检测到产品名称及版本时，在在线CVE数据库（使用Vulners和CVE Details）进行漏洞查询。
• 漏洞扫描：自动检查常见漏洞并尝试部分利用（自动入侵）。
• 暴力破解攻击：自动检查服务上的默认/常见凭据，必要时执行字典攻击。词列表根据目标服务优化。
• 认证后测试：找到有效凭据后，自动执行部分利用后检查。

Web安全评估

• 重点覆盖HTTP：目前支持超过60种不同的HTTP安全检查。
• Web技术检测：在安全检查之前运行基于Wappalyzer的指纹识别引擎，可检测：编程语言、框架、JS库、CMS、Web服务器和应用服务器。
• 服务器利用：自动扫描和/或利用最关键漏洞（例如RCE）在Web和应用服务器上（如JBoss、Tomcat、Weblogic、Websphere、Jenkins等）。
• CMS漏洞扫描：在主流CMS（Wordpress、Drupal、Joomla等）上自动运行漏洞扫描器。

本地数据库与报告

• 本地数据库：与目标相关的数据按任务（工作区）组织存储到本地Sqlite数据库中，并在安全测试期间持续更新。
• 类似Metasploit的交互式Shell：通过交互式Shell访问数据库，内置多条命令。
• 从Nmap导入目标：手动或通过加载Nmap结果将目标添加到任务。
• 从Shodan导入目标：手动从Shodan添加目标到任务（需要Shodan API密钥）。
• 访问所有结果：所有安全检查输出、检测到的凭据和漏洞均存储于数据库，可轻松访问。
• 报告生成：生成包含目标摘要、Web截图及所有安全测试结果的完整HTML报告。

============ 演示

• 示例1：扫描JAVA-RMI（JMX）服务：

.. image:: pictures/video-01.png :target: https://www.youtube.com/watch?v=FlbeBj5FPtI

• 示例2：扫描Joomla网站：

.. image:: pictures/video-02.png :target: https://www.youtube.com/watch?v=z4cf_8EQ59Q

============ 架构

.. image:: ./pictures/visio/architecture/jok3r-architecture.png :alt: Jok3r架构

.. image:: ./pictures/visio/flowchart/jok3r-flow-chart.svg :width: 700px :alt: Jok3r流程图

============ 安装

重要提示：推荐使用Jok3r的方式是拉取Docker镜像，这样您无需担心依赖问题和安装工具箱中的各种黑客工具。所有测试均基于Docker Hub提供的容器进行！

.. image:: https://raw.githubusercontent.com/koutto/jok3r/master/pictures/docker-logo.png

Docker镜像可在Docker Hub获取，每次更新后自动重新构建：https://hub.docker.com/r/koutto/jok3r/。该镜像最初基于官方Kali Linux Docker镜像（kalilinux/kali-linux-docker）。

.. image:: https://images.microbadger.com/badges/image/koutto/jok3r.svg :target: https://microbadger.com/images/koutto/jok3r :alt: Docker镜像大小

1. 拉取Jok3r Docker镜像：

   .. code-block:: console

    sudo docker pull koutto/jok3r
   

2. 运行新的Docker容器：

   .. code-block:: console

    sudo docker run -i -t --name jok3r-container -w /root/jok3r -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix --shm-size 2g --net=host koutto/jok3r
   

注意：

• -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix 是为了能够在Docker容器中启动GUI应用程序（例如打开Web浏览器查看报告）。需要在主机上运行 xhost +local:root。

• --shm-size 2g 用于增加共享内存大小，避免在Docker容器中阅读报告时浏览器崩溃。

• --net=host 用于共享主机接口，这是反向连接所必需的（例如，测试RCE时向容器发送Ping、获取反向Shell）。

3. 重新启动已停止的容器：

   .. code-block:: console

    sudo docker start -i jok3r-container
   

4. 在容器内打开多个Shell：

   .. code-block:: console

    sudo docker exec -it jok3r-container bash
   

============ 更新

要更新，只需从Docker Hub拉取最新的Docker镜像，然后从该新镜像运行一个新容器：

.. code-block:: console

sudo docker pull koutto/jok3r
sudo docker run -i -t --name jok3r-container-updated -w /root/jok3r -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix --shm-size 2g --net=host koutto/jok3r

注意：当然，您可以通过命令 sudo docker cp 从旧容器中检索本地数据库 local.db（包含已保存的任务、目标等）。

==================== 快速使用示例

渗透测试工具箱管理

• 显示工具箱中的所有工具：

.. code-block:: console

python3 jok3r.py toolbox --show-all

• 安装工具箱中的所有工具（Docker容器中已完成）：

.. code-block:: console

python3 jok3r.py toolbox --install-all --auto

• 更新工具箱中的所有工具，每次更新前提示确认：

.. code-block:: console

python3 jok3r.py toolbox --update-all

• 更新工具箱中的所有工具，无需任何提示：

.. code-block:: console

python3 jok3r.py toolbox --update-all --auto

信息查看

• 列出支持的服务：

.. code-block:: console

python3 jok3r.py info --services

• 显示特定服务的安全检查：

.. code-block:: console

python3 jok3r.py info --checks <service>

• 显示特定服务支持的攻击配置文件：

.. code-block:: console

python3 jok3r.py info --attack-profiles <service>

• 显示所有服务支持的产品：

.. code-block:: console

python3 jok3r.py info --products

安全测试

在本地数据库中创建新任务：

.. code-block:: console

python3 jok3r.py db

jok3rdb[default]> mission -a mayhem

[+] 任务 "mayhem" 已成功添加
[*] 当前选中任务为 mayhem

jok3rdb[mayhem]> 

单个目标：

• 以交互模式对URL运行所有安全检查，并将结果添加到"mayhem"任务：

.. code-block:: console

python3 jok3r.py attack -t https://www.example.com/ --add2db mayhem

• 对MS-SQL服务运行安全检查（无需用户交互），并将结果添加到任务：

.. code-block:: console

python3 jok3r.py attack -t 192.168.1.42:1433 -s mssql --add2db mayhem --fast

• 仅对FTP服务运行"recon"和"vulnscan"安全检查，并将结果添加到任务：

.. code-block:: console

python3 jok3r.py attack -t 192.168.1.142:21 -s ftp --cat-only recon,vulnscan --add2db mayhem

多个目标：

• 仅搜索"易得胜利"（关键漏洞且易于利用），针对任务"mayhem"中注册的所有服务：

.. code-block:: console

python3 jok3r.py attack -m mayhem --profile red-team --fast

• 对给定任务中的所有服务运行所有安全检查，并将结果存储到数据库：

.. code-block:: console

python3 jok3r.py attack -m mayhem --fast

• 仅对任务中运行在21/tcp和2121/tcp端口的FTP服务运行安全检查：

.. code-block:: console

python3 jok3r.py attack -m mayhem -f "port=21,2121;service=ftp" --fast

• 仅对任务中运行在2121/tcp端口的FTP服务以及192.168.1.42上的所有HTTP服务运行安全检查：

.. code-block:: console

python3 jok3r.py attack -m mayhem -f "port=2121;service=ftp" -f "ip=192.168.1.42;service=http"

数据库访问与报告

• 选择任务：

.. code-block:: console

python3 jok3r.py db

jok3rdb[default]> mission mayhem

[*] 当前选中任务为 mayhem

• 从Nmap结果（XML）导入主机/服务到任务范围：

.. code-block:: console

jok3rdb[mayhem]> nmap results.xml

• 从Shodan结果（IP）导入主机/服务到任务范围：

.. code-block:: console

jok3rdb[mayhem]> shodan ip

• 显示选中任务中注册的服务、主机、检测到的产品和凭据：

.. code-block:: console

jok3rdb[mayhem]> services
jok3rdb[mayhem]> hosts
jok3rdb[mayhem]> products
jok3rdb[mayhem]> creds

• 在选中任务中搜索检查结果中的字符串：

.. code-block:: console

jok3rdb[mayhem]> results --search '<search_string>'

• 显示从选中任务检查输出中自动检测到的漏洞（实验性）：

.. code-block:: console

jok3rdb[mayhem]> vulns

• 为选中任务生成HTML报告：

.. code-block:: console

jok3rdb[mayhem]> report

====================== 典型使用示例

假设您开始一个渗透测试，包含若干服务器。以下是使用JoK3r的典型示例：

1. 对范围内的服务器运行Nmap扫描。

2. 在本地数据库中创建一个新任务（例如"mayhem"）：

.. code-block:: console

python3 jok3r.py db

jok3rdb[default]> mission -a mayhem

[+] 任务 "mayhem" 已成功添加
[*] 当前选中任务为 mayhem

jok3rdb[mayhem]> 

3. 将Nmap扫描结果导入数据库：

.. code-block:: console