From 50a18ae33ca55630d6df37449805edc0db2a29ca Mon Sep 17 00:00:00 2001 From: kzolotarev95 Date: Fri, 9 Oct 2026 06:44:14 +0400 Subject: [PATCH] Fix CRLF handling when applying router Xray settings --- files/www/cgi-bin/owrt-remote | 18 +++- tests/XRAY_APPLY.md | 54 ++++++++++++ tests/test_xray_apply.py | 151 ++++++++++++++++++++++++++++++++++ vps/deploy-xray-apply-fix.ps1 | 81 ++++++++++++++++++ 4 files changed, 302 insertions(+), 2 deletions(-) create mode 100644 tests/XRAY_APPLY.md create mode 100644 tests/test_xray_apply.py create mode 100644 vps/deploy-xray-apply-fix.ps1 diff --git a/files/www/cgi-bin/owrt-remote b/files/www/cgi-bin/owrt-remote index b1dc678..0907945 100644 --- a/files/www/cgi-bin/owrt-remote +++ b/files/www/cgi-bin/owrt-remote @@ -155,7 +155,9 @@ clear_config() { apply_xray_settings() { local script script_file output rc - script="$(param xray_settings_script)" + # HTML textarea POSTs use CRLF, even when the copied Hub commands use LF. + # BusyBox ash treats the trailing CR as part of keywords such as then/fi. + script="$(param xray_settings_script | tr -d '\r')" output="${TMPDIR:-/tmp}/owrt-remote-apply.$$" script_file="${TMPDIR:-/tmp}/owrt-remote-apply-script.$$" rc=0 @@ -172,7 +174,19 @@ apply_xray_settings() { } >"$script_file" chmod 600 "$script_file" 2>/dev/null || true - if sh "$script_file" >"$output" 2>&1; then + # Check the complete script before any UCI command can change the router. + if sh -n "$script_file" >"$output" 2>&1; then + : + else + rc=$? + set_result "Ошибка применения Xray настроек" "Синтаксическая ошибка в командах. Настройки не изменены. +$(cat "$output") +rc=$rc" "bad" + rm -f "$script_file" "$output" + return + fi + + if sh -e "$script_file" >"$output" 2>&1; then set_result "Xray настройки применены" "$(cat "$output")" "ok" else rc=$? diff --git a/tests/XRAY_APPLY.md b/tests/XRAY_APPLY.md new file mode 100644 index 0000000..8c3f182 --- /dev/null +++ b/tests/XRAY_APPLY.md @@ -0,0 +1,54 @@ +# Применение OpenWrt config через панель роутера (v111) + +При отправке textarea браузер кодирует переносы строк как CRLF. CGI +декодировал их без нормализации и записывал CR в исполняемый shell-скрипт. +После появления блока `if/then/else/fi` для сохранения ручного VPS host +это приводило к ошибке `unexpected end of file (expecting "then")`. + +CGI удаляет CR перед записью скрипта и проверяет целиком `sh -n` до +выполнения любых команд UCI. При ошибке синтаксиса конфигурация не +меняется. Выполнение через `sh -e` останавливается при ошибке команды, +например при неудачном `render-client`, и не продолжает перезапуск. + +`tests/test_xray_apply.py` отправляет настоящий URL-encoded POST в CGI +с тестовым ключом и исполняет команды строгой POSIX-оболочкой. Проверяются +CRLF и LF, heredoc, пустые строки, кодированные символы, отклонение +неполного скрипта до изменений, остановка при сбое команды и отказ +без авторизации. Полный конфиг, сгенерированный Hub, применяется через +ту же форму с подменёнными UCI/службой; ручной VPS host и WAN сохраняются. +На Windows строгая проверка использует Git for Windows dash. + +## Установка и откат + +Скрипт обновляет только CGI на роутере. VPS обновлять для этого фикса +не требуется. До замены сохраняется первая резервная копия CGI: +`/root/owrt-remote-backup-before-xray-apply-v111/owrt-remote`. + +Из PowerShell Windows 11; замените IP, если адрес роутера отличается: + +```powershell +powershell.exe -NoProfile -ExecutionPolicy Bypass -File "C:\Users\k.zolotarev95\Documents\openwrt overlay\vps\deploy-xray-apply-fix.ps1" -Router "root@192.168.2.1" -Action Install +``` + +После `XRAY_APPLY_ROUTER_Install_OK` обновите панель роутера через +Ctrl+F5, снова скопируйте полный блок **OpenWrt config** из панели VPS +и нажмите **Применить настройки**. Это повторно применит настройки без +CR и пересоберёт Xray-конфиг. Предыдущая неудачная попытка могла успеть +записать часть настроек; замена CGI сама по себе их не переприменяет. +Если после успешного применения ошибка proxy остаётся, требуется +проверка запуска Xray и обратного соединения с VPS на реальном роутере. + +Откат возвращает CGI до установки; настройки, повторно применённые +через форму, остаются текущими: + +```powershell +powershell.exe -NoProfile -ExecutionPolicy Bypass -File "C:\Users\k.zolotarev95\Documents\openwrt overlay\vps\deploy-xray-apply-fix.ps1" -Router "root@192.168.2.1" -Action Rollback +``` + +Проверки локально: + +```powershell +python tests/test_xray_apply.py -v +``` + +Переносы строк в формах описаны в [стандарте HTML](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html). diff --git a/tests/test_xray_apply.py b/tests/test_xray_apply.py new file mode 100644 index 0000000..11cfa1a --- /dev/null +++ b/tests/test_xray_apply.py @@ -0,0 +1,151 @@ +"""Exercise the real router CGI POST with LF/CRLF and a strict POSIX shell.""" +import importlib.util +import os +from pathlib import Path +import shutil +import subprocess +import sys +import tempfile +import unittest +from unittest import mock +from urllib.parse import urlencode + +ROOT = Path(__file__).resolve().parents[1] +STATE = tempfile.TemporaryDirectory(prefix="owrt-xray-apply-") +spec = importlib.util.spec_from_file_location("xray_apply_hub", ROOT / "vps/owrt-remote-hub.py") +hub = importlib.util.module_from_spec(spec) +sys.modules[spec.name] = hub +with mock.patch.dict(os.environ, {"OWRT_REMOTE_STATE_DIR": STATE.name}): + spec.loader.exec_module(hub) + +SH = shutil.which("sh") +STRICT_SH = shutil.which("dash") or SH +if os.name == "nt": + git_bin = Path(os.environ.get("ProgramFiles", "C:/Program Files")) / "Git/usr/bin" + SH = str(git_bin / "sh.exe") if (git_bin / "sh.exe").exists() else SH + STRICT_SH = str(git_bin / "dash.exe") if (git_bin / "dash.exe").exists() else STRICT_SH +else: + git_bin = None + + +@unittest.skipUnless(SH and STRICT_SH, "POSIX sh and a strict parser are required") +class XrayApplyPostTests(unittest.TestCase): + def setUp(self): + self.temp = tempfile.TemporaryDirectory(dir=STATE.name) + self.addCleanup(self.temp.cleanup) + self.directory = Path(self.temp.name) + self.directory.joinpath("key").write_text("test-web-key", encoding="utf-8") + tools = self.directory / "bin" + tools.mkdir() + tools.joinpath("owrt-remote").write_text( + '#!/bin/sh\n[ "$1" != render-client ] || [ "${RENDER_FAIL:-0}" = 0 ] || exit 7\n' + 'printf "%s\\n" "$*" >>"$TEST_ROOT/operations"\n', encoding="utf-8", newline="\n") + tools.joinpath("owrt-remote").chmod(0o755) + self.env = {**os.environ, "TMPDIR": self.directory.as_posix(), + "TEST_ROOT": self.directory.as_posix(), "KEY_FILE": (self.directory / "key").as_posix(), + "TEST_STRICT_SH": Path(STRICT_SH).as_posix()} + if git_bin: + self.env["PATH"] = str(git_bin) + os.pathsep + self.env["PATH"] + self.env["PATH"] = str(tools) + os.pathsep + self.env["PATH"] + cgi = (ROOT / "files/www/cgi-bin/owrt-remote").read_text(encoding="utf-8") + mocks = r''' +sh() { + if [ "$1" = -n ]; then + cp "$2" "$TEST_ROOT/checked.sh" + printf 'check\n' >>"$TEST_ROOT/calls" + else + cp "$2" "$TEST_ROOT/executed.sh" + printf 'execute\n' >>"$TEST_ROOT/calls" + fi + "$TEST_STRICT_SH" "$@" +} +render_page() { printf 'KIND=%s\nTITLE=%s\nBODY=%s\n' "$RESULT_KIND" "$RESULT_TITLE" "$RESULT_BODY"; } +''' + self.cgi = self.directory / "cgi" + self.cgi.write_text(cgi.replace("\nread_request\n", mocks + "\nread_request\n", 1), encoding="utf-8", newline="\n") + + def post(self, script, key="test-web-key"): + body = urlencode({"key": key, "action": "apply_xray_settings", "xray_settings_script": script}).encode("ascii") + result = subprocess.run([SH, self.cgi.as_posix()], input=body, capture_output=True, + env={**self.env, "REQUEST_METHOD": "POST", "CONTENT_TYPE": "application/x-www-form-urlencoded", + "CONTENT_LENGTH": str(len(body))}, timeout=20) + self.assertEqual(result.returncode, 0, result.stderr.decode("utf-8", errors="replace")) + self.assertFalse(list(self.directory.glob("owrt-remote-*")), "CGI temporary files must be removed") + return result.stdout.decode("utf-8") + + def test_form_crlf_is_normalized_before_strict_shell_parsing(self): + script = "if [ x = x ]; then\n printf '%s' 'name + percent% & quote\"'\nfi\n" + response = self.post(script.replace("\n", "\r\n")) + self.assertIn("KIND=ok", response) + self.assertIn('BODY=name + percent% & quote"', response) + self.assertNotIn(b"\r", self.directory.joinpath("checked.sh").read_bytes()) + self.assertNotIn(b"\r", self.directory.joinpath("executed.sh").read_bytes()) + self.assertEqual(self.directory.joinpath("calls").read_text(), "check\nexecute\n") + + def test_lf_and_crlf_heredoc_keep_lines_and_blank_lines(self): + script = 'cat >"$TEST_ROOT/applied" <<\'EOF\'\nfirst\n\nlast + % &\nEOF\n' + for ending in ("\n", "\r\n"): + with self.subTest(ending=repr(ending)): + self.assertIn("KIND=ok", self.post(script.replace("\n", ending))) + self.assertEqual(self.directory.joinpath("applied").read_bytes(), b"first\n\nlast + % &\n") + + def test_incomplete_script_is_rejected_before_any_changes(self): + response = self.post('printf changed >"$TEST_ROOT/applied"\nif [ x = x ]; then\n') + self.assertIn("KIND=bad", response) + self.assertIn("rc=2", response) + self.assertIn("Настройки не изменены", response) + self.assertFalse(self.directory.joinpath("applied").exists()) + self.assertFalse(self.directory.joinpath("executed.sh").exists()) + + def test_failed_render_stops_before_later_restart_or_heartbeat(self): + self.env["RENDER_FAIL"] = "1" + script = 'owrt-remote render-client\nprintf restarted >"$TEST_ROOT/restarted"\n' + response = self.post(script) + self.assertIn("KIND=bad", response) + self.assertIn("rc=7", response) + self.assertFalse(self.directory.joinpath("restarted").exists()) + + def test_empty_and_unauthorized_form_do_not_execute_commands(self): + self.assertIn("KIND=warn", self.post(" \r\n\t\r\n")) + self.assertFalse(self.directory.joinpath("calls").exists()) + response = self.post('printf changed >"$TEST_ROOT/applied"', key="wrong-key") + self.assertIn("Доступ запрещен", response) + self.assertFalse(self.directory.joinpath("applied").exists()) + self.assertFalse(self.directory.joinpath("calls").exists()) + + def test_full_hub_config_through_form_preserves_manual_host_and_wan(self): + self.directory.joinpath("uci").write_text("owrtremote.main.vps_host=192.0.2.25\nowrtremote.main.wan_interface=wwan\n", encoding="utf-8") + mocks = r''' +uci() { + [ "$1" != -q ] || shift + case "$1" in + get) + [ "$2" != owrtremote.main ] || { echo remote; return; } + awk -F= -v key="$2" '$1 == key { sub(/^[^=]*=/, ""); print; found=1; exit } END { if(!found) exit 1 }' "$TEST_ROOT/uci" ;; + set) + key="${2%%=*}"; value="${2#*=}" + awk -F= -v key="$key" '$1 != key' "$TEST_ROOT/uci" >"$TEST_ROOT/uci.new" + printf '%s=%s\n' "$key" "$value" >>"$TEST_ROOT/uci.new" + mv "$TEST_ROOT/uci.new" "$TEST_ROOT/uci" ;; + commit) printf 'commit\n' >>"$TEST_ROOT/operations" ;; + esac +} +test_service() { printf 'service %s\n' "$*" >>"$TEST_ROOT/operations"; } +''' + row = {"id": "main", "name": "test + quote's & name", "vps_host": "hub.example", "reverse_tag": "reverse-in"} + with mock.patch.object(hub, "agent_token", return_value="test-agent-token"): + generated = hub.make_openwrt_config(row, "https://hub.example") + generated = generated.replace("/etc/init.d/owrt-remote", "test_service") + response = self.post((mocks + generated).replace("\n", "\r\n")) + self.assertIn("KIND=ok", response) + state = self.directory.joinpath("uci").read_bytes() + self.assertNotIn(b"\r", state) + self.assertIn(b"owrtremote.main.vps_host=192.0.2.25\n", state) + self.assertIn(b"owrtremote.main.wan_interface=wwan\n", state) + self.assertIn(b"owrtremote.main.router_name=test + quote's & name\n", state) + self.assertEqual(self.directory.joinpath("operations").read_text(), + "commit\nrender-client\nservice enable\nservice restart\nheartbeat\n") + + +if __name__ == "__main__": + unittest.main() diff --git a/vps/deploy-xray-apply-fix.ps1 b/vps/deploy-xray-apply-fix.ps1 new file mode 100644 index 0000000..1e79e1a --- /dev/null +++ b/vps/deploy-xray-apply-fix.ps1 @@ -0,0 +1,81 @@ +param( + [Parameter(Mandatory = $true)][ValidateNotNullOrEmpty()][string]$Router, + [ValidateSet('Install', 'Rollback')][string]$Action = 'Install', + [switch]$PrepareOnly +) + +$ErrorActionPreference = 'Stop' +$RepoRoot = Split-Path -Parent $PSScriptRoot +$UploadName = 'owrt-xray-apply-' + [guid]::NewGuid().ToString('N') +$StageRoot = Join-Path ([System.IO.Path]::GetTempPath()) $UploadName +$Utf8 = [System.Text.UTF8Encoding]::new($false) +$RemoteScript = @' +#!/bin/sh +set -eu +stage=/tmp/__UPLOAD_NAME__ +target=/www/cgi-bin/owrt-remote +backup_dir=/root/owrt-remote-backup-before-xray-apply-v111 +backup=$backup_dir/owrt-remote +candidate=$target.new-__UPLOAD_NAME__ +changed=0 +cleanup() { + code=$? + trap - EXIT + if [ "$code" -ne 0 ] && [ "$changed" = 1 ]; then + echo 'Operation failed; restoring the CGI from this attempt.' >&2 + cp -p "$stage/previous" "$candidate" + mv -f "$candidate" "$target" + fi + rm -f "$candidate" + rm -rf "$stage" + exit "$code" +} +trap cleanup EXIT +test -s "$target" +if [ '__ACTION__' = Install ]; then + test -s "$stage/cgi" + sh -n "$stage/cgi" + grep -F -q 'if sh -n "$script_file"' "$stage/cgi" + grep -F -q 'if sh -e "$script_file"' "$stage/cgi" + mkdir -p "$backup_dir" + chmod 700 "$backup_dir" + if [ ! -e "$backup" ]; then cp -p "$target" "$backup"; fi + test -s "$backup" + source_file=$stage/cgi +else + test -s "$backup" + sh -n "$backup" + source_file=$backup +fi +printf 'Backup: %s\n' "$backup" +cp -p "$target" "$stage/previous" +cp "$source_file" "$candidate" +chmod 755 "$candidate" +changed=1 +mv -f "$candidate" "$target" +sh -n "$target" +cmp "$source_file" "$target" +printf '\nXRAY_APPLY_ROUTER_%s_OK\n' '__ACTION__' +'@ +$RemoteScript = $RemoteScript.Replace('__UPLOAD_NAME__', $UploadName).Replace('__ACTION__', $Action) +try { + [System.IO.Directory]::CreateDirectory($StageRoot) | Out-Null + [System.IO.File]::WriteAllText((Join-Path $StageRoot 'run.sh'), $RemoteScript.Replace("`r`n", "`n") + "`n", $Utf8) + if ($Action -eq 'Install') { + $Content = [System.IO.File]::ReadAllText((Join-Path $RepoRoot 'files\www\cgi-bin\owrt-remote')).Replace("`r`n", "`n") + [System.IO.File]::WriteAllText((Join-Path $StageRoot 'cgi'), $Content, $Utf8) + } + if ($PrepareOnly) { Write-Host "Prepared only: $StageRoot"; return } + & scp -O -r -- $StageRoot "${Router}:/tmp/" + if ($LASTEXITCODE -ne 0) { throw 'Upload failed. The installation has not started.' } + & ssh -T -o ConnectTimeout=10 $Router "sh /tmp/$UploadName/run.sh" + if ($LASTEXITCODE -ne 0) { throw "$Action failed. See the output above; success was not confirmed." } + Write-Host "Router CGI $Action finished successfully." +} finally { + if (-not $PrepareOnly) { + $Resolved = [System.IO.Path]::GetFullPath($StageRoot) + $Expected = [System.IO.Path]::GetFullPath((Join-Path ([System.IO.Path]::GetTempPath()) $UploadName)) + if ($Resolved -ne $Expected -or (Split-Path -Leaf $Resolved) -ne $UploadName) { throw 'Unsafe staging cleanup path.' } + if (Test-Path -LiteralPath $Resolved) { Remove-Item -LiteralPath $Resolved -Recurse -Force } + } +}