whitzard-claw 1.0.0

package/README.md

@@ -0,0 +1,89 @@
+# Whitzard-Claw Security Scanner
+
+Whitzard-Claw 是一个基于 OpenClaw 的安全扫描工具，提供 TUI（终端用户界面）和 WebUI（Web 用户界面）两种交互方式。
+
+## 安装
+
+### 从 npm 安装（推荐）
+
+```bash
+npm install -g whitzard-claw
+```
+
+### 从源码安装
+
+```bash
+# 克隆或下载源码后
+cd whitzard-claw
+npm install
+npm run build
+npm link
+```
+
+## 使用方法
+
+安装完成后，可以使用以下两个命令：
+
+### 1. TUI 模式（终端界面）
+
+```bash
+claw-tui
+```
+
+**快捷键：**
+- `check` + Enter: 开始安全扫描
+- `Up/Down`: 滚动查看漏洞列表
+- `c`: 进入选择模式（可用空格键切换自动修复选项）
+- `f`: 执行选中的自动修复
+- `Esc`: 退出选择模式
+
+### 2. WebUI 模式（Web 界面）
+
+```bash
+claw-webui
+```
+
+然后在浏览器中访问：http://localhost:12340
+
+## 配置
+
+### OPENCLAW_HOME 环境变量
+
+设置 OpenClaw 工作目录的路径：
+
+```bash
+export OPENCLAW_HOME=/path/to/your/openclaw
+```
+
+或在 WebUI 的设置页面中配置。
+
+默认路径为：`~/.openclaw`
+
+## 系统要求
+
+- Node.js >= 18.0.0
+- Linux 操作系统（推荐 Ubuntu/Debian）
+- Bash shell
+
+## 功能特性
+
+- **7 大类安全检查**：网络暴露、访问控制、执行沙箱、凭证存储、记忆毒化、供应链、资源成本
+- **实时进度显示**：在 TUI 和 WebUI 中实时查看扫描进度
+- **自动修复建议**：对检测到的问题提供修复指导和自动化脚本
+- **IOC 数据支持**：支持自定义 IOC（威胁情报）数据文件
+
+## 目录结构
+
+```
+whitzard-claw/
+├── bin/              # CLI 命令入口
+├── dist/             # 编译后的代码
+├── scripts/          # 扫描和修复脚本
+├── ioc/              # IOC 威胁情报数据
+├── webui/            # Web 界面文件
+└── tui/              # TUI 源代码
+```
+
+## 许可证
+
+MIT License

package/bin/whitzard-tui.js

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+
+/**
+ * Whitzard-Claw TUI CLI Entry Point
+ * This script dynamically locates the compiled TUI bundle
+ */
+
+import { fileURLToPath } from 'url';
+import path from 'path';
+import { spawn } from 'child_process';
+import fs from 'fs';
+
+if (typeof global.self === 'undefined') {
+  global.self = global;
+}
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// Get the package installation directory
+const PACKAGE_DIR = path.resolve(__dirname, '..');
+
+// Try to find the compiled TUI in dist/tui/tui.js
+const TUI_PATH = path.join(PACKAGE_DIR, 'dist', 'tui', 'tui.js');
+
+// Check if TUI exists
+if (!fs.existsSync(TUI_PATH)) {
+  console.error('❌ Error: TUI bundle not found at:', TUI_PATH);
+  console.error('');
+  console.error('Please run the build process first:');
+  console.error('  npm run build');
+  console.error('');
+  console.error('Or if you installed from npm, please reinstall:');
+  console.error('  npm install -g whitzard-claw');
+  process.exit(1);
+}
+
+// Get scripts directory for reference
+const SCRIPTS_DIR = path.join(PACKAGE_DIR, 'scripts');
+
+if (!fs.existsSync(SCRIPTS_DIR)) {
+  console.error('❌ Error: Scripts directory not found at:', SCRIPTS_DIR);
+  process.exit(1);
+}
+
+// Set environment variables for Linux
+const env = {
+  ...process.env,
+  // Ensure we're using bash
+  SHELL: '/bin/bash',
+};
+
+// Execute the TUI with tsx or node
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+
+// Try to find tsx or use node directly
+let executor = 'node';
+try {
+  // Check if tsx is available
+  const tsxPath = require.resolve('tsx', { paths: [PACKAGE_DIR] });
+  executor = 'node';
+  process.argv = ['node', tsxPath, TUI_PATH, ...process.argv.slice(2)];
+} catch (e) {
+  // tsx not available, use node directly
+  process.argv = ['node', TUI_PATH, ...process.argv.slice(2)];
+}
+
+// Import and run the TUI
+import(TUI_PATH).catch(err => {
+  console.error('❌ Error running TUI:', err.message);
+  process.exit(1);
+});

package/bin/whitzard-webui.js

@@ -0,0 +1,67 @@
+#!/usr/bin/env node
+
+/**
+ * Whitzard-Claw WebUI CLI Entry Point
+ * This script dynamically locates the server.js and starts the web server
+ */
+
+import { fileURLToPath } from 'url';
+import path from 'path';
+import fs from 'fs';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// Get the package installation directory
+const PACKAGE_DIR = path.resolve(__dirname, '..');
+
+// Try to find the server in dist/webui/server.js
+const SERVER_PATH = path.join(PACKAGE_DIR, 'dist', 'webui', 'server.js');
+const INDEX_HTML_PATH = path.join(PACKAGE_DIR, 'dist', 'webui', 'index.html');
+
+// Check if server exists
+if (!fs.existsSync(SERVER_PATH)) {
+  console.error('❌ Error: WebUI server not found at:', SERVER_PATH);
+  console.error('');
+  console.error('Please run the build process first:');
+  console.error('  npm run build');
+  console.error('');
+  console.error('Or if you installed from npm, please reinstall:');
+  console.error('  npm install -g whitzard-claw');
+  process.exit(1);
+}
+
+if (!fs.existsSync(INDEX_HTML_PATH)) {
+  console.error('❌ Error: index.html not found at:', INDEX_HTML_PATH);
+  process.exit(1);
+}
+
+// Get scripts directory for reference
+const SCRIPTS_DIR = path.join(PACKAGE_DIR, 'scripts');
+const IOC_DIR = path.join(PACKAGE_DIR, 'ioc');
+
+if (!fs.existsSync(SCRIPTS_DIR)) {
+  console.error('❌ Error: Scripts directory not found at:', SCRIPTS_DIR);
+  process.exit(1);
+}
+
+// Set environment variables
+const env = {
+  ...process.env,
+  // Set package directory as environment variable for server to use
+  WHITZARD_CLAW_PACKAGE_DIR: PACKAGE_DIR,
+  WHITZARD_CLAW_SCRIPTS_DIR: SCRIPTS_DIR,
+  WHITZARD_CLAW_IOC_DIR: IOC_DIR,
+};
+
+console.log('🛡️  Starting Whitzard-Claw WebUI...');
+console.log('   Package Directory:', PACKAGE_DIR);
+console.log('   Scripts Directory:', SCRIPTS_DIR);
+console.log('');
+
+// Import and run the server
+import(SERVER_PATH).catch(err => {
+  console.error('❌ Error starting WebUI server:', err.message);
+  console.error(err.stack);
+  process.exit(1);
+});