├── .github └── workflows │ └── publish.yml ├── package.json ├── .gitignore ├── README.md ├── xping.mjs └── LICENSE /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish to NPM 2 | 3 | on: 4 | push: 5 | branches: [ main ] 6 | 7 | jobs: 8 | publish: 9 | runs-on: ubuntu-latest 10 | 11 | steps: 12 | - uses: actions/checkout@v4 13 | 14 | - uses: actions/setup-node@v4 15 | with: 16 | node-version: '18' 17 | registry-url: 'https://registry.npmjs.org' 18 | 19 | - run: npm ci 20 | - run: | 21 | CURRENT_VERSION=$(node -p "require('./package.json').version") 22 | TIMESTAMP=$(date +%Y%m%d%H%M%S) 23 | NEW_VERSION="${CURRENT_VERSION}-${TIMESTAMP}" 24 | echo "Setting version to: $NEW_VERSION" 25 | npm version "$NEW_VERSION" --no-git-tag-version 26 | - run: npm publish --access public 27 | env: 28 | NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} 29 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@nabikaz/xping", 3 | "version": "1.0.0", 4 | "description": "VLESS connection ping tool using Xray with fragment support", 5 | "main": "xping.mjs", 6 | "type": "module", 7 | "bin": { 8 | "xping": "./xping.mjs" 9 | }, 10 | "scripts": { 11 | "start": "node xping.mjs", 12 | "test": "echo \"Error: no test specified\" && exit 1" 13 | }, 14 | "keywords": [ 15 | "xray", 16 | "vless", 17 | "ping", 18 | "proxy", 19 | "fragment", 20 | "connection-test", 21 | "network-tool" 22 | ], 23 | "author": "NabiKAZ", 24 | "license": "GPL-3.0-only", 25 | "repository": { 26 | "type": "git", 27 | "url": "git+https://github.com/NabiKAZ/xping.git" 28 | }, 29 | "bugs": { 30 | "url": "https://github.com/NabiKAZ/xping/issues" 31 | }, 32 | "homepage": "https://github.com/NabiKAZ/xping#readme", 33 | "dependencies": { 34 | "chalk": "^5.3.0", 35 | "undici": "^6.2.1", 36 | "yargs": "^18.0.0" 37 | }, 38 | "engines": { 39 | "node": ">=16.0.0" 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Node.js 2 | node_modules/ 3 | npm-debug.log* 4 | yarn-debug.log* 5 | yarn-error.log* 6 | .npm 7 | .yarn/ 8 | .pnp.* 9 | 10 | # Environment variables 11 | .env 12 | .env.local 13 | .env.development.local 14 | .env.test.local 15 | .env.production.local 16 | 17 | # IDE and Editor files 18 | .vscode/ 19 | .idea/ 20 | *.swp 21 | *.swo 22 | *~ 23 | 24 | # OS generated files 25 | .DS_Store 26 | .DS_Store? 27 | ._* 28 | .Spotlight-V100 29 | .Trashes 30 | ehthumbs.db 31 | Thumbs.db 32 | 33 | # Logs 34 | logs/ 35 | *.log 36 | 37 | # Runtime data 38 | pids/ 39 | *.pid 40 | *.seed 41 | *.pid.lock 42 | 43 | # Coverage directory used by tools like istanbul 44 | coverage/ 45 | .nyc_output/ 46 | 47 | # Dependency directories 48 | jspm_packages/ 49 | 50 | # TypeScript cache 51 | *.tsbuildinfo 52 | 53 | # Optional npm cache directory 54 | .npm 55 | 56 | # Optional eslint cache 57 | .eslintcache 58 | 59 | # Optional REPL history 60 | .node_repl_history 61 | 62 | # Output of 'npm pack' 63 | *.tgz 64 | 65 | # Yarn Integrity file 66 | .yarn-integrity 67 | 68 | # dotenv environment variables file 69 | .env 70 | 71 | # parcel-bundler cache (https://parceljs.org/) 72 | .cache 73 | .parcel-cache 74 | 75 | # next.js build output 76 | .next 77 | 78 | # nuxt.js build output 79 | .nuxt 80 | 81 | # vuepress build output 82 | .vuepress/dist 83 | 84 | # Serverless directories 85 | .serverless 86 | 87 | # FuseBox cache 88 | .fusebox/ 89 | 90 | # DynamoDB Local files 91 | .dynamodb/ 92 | 93 | # TernJS port file 94 | .tern-port 95 | 96 | # Test files and directories 97 | test/ 98 | tests/ 99 | __tests__/ 100 | *.test.js 101 | *.test.mjs 102 | *.spec.js 103 | *.spec.mjs 104 | 105 | # Temporary files 106 | tmp/ 107 | temp/ 108 | .tmp/ 109 | .temp/ 110 | 111 | # Build directories 112 | build/ 113 | dist/ 114 | 115 | # Local development files 116 | local/ 117 | dev/ 118 | development/ 119 | 120 | # Backup files 121 | *.backup 122 | *.bak 123 | *.old 124 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # XPing 2 | 3 | 🚀 **VLESS connection ping tool using Xray with fragment support** 4 | 5 | A powerful command-line tool for testing VLESS proxy connections with advanced features like fragment support, real-time ping statistics, and automatic port management. 6 | 7 | --- 8 | 9 | ## 🎬 Demo Video 10 | 11 | https://github.com/user-attachments/assets/6dd3f671-5469-441a-91c0-00b1028e2708 12 | 13 | --- 14 | 15 | ## ✨ Features 16 | 17 | - 🔗 **VLESS URL Support**: Test connections directly from VLESS URLs 18 | - 📁 **Config File Support**: Use existing Xray config files 19 | - 🧩 **Fragment Mode**: Enable fragment for bypassing censorship 20 | - 📊 **Real-time Statistics**: Live ping results with detailed stats 21 | - 🎯 **Smart Port Management**: Automatic free port detection to avoid conflicts 22 | - 🌈 **Colorful Output**: Beautiful colored terminal output 23 | - ⚙️ **Environment Variables**: Customizable via environment variables 24 | - 🛡️ **Config Validation**: Built-in Xray config validation 25 | 26 | --- 27 | 28 | ## 📦 Installation 29 | 30 | ### Prerequisites 31 | 32 | - **Node.js** 16.0.0 or higher 33 | - **Xray-core** installed and accessible 34 | 35 | ### Install via npm (Global) 36 | 37 | ```bash 38 | npm install -g @nabikaz/xping 39 | ``` 40 | 41 | ### Manual Installation 42 | 43 | ```bash 44 | git clone https://github.com/NabiKAZ/xping.git 45 | cd xping 46 | npm install 47 | ``` 48 | 49 | --- 50 | 51 | ## 🚀 Usage 52 | 53 | ### Basic Usage 54 | 55 | ```bash 56 | # Test with VLESS URL 57 | xping "vless://uuid@server:port?security=tls&type=ws&path=/..." 58 | 59 | # Test with config file 60 | xping config.json 61 | 62 | # Test with fragment mode (VLESS URL only) 63 | xping "vless://..." --fragment 64 | 65 | # Test with custom options 66 | xping config.json --count 10 --delay 2000 --timeout 5000 67 | ``` 68 | 69 | ### Command Line Options 70 | 71 | ``` 72 | Usage: xping [options] 73 | 74 | Arguments: 75 | input VLESS URL or xray config file path to test 76 | 77 | Options: 78 | -f, --fragment Enable fragment mode (default: false) 79 | -d, --delay Delay between pings in milliseconds (default: 1000) 80 | -t, --timeout Connection timeout in milliseconds (default: 10000) 81 | -c, --count Number of pings to send (default: infinite) 82 | -h, --help Show help 83 | -v, --version Show version number 84 | ``` 85 | 86 | ### Examples 87 | 88 | ```bash 89 | # Basic ping test 90 | xping "vless://abc123@example.com:443?security=tls&type=ws&path=/path" 91 | 92 | # Test with fragment enabled 93 | xping "vless://abc123@example.com:443?..." --fragment 94 | 95 | # Test config file with limited count 96 | xping config.json --count 5 97 | 98 | # Test with custom timing 99 | xping config.json --delay 500 --timeout 15000 --count 10 100 | 101 | # Continuous testing (Ctrl+C to stop) 102 | xping "vless://..." 103 | ``` 104 | 105 | --- 106 | 107 | ## 🔧 Environment Variables 108 | 109 | Configure XPing behavior using environment variables: 110 | 111 | | Variable | Description | Default | 112 | |----------|-------------|---------| 113 | | `XPING_XRAY_PATH` | Path to xray binary | `xray` | 114 | | `XPING_TARGET_URL` | Target URL for testing | `https://www.google.com/generate_204` | 115 | | `XPING_FRAGMENT_PACKETS` | Fragment packets type | `tlshello` | 116 | | `XPING_FRAGMENT_LENGTH` | Fragment length range | `5-9` | 117 | | `XPING_FRAGMENT_INTERVAL` | Fragment interval range | `1-2` | 118 | 119 | ### Example with Environment Variables 120 | 121 | ```bash 122 | # Linux/macOS 123 | export XPING_XRAY_PATH="/usr/local/bin/xray" 124 | export XPING_TARGET_URL="https://www.cloudflare.com" 125 | xping config.json 126 | 127 | # Windows Command Prompt 128 | set XPING_XRAY_PATH="C:\xray\xray.exe" 129 | set XPING_TARGET_URL="https://www.cloudflare.com" 130 | xping config.json 131 | 132 | # Windows PowerShell 133 | $env:XPING_XRAY_PATH="C:\xray\xray.exe" 134 | $env:XPING_TARGET_URL="https://www.cloudflare.com" 135 | xping config.json 136 | ``` 137 | 138 | --- 139 | 140 | ## 🛠️ How It Works 141 | 142 | 1. **Input Detection**: Automatically detects whether input is a VLESS URL or config file 143 | 2. **Config Processing**: 144 | - For VLESS URLs: Generates optimized Xray config 145 | - For config files: Processes in memory with free port assignment 146 | 3. **Validation**: Validates configuration using `xray -test` 147 | 4. **Proxy Setup**: Starts Xray with automatic port management 148 | 5. **Connection Testing**: Performs HTTP requests through the proxy 149 | 6. **Statistics**: Provides real-time and summary statistics 150 | 151 | --- 152 | 153 | ## 💸 Donate 154 | 155 | If you find this tool useful and would like to support its development: 156 | 157 | - TON Wallet: `nabikaz.ton` 158 | 159 | --- 160 | 161 | ## 📄 License 162 | 163 | This project is licensed under the **GNU GPLv3** - see the [LICENSE](LICENSE) file for details. 164 | 165 | --- 166 | 167 | ⭐ **Star this project if you find it useful!** 168 | -------------------------------------------------------------------------------- /xping.mjs: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | /** 4 | * XPing - VLESS Connection Ping Tool 5 | * 6 | * A powerful command-line tool for testing VLESS proxy connections with 7 | * advanced features like fragment support, real-time ping statistics, 8 | * and automatic port management. 9 | * 10 | * @repository https://github.com/NabiKAZ/xping 11 | * @author NabiKAZ 12 | * @license GPL-3.0 13 | * @created 2025 14 | * 15 | * Copyright (C) 2025 NabiKAZ 16 | * Licensed under GNU General Public License v3.0 17 | * See: https://www.gnu.org/licenses/gpl-3.0.html 18 | */ 19 | 20 | import { spawn, exec } from 'child_process'; 21 | import { promisify } from 'util'; 22 | import { readFileSync, existsSync } from 'fs'; 23 | import { resolve } from 'path'; 24 | import chalk from 'chalk'; 25 | import yargs from 'yargs'; 26 | import { hideBin } from 'yargs/helpers'; 27 | import net from 'net'; 28 | 29 | const execAsync = promisify(exec); 30 | 31 | // Configuration constants 32 | const XRAY_PATH = process.env.XPING_XRAY_PATH || 'xray'; 33 | const TARGET_URL = process.env.XPING_TARGET_URL || 'https://www.google.com/generate_204'; 34 | const FRAGMENT_PACKETS = process.env.XPING_FRAGMENT_PACKETS || "tlshello"; 35 | const FRAGMENT_LENGTH = process.env.XPING_FRAGMENT_LENGTH || "5-9"; 36 | const FRAGMENT_INTERVAL = process.env.XPING_FRAGMENT_INTERVAL || "1-2"; 37 | 38 | // Function to find a free port 39 | function findFreePort() { 40 | return new Promise((resolve, reject) => { 41 | const server = net.createServer(); 42 | server.listen(0, (err) => { 43 | if (err) { 44 | reject(err); 45 | } else { 46 | const port = server.address().port; 47 | server.close(() => { 48 | resolve(port); 49 | }); 50 | } 51 | }); 52 | }); 53 | } 54 | 55 | // Function to check if xray is available 56 | async function checkXrayAvailable() { 57 | try { 58 | // Try the specified XRAY_PATH first 59 | await execAsync(`"${XRAY_PATH}" version`); 60 | return XRAY_PATH; 61 | } catch (error) { 62 | // Try system PATH as fallback 63 | try { 64 | await execAsync('xray version'); 65 | return 'xray'; 66 | } catch (e) { 67 | return false; 68 | } 69 | } 70 | } 71 | 72 | // Function to parse vless URL 73 | function parseVlessUrl(vlessUrl) { 74 | try { 75 | // Remove vless:// prefix 76 | const urlWithoutProtocol = vlessUrl.replace('vless://', ''); 77 | 78 | // Split at @ to separate uuid and server info 79 | const [uuid, serverPart] = urlWithoutProtocol.split('@'); 80 | 81 | // Split server part to get address, port and parameters 82 | const [serverAndPort, paramsPart] = serverPart.split('?'); 83 | const [address, port] = serverAndPort.split(':'); 84 | 85 | // Parse parameters 86 | const params = new URLSearchParams(paramsPart.split('#')[0]); 87 | 88 | return { 89 | uuid: uuid, 90 | address: address, 91 | port: parseInt(port), 92 | encryption: params.get('encryption') || 'none', 93 | security: params.get('security') || 'tls', 94 | sni: params.get('sni') || '', 95 | fp: params.get('fp') || '', 96 | type: params.get('type') || 'ws', 97 | host: params.get('host') || '', 98 | path: params.get('path') || '/', 99 | remark: decodeURIComponent(paramsPart.split('#')[1] || 'vless-config') 100 | }; 101 | } catch (error) { 102 | throw new Error(`Failed to parse vless URL: ${error.message}`); 103 | } 104 | } 105 | 106 | // Function to generate xray config 107 | function generateXrayConfig(vlessConfig, fragmentEnabled = false, proxyPort = 10801) { 108 | const config = { 109 | "log": { 110 | "loglevel": "error" 111 | }, 112 | "dns": { 113 | "servers": [ 114 | "8.8.8.8", 115 | "1.1.1.1" 116 | ] 117 | }, 118 | "inbounds": [ 119 | { 120 | "tag": "http-proxy", 121 | "port": proxyPort, 122 | "listen": "127.0.0.1", 123 | "protocol": "http", 124 | "settings": { 125 | "auth": "noauth", 126 | "allowTransparent": false 127 | } 128 | } 129 | ], 130 | "outbounds": [ 131 | { 132 | "tag": "proxy", 133 | "protocol": "vless", 134 | "settings": { 135 | "vnext": [ 136 | { 137 | "address": vlessConfig.address, 138 | "port": vlessConfig.port, 139 | "users": [ 140 | { 141 | "id": vlessConfig.uuid, 142 | "email": "ping@test.com", 143 | "security": "auto", 144 | "encryption": vlessConfig.encryption 145 | } 146 | ] 147 | } 148 | ] 149 | }, 150 | "streamSettings": { 151 | "network": vlessConfig.type, 152 | "security": vlessConfig.security, 153 | "tlsSettings": vlessConfig.security === "tls" ? { 154 | "allowInsecure": false, 155 | "serverName": vlessConfig.sni, 156 | "fingerprint": vlessConfig.fp 157 | } : undefined, 158 | "wsSettings": vlessConfig.type === "ws" ? { 159 | "path": vlessConfig.path, 160 | "headers": { 161 | "Host": vlessConfig.host 162 | } 163 | } : undefined, 164 | "sockopt": fragmentEnabled ? { 165 | "dialerProxy": "fragment" 166 | } : undefined 167 | }, 168 | "mux": { 169 | "enabled": false, 170 | "concurrency": 8 171 | } 172 | }, 173 | { 174 | "tag": "direct", 175 | "protocol": "freedom", 176 | "settings": { 177 | "domainStrategy": "AsIs", 178 | "userLevel": 0 179 | } 180 | }, 181 | { 182 | "tag": "fragment", 183 | "protocol": "freedom", 184 | "settings": fragmentEnabled ? { 185 | "fragment": { 186 | "packets": FRAGMENT_PACKETS, 187 | "length": FRAGMENT_LENGTH, 188 | "interval": FRAGMENT_INTERVAL 189 | } 190 | } : {} 191 | } 192 | ], 193 | "routing": { 194 | "domainStrategy": "AsIs", 195 | "rules": [ 196 | { 197 | "type": "field", 198 | "outboundTag": "proxy", 199 | "domain": [""] 200 | } 201 | ] 202 | } 203 | }; 204 | 205 | return config; 206 | } 207 | 208 | // Function to get current time string 209 | function getCurrentTimeString() { 210 | const now = new Date(); 211 | return now.toLocaleTimeString('en-US', { 212 | hour12: false, 213 | hour: '2-digit', 214 | minute: '2-digit', 215 | second: '2-digit' 216 | }); 217 | } 218 | 219 | // Function to test connection with fetch through proxy 220 | function testConnection(proxyPort, timeout = 10000) { 221 | return new Promise(async (resolve, reject) => { 222 | try { 223 | // Use undici for proxy support 224 | const { ProxyAgent, fetch } = await import('undici'); 225 | const proxyAgent = new ProxyAgent(`http://127.0.0.1:${proxyPort}`); 226 | const response = await fetch(TARGET_URL, { 227 | method: 'HEAD', 228 | dispatcher: proxyAgent, 229 | signal: AbortSignal.timeout(timeout) 230 | }); 231 | 232 | resolve({ 233 | success: true, 234 | statusCode: response.status, 235 | output: `HTTP/${response.status}` 236 | }); 237 | 238 | } catch (error) { 239 | reject({ 240 | success: false, 241 | error: error.message 242 | }); 243 | } 244 | }); 245 | } 246 | 247 | // Function to detect input type and load config 248 | function detectInputTypeAndLoadConfig(input) { 249 | // Check if input is a vless URL 250 | if (input.startsWith('vless://')) { 251 | return { 252 | type: 'vless', 253 | config: parseVlessUrl(input) 254 | }; 255 | } 256 | 257 | // Check if input is a file path 258 | const filePath = resolve(input); 259 | if (existsSync(filePath)) { 260 | try { 261 | const fileContent = readFileSync(filePath, 'utf8'); 262 | const xrayConfig = JSON.parse(fileContent); 263 | 264 | // Extract connection info from xray config for display 265 | const outbound = xrayConfig.outbounds?.find(o => o.protocol === 'vless' || o.protocol === 'vmess' || o.protocol === 'trojan'); 266 | if (!outbound) { 267 | throw new Error('No valid proxy outbound found in config file'); 268 | } 269 | 270 | const connectionInfo = extractConnectionInfo(outbound); 271 | 272 | return { 273 | type: 'config', 274 | config: connectionInfo 275 | }; 276 | } catch (error) { 277 | throw new Error(`Failed to read config file: ${error.message}`); 278 | } 279 | } 280 | 281 | throw new Error('Input must be either a vless:// URL or a valid xray config file path'); 282 | } 283 | 284 | // Function to extract connection info from xray outbound for display 285 | function extractConnectionInfo(outbound) { 286 | const vnext = outbound.settings?.vnext?.[0]; 287 | const streamSettings = outbound.streamSettings || {}; 288 | 289 | return { 290 | address: vnext?.address || 'unknown', 291 | port: vnext?.port || 'unknown', 292 | protocol: outbound.protocol || 'unknown', 293 | security: streamSettings.security || 'none', 294 | network: streamSettings.network || 'tcp', 295 | remark: outbound.tag || 'config-file' 296 | }; 297 | } 298 | 299 | // Function to detect fragment settings in config file 300 | function detectFragmentInConfig(xrayConfig) { 301 | // Check if any outbound has fragment settings 302 | const fragmentOutbounds = xrayConfig.outbounds?.filter(outbound => 303 | outbound.settings?.fragment || 304 | (outbound.protocol === 'freedom' && outbound.settings?.fragment) 305 | ); 306 | 307 | if (fragmentOutbounds && fragmentOutbounds.length > 0) { 308 | const fragmentConfig = fragmentOutbounds[0].settings.fragment; 309 | return { 310 | enabled: true, 311 | packets: fragmentConfig.packets || 'unknown', 312 | length: fragmentConfig.length || 'unknown', 313 | interval: fragmentConfig.interval || 'unknown' 314 | }; 315 | } 316 | 317 | // Check if main proxy outbound uses fragment via dialerProxy 318 | const proxyOutbound = xrayConfig.outbounds?.find(o => 319 | o.protocol === 'vless' || o.protocol === 'vmess' || o.protocol === 'trojan' 320 | ); 321 | 322 | if (proxyOutbound?.streamSettings?.sockopt?.dialerProxy) { 323 | const dialerProxyTag = proxyOutbound.streamSettings.sockopt.dialerProxy; 324 | const dialerOutbound = xrayConfig.outbounds?.find(o => o.tag === dialerProxyTag); 325 | 326 | if (dialerOutbound?.settings?.fragment) { 327 | const fragmentConfig = dialerOutbound.settings.fragment; 328 | return { 329 | enabled: true, 330 | packets: fragmentConfig.packets || 'unknown', 331 | length: fragmentConfig.length || 'unknown', 332 | interval: fragmentConfig.interval || 'unknown' 333 | }; 334 | } 335 | } 336 | 337 | return { enabled: false }; 338 | } 339 | 340 | // Function to validate xray config 341 | async function validateXrayConfig(xrayPath, configData) { 342 | try { 343 | const cmd = xrayPath === 'xray' ? 'xray' : `"${xrayPath}"`; 344 | 345 | // If configData is a file path (string without JSON structure) 346 | if (typeof configData === 'string' && !configData.trim().startsWith('{')) { 347 | // Use file path method for existing files 348 | const { stdout, stderr } = await execAsync(`${cmd} -test -config "${configData}"`); 349 | return { valid: true, message: 'Config is valid' }; 350 | } 351 | 352 | // Use stdin for config validation 353 | const xrayProcess = spawn(cmd === 'xray' ? 'xray' : xrayPath, ['-test', '-config', 'stdin:'], { 354 | stdio: ['pipe', 'pipe', 'pipe'] 355 | }); 356 | 357 | return new Promise((resolve) => { 358 | let stdout = ''; 359 | let stderr = ''; 360 | 361 | xrayProcess.stdout.on('data', (data) => { 362 | stdout += data.toString(); 363 | }); 364 | 365 | xrayProcess.stderr.on('data', (data) => { 366 | stderr += data.toString(); 367 | }); 368 | 369 | xrayProcess.on('close', (code) => { 370 | if (code === 0) { 371 | resolve({ valid: true, message: 'Config is valid' }); 372 | } else { 373 | const errorMessage = stderr.trim() || stdout.trim() || 'Invalid config format'; 374 | resolve({ valid: false, message: errorMessage }); 375 | } 376 | }); 377 | 378 | // Send config via stdin 379 | if (typeof configData === 'string') { 380 | xrayProcess.stdin.write(configData); 381 | } else { 382 | xrayProcess.stdin.write(JSON.stringify(configData, null, 2)); 383 | } 384 | xrayProcess.stdin.end(); 385 | }); 386 | 387 | } catch (error) { 388 | return { 389 | valid: false, 390 | message: error.stderr?.trim() || error.stdout?.trim() || error.message || 'Invalid config format' 391 | }; 392 | } 393 | } 394 | 395 | // Main function 396 | async function main() { 397 | const argv = yargs(hideBin(process.argv)) 398 | .scriptName('xping') 399 | .usage('\nVLESS connection ping tool using Xray with fragment support\nProject: https://github.com/NabiKAZ/xping\n\nUsage: $0 [options]') 400 | .updateStrings({ 401 | 'Positionals:': 'Arguments:' 402 | }) 403 | .fail((msg, err, yargs) => { 404 | if (err) { 405 | console.error(chalk.red(`❌ Error: ${err.message}`)); 406 | } else { 407 | console.error(yargs.help()); 408 | console.error(''); 409 | console.error(chalk.red(`❌ ${msg}`)); 410 | } 411 | process.exit(1); 412 | }) 413 | .command('$0 ', 'VLESS URL or xray config file path to test', (yargs) => { 414 | yargs.positional('input', { 415 | describe: 'VLESS URL or xray config file path to test', 416 | type: 'string' 417 | }); 418 | }) 419 | .option('f', { 420 | alias: 'fragment', 421 | describe: 'Enable fragment mode', 422 | type: 'boolean', 423 | default: false 424 | }) 425 | .option('d', { 426 | alias: 'delay', 427 | describe: 'Delay between pings in milliseconds', 428 | type: 'number', 429 | default: 1000 430 | }) 431 | .option('t', { 432 | alias: 'timeout', 433 | describe: 'Connection timeout in milliseconds', 434 | type: 'number', 435 | default: 10000 436 | }) 437 | .option('c', { 438 | alias: 'count', 439 | describe: 'Number of pings to send (default: infinite)', 440 | type: 'number' 441 | }) 442 | .version('1.0.0') 443 | .alias('v', 'version') 444 | .help('h') 445 | .alias('h', 'help') 446 | .epilogue(`Examples: 447 | $ xping "vless://uuid@server:port?security=tls&type=ws&path=/..." 448 | $ xping config.json --fragment --count 10 449 | $ xping "vless://..." --delay 500 --timeout 10000 --count 5 450 | $ xping config.json -c 3 -d 2000 -t 5000 451 | 452 | Environment Variables: 453 | XPING_XRAY_PATH Path to xray binary (default: xray) 454 | XPING_TARGET_URL Target URL for testing (default: https://www.google.com/generate_204) 455 | XPING_FRAGMENT_PACKETS Fragment packets type (default: tlshello) 456 | XPING_FRAGMENT_LENGTH Fragment length range (default: 5-9) 457 | XPING_FRAGMENT_INTERVAL Fragment interval range (default: 1-2) 458 | 459 | Note: 460 | - When using a config file, it will be processed in memory with a free port (original file unchanged) 461 | - Fragment mode is only applied to vless URLs, not config files`) 462 | .wrap(null) 463 | .parseSync(); 464 | 465 | const input = argv.input; 466 | const fragmentEnabled = argv.fragment; 467 | const delay = argv.delay; 468 | const timeout = argv.timeout; 469 | const pingCount = argv.count || null; // null means infinite 470 | 471 | try { 472 | console.log(''); 473 | 474 | // Check if xray is available 475 | const xrayPath = await checkXrayAvailable(); 476 | if (!xrayPath) { 477 | console.log(chalk.red('❌ Xray not found!')); 478 | console.log(chalk.yellow(`💡 Searched for: ${XRAY_PATH} (from XPING_XRAY_PATH env var or default)`)); 479 | console.log(chalk.blue('📥 Download: https://github.com/XTLS/Xray-core/releases')); 480 | process.exit(1); 481 | } 482 | 483 | // Find a free port for proxy 484 | let proxyPort = await findFreePort(); 485 | 486 | // Detect input type and load config 487 | const inputData = detectInputTypeAndLoadConfig(input); 488 | const connectionInfo = inputData.config; 489 | 490 | let xrayConfig; 491 | let configFilePath = null; 492 | let configFragmentInfo = null; 493 | 494 | if (inputData.type === 'vless') { 495 | xrayConfig = generateXrayConfig(connectionInfo, fragmentEnabled, proxyPort); 496 | 497 | // Validate generated config via stdin 498 | const validation = await validateXrayConfig(xrayPath, xrayConfig); 499 | 500 | if (!validation.valid) { 501 | console.log(chalk.red(`❌ Generated config validation failed:`)); 502 | console.log(chalk.red(validation.message)); 503 | process.exit(1); 504 | } 505 | console.log(chalk.green('✅ Generated config validation passed')); 506 | } else { 507 | // Load and modify existing config file to use our free port 508 | configFilePath = resolve(input); 509 | 510 | // Read and parse the config file 511 | const fileContent = readFileSync(configFilePath, 'utf8'); 512 | const fullXrayConfig = JSON.parse(fileContent); 513 | configFragmentInfo = detectFragmentInConfig(fullXrayConfig); 514 | 515 | // Modify the config to use our free port instead of the original port 516 | if (fullXrayConfig.inbounds) { 517 | fullXrayConfig.inbounds.forEach(inbound => { 518 | if (inbound.protocol === 'http' || inbound.protocol === 'mixed' || inbound.protocol === 'socks') { 519 | inbound.port = proxyPort; 520 | inbound.listen = "127.0.0.1"; // Ensure it's localhost only 521 | } 522 | }); 523 | } 524 | 525 | // We'll use the modified config via stdin instead of file path 526 | xrayConfig = fullXrayConfig; 527 | configFilePath = null; // Don't use file path, use stdin instead 528 | 529 | // Validate the modified config 530 | const validation = await validateXrayConfig(xrayPath, xrayConfig); 531 | if (!validation.valid) { 532 | console.log(chalk.red(`❌ Config validation failed:`)); 533 | console.log(chalk.red(validation.message)); 534 | process.exit(1); 535 | } 536 | console.log(chalk.green('✅ Config validation passed')); 537 | } 538 | 539 | // Show config information 540 | console.log(chalk.cyanBright(`📍 ${connectionInfo.address}:${connectionInfo.port}`) + chalk.gray(' | ') + chalk.white(connectionInfo.remark)); 541 | 542 | if (inputData.type === 'vless') { 543 | console.log(chalk.cyanBright(`🔒 ${connectionInfo.security}`) + chalk.gray(' | Type: ') + chalk.yellow(connectionInfo.type) + chalk.gray(' | Host: ') + chalk.yellow(connectionInfo.host) + chalk.gray(' | SNI: ') + chalk.yellow(connectionInfo.sni) + chalk.gray(' | Path: ') + chalk.yellow(connectionInfo.path)); 544 | } else { 545 | console.log(chalk.cyanBright(`🔒 ${connectionInfo.security}`) + chalk.gray(' | Type: ') + chalk.yellow(connectionInfo.network) + chalk.gray(' | Protocol: ') + chalk.yellow(connectionInfo.protocol)); 546 | } 547 | 548 | // Show fragment info 549 | let fragmentInfo; 550 | if (inputData.type === 'vless') { 551 | fragmentInfo = fragmentEnabled ? { 552 | enabled: true, 553 | packets: FRAGMENT_PACKETS, 554 | length: FRAGMENT_LENGTH, 555 | interval: FRAGMENT_INTERVAL 556 | } : { enabled: false }; 557 | } else { 558 | fragmentInfo = configFragmentInfo || { enabled: false }; 559 | } 560 | 561 | if (fragmentInfo.enabled) { 562 | console.log(chalk.cyanBright(`📝 Fragment: `) + chalk.gray('packets: ') + chalk.yellow(fragmentInfo.packets) + chalk.gray(', length: ') + chalk.yellow(fragmentInfo.length) + chalk.gray(', interval: ') + chalk.yellow(fragmentInfo.interval)); 563 | } else { 564 | console.log(chalk.cyanBright(`📝 Fragment: `) + chalk.gray('disabled')); 565 | } 566 | console.log(''); 567 | 568 | // Start xray process with config via stdin 569 | const xrayArgs = ['-config', 'stdin:']; 570 | xrayProcess = spawn(xrayPath === true ? 'xray' : xrayPath, xrayArgs, { 571 | stdio: 'pipe' 572 | }); 573 | 574 | // Handle xray process errors 575 | xrayProcess.on('error', (error) => { 576 | console.log(chalk.red(`❌ Failed to start xray: ${error.message}`)); 577 | process.exit(1); 578 | }); 579 | 580 | // Send config to xray via stdin (both vless and modified config file) 581 | if (xrayConfig) { 582 | xrayProcess.stdin.write(JSON.stringify(xrayConfig, null, 2)); 583 | xrayProcess.stdin.end(); 584 | } 585 | 586 | let xrayStarted = false; 587 | let xrayError = false; 588 | let xrayErrorMessages = []; 589 | let xrayOutputMessages = []; 590 | let processExited = false; 591 | 592 | xrayProcess.stdout.on('data', (data) => { 593 | const output = data.toString(); 594 | xrayOutputMessages.push(output.trim()); 595 | // Check for various signs that xray has started successfully 596 | if (output.includes('started') || 597 | output.includes('listening') || 598 | output.includes('A unified platform for anti-censorship') || 599 | (output.includes('Xray') && output.includes('windows/amd64'))) { 600 | xrayStarted = true; 601 | } 602 | }); 603 | 604 | xrayProcess.stderr.on('data', (data) => { 605 | const error = data.toString().trim(); 606 | if (error) { 607 | xrayErrorMessages.push(error); 608 | // Also immediately show critical errors 609 | if (error.includes('Failed to start') || 610 | error.includes('failed to listen') || 611 | error.includes('bind:') || 612 | error.includes('address already in use') || 613 | error.includes('permission denied') || 614 | error.includes('invalid config') || 615 | error.includes('parse') || 616 | error.includes('cannot') || 617 | error.includes('error')) { 618 | console.log(chalk.red(`❌ Xray error: ${error}`)); 619 | } 620 | xrayError = true; 621 | } 622 | }); 623 | 624 | xrayProcess.on('exit', (code) => { 625 | processExited = true; 626 | 627 | if (code !== 0 && code !== null) { 628 | console.log(chalk.red(`❌ Xray exited with code: ${code}`)); 629 | 630 | if (xrayErrorMessages.length > 0) { 631 | console.log(chalk.red('📝 Error details:')); 632 | xrayErrorMessages.forEach(msg => { 633 | console.log(chalk.red(` ${msg}`)); 634 | }); 635 | } else if (xrayOutputMessages.length > 0) { 636 | console.log(chalk.red('📋 Xray output messages:')); 637 | xrayOutputMessages.forEach(msg => { 638 | if (msg.trim()) { 639 | console.log(chalk.red(`${msg}`)); 640 | } 641 | }); 642 | } else { 643 | console.log(chalk.red('📝 No specific error message available')); 644 | } 645 | process.exit(1); 646 | } 647 | }); 648 | 649 | // Wait for xray to start or fail with better timing 650 | let attempts = 0; 651 | const maxAttempts = 6; // 3 seconds total, enough time for startup 652 | while (attempts < maxAttempts && !xrayStarted && !processExited) { 653 | await new Promise(resolve => setTimeout(resolve, 500)); 654 | attempts++; 655 | 656 | // Check if we have errors during waiting 657 | if (xrayError && xrayErrorMessages.length > 0) { 658 | break; 659 | } 660 | } 661 | 662 | // Check final status 663 | if (processExited || xrayError) { 664 | if (!processExited) { 665 | // Process is still running but has errors 666 | console.log(chalk.red('❌ Xray startup errors detected:')); 667 | xrayErrorMessages.forEach(msg => { 668 | console.log(chalk.red(` ${msg}`)); 669 | }); 670 | xrayProcess.kill(); 671 | } 672 | process.exit(1); 673 | } 674 | 675 | if (!xrayStarted) { 676 | console.log(chalk.red('❌ Xray failed to start within timeout period')); 677 | 678 | if (xrayErrorMessages.length > 0) { 679 | console.log(chalk.red('📝 Error messages received:')); 680 | xrayErrorMessages.forEach(msg => { 681 | console.log(chalk.red(` ${msg}`)); 682 | }); 683 | } else if (xrayOutputMessages.length > 0) { 684 | console.log(chalk.yellow('📋 Output messages received:')); 685 | xrayOutputMessages.forEach(msg => { 686 | if (msg.trim()) { 687 | console.log(chalk.yellow(` ${msg}`)); 688 | } 689 | }); 690 | } else { 691 | console.log(chalk.red('📝 No output received from Xray during startup')); 692 | } 693 | 694 | xrayProcess.kill(); 695 | process.exit(1); 696 | } 697 | 698 | let currentPing = 0; 699 | 700 | // Ping loop - infinite or limited by count 701 | while (pingCount === null || currentPing < pingCount) { 702 | currentPing++; 703 | try { 704 | // Show testing message and get result in one line 705 | process.stdout.write(chalk.gray(`🌐 [${getCurrentTimeString()}] Testing connection to ${TARGET_URL}...`)); 706 | 707 | const startTime = Date.now(); 708 | const result = await testConnection(proxyPort, timeout); 709 | const endTime = Date.now(); 710 | const responseTime = endTime - startTime; 711 | 712 | // Clear the testing line and show result 713 | process.stdout.write('\r\x1b[K'); // Clear current line 714 | 715 | // Update statistics only after successful test 716 | pingStats.count = currentPing; 717 | pingStats.success++; 718 | pingStats.total += responseTime; 719 | pingStats.min = Math.min(pingStats.min, responseTime); 720 | pingStats.max = Math.max(pingStats.max, responseTime); 721 | 722 | // Calculate success rate 723 | const successRate = Math.round((pingStats.success / pingStats.count) * 100); 724 | 725 | // Format output with more info 726 | console.log(chalk.gray(`[${getCurrentTimeString()}]`) + chalk.green(` ✅ ${connectionInfo.address}:${connectionInfo.port} responded in `) + chalk.bold.whiteBright(`${responseTime}ms`)); 727 | 728 | } catch (error) { 729 | // Clear the testing line and show timeout 730 | process.stdout.write('\r\x1b[K'); // Clear current line 731 | 732 | // Update statistics only after failed test 733 | pingStats.count = currentPing; 734 | const successRate = Math.round((pingStats.success / pingStats.count) * 100); 735 | 736 | // Extract error reason 737 | let errorReason = 'Request timeout'; 738 | if (error.error) { 739 | if (error.error.includes('fetch failed')) errorReason = 'Connection failed'; 740 | else if (error.error.includes('timeout')) errorReason = 'Request timeout'; 741 | else if (error.error.includes('ECONNREFUSED')) errorReason = 'Connection refused'; 742 | else if (error.error.includes('ENOTFOUND')) errorReason = 'Host not found'; 743 | else errorReason = 'Network error'; 744 | } 745 | 746 | console.log(chalk.gray(`[${getCurrentTimeString()}]`) + chalk.red(` ❌ ${errorReason}`)); 747 | } 748 | 749 | // Wait before next ping (but not after the last ping) 750 | if (pingCount === null || currentPing < pingCount) { 751 | await new Promise(resolve => setTimeout(resolve, delay)); 752 | } 753 | } 754 | 755 | // Show final statistics if count was specified 756 | if (pingCount !== null) { 757 | showPingStatistics(); 758 | } 759 | 760 | // Clean up 761 | xrayProcess.kill(); 762 | 763 | } catch (error) { 764 | console.log(chalk.red(`❌ Error: ${error.message}`)); 765 | process.exit(1); 766 | } 767 | } 768 | 769 | // Handle process termination 770 | let xrayProcess = null; 771 | let pingStats = { count: 0, success: 0, total: 0, min: Infinity, max: 0 }; 772 | 773 | function showPingStatistics() { 774 | console.log(chalk.blue('\n📊 === Statistics ===')); 775 | console.log(chalk.white(`📦 Sent: `) + chalk.cyan(pingStats.count) + chalk.white(` | Received: `) + chalk.green(pingStats.success) + chalk.white(` | Lost: `) + chalk.red(pingStats.count - pingStats.success) + chalk.yellow(` (${Math.round(((pingStats.count - pingStats.success) / pingStats.count) * 100) || 0}% loss)`)); 776 | 777 | if (pingStats.success > 0) { 778 | const avgTime = Math.round(pingStats.total / pingStats.success); 779 | console.log(chalk.white(`⏱️ Min: `) + chalk.green(`${pingStats.min}ms`) + chalk.white(` | Max: `) + chalk.red(`${pingStats.max}ms`) + chalk.white(` | Avg: `) + chalk.yellow(`${avgTime}ms`)); 780 | } 781 | console.log(chalk.magenta('🏁 Completed!')); 782 | } 783 | 784 | process.on('SIGINT', () => { 785 | // Clear any pending testing message 786 | process.stdout.write('\r\x1b[K'); 787 | console.log(chalk.yellow('\n^C')); 788 | showPingStatistics(); 789 | if (xrayProcess) { 790 | xrayProcess.kill(); 791 | } 792 | process.exit(0); 793 | }); 794 | 795 | process.on('SIGTERM', () => { 796 | // Clear any pending testing message 797 | process.stdout.write('\r\x1b[K'); 798 | console.log(chalk.yellow('\nProcess terminated')); 799 | showPingStatistics(); 800 | if (xrayProcess) { 801 | xrayProcess.kill(); 802 | } 803 | process.exit(0); 804 | }); 805 | 806 | // Run the main function 807 | main().catch(error => { 808 | console.error(chalk.red('💥 Unexpected error:'), error.message); 809 | process.exit(1); 810 | }); 811 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------