ZeroPulse

---

📋 目次

• 概要
• 機能
• アーキテクチャ
• 前提条件
• インストール
• 設定
• 使用方法
• API ドキュメント
• セキュリティ
• プロジェクト構成
• 開発
• コントリビューション
• ライセンス
• 謝辞
• サポート

🎯 概要

ZeroPulse は、安全なリモート管理と監視のために設計された、包括的なコマンド＆コントロール（C2）プラットフォームです。Cloudflare Tunnel テクノロジーを活用し、インフラストラクチャをパブリックインターネットに公開することなく、安全で暗号化された接続を提供します。

⚠️ 開発ステータス: このプロジェクトは現在活発に開発中です。このバージョンはデモ/アルファ版であり、一部の機能は次の状態である可能性があります：

• 不安定、または破壊的な変更が加えられる可能性があります
• 不完全、または部分的にしか実装されていません
• 活発に開発中で、頻繁に更新されます

このソフトウェアはテストおよび評価目的のみでの使用を推奨します。本番環境での使用は、安定版のリリースをお待ちいただくか、自己責任でご利用ください。

主な特長

• 🔒 デフォルトで安全: 組み込みの認証、セッション管理、API トークンシステム
• 🌐 Cloudflare 統合: Cloudflare API によるシームレスな DNS およびトンネル管理
• 🖥️ リモート管理: WinRM と SSH のサポート、対話型シェル向けの evil-winrm 統合
• 📊 モダンな UI: リアルタイム端末統合を備えた、美しくレスポンシブな React インターフェース
• 🚀 パフォーマンス最適化: ノンブロッキング I/O、最適化されたデータベースクエリ、メモリリーク防止
• 🖥️ ローカルシェルアクセス: リアルタイム端末エミュレーションを備えた WebSocket 経由の対話型ローカルシェル

✨ 機能

中核機能

• トンネル管理

  • Cloudflare トンネルの作成と管理
  • イングレスルールの設定（HTTP、HTTPS、TCP）
  • 自動 DNS レコード管理
  • ルートプロキシ管理

• リモートコマンド実行

  • WinRM を介したリモート Windows システムでのコマンド実行
  • evil-winrm 統合による対話型シェル（パスワード＆NTLM ハッシュ認証）
  • SSH コマンド実行および対話型セッション
  • PowerShell スクリプト実行
  • コマンド履歴の追跡
  • リアルタイム出力ストリーミング
  • 動的モジュール実行を備えたモジュールコントロールパネル

• リモートデスクトップ

  • VNC サーバーの検出と管理
  • noVNC ベースの Web リモートデスクトップクライアント
  • Windows および Linux システムのサポート
  • 安全なトンネルベースの接続

• セッションとセキュリティ

  • JWT ベースの認証
  • アクティブセッション管理
  • きめ細かな権限を持つ API トークンシステム
  • トークンのブラックリスト化と失効
  • ロールベースのアクセス制御（RBAC）

• DNS 管理

  • DNS レコードの自動作成・更新
  • CNAME、A、AAAA レコードのサポート
  • Cloudflare プロキシ設定
  • 競合解決

• ローカルシェルアクセス

  • WebSocket 経由の対話型ローカルシェル
  • xterm.js によるリアルタイム端末エミュレーション
  • スタンドアロンウィンドウのサポート
  • 最適なパフォーマンスのためのノンブロッキング I/O

• モジュール制御システム

  • データベースからの動的モジュール読み込み
  • 階層構造（カテゴリ → セクション → アイテム）
  • 変数置換を備えたテンプレートエンジン
  • 対話型端末統合
  • コマンド実行履歴

⚙️ 技術スタック

レイヤー	テクノロジー	目的
フロントエンド	React 19、Redux Toolkit、React Router、TailwindCSS、xterm.js	ユーザーインターフェース
バックエンド	FastAPI、Uvicorn	API サーバー
データベース	SQLite（最適化されたクエリとインデックスを使用）	データ永続化
認証	JWT、python-jose	トークンベースの認証
リモート実行	pywinrm、paramiko、evil-winrm	WinRM および SSH 統合
ターミナル	xterm.js、WebSocket	対話型ターミナル
外部 API	requests、cloudflare	サービス統合
プロセス管理	subprocess、asyncio、threading	バックグラウンドタスク

📦 前提条件

システム要件

• OS: Linux（Ubuntu 20.04+、Debian 11+、またはその他のモダンな Linux ディストリビューション）
• Python: 3.8 以上
• Node.js: 20.19.0+ または 22.12.0+（フロントエンドディレクトリの .nvmrc を参照）
• npm: Node.js に同梱
• Cloudflare アカウント: API トークンとアカウント ID が必要
• Ruby（オプション）: evil-winrm サポート用（gem install evil-winrm）

必要なソフトウェア```bash

Ubuntu/Debian

sudo apt update sudo apt install -y python3 python3-pip python3-venv git curl

Install Node.js 20+ (using nvm recommended)

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash source ~/.bashrc nvm install 20.19.0 nvm use 20.19.0

Optional: Install Ruby for evil-winrm

sudo snap install ruby --classic gem install evil-winrm

Verify versions

python3 --version # Should be 3.8+ node --version # Should be 20.19.0+ or 22.12.0+ npm --version

## 🚀 インストール

<div align="center">
  <img src="https://assets.kitploit.com/production/public/readmes/7371/63f8299d6bb31aaa64c5e271f4e78bcb3ea94ef8ae7a2f1e2e3b6205552fb8b2.png" alt="インストールセットアップ" />
  <p><em>インストールプロセス - 新システムへのZeroPulseのセットアップ</em></p>
</div>

### 1. リポジトリをクローン```bash
git clone https://github.com/yourusername/zeropulse.git
cd zeropulse

2. バックエンドのセットアップ```bash

Create virtual environment

python3 -m venv venv

Activate virtual environment

source venv/bin/activate

Upgrade pip

pip install --upgrade pip

Install dependencies

pip install -r requirements.txt

### 3. フロントエンドのセットアップ```bash
cd frontend

# Check Node.js version (should be 20.19.0+ or 22.12.0+)
node --version

# If using nvm, switch to required version
nvm use  # Automatically uses version from .nvmrc

# Install dependencies
npm install

# Build frontend
npm run build

cd ..

4. 環境変数の設定

プロジェクトのルートに .env ファイルを作成します:```bash cat > .env << EOF

Authentication Settings

ADMIN_USERNAME=admin ADMIN_PASSWORD=your-secure-password-here JWT_SECRET_KEY=$(python3 -c "import secrets; print(secrets.token_urlsafe(32))") JWT_ALGORITHM=HS256 JWT_EXPIRATION_HOURS=24

Cloudflare Settings

CLOUDFLARE_API_TOKEN=your-cloudflare-api-token-here CLOUDFLARE_ACCOUNT_ID=your-cloudflare-account-id-here CLOUDFLARE_DOMAIN=your-domain.com

WinRM Settings (optional)

WINRM_USERNAME=WinRMUser WINRM_PASSWORD=your-secure-password-here

SSH Settings (optional)

SSH_KEY_PATH=/path/to/ssh/key SSH_USERNAME=ssh_user

C2 Server Settings

C2_SERVER_HOST=0.0.0.0 C2_SERVER_PORT=8000 ENVIRONMENT=production

Database Settings

DATABASE_PATH=data/database.db EOF

Set permissions

chmod 600 .env

### 5. サーバーを起動する```bash
# Ensure virtual environment is active
source venv/bin/activate

# Start the server
python3 run_server.py

サーバーには http://localhost:8000 でアクセスできます

⚙️ 設定

環境変数

変数	説明	デフォルト
ADMIN_USERNAME	管理者ユーザー名	admin
ADMIN_PASSWORD	管理者パスワード	-
JWT_SECRET_KEY	JWT署名キー	-
JWT_EXPIRATION_HOURS	トークン有効期限	24
CLOUDFLARE_API_TOKEN	Cloudflare APIトークン	-
CLOUDFLARE_ACCOUNT_ID	CloudflareアカウントID	-
CLOUDFLARE_DOMAIN	お使いのドメイン	-
WINRM_USERNAME	WinRMユーザー名	WinRMUser
WINRM_PASSWORD	WinRMパスワード	-
SSH_KEY_PATH	SSH秘密鍵のパス	-
SSH_USERNAME	SSHユーザー名	-
C2_SERVER_HOST	サーバーホスト	0.0.0.0
C2_SERVER_PORT	サーバーポート	8000
ENVIRONMENT	環境モード	development
DATABASE_PATH	データベースファイルのパス	data/database.db

Cloudflare APIトークンの権限

Cloudflare APIトークンには以下の権限が必要です：

• ゾーン: Zone:Read、DNS:Edit
• アカウント: Cloudflare Tunnel:Edit
• ゾーンリソース: お使いのドメインゾーンを含める

トンネルの管理

機能

• 動的ポートマッピング: ローカルポートをトンネルルートにマッピング
• サービスプロキシ: HTTP、HTTPS、TCPサービスをプロキシ
• 自動管理: プロキシプロセスの開始、停止、監視
• ポート検出: 利用可能なポートを自動的に検出
• ステータス監視: アクティブな全プロキシのリアルタイムステータス

1. トンネルの作成: ダッシュボード → トンネルの作成 に移動
2. ルートの設定: HTTP、HTTPS、TCPサービスのイングレスルールを設定
3. DNSの管理: DNSレコードの自動作成・更新
4. ステータスの監視: トンネルのヘルスと接続ステータスを表示