Leaktopus：一款功能強大的源代碼安全管理控制工具

關于Leaktopus 

Leaktopus是一款功能強大的源代碼安全管理控制工具，該工具主要使用Python進行開發，并基于Code C.A.I.N框架實現其功能。

 關鍵功能 

1、插件式安裝：一行代碼即可使用Docker完成工具安裝；

2、支持掃描各種包含關鍵字集的代碼源，當前支持GitHub和PasteBin等；

3、使用內置的啟發式引擎過濾結果；

4、使用泄漏標識IOL增強結果輸出，來源包括Shhgit（使用自定義規則列表）、TruffleHog、URI、電子郵件（包括所在組織的電子郵件地址）、代碼貢獻者和敏感關鍵詞等；

5、支持忽略公開代碼源；

6、支持忽略“垃圾”源；

7、獲取代碼泄漏信息；

8、內置ELK以搜索泄漏數據；

9、通知新的泄漏情況；

 工具技術棧 

1、完全Docker化；

2、基于Python Flask的后端；

3、基于Vue.js 3.x的前端；

4、SQLite數據庫；

5、使用Celery+Redis隊列執行異步任務；

 工具要求 

Docker-Compose

 工具安裝 

首先，使用下列命令將該項目源碼克隆至本地：

git clone https://github.com/PlaytikaOSS/Leaktopus.git

然后創建一個本地.env文件：

cd Leaktopus
cp .env.example .env

根據本地環境修改.env文件，然后使用下列命令運行Leaktopus：

docker-compose up -d

接下來，在瀏覽器中訪問下列地址來完成API的初始化安裝：

http://{LEAKTOPUS_HOST}:8000/api/install

API的初始化安裝完成之后，會運行在下列地址上：

http://{LEAKTOPUS_HOST}:8000/up

最后，訪問下列地址即可查看工具的UI界面并開始使用Leaktopus：

http://{LEAKTOPUS_HOST}:8080

 啟發式引擎過濾結果 

內置的啟發式引擎通過以下方式過濾搜索結果以減少誤報：

1、內容；

2、元數據；

3、代碼源忽略列表；

 API文檔 

廣大研究人員可以訪問下列地址獲取OpenAPI文檔：

http://{LEAKTOPUS_HOST}:8000/apidocs

 許可證協議 

本項目的開發與發布遵循AGPL-3.0開源許可證協議。