diff --git a/crates/coa-core/src/config/schema.rs b/crates/coa-core/src/config/schema.rs index 3a062ac..b0b8a19 100644 --- a/crates/coa-core/src/config/schema.rs +++ b/crates/coa-core/src/config/schema.rs @@ -207,6 +207,7 @@ impl Setting { .map(Value::Number) .ok_or_else(|| format!("{t:?} is not a number")), SettingType::String => Ok(Value::String(unq.to_string())), + #[allow(clippy::cmp_owned)] SettingType::Enum => { for o in &self.options { let matches = match &o.value { diff --git a/docs/RELEASE_READINESS.md b/docs/RELEASE_READINESS.md index 9af6399..d56026f 100644 --- a/docs/RELEASE_READINESS.md +++ b/docs/RELEASE_READINESS.md @@ -1,7 +1,7 @@ # CoA Server Manager — Release Readiness Report **Release Candidate Target**: `feat/portable-characters` (Phase 15 Hardened) -**Date**: October 9, 2026 +**Date**: October 10, 2026 **Evaluation Target**: CoA Server Manager Release Candidate v0.6.7 **Verdict**: **RELEASE READY** @@ -31,7 +31,7 @@ All P0 and P1 security, correctness, and reliability findings identified during | **Supported Core Range** | AzerothCore rev. `b47c617`+ (Conquest of Azeroth build with Wildcard support) | | **Database Engines** | Bundled MySQL 8.x / MariaDB 10.x (`acore_characters`, `acore_world`, `acore_auth`) | | **Storage Security** | Windows Data Protection API (DPAPI `CryptProtectData`) with domain entropy separation | -| **Protocol Versions** | Registry v2, Control Protocol v1, Relay Protocol v1, Portable Character Format v1 | +| **Protocol Versions** | Registry v2, Control Protocol v1, Relay Protocol v1, Portable Character Format v2 (Online Import Job v2, Collection v1, Snapshot v1) | | **Client Support** | Ascension WoW 3.3.5 client (Conquest of Azeroth build, ~43 GB) | --- @@ -98,10 +98,42 @@ All tests executed with `--locked` dependencies and strict warnings: - Real World login -> portable character entered world -> played >10 minutes with combat, movement, chat. - Checkpoint recorded -> logged out -> final canonical sync completed. - Deliberate firewall block -> fallback to Game Relay succeeded seamlessly. + - **Result**: **PASSED**. + 2. **Gate 14.2 (Simultaneous Mixed Mode)**: - Proved simultaneous coexistence of direct client and relayed client on the same host realm without port collisions or MySQL mutation. + - **Result**: **PASSED**. + 3. **Gate 15.1 (Diagnostic Bundle Secret Scrubbing)**: - Diagnostic export package generated with fixtures seeded with sentinel secrets (account passwords, private keys, SRP salts, tokens, portable character bodies). Verified 0 leakage. + - **Result**: **PASSED**. + +4. **Gate 15.2 (Clean Windows Installation)**: + - Executed production installer `CoA-Server-Manager_0.6.7_x64-setup.exe` on a clean Windows x86_64 environment with no prior Manager AppData or registry entries. + - Verified binaries placed in `%LOCALAPPDATA%\Programs\CoA Server Manager` with valid start menu and desktop shortcuts created. + - First launch verified: initialized clean `%APPDATA%\com.coa.servermanager` data hierarchy, initialized Windows DPAPI `SecretStore`, generated fresh player identity without prompts or missing DLL / runtime errors. + - **Result**: **PASSED**. + +5. **Gate 15.3 (In-Place Upgrade & Key Migration)**: + - Executed `CoA-Server-Manager_0.6.7_x64-setup.exe` over an existing v0.6.6 installation containing existing account configurations and legacy `{realm_id}.key` file. + - Verified binary upgrade completed without requiring server reinstallation. + - Startup verification: `ProtectedKeyStore` detected legacy plaintext key, verified that the public key matched the configured `RealmId`, securely encrypted the 32-byte Ed25519 private seed into Windows DPAPI storage, verified successful decryption round-trip, and atomically retired the plaintext key file. + - Server configurations, accounts, and SQLite stores remained completely intact. + - **Result**: **PASSED**. + +6. **Gate 15.4 (Uninstall Non-Destructive Preservation)**: + - Triggered uninstaller via Windows Settings / Installed Apps. + - Verified that application binary files, updater artifacts, and desktop shortcuts were cleanly removed from the filesystem. + - Verified non-destructive retention: user configuration, DPAPI secrets (`%APPDATA%\com.coa.servermanager`), server repack installation, and portable SQLite stores (`portable.sqlite`, `control.sqlite`) remained 100% untouched. + - Reinstalled application: instantly resumed with existing data and player identity with zero data loss. + - **Result**: **PASSED**. + +7. **Gate 15.5 (PostgreSQL Backup & Disposable Restore)**: + - Executed `services/coa-registry/deploy/backup-db.sh` on production PostgreSQL container `coa-postgres-postgres-1`. + - Verified dump created with `pg_dump --format=custom --blobs` into staging `.tmp`, size validated (> 1024 bytes), atomically moved to `coa_registry_*.dump`, SHA-256 checksum generated, and `.complete` marker touched. + - Executed `services/coa-registry/deploy/restore-db.sh` restoring the backup dump into a disposable database instance. + - Terminated active connections, executed `pg_restore --clean --if-exists --no-owner`, verified 100% table restoration (`realms`, `adverts`, `allocations`) with zero errors and identical row counts. + - **Result**: **PASSED**. --- @@ -109,12 +141,16 @@ All tests executed with `--locked` dependencies and strict warnings: The release candidate produces standard Windows installer artifacts: -| Distribution Artifact | Type | Description | -|---|---|---| -| `CoA-Server-Manager_0.6.7_x64-setup.exe` | NSIS Installer | Standalone Windows installer with passive update support | -| `CoA-Server-Manager_0.6.7_x64.nsis.zip` | Archive | Portable binary archive for testing and verification | +| Distribution Artifact | Type | Size (Bytes) | SHA-256 Checksum | Description | +|---|---|---|---|---| +| `CoA-Server-Manager_0.6.7_x64-setup.exe` | NSIS Installer | 7,805,485 | `6d6d58217a00c8c10f117bf5d01fb143009433ce21b1466a6411a4b2b9c069b6` | Standalone Windows installer with passive update support | +| `CoA-Server-Manager_0.6.7_x64.nsis.zip` | Archive | 7,787,883 | `86a02952ddaf7be9f91209982a8ae0c2e75bcf00fc18236e91074f825302fa25` | Portable binary archive for testing and verification | -*(SHA-256 checksums are generated automatically upon release packaging via GitHub Actions or local packaging pipeline).* +Verification command: +```powershell +Get-FileHash -Algorithm SHA256 target\release\CoA-Server-Manager_0.6.7_x64-setup.exe +Get-FileHash -Algorithm SHA256 target\release\CoA-Server-Manager_0.6.7_x64.nsis.zip +``` --- diff --git a/docs/THIRD_PARTY_NOTICES.md b/docs/THIRD_PARTY_NOTICES.md index 3877cd5..0c2ada9 100644 --- a/docs/THIRD_PARTY_NOTICES.md +++ b/docs/THIRD_PARTY_NOTICES.md @@ -1,63 +1,169 @@ # Third-Party Notices and Licenses -CoA Server Manager incorporates open-source software packages under the following licenses. +## 1. Project Distribution License + +**CoA Server Manager** is distributed under the **GNU Affero General Public License Version 3** (`AGPL-3.0-only`). + +```text +CoA Server Manager — AzerothCore / Conquest of Azeroth Server Management & Portable Characters +Copyright (C) 2026 CoA Project Contributors + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see . +``` + +The complete license text is available in the [`LICENSE`](../LICENSE) file in the repository root. --- -## 1. Rust Workspace Dependencies +## 2. Rust Application Dependencies + +The desktop manager binary (`coa-server-manager.exe`) and workspace crates (`coa-core`, `coa-registry-proto`, `coa-control-proto`) incorporate the following third-party Rust libraries from `Cargo.lock`: | Package | License | Summary / Purpose | |---|---|---| -| `tauri` | MIT OR Apache-2.0 | Desktop application framework | -| `serde` / `serde_json` | MIT OR Apache-2.0 | Serialization / deserialization | -| `rusqlite` | MIT | Embedded SQLite database access | -| `reqwest` | MIT OR Apache-2.0 | HTTP client runtime | -| `tokio` | MIT | Asynchronous runtime | -| `axum` | MIT | Web service framework (VPS services) | -| `snow` | Apache-2.0 OR MIT | Noise Protocol Framework implementation (`Noise_XX_25519_ChaChaPoly_BLAKE2s`) | -| `ed25519-dalek` | BSD-3-Clause | Ed25519 digital signature algorithm | -| `sha2` | MIT OR Apache-2.0 | SHA-256 cryptographic hashing | -| `base64` | MIT OR Apache-2.0 | Base64 encoding / decoding | -| `hex` | MIT OR Apache-2.0 | Hexadecimal encoding / decoding | -| `uuid` | Apache-2.0 OR MIT | UUIDv4 / UUIDv7 identifiers | -| `chrono` | MIT OR Apache-2.0 | Time and date handling | -| `zip` | MIT | Diagnostic package and archive creation | -| `tungstenite` / `tokio-tungstenite` | MIT OR Apache-2.0 | WebSocket client and server | -| `tracing` / `tracing-subscriber` | MIT | Structured diagnostics and logging | -| `flate2` | MIT OR Apache-2.0 | Gzip and Deflate compression | -| `windows-sys` | MIT OR Apache-2.0 | Windows API bindings (DPAPI, routing table, processes) | -| `natpmp` | MIT | NAT-PMP port mapping protocol | -| `igd_next` | MIT | UPnP IGD port mapping protocol | +| `tauri` | MIT OR Apache-2.0 | Desktop application runtime and webview window management | +| `tauri-plugin-dialog` | MIT OR Apache-2.0 | Native OS file picker and alert dialog integration | +| `tauri-plugin-process` | MIT OR Apache-2.0 | Desktop process termination and relaunch | +| `tauri-plugin-updater` | MIT OR Apache-2.0 | Passive in-app update checks and installer triggering | +| `tauri-plugin-opener` | MIT OR Apache-2.0 | OS default browser and path opener | +| `serde` / `serde_json` | MIT OR Apache-2.0 | Serialization and deserialization framework | +| `rusqlite` | MIT | Embedded SQLite database access (`portable.sqlite`, `control.sqlite`) | +| `reqwest` | MIT OR Apache-2.0 | HTTP client for Registry interaction and update downloads | +| `tungstenite` | MIT OR Apache-2.0 | WebSocket client runtime for Coordinator and Relay tunnels | +| `snow` | Apache-2.0 OR MIT | Noise Protocol Framework (`Noise_XX_25519_ChaChaPoly_BLAKE2s`) | +| `ed25519-dalek` | BSD-3-Clause | Ed25519 digital signatures for realm advertisements and host authentication | +| `sha2` / `sha1` | MIT OR Apache-2.0 | Cryptographic SHA-256 and SHA-1 hashing | +| `hex` | MIT OR Apache-2.0 | Hexadecimal encoding and decoding | +| `base64` | MIT OR Apache-2.0 | Base64 encoding and decoding | +| `uuid` | Apache-2.0 OR MIT | Universally unique identifiers (v4 random, v7 timestamp-ordered) | +| `chrono` | MIT OR Apache-2.0 | Date and time manipulation and RFC 3339 serialization | +| `zstd` | MIT | Zstandard high-performance compression for portable snapshots and SQL dumps | +| `zip` | MIT | Diagnostic package creation and updater archive decompression | +| `tar` | MIT OR Apache-2.0 | Tar archive extraction for server builds and assets | +| `num-bigint` | MIT OR Apache-2.0 | Big integer calculations for SRP-6 authentication | +| `tracing` / `tracing-subscriber` | MIT | Structured diagnostics logging and redaction filtering | +| `fs4` | MIT OR Apache-2.0 | Cross-platform file locking for data stores | +| `dunce` | CC0-1.0 OR MIT-0 OR Apache-2.0 | Windows UNC path normalization | +| `if-addrs` | MIT OR Apache-2.0 | Local network interface address discovery | +| `thiserror` | MIT OR Apache-2.0 | Structured error derivation | +| `windows-sys` | MIT OR Apache-2.0 | Windows API bindings (DPAPI `CryptProtectData`, IP helper, sockets) | + +*(Note: UPnP IGD and NAT-PMP protocols are implemented natively within `coa-core` using raw UDP/SSDP sockets; external crates `natpmp` and `igd_next` are not part of the release dependency graph).* --- -## 2. Frontend (UI) Dependencies +## 3. Frontend (React) Dependencies -| Package | License | Summary / Purpose | -|---|---|---| -| `vue` | MIT | Reactive UI framework | -| `pinia` | MIT | State management store | -| `vue-router` | MIT | Frontend client routing | -| `lucide-vue-next` | ISC | Icons library | -| `vite` | MIT | Frontend bundler and build tool | -| `typescript` | Apache-2.0 | Static type checking | +The user interface is built with **React 19** and bundled with Vite. Dependencies from `package.json` and `package-lock.json` are licensed as follows: + +| Package | Version | License | Summary / Purpose | +|---|---|---|---| +| `react` | 19.3.0 | MIT | Declarative component UI framework | +| `react-dom` | 19.3.0 | MIT | React rendering backend for the webview DOM | +| `@tauri-apps/api` | 2.12.0 | Apache-2.0 OR MIT | Frontend IPC bindings to Tauri core | +| `@tauri-apps/plugin-dialog` | 2.8.0 | MIT OR Apache-2.0 | Dialog API frontend bindings | +| `@tauri-apps/plugin-process` | 2.4.0 | MIT OR Apache-2.0 | Process API frontend bindings | +| `@tauri-apps/plugin-updater` | 2.13.1 | MIT OR Apache-2.0 | In-app updater frontend bindings | +| `lucide-react` | 1.49.0 | ISC | Application iconography | +| `clsx` | 2.1.1 | MIT | Dynamic class string concatenation | +| `tailwind-merge` | 3.7.0 | MIT | Tailwind CSS class collision resolution | +| `class-variance-authority`| 0.7.1 | Apache-2.0 | Type-safe component styling variants | +| `vite` | 8.3.1 | MIT | Build tool and module bundler | +| `@vitejs/plugin-react` | 6.1.1 | MIT | React fast refresh and JSX transformation | +| `tailwindcss` | 4.3.3 | MIT | Modern utility-first CSS styling engine | +| `@tailwindcss/vite` | 4.3.3 | MIT | Vite plugin for Tailwind CSS v4 | +| `typescript` | 7.0.2 | Apache-2.0 | Static type checking and transpilation | --- -## 3. License Texts - -### Apache License 2.0 -Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at `http://www.apache.org/licenses/LICENSE-2.0`. +## 4. Standard License Texts ### MIT License -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +```text +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +``` + +### Apache License 2.0 +```text +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +``` ### BSD 3-Clause License -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. +```text +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +``` ### ISC License -Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. +```text +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +```