Yaraflux

🚀 Yara 項目文檔

Yara 項目是一個功能強大的安全檢測工具，可用於掃描內存、文件等，檢測潛在威脅。它提供了豐富的配置選項和便捷的使用方式，支持多種部署模式，方便開發者進行開發和維護。

🚀 快速開始

你可以按照以下步驟快速啟動 Yara 項目：

# 克隆倉庫
git clone https://github.com/ThreatFlux/Yara.git
cd Yara

# 安裝依賴項
make install

# 運行應用
python run.py

📦 安裝指南

安裝步驟

1. 克隆倉庫：

   git clone https://github.com/ThreatFlux/Yara.git
   cd Yara
   

2. 安裝依賴項：
   • 使用 Makefile 自動化腳本進行安裝：

     make install
     

   • 或者手動安裝：

     pip install -r requirements.txt
     

3. 運行應用：

   python run.py
   

💻 使用示例

基礎用法

from yara import YaraScanner

scanner = YaraScanner()
result = scanner.scan_file("target.exe")
print(result)

高級用法

from yara import YaraScanner

scanner = YaraScanner()
scan_result = scanner.scan_memory(b"some bytes")
print(f"檢測到威脅: {scan_result.detected_threats}")

📚 詳細文檔

配置選項

• 日誌級別：
  • 調試模式：DEBUG
  • 開發模式：INFO
  • 生產環境：WARNING、ERROR 或 CRITICAL
• 存儲後端：
  • 本地文件系統：默認配置
  • MinIO/S3 存儲：需額外配置訪問信息

工作流程

• 構建階段：

  make build
  

  生成可執行文件和 Docker 鏡像。
• 測試階段：

  make test
  

  執行單元測試和集成測試。
• 部署階段：
  • 使用 Docker 部署：

    docker-compose up --build
    

開發信息

本地開發

make dev-setup

運行開發服務器：

make run-dev

CI/CD 流水線

• 測試流水線：
  • 在 main 和 develop 分支上自動執行。
  • 包括代碼格式檢查、靜態分析和單元測試。
• 版本發佈：

  make release
  

  自動遞增版本號並生成發佈說明。

狀態檢查

• 格式檢查：確保代碼符合 Black 和 isort 格式規範。
• 代碼質量：執行 lint 檢查以保證代碼標準。
• 測試覆蓋率：達到預設的測試覆蓋率要求。

貢獻指南

1. 創建功能分支：

   git checkout -b feature/amazing-feature main
   

2. 提交更改：

   git add .
   git commit -m '實現新特性'
   

3. 推送分支並創建拉取請求。

支持與捐贈

• Patreon：支持作者，請訪問 Patreon 鏈接
• PayPal：捐贈至 email@example.com

🔧 技術細節

本地開發

make dev-setup

運行開發服務器：

make run-dev

CI/CD 流水線

• 測試流水線：
  • 在 main 和 develop 分支上自動執行。
  • 包括代碼格式檢查、靜態分析和單元測試。
• 版本發佈：

  make release
  

  自動遞增版本號並生成發佈說明。

📄 API 文檔

• Swagger UI：訪問 http://localhost:8000/docs
• ReDoc：訪問 http://localhost:8000/redoc
• 詳細文檔請參考 API 參考

🤝 貢獻指南

歡迎貢獻！請按照以下步驟提交代碼：

1. Fork 倉庫。
2. 創建功能分支。
3. 提交代碼並生成 commit 消息。
4. 推送分支到遠程倉庫。
5. 提交 Pull Request。

📄 許可證

本項目遵循 MIT 協議。詳細內容請查看 LICENSE 文件。