Полный продовый фикс fix22: DNS preflight, inet firewall, idempotent bootstrap, auth-semantics и redact-config
This commit is contained in:
@@ -3,6 +3,7 @@ import { reconfigure, repair } from "./commands/reconfigure";
|
||||
import { doctor } from "./commands/doctor";
|
||||
import { status } from "./commands/status";
|
||||
import { diagnosticsCollect } from "./commands/diagnostics";
|
||||
import { redactConfig, type RedactConfigFormat } from "./commands/redact-config";
|
||||
import type { InstallOptions, ReconfigureOptions } from "./types/context";
|
||||
|
||||
function usage(): never {
|
||||
@@ -13,10 +14,65 @@ function usage(): never {
|
||||
console.error(" hy2xs-orchestrator doctor --package-dir <path> [--config <path>] [--skip-firewall] [--skip-service-start] [--skip-smoke]");
|
||||
console.error(" hy2xs-orchestrator status --package-dir <path> [--config <path>] [--skip-firewall] [--skip-service-start] [--skip-smoke]");
|
||||
console.error(" hy2xs-orchestrator diagnostics collect --package-dir <path> [--config <path>] [--skip-firewall] [--skip-service-start] [--skip-smoke]");
|
||||
console.error(" hy2xs-orchestrator redact-config --config <path> [--in-place | --out <path>] [--format auto|env|yaml]");
|
||||
console.error(" note: --skip-start is deprecated alias for --skip-service-start --skip-smoke");
|
||||
process.exit(2);
|
||||
}
|
||||
|
||||
function parseRedactConfigOptions(args: string[]): {
|
||||
configPath: string;
|
||||
outPath: string;
|
||||
inPlace: boolean;
|
||||
format: RedactConfigFormat;
|
||||
} {
|
||||
let configPath = "";
|
||||
let outPath = "";
|
||||
let inPlace = false;
|
||||
let format: RedactConfigFormat = "auto";
|
||||
|
||||
for (let i = 0; i < args.length; i += 1) {
|
||||
const arg = args[i];
|
||||
switch (arg) {
|
||||
case "--config":
|
||||
configPath = takeValue(args, i, arg);
|
||||
i += 1;
|
||||
break;
|
||||
case "--out":
|
||||
outPath = takeValue(args, i, arg);
|
||||
i += 1;
|
||||
break;
|
||||
case "--in-place":
|
||||
inPlace = true;
|
||||
break;
|
||||
case "--format": {
|
||||
const value = takeValue(args, i, arg);
|
||||
if (value !== "auto" && value !== "env" && value !== "yaml") {
|
||||
console.error(`invalid --format value: ${value}`);
|
||||
usage();
|
||||
}
|
||||
format = value;
|
||||
i += 1;
|
||||
break;
|
||||
}
|
||||
default:
|
||||
console.error(`Unknown argument: ${arg}`);
|
||||
usage();
|
||||
}
|
||||
}
|
||||
|
||||
if (!configPath) {
|
||||
console.error("Missing --config");
|
||||
usage();
|
||||
}
|
||||
|
||||
if (inPlace === (outPath !== "")) {
|
||||
console.error("Specify exactly one of --in-place or --out <path>");
|
||||
usage();
|
||||
}
|
||||
|
||||
return { configPath, outPath, inPlace, format };
|
||||
}
|
||||
|
||||
function takeValue(args: string[], index: number, flag: string): string {
|
||||
const value = args[index + 1];
|
||||
if (!value || value.startsWith("--")) {
|
||||
@@ -76,6 +132,11 @@ function parseInstallOptions(args: string[]): InstallOptions {
|
||||
usage();
|
||||
}
|
||||
|
||||
if (options.skipSmoke && process.env.HY2XS_BREAK_GLASS !== "1") {
|
||||
console.error("--skip-smoke is break-glass only. Set HY2XS_BREAK_GLASS=1 to continue.");
|
||||
usage();
|
||||
}
|
||||
|
||||
return options;
|
||||
}
|
||||
|
||||
@@ -139,6 +200,11 @@ function parseReconfigureOptions(args: string[]): ReconfigureOptions {
|
||||
usage();
|
||||
}
|
||||
|
||||
if (options.skipSmoke && process.env.HY2XS_BREAK_GLASS !== "1") {
|
||||
console.error("--skip-smoke is break-glass only. Set HY2XS_BREAK_GLASS=1 to continue.");
|
||||
usage();
|
||||
}
|
||||
|
||||
return options;
|
||||
}
|
||||
|
||||
@@ -178,6 +244,10 @@ async function main(): Promise<void> {
|
||||
await diagnosticsCollect(parseCommonOptions(rest));
|
||||
return;
|
||||
}
|
||||
if (command === "redact-config") {
|
||||
await redactConfig(parseRedactConfigOptions(args));
|
||||
return;
|
||||
}
|
||||
usage();
|
||||
}
|
||||
|
||||
|
||||
@@ -1,26 +1,12 @@
|
||||
import type { CommonOptions } from "../types/context";
|
||||
import { info, setOperationContext } from "../lib/log";
|
||||
import { run } from "../lib/process";
|
||||
import { redactEnv, redactYaml } from "../lib/redaction";
|
||||
|
||||
function shellEscapeSingleQuotes(value: string): string {
|
||||
return value.replaceAll("'", "'\\''");
|
||||
}
|
||||
|
||||
function redactEnv(content: string): string {
|
||||
return content
|
||||
.replace(/^(HY2XS_ADMIN_INITIAL_PASSWORD=).*$/gm, "$1<redacted>")
|
||||
.replace(/^(HY2XS_ADMIN_CON_PASS=).*$/gm, "$1<redacted>")
|
||||
.replace(/^(HY2XS_HYSTERIA_TRAFFIC_STATS_SECRET=).*$/gm, "$1<redacted>")
|
||||
.replace(/^(HY2XS_HYSTERIA_OBFS_PASSWORD=).*$/gm, "$1<redacted>");
|
||||
}
|
||||
|
||||
function redactYaml(content: string): string {
|
||||
return content
|
||||
.replace(/(password:\s*).*/gi, "$1<redacted>")
|
||||
.replace(/(secret:\s*).*/gi, "$1<redacted>")
|
||||
.replace(/(auth:\s*).*/gi, "$1<redacted>");
|
||||
}
|
||||
|
||||
export async function diagnosticsCollect(_options: CommonOptions): Promise<void> {
|
||||
const opId = `diag-${Date.now().toString(36)}`;
|
||||
setOperationContext(opId);
|
||||
@@ -49,6 +35,13 @@ export async function diagnosticsCollect(_options: CommonOptions): Promise<void>
|
||||
// noop
|
||||
}
|
||||
|
||||
try {
|
||||
const postInstallRaw = await Bun.file(`${outDir}/post-install.env`).text();
|
||||
await Bun.write(`${outDir}/post-install.env`, redactEnv(postInstallRaw));
|
||||
} catch {
|
||||
// noop
|
||||
}
|
||||
|
||||
try {
|
||||
const cfgRaw = await Bun.file(`${outDir}/hysteria-config.yaml`).text();
|
||||
await Bun.write(`${outDir}/hysteria-config.yaml`, redactYaml(cfgRaw));
|
||||
|
||||
@@ -12,7 +12,7 @@ import { installHysteria } from "../steps/hysteria";
|
||||
import { generateConfig } from "../steps/config";
|
||||
import { deploySystemd } from "../steps/systemd";
|
||||
import { applyFirewall, cancelFirewallRollback, rollbackFirewallNow } from "../steps/firewall";
|
||||
import { writeBootstrapAdminSecret, writePostInstallEnv } from "../steps/env";
|
||||
import { ensureBootstrapAdminSecret, writePostInstallEnv } from "../steps/env";
|
||||
import { smoke } from "../steps/smoke";
|
||||
import { diagnosticsCollect } from "./diagnostics";
|
||||
|
||||
@@ -32,6 +32,7 @@ type InstallPhase =
|
||||
| "postinstall_env_written"
|
||||
| "bootstrap_secret_written"
|
||||
| "services_started"
|
||||
| "smoke_running"
|
||||
| "smoke_failed"
|
||||
| "failed"
|
||||
| "installed";
|
||||
@@ -232,15 +233,15 @@ export async function install(options: InstallOptions): Promise<void> {
|
||||
await advanceInstallState(context, "postinstall_env_written");
|
||||
state.lastPhase = "postinstall_env_written";
|
||||
step("bootstrap admin secret");
|
||||
await writeBootstrapAdminSecret(context);
|
||||
await ensureBootstrapAdminSecret(context);
|
||||
stepDone("bootstrap admin secret");
|
||||
await advanceInstallState(context, "bootstrap_secret_written");
|
||||
state.lastPhase = "bootstrap_secret_written";
|
||||
step("smoke checks");
|
||||
await advanceInstallState(context, "services_started");
|
||||
state.lastPhase = "services_started";
|
||||
await advanceInstallState(context, "smoke_failed");
|
||||
state.lastPhase = "smoke_failed";
|
||||
await advanceInstallState(context, "smoke_running");
|
||||
state.lastPhase = "smoke_running";
|
||||
await smoke(context);
|
||||
stepDone("smoke checks");
|
||||
step("finalize firewall rollback guard");
|
||||
|
||||
@@ -6,7 +6,7 @@ import { preflight } from "../steps/preflight";
|
||||
import { generateConfig } from "../steps/config";
|
||||
import { deploySystemd } from "../steps/systemd";
|
||||
import { applyFirewall, cancelFirewallRollback, rollbackFirewallNow } from "../steps/firewall";
|
||||
import { writePostInstallEnv } from "../steps/env";
|
||||
import { ensureBootstrapAdminSecret, writePostInstallEnv } from "../steps/env";
|
||||
import { smoke } from "../steps/smoke";
|
||||
import { runVisible } from "../lib/process";
|
||||
import { readInstalledHysteriaVersion, readPackageValue } from "../lib/packageMeta";
|
||||
@@ -219,6 +219,7 @@ export async function reconfigure(options: ReconfigureOptions): Promise<void> {
|
||||
await writeText(options.runtimeConfigPath, renderRuntimeEnv(config), 0o600);
|
||||
await runVisible`chown root:root ${options.runtimeConfigPath}`;
|
||||
await runVisible`chmod 0600 ${options.runtimeConfigPath}`;
|
||||
await ensureBootstrapAdminSecret(context);
|
||||
await writePostInstallEnv(context);
|
||||
stepDone("write env artifacts");
|
||||
await markPhase(context, "runtime_env_written");
|
||||
|
||||
@@ -0,0 +1,60 @@
|
||||
import { fileExists, readText, writeTextAtomic } from "../lib/fs";
|
||||
import { info, setOperationContext } from "../lib/log";
|
||||
import { redactEnv, redactYaml } from "../lib/redaction";
|
||||
|
||||
export type RedactConfigFormat = "auto" | "env" | "yaml";
|
||||
|
||||
export type RedactConfigOptions = {
|
||||
configPath: string;
|
||||
outPath: string;
|
||||
inPlace: boolean;
|
||||
format: RedactConfigFormat;
|
||||
};
|
||||
|
||||
function detectFormat(path: string): Exclude<RedactConfigFormat, "auto"> | null {
|
||||
const p = path.toLowerCase();
|
||||
if (p.endsWith(".env") || p.endsWith("hy2xs.env") || p.endsWith("post-install.env")) {
|
||||
return "env";
|
||||
}
|
||||
if (p.endsWith(".yaml") || p.endsWith(".yml")) {
|
||||
return "yaml";
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function resolveFormat(format: RedactConfigFormat, path: string): Exclude<RedactConfigFormat, "auto"> {
|
||||
if (format !== "auto") {
|
||||
return format;
|
||||
}
|
||||
const detected = detectFormat(path);
|
||||
if (!detected) {
|
||||
throw new Error(`unable to auto-detect format for ${path}; use --format env|yaml`);
|
||||
}
|
||||
return detected;
|
||||
}
|
||||
|
||||
export async function redactConfig(options: RedactConfigOptions): Promise<void> {
|
||||
setOperationContext(`redact-config-${Date.now().toString(36)}`);
|
||||
|
||||
if (!(await fileExists(options.configPath))) {
|
||||
throw new Error(`config file not found: ${options.configPath}`);
|
||||
}
|
||||
|
||||
const targetPath = options.inPlace ? options.configPath : options.outPath;
|
||||
if (!targetPath) {
|
||||
throw new Error("target path is empty");
|
||||
}
|
||||
|
||||
const input = await readText(options.configPath);
|
||||
const format = resolveFormat(options.format, options.configPath);
|
||||
const output = format === "env" ? redactEnv(input) : redactYaml(input);
|
||||
|
||||
await writeTextAtomic(targetPath, output, {
|
||||
mode: 0o600,
|
||||
owner: "root",
|
||||
group: "root"
|
||||
});
|
||||
|
||||
info(`redact-config done: source=${options.configPath} target=${targetPath} format=${format} in_place=${options.inPlace}`);
|
||||
}
|
||||
|
||||
@@ -53,20 +53,41 @@ export async function status(_options: CommonOptions): Promise<void> {
|
||||
|
||||
const rollbackGuardUnits = (await run`sh -c 'systemctl list-units --all --no-legend "hy2xs-fw-rollback-*.timer" "hy2xs-fw-rollback-*.service" 2>/dev/null || true'`).trim();
|
||||
|
||||
const hysteriaService = await unitState("hysteria-server");
|
||||
const adminService = await unitState("hy2xs-admin");
|
||||
const firewall = await firewallState();
|
||||
const installPhase = String(installState?.phase ?? "unknown");
|
||||
const installStateEffective = installState?.installed
|
||||
? "installed"
|
||||
: (installPhase === "unknown" ? "failed" : installPhase);
|
||||
const rollbackGuardActive = rollbackGuardUnits.length > 0;
|
||||
const runtimeState = (hysteriaService === "active" && adminService === "active")
|
||||
? (installStateEffective === "installed" ? "running" : "partial")
|
||||
: "stopped";
|
||||
const humanStatus = runtimeState === "partial"
|
||||
? "Runtime services are active, but installation is not finalized because smoke checks failed."
|
||||
: (runtimeState === "running"
|
||||
? "Runtime services are active and installation is finalized."
|
||||
: "Runtime services are not fully active.");
|
||||
|
||||
const result = {
|
||||
ts: new Date().toISOString(),
|
||||
platform,
|
||||
services: {
|
||||
hysteria: await unitState("hysteria-server"),
|
||||
admin: await unitState("hy2xs-admin")
|
||||
hysteria: hysteriaService,
|
||||
admin: adminService
|
||||
},
|
||||
firewall: await firewallState(),
|
||||
firewall,
|
||||
firewall_entrypoint_kind: await detectFirewallEntrypointKind(),
|
||||
tls: await tlsState(),
|
||||
install_state_present: await fileExists(INSTALL_STATE_PATH),
|
||||
install_state: installState,
|
||||
rollback_guard_active: rollbackGuardUnits.length > 0,
|
||||
rollback_guard_units: rollbackGuardUnits ? rollbackGuardUnits.split("\n") : []
|
||||
rollback_guard_active: rollbackGuardActive,
|
||||
rollback_guard_units: rollbackGuardUnits ? rollbackGuardUnits.split("\n") : [],
|
||||
runtime_state: runtimeState,
|
||||
install_state_effective: installStateEffective,
|
||||
firewall_state: rollbackGuardActive ? "guard_active" : firewall,
|
||||
human_status: humanStatus
|
||||
};
|
||||
info(`status report: ${JSON.stringify(result)}`);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
export function redactKeyValueSecrets(content: string): string {
|
||||
return content.replace(
|
||||
/^([A-Z0-9_]*(PASSWORD|PASS|SECRET|TOKEN)[A-Z0-9_]*=).*$/gm,
|
||||
"$1<redacted>"
|
||||
);
|
||||
}
|
||||
|
||||
export function redactEnv(content: string): string {
|
||||
return redactKeyValueSecrets(content);
|
||||
}
|
||||
|
||||
export function redactYaml(content: string): string {
|
||||
return content
|
||||
.replace(/(password:\s*).*/gi, "$1<redacted>")
|
||||
.replace(/(secret:\s*).*/gi, "$1<redacted>")
|
||||
.replace(/(auth:\s*).*/gi, "$1<redacted>");
|
||||
}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
import type { RuntimeContext } from "../types/context";
|
||||
import { readText, renderTemplate, writeTextAtomic } from "../lib/fs";
|
||||
import { fileExists, readText, renderTemplate, writeTextAtomic } from "../lib/fs";
|
||||
import { runVisible } from "../lib/process";
|
||||
|
||||
export async function writePostInstallEnv(context: RuntimeContext): Promise<void> {
|
||||
const rendered = renderTemplate(await readText(`${context.options.packageDir}/templates/env/post-install.env.tpl`), {
|
||||
@@ -54,3 +55,17 @@ export async function writeBootstrapAdminSecret(context: RuntimeContext): Promis
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
export async function ensureBootstrapAdminSecret(context: RuntimeContext): Promise<void> {
|
||||
const path = context.config.bootstrapAdminSecretPath;
|
||||
if (!(await fileExists(path))) {
|
||||
await writeBootstrapAdminSecret(context);
|
||||
return;
|
||||
}
|
||||
|
||||
await runVisible`test "$(stat -c '%U:%G' ${path})" = 'root:root'`;
|
||||
await runVisible`test "$(stat -c '%a' ${path})" = '600'`;
|
||||
await runVisible`grep -q '^ADMIN_USER=' ${path}`;
|
||||
await runVisible`grep -q '^ADMIN_INITIAL_PASSWORD=' ${path}`;
|
||||
await runVisible`grep -q '^ADMIN_CON_PASS=' ${path}`;
|
||||
}
|
||||
|
||||
@@ -100,7 +100,7 @@ export async function applyFirewall(context: RuntimeContext): Promise<void> {
|
||||
|
||||
const acmeChallengePort = context.config.acmeType === "tls" ? 443 : 80;
|
||||
const acmeRule = context.config.tlsMode === "acme"
|
||||
? `tcp dport ${acmeChallengePort} accept`
|
||||
? `meta nfproto ipv4 tcp dport ${acmeChallengePort} accept`
|
||||
: "# acme challenge port disabled";
|
||||
|
||||
const rendered = renderTemplate(await readText(`${context.options.packageDir}/templates/nftables/hy2xs.nft.tpl`), {
|
||||
|
||||
@@ -1,9 +1,19 @@
|
||||
import type { RuntimeContext } from "../types/context";
|
||||
import { resolve4, resolve6 } from "node:dns/promises";
|
||||
import { dirExists, fileExists } from "../lib/fs";
|
||||
import { fail, info } from "../lib/log";
|
||||
import { run } from "../lib/process";
|
||||
import { assertPlatform } from "../platform/assert";
|
||||
|
||||
function isNoDnsRecords(error: unknown): boolean {
|
||||
return (
|
||||
typeof error === "object" &&
|
||||
error !== null &&
|
||||
"code" in error &&
|
||||
(((error as { code?: string }).code === "ENODATA") || ((error as { code?: string }).code === "ENOTFOUND"))
|
||||
);
|
||||
}
|
||||
|
||||
async function isTcpPortListening(port: number): Promise<boolean> {
|
||||
try {
|
||||
const output = await run`ss -H -ltn`;
|
||||
@@ -114,23 +124,28 @@ export async function preflight(context: RuntimeContext): Promise<void> {
|
||||
}
|
||||
|
||||
if (context.config.domain) {
|
||||
let a: string[] = [];
|
||||
try {
|
||||
const a = await run`getent ahostsv4 ${context.config.domain}`;
|
||||
if (!a.trim()) {
|
||||
fail(`domain has no A-record: ${context.config.domain}`);
|
||||
}
|
||||
a = await resolve4(context.config.domain);
|
||||
} catch {
|
||||
fail(`domain has no A-record: ${context.config.domain}`);
|
||||
}
|
||||
if (a.length === 0) {
|
||||
fail(`domain has no A-record: ${context.config.domain}`);
|
||||
}
|
||||
|
||||
let aaaa: string[] = [];
|
||||
try {
|
||||
const aaaa = await run`getent ahostsv6 ${context.config.domain}`;
|
||||
if (aaaa.trim()) {
|
||||
fail(
|
||||
`domain ${context.config.domain} has AAAA record while HY2XS profile is IPv4-only; remove AAAA record before install`
|
||||
);
|
||||
aaaa = await resolve6(context.config.domain);
|
||||
} catch (error) {
|
||||
if (!isNoDnsRecords(error)) {
|
||||
fail(`DNS AAAA lookup failed for ${context.config.domain}: ${String(error)}`);
|
||||
}
|
||||
} catch {
|
||||
// no AAAA is acceptable
|
||||
}
|
||||
if (aaaa.length > 0) {
|
||||
fail(
|
||||
`domain ${context.config.domain} has DNS AAAA record while HY2XS profile is IPv4-only; remove AAAA record before install`
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user