Compare commits

..
Author SHA1 Message Date
Дмитрий bf2fffcffa fix(friends): restore LAN realm address after restart (#158) 2026-10-27 08:34:02 +05:00
Дмитрий 4a99dd3a6a docs: review Manager 0.8.2 release history 2026-10-27 08:01:37 +05:00
github-actions[bot] 306003b698 Update published Manager changelog 2026-10-27 02:58:39 +00:00
Corfirean d9be2b9d82 Merge pull request #161 from Corfirean/prepare/races-192-20261026
Prepare CoA Custom 1.9.2 clients and preserve server migration order
2026-10-27 07:58:04 +05:00
Дмитрий 81b040ef02 Preserve database migration introduction order across merge commits 2026-10-27 00:30:08 +05:00
Дмитрий 5fdee1d658 Prepare matching CoA Custom 1.9.2 client installation 2026-10-26 23:14:39 +05:00
Дмитрий 4e1f548012 Retain the experimental portable-character notice in Manager 0.8.1 2026-10-25 18:04:13 +05:00
github-actions[bot] b3ee94071d Update published Manager changelog 2026-10-25 13:02:58 +00:00
Corfirean 76dc7452de Merge pull request #157 from Corfirean/prepare/races-191-20261025
Prepare CoA Custom 1.9.1 client installation for the new server
2026-10-25 18:02:16 +05:00
Дмитрий 02e3a9e4e6 Validate nested client assets and retain previous split-release hashes 2026-10-25 11:55:24 +05:00
Дмитрий 8addc97bc5 Prepare compatible CoA Custom 1.9.1 client installation 2026-10-25 11:41:15 +05:00
github-actions[bot] 57807b9769 Update published Manager changelog 2026-10-24 14:50:03 +00:00
Corfirean 7e29a9f2ec Keep the experimental portable-character notice in Manager 0.8.0 notes 2026-10-24 19:49:46 +05:00
github-actions[bot] af9f148889 Update published Manager changelog 2026-10-24 14:27:27 +00:00
Corfirean 92385cf569 Merge pull request #152 from Corfirean/fix/portable-host-activation-20261024
Prepare core portable sessions when the owner enables access
2026-10-24 16:46:12 +05:00
Дмитрий b00e732c7f fix(portable): reject occupied world ports across platforms 2026-10-24 16:37:52 +05:00
Дмитрий 594bdee594 fix(portable): prepare effective core configuration on owner opt-in 2026-10-24 16:32:55 +05:00
Corfirean d4408a0e92 Merge pull request #151 from Corfirean/integrate/complete-release-20261024
Prepare Manager 0.8.0 with rulesets, portable access and relay fixes
2026-10-24 11:19:40 +05:00
Дмитрий b61a186470 Restore remote portable progress and resilient relay connections 2026-10-24 11:12:01 +05:00
Дмитрий 9e9778af74 Keep external network gates reproducible and check all registry rulesets 2026-10-24 06:33:00 +05:00
Дмитрий d5f1e9cc83 Integrate isolated rulesets, portable admission, and compatible relay authentication 2026-10-24 06:04:26 +05:00
github-actions[bot] aa25e9c721 Update published Manager changelog 2026-10-23 20:19:26 +00:00
Corfirean 1fd3a5482e Merge pull request #150 from Corfirean/fix/portable-schema9-hotfix
Fix schema 9 portable stores in Manager 0.7.3
2026-10-24 01:09:25 +05:00
Дмитрий 2715170622 Fix portable schema 9 compatibility and prepare Manager 0.7.3 2026-10-24 01:00:27 +05:00
github-actions[bot] 8801c6f308 Update published Manager changelog 2026-10-23 19:20:08 +00:00
github-actions[bot] 341f2f0230 Update published Manager changelog 2026-10-23 14:18:59 +00:00
Дмитрий a48717340b chore(reborn): MR3.1 semantic audit, i18n localization, and fail-closed cleanup 2026-10-22 22:18:28 +05:00
Дмитрий 351ace1c56 feat(reborn): MR3 Warcraft Reborn portable character vertical slice and ruleset UI 2026-10-22 21:26:39 +05:00
Дмитрий ba143e1ccd fix(control): MR2.1 fail-closed world-port resolution and ruleset invariant verification
- Make world_port resolution fallible (Result<u16>) across LocalBackend, HostService, DirectRouteManager, and RelayLink without default fallbacks to 8085.
- Enforce strict 4-way invariant: local_id ruleset == RealmAccess.mode == Db.realm() == RealmInfo.ruleset. Malformed or unknown suffixes fail closed.
- If Wildcard is selected and world-port resolution fails (or simultaneous mode is disabled), Direct and Relay fail closed with actionable error and zero fallback to CoA.
- Fix documentation drift in docs/WILDCARD.md and docs/MULTIRULESET_PORTABLE_AUDIT.md regarding simultaneous execution, distinct ports, and current vs historical baseline.
2026-10-22 18:10:49 +05:00
Дмитрий 5343020bed feat(portable): MR2 Wildcard portable character vertical slice
- Enforce fail-closed backend resolution in LocalBackend::info (unknown ruleset = error).
- Implement strict three-space isolation (Wildcard != CoA != Reborn) across canonical store, host mappings, and collections.
- Isolate collection namespaces (wildcard:appearance, wildcard:vanity) and reject cross-ruleset collections in claim and import.
- Enforce Control Protocol v2 ruleset verification on TransferOffer, TransferCommit, and Claimed response.
- Route Direct Ingress and Relay Link dynamically according to realm world port (8085 for CoA, 8086 for Wildcard).
- Add runtime session attack rejection test suite (cross-ruleset session offers, checkpoints, owner acks, server IDs).
- Verify end-to-end Wildcard session lifecycle and documentation updates.
2026-10-22 17:24:15 +05:00
Дмитрий 9d135765cd feat(multiruleset): complete MR1.1 foundation correctness gate 2026-10-22 15:34:37 +05:00
Дмитрий 58a99f0a6d feat: multi-ruleset realms and strictly isolated portable characters 2026-10-22 13:04:57 +05:00
Дмитрий d9c10c4564 Merge released v0.7.1 into feat/multiruleset-realms-portable 2026-10-22 12:00:03 +05:00
135 changed files with 9499 additions and 1126 deletions

No files matched your search

+51
View File
@@ -8,6 +8,57 @@ Published releases and previews. Pre-release entries do not change the stable up
Dates follow GitHub publication (UTC); legacy records retain their archived dates. Newest releases first. Dates follow GitHub publication (UTC); legacy records retain their archived dates. Newest releases first.
## 0.8.2 — 2026-10-27
**Portable Characters are experimental and may contain bugs.**
- Installs the verified CoA Custom 1.9.2 client patches and quest safety addon, while recognizing existing 1.9.1 installations.
- Server updates preserve the order of database migrations introduced during merges, preventing older snapshots from overwriting newer progression.
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.8.2) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.8.1...v0.8.2)
## 0.8.1 — 2026-10-25
**Portable Characters are experimental and may contain bugs.**
- Install the matching CoA Custom 1.9.1 client files.
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.8.1) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.8.0...v0.8.1)
## 0.8.0 — 2026-10-24
**Portable Characters are experimental and may contain bugs.**
- Server owners can allow portable characters per realm.
- Allowing portable characters also prepares the server for portable sessions.
- Managers stay compatible with the public connection service.
- Relay connections recover and use the ports of the installed server.
- Portable progress resumes after reconnecting or restarting the Manager.
- Older copies on another host may require maintenance before returning.
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.8.0) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.7.3...v0.8.0)
## 0.7.3 — 2026-10-23
**Portable Characters are experimental and may contain bugs.**
- Portable characters open again after using an experimental Manager.
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.7.3) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.7.2...v0.7.3)
## 0.7.2 — 2026-10-23
- Advanced settings cover creature melee damage, spell damage and health by rank.
- Internet sharing accepts existing port forwards to the same server.
- The Auction House Bot card has a single switch.
- More character and server browser controls now use your selected language.
- Online player counts correctly separate random bots from players.
- Custom races work with shared addon folders on another drive.
- Configure the day and night cycle from the module settings.
- A stalled database inspection no longer blocks server maintenance indefinitely.
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.7.2) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.7.1...v0.7.2)
## 0.7.1 — 2026-10-22 ## 0.7.1 — 2026-10-22
Close the game, then open Modules → Custom Races → Repair Client Patch to update existing patches, or Install Client Patch for a new installation. Updating the Manager does not automatically replace game files or update your server. Close the game, then open Modules → Custom Races → Repair Client Patch to update existing patches, or Install Client Patch for a new installation. Updating the Manager does not automatically replace game files or update your server.
Generated
+3 -3
View File
@@ -586,7 +586,7 @@ dependencies = [
[[package]] [[package]]
name = "coa-core" name = "coa-core"
version = "0.7.2" version = "0.8.2"
dependencies = [ dependencies = [
"base64 0.22.1", "base64 0.22.1",
"chrono", "chrono",
@@ -634,7 +634,7 @@ dependencies = [
[[package]] [[package]]
name = "coa-release" name = "coa-release"
version = "0.7.2" version = "0.8.2"
dependencies = [ dependencies = [
"chrono", "chrono",
"coa-core", "coa-core",
@@ -643,7 +643,7 @@ dependencies = [
[[package]] [[package]]
name = "coa-server-manager" name = "coa-server-manager"
version = "0.7.2" version = "0.8.2"
dependencies = [ dependencies = [
"coa-control-proto", "coa-control-proto",
"coa-core", "coa-core",
+1 -1
View File
@@ -4,7 +4,7 @@ members = ["crates/coa-core", "crates/coa-release", "crates/coa-registry-proto",
exclude = ["services/coa-registry", "services/coa-registry-e2e", "services/coa-coordinator", "services/coa-relay"] exclude = ["services/coa-registry", "services/coa-registry-e2e", "services/coa-coordinator", "services/coa-relay"]
[workspace.package] [workspace.package]
version = "0.7.2" version = "0.8.2"
edition = "2021" edition = "2021"
license = "AGPL-3.0-only" license = "AGPL-3.0-only"
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Server owners can allow portable characters per realm
---
Portable admission is off until enabled by the realm owner. Export and import requests enforce the saved choice.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Allowing portable characters also prepares the server for portable sessions
---
Stop the server before enabling access for the first time. The Manager enables portable sessions in the effective module configuration and preserves the required database setting across restarts. Existing configuration is backed up.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: players
title: Portable characters open again after using an experimental Manager
---
Preserves saved characters and collections when opening a portable store upgraded by an experimental Manager.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Managers stay compatible with the public connection service
---
Coordinator authentication no longer changes when portable messages change. The publishing card shows game relay status separately.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Relay connections recover and use the ports of the installed server
---
Dropped or unresponsive relay links reconnect automatically. Abandoned game connections close, and tunnels refresh when local ports become available or change. Custom authentication ports are respected.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Portable progress resumes after reconnecting or restarting the Manager
---
The player Manager now saves remote baselines, checkpoints and logout progress durably. Repeated logins stay monitored, and transfer retries preserve the same character and session.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: known-issue
audience: admins
title: Older copies on another host may require maintenance before returning
---
Experimental portable play blocks an outdated existing copy on another host. Automatic refresh while that remote worldserver runs is not available. Your canonical character remains saved in your Manager.
+7
View File
@@ -0,0 +1,7 @@
---
area: client
type: changed
audience: players
title: Install the matching CoA Custom 1.9.1 client files
---
The races installer verifies and installs all five client archives, including the new races and appearance corrections.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: changed
audience: players
title: Install the CoA Custom 1.9.2 client patches
---
Installs the updated Hozen and Centaur assets and quest safety addon. Existing CoA Custom 1.9.1 installations remain recognized when updating or removing patches.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Internet sharing restores the LAN address after server restarts
---
Friends on the local network receive the server's LAN address and network mask while internet players keep using its public address.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Server updates preserve the order of database migrations added during merges
---
Older database snapshots no longer run after newer updates when preparing server packages. This prevents outdated Manastorm reward ranges from overwriting newer progression data.
+99 -1
View File
@@ -112,6 +112,8 @@
"Corfirean/coa-server-manager:20261016-preserve-core-migration-history.md", "Corfirean/coa-server-manager:20261016-preserve-core-migration-history.md",
"Corfirean/coa-server-manager:20261016-shared-auth-migration-history.md", "Corfirean/coa-server-manager:20261016-shared-auth-migration-history.md",
"Corfirean/coa-server-manager:20261016-update-compatibility-wording.md", "Corfirean/coa-server-manager:20261016-update-compatibility-wording.md",
"Corfirean/coa-server-manager:20261017-creature-difficulty-rates.md",
"Corfirean/coa-server-manager:20261017-existing-router-mapping.md",
"Corfirean/coa-server-manager:20261018-custom-races-client.md", "Corfirean/coa-server-manager:20261018-custom-races-client.md",
"Corfirean/coa-server-manager:20261019-portable-stop-diagnostics.md", "Corfirean/coa-server-manager:20261019-portable-stop-diagnostics.md",
"Corfirean/coa-server-manager:20261019-remote-character-class-names.md", "Corfirean/coa-server-manager:20261019-remote-character-class-names.md",
@@ -120,7 +122,23 @@
"Corfirean/coa-server-manager:20261021-portable-experimental.md", "Corfirean/coa-server-manager:20261021-portable-experimental.md",
"Corfirean/coa-server-manager:20261021-scaling-health-settings.md", "Corfirean/coa-server-manager:20261021-scaling-health-settings.md",
"Corfirean/coa-server-manager:20261021-warcraft-reborn-realm.md", "Corfirean/coa-server-manager:20261021-warcraft-reborn-realm.md",
"Corfirean/coa-server-manager:20261022-custom-races-client.md" "Corfirean/coa-server-manager:20261022-custom-races-client.md",
"Corfirean/coa-server-manager:20261023-ah-bot-single-switch.md",
"Corfirean/coa-server-manager:20261023-interface-language-coverage.md",
"Corfirean/coa-server-manager:20261023-online-players-exclude-squid-bots.md",
"Corfirean/coa-server-manager:20261023-shared-addons-links.md",
"Corfirean/coa-server-manager:20261023-time-is-time-settings.md",
"Corfirean/coa-server-manager:20261023-update-check-database-timeout.md",
"Corfirean/coa-server-manager:20261024-portable-admission.md",
"Corfirean/coa-server-manager:20261024-portable-owner-core-activation.md",
"Corfirean/coa-server-manager:20261024-portable-schema-nine.md",
"Corfirean/coa-server-manager:20261024-relay-authentication.md",
"Corfirean/coa-server-manager:20261024-relay-recovery.md",
"Corfirean/coa-server-manager:20261024-remote-progress.md",
"Corfirean/coa-server-manager:20261024-remote-refresh.md",
"Corfirean/coa-server-manager:20261025-custom-races-191.md",
"Corfirean/coa-server-manager:20261026-custom-races-192.md",
"Corfirean/coa-server-manager:20261027-merged-database-migration-order.md"
], ],
"releases": [ "releases": [
{ {
@@ -623,6 +641,86 @@
"links": [ "links": [
"[Guides and screenshots](https://github.com/Corfirean/coa-server-manager/blob/master/docs/README.md)" "[Guides and screenshots](https://github.com/Corfirean/coa-server-manager/blob/master/docs/README.md)"
] ]
},
{
"tag": "v0.7.2",
"version": "0.7.2",
"date": "2026-10-23",
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.7.2",
"notes": [
"Advanced settings cover creature melee damage, spell damage and health by rank",
"Internet sharing accepts existing port forwards to the same server",
"The Auction House Bot card has a single switch",
"More character and server browser controls now use your selected language",
"Online player counts correctly separate random bots from players",
"Custom races work with shared addon folders on another drive",
"Configure the day and night cycle from the module settings",
"A stalled database inspection no longer blocks server maintenance indefinitely"
],
"commit": "4d59ce8cb1d4abd7f4992370e9a7ba4dc6bd02f7",
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.7.1...v0.7.2"
},
{
"tag": "v0.7.3",
"version": "0.7.3",
"date": "2026-10-23",
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.7.3",
"notes": [
"Portable characters open again after using an experimental Manager"
],
"commit": "2715170622665f62c396fe1a79f7ef6504713ef1",
"experimentalFeatures": [
"portable-characters"
],
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.7.2...v0.7.3"
},
{
"tag": "v0.8.0",
"version": "0.8.0",
"date": "2026-10-24",
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.8.0",
"notes": [
"Server owners can allow portable characters per realm",
"Allowing portable characters also prepares the server for portable sessions",
"Managers stay compatible with the public connection service",
"Relay connections recover and use the ports of the installed server",
"Portable progress resumes after reconnecting or restarting the Manager",
"Older copies on another host may require maintenance before returning"
],
"commit": "b00e732c7f53f33680aaf6bd520da64b70b26a5a",
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.7.3...v0.8.0",
"experimentalFeatures": [
"portable-characters"
]
},
{
"tag": "v0.8.1",
"version": "0.8.1",
"date": "2026-10-25",
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.8.1",
"notes": [
"Install the matching CoA Custom 1.9.1 client files"
],
"commit": "02e3a9e4e66870a627feeb0b4d3ec2d75a23973d",
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.8.0...v0.8.1",
"experimentalFeatures": [
"portable-characters"
]
},
{
"tag": "v0.8.2",
"version": "0.8.2",
"date": "2026-10-27",
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.8.2",
"notes": [
"Installs the verified CoA Custom 1.9.2 client patches and quest safety addon, while recognizing existing 1.9.1 installations",
"Server updates preserve the order of database migrations introduced during merges, preventing older snapshots from overwriting newer progression"
],
"commit": "81b040ef02763c7cf7a3a3da1424b73177e9d433",
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.8.1...v0.8.2",
"experimentalFeatures": [
"portable-characters"
]
} }
] ]
} }
+115 -1
View File
@@ -15,6 +15,15 @@ pub const MAX_USERNAME: usize = 16;
pub const MIN_PASSWORD: usize = 8; pub const MIN_PASSWORD: usize = 8;
pub const MAX_PASSWORD: usize = 16; pub const MAX_PASSWORD: usize = 16;
pub const MAX_CHARACTERS: usize = 200; pub const MAX_CHARACTERS: usize = 200;
pub const MAX_SESSION_BYTES: usize = 12 * 1024 * 1024;
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum SessionMessageKind {
Started,
Checkpoint,
Collection,
}
/// A game account name: 3 to 16 ASCII letters, digits or `_`, not beginning or ending with `_`. /// A game account name: 3 to 16 ASCII letters, digits or `_`, not beginning or ending with `_`.
pub fn valid_username(s: &str) -> bool { pub fn valid_username(s: &str) -> bool {
@@ -103,6 +112,16 @@ pub enum Request {
TransferOffer { TransferOffer {
transfer_id: Uuid, transfer_id: Uuid,
character_id: Uuid, character_id: Uuid,
ruleset: String,
canonical_revision: u64,
content_hash: String,
total_size: usize,
collections: BTreeMap<String, Vec<u32>>,
},
OwnedTransferOffer {
transfer_id: Uuid,
character_id: Uuid,
ruleset: String,
canonical_revision: u64, canonical_revision: u64,
content_hash: String, content_hash: String,
total_size: usize, total_size: usize,
@@ -127,6 +146,24 @@ pub enum Request {
transfer_id: Uuid, transfer_id: Uuid,
character_id: Uuid, character_id: Uuid,
}, },
SessionPoll {
character_id: Uuid,
session_id: Uuid,
},
SessionRead {
character_id: Uuid,
session_id: Uuid,
message_hash: String,
offset: usize,
},
SessionAck {
character_id: Uuid,
session_id: Uuid,
message_hash: String,
offset: usize,
total_size: usize,
data: String,
},
/// Phase 13: Request a short-lived relay allocation for a relayed JOIN. /// Phase 13: Request a short-lived relay allocation for a relayed JOIN.
AllocateRelay { AllocateRelay {
player_id: Uuid, player_id: Uuid,
@@ -171,6 +208,22 @@ pub struct CharacterEntry {
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
#[serde(tag = "op", rename_all = "snake_case")] #[serde(tag = "op", rename_all = "snake_case")]
pub enum Response { pub enum Response {
SessionPending {
kind: SessionMessageKind,
total_size: usize,
content_hash: String,
},
SessionIdle {
closed: bool,
},
SessionData {
offset: usize,
data: String,
},
SessionAcked {
received_size: usize,
complete: bool,
},
Welcome { Welcome {
realm_id: coa_registry_proto::RealmId, realm_id: coa_registry_proto::RealmId,
automatic: bool, automatic: bool,
@@ -189,6 +242,7 @@ pub enum Response {
/// appearance and vanity ids the Host holds for the account (kind -> ids). /// appearance and vanity ids the Host holds for the account (kind -> ids).
Claimed { Claimed {
character_id: Uuid, character_id: Uuid,
ruleset: String,
sha256: String, sha256: String,
payload: String, payload: String,
collections: BTreeMap<String, Vec<u32>>, collections: BTreeMap<String, Vec<u32>>,
@@ -245,7 +299,10 @@ pub fn decode_request(bytes: &[u8]) -> Result<Request> {
.map_err(|_| ControlError::Invalid("a request is not valid".into()))?; .map_err(|_| ControlError::Invalid("a request is not valid".into()))?;
if !matches!( if !matches!(
&r, &r,
Request::TransferOffer { .. } | Request::TransferChunk { .. } Request::TransferOffer { .. }
| Request::OwnedTransferOffer { .. }
| Request::TransferChunk { .. }
| Request::SessionAck { .. }
) && bytes.len() > MAX_CONTROL_REQUEST_BYTES ) && bytes.len() > MAX_CONTROL_REQUEST_BYTES
{ {
return Err(ControlError::Limit( return Err(ControlError::Limit(
@@ -253,6 +310,34 @@ pub fn decode_request(bytes: &[u8]) -> Result<Request> {
)); ));
} }
match &r { match &r {
Request::SessionRead {
message_hash,
offset,
..
} => {
if message_hash.len() != 64
|| !message_hash.bytes().all(|b| b.is_ascii_hexdigit())
|| *offset > MAX_SESSION_BYTES
{
return invalid("invalid portable session read");
}
}
Request::SessionAck {
message_hash,
offset,
total_size,
data,
..
} => {
if message_hash.len() != 64
|| !message_hash.bytes().all(|b| b.is_ascii_hexdigit())
|| *total_size > MAX_SESSION_BYTES
|| *offset > *total_size
|| data.len() > 48 * 1024
{
return invalid("invalid portable session acknowledgement chunk");
}
}
Request::Provision { Request::Provision {
desired, password, .. desired, password, ..
} => { } => {
@@ -273,11 +358,22 @@ pub fn decode_request(bytes: &[u8]) -> Result<Request> {
return invalid("the client name is too long") return invalid("the client name is too long")
} }
Request::TransferOffer { Request::TransferOffer {
ruleset,
content_hash,
total_size,
collections,
..
}
| Request::OwnedTransferOffer {
ruleset,
content_hash, content_hash,
total_size, total_size,
collections, collections,
.. ..
} => { } => {
if !matches!(ruleset.as_str(), "coa" | "wildcard" | "reborn") {
return invalid("transfer ruleset must be coa, wildcard, or reborn");
}
if content_hash.len() != 64 || !content_hash.chars().all(|c| c.is_ascii_hexdigit()) { if content_hash.len() != 64 || !content_hash.chars().all(|c| c.is_ascii_hexdigit()) {
return invalid("transfer content hash must be 64 hex characters"); return invalid("transfer content hash must be 64 hex characters");
} }
@@ -430,6 +526,7 @@ mod tests {
let offer = Request::TransferOffer { let offer = Request::TransferOffer {
transfer_id: tid, transfer_id: tid,
character_id: cid, character_id: cid,
ruleset: "coa".into(),
canonical_revision: 5, canonical_revision: 5,
content_hash: hash.clone(), content_hash: hash.clone(),
total_size: 1024, total_size: 1024,
@@ -442,6 +539,7 @@ mod tests {
let bad_hash = Request::TransferOffer { let bad_hash = Request::TransferOffer {
transfer_id: tid, transfer_id: tid,
character_id: cid, character_id: cid,
ruleset: "coa".into(),
canonical_revision: 5, canonical_revision: 5,
content_hash: "too_short".into(), content_hash: "too_short".into(),
total_size: 1024, total_size: 1024,
@@ -466,5 +564,21 @@ mod tests {
}; };
let resp_dec = decode_response(&encode_response(&resp)).unwrap(); let resp_dec = decode_response(&encode_response(&resp)).unwrap();
assert_eq!(resp, resp_dec); assert_eq!(resp, resp_dec);
// Control protocol v2 requires ruleset in TransferOffer; missing is rejected
let missing_ruleset_json = serde_json::json!({
"op": "transfer_offer",
"transfer_id": tid,
"character_id": cid,
"canonical_revision": 5,
"content_hash": hash,
"total_size": 1024,
"collections": {}
});
let encoded_missing = serde_json::to_vec(&missing_ruleset_json).unwrap();
assert!(
decode_request(&encoded_missing).is_err(),
"missing ruleset in v2 must be rejected"
);
} }
} }
+14 -2
View File
@@ -112,6 +112,10 @@ pub struct ProbeResponse {
pub all_reachable: bool, pub all_reachable: bool,
} }
/// Coordinator authentication is independent of the encrypted application protocol.
/// Changing portable messages must not invalidate deployed v1 host/player proofs.
pub const COORDINATOR_PROTOCOL_VERSION: u32 = 1;
pub fn challenge_nonce() -> String { pub fn challenge_nonce() -> String {
let mut n = [0u8; 32]; let mut n = [0u8; 32];
n[..16].copy_from_slice(Uuid::new_v4().as_bytes()); n[..16].copy_from_slice(Uuid::new_v4().as_bytes());
@@ -122,7 +126,7 @@ pub fn challenge_nonce() -> String {
fn host_input(realm: &RealmId, nonce: &str, ts: i64) -> Vec<u8> { fn host_input(realm: &RealmId, nonce: &str, ts: i64) -> Vec<u8> {
format!( format!(
"coa-coord-host-v1\n{}\n{realm}\n{nonce}\n{ts}", "coa-coord-host-v1\n{}\n{realm}\n{nonce}\n{ts}",
crate::CONTROL_PROTOCOL_VERSION COORDINATOR_PROTOCOL_VERSION
) )
.into_bytes() .into_bytes()
} }
@@ -130,7 +134,7 @@ fn host_input(realm: &RealmId, nonce: &str, ts: i64) -> Vec<u8> {
fn player_input(player: &Uuid, public_key: &str, realm: &RealmId, nonce: &str, ts: i64) -> Vec<u8> { fn player_input(player: &Uuid, public_key: &str, realm: &RealmId, nonce: &str, ts: i64) -> Vec<u8> {
format!( format!(
"coa-coord-player-v1\n{}\n{}\n{public_key}\n{realm}\n{nonce}\n{ts}", "coa-coord-player-v1\n{}\n{}\n{public_key}\n{realm}\n{nonce}\n{ts}",
crate::CONTROL_PROTOCOL_VERSION, COORDINATOR_PROTOCOL_VERSION,
player.hyphenated() player.hyphenated()
) )
.into_bytes() .into_bytes()
@@ -277,6 +281,14 @@ pub fn to_text(frame: &Frame) -> String {
mod tests { mod tests {
use super::*; use super::*;
#[test]
fn deployed_coordinator_proofs_stay_v1_when_application_protocol_changes() {
let realm = RealmId::new();
let player = Uuid::now_v7();
assert_eq!(host_input(&realm, "nonce", 42), format!("coa-coord-host-v1\n1\n{realm}\nnonce\n42").into_bytes());
assert_eq!(player_input(&player, "public", &realm, "nonce", 42), format!("coa-coord-player-v1\n1\n{player}\npublic\n{realm}\nnonce\n42").into_bytes());
}
fn key(n: u8) -> SigningKey { fn key(n: u8) -> SigningKey {
SigningKey::from_bytes(&[n; 32]) SigningKey::from_bytes(&[n; 32])
} }
+1 -1
View File
@@ -16,7 +16,7 @@ pub mod coord;
pub mod noise; pub mod noise;
pub mod relay; pub mod relay;
pub const CONTROL_PROTOCOL_VERSION: u32 = 1; pub const CONTROL_PROTOCOL_VERSION: u32 = 2;
#[derive(Debug, thiserror::Error, PartialEq, Eq)] #[derive(Debug, thiserror::Error, PartialEq, Eq)]
pub enum ControlError { pub enum ControlError {
@@ -90,6 +90,7 @@ fn test_app_request_hostile_limits_and_validation() {
let offer = Request::TransferOffer { let offer = Request::TransferOffer {
transfer_id: Uuid::now_v7(), transfer_id: Uuid::now_v7(),
character_id: Uuid::now_v7(), character_id: Uuid::now_v7(),
ruleset: "coa".into(),
canonical_revision: 1, canonical_revision: 1,
content_hash: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef".into(), content_hash: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef".into(),
total_size: 1024, total_size: 1024,
@@ -105,6 +106,7 @@ fn test_app_request_hostile_limits_and_validation() {
let bad_hash_offer = Request::TransferOffer { let bad_hash_offer = Request::TransferOffer {
transfer_id: Uuid::now_v7(), transfer_id: Uuid::now_v7(),
character_id: Uuid::now_v7(), character_id: Uuid::now_v7(),
ruleset: "coa".into(),
canonical_revision: 1, canonical_revision: 1,
content_hash: "not_a_valid_hex_hash".into(), content_hash: "not_a_valid_hex_hash".into(),
total_size: 1024, total_size: 1024,
@@ -112,6 +114,18 @@ fn test_app_request_hostile_limits_and_validation() {
}; };
assert!(decode_request(&encode_request(&bad_hash_offer)).is_err()); assert!(decode_request(&encode_request(&bad_hash_offer)).is_err());
// 4b. Invalid ruleset rejected
let bad_ruleset_offer = Request::TransferOffer {
transfer_id: Uuid::now_v7(),
character_id: Uuid::now_v7(),
ruleset: "invalid_ruleset".into(),
canonical_revision: 1,
content_hash: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef".into(),
total_size: 1024,
collections: BTreeMap::new(),
};
assert!(decode_request(&encode_request(&bad_ruleset_offer)).is_err());
// 5. TransferChunk offset out of bounds // 5. TransferChunk offset out of bounds
let bad_offset_chunk = Request::TransferChunk { let bad_offset_chunk = Request::TransferChunk {
transfer_id: Uuid::now_v7(), transfer_id: Uuid::now_v7(),
+120 -53
View File
@@ -1,57 +1,124 @@
//! Read-only audit, or explicit SQL checks on a disposable database fixture. //! Read-only audit, or explicit SQL checks on a disposable database fixture.
use coa_core::{db::{Account, Db}, migrations::{self, Store}, manifest::Manifest, realms::Mode}; use coa_core::{
db::{Account, Db},
manifest::Manifest,
migrations::{self, Store},
realms::Mode,
};
fn main() -> Result<(), Box<dyn std::error::Error>> { fn main() -> Result<(), Box<dyn std::error::Error>> {
let args: Vec<_> = std::env::args().collect(); let args: Vec<_> = std::env::args().collect();
if args.len() < 3 { return Err("usage: migration_plan <root> <signed-manifest> [--apply|--sql-only <migration-directory>]".into()); } if args.len() < 3 {
let root = std::path::Path::new(&args[1]); return Err("usage: migration_plan <root> <signed-manifest> [--apply|--sql-only <migration-directory>]".into());
let bytes = std::fs::read(&args[2])?;
let signature = std::fs::read_to_string(format!("{}.sig",args[2]))?;
coa_core::signing::verify(&bytes, &signature, coa_core::signing::EMBEDDED_PUBLIC_KEY)?;
let manifest = Manifest::parse(&bytes)?;
for (index,mode) in [Mode::Coa, Mode::Wildcard].into_iter().enumerate() {
let db = Db::from_repack(root, Account::Admin)?.for_realm(mode);
let rows = db.load_readonly()?;
let relevant: Vec<_> = rows.iter().filter(|r| r.id == "rev_20260903_01_live_class_baseline").map(|r| format!("{} {:?} {}",r.db,r.status,r.baseline)).collect();
println!("{} baseline history: {:?}",mode.name(),relevant);
let list: Vec<_> = manifest.migrations.iter().filter(|m|index==0 || m.db!="auth").cloned().collect();
let plan = migrations::status(&db,&list)?;
println!("{} pending: {:?}",mode.name(),plan.iter().filter(|m|m.status!=migrations::Status::Applied).map(|m|(&m.db,&m.id,m.status)).collect::<Vec<_>>());
}
if args.get(3).is_some_and(|s| s == "--apply" || s == "--sql-only") {
assert!(root.file_name().unwrap().to_string_lossy().starts_with("update-database-diagnosis-") && root.join(".coa-update-fixture").is_file(), "Only disposable fixture roots may be changed");
if args[3] == "--sql-only" {
let db = Db::from_repack(root, Account::Admin)?.for_realm(Mode::Coa);
let identity = || -> coa_core::Result<String> {
let mut rows = String::new();
for (schema,table,columns) in [("acore_auth","account","id,HEX(username)"),("acore_characters","characters","guid,account,HEX(name)"),("acore_characters_wildcard","characters","guid,account,HEX(name)")] {
rows.push_str(schema);
rows.push_str(&db.query(&format!("SELECT {columns} FROM {schema}.{table} ORDER BY 1;"))?);
} }
Ok(coa_core::fsx::sha256_bytes(rows.as_bytes())) let root = std::path::Path::new(&args[1]);
}; let bytes = std::fs::read(&args[2])?;
let before = identity()?; let signature = std::fs::read_to_string(format!("{}.sig", args[2]))?;
migrations::verify_files(&manifest.migrations,std::path::Path::new(&args[4]))?; coa_core::signing::verify(&bytes, &signature, coa_core::signing::EMBEDDED_PUBLIC_KEY)?;
for (index,mode) in [Mode::Coa,Mode::Wildcard].into_iter().enumerate() { let manifest = Manifest::parse(&bytes)?;
let realm_db = db.clone().for_realm(mode); for (index, mode) in [Mode::Coa, Mode::Wildcard].into_iter().enumerate() {
let list: Vec<_> = manifest.migrations.iter().filter(|m|index==0 || m.db!="auth").cloned().collect(); let db = Db::from_repack(root, Account::Admin)?.for_realm(mode);
let result = migrations::apply_pending(&realm_db,&list,std::path::Path::new(&args[4]),&||Ok("disposable fixture".into()))?; let rows = db.load_readonly()?;
println!("{} SQL result: {}",mode.name(),serde_json::to_string(&result)?); let relevant: Vec<_> = rows
if result.failed.is_some() {return Err("SQL failed; fixture preserved".into());} .iter()
} .filter(|r| r.id == "rev_20260903_01_live_class_baseline")
assert_eq!(before,identity()?,"Account or character identity changed"); .map(|r| format!("{} {:?} {}", r.db, r.status, r.baseline))
println!("Account and character identities preserved: {}",before); .collect();
let capture = root.join("captured-schema"); println!("{} baseline history: {:?}", mode.name(), relevant);
coa_core::schema_check::capture(&db,&capture)?; let list: Vec<_> = manifest
println!("Captured schema SHA256: {}",coa_core::fsx::sha256_file(&capture.join(coa_core::schema_check::CONTRACT))?); .migrations
return Ok(()); .iter()
} .filter(|m| index == 0 || m.db != "auth")
if args.len() != 5 { return Err("Migration directory required".into()); } .cloned()
use coa_core::update::{Env, RepackEnv}; .collect();
let meta = coa_core::registry::metadata_dir_for(root)?; let plan = migrations::status(&db, &list)?;
let env = RepackEnv { root, meta_dir: &meta }; println!(
let result = env.migrate(&manifest, std::path::Path::new(&args[4])); "{} pending: {:?}",
let _ = coa_core::driver::run(root, coa_core::driver::Verb::StopAll); mode.name(),
println!("Application result: {}",serde_json::to_string(&result?)?); plan.iter()
} .filter(|m| m.status != migrations::Status::Applied)
Ok(()) .map(|m| (&m.db, &m.id, m.status))
.collect::<Vec<_>>()
);
}
if args
.get(3)
.is_some_and(|s| s == "--apply" || s == "--sql-only")
{
assert!(
root.file_name()
.unwrap()
.to_string_lossy()
.starts_with("update-database-diagnosis-")
&& root.join(".coa-update-fixture").is_file(),
"Only disposable fixture roots may be changed"
);
if args[3] == "--sql-only" {
let db = Db::from_repack(root, Account::Admin)?.for_realm(Mode::Coa);
let identity = || -> coa_core::Result<String> {
let mut rows = String::new();
for (schema, table, columns) in [
("acore_auth", "account", "id,HEX(username)"),
("acore_characters", "characters", "guid,account,HEX(name)"),
(
"acore_characters_wildcard",
"characters",
"guid,account,HEX(name)",
),
] {
rows.push_str(schema);
rows.push_str(&db.query(&format!(
"SELECT {columns} FROM {schema}.{table} ORDER BY 1;"
))?);
}
Ok(coa_core::fsx::sha256_bytes(rows.as_bytes()))
};
let before = identity()?;
migrations::verify_files(&manifest.migrations, std::path::Path::new(&args[4]))?;
for (index, mode) in [Mode::Coa, Mode::Wildcard].into_iter().enumerate() {
let realm_db = db.clone().for_realm(mode);
let list: Vec<_> = manifest
.migrations
.iter()
.filter(|m| index == 0 || m.db != "auth")
.cloned()
.collect();
let result = migrations::apply_pending(
&realm_db,
&list,
std::path::Path::new(&args[4]),
&|| Ok("disposable fixture".into()),
)?;
println!(
"{} SQL result: {}",
mode.name(),
serde_json::to_string(&result)?
);
if result.failed.is_some() {
return Err("SQL failed; fixture preserved".into());
}
}
assert_eq!(before, identity()?, "Account or character identity changed");
println!("Account and character identities preserved: {}", before);
let capture = root.join("captured-schema");
coa_core::schema_check::capture(&db, &capture)?;
println!(
"Captured schema SHA256: {}",
coa_core::fsx::sha256_file(&capture.join(coa_core::schema_check::CONTRACT))?
);
return Ok(());
}
if args.len() != 5 {
return Err("Migration directory required".into());
}
use coa_core::update::{Env, RepackEnv};
let meta = coa_core::registry::metadata_dir_for(root)?;
let env = RepackEnv {
root,
meta_dir: &meta,
};
let result = env.migrate(&manifest, std::path::Path::new(&args[4]));
let _ = coa_core::driver::run(root, coa_core::driver::Verb::StopAll);
println!("Application result: {}", serde_json::to_string(&result?)?);
}
Ok(())
} }
+3 -3
View File
@@ -457,7 +457,7 @@ fn run() -> Result<(), String> {
} }
("collection-states", [out]) => { ("collection-states", [out]) => {
let states = OwnerService::new(&mut store) let states = OwnerService::new(&mut store)
.collection_states() .collection_states(coa_core::portable::Ruleset::Coa)
.map_err(|e| e.to_string())?; .map_err(|e| e.to_string())?;
for s in &states { for s in &states {
println!( println!(
@@ -618,7 +618,7 @@ fn run() -> Result<(), String> {
let set = let set =
coa_core::portable::collection::IdSet::from_ids(ids).map_err(|e| e.to_string())?; coa_core::portable::collection::IdSet::from_ids(ids).map_err(|e| e.to_string())?;
let merge = store let merge = store
.merge_collection(profile, kind, &set) .merge_collection(profile, coa_core::portable::Ruleset::Coa, kind, &set)
.map_err(|e| e.to_string())?; .map_err(|e| e.to_string())?;
println!( println!(
"{kind}: {} id(s) added{}", "{kind}: {} id(s) added{}",
@@ -633,7 +633,7 @@ fn run() -> Result<(), String> {
let profile = store.default_profile().map_err(|e| e.to_string())?; let profile = store.default_profile().map_err(|e| e.to_string())?;
for kind in coa_core::portable::session::protocol::COLLECTION_KINDS { for kind in coa_core::portable::session::protocol::COLLECTION_KINDS {
match store match store
.collection_info(profile, kind) .collection_info(profile, coa_core::portable::Ruleset::Coa, kind)
.map_err(|e| e.to_string())? .map_err(|e| e.to_string())?
{ {
Some(i) => println!( Some(i) => println!(
+60 -26
View File
@@ -1,28 +1,62 @@
//! Exercise the production updater only on a disposable copy of an installed server. //! Exercise the production updater only on a disposable copy of an installed server.
use coa_core::{registry::MetaDir, update::{self, Env, RepackEnv}}; use coa_core::{
fn main() -> Result<(),Box<dyn std::error::Error>> { registry::MetaDir,
let args:Vec<_>=std::env::args().collect(); update::{self, Env, RepackEnv},
if args.len()!=3 && args.len()!=4 {return Err("usage: upgrade_fixture <disposable-root> <signed-package-directory>".into());} };
let root=std::path::Path::new(&args[1]); fn main() -> Result<(), Box<dyn std::error::Error>> {
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-schema-fixture-real") && root.join(".coa-update-fixture").is_file(),"Disposable fixture required"); let args: Vec<_> = std::env::args().collect();
let meta=coa_core::registry::metadata_dir_for(root)?; if args.len() != 3 && args.len() != 4 {
let (_,installed)=MetaDir::open(&meta)?; return Err("usage: upgrade_fixture <disposable-root> <signed-package-directory>".into());
assert_eq!(coa_core::fsx::canonicalize_lenient(std::path::Path::new(&installed.server_path))?,coa_core::fsx::canonicalize_lenient(root)?,"Fixture metadata must point to the copy"); }
assert!(installed.client_path.is_none(),"Detach the real client from fixture metadata"); let root = std::path::Path::new(&args[1]);
let env=RepackEnv{root,meta_dir:&meta}; assert!(
if args.get(3).is_some_and(|flag|flag=="--validate-only") { root.file_name()
let result=env.validate(); .unwrap()
let _=coa_core::driver::run(root,coa_core::driver::Verb::StopAll); .to_string_lossy()
result?; .starts_with("coa-schema-fixture-real")
println!("Startup and identity validation passed"); && root.join(".coa-update-fixture").is_file(),
return Ok(()); "Disposable fixture required"
} );
let outcome=update::apply(&update::Params{root,meta_dir:&meta,source:coa_core::pkgsource::Source::Dir(args[2].clone().into()),trusted_key:coa_core::signing::EMBEDDED_PUBLIC_KEY,cancel:Default::default(),resolutions:Default::default(),env:&env,fail_after_ops:None},&|phase,percent|println!("{percent}% {phase}")); let meta = coa_core::registry::metadata_dir_for(root)?;
let stopped=coa_core::driver::run(root,coa_core::driver::Verb::StopAll); let (_, installed) = MetaDir::open(&meta)?;
println!("Shutdown after test: {:?}",stopped.map(|r|r.ok)); assert_eq!(
let outcome=outcome?; coa_core::fsx::canonicalize_lenient(std::path::Path::new(&installed.server_path))?,
println!("Final transaction: {:?}",outcome.txn.state); coa_core::fsx::canonicalize_lenient(root)?,
env.ensure_stopped()?; "Fixture metadata must point to the copy"
assert_eq!(outcome.txn.state,update::State::Committed); );
Ok(()) assert!(
installed.client_path.is_none(),
"Detach the real client from fixture metadata"
);
let env = RepackEnv {
root,
meta_dir: &meta,
};
if args.get(3).is_some_and(|flag| flag == "--validate-only") {
let result = env.validate();
let _ = coa_core::driver::run(root, coa_core::driver::Verb::StopAll);
result?;
println!("Startup and identity validation passed");
return Ok(());
}
let outcome = update::apply(
&update::Params {
root,
meta_dir: &meta,
source: coa_core::pkgsource::Source::Dir(args[2].clone().into()),
trusted_key: coa_core::signing::EMBEDDED_PUBLIC_KEY,
cancel: Default::default(),
resolutions: Default::default(),
env: &env,
fail_after_ops: None,
},
&|phase, percent| println!("{percent}% {phase}"),
);
let stopped = coa_core::driver::run(root, coa_core::driver::Verb::StopAll);
println!("Shutdown after test: {:?}", stopped.map(|r| r.ok));
let outcome = outcome?;
println!("Final transaction: {:?}", outcome.txn.state);
env.ensure_stopped()?;
assert_eq!(outcome.txn.state, update::State::Committed);
Ok(())
} }
+28 -9
View File
@@ -261,7 +261,9 @@ pub fn config_files(root: &Path) -> Vec<String> {
for e in rd.flatten() { for e in rd.flatten() {
let n = e.file_name().to_string_lossy().to_string(); let n = e.file_name().to_string_lossy().to_string();
// database.json holds generated database passwords; it is launcher state, not configuration. // database.json holds generated database passwords; it is launcher state, not configuration.
if e.path().is_file() && (n.contains(".template") || n == "repack.json" || n == "docker.json") { if e.path().is_file()
&& (n.contains(".template") || n == "repack.json" || n == "docker.json")
{
out.push(format!("Settings/{n}")); out.push(format!("Settings/{n}"));
} }
} }
@@ -381,12 +383,19 @@ pub fn create(
let build = || -> Result<Vec<Component>> { let build = || -> Result<Vec<Component>> {
let mut components = Vec::new(); let mut components = Vec::new();
let realm = crate::realms::state(root)?; let realm = crate::realms::state(root)?;
let mut databases: Vec<(String, &str)> = wanted_databases(kind).iter() let mut databases: Vec<(String, &str)> = wanted_databases(kind)
.map(|name| Ok((name.to_string(), realm.active.schema(name)?))).collect::<Result<_>>()?; .iter()
.map(|name| Ok((name.to_string(), realm.active.schema(name)?)))
.collect::<Result<_>>()?;
if kind != Kind::Config { if kind != Kind::Config {
for other in realm.modes().into_iter().filter(|m| *m != realm.active) { for other in realm.modes().into_iter().filter(|m| *m != realm.active) {
databases.push((format!("{}-characters", other.name()), other.schema("characters")?)); databases.push((
if kind == Kind::Full { databases.push((format!("{}-world", other.name()), other.schema("world")?)); } format!("{}-characters", other.name()),
other.schema("characters")?,
));
if kind == Kind::Full {
databases.push((format!("{}-world", other.name()), other.schema("world")?));
}
} }
} }
if kind != Kind::Config && with_database(root, |db| db.schema_exists("acore_playerbots"))? { if kind != Kind::Config && with_database(root, |db| db.schema_exists("acore_playerbots"))? {
@@ -427,16 +436,24 @@ pub fn create(
return Err(e); return Err(e);
} }
}; };
let mysql_snapshot = if kind == Kind::Full && matches!(trigger, Trigger::BeforeUpdate | Trigger::BeforeRepair) && cfg!(windows) && !crate::docker::is_docker(root) { let mysql_snapshot = if kind == Kind::Full
&& matches!(trigger, Trigger::BeforeUpdate | Trigger::BeforeRepair)
&& cfg!(windows)
&& !crate::docker::is_docker(root)
{
progress("Saving a complete stopped MySQL recovery copy"); progress("Saving a complete stopped MySQL recovery copy");
match crate::mysql_snapshot::capture(root, &partial) { match crate::mysql_snapshot::capture(root, &partial) {
Ok(snapshot) => Some(snapshot), Ok(snapshot) => Some(snapshot),
Err(error) => { Err(error) => {
if let Ok(owned) = fsx::ensure_within(&backups_dir(meta), &partial) { let _ = fs::remove_dir_all(owned); } if let Ok(owned) = fsx::ensure_within(&backups_dir(meta), &partial) {
let _ = fs::remove_dir_all(owned);
}
return Err(error); return Err(error);
} }
} }
} else { None }; } else {
None
};
let point = RecoveryPoint { let point = RecoveryPoint {
realm: crate::realms::state(root)?.active, realm: crate::realms::state(root)?.active,
schema: 1, schema: 1,
@@ -485,7 +502,9 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
let dir = point_dir(meta, id)?; let dir = point_dir(meta, id)?;
let mut problems = Vec::new(); let mut problems = Vec::new();
if let Some(snapshot) = &point.mysql_snapshot { if let Some(snapshot) = &point.mysql_snapshot {
if let Err(error) = crate::mysql_snapshot::verify(&dir, snapshot) { problems.push(error.to_string()); } if let Err(error) = crate::mysql_snapshot::verify(&dir, snapshot) {
problems.push(error.to_string());
}
} }
let mut names = std::collections::BTreeSet::new(); let mut names = std::collections::BTreeSet::new();
let mut schemas = std::collections::BTreeSet::new(); let mut schemas = std::collections::BTreeSet::new();
+48 -16
View File
@@ -1,7 +1,7 @@
//! Signed channel pointers select one immutable package for an entire transaction. //! Signed channel pointers select one immutable package for an entire transaction.
use serde::{Deserialize, Serialize};
use crate::{Error, Result};
use crate::pkgsource::{fetch_small, Source}; use crate::pkgsource::{fetch_small, Source};
use crate::{Error, Result};
use serde::{Deserialize, Serialize};
#[derive(Debug, Serialize, Deserialize)] #[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)] #[serde(rename_all = "camelCase", deny_unknown_fields)]
@@ -21,15 +21,22 @@ pub struct Envelope {
} }
pub fn verify(bytes: &[u8], channel: &str, key: &str) -> Result<Pointer> { pub fn verify(bytes: &[u8], channel: &str, key: &str) -> Result<Pointer> {
let envelope: Envelope = serde_json::from_slice(bytes).map_err(|e| Error::InvalidManifest(e.to_string()))?; let envelope: Envelope =
serde_json::from_slice(bytes).map_err(|e| Error::InvalidManifest(e.to_string()))?;
crate::signing::verify(envelope.payload.as_bytes(), &envelope.signature, key)?; crate::signing::verify(envelope.payload.as_bytes(), &envelope.signature, key)?;
let pointer: Pointer = serde_json::from_str(&envelope.payload).map_err(|e| Error::InvalidManifest(e.to_string()))?; let pointer: Pointer = serde_json::from_str(&envelope.payload)
if pointer.schema != 1 || pointer.channel != channel .map_err(|e| Error::InvalidManifest(e.to_string()))?;
if pointer.schema != 1
|| pointer.channel != channel
|| pointer.release_tag != format!("server-{}", pointer.version) || pointer.release_tag != format!("server-{}", pointer.version)
|| pointer.version.is_empty() || pointer.version.is_empty()
|| !pointer.version.bytes().all(|b| b.is_ascii_digit() || b == b'.') || !pointer
.version
.bytes()
.all(|b| b.is_ascii_digit() || b == b'.')
|| pointer.snapshot.len() != 64 || pointer.snapshot.len() != 64
|| !pointer.snapshot.bytes().all(|b| b.is_ascii_hexdigit()) { || !pointer.snapshot.bytes().all(|b| b.is_ascii_hexdigit())
{
return Err(Error::InvalidManifest("Invalid channel pointer".into())); return Err(Error::InvalidManifest("Invalid channel pointer".into()));
} }
Ok(pointer) Ok(pointer)
@@ -39,21 +46,37 @@ pub fn resolve(channel: &str) -> Result<Source> {
if channel != "stable" && channel != "edge" { if channel != "stable" && channel != "edge" {
return Err(Error::InvalidManifest("Unknown release channel".into())); return Err(Error::InvalidManifest("Unknown release channel".into()));
} }
let source = Source::Url("https://raw.githubusercontent.com/Corfirean/coa-server-build/channels".into()); let source =
Source::Url("https://raw.githubusercontent.com/Corfirean/coa-server-build/channels".into());
let bytes = fetch_small(&source, &format!("{channel}.json"))?; let bytes = fetch_small(&source, &format!("{channel}.json"))?;
let pointer = verify(&bytes, channel, crate::signing::EMBEDDED_PUBLIC_KEY)?; let pointer = verify(&bytes, channel, crate::signing::EMBEDDED_PUBLIC_KEY)?;
Ok(Source::Url(format!("https://github.com/Corfirean/coa-server-build/releases/download/{}", pointer.release_tag))) Ok(Source::Url(format!(
"https://github.com/Corfirean/coa-server-build/releases/download/{}",
pointer.release_tag
)))
} }
pub fn sign(pointer: &Pointer, seed: &str) -> Result<Vec<u8>> { pub fn sign(pointer: &Pointer, seed: &str) -> Result<Vec<u8>> {
use base64::{engine::general_purpose::STANDARD, Engine}; use base64::{engine::general_purpose::STANDARD, Engine};
use ed25519_dalek::{Signer, SigningKey}; use ed25519_dalek::{Signer, SigningKey};
let seed: [u8; 32] = STANDARD.decode(seed.trim()).map_err(|_| Error::Invalid("Invalid signing key".into()))? let seed: [u8; 32] = STANDARD
.try_into().map_err(|_| Error::Invalid("Invalid signing key length".into()))?; .decode(seed.trim())
.map_err(|_| Error::Invalid("Invalid signing key".into()))?
.try_into()
.map_err(|_| Error::Invalid("Invalid signing key length".into()))?;
let payload = serde_json::to_string(pointer).map_err(|e| Error::Invalid(e.to_string()))?; let payload = serde_json::to_string(pointer).map_err(|e| Error::Invalid(e.to_string()))?;
let signature = STANDARD.encode(SigningKey::from_bytes(&seed).sign(payload.as_bytes()).to_bytes()); let signature = STANDARD.encode(
let bytes = serde_json::to_vec(&Envelope { payload, signature }).map_err(|e| Error::Invalid(e.to_string()))?; SigningKey::from_bytes(&seed)
verify(&bytes, &pointer.channel, crate::signing::EMBEDDED_PUBLIC_KEY)?; .sign(payload.as_bytes())
.to_bytes(),
);
let bytes = serde_json::to_vec(&Envelope { payload, signature })
.map_err(|e| Error::Invalid(e.to_string()))?;
verify(
&bytes,
&pointer.channel,
crate::signing::EMBEDDED_PUBLIC_KEY,
)?;
Ok(bytes) Ok(bytes)
} }
@@ -67,12 +90,21 @@ mod tests {
let sk = SigningKey::from_bytes(&[17; 32]); let sk = SigningKey::from_bytes(&[17; 32]);
let payload = serde_json::to_string(pointer).unwrap(); let payload = serde_json::to_string(pointer).unwrap();
let signature = STANDARD.encode(sk.sign(payload.as_bytes()).to_bytes()); let signature = STANDARD.encode(sk.sign(payload.as_bytes()).to_bytes());
(serde_json::to_vec(&Envelope { payload, signature }).unwrap(), STANDARD.encode(sk.verifying_key().to_bytes())) (
serde_json::to_vec(&Envelope { payload, signature }).unwrap(),
STANDARD.encode(sk.verifying_key().to_bytes()),
)
} }
#[test] #[test]
fn verifies_identity_signature_and_immutable_tag() { fn verifies_identity_signature_and_immutable_tag() {
let mut p = Pointer { schema: 1, channel: "stable".into(), version: "0.261010.40".into(), release_tag: "server-0.261010.40".into(), snapshot: "a".repeat(64) }; let mut p = Pointer {
schema: 1,
channel: "stable".into(),
version: "0.261010.40".into(),
release_tag: "server-0.261010.40".into(),
snapshot: "a".repeat(64),
};
let (bytes, key) = signed(&p); let (bytes, key) = signed(&p);
assert_eq!(verify(&bytes, "stable", &key).unwrap().version, p.version); assert_eq!(verify(&bytes, "stable", &key).unwrap().version, p.version);
assert!(verify(&bytes, "edge", &key).is_err()); assert!(verify(&bytes, "edge", &key).is_err());
+61 -14
View File
@@ -417,11 +417,21 @@ pub fn launch(client: &Path) -> Result<u32> {
return crate::wine::launch(client, exe); return crate::wine::launch(client, exe);
} }
let executable = client.join(exe); let executable = client.join(exe);
let spawn = || Command::new(&executable).current_dir(client).spawn().map(|child| child.id()); let spawn = || {
Command::new(&executable)
.current_dir(client)
.spawn()
.map(|child| child.id())
};
#[cfg(windows)] #[cfg(windows)]
{ launch_with_elevation_fallback(spawn, || launch_elevated(&executable, client)).map_err(Into::into) } {
launch_with_elevation_fallback(spawn, || launch_elevated(&executable, client))
.map_err(Into::into)
}
#[cfg(not(windows))] #[cfg(not(windows))]
{ spawn().map_err(Into::into) } {
spawn().map_err(Into::into)
}
} }
/// Start normally first; ask Windows for elevation only when the client requires it (ERROR_ELEVATION_REQUIRED, 740). /// Start normally first; ask Windows for elevation only when the client requires it (ERROR_ELEVATION_REQUIRED, 740).
@@ -443,9 +453,15 @@ fn launch_elevated(executable: &Path, directory: &Path) -> std::io::Result<u32>
use std::os::windows::ffi::OsStrExt; use std::os::windows::ffi::OsStrExt;
use windows_sys::Win32::Foundation::CloseHandle; use windows_sys::Win32::Foundation::CloseHandle;
use windows_sys::Win32::System::Threading::GetProcessId; use windows_sys::Win32::System::Threading::GetProcessId;
use windows_sys::Win32::UI::Shell::{ShellExecuteExW, SHELLEXECUTEINFOW, SEE_MASK_NOCLOSEPROCESS, SEE_MASK_NOASYNC}; use windows_sys::Win32::UI::Shell::{
ShellExecuteExW, SEE_MASK_NOASYNC, SEE_MASK_NOCLOSEPROCESS, SHELLEXECUTEINFOW,
};
use windows_sys::Win32::UI::WindowsAndMessaging::SW_SHOWNORMAL; use windows_sys::Win32::UI::WindowsAndMessaging::SW_SHOWNORMAL;
let file: Vec<u16> = executable.as_os_str().encode_wide().chain(Some(0)).collect(); let file: Vec<u16> = executable
.as_os_str()
.encode_wide()
.chain(Some(0))
.collect();
let cwd: Vec<u16> = directory.as_os_str().encode_wide().chain(Some(0)).collect(); let cwd: Vec<u16> = directory.as_os_str().encode_wide().chain(Some(0)).collect();
let verb: Vec<u16> = "runas".encode_utf16().chain(Some(0)).collect(); let verb: Vec<u16> = "runas".encode_utf16().chain(Some(0)).collect();
let mut info = SHELLEXECUTEINFOW { let mut info = SHELLEXECUTEINFOW {
@@ -457,12 +473,22 @@ fn launch_elevated(executable: &Path, directory: &Path) -> std::io::Result<u32>
nShow: SW_SHOWNORMAL, nShow: SW_SHOWNORMAL,
..Default::default() ..Default::default()
}; };
if unsafe { ShellExecuteExW(&mut info) } == 0 { return Err(std::io::Error::last_os_error()); } if unsafe { ShellExecuteExW(&mut info) } == 0 {
if info.hProcess.is_null() { return Err(std::io::Error::other("Windows did not return the game process handle.")); } return Err(std::io::Error::last_os_error());
}
if info.hProcess.is_null() {
return Err(std::io::Error::other(
"Windows did not return the game process handle.",
));
}
let pid = unsafe { GetProcessId(info.hProcess) }; let pid = unsafe { GetProcessId(info.hProcess) };
let error = std::io::Error::last_os_error(); let error = std::io::Error::last_os_error();
unsafe { CloseHandle(info.hProcess); } unsafe {
if pid == 0 { return Err(error); } CloseHandle(info.hProcess);
}
if pid == 0 {
return Err(error);
}
Ok(pid) Ok(pid)
} }
@@ -585,11 +611,29 @@ mod tests {
#[cfg(windows)] #[cfg(windows)]
#[test] #[test]
fn elevation_is_requested_only_when_windows_requires_it() { fn elevation_is_requested_only_when_windows_requires_it() {
assert_eq!(launch_with_elevation_fallback(|| Ok(17), || panic!("unneeded elevation")).unwrap(), 17); assert_eq!(
assert_eq!(launch_with_elevation_fallback(|| Err(std::io::Error::from_raw_os_error(740)), || Ok(23)).unwrap(), 23); launch_with_elevation_fallback(|| Ok(17), || panic!("unneeded elevation")).unwrap(),
let error = launch_with_elevation_fallback(|| Err(std::io::Error::from_raw_os_error(2)), || panic!("wrong error elevated")).unwrap_err(); 17
);
assert_eq!(
launch_with_elevation_fallback(
|| Err(std::io::Error::from_raw_os_error(740)),
|| Ok(23)
)
.unwrap(),
23
);
let error = launch_with_elevation_fallback(
|| Err(std::io::Error::from_raw_os_error(2)),
|| panic!("wrong error elevated"),
)
.unwrap_err();
assert_eq!(error.raw_os_error(), Some(2)); assert_eq!(error.raw_os_error(), Some(2));
let cancelled = launch_with_elevation_fallback(|| Err(std::io::Error::from_raw_os_error(740)), || Err(std::io::Error::from_raw_os_error(1223))).unwrap_err(); let cancelled = launch_with_elevation_fallback(
|| Err(std::io::Error::from_raw_os_error(740)),
|| Err(std::io::Error::from_raw_os_error(1223)),
)
.unwrap_err();
assert_eq!(cancelled.raw_os_error(), Some(1223)); assert_eq!(cancelled.raw_os_error(), Some(1223));
} }
@@ -620,7 +664,10 @@ mod tests {
assert!(sync_realm(&c, &meta, crate::realms::Mode::Wildcard).unwrap()); assert!(sync_realm(&c, &meta, crate::realms::Mode::Wildcard).unwrap());
assert_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), original); assert_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), original);
assert!(sync_realm(&c, &meta, crate::realms::Mode::Reborn).unwrap()); assert!(sync_realm(&c, &meta, crate::realms::Mode::Reborn).unwrap());
assert_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), b"SET sound 1\r\nSET realmName \"Warcraft Reborn\"\r\n"); assert_eq!(
fs::read(c.join("WTF/Config.wtf")).unwrap(),
b"SET sound 1\r\nSET realmName \"Warcraft Reborn\"\r\n"
);
} }
#[test] #[test]
+1
View File
@@ -2,6 +2,7 @@
pub mod merge; pub mod merge;
pub mod parser; pub mod parser;
pub mod portable;
pub mod schema; pub mod schema;
use std::collections::{BTreeMap, BTreeSet}; use std::collections::{BTreeMap, BTreeSet};
+175
View File
@@ -0,0 +1,175 @@
//! Prepare the core side of the owner's portable-character opt-in.
use std::{fs, path::Path};
use super::{parser::ConfFile, take_snapshot, targets, Scope};
use crate::{fsx, Error, Result};
/// Configuration is changed only while the world is stopped. Disabling admission is
/// handled by the control service and must not disable an active session's core.
pub fn enable(root: &Path) -> Result<()> {
let meta = crate::registry::metadata_dir_for(root)?;
let _lock = crate::update::operation_lock_for(&meta, "configuring portable characters", false)?;
let module = root.join("Core/configs/modules/coa.conf");
let module_source = if module.is_file() {
module.clone()
} else {
root.join("Core/configs/modules/coa.conf.dist")
};
let bytes = fs::read(&module_source).map_err(|_| Error::Invalid(
"Update this server before enabling portable characters; its portable configuration is missing.".into()
))?;
let mut conf = ConfFile::parse_bytes(&bytes)?;
if conf.get("PortableSession.Enable").is_none() {
return Err(Error::Invalid("Update this server before enabling portable characters; its core configuration has no portable session support.".into()));
}
let mut writes = Vec::new();
if conf.get("PortableSession.Enable").map(str::trim) != Some("1")
|| conf.get("PortableImport.JobDir").map(str::trim) != Some("\"PortableImport\"")
|| !module.is_file()
{
conf.set(
"PortableSession.Enable",
"1",
&["Enabled by the realm owner's portable-character opt-in"],
);
conf.set(
"PortableImport.JobDir",
"\"PortableImport\"",
&["Shared working directory for the core and Manager"],
);
writes.push((
module.clone(),
module.is_file().then(|| bytes.clone()),
conf.to_text(),
));
}
for path in targets(root, Scope::Server)?.writes {
let bytes = fs::read(&path)?;
let mut conf = ConfFile::parse_bytes(&bytes)?;
if conf.get("CharacterDatabase.WorkerThreads").map(str::trim) != Some("1") {
conf.set(
"CharacterDatabase.WorkerThreads",
"1",
&["Portable sessions require ordered character database transactions"],
);
writes.push((path, Some(bytes), conf.to_text()));
}
}
if writes.is_empty() {
fs::create_dir_all(root.join("Core/PortableImport"))?;
return Ok(());
}
let observed = crate::process::observe(root, &crate::layout::read_ports(root));
if observed.world.state != crate::process::ServiceState::Stopped
|| observed.world.conflict.is_some()
|| std::net::TcpStream::connect_timeout(
&std::net::SocketAddr::from(([127, 0, 0, 1], crate::layout::read_ports(root).world)),
std::time::Duration::from_millis(100),
)
.is_ok()
|| crate::multiworld::is_running(root)
{
return Err(Error::Invalid("Stop this server, then enable portable characters and save again. The Manager must configure the core before its next start.".into()));
}
let originals = writes
.iter()
.filter_map(|(p, old, _)| old.clone().map(|bytes| (p.clone(), bytes)))
.collect::<Vec<_>>();
take_snapshot(
&meta,
Scope::Server,
"before enabling portable characters",
&originals,
)?;
for (index, (path, _, text)) in writes.iter().enumerate() {
if let Err(error) = fsx::atomic_write(path, text.as_bytes()) {
for (path, old, _) in writes.iter().take(index) {
if let Some(bytes) = old {
let _ = fsx::atomic_write(path, bytes);
} else {
let _ = fs::remove_file(path);
}
}
return Err(error);
}
}
fs::create_dir_all(root.join("Core/PortableImport"))?;
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use tempfile::tempdir;
#[test]
fn portable_opt_in_updates_the_effective_module_and_survives_launcher_rendering() {
let temp = tempdir().unwrap();
let root = temp.path().join("realm");
fs::create_dir_all(root.join("Core/configs/modules")).unwrap();
fs::create_dir_all(root.join("Settings")).unwrap();
fs::write(
root.join("Settings/repack.json"),
r#"{"worldPort":49143,"authPort":49144,"mysqlPort":49145,"raPort":49146}"#,
)
.unwrap();
fs::write(
root.join("Core/configs/modules/coa.conf"),
"# Owner setting\nCoA.Enable = 1\nPortableSession.Enable = 0\n",
)
.unwrap();
for name in [
"Settings/worldserver.conf.template",
"Core/configs/worldserver.conf",
] {
fs::write(
root.join(name),
"CharacterDatabase.WorkerThreads = 3\nMaxPlayerLevel = 80\n",
)
.unwrap();
}
enable(&root).unwrap();
assert!(root.join("Core/PortableImport").is_dir());
let module = fs::read_to_string(root.join("Core/configs/modules/coa.conf")).unwrap();
assert!(
module.contains("# Owner setting") && module.contains("PortableSession.Enable = 1")
);
for name in [
"Settings/worldserver.conf.template",
"Core/configs/worldserver.conf",
] {
let text = fs::read_to_string(root.join(name)).unwrap();
assert!(
text.contains("CharacterDatabase.WorkerThreads = 1")
&& text.contains("MaxPlayerLevel = 80")
);
}
let snapshots =
super::super::list_snapshots(&crate::registry::metadata_dir_for(&root).unwrap());
assert_eq!(snapshots.len(), 1);
enable(&root).unwrap();
assert_eq!(
super::super::list_snapshots(&crate::registry::metadata_dir_for(&root).unwrap()).len(),
1
);
let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
fs::write(
root.join("Settings/repack.json"),
format!(
r#"{{"worldPort":{}}}"#,
listener.local_addr().unwrap().port()
),
)
.unwrap();
let disabled = "PortableSession.Enable = 0\n";
fs::write(root.join("Core/configs/modules/coa.conf"), disabled).unwrap();
assert!(enable(&root)
.unwrap_err()
.to_string()
.contains("Stop this server"));
assert_eq!(
fs::read_to_string(root.join("Core/configs/modules/coa.conf")).unwrap(),
disabled
);
}
}
+10 -2
View File
@@ -61,8 +61,16 @@ pub fn lines_from_text(text: &str, filter: Option<&str>, max_lines: usize) -> Ve
let out: Vec<Line> = text let out: Vec<Line> = text
.lines() .lines()
.filter(|l| !l.trim().is_empty()) .filter(|l| !l.trim().is_empty())
.filter(|l| needle.as_ref().map(|n| l.to_lowercase().contains(n)).unwrap_or(true)) .filter(|l| {
.map(|l| Line { level: classify(l), text: crate::diag::redact(l) }) needle
.as_ref()
.map(|n| l.to_lowercase().contains(n))
.unwrap_or(true)
})
.map(|l| Line {
level: classify(l),
text: crate::diag::redact(l),
})
.collect(); .collect();
let skip = out.len().saturating_sub(max_lines); let skip = out.len().saturating_sub(max_lines);
out.into_iter().skip(skip).collect() out.into_iter().skip(skip).collect()
+902 -2
View File
@@ -63,9 +63,47 @@ impl LocalBackend {
} }
} }
fn require_portable(&self, local_id: &str) -> Result<()> {
let settings = settings::load(&self.settings_dir)?;
if settings
.realms
.get(local_id)
.is_some_and(|cfg| cfg.allow_portable)
{
Ok(())
} else {
Err(Error::Invalid(
"The realm owner has disabled portable characters.".into(),
))
}
}
fn access(&self, local_id: &str) -> Result<RealmAccess> { fn access(&self, local_id: &str) -> Result<RealmAccess> {
find_access(&self.descriptors, &(self.installs)(), local_id) let access =
.ok_or_else(|| Error::Invalid("That realm is not known to this Manager.".into())) find_access(&self.descriptors, &(self.installs)(), local_id).ok_or_else(|| {
Error::Invalid(format!(
"That realm is not known to this Manager: {local_id}"
))
})?;
if let Some((_base, rs)) = local_id.split_once(':') {
let expected_mode = match rs {
"coa" => crate::realms::Mode::Coa,
"wildcard" => crate::realms::Mode::Wildcard,
"reborn" => crate::realms::Mode::Reborn,
_ => {
return Err(Error::Invalid(format!(
"Malformed or unknown ruleset suffix in local_id: {rs}"
)))
}
};
if access.mode != Some(expected_mode) {
return Err(Error::Invalid(format!(
"Realm access mode {:?} does not match expected ruleset in local_id {local_id}",
access.mode
)));
}
}
Ok(access)
} }
fn account(&self, local_id: &str, filter: &str) -> Result<Option<AccountRow>> { fn account(&self, local_id: &str, filter: &str) -> Result<Option<AccountRow>> {
@@ -84,11 +122,73 @@ impl LocalBackend {
} }
impl RealmBackend for LocalBackend { impl RealmBackend for LocalBackend {
fn session_message(
&self,
local_id: &str,
character: Uuid,
session: Uuid,
account: u32,
) -> Result<super::service::RemoteSessionState> {
let id = local_id.to_string();
self.portable
.call(move |service| service.remote_session_message(&id, character, session, account))
.map_err(|error| unavailable("portable engine", error))?
.map_err(|error| unavailable("portable session", error))
}
fn session_ack(
&self,
local_id: &str,
character: Uuid,
session: Uuid,
account: u32,
kind: app::SessionMessageKind,
bytes: &[u8],
) -> Result<()> {
let id = local_id.to_string();
let bytes = bytes.to_vec();
self.portable
.call(move |service| {
service.apply_remote_session_ack(&id, character, session, account, kind, &bytes)
})
.map_err(|error| unavailable("portable engine", error))?
.map_err(|error| unavailable("portable session", error))
}
fn info(&self, local_id: &str) -> Result<RealmInfo> { fn info(&self, local_id: &str) -> Result<RealmInfo> {
let cfg = settings::load(&self.settings_dir)?.realms.remove(local_id); let cfg = settings::load(&self.settings_dir)?.realms.remove(local_id);
let access = self.access(local_id)?;
let db = access.db()?;
let ruleset = realm::ruleset_of(&db).map_err(|e| Error::Invalid(e.to_string()))?;
// Explicit local-id -> ruleset invariant:
// local_id ruleset == RealmAccess.mode == Db.realm() == RealmInfo.ruleset
if let Some((_base, rs)) = local_id.split_once(':') {
let expected_ruleset: crate::portable::Ruleset = rs
.parse()
.map_err(|_| Error::Invalid(format!("Unknown ruleset in local_id: {rs}")))?;
if ruleset != expected_ruleset {
return Err(Error::Invalid(format!(
"Ruleset of realm DB ({ruleset:?}) does not match local_id {local_id}"
)));
}
if access.mode.map(|m| m.name()) != Some(expected_ruleset.as_str()) {
return Err(Error::Invalid(format!(
"RealmAccess mode ({:?}) does not match local_id {local_id}",
access.mode
)));
}
if db.realm().name() != expected_ruleset.as_str() {
return Err(Error::Invalid(format!(
"Db realm ({:?}) does not match local_id {local_id}",
db.realm()
)));
}
}
Ok(RealmInfo { Ok(RealmInfo {
automatic: cfg.as_ref().is_none_or(|c| !c.existing_only), automatic: cfg.as_ref().is_none_or(|c| !c.existing_only),
route: cfg.and_then(|c| c.route), route: cfg.and_then(|c| c.route),
ruleset,
}) })
} }
@@ -203,6 +303,7 @@ impl RealmBackend for LocalBackend {
} }
fn export(&self, local_id: &str, _account_id: u32, guid: u32) -> Result<ClaimExport> { fn export(&self, local_id: &str, _account_id: u32, guid: u32) -> Result<ClaimExport> {
self.require_portable(local_id)?;
let id = local_id.to_string(); let id = local_id.to_string();
let bundle = self let bundle = self
.portable .portable
@@ -211,6 +312,7 @@ impl RealmBackend for LocalBackend {
.map_err(|e| unavailable("export", e))?; .map_err(|e| unavailable("export", e))?;
Ok(ClaimExport { Ok(ClaimExport {
character_id: bundle.character_id.as_uuid(), character_id: bundle.character_id.as_uuid(),
ruleset: bundle.ruleset,
payload: bundle.payload, payload: bundle.payload,
sha256: bundle.content_hash, sha256: bundle.content_hash,
collections: bundle.collections, collections: bundle.collections,
@@ -223,6 +325,7 @@ impl RealmBackend for LocalBackend {
character_id: Uuid, character_id: Uuid,
revision: u64, revision: u64,
) -> Result<PreflightVerdict> { ) -> Result<PreflightVerdict> {
self.require_portable(local_id)?;
let id = local_id.to_string(); let id = local_id.to_string();
let cid = crate::portable::CharacterId::from_uuid(character_id) let cid = crate::portable::CharacterId::from_uuid(character_id)
.map_err(|e| unavailable("character id", e))?; .map_err(|e| unavailable("character id", e))?;
@@ -237,10 +340,807 @@ impl RealmBackend for LocalBackend {
local_id: &str, local_id: &str,
params: RemoteImportParams, params: RemoteImportParams,
) -> Result<RemoteImportOutcome> { ) -> Result<RemoteImportOutcome> {
self.require_portable(local_id)?;
let id = local_id.to_string(); let id = local_id.to_string();
self.portable self.portable
.call(move |s| s.import_remote_character(&id, params)) .call(move |s| s.import_remote_character(&id, params))
.map_err(|e| unavailable("portable engine", e))? .map_err(|e| unavailable("portable engine", e))?
.map_err(|e| unavailable("import remote", e)) .map_err(|e| unavailable("import remote", e))
} }
fn auth_port(&self, local_id: &str) -> Result<u16> {
let access = self.access(local_id)?;
let root = access
.root
.ok_or_else(|| Error::Invalid("The realm's auth port is unresolved.".into()))?;
let settings: serde_json::Value =
crate::fsx::read_json(&root.join("Settings/repack.json"))?;
match settings.get("authPort") {
None => Ok(coa_control_proto::relay::LOCAL_AUTH_PORT),
Some(value) => value
.as_u64()
.and_then(|port| u16::try_from(port).ok())
.filter(|port| *port != 0)
.ok_or_else(|| Error::Invalid("The realm's auth port is invalid.".into())),
}
}
fn world_port(&self, local_id: &str) -> Result<u16> {
if let Ok(override_port) = std::env::var("COA_OVERRIDE_LOCAL_WORLD_PORT") {
if let Ok(p) = override_port.parse::<u16>() {
return Ok(p);
}
}
let access = self.access(local_id)?;
let mode = if let Some(m) = access.mode {
m
} else if let Some((_base, _rs)) = local_id.split_once(':') {
return Err(Error::Invalid(format!(
"Unresolved mode for ruleset suffix in {local_id}"
)));
} else {
// Legacy unsuffixed CoA realm ONLY
crate::realms::Mode::Coa
};
if let Some(ref root) = access.root {
crate::realms::world_port_for_mode(root, mode)
} else {
Err(Error::Invalid(format!(
"No server installation root for {local_id} to resolve world port"
)))
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::fs;
use tempfile::tempdir;
#[test]
fn portable_access_requires_owner_opt_in_and_revokes_immediately() {
let dir = tempdir().unwrap();
let rt =
PortableRuntime::start(&dir.path().join("portable"), Box::new(Vec::new), None).unwrap();
let backend = LocalBackend::new(Arc::new(rt), dir.path(), dir.path(), Arc::new(Vec::new));
assert!(backend.require_portable("srv-test").is_err());
let mut cfg = settings::RegistrySettings::default();
cfg.realms.insert(
"srv-test".into(),
settings::PublishConfig {
realm_id: None,
enabled: true,
display_name: "Test".into(),
description: String::new(),
language: "en".into(),
region: None,
existing_only: false,
allow_portable: true,
route: None,
},
);
settings::save(dir.path(), &cfg).unwrap();
assert!(backend.require_portable("srv-test").is_ok());
cfg.realms.get_mut("srv-test").unwrap().allow_portable = false;
settings::save(dir.path(), &cfg).unwrap();
assert!(backend
.export("srv-test", 1, 1)
.unwrap_err()
.to_string()
.contains("disabled portable"));
assert!(backend
.check_transfer("srv-test", Uuid::new_v4(), 1)
.unwrap_err()
.to_string()
.contains("disabled portable"));
}
#[test]
#[ignore = "Requires disposable A/B databases, B worldserver configuration and REGISTRY_URL"]
fn live_vps_transfer_uses_real_backend_and_preserves_the_working_copy() {
use crate::control::{
host_link::HostLink,
join::{PlayerControl, RealmTarget},
secrets::MemoryStore,
service::HostService,
store::ControlStore,
transport::coordinator_url,
};
use crate::portable::{
extension::ExtensionRegistry,
realm::{
live_import::{number, realms, reset_b},
live_projection::fixture_character,
profile::probe_capabilities,
},
session::live_session::{spec, Server},
store::Store,
};
use crate::realm_registry::{advert::advertise, client::RegistryClient};
use coa_registry_proto::{
AccountProvisioning, Listing, Population, Rates, RealmId, RegisterRequest,
REGISTRY_PROTOCOL_VERSION,
};
use std::collections::BTreeMap;
use std::sync::Mutex;
use std::time::{Duration, Instant, SystemTime, UNIX_EPOCH};
let base = std::env::var("REGISTRY_URL").expect("REGISTRY_URL");
let root = std::path::PathBuf::from(
std::env::var("COA_REAL_CONTROL_ROOT").expect("disposable root"),
);
assert!(root.starts_with("C:/games/source/candidate-evidence-20261021"));
crate::config::portable::enable(&root).expect("owner portable-character opt-in");
let databases = realms().expect("disposable databases");
reset_b(&databases.b);
let server = Server::start(spec().expect("disposable worldserver"));
struct Auth(std::process::Child);
impl Drop for Auth {
fn drop(&mut self) {
let _ = self.0.kill();
let _ = self.0.wait();
}
}
let auth_port = crate::layout::read_ports(&root).auth;
assert_eq!(
auth_port, 57637,
"Only the disposable auth port may be used"
);
assert!(std::net::TcpStream::connect(("127.0.0.1", auth_port)).is_err());
let mut command = std::process::Command::new(root.join("Core/authserver.exe"));
command
.arg("-c")
.arg(root.join("Core/configs/authserver.conf"))
.current_dir(root.join("Core"))
.stdin(std::process::Stdio::null())
.stdout(std::process::Stdio::null())
.stderr(std::process::Stdio::null());
#[cfg(windows)]
{
use std::os::windows::process::CommandExt;
command.creation_flags(0x0800_0000);
}
let mut auth = Auth(command.spawn().unwrap());
let end = Instant::now() + Duration::from_secs(30);
while std::net::TcpStream::connect(("127.0.0.1", auth_port)).is_err() {
assert!(
auth.0.try_wait().unwrap().is_none(),
"Disposable authserver exited"
);
assert!(Instant::now() < end, "Disposable authserver did not listen");
std::thread::sleep(Duration::from_millis(100));
}
let mut ra = crate::ra::Ra::connect_to(
server.spec.ra_port,
&server.spec.user,
&server.spec.password,
)
.unwrap();
let caps = probe_capabilities(
&databases.b,
Some(&root.join("Data")),
Some(&mut ra),
&ExtensionRegistry::new(),
)
.unwrap();
let advertised = advertise(&caps).unwrap();
let realm = RealmId::new();
let mut seed = [0u8; 32];
seed[..16].copy_from_slice(Uuid::new_v4().as_bytes());
seed[16..].copy_from_slice(Uuid::new_v4().as_bytes());
let key = ed25519_dalek::SigningKey::from_bytes(&seed);
let clock = || {
SystemTime::now()
.duration_since(UNIX_EPOCH)
.unwrap()
.as_secs() as i64
};
let registry = RegistryClient::new(&base).unwrap();
let listing = Listing {
display_name: "Real portable candidate gate".into(),
description: "Disposable database and real worldserver test".into(),
language: "en".into(),
region: None,
rates: Rates::default(),
modules: vec![],
account_provisioning: AccountProvisioning {
automatic: true,
existing_only: false,
},
manager_version: crate::MANAGER_VERSION.into(),
};
registry
.register(
&key,
&RegisterRequest {
protocol_version: REGISTRY_PROTOCOL_VERSION,
realm_id: realm,
public_key: coa_registry_proto::sign::encode_public_key(&key.verifying_key()),
listing_hash: listing.hash(),
listing,
capabilities_hash: advertised.advert_hash(),
capabilities: advertised,
population: Population {
players: 0,
bots: 0,
capacity: None,
},
},
clock(),
)
.unwrap();
// Always unpublish this isolated identity, including after a failed assertion.
struct Lease(RegistryClient, RealmId, ed25519_dalek::SigningKey);
impl Drop for Lease {
fn drop(&mut self) {
let ts = SystemTime::now()
.duration_since(UNIX_EPOCH)
.unwrap()
.as_secs() as i64;
let _ = self.0.unpublish(&self.2, &self.1, ts);
}
}
let _lease = Lease(registry, realm, key.clone());
let temporary = tempdir().unwrap();
let settings_dir = temporary.path().join("registry");
let local_id = "srv-live-candidate";
let mut cfg = settings::RegistrySettings::default();
cfg.realms.insert(
local_id.into(),
settings::PublishConfig {
realm_id: Some(realm),
enabled: true,
display_name: "Candidate".into(),
description: String::new(),
language: "en".into(),
region: None,
existing_only: false,
allow_portable: true,
route: None,
},
);
settings::save(&settings_dir, &cfg).unwrap();
let installed = root.clone();
let runtime = Arc::new(
PortableRuntime::start(
&temporary.path().join("portable"),
Box::new(move || vec![("live-candidate".into(), installed.clone())]),
None,
)
.unwrap(),
);
let installed = root.clone();
let backend = LocalBackend::new(
runtime.clone(),
&settings_dir,
temporary.path().join("descriptors"),
Arc::new(move || vec![("live-candidate".into(), installed.clone())]),
);
assert_eq!(
backend.info(local_id).unwrap().ruleset,
crate::portable::Ruleset::Coa
);
let service = Arc::new(HostService::new(
local_id,
realm,
Arc::new(Mutex::new(ControlStore::open_in_memory().unwrap())),
Arc::new(backend),
));
let relay = crate::control::relay_link::RelayLink::start_with_local_ports(
coordinator_url(&base, "/relay/v1/host").unwrap(),
realm,
key.clone(),
auth_port,
Some(57638),
);
service.set_relay(relay.clone());
let mut link = HostLink::start(
coordinator_url(&base, "/coord/v1/host").unwrap(),
realm,
key.clone(),
service,
Arc::new(clock),
);
let deadline = Instant::now() + Duration::from_secs(20);
while !link.status().connected && Instant::now() < deadline {
std::thread::sleep(Duration::from_millis(100));
}
assert!(link.status().connected, "{:?}", link.status());
let player_secrets = Arc::new(MemoryStore::default());
let player = Arc::new(
PlayerControl::open(&temporary.path().join("player"), player_secrets.clone()).unwrap(),
);
let target = RealmTarget {
realm_id: realm,
key: key.verifying_key(),
coordinator: coordinator_url(&base, "/coord/v1/player").unwrap(),
};
let mut channel = player.connect(&target).unwrap();
let account = player
.ensure_account(&mut channel, &realm, Some("REALPORTABLEGATE"))
.unwrap();
let until = Instant::now() + Duration::from_secs(20);
while !relay.status().connected && Instant::now() < until {
std::thread::sleep(Duration::from_millis(100));
}
assert!(relay.status().connected, "{:?}", relay.status());
let allocation = player.allocate_relay(&mut channel).unwrap();
use std::io::{Read, Write};
let mut auth_client =
std::net::TcpStream::connect((allocation.relay_host.as_str(), allocation.auth_port))
.unwrap();
auth_client
.set_read_timeout(Some(Duration::from_secs(10)))
.unwrap();
let username = account.username.to_ascii_uppercase();
let mut challenge = vec![0, 0];
challenge.extend_from_slice(&((30 + username.len()) as u16).to_le_bytes());
challenge.extend_from_slice(b"WoW\0");
challenge.extend_from_slice(&[3, 3, 5]);
challenge.extend_from_slice(&12340u16.to_le_bytes());
challenge.extend_from_slice(b"68x\0niW\0SUne");
challenge.extend_from_slice(&0u32.to_le_bytes());
challenge.extend_from_slice(&[127, 0, 0, 1]);
challenge.push(username.len() as u8);
challenge.extend_from_slice(username.as_bytes());
auth_client.write_all(&challenge).unwrap();
let mut response = [0u8; 35];
auth_client.read_exact(&mut response).unwrap();
assert_eq!(
&response[..3],
&[0, 0, 0],
"Real authserver must accept the relay challenge"
);
assert!(response[3..].iter().any(|byte| *byte != 0));
drop(auth_client);
let mut world_client =
std::net::TcpStream::connect((allocation.relay_host.as_str(), allocation.world_port))
.unwrap();
world_client
.set_read_timeout(Some(Duration::from_secs(10)))
.unwrap();
let mut response = [0u8; 44];
world_client.read_exact(&mut response).unwrap();
assert_eq!(
&response[2..4],
&[0xec, 0x01],
"Real worldserver authentication challenge must pass through relay"
);
drop(world_client);
let mut owner = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap();
let character = fixture_character(&databases, &mut owner, profile);
let mut model = owner.load_current(character).unwrap();
model.progression.level = 50;
model.progression.xp = 0;
let hidden_items = model.items.len();
let owner_path = temporary.path().join("player-portable");
let owner_runtime =
Arc::new(PortableRuntime::start(&owner_path, Box::new(Vec::new), None).unwrap());
owner_runtime
.call(move |service| {
let profile = service.owner_profile();
service
.owner_mut()
.host_install_copy(profile, &model, 1, "test-owner")
.unwrap();
})
.unwrap();
let public_realm = realm.to_string();
let (bundle, session, revision) = owner_runtime
.call(move |service| {
service.prepare_remote_transfer(&character.to_string(), &public_realm)
})
.unwrap()
.unwrap();
let transferred = player
.transfer_owned_character(
&mut channel,
session,
character.as_uuid(),
"coa",
revision,
&bundle.payload,
bundle.content_hash,
BTreeMap::new(),
)
.unwrap();
assert_eq!(transferred.session_id, session);
assert!(transferred.local_guid > 0);
assert_eq!(
number(
&databases.b,
&format!(
"SELECT level FROM acore_characters.characters WHERE guid = {}",
transferred.local_guid
)
),
50
);
let retry = player
.transfer_owned_character(
&mut channel,
session,
character.as_uuid(),
"coa",
revision,
&bundle.payload,
bundle.content_hash,
BTreeMap::new(),
)
.unwrap();
assert_eq!(
(retry.local_guid, retry.session_id),
(transferred.local_guid, transferred.session_id)
);
let pending = player.pending_remote_sessions().unwrap().pop().unwrap();
let mut console = server.ra();
console
.run(&format!("botcmd spawnbot {}", transferred.local_guid))
.unwrap();
let deadline = Instant::now() + Duration::from_secs(90);
let sid = crate::portable::SessionId::from_uuid(session).unwrap();
let mut playing = false;
while Instant::now() < deadline {
player
.sync_remote_session(&pending, &owner_runtime)
.unwrap();
let opened = owner_runtime
.call(move |service| {
service
.owner()
.owner_session_info(sid)
.unwrap()
.is_some_and(|row| row.0 == "open")
})
.unwrap();
if opened
&& crate::portable::session::live_session::online(
&databases.b,
transferred.local_guid,
)
&& console
.run(&format!("portable status {}", transferred.local_guid))
.unwrap_or_default()
.contains("gated 0")
{
playing = true;
break;
}
std::thread::sleep(Duration::from_millis(500));
}
assert!(
playing,
"The actual player never received the Owner's durable baseline acknowledgement"
);
let name =
crate::portable::session::live_session::name_of(&databases.b, transferred.local_guid);
console.run(&format!("character level {name} 51")).unwrap();
// Reopen both Player databases before receiving progress. Recovery uses the pinned realm key and durable session.
owner_runtime.shutdown();
drop(owner_runtime);
drop(player);
let owner_runtime =
Arc::new(PortableRuntime::start(&owner_path, Box::new(Vec::new), None).unwrap());
let player = Arc::new(
PlayerControl::open(&temporary.path().join("player"), player_secrets).unwrap(),
);
let pending = player.pending_remote_sessions().unwrap().pop().unwrap();
let deadline = Instant::now() + Duration::from_secs(90);
let mut saved = false;
while Instant::now() < deadline {
player
.sync_remote_session(&pending, &owner_runtime)
.unwrap();
saved = owner_runtime
.call(move |service| {
service
.owner()
.load_current(character)
.unwrap()
.progression
.level
== 51
})
.unwrap();
if saved {
break;
}
std::thread::sleep(Duration::from_millis(500));
}
assert!(saved, "Real in-game progress was not saved through the public coordinator after Manager restart");
assert!(crate::portable::session::live_session::online(
&databases.b,
transferred.local_guid
));
console
.run(&format!("botcmd despawn {}", transferred.local_guid))
.unwrap();
let deadline = Instant::now() + Duration::from_secs(90);
let mut completed = false;
while Instant::now() < deadline {
if player
.sync_remote_session(&pending, &owner_runtime)
.unwrap()
{
completed = true;
break;
}
std::thread::sleep(Duration::from_millis(500));
}
assert!(
completed,
"The final progress acknowledgement never completed"
);
let next = player.pending_remote_sessions().unwrap().pop().unwrap();
assert_ne!(
next.session_id, session,
"The next login must remain monitored"
);
assert!(owner_runtime
.call(move |service| service.remote_session_idle(next.session_id))
.unwrap()
.unwrap());
// A second login without pressing Play is still supervised and saved.
PlayerControl::start_remote_session_sync(&player, &owner_runtime);
console
.run(&format!("botcmd spawnbot {}", transferred.local_guid))
.unwrap();
let deadline = Instant::now() + Duration::from_secs(90);
let next_sid = crate::portable::SessionId::from_uuid(next.session_id).unwrap();
let mut opened = false;
while Instant::now() < deadline {
opened = owner_runtime
.call(move |service| {
service
.owner()
.owner_session_info(next_sid)
.unwrap()
.is_some_and(|row| row.0 == "open")
})
.unwrap();
if opened {
break;
}
std::thread::sleep(Duration::from_millis(500));
}
assert!(
opened
&& crate::portable::session::live_session::online(
&databases.b,
transferred.local_guid
)
);
console.run(&format!("character level {name} 52")).unwrap();
console
.run(&format!("botcmd despawn {}", transferred.local_guid))
.unwrap();
let deadline = Instant::now() + Duration::from_secs(90);
let mut completed = false;
while Instant::now() < deadline {
if player
.pending_remote_sessions()
.unwrap()
.iter()
.all(|pending| pending.session_id != next.session_id)
{
completed = true;
break;
}
std::thread::sleep(Duration::from_millis(500));
}
assert!(
completed,
"The second login's final checkpoint was not acknowledged"
);
player
.leave_idle_remote_session(character.as_uuid(), &owner_runtime)
.unwrap();
assert!(player.pending_remote_sessions().unwrap().is_empty());
owner_runtime
.call(move |service| {
assert!(service.remote_session_closed(session).unwrap());
let current = service.owner().load_current(character).unwrap();
assert_eq!(current.progression.level, 52);
assert!(
current.items.len() >= hidden_items,
"Hidden equipment was lost"
);
})
.unwrap();
owner_runtime.shutdown();
channel.close();
link.stop();
relay.stop();
runtime.shutdown();
drop(server);
}
#[test]
fn unreadable_or_unknown_realm_fails_closed_in_info() {
let dir = tempdir().unwrap();
let settings = dir.path().join("Settings");
fs::create_dir_all(&settings).unwrap();
fs::write(settings.join("registry.json"), "{}").unwrap();
let desc_dir = dir.path().join("descriptors");
fs::create_dir_all(&desc_dir).unwrap();
let portable_dir = dir.path().join("portable");
let rt = PortableRuntime::start(&portable_dir, Box::new(Vec::new), None).unwrap();
let backend = LocalBackend::new(Arc::new(rt), &settings, &desc_dir, Arc::new(Vec::new));
// Unknown realm id must return Err, never Ok(RealmInfo { ruleset: Ruleset::Coa, .. })
assert!(backend.info("srv-unknown").is_err());
assert!(backend.info("srv-unknown:wildcard").is_err());
assert!(backend.info("srv-unknown:reborn").is_err());
}
#[test]
fn world_port_for_mode_distinguishes_simultaneous_realms() {
let dir = tempdir().unwrap();
let root = dir.path().join("srv");
fs::create_dir_all(root.join("Settings")).unwrap();
fs::write(root.join("Settings/repack.json"), r#"{"worldPort": 8085}"#).unwrap();
fs::write(
root.join("Settings/realm-profile.json"),
r#"{"active": "coa", "wildcard_created": true, "simultaneous": true, "secondary_world_port": 8086}"#,
)
.unwrap();
assert_eq!(
crate::realms::world_port_for_mode(&root, crate::realms::Mode::Coa).unwrap(),
8085
);
assert_eq!(
crate::realms::world_port_for_mode(&root, crate::realms::Mode::Wildcard).unwrap(),
8086
);
let desc_dir = dir.path().join("descriptors");
let portable_dir = dir.path().join("portable");
let rt = PortableRuntime::start(&portable_dir, Box::new(Vec::new), None).unwrap();
let root_clone = root.clone();
let backend = LocalBackend::new(
Arc::new(rt),
root.join("Settings"),
&desc_dir,
Arc::new(move || vec![("test1".to_string(), root_clone.clone())]),
);
assert_eq!(backend.auth_port("srv-test1:coa").unwrap(), 3724);
fs::write(
root.join("Settings/repack.json"),
r#"{"worldPort":8085,"authPort":57324}"#,
)
.unwrap();
assert_eq!(backend.auth_port("srv-test1:coa").unwrap(), 57324);
assert_eq!(backend.auth_port("srv-test1:wildcard").unwrap(), 57324);
fs::write(
root.join("Settings/repack.json"),
r#"{"worldPort":8085,"authPort":0}"#,
)
.unwrap();
assert!(backend.auth_port("srv-test1:coa").is_err());
fs::write(
root.join("Settings/repack.json"),
r#"{"worldPort":8085,"authPort":57324}"#,
)
.unwrap();
assert_eq!(backend.world_port("srv-test1:coa").unwrap(), 8085);
assert_eq!(backend.world_port("srv-test1:wildcard").unwrap(), 8086);
// When simultaneous is false and active is CoA:
fs::write(
root.join("Settings/realm-profile.json"),
r#"{"active": "coa", "wildcard_created": true, "simultaneous": false}"#,
)
.unwrap();
// CoA succeeds with 8085
assert_eq!(backend.world_port("srv-test1:coa").unwrap(), 8085);
// Wildcard must FAIL CLOSED, never return 8085
let err_wc_mode =
crate::realms::world_port_for_mode(&root, crate::realms::Mode::Wildcard).unwrap_err();
assert!(
err_wc_mode.to_string().contains("not active"),
"Expected not active error, got: {err_wc_mode}"
);
assert!(backend.world_port("srv-test1:wildcard").is_err());
// Reborn must FAIL CLOSED
let err_reb_mode =
crate::realms::world_port_for_mode(&root, crate::realms::Mode::Reborn).unwrap_err();
assert!(
err_reb_mode.to_string().contains("not active"),
"Expected not active error, got: {err_reb_mode}"
);
assert!(backend.world_port("srv-test1:reborn").is_err());
// When active is Reborn:
fs::write(
root.join("Settings/realm-profile.json"),
r#"{"active": "reborn", "wildcard_created": true, "reborn_created": true, "simultaneous": false}"#,
)
.unwrap();
// Reborn succeeds with primary world port 8085
assert_eq!(backend.world_port("srv-test1:reborn").unwrap(), 8085);
// CoA must FAIL CLOSED when Reborn is active
assert!(backend.world_port("srv-test1:coa").is_err());
// Wildcard must FAIL CLOSED when Reborn is active
assert!(backend.world_port("srv-test1:wildcard").is_err());
// Malformed and unknown suffixes must fail closed
assert!(backend.access("srv-test1:unknown").is_err());
assert!(backend.access("srv-test1:garbage").is_err());
assert!(backend.access("srv-test1:coa:extra").is_err());
assert!(backend.world_port("srv-test1:unknown").is_err());
assert!(backend.world_port("srv-test1:garbage").is_err());
}
#[test]
fn world_port_lookup_failure_causes_direct_and_relay_to_fail_closed() {
let dir = tempdir().unwrap();
let root = dir.path().join("srv");
fs::create_dir_all(root.join("Settings")).unwrap();
fs::write(root.join("Settings/repack.json"), r#"{"worldPort": 8085}"#).unwrap();
// Server only has active CoA, simultaneous is off
fs::write(
root.join("Settings/realm-profile.json"),
r#"{"active": "coa", "wildcard_created": false, "simultaneous": false}"#,
)
.unwrap();
let desc_dir = dir.path().join("descriptors");
let portable_dir = dir.path().join("portable");
let rt = PortableRuntime::start(&portable_dir, Box::new(Vec::new), None).unwrap();
let root_clone = root.clone();
let backend = Arc::new(LocalBackend::new(
Arc::new(rt),
root.join("Settings"),
&desc_dir,
Arc::new(move || vec![("test1".to_string(), root_clone.clone())]),
));
let store = Arc::new(std::sync::Mutex::new(
crate::control::store::ControlStore::open_in_memory().unwrap(),
));
let service = Arc::new(crate::control::service::HostService::new(
"srv-test1:wildcard",
coa_registry_proto::sign::RealmId::new(),
store,
backend,
));
// 1. HostService::local_world_port fails closed
assert!(service.local_world_port().is_err());
// 2. Direct route manager cannot find a direct route because world port resolution failed
let mut direct_mgr =
crate::control::direct_route::DirectRouteManager::start(None, service.clone());
assert!(!direct_mgr.is_direct_ready());
assert!(service.direct_route().is_none());
direct_mgr.shutdown();
// 3. When relay link has no world port resolved, AllocateRelay refuses
let mut session = crate::control::service::Session::default();
let player = uuid::Uuid::now_v7();
let resp = service.handle(
&mut session,
&player,
"KEY",
coa_control_proto::app::Request::AllocateRelay { player_id: player },
);
assert!(matches!(
resp,
coa_control_proto::app::Response::Error {
code: coa_control_proto::app::AppError::NoAccount
| coa_control_proto::app::AppError::RelayUnavailable,
..
}
));
}
} }
+171 -47
View File
@@ -33,8 +33,13 @@ impl DirectIngress {
local_auth_port: u16, local_auth_port: u16,
local_world_port: u16, local_world_port: u16,
) -> Result<Self> { ) -> Result<Self> {
let auth_host = if auth_bind_port == 0 {
"127.0.0.1"
} else {
"0.0.0.0"
};
let auth_listener = let auth_listener =
TcpListener::bind(format!("0.0.0.0:{auth_bind_port}")).map_err(|e| { TcpListener::bind(format!("{auth_host}:{auth_bind_port}")).map_err(|e| {
Error::Invalid(format!( Error::Invalid(format!(
"Cannot bind direct auth listener on port {auth_bind_port}: {e}" "Cannot bind direct auth listener on port {auth_bind_port}: {e}"
)) ))
@@ -47,8 +52,13 @@ impl DirectIngress {
.map_err(|e| Error::Invalid(e.to_string()))? .map_err(|e| Error::Invalid(e.to_string()))?
.port(); .port();
let world_host = if world_bind_port == 0 {
"127.0.0.1"
} else {
"0.0.0.0"
};
let world_listener = let world_listener =
TcpListener::bind(format!("0.0.0.0:{world_bind_port}")).map_err(|e| { TcpListener::bind(format!("{world_host}:{world_bind_port}")).map_err(|e| {
Error::Invalid(format!( Error::Invalid(format!(
"Cannot bind direct world listener on port {world_bind_port}: {e}" "Cannot bind direct world listener on port {world_bind_port}: {e}"
)) ))
@@ -114,7 +124,11 @@ impl DirectIngress {
std::thread::Builder::new() std::thread::Builder::new()
.name("direct-world-worker".into()) .name("direct-world-worker".into())
.spawn(move || { .spawn(move || {
let _ = handle_world_client(client_stream, local_world_port); if let Err(e) =
handle_world_client(client_stream, local_world_port)
{
eprintln!("handle_world_client error: {e}");
}
}) })
.ok(); .ok();
} }
@@ -174,8 +188,21 @@ fn handle_auth_client(
local_auth_port: u16, local_auth_port: u16,
world_target: Arc<std::sync::RwLock<String>>, world_target: Arc<std::sync::RwLock<String>>,
) -> Result<()> { ) -> Result<()> {
let mut server = TcpStream::connect(format!("127.0.0.1:{local_auth_port}")) let mut server = None;
.map_err(|e| Error::Invalid(format!("Cannot connect to local authserver: {e}")))?; for _ in 0..5 {
match TcpStream::connect(format!("127.0.0.1:{local_auth_port}")) {
Ok(s) => {
server = Some(s);
break;
}
Err(_) => std::thread::sleep(Duration::from_millis(20)),
}
}
let mut server = server.ok_or_else(|| {
Error::Invalid(format!(
"Cannot connect to local authserver: {local_auth_port}"
))
})?;
let _ = client.set_read_timeout(Some(Duration::from_millis(500))); let _ = client.set_read_timeout(Some(Duration::from_millis(500)));
let _ = server.set_read_timeout(Some(Duration::from_millis(500))); let _ = server.set_read_timeout(Some(Duration::from_millis(500)));
@@ -213,7 +240,7 @@ fn handle_auth_client(
} }
done_c.store(true, Ordering::Relaxed); done_c.store(true, Ordering::Relaxed);
if let Some(s) = server_shutdown { if let Some(s) = server_shutdown {
let _ = s.shutdown(std::net::Shutdown::Both); let _ = s.shutdown(std::net::Shutdown::Write);
} }
}); });
@@ -261,8 +288,21 @@ fn handle_auth_client(
} }
fn handle_world_client(mut client: TcpStream, local_world_port: u16) -> Result<()> { fn handle_world_client(mut client: TcpStream, local_world_port: u16) -> Result<()> {
let mut server = TcpStream::connect(format!("127.0.0.1:{local_world_port}")) let mut server = None;
.map_err(|e| Error::Invalid(format!("Cannot connect to local worldserver: {e}")))?; for _ in 0..5 {
match TcpStream::connect(format!("127.0.0.1:{local_world_port}")) {
Ok(s) => {
server = Some(s);
break;
}
Err(_) => std::thread::sleep(Duration::from_millis(20)),
}
}
let mut server = server.ok_or_else(|| {
Error::Invalid(format!(
"Cannot connect to local worldserver: {local_world_port}"
))
})?;
let _ = client.set_nonblocking(false); let _ = client.set_nonblocking(false);
let _ = server.set_nonblocking(false); let _ = server.set_nonblocking(false);
@@ -278,11 +318,11 @@ fn handle_world_client(mut client: TcpStream, local_world_port: u16) -> Result<(
let t_c2s = std::thread::spawn(move || { let t_c2s = std::thread::spawn(move || {
let _ = std::io::copy(&mut client_read, &mut server_write); let _ = std::io::copy(&mut client_read, &mut server_write);
let _ = server_write.shutdown(std::net::Shutdown::Both); let _ = server_write.shutdown(std::net::Shutdown::Write);
}); });
let _ = std::io::copy(&mut server, &mut client); let _ = std::io::copy(&mut server, &mut client);
let _ = client.shutdown(std::net::Shutdown::Both); let _ = client.shutdown(std::net::Shutdown::Write);
let _ = t_c2s.join(); let _ = t_c2s.join();
Ok(()) Ok(())
@@ -320,6 +360,7 @@ mod tests {
let n = stream.read(&mut buf).unwrap(); let n = stream.read(&mut buf).unwrap();
assert_eq!(&buf[..n], b"WORLD_PING"); assert_eq!(&buf[..n], b"WORLD_PING");
stream.write_all(b"WORLD_PONG").unwrap(); stream.write_all(b"WORLD_PONG").unwrap();
stream.flush().unwrap();
let _ = stream.shutdown(std::net::Shutdown::Write); let _ = stream.shutdown(std::net::Shutdown::Write);
}); });
@@ -337,25 +378,27 @@ mod tests {
let mut buf = [0u8; 16]; let mut buf = [0u8; 16];
let _ = stream.read(&mut buf).unwrap(); let _ = stream.read(&mut buf).unwrap();
let mut fake_realm_list = vec![ let name_bytes = b"RealmOne\0";
0x10, // Opcode CMD_REALM_LIST let addr_bytes = b"127.0.0.1:8085\0";
0x00, 0x00, // Size placeholder let body_len = 4 + 2 + 3 + name_bytes.len() + addr_bytes.len() + 4 + 1 + 1 + 1 + 2;
0x00, 0x00, 0x00, 0x00, // Unused
0x01, 0x00, // Realm count: 1
0x01, 0x00, 0x00, 0x00, // Icon
0x00, // Lock
0x00, // Flags
];
fake_realm_list.extend_from_slice(b"RealmOne\0");
fake_realm_list.extend_from_slice(b"127.0.0.1:8085\0"); // original target
fake_realm_list.extend_from_slice(&[0x00, 0x00, 0x00, 0x00]); // Population
fake_realm_list.extend_from_slice(&[0x01]); // Num characters
fake_realm_list.extend_from_slice(&[0x01]); // Timezone
fake_realm_list.extend_from_slice(&[0x00]); // Realm ID
fake_realm_list.extend_from_slice(&[0x02, 0x00]); // Footer
let body_len = (fake_realm_list.len() - 3) as u16; let mut fake_realm_list = Vec::new();
fake_realm_list[1..3].copy_from_slice(&body_len.to_le_bytes()); fake_realm_list.push(0x10); // Opcode
fake_realm_list.extend_from_slice(&(body_len as u16).to_le_bytes()); // Length
fake_realm_list.extend_from_slice(&0u32.to_le_bytes()); // Unused
fake_realm_list.extend_from_slice(&1u16.to_le_bytes()); // Realm count = 1
// Realm info:
fake_realm_list.extend_from_slice(&[1, 0, 0]); // type, lock, flag
fake_realm_list.extend_from_slice(name_bytes);
fake_realm_list.extend_from_slice(addr_bytes);
fake_realm_list.extend_from_slice(&[0, 0, 0, 0]); // pop
fake_realm_list.extend_from_slice(&[0]); // chars
fake_realm_list.extend_from_slice(&[1]); // timezone
fake_realm_list.extend_from_slice(&[1]); // realm id
// Footer:
fake_realm_list.extend_from_slice(&[0x10, 0x00]);
stream.write_all(&fake_realm_list).unwrap(); stream.write_all(&fake_realm_list).unwrap();
let _ = stream.shutdown(std::net::Shutdown::Write); let _ = stream.shutdown(std::net::Shutdown::Write);
@@ -386,7 +429,7 @@ mod tests {
let mock_world_port = mock_world.local_addr().unwrap().port(); let mock_world_port = mock_world.local_addr().unwrap().port();
// DirectIngress binds to ephemeral ports (0, 0), so actual ingress port != 8085 // DirectIngress binds to ephemeral ports (0, 0), so actual ingress port != 8085
let ingress = DirectIngress::start( let mut ingress = DirectIngress::start(
0, 0,
0, 0,
"198.51.100.1".to_string(), "198.51.100.1".to_string(),
@@ -415,25 +458,27 @@ mod tests {
let mut buf = [0u8; 16]; let mut buf = [0u8; 16];
let _ = stream.read(&mut buf).unwrap(); let _ = stream.read(&mut buf).unwrap();
let mut fake_realm_list = vec![ let name_bytes = b"RealmOne\0";
0x10, // Opcode CMD_REALM_LIST let addr_bytes = b"127.0.0.1:8085\0";
0x00, 0x00, // Size placeholder let body_len = 4 + 2 + 3 + name_bytes.len() + addr_bytes.len() + 4 + 1 + 1 + 1 + 2;
0x00, 0x00, 0x00, 0x00, // Unused
0x01, 0x00, // Realm count: 1
0x01, 0x00, 0x00, 0x00, // Icon
0x00, // Lock
0x00, // Flags
];
fake_realm_list.extend_from_slice(b"RealmOne\0");
fake_realm_list.extend_from_slice(b"127.0.0.1:8085\0");
fake_realm_list.extend_from_slice(&[0x00, 0x00, 0x00, 0x00]);
fake_realm_list.extend_from_slice(&[0x01]);
fake_realm_list.extend_from_slice(&[0x01]);
fake_realm_list.extend_from_slice(&[0x00]);
fake_realm_list.extend_from_slice(&[0x02, 0x00]);
let body_len = (fake_realm_list.len() - 3) as u16; let mut fake_realm_list = Vec::new();
fake_realm_list[1..3].copy_from_slice(&body_len.to_le_bytes()); fake_realm_list.push(0x10); // Opcode
fake_realm_list.extend_from_slice(&(body_len as u16).to_le_bytes()); // Length
fake_realm_list.extend_from_slice(&0u32.to_le_bytes()); // Unused
fake_realm_list.extend_from_slice(&1u16.to_le_bytes()); // Realm count = 1
// Realm info:
fake_realm_list.extend_from_slice(&[1, 0, 0]); // type, lock, flag
fake_realm_list.extend_from_slice(name_bytes);
fake_realm_list.extend_from_slice(addr_bytes);
fake_realm_list.extend_from_slice(&[0, 0, 0, 0]); // pop
fake_realm_list.extend_from_slice(&[0]); // chars
fake_realm_list.extend_from_slice(&[1]); // timezone
fake_realm_list.extend_from_slice(&[1]); // realm id
// Footer:
fake_realm_list.extend_from_slice(&[0x10, 0x00]);
stream.write_all(&fake_realm_list).unwrap(); stream.write_all(&fake_realm_list).unwrap();
let _ = stream.shutdown(std::net::Shutdown::Write); let _ = stream.shutdown(std::net::Shutdown::Write);
@@ -462,5 +507,84 @@ mod tests {
drop(client_auth); drop(client_auth);
t_auth.join().unwrap(); t_auth.join().unwrap();
ingress.stop();
}
#[test]
fn test_direct_ingress_wildcard_port_rewrites_to_mapped_port_and_never_advertises_coa_8085() {
let ext_wildcard_port = 48086;
let mock_auth = TcpListener::bind("127.0.0.1:0").unwrap();
let mock_auth_port = mock_auth.local_addr().unwrap().port();
let mock_world = TcpListener::bind("127.0.0.1:0").unwrap();
let mock_world_port = mock_world.local_addr().unwrap().port();
// DirectIngress configured for Wildcard (local_world = mock_world_port, ext_world = 48086)
let mut ingress = DirectIngress::start(
0,
0,
"198.51.100.1".to_string(),
ext_wildcard_port,
mock_auth_port,
mock_world_port,
)
.unwrap();
// Verify Auth rewrite rewrites to external port 48086 and never mentions 8085 or 8086
let t_auth = std::thread::spawn(move || {
let (mut stream, _) = mock_auth.accept().unwrap();
let mut buf = [0u8; 16];
let _ = stream.read(&mut buf).unwrap();
let name_bytes = b"Wildcard\0";
let addr_bytes = b"127.0.0.1:8086\0";
let body_len = 4 + 2 + 3 + name_bytes.len() + addr_bytes.len() + 4 + 1 + 1 + 1 + 2;
let mut fake_realm_list = Vec::new();
fake_realm_list.push(0x10); // Opcode
fake_realm_list.extend_from_slice(&(body_len as u16).to_le_bytes()); // Length
fake_realm_list.extend_from_slice(&0u32.to_le_bytes()); // Unused
fake_realm_list.extend_from_slice(&1u16.to_le_bytes()); // Realm count = 1
// Realm info:
fake_realm_list.extend_from_slice(&[1, 0, 0]); // type, lock, flag
fake_realm_list.extend_from_slice(name_bytes);
fake_realm_list.extend_from_slice(addr_bytes);
fake_realm_list.extend_from_slice(&[0, 0, 0, 0]); // pop
fake_realm_list.extend_from_slice(&[0]); // chars
fake_realm_list.extend_from_slice(&[1]); // timezone
fake_realm_list.extend_from_slice(&[1]); // realm id
// Footer:
fake_realm_list.extend_from_slice(&[0x10, 0x00]);
stream.write_all(&fake_realm_list).unwrap();
let _ = stream.shutdown(std::net::Shutdown::Write);
});
let mut client_auth =
TcpStream::connect(format!("127.0.0.1:{}", ingress.auth_port())).unwrap();
client_auth.write_all(b"AUTH_HELLO").unwrap();
let mut auth_buf = [0u8; 512];
let an = client_auth.read(&mut auth_buf).unwrap();
let payload = String::from_utf8_lossy(&auth_buf[..an]);
assert!(
payload.contains("198.51.100.1:48086"),
"Expected rewritten realm list to contain external port 48086, got: {payload}"
);
assert!(
!payload.contains("8085"),
"DirectIngress for Wildcard must never advertise CoA port 8085"
);
assert!(
!payload.contains(":8086"),
"DirectIngress for Wildcard must rewrite internal port 8086 to external 48086"
);
drop(client_auth);
t_auth.join().unwrap();
ingress.stop();
} }
} }
+33 -4
View File
@@ -303,11 +303,40 @@ fn attempt_route_discovery(
let local_auth = std::env::var("COA_OVERRIDE_LOCAL_AUTH_PORT") let local_auth = std::env::var("COA_OVERRIDE_LOCAL_AUTH_PORT")
.ok() .ok()
.and_then(|p| p.parse().ok()) .and_then(|p| p.parse().ok())
.unwrap_or(coa_control_proto::relay::LOCAL_AUTH_PORT); .map(Ok)
let local_world = std::env::var("COA_OVERRIDE_LOCAL_WORLD_PORT") .unwrap_or_else(|| service.local_auth_port());
let local_auth = match local_auth {
Ok(port) => port,
Err(error) => {
set_status(
status,
RouteStatus::RelayOnly {
reason: format!("Cannot resolve local auth port: {error}"),
},
);
service.set_direct_route(None);
return;
}
};
let local_world = match std::env::var("COA_OVERRIDE_LOCAL_WORLD_PORT")
.ok() .ok()
.and_then(|p| p.parse().ok()) .and_then(|p| p.parse().ok())
.unwrap_or(coa_control_proto::relay::LOCAL_WORLD_PORT); {
Some(p) => p,
None => match service.local_world_port() {
Ok(p) => p,
Err(e) => {
set_status(
status,
RouteStatus::RelayOnly {
reason: format!("Cannot resolve local world port: {e}"),
},
);
service.set_direct_route(None);
return;
}
},
};
let desired_auth_port: u16 = std::env::var("COA_DIRECT_AUTH_PORT") let desired_auth_port: u16 = std::env::var("COA_DIRECT_AUTH_PORT")
.ok() .ok()
@@ -316,7 +345,7 @@ fn attempt_route_discovery(
let desired_world_port: u16 = std::env::var("COA_DIRECT_WORLD_PORT") let desired_world_port: u16 = std::env::var("COA_DIRECT_WORLD_PORT")
.ok() .ok()
.and_then(|p| p.parse().ok()) .and_then(|p| p.parse().ok())
.unwrap_or(8085); .unwrap_or(local_world);
let ingress = match DirectIngress::start( let ingress = match DirectIngress::start(
desired_auth_port, desired_auth_port,
+1 -1
View File
@@ -159,7 +159,7 @@ fn session(
) -> Result<(), LinkError> { ) -> Result<(), LinkError> {
let mut ws = transport::connect(url, POLL)?; let mut ws = transport::connect(url, POLL)?;
let nonce = match transport::next_frame(&mut ws, Duration::from_secs(15))? { let nonce = match transport::next_frame(&mut ws, Duration::from_secs(15))? {
Frame::Challenge { nonce, .. } => nonce, Frame::Challenge { protocol, nonce } if protocol == coord::COORDINATOR_PROTOCOL_VERSION => nonce,
_ => return Err(LinkError::Protocol("a challenge was expected".into())), _ => return Err(LinkError::Protocol("a challenge was expected".into())),
}; };
transport::send_text( transport::send_text(
+28 -13
View File
@@ -24,6 +24,7 @@ pub struct HostControlRealm {
pub local_id: String, pub local_id: String,
pub realm_id: String, pub realm_id: String,
pub link: LinkStatus, pub link: LinkStatus,
pub relay: Option<crate::control::relay_link::RelayStatus>,
} }
pub struct HostControl { pub struct HostControl {
@@ -35,6 +36,7 @@ pub struct HostControl {
struct Running { struct Running {
realm_id: RealmId, realm_id: RealmId,
url: String, url: String,
ports: Option<(u16, u16)>,
link: HostLink, link: HostLink,
#[allow(dead_code)] #[allow(dead_code)]
relay_link: Option<Arc<crate::control::relay_link::RelayLink>>, relay_link: Option<Arc<crate::control::relay_link::RelayLink>>,
@@ -83,7 +85,7 @@ impl HostControl {
running.retain(|id, r| { running.retain(|id, r| {
wanted wanted
.get(id) .get(id)
.is_some_and(|(realm, url, _, _)| *realm == r.realm_id && *url == r.url) .is_some_and(|(realm, url, _, _)| *realm == r.realm_id && *url == r.url && backend.auth_port(id).ok().zip(backend.world_port(id).ok()) == r.ports)
}); });
for (local_id, (realm_id, url, base, key)) in wanted { for (local_id, (realm_id, url, base, key)) in wanted {
if running.contains_key(&local_id) { if running.contains_key(&local_id) {
@@ -95,18 +97,29 @@ impl HostControl {
store.clone(), store.clone(),
backend.clone(), backend.clone(),
)); ));
let relay_link = let ports = service.local_auth_port().ok().zip(service.local_world_port().ok());
crate::control::transport::relay_url(&base, "/relay/v1/host").map( let relay_link = match ports {
|r_url| { Some((auth_port, world_port)) => {
let rl = crate::control::relay_link::RelayLink::start( crate::control::transport::relay_url(&base, "/relay/v1/host").map(
r_url, |r_url| {
realm_id, let rl =
key.clone(), crate::control::relay_link::RelayLink::start_with_local_ports(
); r_url,
service.set_relay(rl.clone()); realm_id,
rl key.clone(),
}, auth_port,
); Some(world_port),
);
service.set_relay(rl.clone());
rl
},
)
}
None => {
tracing::warn!(%local_id, "relay is waiting for valid local auth and world ports");
None
}
};
let direct_route = let direct_route =
Some(crate::control::direct_route::DirectRouteManager::start( Some(crate::control::direct_route::DirectRouteManager::start(
Some(base.clone()), Some(base.clone()),
@@ -119,6 +132,7 @@ impl HostControl {
Running { Running {
realm_id, realm_id,
url, url,
ports,
link, link,
relay_link, relay_link,
direct_route, direct_route,
@@ -135,6 +149,7 @@ impl HostControl {
local_id: id.clone(), local_id: id.clone(),
realm_id: r.realm_id.to_string(), realm_id: r.realm_id.to_string(),
link: r.link.status(), link: r.link.status(),
relay: r.relay_link.as_ref().map(|relay| relay.status()),
}, },
) )
}) })
+46 -12
View File
@@ -20,6 +20,8 @@ use super::store::{AccountKind, ControlStore};
use super::transport::{self, LinkError}; use super::transport::{self, LinkError};
use crate::{Error, Result}; use crate::{Error, Result};
mod portable_sync;
/// Where and as whom to reach a realm. /// Where and as whom to reach a realm.
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub struct RealmTarget { pub struct RealmTarget {
@@ -115,6 +117,7 @@ pub struct AccountOutcome {
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct Claimed { pub struct Claimed {
pub character_id: Uuid, pub character_id: Uuid,
pub ruleset: String,
pub payload: Vec<u8>, pub payload: Vec<u8>,
pub sha256: [u8; 32], pub sha256: [u8; 32],
pub collections: BTreeMap<String, Vec<u32>>, pub collections: BTreeMap<String, Vec<u32>>,
@@ -347,13 +350,14 @@ impl PlayerControl {
pub fn claim(&self, ch: &mut PlayerChannel, token: u32) -> R<Claimed> { pub fn claim(&self, ch: &mut PlayerChannel, token: u32) -> R<Claimed> {
let r = ch.request(&Request::Claim { token })?; let r = ch.request(&Request::Claim { token })?;
let (character_id, sha256, payload, collections) = expect(r, |r| match r { let (character_id, ruleset, sha256, payload, collections) = expect(r, |r| match r {
Response::Claimed { Response::Claimed {
character_id, character_id,
ruleset,
sha256, sha256,
payload, payload,
collections, collections,
} => Ok((character_id, sha256, payload, collections)), } => Ok((character_id, ruleset, sha256, payload, collections)),
other => Err(other), other => Err(other),
})?; })?;
let payload = base64::engine::general_purpose::STANDARD let payload = base64::engine::general_purpose::STANDARD
@@ -373,6 +377,7 @@ impl PlayerControl {
})?; })?;
Ok(Claimed { Ok(Claimed {
character_id, character_id,
ruleset,
payload, payload,
sha256: hash, sha256: hash,
collections, collections,
@@ -409,24 +414,39 @@ impl PlayerControl {
} }
/// Transfer a portable character to a remote realm over the verified control channel (Phase 12.1). /// Transfer a portable character to a remote realm over the verified control channel (Phase 12.1).
pub fn transfer_character( fn transfer_with_id(
&self, &self,
ch: &mut PlayerChannel, ch: &mut PlayerChannel,
transfer_id: Uuid,
owned_session: bool,
character_id: Uuid, character_id: Uuid,
ruleset: &str,
canonical_revision: u64, canonical_revision: u64,
payload: &[u8], payload: &[u8],
content_hash: [u8; 32], content_hash: [u8; 32],
collections: BTreeMap<String, Vec<u32>>, collections: BTreeMap<String, Vec<u32>>,
) -> R<RemoteTransferOutcome> { ) -> R<RemoteTransferOutcome> {
let transfer_id = Uuid::now_v7();
let content_hash_str = hex::encode(content_hash); let content_hash_str = hex::encode(content_hash);
let offer = Request::TransferOffer { let offer = if owned_session {
transfer_id, Request::OwnedTransferOffer {
character_id, transfer_id,
canonical_revision, character_id,
content_hash: content_hash_str.clone(), ruleset: ruleset.to_string(),
total_size: payload.len(), canonical_revision,
collections, content_hash: content_hash_str.clone(),
total_size: payload.len(),
collections,
}
} else {
Request::TransferOffer {
transfer_id,
character_id,
ruleset: ruleset.to_string(),
canonical_revision,
content_hash: content_hash_str.clone(),
total_size: payload.len(),
collections,
}
}; };
let r = ch.request(&offer)?; let r = ch.request(&offer)?;
let mut offset = match r { let mut offset = match r {
@@ -451,7 +471,21 @@ impl PlayerControl {
notes, notes,
}); });
} }
Response::Error { code, message } => return Err(ControlFail::App { code, message }), Response::Error { code, message } => {
if owned_session
&& matches!(
code,
AppError::Incompatible
| AppError::NotYours
| AppError::AlreadyClaimed
| AppError::Invalid
)
{
self.store()?
.player_remote_session_remove(character_id, transfer_id)?;
}
return Err(ControlFail::App { code, message });
}
_ => { _ => {
return Err(ControlFail::Link(LinkError::Protocol( return Err(ControlFail::Link(LinkError::Protocol(
"unexpected response to transfer offer".into(), "unexpected response to transfer offer".into(),
@@ -0,0 +1,290 @@
use super::*;
use crate::control::store::PlayerRemoteSession;
use crate::portable::service::PortableRuntime;
use base64::engine::general_purpose::STANDARD as B64;
use sha2::{Digest, Sha256};
fn protocol_error(message: &str) -> ControlFail {
ControlFail::Link(LinkError::Protocol(message.into()))
}
impl PlayerControl {
/// Compatibility helper for transport tests. Interactive play uses the Owner's durable session id.
pub fn transfer_character(
&self,
channel: &mut PlayerChannel,
character: Uuid,
ruleset: &str,
revision: u64,
payload: &[u8],
hash: [u8; 32],
collections: BTreeMap<String, Vec<u32>>,
) -> R<RemoteTransferOutcome> {
self.transfer_with_id(
channel,
Uuid::now_v7(),
false,
character,
ruleset,
revision,
payload,
hash,
collections,
)
}
pub fn transfer_owned_character(
&self,
channel: &mut PlayerChannel,
session: Uuid,
character: Uuid,
ruleset: &str,
revision: u64,
payload: &[u8],
hash: [u8; 32],
collections: BTreeMap<String, Vec<u32>>,
) -> R<RemoteTransferOutcome> {
self.store()?
.player_remote_session_set(&PlayerRemoteSession {
character_id: character,
realm_id: channel.realm_id.to_string(),
session_id: session,
public_key: coord::encode_public_key(&channel.realm_key),
coordinator: channel.coordinator.clone(),
})?;
let result = self.transfer_with_id(
channel,
session,
true,
character,
ruleset,
revision,
payload,
hash,
collections,
);
if let Ok(outcome) = &result {
if outcome.session_id != session {
return Err(protocol_error(
"The Host returned another portable session.",
));
}
}
result
}
pub fn pending_remote_sessions(&self) -> R<Vec<PlayerRemoteSession>> {
Ok(self.store()?.player_remote_sessions()?)
}
/// An idle, already-saved realm may be left; an uncertain or open session must finish first.
pub fn leave_idle_remote_session(&self, character: Uuid, runtime: &PortableRuntime) -> R<()> {
for pending in self
.pending_remote_sessions()?
.into_iter()
.filter(|pending| pending.character_id == character)
{
let sid = pending.session_id;
let idle = runtime
.call(move |service| service.remote_session_idle(sid))
.map_err(|error| ControlFail::Local(error.to_string()))?
.map_err(|error| ControlFail::Local(error.message))?;
if !idle {
return Err(ControlFail::Local("Progress from the previous realm is still being saved. Keep both Managers running until it finishes.".into()));
}
self.store()?.player_remote_session_remove(character, sid)?;
}
Ok(())
}
/// Persist the Owner's acknowledgement before acknowledging it to the Host. A lost reply is retried without making another revision.
pub fn sync_remote_session(
&self,
pending: &PlayerRemoteSession,
runtime: &PortableRuntime,
) -> R<bool> {
let mut channel = self.remote_session_channel(pending)?;
self.sync_remote_session_on_channel(pending, runtime, &mut channel)
}
fn remote_session_channel(&self, pending: &PlayerRemoteSession) -> R<PlayerChannel> {
let realm = RealmId::parse(&pending.realm_id)
.map_err(|error| ControlFail::Local(error.to_string()))?;
let key = coord::decode_public_key(&pending.public_key)
.map_err(|error| protocol_error(&error.to_string()))?;
let target = RealmTarget {
realm_id: realm,
key,
coordinator: pending.coordinator.clone(),
};
self.connect(&target)
}
fn sync_remote_session_on_channel(
&self,
pending: &PlayerRemoteSession,
runtime: &PortableRuntime,
channel: &mut PlayerChannel,
) -> R<bool> {
let character_id = pending.character_id;
let session_id = pending.session_id;
for _ in 0..16 {
let (kind, total_size, content_hash) = match channel.request(&Request::SessionPoll {
character_id,
session_id,
})? {
Response::SessionIdle { closed } => {
if closed {
let locally_closed = runtime
.call(move |service| service.remote_session_closed(session_id))
.map_err(|error| ControlFail::Local(error.to_string()))?
.map_err(|error| ControlFail::Local(error.message))?;
if !locally_closed {
return Err(protocol_error(
"The Host closed a session before the Owner saved it.",
));
}
let realm = pending.realm_id.clone();
let next = runtime
.call(move |service| service.next_remote_session(character_id, &realm))
.map_err(|error| ControlFail::Local(error.to_string()))?
.map_err(|error| ControlFail::Local(error.message))?;
if let Some(next) = next {
self.store()?.player_remote_session_advance(
character_id,
session_id,
next,
)?;
} else {
self.store()?
.player_remote_session_remove(character_id, session_id)?;
}
return Ok(true);
}
return Ok(false);
}
Response::SessionPending {
kind,
total_size,
content_hash,
} if total_size > 0
&& total_size <= app::MAX_SESSION_BYTES
&& content_hash.len() == 64 =>
{
(kind, total_size, content_hash)
}
Response::Error { code, message } => {
return Err(ControlFail::App { code, message })
}
_ => return Err(protocol_error("Invalid portable session metadata.")),
};
let mut bytes = Vec::with_capacity(total_size);
while bytes.len() < total_size {
match channel.request(&Request::SessionRead {
character_id,
session_id,
message_hash: content_hash.clone(),
offset: bytes.len(),
})? {
Response::SessionData { offset, data } if offset == bytes.len() => {
let chunk = B64
.decode(data)
.map_err(|_| protocol_error("Invalid portable session chunk."))?;
if chunk.is_empty() || chunk.len() > total_size - bytes.len() {
return Err(protocol_error("Invalid portable session chunk bounds."));
}
bytes.extend_from_slice(&chunk);
}
Response::Error { code, message } => {
return Err(ControlFail::App { code, message })
}
_ => return Err(protocol_error("Invalid portable session chunk offset.")),
}
}
if hex::encode(Sha256::digest(&bytes)) != content_hash {
return Err(protocol_error("The portable session message hash changed."));
}
let remote_realm = pending.realm_id.clone();
let ack = runtime
.call(move |service| {
service.apply_remote_session_message(
character_id,
session_id,
&remote_realm,
kind,
&bytes,
)
})
.map_err(|error| ControlFail::Local(error.to_string()))?
.map_err(|error| ControlFail::Local(error.message))?;
let mut offset = 0;
while offset < ack.len() {
let end = ack.len().min(offset + 24 * 1024);
match channel.request(&Request::SessionAck {
character_id,
session_id,
message_hash: content_hash.clone(),
offset,
total_size: ack.len(),
data: B64.encode(&ack[offset..end]),
})? {
Response::SessionAcked {
received_size,
complete,
} if received_size > offset
&& received_size <= ack.len()
&& (!complete || received_size == ack.len()) =>
{
offset = received_size
}
Response::Error { code, message } => {
return Err(ControlFail::App { code, message })
}
_ => return Err(protocol_error("Invalid portable acknowledgement offset.")),
}
}
}
Ok(false)
}
/// Independent of the visible page and the game process. Durable sessions resume after a Manager restart.
pub fn start_remote_session_sync(player: &Arc<Self>, runtime: &Arc<PortableRuntime>) {
let player = Arc::downgrade(player);
let runtime = Arc::downgrade(runtime);
let _ = std::thread::Builder::new().name("portable-remote-sync".into()).spawn(move || {
let mut errors = std::collections::HashMap::<Uuid, String>::new();
let mut channels = std::collections::HashMap::<String, PlayerChannel>::new();
loop {
{
let (Some(player), Some(runtime)) = (player.upgrade(), runtime.upgrade()) else { return };
if let Ok(sessions) = player.pending_remote_sessions() {
let wanted: std::collections::HashSet<_> = sessions.iter().map(|session| format!("{}|{}|{}", session.realm_id, session.public_key, session.coordinator)).collect();
channels.retain(|key, _| wanted.contains(key));
for session in sessions {
let key = format!("{}|{}|{}", session.realm_id, session.public_key, session.coordinator);
let result = (|| {
if !channels.contains_key(&key) {
if channels.len() >= 8 { channels.clear(); }
channels.insert(key.clone(), player.remote_session_channel(&session)?);
}
player.sync_remote_session_on_channel(&session, &runtime, channels.get_mut(&key).expect("inserted"))
})();
match result {
Ok(_) => { errors.remove(&session.character_id); },
Err(error) => {
channels.remove(&key);
let message = error.to_string();
if errors.get(&session.character_id) != Some(&message) {
tracing::warn!(character = %session.character_id, error = %message, "remote portable progress is pending; retrying");
errors.insert(session.character_id, message);
}
}
}
}
}
}
std::thread::sleep(std::time::Duration::from_secs(2));
}
});
}
}
+16 -2
View File
@@ -13,6 +13,9 @@ use super::identity::PlayerIdentity;
use super::transport::{self, LinkError, Ws}; use super::transport::{self, LinkError, Ws};
pub struct PlayerChannel { pub struct PlayerChannel {
pub(crate) realm_id: RealmId,
pub(crate) realm_key: VerifyingKey,
pub(crate) coordinator: String,
ws: Ws, ws: Ws,
channel: Channel, channel: Channel,
conn: u32, conn: u32,
@@ -35,7 +38,11 @@ impl PlayerChannel {
Duration::from_millis(500), Duration::from_millis(500),
)?; )?;
let nonce = match transport::next_frame(&mut ws, STEP)? { let nonce = match transport::next_frame(&mut ws, STEP)? {
Frame::Challenge { nonce, .. } => nonce, Frame::Challenge { protocol, nonce }
if protocol == coord::COORDINATOR_PROTOCOL_VERSION =>
{
nonce
}
_ => return Err(LinkError::Protocol("a challenge was expected".into())), _ => return Err(LinkError::Protocol("a challenge was expected".into())),
}; };
transport::send_text( transport::send_text(
@@ -67,7 +74,14 @@ impl PlayerChannel {
{ {
transport::send_binary(&mut ws, f)?; transport::send_binary(&mut ws, f)?;
} }
Ok(PlayerChannel { ws, channel, conn }) Ok(PlayerChannel {
ws,
channel,
conn,
realm_id: *realm,
realm_key: *realm_key,
coordinator: coordinator.into(),
})
} }
pub fn connection(&self) -> u32 { pub fn connection(&self) -> u32 {
+204 -10
View File
@@ -1,6 +1,6 @@
//! Outbound Host <-> Game Relay tunnel link (Phase 13). //! Outbound Host <-> Game Relay tunnel link (Phase 13).
//! Maintains outbound connectivity from Host Manager to the Game Relay, //! Maintains outbound connectivity from Host Manager to the Game Relay,
//! opening local TCP connections strictly to 127.0.0.1:3724 (Auth) and 127.0.0.1:8085 (World). //! opening local TCP connections only to the installed realm's configured loopback Auth and World ports.
use std::collections::HashMap; use std::collections::HashMap;
use std::io::{Read, Write}; use std::io::{Read, Write};
@@ -71,6 +71,31 @@ impl RelayProvider for RelayLink {
impl RelayLink { impl RelayLink {
pub fn start(url: String, realm_id: RealmId, key: SigningKey) -> Arc<Self> { pub fn start(url: String, realm_id: RealmId, key: SigningKey) -> Arc<Self> {
Self::start_with_ports(url, realm_id, key, None)
}
pub fn start_with_ports(
url: String,
realm_id: RealmId,
key: SigningKey,
local_world_port: Option<u16>,
) -> Arc<Self> {
Self::start_with_local_ports(
url,
realm_id,
key,
RelayTarget::Auth.local_port(),
local_world_port,
)
}
pub fn start_with_local_ports(
url: String,
realm_id: RealmId,
key: SigningKey,
local_auth_port: u16,
local_world_port: Option<u16>,
) -> Arc<Self> {
let stop = Arc::new(AtomicBool::new(false)); let stop = Arc::new(AtomicBool::new(false));
let status = Arc::new(Mutex::new(RelayStatus::default())); let status = Arc::new(Mutex::new(RelayStatus::default()));
let (alloc_tx, alloc_rx) = channel(); let (alloc_tx, alloc_rx) = channel();
@@ -79,7 +104,18 @@ impl RelayLink {
let st = status.clone(); let st = status.clone();
let join = std::thread::Builder::new() let join = std::thread::Builder::new()
.name("control-relay-host".into()) .name("control-relay-host".into())
.spawn(move || run(&url, realm_id, &key, alloc_rx, &s, &st)) .spawn(move || {
run(
&url,
realm_id,
&key,
alloc_rx,
&s,
&st,
local_auth_port,
local_world_port,
)
})
.ok(); .ok();
Arc::new(RelayLink { Arc::new(RelayLink {
@@ -127,11 +163,25 @@ fn run(
)>, )>,
stop: &AtomicBool, stop: &AtomicBool,
status: &Mutex<RelayStatus>, status: &Mutex<RelayStatus>,
local_auth_port: u16,
local_world_port: Option<u16>,
) { ) {
let mut failures = 0u32; let mut failures = 0u32;
while !stop.load(Ordering::SeqCst) { while !stop.load(Ordering::SeqCst) {
let began = Instant::now(); let began = Instant::now();
let result = session(url, realm, key, &alloc_rx, stop, status); let result = session(
url,
realm,
key,
&alloc_rx,
stop,
status,
local_auth_port,
local_world_port,
);
if let Err(error) = &result {
tracing::warn!(%realm, %error, "game relay connection lost; retrying");
}
set_status(status, |s| { set_status(status, |s| {
s.connected = false; s.connected = false;
s.active_streams = 0; s.active_streams = 0;
@@ -163,6 +213,15 @@ fn run(
struct StreamWorker { struct StreamWorker {
tx: Sender<TunnelMsg>, tx: Sender<TunnelMsg>,
reset_on_drop: bool,
}
impl Drop for StreamWorker {
fn drop(&mut self) {
if self.reset_on_drop {
let _ = self.tx.send(TunnelMsg::Reset { stream_id: 0 });
}
}
} }
fn session( fn session(
@@ -176,6 +235,8 @@ fn session(
)>, )>,
stop: &AtomicBool, stop: &AtomicBool,
status: &Mutex<RelayStatus>, status: &Mutex<RelayStatus>,
local_auth_port: u16,
local_world_port: Option<u16>,
) -> Result<(), LinkError> { ) -> Result<(), LinkError> {
let mut ws = transport::connect(url, POLL)?; let mut ws = transport::connect(url, POLL)?;
@@ -243,6 +304,7 @@ fn session(
let (ws_out_tx, ws_out_rx) = channel::<TunnelMsg>(); let (ws_out_tx, ws_out_rx) = channel::<TunnelMsg>();
let mut last_ping = Instant::now(); let mut last_ping = Instant::now();
let mut last_pong = Instant::now();
while !stop.load(Ordering::SeqCst) { while !stop.load(Ordering::SeqCst) {
// Drain pending allocation requests // Drain pending allocation requests
@@ -263,10 +325,14 @@ fn session(
} }
// Keepalive // Keepalive
if last_pong.elapsed() > Duration::from_secs(90) {
return Err(LinkError::Timeout);
}
if last_ping.elapsed() > Duration::from_secs(30) { if last_ping.elapsed() > Duration::from_secs(30) {
let _ = ws.send(Message::Text( ws.send(Message::Text(
serde_json::to_string(&TunnelMsg::Ping).unwrap().into(), serde_json::to_string(&TunnelMsg::Ping).unwrap().into(),
)); ))
.map_err(|error| LinkError::Io(error.to_string()))?;
last_ping = Instant::now(); last_ping = Instant::now();
} }
@@ -305,8 +371,21 @@ fn session(
TunnelMsg::Connect { TunnelMsg::Connect {
stream_id, target, .. stream_id, target, ..
} => { } => {
// Strictly predefined local targets: Auth (3724) or World (8085) // Strictly predefined local targets: Auth (3724) or World (8085 or bound realm world port)
let local_port = target.local_port(); let local_port = match target {
RelayTarget::Auth => local_auth_port,
RelayTarget::World => match local_world_port {
Some(p) => p,
None => {
eprintln!("RelayLink cannot connect to World: local_world_port was not provided (fail-closed)");
let _ = ws_out_tx.send(TunnelMsg::ConnectErr {
stream_id,
error: "World port unresolved".into(),
});
continue;
}
},
};
match TcpStream::connect(("127.0.0.1", local_port)) { match TcpStream::connect(("127.0.0.1", local_port)) {
Ok(tcp) => { Ok(tcp) => {
let (stream_tx, stream_rx) = channel::<TunnelMsg>(); let (stream_tx, stream_rx) = channel::<TunnelMsg>();
@@ -314,7 +393,13 @@ fn session(
// Spawn worker for this stream // Spawn worker for this stream
spawn_local_tcp_bridge(stream_id, tcp, stream_rx, ws_tx); spawn_local_tcp_bridge(stream_id, tcp, stream_rx, ws_tx);
streams.insert(stream_id, StreamWorker { tx: stream_tx }); streams.insert(
stream_id,
StreamWorker {
tx: stream_tx,
reset_on_drop: true,
},
);
// Reply ConnectOk // Reply ConnectOk
let ok_msg = TunnelMsg::ConnectOk { stream_id }; let ok_msg = TunnelMsg::ConnectOk { stream_id };
@@ -340,7 +425,8 @@ fn session(
} }
} }
TunnelMsg::Close { stream_id } => { TunnelMsg::Close { stream_id } => {
if let Some(w) = streams.remove(&stream_id) { if let Some(mut w) = streams.remove(&stream_id) {
w.reset_on_drop = false;
let _ = w.tx.send(TunnelMsg::Close { stream_id }); let _ = w.tx.send(TunnelMsg::Close { stream_id });
} }
set_status(status, |s| s.active_streams = streams.len()); set_status(status, |s| s.active_streams = streams.len());
@@ -351,7 +437,9 @@ fn session(
} }
set_status(status, |s| s.active_streams = streams.len()); set_status(status, |s| s.active_streams = streams.len());
} }
TunnelMsg::Pong => {} TunnelMsg::Pong => {
last_pong = Instant::now();
}
_ => {} _ => {}
} }
} }
@@ -433,3 +521,109 @@ fn spawn_local_tcp_bridge(
}) })
.ok(); .ok();
} }
#[cfg(test)]
mod tests {
use super::*;
use std::net::TcpListener;
use std::sync::atomic::AtomicUsize;
#[test]
fn relay_reconnects_after_a_dropped_link_and_clears_its_error() {
let listener = TcpListener::bind("127.0.0.1:0").unwrap();
let addr = listener.local_addr().unwrap();
let accepted = Arc::new(AtomicUsize::new(0));
let seen = accepted.clone();
let worker = std::thread::spawn(move || {
for turn in 0..2 {
let (tcp, _) = listener.accept().unwrap();
tcp.set_read_timeout(Some(Duration::from_secs(15))).unwrap();
let mut ws = tungstenite::accept(tcp).unwrap();
ws.send(Message::Text(
serde_json::to_string(&RelayChallenge {
nonce: "relay-reconnect-test".into(),
})
.unwrap()
.into(),
))
.unwrap();
let _: HostHello =
serde_json::from_str(ws.read().unwrap().to_text().unwrap()).unwrap();
ws.send(Message::Text(
serde_json::to_string(&RelayWelcome {
ok: true,
message: String::new(),
})
.unwrap()
.into(),
))
.unwrap();
seen.fetch_add(1, Ordering::SeqCst);
if turn == 0 {
continue;
}
while let Ok(message) = ws.read() {
let Ok(text) = message.to_text() else {
continue;
};
if let Ok(TunnelMsg::Allocate { request_id, .. }) = serde_json::from_str(text) {
ws.send(Message::Text(
serde_json::to_string(&TunnelMsg::AllocateOk {
request_id,
token: "test-only".into(),
relay_host: "127.0.0.1".into(),
auth_port: 41001,
world_port: 41002,
expires_at: i64::MAX,
})
.unwrap()
.into(),
))
.unwrap();
break;
}
}
}
});
let link = RelayLink::start_with_local_ports(
format!("ws://{addr}"),
RealmId::new(),
SigningKey::from_bytes(&[43; 32]),
57324,
Some(58085),
);
let until = Instant::now() + Duration::from_secs(20);
while accepted.load(Ordering::SeqCst) < 2 || !link.status().connected {
assert!(Instant::now() < until, "{:?}", link.status());
std::thread::sleep(Duration::from_millis(50));
}
assert!(link.status().last_error.is_none());
let allocation = link.allocate(&Uuid::now_v7(), None).unwrap();
assert_eq!(
(allocation.auth_port, allocation.world_port),
(41001, 41002)
);
link.stop();
worker.join().unwrap();
}
#[test]
fn dropping_a_tunnel_closes_its_local_tcp_stream() {
let listener = TcpListener::bind("127.0.0.1:0").unwrap();
let tcp = TcpStream::connect(listener.local_addr().unwrap()).unwrap();
let (mut peer, _) = listener.accept().unwrap();
peer.set_read_timeout(Some(Duration::from_secs(3))).unwrap();
let (tx, rx) = channel();
let (out, _) = channel();
spawn_local_tcp_bridge(7, tcp, rx, out);
drop(StreamWorker {
tx,
reset_on_drop: true,
});
match peer.read(&mut [0u8; 1]) {
Ok(0) => {},
Err(error) if matches!(error.kind(), std::io::ErrorKind::ConnectionReset | std::io::ErrorKind::ConnectionAborted) => {},
other => panic!("The abandoned relay stream must close, got {other:?}"),
}
}
}
+528 -55
View File
@@ -20,12 +20,27 @@ use uuid::Uuid;
use super::store::{AccountKind, ClaimState, ControlStore, HostTransfer, TransferState}; use super::store::{AccountKind, ClaimState, ControlStore, HostTransfer, TransferState};
use crate::{Error, Result}; use crate::{Error, Result};
mod portable_sync;
#[derive(Clone, Debug)]
pub struct RemoteSessionMessage {
pub kind: app::SessionMessageKind,
pub bytes: Vec<u8>,
}
#[derive(Clone, Debug)]
pub struct RemoteSessionState {
pub message: Option<RemoteSessionMessage>,
pub closed: bool,
}
#[derive(Clone, Debug, PartialEq, Eq)] #[derive(Clone, Debug, PartialEq, Eq)]
pub struct RealmInfo { pub struct RealmInfo {
/// Create accounts for joining players (the default). When false the realm only links accounts that exist. /// Create accounts for joining players (the default). When false the realm only links accounts that exist.
pub automatic: bool, pub automatic: bool,
/// An address a player's game client can reach right now, when the owner has stated one. Not a relay and not discovery. /// An address a player's game client can reach right now, when the owner has stated one. Not a relay and not discovery.
pub route: Option<String>, pub route: Option<String>,
pub ruleset: crate::portable::model::Ruleset,
} }
#[derive(Clone, Debug, PartialEq, Eq)] #[derive(Clone, Debug, PartialEq, Eq)]
@@ -55,6 +70,7 @@ pub struct CharInfo {
#[derive(Clone, Debug, PartialEq, Eq)] #[derive(Clone, Debug, PartialEq, Eq)]
pub struct ClaimExport { pub struct ClaimExport {
pub character_id: Uuid, pub character_id: Uuid,
pub ruleset: crate::portable::Ruleset,
pub payload: Vec<u8>, pub payload: Vec<u8>,
pub sha256: [u8; 32], pub sha256: [u8; 32],
pub collections: BTreeMap<String, Vec<u32>>, pub collections: BTreeMap<String, Vec<u32>>,
@@ -62,6 +78,7 @@ pub struct ClaimExport {
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub struct RemoteImportParams { pub struct RemoteImportParams {
pub session_id: Uuid,
pub character_id: Uuid, pub character_id: Uuid,
pub revision: u64, pub revision: u64,
pub payload: Vec<u8>, pub payload: Vec<u8>,
@@ -87,6 +104,30 @@ pub enum PreflightVerdict {
/// The realm itself: its login database, its console and the portable engine. /// The realm itself: its login database, its console and the portable engine.
pub trait RealmBackend: Send + Sync { pub trait RealmBackend: Send + Sync {
fn session_message(
&self,
_local_id: &str,
_character: Uuid,
_session: Uuid,
_account: u32,
) -> Result<RemoteSessionState> {
Err(Error::Invalid(
"Portable session synchronization is unavailable.".into(),
))
}
fn session_ack(
&self,
_local_id: &str,
_character: Uuid,
_session: Uuid,
_account: u32,
_kind: app::SessionMessageKind,
_bytes: &[u8],
) -> Result<()> {
Err(Error::Invalid(
"Portable session synchronization is unavailable.".into(),
))
}
fn info(&self, local_id: &str) -> Result<RealmInfo>; fn info(&self, local_id: &str) -> Result<RealmInfo>;
fn account_by_name(&self, local_id: &str, username: &str) -> Result<Option<AccountRow>>; fn account_by_name(&self, local_id: &str, username: &str) -> Result<Option<AccountRow>>;
fn account_by_id(&self, local_id: &str, id: u32) -> Result<Option<AccountRow>>; fn account_by_id(&self, local_id: &str, id: u32) -> Result<Option<AccountRow>>;
@@ -118,6 +159,11 @@ pub trait RealmBackend: Send + Sync {
local_id: &str, local_id: &str,
params: RemoteImportParams, params: RemoteImportParams,
) -> Result<RemoteImportOutcome>; ) -> Result<RemoteImportOutcome>;
/// Local world port for this realm. Must fail closed if the realm port cannot be resolved.
fn auth_port(&self, _local_id: &str) -> Result<u16> {
Ok(coa_control_proto::relay::LOCAL_AUTH_PORT)
}
fn world_port(&self, local_id: &str) -> Result<u16>;
} }
/// State of one channel. /// State of one channel.
@@ -144,7 +190,7 @@ impl Session {
} }
const MAX_REQUESTS_PER_SESSION: u32 = 60; const MAX_REQUESTS_PER_SESSION: u32 = 60;
const MAX_TRANSFER_CHUNKS_PER_SESSION: u32 = 128; const MAX_TRANSFER_CHUNKS_PER_SESSION: u32 = 2048;
const LINK_FAILURES: usize = 5; const LINK_FAILURES: usize = 5;
const LINK_WINDOW: Duration = Duration::from_secs(600); const LINK_WINDOW: Duration = Duration::from_secs(600);
@@ -177,6 +223,8 @@ fn err(code: AppError, message: &str) -> Response {
fn unavailable(what: &str, e: &Error) -> Response { fn unavailable(what: &str, e: &Error) -> Response {
tracing::warn!(error = %e, "{what}"); tracing::warn!(error = %e, "{what}");
#[cfg(test)]
eprintln!("{what}: {e}");
err( err(
AppError::Unavailable, AppError::Unavailable,
"The server could not do that right now.", "The server could not do that right now.",
@@ -218,6 +266,14 @@ impl HostService {
self.realm_id self.realm_id
} }
pub fn local_auth_port(&self) -> Result<u16> {
self.backend.auth_port(&self.local_id)
}
pub fn local_world_port(&self) -> Result<u16> {
self.backend.world_port(&self.local_id)
}
/// The player's public key is the one recorded for this player id when there is a record; `None` when the player is new here. /// The player's public key is the one recorded for this player id when there is a record; `None` when the player is new here.
pub fn key_matches(&self, player: &Uuid, public_key: &str) -> bool { pub fn key_matches(&self, player: &Uuid, public_key: &str) -> bool {
match self match self
@@ -238,7 +294,12 @@ impl HostService {
public_key: &str, public_key: &str,
request: Request, request: Request,
) -> Response { ) -> Response {
if matches!(request, Request::TransferChunk { .. }) { if matches!(
request,
Request::TransferChunk { .. }
| Request::SessionRead { .. }
| Request::SessionAck { .. }
) {
session.transfer_chunks += 1; session.transfer_chunks += 1;
if session.transfer_chunks > MAX_TRANSFER_CHUNKS_PER_SESSION { if session.transfer_chunks > MAX_TRANSFER_CHUNKS_PER_SESSION {
return err( return err(
@@ -303,6 +364,7 @@ impl HostService {
Request::TransferOffer { Request::TransferOffer {
transfer_id, transfer_id,
character_id, character_id,
ruleset,
canonical_revision, canonical_revision,
content_hash, content_hash,
total_size, total_size,
@@ -311,10 +373,31 @@ impl HostService {
player, player,
transfer_id, transfer_id,
character_id, character_id,
ruleset,
canonical_revision, canonical_revision,
content_hash, content_hash,
total_size, total_size,
collections, collections,
false,
),
Request::OwnedTransferOffer {
transfer_id,
character_id,
ruleset,
canonical_revision,
content_hash,
total_size,
collections,
} => self.transfer_offer(
player,
transfer_id,
character_id,
ruleset,
canonical_revision,
content_hash,
total_size,
collections,
true,
), ),
Request::TransferChunk { Request::TransferChunk {
transfer_id, transfer_id,
@@ -327,6 +410,32 @@ impl HostService {
transfer_id, transfer_id,
character_id, character_id,
} => self.transfer_ack(player, transfer_id, character_id), } => self.transfer_ack(player, transfer_id, character_id),
Request::SessionPoll {
character_id,
session_id,
} => self.session_poll(player, character_id, session_id),
Request::SessionRead {
character_id,
session_id,
message_hash,
offset,
} => self.session_read(player, character_id, session_id, &message_hash, offset),
Request::SessionAck {
character_id,
session_id,
message_hash,
offset,
total_size,
data,
} => self.session_ack_chunk(
player,
character_id,
session_id,
&message_hash,
offset,
total_size,
&data,
),
Request::AllocateRelay { player_id } => { Request::AllocateRelay { player_id } => {
self.allocate_relay(session, player, &player_id) self.allocate_relay(session, player, &player_id)
} }
@@ -691,6 +800,7 @@ impl HostService {
use base64::Engine; use base64::Engine;
Response::Claimed { Response::Claimed {
character_id: exported.character_id, character_id: exported.character_id,
ruleset: exported.ruleset.as_str().to_string(),
sha256: hex::encode(exported.sha256), sha256: hex::encode(exported.sha256),
payload: base64::engine::general_purpose::STANDARD.encode(&exported.payload), payload: base64::engine::general_purpose::STANDARD.encode(&exported.payload),
collections: exported.collections, collections: exported.collections,
@@ -726,10 +836,12 @@ impl HostService {
player: &Uuid, player: &Uuid,
transfer_id: Uuid, transfer_id: Uuid,
character_id: Uuid, character_id: Uuid,
ruleset: String,
canonical_revision: u64, canonical_revision: u64,
content_hash: String, content_hash: String,
total_size: usize, total_size: usize,
collections: BTreeMap<String, Vec<u32>>, collections: BTreeMap<String, Vec<u32>>,
owned_session: bool,
) -> Response { ) -> Response {
let Ok(_guard) = self.write.lock() else { let Ok(_guard) = self.write.lock() else {
return err(AppError::Unavailable, "Busy."); return err(AppError::Unavailable, "Busy.");
@@ -741,6 +853,30 @@ impl HostService {
); );
}; };
// 0. Strict ruleset isolation: target realm ruleset must match offer ruleset
let info = match self.backend.info(&self.local_id) {
Ok(i) => i,
Err(e) => return unavailable("reading realm info", &e),
};
let offer_ruleset = match crate::portable::model::Ruleset::parse(&ruleset) {
Ok(r) => r,
Err(_) => return err(AppError::Incompatible, "Invalid ruleset in transfer offer."),
};
if offer_ruleset != info.ruleset {
return err(
AppError::Incompatible,
"Character ruleset does not match this realm.",
);
}
for kind in collections.keys() {
if !crate::portable::session::protocol::carried_kind_for(kind, offer_ruleset) {
return err(
AppError::Incompatible,
"Collection kind does not belong to this ruleset.",
);
}
}
// 1. Ownership check: another player cannot overwrite a character claimed here // 1. Ownership check: another player cannot overwrite a character claimed here
if let Ok(Some(claim)) = self if let Ok(Some(claim)) = self
.store .store
@@ -756,6 +892,41 @@ impl HostService {
} }
} }
// An exact committed retry returns its saved result before transient presence or compatibility checks.
if let Ok(Some(existing)) = self
.store
.lock()
.map_err(|_| Error::Invalid("lock".into()))
.and_then(|s| s.host_transfer_latest(&self.local_id, &character_id))
{
if existing.player_id != *player {
return err(
AppError::NotYours,
"This character's transfer belongs to another player.",
);
}
if existing.state != TransferState::Receiving
&& (!owned_session || existing.transfer_id == transfer_id)
&& existing.player_id == *player
&& existing.ruleset == ruleset
&& existing.total_size == total_size
&& existing.collections == collections
&& existing.revision == canonical_revision
&& existing.content_hash == content_hash
{
if let (Some(guid), Some(sid)) = (existing.local_guid, existing.session_id) {
return Response::TransferCommitted {
transfer_id,
character_id,
local_guid: guid,
session_id: sid,
projected_level: existing.projected_level,
notes: existing.notes,
};
}
}
}
// 2. Active session conflict: if account is online with active characters // 2. Active session conflict: if account is online with active characters
match self.backend.presence(&self.local_id, m.account_id) { match self.backend.presence(&self.local_id, m.account_id) {
Ok(p) if p.account_online && p.online_characters > 0 => { Ok(p) if p.account_online && p.online_characters > 0 => {
@@ -783,30 +954,6 @@ impl HostService {
_ => {} _ => {}
} }
// 4. Idempotency / already committed check
if let Ok(Some(existing)) = self
.store
.lock()
.map_err(|_| Error::Invalid("lock".into()))
.and_then(|s| s.host_transfer_latest(&self.local_id, &character_id))
{
if existing.state != TransferState::Receiving
&& existing.revision == canonical_revision
&& existing.content_hash == content_hash
{
if let (Some(guid), Some(sid)) = (existing.local_guid, existing.session_id) {
return Response::TransferCommitted {
transfer_id,
character_id,
local_guid: guid,
session_id: sid,
projected_level: existing.projected_level,
notes: existing.notes,
};
}
}
}
// 5. Resume check for this specific transfer_id // 5. Resume check for this specific transfer_id
if let Ok(Some(cur)) = self if let Ok(Some(cur)) = self
.store .store
@@ -834,6 +981,7 @@ impl HostService {
realm_local_id: self.local_id.clone(), realm_local_id: self.local_id.clone(),
transfer_id, transfer_id,
character_id, character_id,
ruleset: offer_ruleset.as_str().to_string(),
player_id: *player, player_id: *player,
revision: canonical_revision, revision: canonical_revision,
content_hash, content_hash,
@@ -1008,23 +1156,61 @@ impl HostService {
Err(e) => return unavailable("reading transfer file", &Error::Invalid(e.to_string())), Err(e) => return unavailable("reading transfer file", &Error::Invalid(e.to_string())),
}; };
use sha2::{Digest, Sha256};
let hash = hex::encode(Sha256::digest(&payload));
if hash != t.content_hash {
let _ = std::fs::remove_file(&path);
return err(AppError::Invalid, "Content hash mismatch.");
}
let mut hash_bytes = [0u8; 32]; let mut hash_bytes = [0u8; 32];
if hex::decode_to_slice(&t.content_hash, &mut hash_bytes).is_err() { if hex::decode_to_slice(&t.content_hash, &mut hash_bytes).is_err() {
let _ = std::fs::remove_file(&path);
return err(AppError::Invalid, "Invalid content hash format."); return err(AppError::Invalid, "Invalid content hash format.");
} }
let decoded = match crate::portable::snapshot::decode(&payload, Some(&hash_bytes)) {
Ok(d) => d,
Err(e) => {
let _ = std::fs::remove_file(&path);
return err(AppError::Invalid, &format!("Corrupt snapshot: {e}"));
}
};
let transfer_ruleset: crate::portable::Ruleset = match t.ruleset.parse() {
Ok(r) => r,
Err(_) => {
let _ = std::fs::remove_file(&path);
return err(AppError::Incompatible, "Invalid transfer ruleset.");
}
};
if decoded.character_id.as_uuid() != t.character_id {
let _ = std::fs::remove_file(&path);
return err(
AppError::Invalid,
"Snapshot character id does not match TransferOffer.",
);
}
if decoded.ruleset != transfer_ruleset {
let _ = std::fs::remove_file(&path);
return err(
AppError::Incompatible,
"Snapshot ruleset does not match TransferOffer.",
);
}
let info = match self.backend.info(&self.local_id) {
Ok(i) => i,
Err(e) => {
let _ = std::fs::remove_file(&path);
return unavailable("reading realm info", &e);
}
};
if transfer_ruleset != info.ruleset {
let _ = std::fs::remove_file(&path);
return err(
AppError::Incompatible,
"Transfer ruleset does not match target realm ruleset.",
);
}
let Some(m) = self.mapping(player) else { let Some(m) = self.mapping(player) else {
return err(AppError::NoAccount, "Player has no account on this realm."); return err(AppError::NoAccount, "Player has no account on this realm.");
}; };
let params = RemoteImportParams { let params = RemoteImportParams {
session_id: t.transfer_id,
character_id: t.character_id, character_id: t.character_id,
revision: t.revision, revision: t.revision,
payload, payload,
@@ -1083,6 +1269,7 @@ impl HostService {
#[cfg(any(test, feature = "testkit"))] #[cfg(any(test, feature = "testkit"))]
pub mod fake { pub mod fake {
use super::*; use super::*;
use crate::portable::Ruleset;
#[derive(Default)] #[derive(Default)]
pub struct FakeRealm { pub struct FakeRealm {
@@ -1095,6 +1282,7 @@ pub mod fake {
pub seen_passwords: Mutex<Vec<String>>, pub seen_passwords: Mutex<Vec<String>>,
pub imported: Mutex<HashMap<Uuid, (u32, Uuid)>>, pub imported: Mutex<HashMap<Uuid, (u32, Uuid)>>,
pub incompatible: Mutex<std::collections::HashSet<Uuid>>, pub incompatible: Mutex<std::collections::HashSet<Uuid>>,
pub world_port: Mutex<Option<Result<u16>>>,
} }
impl FakeRealm { impl FakeRealm {
@@ -1141,6 +1329,7 @@ pub mod fake {
impl RealmBackend for FakeRealm { impl RealmBackend for FakeRealm {
fn info(&self, _: &str) -> Result<RealmInfo> { fn info(&self, _: &str) -> Result<RealmInfo> {
Ok(RealmInfo { Ok(RealmInfo {
ruleset: Ruleset::Coa,
automatic: *self.automatic.lock().unwrap(), automatic: *self.automatic.lock().unwrap(),
route: self.route.lock().unwrap().clone(), route: self.route.lock().unwrap().clone(),
}) })
@@ -1245,6 +1434,7 @@ pub mod fake {
.or_insert_with(Uuid::now_v7); .or_insert_with(Uuid::now_v7);
Ok(ClaimExport { Ok(ClaimExport {
character_id: id, character_id: id,
ruleset: crate::portable::Ruleset::Coa,
payload: format!("payload-{guid}").into_bytes(), payload: format!("payload-{guid}").into_bytes(),
sha256: [7; 32], sha256: [7; 32],
collections: BTreeMap::from([("coa:appearance".to_string(), vec![1, 2, 3])]), collections: BTreeMap::from([("coa:appearance".to_string(), vec![1, 2, 3])]),
@@ -1284,6 +1474,16 @@ pub mod fake {
notes: vec![], notes: vec![],
}) })
} }
fn world_port(&self, _: &str) -> Result<u16> {
if let Some(res) = self.world_port.lock().unwrap().as_ref() {
match res {
Ok(p) => Ok(*p),
Err(e) => Err(Error::Invalid(e.to_string())),
}
} else {
Ok(8085)
}
}
} }
} }
@@ -1424,7 +1624,7 @@ mod tests {
&Uuid::now_v7(), &Uuid::now_v7(),
"K", "K",
Request::Hello { Request::Hello {
protocol: 1, protocol: coa_control_proto::CONTROL_PROTOCOL_VERSION,
client: "t".into(), client: "t".into(),
}, },
) )
@@ -1655,6 +1855,7 @@ mod tests {
); );
let Response::Claimed { let Response::Claimed {
character_id, character_id,
ruleset,
sha256, sha256,
payload, payload,
collections, collections,
@@ -1662,6 +1863,7 @@ mod tests {
else { else {
panic!() panic!()
}; };
assert_eq!(ruleset, "coa");
assert_eq!(sha256, hex::encode([7u8; 32])); assert_eq!(sha256, hex::encode([7u8; 32]));
assert!(!payload.is_empty() && collections["coa:appearance"] == vec![1, 2, 3]); assert!(!payload.is_empty() && collections["coa:appearance"] == vec![1, 2, 3]);
// asking again returns the same character // asking again returns the same character
@@ -1857,6 +2059,14 @@ mod tests {
); );
} }
fn test_snapshot(cid: Uuid, ruleset: crate::portable::Ruleset) -> (Vec<u8>, String) {
let mut model = crate::portable::fixtures::geared_level_eighty();
model.character_id = crate::portable::CharacterId::from_uuid(cid).unwrap();
model.ruleset = ruleset;
let encoded = crate::portable::snapshot::encode(&model).unwrap();
(encoded.payload, hex::encode(encoded.content_hash))
}
#[test] #[test]
fn remote_transfer_lifecycle_empty_realm_import_and_ack() { fn remote_transfer_lifecycle_empty_realm_import_and_ack() {
let (realm, s, p, _acc) = claimed_setup(); let (realm, s, p, _acc) = claimed_setup();
@@ -1864,12 +2074,11 @@ mod tests {
let cid = Uuid::now_v7(); let cid = Uuid::now_v7();
let tid = Uuid::now_v7(); let tid = Uuid::now_v7();
let payload = b"portable_character_snapshot_payload_test_data".to_vec(); let (payload, hash) = test_snapshot(cid, crate::portable::Ruleset::Coa);
use sha2::{Digest, Sha256};
let hash = hex::encode(Sha256::digest(&payload));
// 1. Offer // 1. Offer
let offer = Request::TransferOffer { let offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid, transfer_id: tid,
character_id: cid, character_id: cid,
canonical_revision: 1, canonical_revision: 1,
@@ -1943,6 +2152,7 @@ mod tests {
realm.incompatible.lock().unwrap().insert(cid); realm.incompatible.lock().unwrap().insert(cid);
let offer = Request::TransferOffer { let offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid, transfer_id: tid,
character_id: cid, character_id: cid,
canonical_revision: 1, canonical_revision: 1,
@@ -1973,15 +2183,12 @@ mod tests {
let cid = Uuid::now_v7(); let cid = Uuid::now_v7();
let tid = Uuid::now_v7(); let tid = Uuid::now_v7();
let chunk1 = b"first_chunk_of_payload_"; let (full, hash) = test_snapshot(cid, crate::portable::Ruleset::Coa);
let chunk2 = b"second_chunk_of_payload"; let mid = full.len() / 2;
let mut full = chunk1.to_vec(); let (chunk1, chunk2) = full.split_at(mid);
full.extend_from_slice(chunk2);
use sha2::{Digest, Sha256};
let hash = hex::encode(Sha256::digest(&full));
let offer = Request::TransferOffer { let offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid, transfer_id: tid,
character_id: cid, character_id: cid,
canonical_revision: 1, canonical_revision: 1,
@@ -2071,11 +2278,10 @@ mod tests {
let cid = Uuid::now_v7(); let cid = Uuid::now_v7();
let tid = Uuid::now_v7(); let tid = Uuid::now_v7();
let payload = b"idempotency_test_payload".to_vec(); let (payload, hash) = test_snapshot(cid, crate::portable::Ruleset::Coa);
use sha2::{Digest, Sha256};
let hash = hex::encode(Sha256::digest(&payload));
let offer = Request::TransferOffer { let offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid, transfer_id: tid,
character_id: cid, character_id: cid,
canonical_revision: 1, canonical_revision: 1,
@@ -2138,6 +2344,7 @@ mod tests {
// Client starts a new transfer for the exact same committed revision: discovers committed state // Client starts a new transfer for the exact same committed revision: discovers committed state
let tid2 = Uuid::now_v7(); let tid2 = Uuid::now_v7();
let offer2 = Request::TransferOffer { let offer2 = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid2, transfer_id: tid2,
character_id: cid, character_id: cid,
canonical_revision: 1, canonical_revision: 1,
@@ -2163,17 +2370,92 @@ mod tests {
); );
} }
#[test]
fn committed_transfer_retry_survives_presence_and_compatibility_changes() {
let (realm, service, player, account) = claimed_setup();
let character = Uuid::now_v7();
let session_id = Uuid::now_v7();
let (payload, hash) = test_snapshot(character, crate::portable::Ruleset::Coa);
let transfer = HostTransfer {
realm_local_id: service.local_id.clone(),
transfer_id: Uuid::now_v7(),
character_id: character,
ruleset: "coa".into(),
player_id: player,
revision: 7,
content_hash: hash.clone(),
total_size: payload.len(),
received_size: payload.len(),
state: TransferState::Committed,
local_guid: Some(3012),
session_id: Some(session_id),
projected_level: Some(60),
notes: vec![],
collections: BTreeMap::new(),
};
service
.store
.lock()
.unwrap()
.host_transfer_save(&transfer)
.unwrap();
realm.incompatible.lock().unwrap().insert(character);
realm.online.lock().unwrap().insert(
account,
Presence {
account_online: true,
online_characters: 1,
},
);
let offer = || Request::TransferOffer {
transfer_id: Uuid::now_v7(),
character_id: character,
ruleset: "coa".into(),
canonical_revision: 7,
content_hash: hash.clone(),
total_size: payload.len(),
collections: BTreeMap::new(),
};
assert!(
matches!(service.handle(&mut Session::default(), &player, "K", offer()),
Response::TransferCommitted { local_guid: 3012, session_id: returned, .. } if returned == session_id)
);
let mut different = transfer;
different.player_id = Uuid::now_v7();
different.transfer_id = Uuid::now_v7();
different.character_id = Uuid::now_v7();
service
.store
.lock()
.unwrap()
.host_transfer_save(&different)
.unwrap();
let foreign_offer = Request::TransferOffer {
transfer_id: Uuid::now_v7(),
character_id: different.character_id,
ruleset: "coa".into(),
canonical_revision: 7,
content_hash: hash.clone(),
total_size: payload.len(),
collections: BTreeMap::new(),
};
assert!(matches!(
service.handle(&mut Session::default(), &player, "K", foreign_offer),
Response::Error { .. }
));
assert!(realm.imported.lock().unwrap().is_empty());
}
#[test] #[test]
fn wrong_player_identity_cannot_overwrite_another_players_realm_copy() { fn wrong_player_identity_cannot_overwrite_another_players_realm_copy() {
let (_realm, s, p, _acc) = claimed_setup(); let (_realm, s, p, _acc) = claimed_setup();
let cid = Uuid::now_v7(); let cid = Uuid::now_v7();
let tid = Uuid::now_v7(); let tid = Uuid::now_v7();
let payload = b"player_1_character_data".to_vec(); let (payload, hash) = test_snapshot(cid, crate::portable::Ruleset::Coa);
use sha2::{Digest, Sha256};
let hash = hex::encode(Sha256::digest(&payload));
let offer = Request::TransferOffer { let offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid, transfer_id: tid,
character_id: cid, character_id: cid,
canonical_revision: 1, canonical_revision: 1,
@@ -2240,6 +2522,7 @@ mod tests {
let tid_impostor = Uuid::now_v7(); let tid_impostor = Uuid::now_v7();
let impostor_offer = Request::TransferOffer { let impostor_offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid_impostor, transfer_id: tid_impostor,
character_id: cid, character_id: cid,
canonical_revision: 2, canonical_revision: 2,
@@ -2267,9 +2550,7 @@ mod tests {
let cid = Uuid::now_v7(); let cid = Uuid::now_v7();
let tid1 = Uuid::now_v7(); let tid1 = Uuid::now_v7();
let payload1 = b"character_revision_1_data".to_vec(); let (payload1, hash1) = test_snapshot(cid, crate::portable::Ruleset::Coa);
use sha2::{Digest, Sha256};
let hash1 = hex::encode(Sha256::digest(&payload1));
// Rev 1 // Rev 1
s.handle( s.handle(
@@ -2277,6 +2558,7 @@ mod tests {
&p, &p,
"K", "K",
Request::TransferOffer { Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid1, transfer_id: tid1,
character_id: cid, character_id: cid,
canonical_revision: 1, canonical_revision: 1,
@@ -2321,13 +2603,18 @@ mod tests {
// Rev 2 // Rev 2
let tid2 = Uuid::now_v7(); let tid2 = Uuid::now_v7();
let payload2 = b"character_revision_2_newer_data".to_vec(); let mut model2 = crate::portable::fixtures::geared_level_eighty();
let hash2 = hex::encode(Sha256::digest(&payload2)); model2.character_id = crate::portable::CharacterId::from_uuid(cid).unwrap();
model2.progression.money += 500;
let enc2 = crate::portable::snapshot::encode(&model2).unwrap();
let (payload2, hash2) = (enc2.payload, hex::encode(enc2.content_hash));
let r = s.handle( let r = s.handle(
&mut session, &mut session,
&p, &p,
"K", "K",
Request::TransferOffer { Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid2, transfer_id: tid2,
character_id: cid, character_id: cid,
canonical_revision: 2, canonical_revision: 2,
@@ -2377,4 +2664,190 @@ mod tests {
"update, not duplicate import" "update, not duplicate import"
); );
} }
#[test]
fn cross_ruleset_transfer_offers_are_rejected_before_mutation() {
let (realm, s, p, _acc) = claimed_setup();
let mut session = Session::default();
let cid = Uuid::now_v7();
let tid = Uuid::now_v7();
// 1. Host is CoA, offer is Wildcard -> Rejected
let wc_offer = Request::TransferOffer {
ruleset: "wildcard".into(),
transfer_id: tid,
character_id: cid,
canonical_revision: 1,
content_hash: "a".repeat(64),
total_size: 100,
collections: BTreeMap::new(),
};
let r = s.handle(&mut session, &p, "K", wc_offer);
assert!(matches!(
r,
Response::Error {
code: AppError::Incompatible,
..
}
));
// 2. Host is CoA, offer is Reborn -> Rejected
let rb_offer = Request::TransferOffer {
ruleset: "reborn".into(),
transfer_id: tid,
character_id: cid,
canonical_revision: 1,
content_hash: "a".repeat(64),
total_size: 100,
collections: BTreeMap::new(),
};
let r = s.handle(&mut session, &p, "K", rb_offer);
assert!(matches!(
r,
Response::Error {
code: AppError::Incompatible,
..
}
));
// 3. Collection kinds for another ruleset -> Rejected
let foreign_coll_offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid,
character_id: cid,
canonical_revision: 1,
content_hash: "a".repeat(64),
total_size: 100,
collections: BTreeMap::from([("wildcard:appearance".into(), vec![1, 2, 3])]),
};
let r = s.handle(&mut session, &p, "K", foreign_coll_offer);
assert!(matches!(
r,
Response::Error {
code: AppError::Incompatible,
..
}
));
// Ensure 0 DB imports happened
assert!(realm.imported.lock().unwrap().is_empty());
}
#[test]
fn tampered_payload_at_commit_aborts_with_zero_mutation() {
let (realm, s, p, _acc) = claimed_setup();
let mut session = Session::default();
let cid = Uuid::now_v7();
let tid = Uuid::now_v7();
// 1. Offer announces CoA
let (payload_coa, hash_coa) = test_snapshot(cid, crate::portable::Ruleset::Coa);
let offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid,
character_id: cid,
canonical_revision: 1,
content_hash: hash_coa,
total_size: payload_coa.len(),
collections: BTreeMap::new(),
};
s.handle(&mut session, &p, "K", offer);
// Attacker creates a Wildcard snapshot with the same CID, but uploads it under the CoA offer
let (payload_wc, hash_wc) = test_snapshot(cid, crate::portable::Ruleset::Wildcard);
// Uploading chunks of payload_wc will mismatch the offered hash
use base64::Engine;
let data = base64::engine::general_purpose::STANDARD.encode(&payload_wc);
s.handle(
&mut session,
&p,
"K",
Request::TransferChunk {
transfer_id: tid,
offset: 0,
data,
},
);
let commit = Request::TransferCommit { transfer_id: tid };
let r = s.handle(&mut session, &p, "K", commit);
assert!(matches!(
r,
Response::Error {
code: AppError::Invalid,
..
}
));
assert!(realm.imported.lock().unwrap().is_empty());
// 2. What if attacker offered hash_wc matching payload_wc, but offer.ruleset is "coa"?
let tid2 = Uuid::now_v7();
let offer2 = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid2,
character_id: cid,
canonical_revision: 1,
content_hash: hash_wc,
total_size: payload_wc.len(),
collections: BTreeMap::new(),
};
s.handle(&mut session, &p, "K", offer2);
let data2 = base64::engine::general_purpose::STANDARD.encode(&payload_wc);
s.handle(
&mut session,
&p,
"K",
Request::TransferChunk {
transfer_id: tid2,
offset: 0,
data: data2,
},
);
let commit2 = Request::TransferCommit { transfer_id: tid2 };
let r2 = s.handle(&mut session, &p, "K", commit2);
assert!(matches!(
r2,
Response::Error {
code: AppError::Incompatible,
..
}
));
assert!(realm.imported.lock().unwrap().is_empty());
// 3. What if snapshot contains a different character_id than offer?
let tid3 = Uuid::now_v7();
let other_cid = Uuid::now_v7();
let (payload_other, hash_other) = test_snapshot(other_cid, crate::portable::Ruleset::Coa);
let offer3 = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid3,
character_id: cid, // offered cid
canonical_revision: 1,
content_hash: hash_other,
total_size: payload_other.len(),
collections: BTreeMap::new(),
};
s.handle(&mut session, &p, "K", offer3);
let data3 = base64::engine::general_purpose::STANDARD.encode(&payload_other);
s.handle(
&mut session,
&p,
"K",
Request::TransferChunk {
transfer_id: tid3,
offset: 0,
data: data3,
},
);
let commit3 = Request::TransferCommit { transfer_id: tid3 };
let r3 = s.handle(&mut session, &p, "K", commit3);
assert!(matches!(
r3,
Response::Error {
code: AppError::Invalid,
..
}
));
assert!(realm.imported.lock().unwrap().is_empty());
}
} }
@@ -0,0 +1,209 @@
//! Authenticated, bounded transport for the existing Owner/Host session messages.
use super::*;
use base64::{engine::general_purpose::STANDARD as B64, Engine};
use sha2::{Digest, Sha256};
use std::io::Write;
fn digest(bytes: &[u8]) -> String {
hex::encode(Sha256::digest(bytes))
}
impl HostService {
fn session_account(&self, player: &Uuid, character: Uuid) -> Option<u32> {
let mapping = self.mapping(player)?;
let transfer = self
.store
.lock()
.ok()?
.host_transfer_latest(&self.local_id, &character)
.ok()??;
(transfer.player_id == *player && transfer.state != TransferState::Receiving)
.then_some(mapping.account_id)
}
pub(super) fn session_poll(&self, player: &Uuid, character: Uuid, session: Uuid) -> Response {
let Some(account) = self.session_account(player, character) else {
return err(
AppError::NotYours,
"This portable session does not belong to this player.",
);
};
match self
.backend
.session_message(&self.local_id, character, session, account)
{
Ok(RemoteSessionState {
message: Some(message),
..
}) => Response::SessionPending {
kind: message.kind,
total_size: message.bytes.len(),
content_hash: digest(&message.bytes),
},
Ok(state) => Response::SessionIdle {
closed: state.closed,
},
Err(error) => unavailable("reading portable session", &error),
}
}
pub(super) fn session_read(
&self,
player: &Uuid,
character: Uuid,
session: Uuid,
expected: &str,
offset: usize,
) -> Response {
let Some(account) = self.session_account(player, character) else {
return err(
AppError::NotYours,
"This portable session does not belong to this player.",
);
};
let message =
match self
.backend
.session_message(&self.local_id, character, session, account)
{
Ok(state) => match state.message {
Some(message) => message,
None => {
return err(
AppError::Conflict,
"The portable session message changed; retry.",
)
}
},
Err(error) => return unavailable("reading portable session", &error),
};
if digest(&message.bytes) != expected || offset > message.bytes.len() {
return err(
AppError::Conflict,
"The portable session message changed; retry.",
);
}
let end = message.bytes.len().min(offset.saturating_add(24 * 1024));
Response::SessionData {
offset,
data: B64.encode(&message.bytes[offset..end]),
}
}
pub(super) fn session_ack_chunk(
&self,
player: &Uuid,
character: Uuid,
session: Uuid,
expected: &str,
offset: usize,
total_size: usize,
data: &str,
) -> Response {
let Ok(_guard) = self.write.lock() else {
return err(AppError::Unavailable, "Busy.");
};
let Some(account) = self.session_account(player, character) else {
return err(
AppError::NotYours,
"This portable session does not belong to this player.",
);
};
if expected.len() != 64
|| !expected.bytes().all(|b| b.is_ascii_hexdigit())
|| total_size == 0
|| total_size > app::MAX_SESSION_BYTES
|| offset > total_size
|| data.len() > 48 * 1024
{
return err(AppError::Invalid, "Invalid acknowledgement bounds.");
}
let bytes = match B64.decode(data) {
Ok(bytes) if bytes.len() <= total_size - offset => bytes,
_ => return err(AppError::Invalid, "Invalid acknowledgement chunk."),
};
let directory = std::env::temp_dir()
.join("coa-session-acks")
.join(digest(self.local_id.as_bytes()));
if let Err(error) = std::fs::create_dir_all(&directory) {
return unavailable("preparing session acknowledgement", &Error::from(error));
}
let path = directory.join(format!("{character}-{session}.part"));
let state = match self
.backend
.session_message(&self.local_id, character, session, account)
{
Ok(state) => state,
Err(error) => return unavailable("reading portable session", &error),
};
let Some(message) = state.message else {
let _ = std::fs::remove_file(&path);
return Response::SessionAcked {
received_size: total_size,
complete: true,
};
};
if digest(&message.bytes) != expected {
return err(
AppError::Conflict,
"The portable session message changed; retry.",
);
}
// Bind one partial file to the precise message and acknowledgement length.
let mut header = expected.as_bytes().to_vec();
header.extend_from_slice(&(total_size as u64).to_le_bytes());
let write = (|| -> Result<usize> {
if offset == 0 {
let mut file = std::fs::File::create(&path)?;
file.write_all(&header)?;
}
let current = std::fs::read(&path)?;
if !current.starts_with(&header) {
return Err(Error::Invalid(
"The acknowledgement changed; restart it.".into(),
));
}
let received = current.len() - header.len();
if received != offset {
return Ok(received);
}
let mut file = std::fs::OpenOptions::new().append(true).open(&path)?;
file.write_all(&bytes)?;
file.sync_all()?;
Ok(received + bytes.len())
})();
let received = match write {
Ok(received) => received,
Err(error) => return unavailable("saving portable acknowledgement", &error),
};
if received != total_size {
return Response::SessionAcked {
received_size: received,
complete: false,
};
}
let complete = match std::fs::read(&path) {
Ok(bytes) => bytes,
Err(error) => {
return unavailable("reading portable acknowledgement", &Error::from(error))
}
};
match self.backend.session_ack(
&self.local_id,
character,
session,
account,
message.kind,
&complete[header.len()..],
) {
Ok(()) => {
let _ = std::fs::remove_file(&path);
Response::SessionAcked {
received_size: total_size,
complete: true,
}
}
Err(error) => unavailable("applying portable acknowledgement", &error),
}
}
}
+128 -4
View File
@@ -56,6 +56,7 @@ CREATE TABLE IF NOT EXISTS host_transfer(
realm_local_id TEXT NOT NULL, realm_local_id TEXT NOT NULL,
transfer_id TEXT NOT NULL PRIMARY KEY, transfer_id TEXT NOT NULL PRIMARY KEY,
character_id TEXT NOT NULL, character_id TEXT NOT NULL,
ruleset TEXT NOT NULL DEFAULT 'coa',
player_id TEXT NOT NULL, player_id TEXT NOT NULL,
revision INTEGER NOT NULL, revision INTEGER NOT NULL,
content_hash TEXT NOT NULL, content_hash TEXT NOT NULL,
@@ -71,6 +72,13 @@ CREATE TABLE IF NOT EXISTS host_transfer(
updated_at TEXT NOT NULL updated_at TEXT NOT NULL
); );
CREATE INDEX IF NOT EXISTS host_transfer_char ON host_transfer(realm_local_id, character_id); CREATE INDEX IF NOT EXISTS host_transfer_char ON host_transfer(realm_local_id, character_id);
CREATE TABLE IF NOT EXISTS player_remote_session(
character_id TEXT PRIMARY KEY,
realm_id TEXT NOT NULL,
session_id TEXT NOT NULL,
public_key TEXT NOT NULL,
coordinator TEXT NOT NULL
);
"; ";
fn now() -> String { fn now() -> String {
@@ -155,6 +163,7 @@ pub struct HostTransfer {
pub realm_local_id: String, pub realm_local_id: String,
pub transfer_id: Uuid, pub transfer_id: Uuid,
pub character_id: Uuid, pub character_id: Uuid,
pub ruleset: String,
pub player_id: Uuid, pub player_id: Uuid,
pub revision: u64, pub revision: u64,
pub content_hash: String, pub content_hash: String,
@@ -175,6 +184,15 @@ pub struct PlayerRealm {
pub kind: AccountKind, pub kind: AccountKind,
} }
#[derive(Clone, Debug)]
pub struct PlayerRemoteSession {
pub character_id: Uuid,
pub realm_id: String,
pub session_id: Uuid,
pub public_key: String,
pub coordinator: String,
}
pub struct ControlStore { pub struct ControlStore {
conn: Connection, conn: Connection,
} }
@@ -184,6 +202,66 @@ fn uuid(s: String) -> Result<Uuid> {
} }
impl ControlStore { impl ControlStore {
pub fn player_remote_sessions(&self) -> Result<Vec<PlayerRemoteSession>> {
let mut statement = self.conn.prepare("SELECT character_id, realm_id, session_id, public_key, coordinator FROM player_remote_session ORDER BY character_id").map_err(db)?;
let rows = statement
.query_map([], |row| {
Ok((
row.get::<_, String>(0)?,
row.get::<_, String>(1)?,
row.get::<_, String>(2)?,
row.get::<_, String>(3)?,
row.get::<_, String>(4)?,
))
})
.map_err(db)?;
rows.map(|row| {
let (character, realm_id, session, public_key, coordinator) = row.map_err(db)?;
Ok(PlayerRemoteSession {
character_id: uuid(character)?,
realm_id,
session_id: uuid(session)?,
public_key,
coordinator,
})
})
.collect()
}
pub fn player_remote_session_set(&self, session: &PlayerRemoteSession) -> Result<()> {
if self.player_remote_sessions()?.iter().any(|existing| {
existing.character_id == session.character_id
&& (existing.session_id != session.session_id
|| existing.realm_id != session.realm_id
|| existing.public_key != session.public_key)
}) {
return Err(Error::Invalid(
"The character's previous remote session must finish saving first.".into(),
));
}
self.conn.execute("INSERT INTO player_remote_session(character_id, realm_id, session_id, public_key, coordinator) VALUES(?1,?2,?3,?4,?5) ON CONFLICT(character_id) DO NOTHING", params![session.character_id.to_string(), session.realm_id, session.session_id.to_string(), session.public_key, session.coordinator]).map_err(db)?;
Ok(())
}
pub fn player_remote_session_advance(
&self,
character: Uuid,
previous: Uuid,
next: Uuid,
) -> Result<()> {
self.conn.execute("UPDATE player_remote_session SET session_id=?3 WHERE character_id=?1 AND session_id=?2", params![character.to_string(), previous.to_string(), next.to_string()]).map_err(db)?;
Ok(())
}
pub fn player_remote_session_remove(&self, character: Uuid, session: Uuid) -> Result<()> {
self.conn
.execute(
"DELETE FROM player_remote_session WHERE character_id=?1 AND session_id=?2",
params![character.to_string(), session.to_string()],
)
.map_err(db)?;
Ok(())
}
pub fn open(dir: &Path) -> Result<Self> { pub fn open(dir: &Path) -> Result<Self> {
std::fs::create_dir_all(dir)?; std::fs::create_dir_all(dir)?;
let conn = Connection::open(dir.join("control.sqlite")).map_err(db)?; let conn = Connection::open(dir.join("control.sqlite")).map_err(db)?;
@@ -199,6 +277,10 @@ impl ControlStore {
.map_err(db)?; .map_err(db)?;
let _ = conn.pragma_update(None, "journal_mode", "WAL"); let _ = conn.pragma_update(None, "journal_mode", "WAL");
conn.execute_batch(SCHEMA).map_err(db)?; conn.execute_batch(SCHEMA).map_err(db)?;
let _ = conn.execute(
"ALTER TABLE host_transfer ADD COLUMN ruleset TEXT NOT NULL DEFAULT 'coa'",
[],
);
Ok(Self { conn }) Ok(Self { conn })
} }
@@ -307,7 +389,7 @@ impl ControlStore {
pub fn host_transfer(&self, realm: &str, transfer_id: &Uuid) -> Result<Option<HostTransfer>> { pub fn host_transfer(&self, realm: &str, transfer_id: &Uuid) -> Result<Option<HostTransfer>> {
self.conn self.conn
.query_row( .query_row(
"SELECT realm_local_id, transfer_id, character_id, player_id, revision, content_hash, total_size, received_size, state, local_guid, session_id, projected_level, notes, collections FROM host_transfer WHERE realm_local_id = ?1 AND transfer_id = ?2", "SELECT realm_local_id, transfer_id, character_id, player_id, revision, content_hash, total_size, received_size, state, local_guid, session_id, projected_level, notes, collections, ruleset FROM host_transfer WHERE realm_local_id = ?1 AND transfer_id = ?2",
params![realm, transfer_id.to_string()], params![realm, transfer_id.to_string()],
row_transfer, row_transfer,
) )
@@ -323,7 +405,7 @@ impl ControlStore {
) -> Result<Option<HostTransfer>> { ) -> Result<Option<HostTransfer>> {
self.conn self.conn
.query_row( .query_row(
"SELECT realm_local_id, transfer_id, character_id, player_id, revision, content_hash, total_size, received_size, state, local_guid, session_id, projected_level, notes, collections FROM host_transfer WHERE realm_local_id = ?1 AND character_id = ?2 ORDER BY updated_at DESC LIMIT 1", "SELECT realm_local_id, transfer_id, character_id, player_id, revision, content_hash, total_size, received_size, state, local_guid, session_id, projected_level, notes, collections, ruleset FROM host_transfer WHERE realm_local_id = ?1 AND character_id = ?2 ORDER BY updated_at DESC LIMIT 1",
params![realm, character_id.to_string()], params![realm, character_id.to_string()],
row_transfer, row_transfer,
) )
@@ -337,8 +419,8 @@ impl ControlStore {
let coll_json = serde_json::to_string(&t.collections).unwrap_or_default(); let coll_json = serde_json::to_string(&t.collections).unwrap_or_default();
self.conn self.conn
.execute( .execute(
"INSERT INTO host_transfer(realm_local_id, transfer_id, character_id, player_id, revision, content_hash, total_size, received_size, state, local_guid, session_id, projected_level, notes, collections, created_at, updated_at) "INSERT INTO host_transfer(realm_local_id, transfer_id, character_id, ruleset, player_id, revision, content_hash, total_size, received_size, state, local_guid, session_id, projected_level, notes, collections, created_at, updated_at)
VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11, ?12, ?13, ?14, ?15, ?16) VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11, ?12, ?13, ?14, ?15, ?16, ?17)
ON CONFLICT(transfer_id) DO UPDATE SET ON CONFLICT(transfer_id) DO UPDATE SET
received_size = excluded.received_size, received_size = excluded.received_size,
state = excluded.state, state = excluded.state,
@@ -347,11 +429,13 @@ impl ControlStore {
projected_level = excluded.projected_level, projected_level = excluded.projected_level,
notes = excluded.notes, notes = excluded.notes,
collections = excluded.collections, collections = excluded.collections,
ruleset = excluded.ruleset,
updated_at = excluded.updated_at", updated_at = excluded.updated_at",
params![ params![
t.realm_local_id, t.realm_local_id,
t.transfer_id.to_string(), t.transfer_id.to_string(),
t.character_id.to_string(), t.character_id.to_string(),
t.ruleset,
t.player_id.to_string(), t.player_id.to_string(),
t.revision as i64, t.revision as i64,
t.content_hash, t.content_hash,
@@ -540,11 +624,13 @@ fn row_transfer(r: &rusqlite::Row<'_>) -> rusqlite::Result<Result<HostTransfer>>
let collections = coll_str let collections = coll_str
.and_then(|s| serde_json::from_str::<BTreeMap<String, Vec<u32>>>(&s).ok()) .and_then(|s| serde_json::from_str::<BTreeMap<String, Vec<u32>>>(&s).ok())
.unwrap_or_default(); .unwrap_or_default();
let ruleset: String = r.get(14).unwrap_or_else(|_| "coa".to_string());
Ok((|| { Ok((|| {
Ok(HostTransfer { Ok(HostTransfer {
realm_local_id, realm_local_id,
transfer_id: uuid(tid)?, transfer_id: uuid(tid)?,
character_id: uuid(cid)?, character_id: uuid(cid)?,
ruleset,
player_id: uuid(pid)?, player_id: uuid(pid)?,
revision: revision as u64, revision: revision as u64,
content_hash, content_hash,
@@ -564,6 +650,43 @@ fn row_transfer(r: &rusqlite::Row<'_>) -> rusqlite::Result<Result<HostTransfer>>
mod tests { mod tests {
use super::*; use super::*;
#[test]
fn remote_session_survives_restart_and_cannot_be_replaced() {
let dir = tempfile::tempdir().unwrap();
let row = PlayerRemoteSession {
character_id: Uuid::now_v7(),
realm_id: "realm".into(),
session_id: Uuid::now_v7(),
public_key: "pinned-key".into(),
coordinator: "wss://example.test/coord/v1/player".into(),
};
{
let store = ControlStore::open(dir.path()).unwrap();
store.player_remote_session_set(&row).unwrap();
store.player_remote_session_set(&row).unwrap();
let mut other = row.clone();
other.session_id = Uuid::now_v7();
assert!(store.player_remote_session_set(&other).is_err());
other = row.clone();
other.public_key = "changed-key".into();
assert!(store.player_remote_session_set(&other).is_err());
}
let store = ControlStore::open(dir.path()).unwrap();
let recovered = store.player_remote_sessions().unwrap().pop().unwrap();
assert_eq!(
(recovered.session_id, recovered.public_key),
(row.session_id, row.public_key)
);
store
.player_remote_session_remove(row.character_id, Uuid::now_v7())
.unwrap();
assert_eq!(store.player_remote_sessions().unwrap().len(), 1);
store
.player_remote_session_remove(row.character_id, row.session_id)
.unwrap();
assert!(store.player_remote_sessions().unwrap().is_empty());
}
#[test] #[test]
fn a_player_owns_one_account_per_realm_and_an_account_one_player() { fn a_player_owns_one_account_per_realm_and_an_account_one_player() {
let s = ControlStore::open_in_memory().unwrap(); let s = ControlStore::open_in_memory().unwrap();
@@ -677,6 +800,7 @@ mod tests {
realm_local_id: "live".into(), realm_local_id: "live".into(),
transfer_id: t, transfer_id: t,
character_id: c, character_id: c,
ruleset: "coa".into(),
player_id: p, player_id: p,
revision: 3, revision: 3,
content_hash: "a".repeat(64), content_hash: "a".repeat(64),
+95 -32
View File
@@ -14,12 +14,14 @@ use crate::download::Cancel;
use crate::error::{Error, Result}; use crate::error::{Error, Result};
use crate::fsx; use crate::fsx;
pub const CLIENT_VERSION: &str = "1.8.3"; pub const CLIENT_VERSION: &str = "1.9.2";
pub const MANIFEST_FILENAME: &str = "custom_races_patch_manifest.txt"; pub const MANIFEST_FILENAME: &str = "custom_races_patch_manifest.txt";
pub const ARCHIVES: &[(&str, &str)] = &[ pub const ARCHIVES: &[(&str, &str)] = &[
("CoA-Custom-1.8.3-Client-1.zip", "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.8.3/CoA-Custom-1.8.3-Client-1.zip"), ("CoA-Custom-1.9.2-Client-1.zip", "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.9.2/CoA-Custom-1.9.2-Client-1.zip"),
("CoA-Custom-1.8.3-Client-2.zip", "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.8.3/CoA-Custom-1.8.3-Client-2.zip"), ("CoA-Custom-1.9.2-Client-2.zip", "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.9.2/CoA-Custom-1.9.2-Client-2.zip"),
("CoA-Custom-1.8.3-Client-3.zip", "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.8.3/CoA-Custom-1.8.3-Client-3.zip"), ("CoA-Custom-1.9.2-Client-3.zip", "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.9.2/CoA-Custom-1.9.2-Client-3.zip"),
("CoA-Custom-1.9.2-Client-4.zip", "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.9.2/CoA-Custom-1.9.2-Client-4.zip"),
("CoA-Custom-1.9.2-Client-5.zip", "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.9.2/CoA-Custom-1.9.2-Client-5.zip"),
]; ];
pub const RACE_MPQS: &[&str] = &[ pub const RACE_MPQS: &[&str] = &[
@@ -53,9 +55,15 @@ pub const RACE_MPQS: &[&str] = &[
"patch-ZZX.MPQ", "patch-ZZX.MPQ",
"patch-ZZZC.MPQ", "patch-ZZZC.MPQ",
"patch-ZZZD.MPQ", "patch-ZZZD.MPQ",
"patch-ZZZA.MPQ",
"patch-ZZZE.MPQ",
"patch-ZZZF.MPQ",
"patch-ZZZZ.MPQ",
]; ];
pub const RACE_ADDONS: &[&str] = &[ pub const RACE_ADDONS: &[&str] = &[
"CoAQuestSafe/CoAQuestSafe.lua",
"CoAQuestSafe/CoAQuestSafe.toc",
"CoAWC2Cursor/CoAWC2Cursor.lua", "CoAWC2Cursor/CoAWC2Cursor.lua",
"CoAWC2Cursor/CoAWC2Cursor.toc", "CoAWC2Cursor/CoAWC2Cursor.toc",
"CoAHideArmor/CoAHideArmor.lua", "CoAHideArmor/CoAHideArmor.lua",
@@ -186,6 +194,10 @@ fn patch_files(client: &Path) -> Result<Vec<PatchFile>> {
include_str!("custom_races_hashes_1_7.json") include_str!("custom_races_hashes_1_7.json")
} else if manifest.lines().any(|line| line == "# CoA Custom 1.8") { } else if manifest.lines().any(|line| line == "# CoA Custom 1.8") {
include_str!("custom_races_hashes_1_8.json") include_str!("custom_races_hashes_1_8.json")
} else if manifest.lines().any(|line| line == "# CoA Custom 1.8.3") {
include_str!("custom_races_hashes_1_8_3.json")
} else if manifest.lines().any(|line| line == "# CoA Custom 1.9.1") {
include_str!("custom_races_hashes_1_9_1.json")
} else { } else {
include_str!("custom_races_hashes.json") include_str!("custom_races_hashes.json")
}; };
@@ -200,16 +212,10 @@ fn patch_files(client: &Path) -> Result<Vec<PatchFile>> {
} }
Some(format!("Data/{name}")) Some(format!("Data/{name}"))
} else if let Some(name) = line.strip_prefix("ROOT:") { } else if let Some(name) = line.strip_prefix("ROOT:") {
if name.contains(['/', '\\']) {
return Err(Error::Invalid(
"Invalid custom races patch manifest.".into(),
));
}
Some(name.to_string()) Some(name.to_string())
} else if let Some(name) = line.strip_prefix("ADDON:") {
Some(format!("Interface/AddOns/{name}"))
} else { } else {
None line.strip_prefix("ADDON:")
.map(|name| format!("Interface/AddOns/{name}"))
}; };
if let Some(path) = path { if let Some(path) = path {
fsx::safe_join(client, &path)?; fsx::safe_join(client, &path)?;
@@ -625,16 +631,37 @@ pub fn uninstall_client_patches(client: &Path) -> Result<()> {
tx.finish() tx.finish()
} }
fn stage_root_asset(staging: &Path, relative: &str, reader: &mut impl Read) -> Result<String> {
let dest = fsx::safe_join(staging, relative)?;
fs::create_dir_all(
dest.parent()
.ok_or_else(|| Error::Invalid("Invalid client asset path.".into()))?,
)?;
let mut output = File::create(&dest)?;
io::copy(reader, &mut output)?;
let disabled = PathBuf::from(format!("{}.disabled", dest.display()));
if disabled.is_file() {
fs::remove_file(disabled)?;
}
Ok(relative.to_string())
}
fn verify_archive(path: &Path, filename: &str) -> Result<()> { fn verify_archive(path: &Path, filename: &str) -> Result<()> {
let expected = match filename { let expected = match filename {
"CoA-Custom-1.8.3-Client-1.zip" => { "CoA-Custom-1.9.2-Client-1.zip" => {
"a9dd51ed2d90fb048d549602f40f5429d56e2df0df5606a38781b358fa369568" "a9dd51ed2d90fb048d549602f40f5429d56e2df0df5606a38781b358fa369568"
} }
"CoA-Custom-1.8.3-Client-2.zip" => { "CoA-Custom-1.9.2-Client-2.zip" => {
"ab084a55509ccbcc2977a06dd0c01fa879973a1892baaacaeb3ff52f3dfc750e" "ab084a55509ccbcc2977a06dd0c01fa879973a1892baaacaeb3ff52f3dfc750e"
} }
"CoA-Custom-1.8.3-Client-3.zip" => { "CoA-Custom-1.9.2-Client-3.zip" => {
"270c7b306624bf9e5c3fe577e3bd058601221df223dd9e449ff7c25de70b9461" "907e267f0ee7038807e626c3c1eca5e12db6c88b747137a23c5fb52eaa1a358e"
}
"CoA-Custom-1.9.2-Client-4.zip" => {
"e0bd87172af989fa50a8e2b08ba4321c72b6265047482f051a1db3b80d55bcaa"
}
"CoA-Custom-1.9.2-Client-5.zip" => {
"73364ad1b58c6342641a848a3b20a835472834f600416606be1470386774ca78"
} }
_ => return Err(Error::Invalid("Unknown custom races archive.".into())), _ => return Err(Error::Invalid("Unknown custom races archive.".into())),
}; };
@@ -868,22 +895,8 @@ pub fn install_client_patches(
let mut out = File::create(&dest)?; let mut out = File::create(&dest)?;
io::copy(&mut zfile, &mut out)?; io::copy(&mut zfile, &mut out)?;
installed_roots.push(relative); installed_roots.push(relative);
} else if zname_norm.contains("files/client_root/") { } else if let Some(relative) = zname_norm.split("files/client_root/").nth(1) {
let base = Path::new(&zname_norm) installed_roots.push(stage_root_asset(staging.path(), relative, &mut zfile)?);
.file_name()
.map(|n| n.to_string_lossy().into_owned())
.unwrap_or_default();
if !base.is_empty() {
let dest = staging.path().join(&base);
let mut out = File::create(&dest)?;
io::copy(&mut zfile, &mut out)?;
let disabled = staging.path().join(format!("{base}.disabled"));
if disabled.is_file() {
fs::remove_file(disabled)?;
}
installed_roots.push(base);
}
} }
} }
} }
@@ -1049,6 +1062,56 @@ mod tests {
fs::remove_dir(link).unwrap(); fs::remove_dir(link).unwrap();
} }
#[test]
fn nested_root_manifest_remains_valid_and_rejects_traversal() {
let temp = tempfile::tempdir().unwrap();
let relative = "Data/Retail/Assets/EquipmentFitting/60-0.bin";
fs::write(
temp.path().join(MANIFEST_FILENAME),
format!("# CoA Custom {CLIENT_VERSION}\nROOT:{relative}\n"),
)
.unwrap();
assert_eq!(patch_files(temp.path()).unwrap()[0].path, relative);
fs::write(temp.path().join(MANIFEST_FILENAME), "ROOT:../outside.bin\n").unwrap();
assert!(patch_files(temp.path()).is_err());
}
#[test]
fn previous_split_release_retains_its_original_hash_inventory() {
let temp = tempfile::tempdir().unwrap();
fs::write(temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.8.3\n").unwrap();
let old: std::collections::BTreeMap<String, String> =
serde_json::from_str(include_str!("custom_races_hashes_1_8_3.json")).unwrap();
let files = patch_files(temp.path()).unwrap();
assert_eq!(files.len(), old.len());
assert!(files
.iter()
.all(|file| old.get(&file.path) == Some(&file.sha256)));
}
#[test]
fn previous_191_release_keeps_its_hashes_and_does_not_claim_new_addons() {
let temp = tempfile::tempdir().unwrap();
fs::write(temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.9.1\n").unwrap();
let old: std::collections::BTreeMap<String, String> =
serde_json::from_str(include_str!("custom_races_hashes_1_9_1.json")).unwrap();
let files = patch_files(temp.path()).unwrap();
assert_eq!(files.len(), old.len());
assert!(files.iter().all(|file| old.get(&file.path) == Some(&file.sha256)));
assert!(!files.iter().any(|file| file.path.contains("CoAQuestSafe")));
}
#[test]
fn root_assets_preserve_nested_paths_and_reject_traversal() {
let temp = tempfile::tempdir().unwrap();
let relative = "Data/Retail/Assets/EquipmentFitting/60-0.bin";
let result = stage_root_asset(temp.path(), relative, &mut &b"fitting"[..]).unwrap();
assert_eq!(result, relative);
assert_eq!(fs::read(temp.path().join(relative)).unwrap(), b"fitting");
assert!(!temp.path().join("60-0.bin").exists());
assert!(stage_root_asset(temp.path(), "../outside.bin", &mut &b"bad"[..]).is_err());
}
#[test] #[test]
#[cfg(windows)] #[cfg(windows)]
fn shared_addons_junction_supports_install_switch_and_rollback() { fn shared_addons_junction_supports_install_switch_and_rollback() {
+51 -8
View File
@@ -1,5 +1,20 @@
{ {
"Ascension.exe": "e2c347019d554a59639e5978fd68e50e906973ab313c6573cc56ca82e8e3c547", "Ascension.exe": "e2c347019d554a59639e5978fd68e50e906973ab313c6573cc56ca82e8e3c547",
"Data/Retail/Assets/EquipmentFitting/1068-1.bin": "332d2c38b037a118f262bbb3096a01ebfb33c5347e96bbfb64157437b300281b",
"Data/Retail/Assets/EquipmentFitting/60-0.bin": "ffbf6efc9ea09b0c442f048c5bc7b4c5975258045cfddedd9a77a93363312b5e",
"Data/Retail/Assets/EquipmentFitting/60-1.bin": "36ceed2a55756f3322e018938809acea5124351161405058ef27d100173778da",
"Data/Retail/Assets/EquipmentFitting/61-0.bin": "3b302a4055d1e795c451b02e38dfe8007527ee1bc5f926ebcd6ef17f433cd232",
"Data/Retail/Assets/EquipmentFitting/61-1.bin": "c42df399ed99be3c7ce1b5fdb95a873711011713a4cd867bc226a14b1ce0e8ca",
"Data/Retail/Assets/EquipmentFitting/65-0.bin": "8ce3f884ae197d14dff0f955c2cf05abb716742c8aff79f7af1cec5cf7225f04",
"Data/Retail/Assets/EquipmentFitting/68-0.bin": "f1d878f0f943cbdb8025af8daac4a38c1d1e159bd961d9d76f225931c11648ac",
"Data/Retail/Assets/EquipmentFitting/68-1.bin": "2ccbae634384200340c0cc3dca36a7a014a8ddad110598e4470ff1b266576465",
"Data/Retail/Assets/EquipmentFitting/73-0.bin": "5530882678f677ad47987ce906e851338a35f7d9737e3f9d829938027b8af67f",
"Data/Retail/Assets/EquipmentFitting/74-0.bin": "53a7be86b3bfdd6995406c706df3ca091484206d8141cebb39113c714500384a",
"Data/Retail/Assets/EquipmentFitting/74-1.bin": "e688c55a355231978d42480a003c26d379460f5931c2469c119ecb073ea153e1",
"Data/Retail/Assets/EquipmentFitting/75-0.bin": "289abc71c6df0e031a64d62a40e658eaefd37e45373a062ca52f08fbe803500c",
"Data/Retail/Assets/EquipmentFitting/76-0.bin": "63a493e70b91f59ff49f1942d959df986062bd267fe2ba589f344963df771021",
"Data/Retail/Assets/EquipmentFitting/77-0.bin": "b1366ce0dc4f31cb8c8c9705be2da565df4b905224af04b6b88f8c8e9c87e3c9",
"Data/Retail/Assets/EquipmentFitting/78-0.bin": "7b0031fb12ab19020005bdccacca2dd3991349c36949a58b035992585b4134db",
"Data/patch-T.MPQ": "fe597138ab7f56881b5f4f27d6dc9d81bb278b483ca0d91b7207ffd4a5ae7bfd", "Data/patch-T.MPQ": "fe597138ab7f56881b5f4f27d6dc9d81bb278b483ca0d91b7207ffd4a5ae7bfd",
"Data/patch-ZE1.MPQ": "69d79dbbea54ec0312c37770debc79c7bc9ce2e21eedef99c03cd8d911955283", "Data/patch-ZE1.MPQ": "69d79dbbea54ec0312c37770debc79c7bc9ce2e21eedef99c03cd8d911955283",
"Data/patch-ZE2.MPQ": "1a41cae77ad730e9cf69e8d63fd12ae3a579418bb550d351fff469573a97ac3c", "Data/patch-ZE2.MPQ": "1a41cae77ad730e9cf69e8d63fd12ae3a579418bb550d351fff469573a97ac3c",
@@ -22,28 +37,48 @@
"Data/patch-ZZE.MPQ": "4b1e289e12c82644cb78f50170e6b5fd53918eb2de834f9e0cebddd81873a8bb", "Data/patch-ZZE.MPQ": "4b1e289e12c82644cb78f50170e6b5fd53918eb2de834f9e0cebddd81873a8bb",
"Data/patch-ZZR.MPQ": "5a7575e592dc0c8a6913e0d946bbe06fa0ca2e4d817ef1f8548d3d13142bcbd3", "Data/patch-ZZR.MPQ": "5a7575e592dc0c8a6913e0d946bbe06fa0ca2e4d817ef1f8548d3d13142bcbd3",
"Data/patch-ZZS.MPQ": "533fd69d5784d83e872a5a28d27301dc9ab5d0cb925f8b2116926854e4a0a5b8", "Data/patch-ZZS.MPQ": "533fd69d5784d83e872a5a28d27301dc9ab5d0cb925f8b2116926854e4a0a5b8",
"Data/patch-ZZT.MPQ": "aef3bbe4951333d62fb55224484724fbaa9c35773a19944ffb9935e250cfb59c", "Data/patch-ZZT.MPQ": "e60dab63fe5650fdf5f0846ea6d4136219293bcfdad46d9b796697faeff9ab4c",
"Data/patch-ZZU.MPQ": "8ee1839415b56d46c6eff7eb4dfbaf6fbafc4c6b29b39380d69f4d827d02a99e", "Data/patch-ZZU.MPQ": "0311de8f034eae7dec1bd2c92b1fe6c741cbaf53da62c7609cd12b6c37908e47",
"Data/patch-ZZV.MPQ": "8d5e61d37008abf70478e5d5f46ec7afb0490b9a643323bd75a1c70cadd63290", "Data/patch-ZZV.MPQ": "3b04008905e7185d165827d68f7ca228dda8272816364f7d71874ecc83b64f0e",
"Data/patch-ZZW.MPQ": "3689c485f8ee8fccaa6dbae1d073bc9231229f9a040f79a272d80a87486d0c33", "Data/patch-ZZW.MPQ": "3bbbc72901fd2d662113036485c380701e693f5a39ba9479af306bf2fa2030bd",
"Data/patch-ZZX.MPQ": "4c12608089cfe356f7c8882d66db90239ed3ec8ddd980d91d7a3a488680f3c88", "Data/patch-ZZX.MPQ": "4c12608089cfe356f7c8882d66db90239ed3ec8ddd980d91d7a3a488680f3c88",
"Data/patch-ZZZ.MPQ": "566aaadf501af42e29a828b1bc2edbd36d436288fb309fe423bd74b9619bf593", "Data/patch-ZZZ.MPQ": "566aaadf501af42e29a828b1bc2edbd36d436288fb309fe423bd74b9619bf593",
"Data/patch-ZZZA.MPQ": "57ccbdc0a66000767554ffd194088df6d602ddd8341a141bca8201e7d5435889",
"Data/patch-ZZZC.MPQ": "691a53f6325c2615a64ced0802f18bc4d96e99c62aaa606fc930f9406ee74cdf", "Data/patch-ZZZC.MPQ": "691a53f6325c2615a64ced0802f18bc4d96e99c62aaa606fc930f9406ee74cdf",
"Data/patch-ZZZD.MPQ": "e4ce9d8b363eb609d0d6d92627eb53454fa2e03e4dbc1795b3573a22b7d009c8", "Data/patch-ZZZD.MPQ": "ca893cf8129f6fd442a63f0697a8ddea88546e3ce71bde713be2cc832b892bc9",
"Data/patch-ZZZE.MPQ": "2e245ee0fe3b913087eed399062fda5843d98b04afac38024f7c64ac3bf43e18",
"Data/patch-ZZZF.MPQ": "40eac695cfcafb598b8376f3b9a61ecc037e4d445b87279cfe387a91edad32c3",
"Data/patch-ZZZZ.MPQ": "860c990db3b4185fdc36e1a001d3ca3507a68253a4506793a115f86eb0892a15",
"EsteriaAppearance.bin": "90d9cfaeaf6de10f014f1d1610ea10453ec9b240255759aea99513cac488a3ec", "EsteriaAppearance.bin": "90d9cfaeaf6de10f014f1d1610ea10453ec9b240255759aea99513cac488a3ec",
"EsteriaAppearance.dll": "196a82f24dd287653e2b2fc4d12bfc796f8ee3f6687ca8308905a5ab528a51a9", "EsteriaAppearance.dll": "88e268d3be9eca3b0644f543d823f4bdcc04a9700a6e8ed73fd2a1260ad191af",
"EsteriaAppearanceGeometry.bin": "19de5b4b4f79778ea5316659efc2f66c6edb6b5149c46efa47c46bfa4ec6904c", "EsteriaAppearanceGeometry.bin": "19de5b4b4f79778ea5316659efc2f66c6edb6b5149c46efa47c46bfa4ec6904c",
"EsteriaAppearanceMaterials.bin": "f72f027f54a55c05aa0f76b457b97b484fe0e1aedc0e068cc0e0ca53e1878cba", "EsteriaAppearanceMaterials.bin": "f72f027f54a55c05aa0f76b457b97b484fe0e1aedc0e068cc0e0ca53e1878cba",
"EsteriaBanshee.bin": "d3fe66caa6a0ecba96bddb07ac1cbdb915694e87fc1608da0fdabecdf9ffea4d",
"EsteriaBansheeTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaCentaur.bin": "d63f0b7d21cee67d234d134e832fe6d55c398f2b63f9f6c191dcfa9671637185",
"EsteriaCentaurTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaCosmeticWings.bin": "57352c28459d073a29b3014d33b70f3b3756afa37fa9583ef6b30d503422ac3f", "EsteriaCosmeticWings.bin": "57352c28459d073a29b3014d33b70f3b3756afa37fa9583ef6b30d503422ac3f",
"EsteriaDrakonid.bin": "95440ee9c065ef20bb7fed6158d20623d68745291cedc2726fc746ff54601f95", "EsteriaDrakonid.bin": "95440ee9c065ef20bb7fed6158d20623d68745291cedc2726fc746ff54601f95",
"EsteriaDrakonidCoverage.bin": "9cdc227f08329e1245d2b864a996e7a772c96ecdbe5d81925f4d60cdbe4fa11e", "EsteriaDrakonidCoverage.bin": "9cdc227f08329e1245d2b864a996e7a772c96ecdbe5d81925f4d60cdbe4fa11e",
"EsteriaDrakonidTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605", "EsteriaDrakonidTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaEarthen.bin": "8a0db93ba2d5c756b44ed84f2f7bc7c15eef13be6a7d87baf1383c6c0c624e02", "EsteriaEarthen.bin": "8a0db93ba2d5c756b44ed84f2f7bc7c15eef13be6a7d87baf1383c6c0c624e02",
"EsteriaEthereal.bin": "ada3b7588511a847dd5154d91e3041e9f7f193998b06bfede5e0afc32570b48c",
"EsteriaEtherealTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaFaceless.bin": "1c5a1d7a6b1db6984a8e41bc4804e9f7c50d65dcdbb8c0a9d1a9e8af8c91bd8f",
"EsteriaFacelessTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaGnoll.bin": "cfacc8e681bb8e54a4f01ee9c12a91bf0bd23a23527bb548d4dc21ec1b33eea2", "EsteriaGnoll.bin": "cfacc8e681bb8e54a4f01ee9c12a91bf0bd23a23527bb548d4dc21ec1b33eea2",
"EsteriaGnollTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605", "EsteriaGnollTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaHaranir.bin": "59f31d00e372fd2646e1cf0d9d3d5d671b31edd60ff7b862f8d1ce7e53ba1f2f", "EsteriaHaranir.bin": "59f31d00e372fd2646e1cf0d9d3d5d671b31edd60ff7b862f8d1ce7e53ba1f2f",
"EsteriaHaranirTextures.bin": "99948ca570be2d376f0c67e3b8088739b6fa9f9d2c73985e19f68df77689a229", "EsteriaHaranirTextures.bin": "99948ca570be2d376f0c67e3b8088739b6fa9f9d2c73985e19f68df77689a229",
"EsteriaHighmountain.bin": "e83349252ad2687ac23fcfc5623db7401cf32e5faf47a5a7be20c2f94b014938", "EsteriaHighmountain.bin": "e83349252ad2687ac23fcfc5623db7401cf32e5faf47a5a7be20c2f94b014938",
"EsteriaHozen.bin": "739bc3775388976f5c09bcbf3a98b62d804dff78d545e25a41d07dd99b5fddc5",
"EsteriaHozenTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaKvItems.bin": "fc5f9d86114234b38dbb0e14a6a5ec16249eaa92a73411a7fc371a950549dcce",
"EsteriaKvSkins.bin": "60b2b899f5f83137368514928f92f3b04c0fae058f534c487ddbe913ee4bec18",
"EsteriaKyrian.bin": "9329147f08805ff4003f9e062fea7c6ea8fdd8c4d6a40de63a6d228ebe1b7c9a",
"EsteriaKyrianTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaMantid.bin": "71536dee6c2abd0b0e13f33bc73cad7e6fb1b0fc1f6912a95c55d57bc7ee1787",
"EsteriaMantidTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaNaga.bin": "e87547cff5d09500c294f8b06935d134cdd0bbb962e294a72de09404505bd8b3", "EsteriaNaga.bin": "e87547cff5d09500c294f8b06935d134cdd0bbb962e294a72de09404505bd8b3",
"EsteriaNagaTextures.bin": "57ec560f99c1d48ac1e8f6a797c156513b99e7d349e3071afe405f812d159ae3", "EsteriaNagaTextures.bin": "57ec560f99c1d48ac1e8f6a797c156513b99e7d349e3071afe405f812d159ae3",
"EsteriaSaberon.bin": "7735c9325c807c5125760d87f323d6b7d4162fb542c1d8b5f435ea2d6b9a4daa", "EsteriaSaberon.bin": "7735c9325c807c5125760d87f323d6b7d4162fb542c1d8b5f435ea2d6b9a4daa",
@@ -51,18 +86,26 @@
"EsteriaSaberonTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605", "EsteriaSaberonTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaSethrak.bin": "bd14857a8c11fdf8027128763293701586b2102f9a6539d33a727014789fd606", "EsteriaSethrak.bin": "bd14857a8c11fdf8027128763293701586b2102f9a6539d33a727014789fd606",
"EsteriaSethrakTextures.bin": "d2b2cf58087a391f00198008fe871edd400ddf28d54a3a05674df74c5198528a", "EsteriaSethrakTextures.bin": "d2b2cf58087a391f00198008fe871edd400ddf28d54a3a05674df74c5198528a",
"EsteriaSlime.bin": "491e942ceb6abda83c0249afebae7c9c43af3897b35e45fa33d6f9177ecbc177",
"EsteriaSlimeTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaTarasek.bin": "f718444d5ec36f7aff018883486ae1981151fe6e01f5b7781d68d74e9fadfa47", "EsteriaTarasek.bin": "f718444d5ec36f7aff018883486ae1981151fe6e01f5b7781d68d74e9fadfa47",
"EsteriaTarasekTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605", "EsteriaTarasekTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaThinHuman.bin": "75794d192ea0c228b3da7bf7d0bdff1119f79d3f9bfef6650cd5e1a2b5d106eb", "EsteriaThinHuman.bin": "bc12e5ca2c087ca0a8642ff6cd8e78fe2e1f85928518b12c19b4245a8320585d",
"EsteriaThinHumanTextures.bin": "02aeb4c05893d06125b8b58fdb7c2a56fe3d66a7d094706a44b43cb503d1731e", "EsteriaThinHumanTextures.bin": "27488a7494fa9733b53118d1d0f4acef50a9e19004f81f9c8a614b10f4c3fd5e",
"EsteriaTuskarr.bin": "ecbe7ef490ba67eca029a57639192db61238522618491549766fe38529914387", "EsteriaTuskarr.bin": "ecbe7ef490ba67eca029a57639192db61238522618491549766fe38529914387",
"EsteriaTuskarrTextures.bin": "e2116c2c83adea079126fd5da765d20da24f044d4f161c4124e4368cb3d6bc71", "EsteriaTuskarrTextures.bin": "e2116c2c83adea079126fd5da765d20da24f044d4f161c4124e4368cb3d6bc71",
"EsteriaVenthyr.bin": "5bcf7804363e59b3c922830d06de17bbd348b9967307f39b7d72bc09f58814eb",
"EsteriaVenthyrTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaVorkai.bin": "d6d2088c7e867b5db437e9afc2d323c22d830c6f84a3598415eedcaa27e2461f",
"EsteriaVorkaiTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaVrykul.bin": "39e2b7b4c67997dbbd34bae840bd606a59290f7f2fc82565a0ba00090335415c", "EsteriaVrykul.bin": "39e2b7b4c67997dbbd34bae840bd606a59290f7f2fc82565a0ba00090335415c",
"EsteriaVrykulTextures.bin": "46098750a0e235724c6e9cc8d9d4e26550aa47bef95fd5f0f82efe5e945bf296", "EsteriaVrykulTextures.bin": "46098750a0e235724c6e9cc8d9d4e26550aa47bef95fd5f0f82efe5e945bf296",
"EsteriaVulpera.bin": "c5434993b9af4a17d881965e4735cd2ac379e39c7142aac9844adff9528562d4", "EsteriaVulpera.bin": "c5434993b9af4a17d881965e4735cd2ac379e39c7142aac9844adff9528562d4",
"EsteriaVulperaTextures.bin": "1ab844e74684aced2b069f1b91cd563aade45e05bd5e23f866a6c0c301cb098e", "EsteriaVulperaTextures.bin": "1ab844e74684aced2b069f1b91cd563aade45e05bd5e23f866a6c0c301cb098e",
"Interface/AddOns/CoAHideArmor/CoAHideArmor.lua": "8c1c7403524fc9bd56c0809b4101b141da700ba163701209bf1420f2ef106aa7", "Interface/AddOns/CoAHideArmor/CoAHideArmor.lua": "8c1c7403524fc9bd56c0809b4101b141da700ba163701209bf1420f2ef106aa7",
"Interface/AddOns/CoAHideArmor/CoAHideArmor.toc": "123580d92fd5ceee258e96296f42c359b7e83cdff151af49c50c6c4e2059677c", "Interface/AddOns/CoAHideArmor/CoAHideArmor.toc": "123580d92fd5ceee258e96296f42c359b7e83cdff151af49c50c6c4e2059677c",
"Interface/AddOns/CoAQuestSafe/CoAQuestSafe.lua": "062de55c91228971553f482fd2c8753f4752993b4e8e49d4ded04fa18b98bde7",
"Interface/AddOns/CoAQuestSafe/CoAQuestSafe.toc": "890bb9d1087e236f4823603f5df3ab0e316dbb65c28feebbda08fb0ab53a408f",
"Interface/AddOns/CoAWC2Cursor/CoAWC2Cursor.lua": "1cf9537ff5f10b77250fea4407aea1008da690afe102ed6ed2dac21f79638cfa", "Interface/AddOns/CoAWC2Cursor/CoAWC2Cursor.lua": "1cf9537ff5f10b77250fea4407aea1008da690afe102ed6ed2dac21f79638cfa",
"Interface/AddOns/CoAWC2Cursor/CoAWC2Cursor.toc": "48ce695dce712b3643ebe13a77e318d623c964acc69479b8fc8cc675099801bf", "Interface/AddOns/CoAWC2Cursor/CoAWC2Cursor.toc": "48ce695dce712b3643ebe13a77e318d623c964acc69479b8fc8cc675099801bf",
"Interface/AddOns/CoA_TalentReset/CoA_TalentReset.lua": "827d756d5948ef918fafaf8b869290b3a1faa4e4cc21b19b512a00d4509f3d41", "Interface/AddOns/CoA_TalentReset/CoA_TalentReset.lua": "827d756d5948ef918fafaf8b869290b3a1faa4e4cc21b19b512a00d4509f3d41",
@@ -0,0 +1,73 @@
{
"Ascension.exe": "e2c347019d554a59639e5978fd68e50e906973ab313c6573cc56ca82e8e3c547",
"Data/patch-T.MPQ": "fe597138ab7f56881b5f4f27d6dc9d81bb278b483ca0d91b7207ffd4a5ae7bfd",
"Data/patch-ZE1.MPQ": "69d79dbbea54ec0312c37770debc79c7bc9ce2e21eedef99c03cd8d911955283",
"Data/patch-ZE2.MPQ": "1a41cae77ad730e9cf69e8d63fd12ae3a579418bb550d351fff469573a97ac3c",
"Data/patch-ZE3.MPQ": "b587202c21b6f580682b601b7c2e905fbfa766276e74733db55c1bddbffb7f87",
"Data/patch-ZE5.MPQ": "476b5a1fcf69f64fdb281e3b445362b936d016066ccd12f897acfcf200d6c0cf",
"Data/patch-ZE6.MPQ": "762592c9ed950b4a7b6c7d85d45050b30fa3f35d53e348ee1e1516fdbb7e5484",
"Data/patch-ZE7.MPQ": "de54b0189d242763d2872223419a259b6b8a4b380c24b50a2ef9c6fa44466248",
"Data/patch-ZE8.MPQ": "1bc5691fb84a84f3e7a0a70baaa9192a97b4ec5906ee37c85838ffe08adef934",
"Data/patch-ZE9.MPQ": "d49c94463e9548e76378ce2c0454d8f204f0745c8c0de32b6dce7f0b0fd67c4a",
"Data/patch-ZEA.MPQ": "78fd10ec5262ae2417eba9700d2172553bbc1e5cfb0b597aada8f1753ca46d9d",
"Data/patch-ZES.MPQ": "a2d9348f917f745c7aa25b2eed96efa312f7b2d2f62cb86a4f2eaabc2dfa895f",
"Data/patch-ZG.MPQ": "48979e1fda775f8deb47bffa48e0a468595d4c71286fee518f51dc5801c5ca39",
"Data/patch-ZH.MPQ": "5e1d2fe287053abba703d7af381e10096c6525ba477ffed3971c2fc4f93e919c",
"Data/patch-ZHA.MPQ": "0fc6ebeafe1d14192dc64bafc90bde3c49230df1297f98bf65900a3bcf953617",
"Data/patch-ZHM.MPQ": "317d3ae00f0bd674b358af07544976acb7804aa6d8b19d1788ad96030e8c9bf0",
"Data/patch-ZJ.MPQ": "f821e99add86ef68d108c5ec466328c97677d3ed52f7944e200f3fe38c13b4de",
"Data/patch-ZK.MPQ": "444d0ecb72c1e990509d53e3cfa5b7634c816733533e8a97e5d7f5653ee32cce",
"Data/patch-ZM.MPQ": "424ab1978986e854551633983a94bd15beba6328aabea8c02f98eaa32f6f0b61",
"Data/patch-ZVU.MPQ": "c679b85a2e97344395756b54d2cf6abefe4e80e74944cb55b6e573ad17b7d020",
"Data/patch-ZZE.MPQ": "4b1e289e12c82644cb78f50170e6b5fd53918eb2de834f9e0cebddd81873a8bb",
"Data/patch-ZZR.MPQ": "5a7575e592dc0c8a6913e0d946bbe06fa0ca2e4d817ef1f8548d3d13142bcbd3",
"Data/patch-ZZS.MPQ": "533fd69d5784d83e872a5a28d27301dc9ab5d0cb925f8b2116926854e4a0a5b8",
"Data/patch-ZZT.MPQ": "aef3bbe4951333d62fb55224484724fbaa9c35773a19944ffb9935e250cfb59c",
"Data/patch-ZZU.MPQ": "8ee1839415b56d46c6eff7eb4dfbaf6fbafc4c6b29b39380d69f4d827d02a99e",
"Data/patch-ZZV.MPQ": "8d5e61d37008abf70478e5d5f46ec7afb0490b9a643323bd75a1c70cadd63290",
"Data/patch-ZZW.MPQ": "3689c485f8ee8fccaa6dbae1d073bc9231229f9a040f79a272d80a87486d0c33",
"Data/patch-ZZX.MPQ": "4c12608089cfe356f7c8882d66db90239ed3ec8ddd980d91d7a3a488680f3c88",
"Data/patch-ZZZ.MPQ": "566aaadf501af42e29a828b1bc2edbd36d436288fb309fe423bd74b9619bf593",
"Data/patch-ZZZC.MPQ": "691a53f6325c2615a64ced0802f18bc4d96e99c62aaa606fc930f9406ee74cdf",
"Data/patch-ZZZD.MPQ": "e4ce9d8b363eb609d0d6d92627eb53454fa2e03e4dbc1795b3573a22b7d009c8",
"EsteriaAppearance.bin": "90d9cfaeaf6de10f014f1d1610ea10453ec9b240255759aea99513cac488a3ec",
"EsteriaAppearance.dll": "196a82f24dd287653e2b2fc4d12bfc796f8ee3f6687ca8308905a5ab528a51a9",
"EsteriaAppearanceGeometry.bin": "19de5b4b4f79778ea5316659efc2f66c6edb6b5149c46efa47c46bfa4ec6904c",
"EsteriaAppearanceMaterials.bin": "f72f027f54a55c05aa0f76b457b97b484fe0e1aedc0e068cc0e0ca53e1878cba",
"EsteriaCosmeticWings.bin": "57352c28459d073a29b3014d33b70f3b3756afa37fa9583ef6b30d503422ac3f",
"EsteriaDrakonid.bin": "95440ee9c065ef20bb7fed6158d20623d68745291cedc2726fc746ff54601f95",
"EsteriaDrakonidCoverage.bin": "9cdc227f08329e1245d2b864a996e7a772c96ecdbe5d81925f4d60cdbe4fa11e",
"EsteriaDrakonidTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaEarthen.bin": "8a0db93ba2d5c756b44ed84f2f7bc7c15eef13be6a7d87baf1383c6c0c624e02",
"EsteriaGnoll.bin": "cfacc8e681bb8e54a4f01ee9c12a91bf0bd23a23527bb548d4dc21ec1b33eea2",
"EsteriaGnollTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaHaranir.bin": "59f31d00e372fd2646e1cf0d9d3d5d671b31edd60ff7b862f8d1ce7e53ba1f2f",
"EsteriaHaranirTextures.bin": "99948ca570be2d376f0c67e3b8088739b6fa9f9d2c73985e19f68df77689a229",
"EsteriaHighmountain.bin": "e83349252ad2687ac23fcfc5623db7401cf32e5faf47a5a7be20c2f94b014938",
"EsteriaNaga.bin": "e87547cff5d09500c294f8b06935d134cdd0bbb962e294a72de09404505bd8b3",
"EsteriaNagaTextures.bin": "57ec560f99c1d48ac1e8f6a797c156513b99e7d349e3071afe405f812d159ae3",
"EsteriaSaberon.bin": "7735c9325c807c5125760d87f323d6b7d4162fb542c1d8b5f435ea2d6b9a4daa",
"EsteriaSaberonCoverage.bin": "9cdc227f08329e1245d2b864a996e7a772c96ecdbe5d81925f4d60cdbe4fa11e",
"EsteriaSaberonTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaSethrak.bin": "bd14857a8c11fdf8027128763293701586b2102f9a6539d33a727014789fd606",
"EsteriaSethrakTextures.bin": "d2b2cf58087a391f00198008fe871edd400ddf28d54a3a05674df74c5198528a",
"EsteriaTarasek.bin": "f718444d5ec36f7aff018883486ae1981151fe6e01f5b7781d68d74e9fadfa47",
"EsteriaTarasekTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaThinHuman.bin": "75794d192ea0c228b3da7bf7d0bdff1119f79d3f9bfef6650cd5e1a2b5d106eb",
"EsteriaThinHumanTextures.bin": "02aeb4c05893d06125b8b58fdb7c2a56fe3d66a7d094706a44b43cb503d1731e",
"EsteriaTuskarr.bin": "ecbe7ef490ba67eca029a57639192db61238522618491549766fe38529914387",
"EsteriaTuskarrTextures.bin": "e2116c2c83adea079126fd5da765d20da24f044d4f161c4124e4368cb3d6bc71",
"EsteriaVrykul.bin": "39e2b7b4c67997dbbd34bae840bd606a59290f7f2fc82565a0ba00090335415c",
"EsteriaVrykulTextures.bin": "46098750a0e235724c6e9cc8d9d4e26550aa47bef95fd5f0f82efe5e945bf296",
"EsteriaVulpera.bin": "c5434993b9af4a17d881965e4735cd2ac379e39c7142aac9844adff9528562d4",
"EsteriaVulperaTextures.bin": "1ab844e74684aced2b069f1b91cd563aade45e05bd5e23f866a6c0c301cb098e",
"Interface/AddOns/CoAHideArmor/CoAHideArmor.lua": "8c1c7403524fc9bd56c0809b4101b141da700ba163701209bf1420f2ef106aa7",
"Interface/AddOns/CoAHideArmor/CoAHideArmor.toc": "123580d92fd5ceee258e96296f42c359b7e83cdff151af49c50c6c4e2059677c",
"Interface/AddOns/CoAWC2Cursor/CoAWC2Cursor.lua": "1cf9537ff5f10b77250fea4407aea1008da690afe102ed6ed2dac21f79638cfa",
"Interface/AddOns/CoAWC2Cursor/CoAWC2Cursor.toc": "48ce695dce712b3643ebe13a77e318d623c964acc69479b8fc8cc675099801bf",
"Interface/AddOns/CoA_TalentReset/CoA_TalentReset.lua": "827d756d5948ef918fafaf8b869290b3a1faa4e4cc21b19b512a00d4509f3d41",
"Interface/AddOns/CoA_TalentReset/CoA_TalentReset.toc": "16298c04af68e68d6445e7a11f42aee525dd4145f85d2771ff434fb7c6e95a85",
"dinput8.dll": "f8de78606c241fb3911dce22faf68f5b9f9885b142b183c1e2c09ddc8f7e380c",
"wc2_human.cur": "f609736e29596bb386ef1597b157d211e01a86d32c2a929e256c581c37d71791",
"wc2_orc.cur": "baa512c9b9045762ba35b6e0d35b8f79c54b7649f35cc9c0e0cc8c168a1e5a97"
}
@@ -0,0 +1,114 @@
{
"Ascension.exe": "e2c347019d554a59639e5978fd68e50e906973ab313c6573cc56ca82e8e3c547",
"Data/Retail/Assets/EquipmentFitting/1068-1.bin": "332d2c38b037a118f262bbb3096a01ebfb33c5347e96bbfb64157437b300281b",
"Data/Retail/Assets/EquipmentFitting/60-0.bin": "ffbf6efc9ea09b0c442f048c5bc7b4c5975258045cfddedd9a77a93363312b5e",
"Data/Retail/Assets/EquipmentFitting/60-1.bin": "36ceed2a55756f3322e018938809acea5124351161405058ef27d100173778da",
"Data/Retail/Assets/EquipmentFitting/61-0.bin": "3b302a4055d1e795c451b02e38dfe8007527ee1bc5f926ebcd6ef17f433cd232",
"Data/Retail/Assets/EquipmentFitting/61-1.bin": "c42df399ed99be3c7ce1b5fdb95a873711011713a4cd867bc226a14b1ce0e8ca",
"Data/Retail/Assets/EquipmentFitting/65-0.bin": "8ce3f884ae197d14dff0f955c2cf05abb716742c8aff79f7af1cec5cf7225f04",
"Data/Retail/Assets/EquipmentFitting/68-0.bin": "f1d878f0f943cbdb8025af8daac4a38c1d1e159bd961d9d76f225931c11648ac",
"Data/Retail/Assets/EquipmentFitting/68-1.bin": "2ccbae634384200340c0cc3dca36a7a014a8ddad110598e4470ff1b266576465",
"Data/Retail/Assets/EquipmentFitting/73-0.bin": "5530882678f677ad47987ce906e851338a35f7d9737e3f9d829938027b8af67f",
"Data/Retail/Assets/EquipmentFitting/74-0.bin": "53a7be86b3bfdd6995406c706df3ca091484206d8141cebb39113c714500384a",
"Data/Retail/Assets/EquipmentFitting/74-1.bin": "e688c55a355231978d42480a003c26d379460f5931c2469c119ecb073ea153e1",
"Data/Retail/Assets/EquipmentFitting/75-0.bin": "289abc71c6df0e031a64d62a40e658eaefd37e45373a062ca52f08fbe803500c",
"Data/Retail/Assets/EquipmentFitting/76-0.bin": "63a493e70b91f59ff49f1942d959df986062bd267fe2ba589f344963df771021",
"Data/Retail/Assets/EquipmentFitting/77-0.bin": "b1366ce0dc4f31cb8c8c9705be2da565df4b905224af04b6b88f8c8e9c87e3c9",
"Data/Retail/Assets/EquipmentFitting/78-0.bin": "7b0031fb12ab19020005bdccacca2dd3991349c36949a58b035992585b4134db",
"Data/patch-T.MPQ": "fe597138ab7f56881b5f4f27d6dc9d81bb278b483ca0d91b7207ffd4a5ae7bfd",
"Data/patch-ZE1.MPQ": "69d79dbbea54ec0312c37770debc79c7bc9ce2e21eedef99c03cd8d911955283",
"Data/patch-ZE2.MPQ": "1a41cae77ad730e9cf69e8d63fd12ae3a579418bb550d351fff469573a97ac3c",
"Data/patch-ZE3.MPQ": "b587202c21b6f580682b601b7c2e905fbfa766276e74733db55c1bddbffb7f87",
"Data/patch-ZE5.MPQ": "476b5a1fcf69f64fdb281e3b445362b936d016066ccd12f897acfcf200d6c0cf",
"Data/patch-ZE6.MPQ": "762592c9ed950b4a7b6c7d85d45050b30fa3f35d53e348ee1e1516fdbb7e5484",
"Data/patch-ZE7.MPQ": "de54b0189d242763d2872223419a259b6b8a4b380c24b50a2ef9c6fa44466248",
"Data/patch-ZE8.MPQ": "1bc5691fb84a84f3e7a0a70baaa9192a97b4ec5906ee37c85838ffe08adef934",
"Data/patch-ZE9.MPQ": "d49c94463e9548e76378ce2c0454d8f204f0745c8c0de32b6dce7f0b0fd67c4a",
"Data/patch-ZEA.MPQ": "78fd10ec5262ae2417eba9700d2172553bbc1e5cfb0b597aada8f1753ca46d9d",
"Data/patch-ZES.MPQ": "a2d9348f917f745c7aa25b2eed96efa312f7b2d2f62cb86a4f2eaabc2dfa895f",
"Data/patch-ZG.MPQ": "48979e1fda775f8deb47bffa48e0a468595d4c71286fee518f51dc5801c5ca39",
"Data/patch-ZH.MPQ": "5e1d2fe287053abba703d7af381e10096c6525ba477ffed3971c2fc4f93e919c",
"Data/patch-ZHA.MPQ": "0fc6ebeafe1d14192dc64bafc90bde3c49230df1297f98bf65900a3bcf953617",
"Data/patch-ZHM.MPQ": "317d3ae00f0bd674b358af07544976acb7804aa6d8b19d1788ad96030e8c9bf0",
"Data/patch-ZJ.MPQ": "f821e99add86ef68d108c5ec466328c97677d3ed52f7944e200f3fe38c13b4de",
"Data/patch-ZK.MPQ": "444d0ecb72c1e990509d53e3cfa5b7634c816733533e8a97e5d7f5653ee32cce",
"Data/patch-ZM.MPQ": "424ab1978986e854551633983a94bd15beba6328aabea8c02f98eaa32f6f0b61",
"Data/patch-ZVU.MPQ": "c679b85a2e97344395756b54d2cf6abefe4e80e74944cb55b6e573ad17b7d020",
"Data/patch-ZZE.MPQ": "4b1e289e12c82644cb78f50170e6b5fd53918eb2de834f9e0cebddd81873a8bb",
"Data/patch-ZZR.MPQ": "5a7575e592dc0c8a6913e0d946bbe06fa0ca2e4d817ef1f8548d3d13142bcbd3",
"Data/patch-ZZS.MPQ": "533fd69d5784d83e872a5a28d27301dc9ab5d0cb925f8b2116926854e4a0a5b8",
"Data/patch-ZZT.MPQ": "e60dab63fe5650fdf5f0846ea6d4136219293bcfdad46d9b796697faeff9ab4c",
"Data/patch-ZZU.MPQ": "0311de8f034eae7dec1bd2c92b1fe6c741cbaf53da62c7609cd12b6c37908e47",
"Data/patch-ZZV.MPQ": "3b04008905e7185d165827d68f7ca228dda8272816364f7d71874ecc83b64f0e",
"Data/patch-ZZW.MPQ": "3bbbc72901fd2d662113036485c380701e693f5a39ba9479af306bf2fa2030bd",
"Data/patch-ZZX.MPQ": "4c12608089cfe356f7c8882d66db90239ed3ec8ddd980d91d7a3a488680f3c88",
"Data/patch-ZZZ.MPQ": "566aaadf501af42e29a828b1bc2edbd36d436288fb309fe423bd74b9619bf593",
"Data/patch-ZZZA.MPQ": "57ccbdc0a66000767554ffd194088df6d602ddd8341a141bca8201e7d5435889",
"Data/patch-ZZZC.MPQ": "691a53f6325c2615a64ced0802f18bc4d96e99c62aaa606fc930f9406ee74cdf",
"Data/patch-ZZZD.MPQ": "ca893cf8129f6fd442a63f0697a8ddea88546e3ce71bde713be2cc832b892bc9",
"Data/patch-ZZZE.MPQ": "2e245ee0fe3b913087eed399062fda5843d98b04afac38024f7c64ac3bf43e18",
"Data/patch-ZZZF.MPQ": "0e0dd0b46e5308756af779803259e2ba6c99920a01b62a01505b268c20a15bbe",
"Data/patch-ZZZZ.MPQ": "ae27e2f203755c8a74f21cabf8d3ebafd076b53452b1eb9d894fa1ce9837d0ea",
"EsteriaAppearance.bin": "90d9cfaeaf6de10f014f1d1610ea10453ec9b240255759aea99513cac488a3ec",
"EsteriaAppearance.dll": "88e268d3be9eca3b0644f543d823f4bdcc04a9700a6e8ed73fd2a1260ad191af",
"EsteriaAppearanceGeometry.bin": "19de5b4b4f79778ea5316659efc2f66c6edb6b5149c46efa47c46bfa4ec6904c",
"EsteriaAppearanceMaterials.bin": "f72f027f54a55c05aa0f76b457b97b484fe0e1aedc0e068cc0e0ca53e1878cba",
"EsteriaBanshee.bin": "d3fe66caa6a0ecba96bddb07ac1cbdb915694e87fc1608da0fdabecdf9ffea4d",
"EsteriaBansheeTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaCentaur.bin": "d63f0b7d21cee67d234d134e832fe6d55c398f2b63f9f6c191dcfa9671637185",
"EsteriaCentaurTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaCosmeticWings.bin": "57352c28459d073a29b3014d33b70f3b3756afa37fa9583ef6b30d503422ac3f",
"EsteriaDrakonid.bin": "95440ee9c065ef20bb7fed6158d20623d68745291cedc2726fc746ff54601f95",
"EsteriaDrakonidCoverage.bin": "9cdc227f08329e1245d2b864a996e7a772c96ecdbe5d81925f4d60cdbe4fa11e",
"EsteriaDrakonidTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaEarthen.bin": "8a0db93ba2d5c756b44ed84f2f7bc7c15eef13be6a7d87baf1383c6c0c624e02",
"EsteriaEthereal.bin": "ada3b7588511a847dd5154d91e3041e9f7f193998b06bfede5e0afc32570b48c",
"EsteriaEtherealTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaFaceless.bin": "1c5a1d7a6b1db6984a8e41bc4804e9f7c50d65dcdbb8c0a9d1a9e8af8c91bd8f",
"EsteriaFacelessTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaGnoll.bin": "cfacc8e681bb8e54a4f01ee9c12a91bf0bd23a23527bb548d4dc21ec1b33eea2",
"EsteriaGnollTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaHaranir.bin": "59f31d00e372fd2646e1cf0d9d3d5d671b31edd60ff7b862f8d1ce7e53ba1f2f",
"EsteriaHaranirTextures.bin": "99948ca570be2d376f0c67e3b8088739b6fa9f9d2c73985e19f68df77689a229",
"EsteriaHighmountain.bin": "e83349252ad2687ac23fcfc5623db7401cf32e5faf47a5a7be20c2f94b014938",
"EsteriaHozen.bin": "739bc3775388976f5c09bcbf3a98b62d804dff78d545e25a41d07dd99b5fddc5",
"EsteriaHozenTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaKvItems.bin": "fc5f9d86114234b38dbb0e14a6a5ec16249eaa92a73411a7fc371a950549dcce",
"EsteriaKvSkins.bin": "60b2b899f5f83137368514928f92f3b04c0fae058f534c487ddbe913ee4bec18",
"EsteriaKyrian.bin": "9329147f08805ff4003f9e062fea7c6ea8fdd8c4d6a40de63a6d228ebe1b7c9a",
"EsteriaKyrianTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaMantid.bin": "71536dee6c2abd0b0e13f33bc73cad7e6fb1b0fc1f6912a95c55d57bc7ee1787",
"EsteriaMantidTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaNaga.bin": "e87547cff5d09500c294f8b06935d134cdd0bbb962e294a72de09404505bd8b3",
"EsteriaNagaTextures.bin": "57ec560f99c1d48ac1e8f6a797c156513b99e7d349e3071afe405f812d159ae3",
"EsteriaSaberon.bin": "7735c9325c807c5125760d87f323d6b7d4162fb542c1d8b5f435ea2d6b9a4daa",
"EsteriaSaberonCoverage.bin": "9cdc227f08329e1245d2b864a996e7a772c96ecdbe5d81925f4d60cdbe4fa11e",
"EsteriaSaberonTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaSethrak.bin": "bd14857a8c11fdf8027128763293701586b2102f9a6539d33a727014789fd606",
"EsteriaSethrakTextures.bin": "d2b2cf58087a391f00198008fe871edd400ddf28d54a3a05674df74c5198528a",
"EsteriaSlime.bin": "491e942ceb6abda83c0249afebae7c9c43af3897b35e45fa33d6f9177ecbc177",
"EsteriaSlimeTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaTarasek.bin": "f718444d5ec36f7aff018883486ae1981151fe6e01f5b7781d68d74e9fadfa47",
"EsteriaTarasekTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaThinHuman.bin": "bc12e5ca2c087ca0a8642ff6cd8e78fe2e1f85928518b12c19b4245a8320585d",
"EsteriaThinHumanTextures.bin": "27488a7494fa9733b53118d1d0f4acef50a9e19004f81f9c8a614b10f4c3fd5e",
"EsteriaTuskarr.bin": "ecbe7ef490ba67eca029a57639192db61238522618491549766fe38529914387",
"EsteriaTuskarrTextures.bin": "e2116c2c83adea079126fd5da765d20da24f044d4f161c4124e4368cb3d6bc71",
"EsteriaVenthyr.bin": "5bcf7804363e59b3c922830d06de17bbd348b9967307f39b7d72bc09f58814eb",
"EsteriaVenthyrTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaVorkai.bin": "d6d2088c7e867b5db437e9afc2d323c22d830c6f84a3598415eedcaa27e2461f",
"EsteriaVorkaiTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaVrykul.bin": "39e2b7b4c67997dbbd34bae840bd606a59290f7f2fc82565a0ba00090335415c",
"EsteriaVrykulTextures.bin": "46098750a0e235724c6e9cc8d9d4e26550aa47bef95fd5f0f82efe5e945bf296",
"EsteriaVulpera.bin": "c5434993b9af4a17d881965e4735cd2ac379e39c7142aac9844adff9528562d4",
"EsteriaVulperaTextures.bin": "1ab844e74684aced2b069f1b91cd563aade45e05bd5e23f866a6c0c301cb098e",
"Interface/AddOns/CoAHideArmor/CoAHideArmor.lua": "8c1c7403524fc9bd56c0809b4101b141da700ba163701209bf1420f2ef106aa7",
"Interface/AddOns/CoAHideArmor/CoAHideArmor.toc": "123580d92fd5ceee258e96296f42c359b7e83cdff151af49c50c6c4e2059677c",
"Interface/AddOns/CoAWC2Cursor/CoAWC2Cursor.lua": "1cf9537ff5f10b77250fea4407aea1008da690afe102ed6ed2dac21f79638cfa",
"Interface/AddOns/CoAWC2Cursor/CoAWC2Cursor.toc": "48ce695dce712b3643ebe13a77e318d623c964acc69479b8fc8cc675099801bf",
"Interface/AddOns/CoA_TalentReset/CoA_TalentReset.lua": "827d756d5948ef918fafaf8b869290b3a1faa4e4cc21b19b512a00d4509f3d41",
"Interface/AddOns/CoA_TalentReset/CoA_TalentReset.toc": "16298c04af68e68d6445e7a11f42aee525dd4145f85d2771ff434fb7c6e95a85",
"dinput8.dll": "f8de78606c241fb3911dce22faf68f5b9f9885b142b183c1e2c09ddc8f7e380c",
"wc2_human.cur": "f609736e29596bb386ef1597b157d211e01a86d32c2a929e256c581c37d71791",
"wc2_orc.cur": "baa512c9b9045762ba35b6e0d35b8f79c54b7649f35cc9c0e0cc8c168a1e5a97"
}
+42 -17
View File
@@ -113,11 +113,23 @@ pub const SCHEMAS: [(&str, &str); 3] = [
]; ];
pub fn schema_of(kind: &str) -> Result<&'static str> { pub fn schema_of(kind: &str) -> Result<&'static str> {
if kind == "playerbots" { return Ok("acore_playerbots"); } if kind == "playerbots" {
if let Some(kind) = kind.strip_prefix("wildcard-") { return crate::realms::Mode::Wildcard.schema(kind); } return Ok("acore_playerbots");
if let Some(kind) = kind.strip_prefix("reborn-") { return crate::realms::Mode::Reborn.schema(kind); } }
if let Some(kind) = kind.strip_prefix("coa-") { return crate::realms::Mode::Coa.schema(kind); } if let Some(kind) = kind.strip_prefix("wildcard-") {
SCHEMAS.iter().find(|(k, _)| *k == kind).map(|(_, s)| *s).ok_or_else(|| Error::Invalid(format!("unknown database {kind}"))) return crate::realms::Mode::Wildcard.schema(kind);
}
if let Some(kind) = kind.strip_prefix("reborn-") {
return crate::realms::Mode::Reborn.schema(kind);
}
if let Some(kind) = kind.strip_prefix("coa-") {
return crate::realms::Mode::Coa.schema(kind);
}
SCHEMAS
.iter()
.find(|(k, _)| *k == kind)
.map(|(_, s)| *s)
.ok_or_else(|| Error::Invalid(format!("unknown database {kind}")))
} }
fn ident_ok(name: &str) -> bool { fn ident_ok(name: &str) -> bool {
@@ -411,9 +423,11 @@ impl Db {
pub fn recovery_objects(&self, schema: &str) -> Result<Vec<serde_json::Value>> { pub fn recovery_objects(&self, schema: &str) -> Result<Vec<serde_json::Value>> {
let schema = self.realm_schema(schema); let schema = self.realm_schema(schema);
if !ident_ok(schema) { return Err(Error::Invalid("bad schema name".into())); } if !ident_ok(schema) {
return Err(Error::Invalid("bad schema name".into()));
}
let sql = format!("SELECT routine_type,HEX(routine_name) FROM information_schema.routines WHERE routine_schema='{schema}' UNION ALL SELECT 'TRIGGER',HEX(trigger_name) FROM information_schema.triggers WHERE trigger_schema='{schema}' UNION ALL SELECT 'VIEW',HEX(table_name) FROM information_schema.views WHERE table_schema='{schema}' ORDER BY 1,2;"); let sql = format!("SELECT routine_type,HEX(routine_name) FROM information_schema.routines WHERE routine_schema='{schema}' UNION ALL SELECT 'TRIGGER',HEX(trigger_name) FROM information_schema.triggers WHERE trigger_schema='{schema}' UNION ALL SELECT 'VIEW',HEX(table_name) FROM information_schema.views WHERE table_schema='{schema}' ORDER BY 1,2;");
parse_recovery_objects(&schema, &self.query(&sql)?) parse_recovery_objects(schema, &self.query(&sql)?)
} }
/// Consistent dump of one schema, zstd-compressed to `out`. Returns (compressed bytes, sha256 of the file). /// Consistent dump of one schema, zstd-compressed to `out`. Returns (compressed bytes, sha256 of the file).
@@ -523,15 +537,23 @@ impl Db {
} }
fn parse_recovery_objects(schema: &str, text: &str) -> Result<Vec<serde_json::Value>> { fn parse_recovery_objects(schema: &str, text: &str) -> Result<Vec<serde_json::Value>> {
text.lines().filter(|line| !line.is_empty()).map(|line| { text.lines()
let (kind, name) = line.split_once('\t').ok_or_else(|| Error::Invalid("unexpected database object reply".into()))?; .filter(|line| !line.is_empty())
if !matches!(kind, "PROCEDURE" | "FUNCTION" | "TRIGGER" | "VIEW") { .map(|line| {
return Err(Error::Invalid("unexpected database object type".into())); let (kind, name) = line
} .split_once('\t')
let name = hex::decode(name).ok().and_then(|bytes| String::from_utf8(bytes).ok()) .ok_or_else(|| Error::Invalid("unexpected database object reply".into()))?;
.filter(|name| !name.is_empty()).ok_or_else(|| Error::Invalid("unexpected database object name".into()))?; if !matches!(kind, "PROCEDURE" | "FUNCTION" | "TRIGGER" | "VIEW") {
Ok(serde_json::json!({ "database": schema, "kind": kind, "name": name })) return Err(Error::Invalid("unexpected database object type".into()));
}).collect() }
let name = hex::decode(name)
.ok()
.and_then(|bytes| String::from_utf8(bytes).ok())
.filter(|name| !name.is_empty())
.ok_or_else(|| Error::Invalid("unexpected database object name".into()))?;
Ok(serde_json::json!({ "database": schema, "kind": kind, "name": name }))
})
.collect()
} }
/// Name of the service account the Manager uses for the server console (RA). Accounts are stored upper-case. /// Name of the service account the Manager uses for the server console (RA). Accounts are stored upper-case.
@@ -738,7 +760,10 @@ mod tests {
use crate::realms::Mode; use crate::realms::Mode;
let sql = "SELECT * FROM `acore_characters`.characters WHERE name='acore_world'; -- acore_world\nSELECT * FROM acore_world.items; SELECT * FROM acore_world_wildcard.items;"; let sql = "SELECT * FROM `acore_characters`.characters WHERE name='acore_world'; -- acore_world\nSELECT * FROM acore_world.items; SELECT * FROM acore_world_wildcard.items;";
assert_eq!(super::route_sql(sql, Mode::Reborn), "SELECT * FROM `acore_characters_reborn`.characters WHERE name='acore_world'; -- acore_world\nSELECT * FROM acore_world_reborn.items; SELECT * FROM acore_world_wildcard.items;"); assert_eq!(super::route_sql(sql, Mode::Reborn), "SELECT * FROM `acore_characters_reborn`.characters WHERE name='acore_world'; -- acore_world\nSELECT * FROM acore_world_reborn.items; SELECT * FROM acore_world_wildcard.items;");
assert_eq!(super::schema_of("reborn-characters").unwrap(), "acore_characters_reborn"); assert_eq!(
super::schema_of("reborn-characters").unwrap(),
"acore_characters_reborn"
);
assert_eq!(super::schema_of("reborn-auth").unwrap(), "acore_auth"); assert_eq!(super::schema_of("reborn-auth").unwrap(), "acore_auth");
} }
use super::*; use super::*;
+6 -1
View File
@@ -1045,7 +1045,12 @@ real error
fn stop_diagnostics_survive_while_portable_pins_remain_hidden() { fn stop_diagnostics_survive_while_portable_pins_remain_hidden() {
let ordinary = "MySQL is still stopping; wait before copying the repack."; let ordinary = "MySQL is still stopping; wait before copying the repack.";
assert_eq!(redact(ordinary), ordinary); assert_eq!(redact(ordinary), ordinary);
for secret in ["PIN: 123456", "pin=123456", "transfer_pin=123456", "PIN123456"] { for secret in [
"PIN: 123456",
"pin=123456",
"transfer_pin=123456",
"PIN123456",
] {
let output = redact(&format!("{ordinary}\n{secret}")); let output = redact(&format!("{ordinary}\n{secret}"));
assert!(output.contains(ordinary)); assert!(output.contains(ordinary));
assert!(!output.contains("123456")); assert!(!output.contains("123456"));
+20 -5
View File
@@ -1249,12 +1249,27 @@ mod tests {
"db;3306;acore;apppw;acore_characters" "db;3306;acore;apppw;acore_characters"
); );
let wild = database_env(&s, true, crate::realms::Mode::Wildcard); let wild = database_env(&s, true, crate::realms::Mode::Wildcard);
assert_eq!(get(&wild, "AC_WORLD_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_world_wildcard"); assert_eq!(
assert_eq!(get(&wild, "AC_CHARACTER_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_characters_wildcard"); get(&wild, "AC_WORLD_DATABASE_INFO").unwrap(),
"db;3306;acore;apppw;acore_world_wildcard"
);
assert_eq!(
get(&wild, "AC_CHARACTER_DATABASE_INFO").unwrap(),
"db;3306;acore;apppw;acore_characters_wildcard"
);
let reborn = database_env(&s, true, crate::realms::Mode::Reborn); let reborn = database_env(&s, true, crate::realms::Mode::Reborn);
assert_eq!(get(&reborn, "AC_WORLD_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_world_reborn"); assert_eq!(
assert_eq!(get(&reborn, "AC_CHARACTER_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_characters_reborn"); get(&reborn, "AC_WORLD_DATABASE_INFO").unwrap(),
assert_eq!(get(&reborn, "AC_LOGIN_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_auth"); "db;3306;acore;apppw;acore_world_reborn"
);
assert_eq!(
get(&reborn, "AC_CHARACTER_DATABASE_INFO").unwrap(),
"db;3306;acore;apppw;acore_characters_reborn"
);
assert_eq!(
get(&reborn, "AC_LOGIN_DATABASE_INFO").unwrap(),
"db;3306;acore;apppw;acore_auth"
);
// Accounts are shared by both realms; the auth server never sees the others. // Accounts are shared by both realms; the auth server never sees the others.
assert_eq!( assert_eq!(
get(&wild, "AC_LOGIN_DATABASE_INFO").unwrap(), get(&wild, "AC_LOGIN_DATABASE_INFO").unwrap(),
+30 -6
View File
@@ -12,16 +12,28 @@ pub fn database_log(root: &Path, filter: Option<&str>, max_lines: usize) -> Resu
database_log_with(&SystemDocker, root, filter, max_lines) database_log_with(&SystemDocker, root, filter, max_lines)
} }
pub fn database_log_with(d: &dyn Docker, root: &Path, filter: Option<&str>, max_lines: usize) -> Result<Vec<Line>> { pub fn database_log_with(
d: &dyn Docker,
root: &Path,
filter: Option<&str>,
max_lines: usize,
) -> Result<Vec<Line>> {
let name = Config::load(root)?.names().db; let name = Config::load(root)?.names().db;
// Ask for more than wanted: the filter may drop most of them. // Ask for more than wanted: the filter may drop most of them.
let tail = (max_lines * 4).clamp(200, 8000).to_string(); let tail = (max_lines * 4).clamp(200, 8000).to_string();
let out = d.run(&Call::new(&["logs", "--tail", &tail, &name], Duration::from_secs(20)))?; let out = d.run(&Call::new(
&["logs", "--tail", &tail, &name],
Duration::from_secs(20),
))?;
if !out.ok() { if !out.ok() {
return Err(Error::Invalid("This log does not exist yet.".into())); return Err(Error::Invalid("This log does not exist yet.".into()));
} }
// MySQL writes to the error stream. // MySQL writes to the error stream.
Ok(crate::console::lines_from_text(&format!("{}\n{}", out.stderr, out.stdout), filter, max_lines)) Ok(crate::console::lines_from_text(
&format!("{}\n{}", out.stderr, out.stdout),
filter,
max_lines,
))
} }
#[cfg(test)] #[cfg(test)]
@@ -58,7 +70,9 @@ mod tests {
assert_eq!(fake.calls.borrow()[0][..2], ["logs", "--tail"]); assert_eq!(fake.calls.borrow()[0][..2], ["logs", "--tail"]);
assert_eq!(fake.calls.borrow()[0].last().unwrap(), "coa-t1-db"); assert_eq!(fake.calls.borrow()[0].last().unwrap(), "coa-t1-db");
assert_eq!(lines.len(), 3); assert_eq!(lines.len(), 3);
assert!(lines.iter().any(|l| l.text.contains("boom") && l.level == crate::console::Level::Error)); assert!(lines
.iter()
.any(|l| l.text.contains("boom") && l.level == crate::console::Level::Error));
let only = database_log_with(&fake, &root, Some("slow"), 100).unwrap(); let only = database_log_with(&fake, &root, Some("slow"), 100).unwrap();
assert_eq!(only.len(), 1); assert_eq!(only.len(), 1);
} }
@@ -66,7 +80,17 @@ mod tests {
#[test] #[test]
fn a_database_that_never_ran_has_no_log_yet() { fn a_database_that_never_ran_has_no_log_yet() {
let (_d, root) = root(); let (_d, root) = root();
let fake = Fake { out: Output { code: Some(1), stdout: String::new(), stderr: "Error: No such container: coa-t1-db".into() }, calls: Default::default() }; let fake = Fake {
assert!(database_log_with(&fake, &root, None, 10).unwrap_err().to_string().contains("does not exist yet")); out: Output {
code: Some(1),
stdout: String::new(),
stderr: "Error: No such container: coa-t1-db".into(),
},
calls: Default::default(),
};
assert!(database_log_with(&fake, &root, None, 10)
.unwrap_err()
.to_string()
.contains("does not exist yet"));
} }
} }
+72 -14
View File
@@ -18,7 +18,10 @@ use crate::net::Exposure;
use crate::process::{ServiceState, ServiceStatus}; use crate::process::{ServiceState, ServiceStatus};
fn is_open(cfg: &Config) -> bool { fn is_open(cfg: &Config) -> bool {
cfg.bind_address.parse::<IpAddr>().map(|ip| !ip.is_loopback()).unwrap_or(false) cfg.bind_address
.parse::<IpAddr>()
.map(|ip| !ip.is_loopback())
.unwrap_or(false)
} }
/// Whether the login and world servers are published beyond this computer. /// Whether the login and world servers are published beyond this computer.
@@ -46,7 +49,11 @@ pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
if let Ok(bytes) = fs::read(&coa_conf) { if let Ok(bytes) = fs::read(&coa_conf) {
let mut conf = ConfFile::parse_bytes(&bytes)?; let mut conf = ConfFile::parse_bytes(&bytes)?;
if conf.get("CoA.AllowRemoteClients").map(str::trim) != Some("1") { if conf.get("CoA.AllowRemoteClients").map(str::trim) != Some("1") {
conf.set("CoA.AllowRemoteClients", "1", &["Set by CoA Server Manager together with the friends mode"]); conf.set(
"CoA.AllowRemoteClients",
"1",
&["Set by CoA Server Manager together with the friends mode"],
);
originals.push((coa_conf.clone(), bytes)); originals.push((coa_conf.clone(), bytes));
coa_edit = Some(conf.to_text()); coa_edit = Some(conf.to_text());
} }
@@ -55,7 +62,16 @@ pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
if !changed && coa_edit.is_none() { if !changed && coa_edit.is_none() {
return Ok(false); return Ok(false);
} }
take_snapshot(meta, Scope::Server, if open { "before opening the servers to friends" } else { "before closing the servers to friends" }, &originals)?; take_snapshot(
meta,
Scope::Server,
if open {
"before opening the servers to friends"
} else {
"before closing the servers to friends"
},
&originals,
)?;
if changed { if changed {
fsx::atomic_write_json(&root.join(MARKER), &cfg)?; fsx::atomic_write_json(&root.join(MARKER), &cfg)?;
} }
@@ -73,10 +89,30 @@ pub fn exposure(root: &Path, ports: &Ports) -> Vec<Exposure> {
let observed = crate::process::observe(root, ports); let observed = crate::process::observe(root, ports);
let up = |s: &ServiceStatus| matches!(s.state, ServiceState::Running | ServiceState::Starting); let up = |s: &ServiceStatus| matches!(s.state, ServiceState::Running | ServiceState::Starting);
vec![ vec![
Exposure { port: ports.mysql, what: "database", listening: up(&observed.mysql), reachable_from_network: false }, Exposure {
Exposure { port: ports.ra, what: "server console", listening: up(&observed.world), reachable_from_network: false }, port: ports.mysql,
Exposure { port: ports.auth, what: "login server", listening: up(&observed.auth), reachable_from_network: open && up(&observed.auth) }, what: "database",
Exposure { port: ports.world, what: "game world", listening: up(&observed.world), reachable_from_network: open && up(&observed.world) }, listening: up(&observed.mysql),
reachable_from_network: false,
},
Exposure {
port: ports.ra,
what: "server console",
listening: up(&observed.world),
reachable_from_network: false,
},
Exposure {
port: ports.auth,
what: "login server",
listening: up(&observed.auth),
reachable_from_network: open && up(&observed.auth),
},
Exposure {
port: ports.world,
what: "game world",
listening: up(&observed.world),
reachable_from_network: open && up(&observed.world),
},
] ]
} }
@@ -91,9 +127,15 @@ mod tests {
fs::create_dir_all(root.join("Settings")).unwrap(); fs::create_dir_all(root.join("Settings")).unwrap();
fs::create_dir_all(root.join("Core/configs/modules")).unwrap(); fs::create_dir_all(root.join("Core/configs/modules")).unwrap();
fs::create_dir_all(&meta).unwrap(); fs::create_dir_all(&meta).unwrap();
let extra = bind.map(|b| format!(r#","bindAddress":"{b}""#)).unwrap_or_default(); let extra = bind
.map(|b| format!(r#","bindAddress":"{b}""#))
.unwrap_or_default();
fs::write(root.join(MARKER), format!(r#"{{"project":"t1"{extra}}}"#)).unwrap(); fs::write(root.join(MARKER), format!(r#"{{"project":"t1"{extra}}}"#)).unwrap();
fs::write(root.join("Core/configs/modules/coa.conf"), "CoA.Enable = 1\n").unwrap(); fs::write(
root.join("Core/configs/modules/coa.conf"),
"CoA.Enable = 1\n",
)
.unwrap();
(d, root, meta) (d, root, meta)
} }
@@ -104,8 +146,15 @@ mod tests {
assert!(set_open(&root, &meta, true).unwrap(), "a restart is needed"); assert!(set_open(&root, &meta, true).unwrap(), "a restart is needed");
assert!(bind_is_open(&root)); assert!(bind_is_open(&root));
assert_eq!(Config::load(&root).unwrap().bind_address, "0.0.0.0"); assert_eq!(Config::load(&root).unwrap().bind_address, "0.0.0.0");
assert!(fs::read_to_string(root.join("Core/configs/modules/coa.conf")).unwrap().contains("CoA.AllowRemoteClients = 1")); assert!(
assert!(!set_open(&root, &meta, true).unwrap(), "nothing left to change"); fs::read_to_string(root.join("Core/configs/modules/coa.conf"))
.unwrap()
.contains("CoA.AllowRemoteClients = 1")
);
assert!(
!set_open(&root, &meta, true).unwrap(),
"nothing left to change"
);
assert!(set_open(&root, &meta, false).unwrap()); assert!(set_open(&root, &meta, false).unwrap());
assert!(!bind_is_open(&root)); assert!(!bind_is_open(&root));
assert_eq!(Config::load(&root).unwrap().bind_address, "127.0.0.1"); assert_eq!(Config::load(&root).unwrap().bind_address, "127.0.0.1");
@@ -114,7 +163,11 @@ mod tests {
#[test] #[test]
fn enabling_remote_client_protocol_requires_restart_even_when_ports_are_open() { fn enabling_remote_client_protocol_requires_restart_even_when_ports_are_open() {
let (_d, root, meta) = server(Some("0.0.0.0")); let (_d, root, meta) = server(Some("0.0.0.0"));
fs::write(root.join("Core/configs/modules/coa.conf"), "CoA.Enable = 1\nCoA.AllowRemoteClients = 0\n").unwrap(); fs::write(
root.join("Core/configs/modules/coa.conf"),
"CoA.Enable = 1\nCoA.AllowRemoteClients = 0\n",
)
.unwrap();
assert!(set_open(&root, &meta, true).unwrap()); assert!(set_open(&root, &meta, true).unwrap());
assert_eq!(Config::load(&root).unwrap().bind_address, "0.0.0.0"); assert_eq!(Config::load(&root).unwrap().bind_address, "0.0.0.0");
assert!(!set_open(&root, &meta, true).unwrap()); assert!(!set_open(&root, &meta, true).unwrap());
@@ -123,7 +176,10 @@ mod tests {
#[test] #[test]
fn an_address_chosen_by_hand_is_kept_when_opening_and_other_settings_survive() { fn an_address_chosen_by_hand_is_kept_when_opening_and_other_settings_survive() {
let (_d, root, meta) = server(Some("192.168.1.20")); let (_d, root, meta) = server(Some("192.168.1.20"));
assert!(bind_is_open(&root), "any address but the loopback is the network"); assert!(
bind_is_open(&root),
"any address but the loopback is the network"
);
set_open(&root, &meta, true).unwrap(); set_open(&root, &meta, true).unwrap();
let cfg = Config::load(&root).unwrap(); let cfg = Config::load(&root).unwrap();
assert_eq!(cfg.bind_address, "192.168.1.20"); assert_eq!(cfg.bind_address, "192.168.1.20");
@@ -142,7 +198,9 @@ mod tests {
let (_d, root, _meta) = server(Some("0.0.0.0")); let (_d, root, _meta) = server(Some("0.0.0.0"));
let rows = exposure(&root, &Ports::default()); let rows = exposure(&root, &Ports::default());
let by = |what: &str| rows.iter().find(|e| e.what == what).unwrap(); let by = |what: &str| rows.iter().find(|e| e.what == what).unwrap();
assert!(!by("database").reachable_from_network && !by("server console").reachable_from_network); assert!(
!by("database").reachable_from_network && !by("server console").reachable_from_network
);
// Nothing runs in this test (docker is not asked to start anything), so nothing is reachable yet. // Nothing runs in this test (docker is not asked to start anything), so nothing is reachable yet.
assert!(rows.iter().all(|e| !e.reachable_from_network)); assert!(rows.iter().all(|e| !e.reachable_from_network));
} }
+65 -6
View File
@@ -163,10 +163,52 @@ pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
/// Make the realm list advertise `host` to remote clients (the launcher resets it to 127.0.0.1 at every start, so this /// Make the realm list advertise `host` to remote clients (the launcher resets it to 127.0.0.1 at every start, so this
/// runs after each start). /// runs after each start).
pub fn apply_realm_address(root: &Path, host: &str) -> Result<()> { fn realm_address_sql(
host: &str,
local: Option<(std::net::Ipv4Addr, std::net::Ipv4Addr)>,
where_realms: &str,
) -> Result<String> {
if !host_ok(host) { if !host_ok(host) {
return Err(Error::Invalid("That address is not valid.".into())); return Err(Error::Invalid("That address is not valid.".into()));
} }
let local = local
.map(|(address, mask)| format!(",localAddress='{address}',localSubnetMask='{mask}'"))
.unwrap_or_default();
Ok(format!(
"UPDATE acore_auth.realmlist SET address='{host}'{local} WHERE {where_realms};"
))
}
pub fn apply_realm_address(root: &Path, settings: &Settings) -> Result<()> {
let host = settings.host.as_deref().unwrap_or("127.0.0.1");
let local = match settings.mode {
Mode::Direct | Mode::Lan => {
let address = if settings.mode == Mode::Lan {
host.to_owned()
} else {
crate::net::resolve_lan_host(
settings.lan_address_override.as_deref(),
crate::net::lan_ip(),
)?
};
let address = crate::net::validate_lan_address(&address)?;
let mask = if_addrs::get_if_addrs()?
.into_iter()
.find_map(|interface| match interface.addr {
if_addrs::IfAddr::V4(v4) if v4.ip == address => Some(v4.netmask),
_ => None,
})
.ok_or_else(|| {
Error::Invalid("The selected local network address is not connected.".into())
})?;
Some((address, mask))
}
Mode::Local => Some((
std::net::Ipv4Addr::LOCALHOST,
std::net::Ipv4Addr::new(255, 0, 0, 0),
)),
Mode::Private => None,
};
let db = Db::from_repack(root, Account::Admin)?; let db = Db::from_repack(root, Account::Admin)?;
let realm = crate::realms::state(root)?.active.realm_id(); let realm = crate::realms::state(root)?.active.realm_id();
let where_realms = if crate::realms::state(root)?.simultaneous { let where_realms = if crate::realms::state(root)?.simultaneous {
@@ -174,9 +216,7 @@ pub fn apply_realm_address(root: &Path, host: &str) -> Result<()> {
} else { } else {
format!("id={realm}") format!("id={realm}")
}; };
db.query(&format!( db.query(&realm_address_sql(host, local, &where_realms)?)?;
"UPDATE acore_auth.realmlist SET address='{host}' WHERE {where_realms};"
))?;
Ok(()) Ok(())
} }
@@ -194,9 +234,9 @@ pub fn ensure_bind(root: &Path, meta: &Path) -> Result<bool> {
/// After every server start: put the chosen address back into the realm list (the launcher resets it to 127.0.0.1). /// After every server start: put the chosen address back into the realm list (the launcher resets it to 127.0.0.1).
pub fn reapply(root: &Path, meta: &Path) -> Result<()> { pub fn reapply(root: &Path, meta: &Path) -> Result<()> {
let s = load(meta); let s = load(meta);
match (s.mode, s.host) { match (s.mode, &s.host) {
(Mode::Local, _) | (_, None) => Ok(()), (Mode::Local, _) | (_, None) => Ok(()),
(_, Some(host)) => apply_realm_address(root, &host), (_, Some(_)) => apply_realm_address(root, &s),
} }
} }
@@ -390,6 +430,25 @@ CoA.AllowRemoteClients = 0
); );
} }
#[test]
fn realm_addresses_restore_lan_without_replacing_public_host() {
let sql = realm_address_sql(
"203.0.113.9",
Some((
"192.168.50.7".parse().unwrap(),
"255.255.254.0".parse().unwrap(),
)),
"id IN (1,2)",
)
.unwrap();
assert_eq!(sql, "UPDATE acore_auth.realmlist SET address='203.0.113.9',localAddress='192.168.50.7',localSubnetMask='255.255.254.0' WHERE id IN (1,2);");
assert_eq!(
realm_address_sql("100.64.1.2", None, "id=1").unwrap(),
"UPDATE acore_auth.realmlist SET address='100.64.1.2' WHERE id=1;"
);
assert!(realm_address_sql("bad'host", None, "id=1").is_err());
}
#[test] #[test]
fn old_settings_load_without_migrating_effective_host_to_override() { fn old_settings_load_without_migrating_effective_host_to_override() {
let s: Settings = serde_json::from_str(r#"{"mode":"lan","host":"192.168.1.50"}"#).unwrap(); let s: Settings = serde_json::from_str(r#"{"mode":"lan","host":"192.168.1.50"}"#).unwrap();
+30 -7
View File
@@ -36,7 +36,12 @@ fn key(path: &Path) -> Vec<String> {
return format!("{}:", char::from(drive).to_ascii_lowercase()); return format!("{}:", char::from(drive).to_ascii_lowercase());
} }
Prefix::UNC(server, share) | Prefix::VerbatimUNC(server, share) => { Prefix::UNC(server, share) | Prefix::VerbatimUNC(server, share) => {
return format!("\\\\{}\\{}", server.to_string_lossy(), share.to_string_lossy()).to_lowercase(); return format!(
"\\\\{}\\{}",
server.to_string_lossy(),
share.to_string_lossy()
)
.to_lowercase();
} }
_ => {} _ => {}
} }
@@ -337,12 +342,30 @@ mod tests {
#[cfg(windows)] #[cfg(windows)]
#[test] #[test]
fn containment_matches_verbatim_drive_and_unc_prefixes() { fn containment_matches_verbatim_drive_and_unc_prefixes() {
assert!(starts_with_ci(Path::new(r"\\?\C:\server\Extras\file.sql"), Path::new(r"C:\server"))); assert!(starts_with_ci(
assert!(starts_with_ci(Path::new(r"C:\server\Extras\file.sql"), Path::new(r"\\?\c:\server"))); Path::new(r"\\?\C:\server\Extras\file.sql"),
assert!(starts_with_ci(Path::new(r"\\?\UNC\host\share\server\file.sql"), Path::new(r"\\host\share\server"))); Path::new(r"C:\server")
assert!(!starts_with_ci(Path::new(r"\\?\D:\server\file.sql"), Path::new(r"C:\server"))); ));
assert!(!starts_with_ci(Path::new(r"\\?\C:\server-other\file.sql"), Path::new(r"C:\server"))); assert!(starts_with_ci(
assert!(!starts_with_ci(Path::new(r"\\?\UNC\host\other\server\file.sql"), Path::new(r"\\host\share\server"))); Path::new(r"C:\server\Extras\file.sql"),
Path::new(r"\\?\c:\server")
));
assert!(starts_with_ci(
Path::new(r"\\?\UNC\host\share\server\file.sql"),
Path::new(r"\\host\share\server")
));
assert!(!starts_with_ci(
Path::new(r"\\?\D:\server\file.sql"),
Path::new(r"C:\server")
));
assert!(!starts_with_ci(
Path::new(r"\\?\C:\server-other\file.sql"),
Path::new(r"C:\server")
));
assert!(!starts_with_ci(
Path::new(r"\\?\UNC\host\other\server\file.sql"),
Path::new(r"\\host\share\server")
));
} }
#[cfg(windows)] #[cfg(windows)]
+82 -25
View File
@@ -165,21 +165,38 @@ impl Manifest {
} }
if let Some(c) = &self.compatibility { if let Some(c) = &self.compatibility {
if parse_version(&self.min_manager_version).is_none_or(|v| v < (0, 6, 13)) { if parse_version(&self.min_manager_version).is_none_or(|v| v < (0, 6, 13)) {
return bad("Release compatibility matrices require Manager 0.6.13 or newer".into()); return bad(
"Release compatibility matrices require Manager 0.6.13 or newer".into(),
);
} }
if c.schema != 1 || !matches!(c.platform.as_str(), "windows-x86_64" | "linux-x86_64") if c.schema != 1
|| !is_commit(&c.core_commit) || self.core.commit.as_deref() != Some(&c.core_commit) || !matches!(c.platform.as_str(), "windows-x86_64" | "linux-x86_64")
|| c.module_commits.is_empty() || c.module_commits.values().any(|sha| !is_commit(sha)) || !is_commit(&c.core_commit)
|| self.bots.as_ref().and_then(|r| r.commit.as_ref()).is_some_and(|sha| c.module_commits.get("bots") != Some(sha)) || self.core.commit.as_deref() != Some(&c.core_commit)
|| c.module_commits.is_empty()
|| c.module_commits.values().any(|sha| !is_commit(sha))
|| self
.bots
.as_ref()
.and_then(|r| r.commit.as_ref())
.is_some_and(|sha| c.module_commits.get("bots") != Some(sha))
|| parse_version(&c.client_patch_version).is_none() || parse_version(&c.client_patch_version).is_none()
|| c.source_versions.is_empty() || c.source_versions.iter().any(|v| parse_version(v).is_none()) || c.source_versions.is_empty()
|| c.source_versions.iter().collect::<HashSet<_>>().len() != c.source_versions.len() { || c.source_versions.iter().any(|v| parse_version(v).is_none())
|| c.source_versions.iter().collect::<HashSet<_>>().len() != c.source_versions.len()
{
return bad("Invalid release compatibility matrix".into()); return bad("Invalid release compatibility matrix".into());
} }
if !c.source_databases.is_empty() && (c.source_databases.len() != c.source_versions.len() if !c.source_databases.is_empty()
|| c.source_versions.iter().any(|v| !c.source_databases.contains_key(v)) && (c.source_databases.len() != c.source_versions.len()
|| c.source_databases.values().any(|s| !is_sha256(&s.manifest_sha256) || c.source_versions
|| s.schema_sha256.as_ref().is_some_and(|sha| !is_sha256(sha)))) { .iter()
.any(|v| !c.source_databases.contains_key(v))
|| c.source_databases.values().any(|s| {
!is_sha256(&s.manifest_sha256)
|| s.schema_sha256.as_ref().is_some_and(|sha| !is_sha256(sha))
}))
{
return bad("Invalid source database compatibility".into()); return bad("Invalid source database compatibility".into());
} }
} }
@@ -308,9 +325,15 @@ mod tests {
fn compatibility_matrix_binds_core_and_requires_tested_sources() { fn compatibility_matrix_binds_core_and_requires_tested_sources() {
let mut m = Manifest::parse(sample("").as_bytes()).unwrap(); let mut m = Manifest::parse(sample("").as_bytes()).unwrap();
m.min_manager_version = "0.6.13".into(); m.min_manager_version = "0.6.13".into();
m.compatibility = Some(Compatibility { schema: 1, platform: "windows-x86_64".into(), m.compatibility = Some(Compatibility {
core_commit: "a".repeat(40), module_commits: [("squid".into(), "b".repeat(40))].into(), schema: 1,
source_databases: Default::default(), client_patch_version: "1.5.1".into(), source_versions: vec!["0.261010.32".into()] }); platform: "windows-x86_64".into(),
core_commit: "a".repeat(40),
module_commits: [("squid".into(), "b".repeat(40))].into(),
source_databases: Default::default(),
client_patch_version: "1.5.1".into(),
source_versions: vec!["0.261010.32".into()],
});
m.validate().unwrap(); m.validate().unwrap();
m.compatibility.as_mut().unwrap().core_commit = "c".repeat(40); m.compatibility.as_mut().unwrap().core_commit = "c".repeat(40);
assert!(m.validate().is_err()); assert!(m.validate().is_err());
@@ -323,14 +346,30 @@ mod tests {
fn compatibility_cannot_claim_a_different_packaged_bot_revision() { fn compatibility_cannot_claim_a_different_packaged_bot_revision() {
let mut m = Manifest::parse(sample("").as_bytes()).unwrap(); let mut m = Manifest::parse(sample("").as_bytes()).unwrap();
m.min_manager_version = "0.6.13".into(); m.min_manager_version = "0.6.13".into();
m.bots = Some(Revision { commit: Some("b".repeat(40)) }); m.bots = Some(Revision {
m.compatibility = Some(Compatibility { schema: 1, platform: "windows-x86_64".into(), commit: Some("b".repeat(40)),
core_commit: "a".repeat(40), module_commits: [("bots".into(), "c".repeat(40))].into(), });
source_databases: Default::default(), client_patch_version: "1.5.1".into(), source_versions: vec!["0.2.0".into()] }); m.compatibility = Some(Compatibility {
schema: 1,
platform: "windows-x86_64".into(),
core_commit: "a".repeat(40),
module_commits: [("bots".into(), "c".repeat(40))].into(),
source_databases: Default::default(),
client_patch_version: "1.5.1".into(),
source_versions: vec!["0.2.0".into()],
});
assert!(m.validate().is_err()); assert!(m.validate().is_err());
m.compatibility.as_mut().unwrap().module_commits.insert("bots".into(), "b".repeat(40)); m.compatibility
.as_mut()
.unwrap()
.module_commits
.insert("bots".into(), "b".repeat(40));
m.validate().unwrap(); m.validate().unwrap();
m.compatibility.as_mut().unwrap().source_versions.push("0.2.0".into()); m.compatibility
.as_mut()
.unwrap()
.source_versions
.push("0.2.0".into());
assert!(m.validate().is_err()); assert!(m.validate().is_err());
} }
@@ -338,12 +377,30 @@ mod tests {
fn source_database_contracts_must_cover_the_exact_upgrade_versions() { fn source_database_contracts_must_cover_the_exact_upgrade_versions() {
let mut m = Manifest::parse(sample("").as_bytes()).unwrap(); let mut m = Manifest::parse(sample("").as_bytes()).unwrap();
m.min_manager_version = "0.6.13".into(); m.min_manager_version = "0.6.13".into();
m.compatibility = Some(Compatibility { schema: 1, platform: "windows-x86_64".into(), m.compatibility = Some(Compatibility {
core_commit: "a".repeat(40), module_commits: [("squid".into(), "b".repeat(40))].into(), schema: 1,
client_patch_version: "1.5.1".into(), source_versions: vec!["0.2.0".into()], platform: "windows-x86_64".into(),
source_databases: [("0.2.0".into(), SourceDatabase { manifest_sha256: "a".repeat(64), schema_sha256: None })].into() }); core_commit: "a".repeat(40),
module_commits: [("squid".into(), "b".repeat(40))].into(),
client_patch_version: "1.5.1".into(),
source_versions: vec!["0.2.0".into()],
source_databases: [(
"0.2.0".into(),
SourceDatabase {
manifest_sha256: "a".repeat(64),
schema_sha256: None,
},
)]
.into(),
});
m.validate().unwrap(); m.validate().unwrap();
m.compatibility.as_mut().unwrap().source_databases.get_mut("0.2.0").unwrap().schema_sha256 = Some("bad".into()); m.compatibility
.as_mut()
.unwrap()
.source_databases
.get_mut("0.2.0")
.unwrap()
.schema_sha256 = Some("bad".into());
assert!(m.validate().is_err()); assert!(m.validate().is_err());
let c = m.compatibility.as_mut().unwrap(); let c = m.compatibility.as_mut().unwrap();
c.source_databases.get_mut("0.2.0").unwrap().schema_sha256 = None; c.source_databases.get_mut("0.2.0").unwrap().schema_sha256 = None;
+23 -3
View File
@@ -101,8 +101,19 @@ impl Store for Db {
let connection = self.clone().for_realm(crate::realms::Mode::Coa); let connection = self.clone().for_realm(crate::realms::Mode::Coa);
let world = self.realm_schema("acore_world"); let world = self.realm_schema("acore_world");
let characters = self.realm_schema("acore_characters"); let characters = self.realm_schema("acore_characters");
let others: Vec<_> = [crate::realms::Mode::Coa, crate::realms::Mode::Wildcard, crate::realms::Mode::Reborn].into_iter().filter(|m| *m != self.realm()).map(|m| m.schema("world").unwrap()).collect(); let others: Vec<_> = [
let schemas: std::collections::BTreeSet<_> = [world, characters, AUTH_LEDGER_SCHEMA].into_iter().chain(others.iter().copied()).collect(); crate::realms::Mode::Coa,
crate::realms::Mode::Wildcard,
crate::realms::Mode::Reborn,
]
.into_iter()
.filter(|m| *m != self.realm())
.map(|m| m.schema("world").unwrap())
.collect();
let schemas: std::collections::BTreeSet<_> = [world, characters, AUTH_LEDGER_SCHEMA]
.into_iter()
.chain(others.iter().copied())
.collect();
let catalog = connection.query(&format!("SELECT table_schema,table_name FROM information_schema.tables WHERE table_schema IN ('{}') AND table_name IN ('updates','{LEDGER_TABLE}') AND table_type='BASE TABLE';", schemas.into_iter().collect::<Vec<_>>().join("','")))?; let catalog = connection.query(&format!("SELECT table_schema,table_name FROM information_schema.tables WHERE table_schema IN ('{}') AND table_name IN ('updates','{LEDGER_TABLE}') AND table_type='BASE TABLE';", schemas.into_iter().collect::<Vec<_>>().join("','")))?;
let available: std::collections::BTreeSet<_> = catalog let available: std::collections::BTreeSet<_> = catalog
.lines() .lines()
@@ -120,7 +131,16 @@ impl Store for Db {
queries.push(format!("SELECT 'core','{kind}',{},REPEAT('0',64),'applied',1,'' FROM `{schema}`.`updates` WHERE BINARY RIGHT(name,4)='.sql'",text("LEFT(name,CHAR_LENGTH(name)-4)"))); queries.push(format!("SELECT 'core','{kind}',{},REPEAT('0',64),'applied',1,'' FROM `{schema}`.`updates` WHERE BINARY RIGHT(name,4)='.sql'",text("LEFT(name,CHAR_LENGTH(name)-4)")));
} }
} }
for (origin, schema, filter) in [("local",world,""), ("shared",AUTH_LEDGER_SCHEMA,"")].into_iter().chain(others.iter().map(|schema| ("other", *schema, " WHERE `db` IN ('auth','coa-auth','wildcard-auth','reborn-auth')"))) { for (origin, schema, filter) in [("local", world, ""), ("shared", AUTH_LEDGER_SCHEMA, "")]
.into_iter()
.chain(others.iter().map(|schema| {
(
"other",
*schema,
" WHERE `db` IN ('auth','coa-auth','wildcard-auth','reborn-auth')",
)
}))
{
if available.contains(&(schema, LEDGER_TABLE)) { if available.contains(&(schema, LEDGER_TABLE)) {
queries.push(format!("SELECT '{origin}',{},{},{},{},`baseline`,{} FROM `{schema}`.`{LEDGER_TABLE}`{filter}",text("`db`"),text("`id`"),text("`sha256`"),text("`status`"),text("COALESCE(HEX(`error`),'')"))); queries.push(format!("SELECT '{origin}',{},{},{},{},`baseline`,{} FROM `{schema}`.`{LEDGER_TABLE}`{filter}",text("`db`"),text("`id`"),text("`sha256`"),text("`status`"),text("COALESCE(HEX(`error`),'')")));
} }
+33 -8
View File
@@ -173,7 +173,9 @@ fn installed_module_commits(root: &Path) -> BTreeMap<String, String> {
fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> { fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
let installed_commits = installed_module_commits(root); let installed_commits = installed_module_commits(root);
let wildcard = crate::realms::state(root).map(|s| s.active != crate::realms::Mode::Coa).unwrap_or(true); let wildcard = crate::realms::state(root)
.map(|s| s.active != crate::realms::Mode::Coa)
.unwrap_or(true);
cat.iter() cat.iter()
.cloned() .cloned()
.map(|e| { .map(|e| {
@@ -544,10 +546,17 @@ fn save_settings_in(
)); ));
} }
} }
if id == "content-scaling" && key.starts_with("CoAContentScaling.Difficulty.Health.") && key.ends_with("Multiplier") { if id == "content-scaling"
let multiplier = value.parse::<f32>().map_err(|_| Error::Invalid("Health multipliers must be a number from 0.1 to 10.".into()))?; && key.starts_with("CoAContentScaling.Difficulty.Health.")
&& key.ends_with("Multiplier")
{
let multiplier = value.parse::<f32>().map_err(|_| {
Error::Invalid("Health multipliers must be a number from 0.1 to 10.".into())
})?;
if !multiplier.is_finite() || !(0.1..=10.0).contains(&multiplier) { if !multiplier.is_finite() || !(0.1..=10.0).contains(&multiplier) {
return Err(Error::Invalid("Health multipliers must be a number from 0.1 to 10.".into())); return Err(Error::Invalid(
"Health multipliers must be a number from 0.1 to 10.".into(),
));
} }
} }
if id == "content-scaling" && key == "CoAContentScaling.World.Leech.Percent" { if id == "content-scaling" && key == "CoAContentScaling.World.Leech.Percent" {
@@ -1261,17 +1270,33 @@ mod tests {
for key in keys { for key in keys {
let changes = |v: &str| BTreeMap::from([(key.to_string(), v.to_string())]); let changes = |v: &str| BTreeMap::from([(key.to_string(), v.to_string())]);
for bad in ["NaN", "inf", "0", "0.09", "10.01", "-1", "abc", ""] { for bad in ["NaN", "inf", "0", "0.09", "10.01", "-1", "abc", ""] {
assert!(save_settings_in(&cat, &root, &meta, "content-scaling", &changes(bad)).is_err(), "{key} {bad}"); assert!(
save_settings_in(&cat, &root, &meta, "content-scaling", &changes(bad)).is_err(),
"{key} {bad}"
);
} }
for good in ["0.1", "0.4", "1", "2.5", "10"] { for good in ["0.1", "0.4", "1", "2.5", "10"] {
assert_eq!(save_settings_in(&cat, &root, &meta, "content-scaling", &changes(good)).unwrap(), [key]); assert_eq!(
assert_eq!(settings_in(&cat, &root, "content-scaling").unwrap().iter().find(|s| s.key == key).unwrap().value, good); save_settings_in(&cat, &root, &meta, "content-scaling", &changes(good))
.unwrap(),
[key]
);
assert_eq!(
settings_in(&cat, &root, "content-scaling")
.unwrap()
.iter()
.find(|s| s.key == key)
.unwrap()
.value,
good
);
} }
} }
} }
#[test] #[test]
fn an_older_file_name_is_used_when_the_current_one_is_missing_and_a_part_that_cannot_be_switched_stays_on() { fn an_older_file_name_is_used_when_the_current_one_is_missing_and_a_part_that_cannot_be_switched_stays_on(
) {
let d = tempfile::tempdir().unwrap(); let d = tempfile::tempdir().unwrap();
let (root, meta) = server(d.path()); let (root, meta) = server(d.path());
fs::write( fs::write(
+11 -2
View File
@@ -62,8 +62,17 @@ pub fn set_enabled(main: &Path, enabled: bool) -> Result<realms::View> {
)); ));
} }
if enabled { if enabled {
if realms::state(main)?.active == Mode::Reborn { return Err(Error::Invalid("Simultaneous startup supports CoA and Wildcard. Select one of these realms first.".into())); } if realms::state(main)?.active == Mode::Reborn {
if !realms::view(main)?.supported { return Err(Error::Invalid("Update the server to a build with Wildcard support first.".into())); } return Err(Error::Invalid(
"Simultaneous startup supports CoA and Wildcard. Select one of these realms first."
.into(),
));
}
if !realms::view(main)?.supported {
return Err(Error::Invalid(
"Update the server to a build with Wildcard support first.".into(),
));
}
secondary_launcher(&fs::read_to_string(main.join("Scripts/manage.py"))?)?; secondary_launcher(&fs::read_to_string(main.join("Scripts/manage.py"))?)?;
} }
let status = process::observe(main, &crate::layout::read_ports(main)); let status = process::observe(main, &crate::layout::read_ports(main));
File diff suppressed because it is too large. Load diff
+3 -2
View File
@@ -456,8 +456,9 @@ mod tests {
ruleset: Ruleset::Coa, ruleset: Ruleset::Coa,
character_formats: ContentProfile::manager_formats(), character_formats: ContentProfile::manager_formats(),
online_import_job_formats: jobs.to_vec(), online_import_job_formats: jobs.to_vec(),
session_protocol: 2, session_protocol: crate::portable::session::protocol::SESSION_PROTOCOL_VERSION,
collection_protocol: 2, collection_protocol:
crate::portable::session::protocol::COLLECTION_PROTOCOL_VERSION,
features: features.iter().copied().collect(), features: features.iter().copied().collect(),
collection_kinds: ["coa:appearance".to_string(), "coa:vanity".to_string()] collection_kinds: ["coa:appearance".to_string(), "coa:vanity".to_string()]
.into_iter() .into_iter()
+5
View File
@@ -64,6 +64,11 @@ pub enum PortableError {
RealmRead(String), RealmRead(String),
#[error("the realm database is a {found} realm but a {expected} character was requested")] #[error("the realm database is a {found} realm but a {expected} character was requested")]
WrongRealm { expected: String, found: String }, WrongRealm { expected: String, found: String },
#[error("ruleset mismatch: character has {character:?}, realm expects {realm:?}")]
RulesetMismatch {
character: super::model::Ruleset,
realm: super::model::Ruleset,
},
#[error("character {character} is already on server {server_id}")] #[error("character {character} is already on server {server_id}")]
AlreadyOnRealm { AlreadyOnRealm {
@@ -0,0 +1,23 @@
-- Schema 9: Multi-ruleset partitioned collections and reborn ruleset support.
-- 1. Partition collection table by (profile_id, ruleset, kind)
CREATE TABLE collection_new (
profile_id TEXT NOT NULL REFERENCES profile(profile_id),
ruleset TEXT NOT NULL CHECK (ruleset IN ('coa', 'wildcard', 'reborn')),
kind TEXT NOT NULL,
collection_revision INTEGER NOT NULL CHECK (collection_revision >= 1),
collection_hash BLOB NOT NULL CHECK (length(collection_hash) = 32),
format_version INTEGER NOT NULL,
item_count INTEGER NOT NULL,
updated_at TEXT NOT NULL,
payload BLOB NOT NULL,
PRIMARY KEY (profile_id, ruleset, kind)
) STRICT;
INSERT INTO collection_new (profile_id, ruleset, kind, collection_revision, collection_hash, format_version, item_count, updated_at, payload)
SELECT profile_id, 'coa', kind, collection_revision, collection_hash, format_version, item_count, updated_at, payload
FROM collection;
DROP TABLE collection;
ALTER TABLE collection_new RENAME TO collection;
CREATE INDEX IF NOT EXISTS character_profile_ruleset ON character(profile_id, ruleset);
@@ -0,0 +1,26 @@
-- 2. Upgrade character table to allow 'reborn' in CHECK (ruleset IN ('coa', 'wildcard', 'reborn'))
-- Foreign keys are off during migration runner, but legacy child tables remain valid because primary keys are untouched.
CREATE TABLE character_new (
character_id TEXT PRIMARY KEY,
profile_id TEXT NOT NULL REFERENCES profile(profile_id),
ruleset TEXT NOT NULL CHECK (ruleset IN ('coa', 'wildcard', 'reborn')),
name TEXT NOT NULL,
race TEXT NOT NULL,
class TEXT NOT NULL,
gender INTEGER NOT NULL,
level INTEGER NOT NULL,
revision INTEGER NOT NULL CHECK (revision >= 1),
created_at TEXT NOT NULL,
updated_at TEXT NOT NULL,
archived INTEGER NOT NULL DEFAULT 0 CHECK (archived IN (0, 1))
) STRICT;
INSERT INTO character_new (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
SELECT character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived
FROM character;
DROP TABLE character;
ALTER TABLE character_new RENAME TO character;
CREATE INDEX character_profile ON character(profile_id);
CREATE INDEX character_profile_ruleset ON character(profile_id, ruleset);
+2 -2
View File
@@ -23,8 +23,8 @@ pub mod snapshot;
pub mod store; pub mod store;
pub mod versions; pub mod versions;
#[cfg(test)] #[cfg(any(test, feature = "testkit"))]
pub(crate) mod fixtures; pub mod fixtures;
pub use collection::IdSet; pub use collection::IdSet;
pub use error::{PortableError, Result}; pub use error::{PortableError, Result};
+96 -1
View File
@@ -59,12 +59,13 @@ pub mod limits {
use limits::*; use limits::*;
/// A character belongs to exactly one ruleset for its whole life; CoA and Wildcard never mix. /// A character belongs to exactly one ruleset for its whole life; rulesets never mix.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")] #[serde(rename_all = "lowercase")]
pub enum Ruleset { pub enum Ruleset {
Coa, Coa,
Wildcard, Wildcard,
Reborn,
} }
impl Ruleset { impl Ruleset {
@@ -72,23 +73,99 @@ impl Ruleset {
match self { match self {
Ruleset::Coa => "coa", Ruleset::Coa => "coa",
Ruleset::Wildcard => "wildcard", Ruleset::Wildcard => "wildcard",
Ruleset::Reborn => "reborn",
}
}
pub fn display_name(self) -> &'static str {
match self {
Ruleset::Coa => "Conquest of Azeroth",
Ruleset::Wildcard => "Wildcard",
Ruleset::Reborn => "Warcraft Reborn",
}
}
pub fn realm_id(self) -> u32 {
match self {
Ruleset::Coa => 1,
Ruleset::Wildcard => 2,
Ruleset::Reborn => 3,
}
}
pub fn schema(self, kind: &str) -> Result<&'static str> {
let mode: crate::realms::Mode = self.into();
mode.schema(kind)
.map_err(|e| PortableError::Invalid(e.to_string()))
}
pub fn collection_namespace(self) -> &'static str {
match self {
Ruleset::Coa => "coa",
Ruleset::Wildcard => "wildcard",
Ruleset::Reborn => "reborn",
} }
} }
pub fn parse(s: &str) -> Result<Self> { pub fn parse(s: &str) -> Result<Self> {
match s { match s {
"coa" => Ok(Ruleset::Coa), "coa" => Ok(Ruleset::Coa),
"wildcard" => Ok(Ruleset::Wildcard), "wildcard" => Ok(Ruleset::Wildcard),
"reborn" => Ok(Ruleset::Reborn),
other => Err(PortableError::Invalid(format!("unknown ruleset {other:?}"))), other => Err(PortableError::Invalid(format!("unknown ruleset {other:?}"))),
} }
} }
} }
impl std::str::FromStr for Ruleset {
type Err = PortableError;
fn from_str(s: &str) -> Result<Self> {
Self::parse(s)
}
}
impl std::fmt::Display for Ruleset { impl std::fmt::Display for Ruleset {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str(self.as_str()) f.write_str(self.as_str())
} }
} }
impl From<crate::realms::Mode> for Ruleset {
fn from(m: crate::realms::Mode) -> Self {
match m {
crate::realms::Mode::Coa => Ruleset::Coa,
crate::realms::Mode::Wildcard => Ruleset::Wildcard,
crate::realms::Mode::Reborn => Ruleset::Reborn,
}
}
}
impl From<Ruleset> for crate::realms::Mode {
fn from(r: Ruleset) -> Self {
match r {
Ruleset::Coa => crate::realms::Mode::Coa,
Ruleset::Wildcard => crate::realms::Mode::Wildcard,
Ruleset::Reborn => crate::realms::Mode::Reborn,
}
}
}
impl From<coa_registry_proto::caps::Ruleset> for Ruleset {
fn from(r: coa_registry_proto::caps::Ruleset) -> Self {
match r {
coa_registry_proto::caps::Ruleset::Coa => Ruleset::Coa,
coa_registry_proto::caps::Ruleset::Wildcard => Ruleset::Wildcard,
coa_registry_proto::caps::Ruleset::Reborn => Ruleset::Reborn,
}
}
}
impl From<Ruleset> for coa_registry_proto::caps::Ruleset {
fn from(r: Ruleset) -> Self {
match r {
Ruleset::Coa => coa_registry_proto::caps::Ruleset::Coa,
Ruleset::Wildcard => coa_registry_proto::caps::Ruleset::Wildcard,
Ruleset::Reborn => coa_registry_proto::caps::Ruleset::Reborn,
}
}
}
/// Binary data as base64 text in the serialised form. /// Binary data as base64 text in the serialised form.
#[derive(Clone, PartialEq, Eq, Default)] #[derive(Clone, PartialEq, Eq, Default)]
pub struct Bytes(pub Vec<u8>); pub struct Bytes(pub Vec<u8>);
@@ -806,3 +883,21 @@ impl PortableCharacter {
Ok(()) Ok(())
} }
} }
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn schema_mapping_never_falls_back_on_unknown_database_kind() {
for ruleset in [Ruleset::Coa, Ruleset::Wildcard, Ruleset::Reborn] {
assert!(ruleset.schema("auth").is_ok());
assert!(ruleset.schema("characters").is_ok());
assert!(ruleset.schema("world").is_ok());
assert!(ruleset.schema("characters_extra").is_err());
assert!(ruleset.schema("unknown").is_err());
assert!(ruleset.schema("").is_err());
assert!(ruleset.schema("acore_characters").is_err());
}
}
}
@@ -11,7 +11,6 @@ use crate::db::Db;
use super::super::collection::IdSet; use super::super::collection::IdSet;
use super::super::error::{PortableError, Result}; use super::super::error::{PortableError, Result};
use super::super::model::Ruleset;
use super::knowledge::{is_bank_vanity_item, RealmKnowledge}; use super::knowledge::{is_bank_vanity_item, RealmKnowledge};
use super::plan::FAIL; use super::plan::FAIL;
use super::ruleset_of; use super::ruleset_of;
@@ -22,8 +21,12 @@ const CHUNK: usize = 2_000;
/// `(table, id column, columns written)` of a collection kind. /// `(table, id column, columns written)` of a collection kind.
fn layout(kind: &str) -> Result<(&'static str, &'static str, bool)> { fn layout(kind: &str) -> Result<(&'static str, &'static str, bool)> {
match kind { match kind {
"coa:appearance" => Ok(("account_appearance_collection", "appearance_id", true)), "coa:appearance" | "wildcard:appearance" | "reborn:appearance" => {
"coa:vanity" => Ok(("account_vanity_collection", "item_id", false)), Ok(("account_appearance_collection", "appearance_id", true))
}
"coa:vanity" | "wildcard:vanity" | "reborn:vanity" => {
Ok(("account_vanity_collection", "item_id", false))
}
other => Err(PortableError::Invalid(format!( other => Err(PortableError::Invalid(format!(
"collection kind {other:?} is not carried" "collection kind {other:?} is not carried"
))), ))),
@@ -34,11 +37,12 @@ fn realm_error(e: crate::Error) -> PortableError {
PortableError::RealmRead(e.to_string()) PortableError::RealmRead(e.to_string())
} }
fn coa_only(db: &Db) -> Result<()> { fn check_ruleset(db: &Db, kind: &str) -> Result<()> {
if ruleset_of(db)? != Ruleset::Coa { let r = ruleset_of(db)?;
return Err(PortableError::Invalid( if !crate::portable::session::protocol::carried_kind_for(kind, r) {
"collections are carried for CoA realms only (Wildcard transfer is disabled)".into(), return Err(PortableError::Invalid(format!(
)); "collection kind {kind:?} does not belong to realm ruleset {r:?}"
)));
} }
Ok(()) Ok(())
} }
@@ -62,7 +66,7 @@ pub fn account_of(db: &Db, local_guid: u32) -> Result<Option<u32>> {
/// Count, maximum, sum and checksum of the account's rows of this kind: one cheap aggregate over the primary key. /// Count, maximum, sum and checksum of the account's rows of this kind: one cheap aggregate over the primary key.
pub fn fingerprint(db: &Db, account: u32, kind: &str) -> Result<String> { pub fn fingerprint(db: &Db, account: u32, kind: &str) -> Result<String> {
coa_only(db)?; check_ruleset(db, kind)?;
let (table, column, _) = layout(kind)?; let (table, column, _) = layout(kind)?;
let out = db let out = db
.query(&format!("SELECT COUNT(*), IFNULL(MAX(`{column}`), 0), IFNULL(SUM(`{column}`), 0), IFNULL(BIT_XOR(CRC32(`{column}`)), 0) FROM acore_characters.`{table}` WHERE `account_id` = {account}")) .query(&format!("SELECT COUNT(*), IFNULL(MAX(`{column}`), 0), IFNULL(SUM(`{column}`), 0), IFNULL(BIT_XOR(CRC32(`{column}`)), 0) FROM acore_characters.`{table}` WHERE `account_id` = {account}"))
@@ -82,7 +86,7 @@ pub fn fingerprint(db: &Db, account: u32, kind: &str) -> Result<String> {
/// The ids of the account in this realm, without the bank vanity items. /// The ids of the account in this realm, without the bank vanity items.
pub fn read_set(db: &Db, account: u32, kind: &str) -> Result<IdSet> { pub fn read_set(db: &Db, account: u32, kind: &str) -> Result<IdSet> {
coa_only(db)?; check_ruleset(db, kind)?;
let (table, column, _) = layout(kind)?; let (table, column, _) = layout(kind)?;
let out = db.query(&format!("SELECT `{column}` FROM acore_characters.`{table}` WHERE `account_id` = {account} ORDER BY `{column}`")).map_err(realm_error)?; let out = db.query(&format!("SELECT `{column}` FROM acore_characters.`{table}` WHERE `account_id` = {account} ORDER BY `{column}`")).map_err(realm_error)?;
let mut ids = Vec::new(); let mut ids = Vec::new();
@@ -91,7 +95,9 @@ pub fn read_set(db: &Db, account: u32, kind: &str) -> Result<IdSet> {
.trim() .trim()
.parse() .parse()
.map_err(|_| PortableError::CorruptSnapshot(format!("{line:?} is not an id")))?; .map_err(|_| PortableError::CorruptSnapshot(format!("{line:?} is not an id")))?;
if kind == "coa:vanity" && is_bank_vanity_item(id) { if (kind == "coa:vanity" || kind == "wildcard:vanity" || kind == "reborn:vanity")
&& is_bank_vanity_item(id)
{
continue; continue;
} }
ids.push(id); ids.push(id);
@@ -117,21 +123,21 @@ pub fn apply_set(
canonical: &IdSet, canonical: &IdSet,
knowledge: &RealmKnowledge, knowledge: &RealmKnowledge,
) -> Result<Applied> { ) -> Result<Applied> {
coa_only(db)?; check_ruleset(db, kind)?;
let (table, column, has_source) = layout(kind)?; let (table, column, has_source) = layout(kind)?;
let known = |id: u32| match kind { let known = |id: u32| match kind {
"coa:appearance" => knowledge.knows_appearance(id), "coa:appearance" | "wildcard:appearance" | "reborn:appearance" => {
knowledge.knows_appearance(id)
}
_ => knowledge.knows_vanity(id) && !is_bank_vanity_item(id), _ => knowledge.knows_vanity(id) && !is_bank_vanity_item(id),
}; };
let held = read_set(db, account, kind)?; let held = read_set(db, account, kind)?;
let mut applied = Applied::default(); let mut applied = Applied::default();
let mut wanted = Vec::new(); let mut wanted = Vec::new();
for id in canonical for id in canonical.ids().iter().copied().filter(|id| {
.ids() !((kind == "coa:vanity" || kind == "wildcard:vanity" || kind == "reborn:vanity")
.iter() && is_bank_vanity_item(*id))
.copied() }) {
.filter(|id| !(kind == "coa:vanity" && is_bank_vanity_item(*id)))
{
if !known(id) { if !known(id) {
applied.unknown += 1; applied.unknown += 1;
} else if held.contains(id) { } else if held.contains(id) {
@@ -168,9 +168,11 @@ fn account_collections_are_read_cheaply_unioned_and_written_without_duplicates_o
let (mut store, _) = fresh_store(); let (mut store, _) = fresh_store();
let profile = store.default_profile().unwrap(); let profile = store.default_profile().unwrap();
store store
.merge_collection(profile, APPEARANCE, &wardrobe) .merge_collection(profile, Ruleset::Coa, APPEARANCE, &wardrobe)
.unwrap();
store
.merge_collection(profile, Ruleset::Coa, VANITY, &vanity)
.unwrap(); .unwrap();
store.merge_collection(profile, VANITY, &vanity).unwrap();
let fingerprint_a = fingerprint(&r.a, 5001, APPEARANCE).unwrap(); let fingerprint_a = fingerprint(&r.a, 5001, APPEARANCE).unwrap();
assert_eq!( assert_eq!(
fingerprint(&r.a, 5001, APPEARANCE).unwrap(), fingerprint(&r.a, 5001, APPEARANCE).unwrap(),
@@ -331,10 +333,20 @@ fn the_result_comes_back_to_realm_a_unchanged_gameplay_and_complete_collections(
reconcile_session(&r.b, &mut store, id, B, true, None).unwrap(); reconcile_session(&r.b, &mut store, id, B, true, None).unwrap();
for kind in [APPEARANCE, VANITY] { for kind in [APPEARANCE, VANITY] {
store store
.merge_collection(profile, kind, &read_set(&r.b, ACCOUNT, kind).unwrap()) .merge_collection(
profile,
Ruleset::Coa,
kind,
&read_set(&r.b, ACCOUNT, kind).unwrap(),
)
.unwrap(); .unwrap();
store store
.merge_collection(profile, kind, &read_set(&r.a, 5001, kind).unwrap()) .merge_collection(
profile,
Ruleset::Coa,
kind,
&read_set(&r.a, 5001, kind).unwrap(),
)
.unwrap(); .unwrap();
} }
@@ -343,7 +355,10 @@ fn the_result_comes_back_to_realm_a_unchanged_gameplay_and_complete_collections(
let updated = let updated =
update_realm_character(&r.a, &mut store, id, "realm-a", &options(a_known.clone())).unwrap(); update_realm_character(&r.a, &mut store, id, "realm-a", &options(a_known.clone())).unwrap();
assert!(updated.updated, "{updated:?}"); assert!(updated.updated, "{updated:?}");
let (_, canonical_wardrobe) = store.collection(profile, APPEARANCE).unwrap().unwrap(); let (_, canonical_wardrobe) = store
.collection(profile, Ruleset::Coa, APPEARANCE)
.unwrap()
.unwrap();
let applied = apply_set(&r.a, 5001, APPEARANCE, &canonical_wardrobe, &a_known).unwrap(); let applied = apply_set(&r.a, 5001, APPEARANCE, &canonical_wardrobe, &a_known).unwrap();
assert_eq!(applied.inserted, 1, "only 1300 is new to A"); assert_eq!(applied.inserted, 1, "only 1300 is new to A");
assert_eq!( assert_eq!(
+1 -1
View File
@@ -55,7 +55,7 @@ pub fn ruleset_of(db: &Db) -> Result<Ruleset> {
match db.realm() { match db.realm() {
Mode::Coa => Ok(Ruleset::Coa), Mode::Coa => Ok(Ruleset::Coa),
Mode::Wildcard => Ok(Ruleset::Wildcard), Mode::Wildcard => Ok(Ruleset::Wildcard),
Mode::Reborn => Err(PortableError::Invalid("Portable characters are not supported on Warcraft Reborn realms yet.".into())), Mode::Reborn => Ok(Ruleset::Reborn),
} }
} }
@@ -14,7 +14,9 @@ use super::super::extension::{
}; };
use super::super::ids::CharacterId; use super::super::ids::CharacterId;
use super::super::model::PortableCharacter; use super::super::model::PortableCharacter;
use super::super::session::protocol::{COLLECTION_KINDS, PROTOCOL_VERSION}; use super::super::session::protocol::{
collection_kinds, COLLECTION_PROTOCOL_VERSION, SESSION_PROTOCOL_VERSION,
};
use super::super::store::Store; use super::super::store::Store;
use super::import::ImportOptions; use super::import::ImportOptions;
use super::script::SchemaProbe; use super::script::SchemaProbe;
@@ -97,13 +99,16 @@ pub fn assemble(
online_import_job_formats: core online_import_job_formats: core
.map(|c| c.portable.job_formats.clone()) .map(|c| c.portable.job_formats.clone())
.unwrap_or_default(), .unwrap_or_default(),
session_protocol: PROTOCOL_VERSION, session_protocol: SESSION_PROTOCOL_VERSION,
collection_protocol: PROTOCOL_VERSION, collection_protocol: COLLECTION_PROTOCOL_VERSION,
features, features,
collection_kinds: if probe.has("account_appearance_collection") collection_kinds: if probe.has("account_appearance_collection")
&& probe.has("account_vanity_collection") && probe.has("account_vanity_collection")
{ {
COLLECTION_KINDS.iter().map(|k| k.to_string()).collect() collection_kinds(ruleset_of(db)?)
.iter()
.map(|k| k.to_string())
.collect()
} else { } else {
Default::default() Default::default()
}, },
+1 -1
View File
@@ -729,7 +729,7 @@ fn the_wildcard_ruleset_uses_its_own_namespace_and_quarantines_wildcard_state()
let wc_db = Db::with_tools(std::path::PathBuf::new(), 1, "root", "x", Mode::Wildcard); let wc_db = Db::with_tools(std::path::PathBuf::new(), 1, "root", "x", Mode::Wildcard);
let coa_db = Db::with_tools(std::path::PathBuf::new(), 1, "root", "x", Mode::Coa); let coa_db = Db::with_tools(std::path::PathBuf::new(), 1, "root", "x", Mode::Coa);
let reborn_db = Db::with_tools(std::path::PathBuf::new(), 1, "root", "x", Mode::Reborn); let reborn_db = Db::with_tools(std::path::PathBuf::new(), 1, "root", "x", Mode::Reborn);
assert!(ruleset_of(&reborn_db).is_err()); assert_eq!(ruleset_of(&reborn_db).unwrap(), Ruleset::Reborn);
assert_eq!( assert_eq!(
(ruleset_of(&wc_db).unwrap(), ruleset_of(&coa_db).unwrap()), (ruleset_of(&wc_db).unwrap(), ruleset_of(&coa_db).unwrap()),
(Ruleset::Wildcard, Ruleset::Coa) (Ruleset::Wildcard, Ruleset::Coa)
+11 -2
View File
@@ -112,6 +112,7 @@ pub struct RealmAccess {
pub job_dir: PathBuf, pub job_dir: PathBuf,
pub data_dir: PathBuf, pub data_dir: PathBuf,
pub game_server_users: Vec<String>, pub game_server_users: Vec<String>,
pub mode: Option<crate::realms::Mode>,
source: Source, source: Source,
} }
@@ -198,6 +199,7 @@ impl RealmAccess {
job_dir: PathBuf::from(&d.job_dir), job_dir: PathBuf::from(&d.job_dir),
data_dir: PathBuf::from(&d.data_dir), data_dir: PathBuf::from(&d.data_dir),
game_server_users: d.game_server_users.clone(), game_server_users: d.game_server_users.clone(),
mode: None,
source: Source::Descriptor(Box::new(d)), source: Source::Descriptor(Box::new(d)),
}) })
} }
@@ -219,6 +221,7 @@ impl RealmAccess {
job_dir: root.join("Core").join("PortableImport"), job_dir: root.join("Core").join("PortableImport"),
data_dir: root.join("Data"), data_dir: root.join("Data"),
game_server_users: default_game_users(), game_server_users: default_game_users(),
mode: None,
source: Source::Install { source: Source::Install {
root: root.to_path_buf(), root: root.to_path_buf(),
}, },
@@ -228,13 +231,19 @@ impl RealmAccess {
/// The database with full rights (imports and updates of a stopped realm, reading characters). /// The database with full rights (imports and updates of a stopped realm, reading characters).
pub fn db(&self) -> Result<Db> { pub fn db(&self) -> Result<Db> {
match &self.source { match &self.source {
Source::Install { root } => Db::from_repack(root, Account::Admin), Source::Install { root } => {
let mut d = Db::from_repack(root, Account::Admin)?;
if let Some(m) = self.mode {
d = d.for_realm(m);
}
Ok(d)
}
Source::Descriptor(d) => Ok(Db::with_tools( Source::Descriptor(d) => Ok(Db::with_tools(
PathBuf::from(&d.mysql_bin), PathBuf::from(&d.mysql_bin),
d.db_port, d.db_port,
leak(&d.db_user), leak(&d.db_user),
d.db_password.expose(), d.db_password.expose(),
Mode::Coa, self.mode.unwrap_or(Mode::Coa),
)), )),
} }
} }
+147 -40
View File
@@ -31,6 +31,8 @@ use serde::{Deserialize, Serialize};
use crate::db::Db; use crate::db::Db;
use crate::ra::Ra; use crate::ra::Ra;
mod remote_sync;
use super::super::capabilities::RealmCapabilities; use super::super::capabilities::RealmCapabilities;
use super::super::compat::{self, CompatibilityReport, Inputs, Operation, Outcome, Topic}; use super::super::compat::{self, CompatibilityReport, Inputs, Operation, Outcome, Topic};
use super::super::error::PortableError; use super::super::error::PortableError;
@@ -136,6 +138,7 @@ struct Saved {
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct ClaimBundle { pub struct ClaimBundle {
pub character_id: CharacterId, pub character_id: CharacterId,
pub ruleset: super::super::model::Ruleset,
pub payload: Vec<u8>, pub payload: Vec<u8>,
pub content_hash: [u8; 32], pub content_hash: [u8; 32],
pub collections: BTreeMap<String, Vec<u32>>, pub collections: BTreeMap<String, Vec<u32>>,
@@ -181,6 +184,16 @@ pub fn class_name(class: &str) -> String {
.and_then(|n| n.parse().ok()) .and_then(|n| n.parse().ok())
.unwrap_or(0); .unwrap_or(0);
match id { match id {
1 => "Warrior",
2 => "Paladin",
3 => "Hunter",
4 => "Rogue",
5 => "Priest",
6 => "Death Knight",
7 => "Shaman",
8 => "Mage",
9 => "Warlock",
11 => "Druid",
12 => "Barbarian", 12 => "Barbarian",
13 => "Witch Doctor", 13 => "Witch Doctor",
14 => "Felsworn", 14 => "Felsworn",
@@ -363,11 +376,26 @@ impl PortableService {
pub fn reload_realms(&mut self) { pub fn reload_realms(&mut self) {
let (descriptors, broken) = access::load_descriptors(&self.dir.join("realms")); let (descriptors, broken) = access::load_descriptors(&self.dir.join("realms"));
self.broken_descriptors = broken; self.broken_descriptors = broken;
let mut realms: Vec<RealmAccess> = self let mut realms: Vec<RealmAccess> = Vec::new();
.installs for (id, root) in &self.installs {
.iter() realms.push(RealmAccess::from_install(id, root));
.map(|(id, root)| RealmAccess::from_install(id, root)) if let Ok(state) = crate::realms::state(root) {
.collect(); if state.wildcard_created {
let mut wc = RealmAccess::from_install(id, root);
wc.id = format!("srv-{id}:wildcard");
wc.name = format!("{} — Wildcard", wc.name);
wc.mode = Some(crate::realms::Mode::Wildcard);
realms.push(wc);
}
if state.reborn_created {
let mut rb = RealmAccess::from_install(id, root);
rb.id = format!("srv-{id}:reborn");
rb.name = format!("{} — Warcraft Reborn", rb.name);
rb.mode = Some(crate::realms::Mode::Reborn);
realms.push(rb);
}
}
}
for d in descriptors { for d in descriptors {
match RealmAccess::from_descriptor(d) { match RealmAccess::from_descriptor(d) {
Ok(a) if !realms.iter().any(|r| r.id == a.id) => realms.push(a), Ok(a) if !realms.iter().any(|r| r.id == a.id) => realms.push(a),
@@ -414,10 +442,10 @@ impl PortableService {
} }
fn access(&self, id: &str) -> Res<RealmAccess> { fn access(&self, id: &str) -> Res<RealmAccess> {
self.realms if let Some(r) = self.realms.iter().find(|r| r.id == id) {
.iter() return Ok(r.clone());
.find(|r| r.id == id) }
.cloned() crate::realm_registry::advert::find_access(&self.dir.join("realms"), &self.installs, id)
.ok_or_else(|| fail("realm_missing", "That realm is not known to this Manager.")) .ok_or_else(|| fail("realm_missing", "That realm is not known to this Manager."))
} }
@@ -703,6 +731,12 @@ impl PortableService {
updated_at: at, updated_at: at,
}); });
} }
let remote_active = self
.owner
.owner_active_remote(c.character_id)
.ok()
.flatten()
.is_some();
let active = copies let active = copies
.iter() .iter()
.find(|x| { .find(|x| {
@@ -715,9 +749,9 @@ impl PortableService {
) )
}) })
.cloned(); .cloned();
let status = active let status = remote_active
.as_ref() .then_some(PlayStatus::Syncing)
.map(|a| a.status) .or_else(|| active.as_ref().map(|a| a.status))
.or_else(|| { .or_else(|| {
copies copies
.iter() .iter()
@@ -728,6 +762,7 @@ impl PortableService {
characters.push(CharacterView { characters.push(CharacterView {
id: c.character_id.to_string(), id: c.character_id.to_string(),
name: c.name, name: c.name,
ruleset: c.ruleset,
class_name: class_name(&c.class), class_name: class_name(&c.class),
race: c.race, race: c.race,
level: c.level, level: c.level,
@@ -1291,6 +1326,11 @@ impl PortableService {
if events.is_ok() { if events.is_ok() {
delivery = (|| { delivery = (|| {
for m in host.outbox()? { for m in host.outbox()? {
if self.owner.owner_session_realm(m.session_id)?.as_deref()
!= Some(access.id.as_str())
{
continue; // The remote Owner must acknowledge its own baseline and checkpoints.
}
let mut owner = OwnerService::new(&mut self.owner); let mut owner = OwnerService::new(&mut self.owner);
let ack: OwnerAck = if m.started { let ack: OwnerAck = if m.started {
owner.handle_started(&m.bytes)? owner.handle_started(&m.bytes)?
@@ -1304,6 +1344,25 @@ impl PortableService {
} }
} }
for m in host.collection_outbox()? { for m in host.collection_outbox()? {
let local_owner =
host.store()
.host_live_sessions(&access.id)?
.iter()
.any(|session| {
session.local_guid.is_some_and(|guid| {
realm::collections::account_of(&db, guid).ok().flatten()
== Some(m.account)
}) && self
.owner
.owner_session_realm(session.session_id)
.ok()
.flatten()
.as_deref()
== Some(access.id.as_str())
});
if !local_owner {
continue;
}
let ack = OwnerService::new(&mut self.owner).handle_collection(&m.bytes)?; let ack = OwnerService::new(&mut self.owner).handle_collection(&m.bytes)?;
host.receive_collection_ack(&mut bridge, m.account, &ack)?; host.receive_collection_ack(&mut bridge, m.account, &ack)?;
} }
@@ -1356,6 +1415,7 @@ impl PortableService {
.map_err(|e| fail("realm_offline", e.to_string()))?; .map_err(|e| fail("realm_offline", e.to_string()))?;
let list = let list =
realm::inspect_characters(&db).map_err(|e| fail("realm_offline", e.to_string()))?; realm::inspect_characters(&db).map_err(|e| fail("realm_offline", e.to_string()))?;
let realm_ruleset = realm::ruleset_of(&db)?;
let mut out = Vec::new(); let mut out = Vec::new();
for c in list { for c in list {
if self.host.find_by_local(realm_id, c.local_guid)?.is_some() { if self.host.find_by_local(realm_id, c.local_guid)?.is_some() {
@@ -1364,7 +1424,7 @@ impl PortableService {
out.push(LocalCharacterView { out.push(LocalCharacterView {
token: c.local_guid, token: c.local_guid,
name: c.name.clone(), name: c.name.clone(),
class_name: class_name(&format!("coa:class:{}", c.class)), class_name: class_name(&format!("{}:class:{}", realm_ruleset.as_str(), c.class)),
level: c.level, level: c.level,
account: c.username.clone().unwrap_or_default(), account: c.username.clone().unwrap_or_default(),
eligible: c.eligible(), eligible: c.eligible(),
@@ -1438,18 +1498,18 @@ impl PortableService {
let model = self.host.load_current(character_id)?; let model = self.host.load_current(character_id)?;
let encoded = super::super::snapshot::encode(&model)?; let encoded = super::super::snapshot::encode(&model)?;
let mut collections = BTreeMap::new(); let mut collections = BTreeMap::new();
if realm::ruleset_of(&db)? == super::super::model::Ruleset::Coa { let realm_ruleset = realm::ruleset_of(&db)?;
if let Some(account) = realm::collections::account_of(&db, local_guid)? { if let Some(account) = realm::collections::account_of(&db, local_guid)? {
for kind in ["coa:appearance", "coa:vanity"] { for kind in super::super::session::protocol::collection_kinds(realm_ruleset) {
if let Ok(set) = realm::collections::read_set(&db, account, kind) { if let Ok(set) = realm::collections::read_set(&db, account, kind) {
collections.insert(kind.to_string(), set.ids().to_vec()); collections.insert(kind.to_string(), set.ids().to_vec());
}
} }
} }
} }
self.publish(); self.publish();
Ok(ClaimBundle { Ok(ClaimBundle {
character_id, character_id,
ruleset: model.ruleset,
payload: encoded.payload, payload: encoded.payload,
content_hash: encoded.content_hash, content_hash: encoded.content_hash,
collections, collections,
@@ -1473,17 +1533,25 @@ impl PortableService {
"The character data does not belong to the character that was claimed.", "The character data does not belong to the character that was claimed.",
)); ));
} }
let ruleset = model.ruleset;
for kind in collections.keys() {
if !super::super::session::protocol::carried_kind_for(kind, ruleset) {
return Err(fail(
"incompatible",
format!("Foreign collection kind {kind:?} in {ruleset} claim"),
));
}
}
if self.owner.character(character_id).is_err() { if self.owner.character(character_id).is_err() {
self.owner self.owner
.create_character_with_id(self.owner_profile, model, realm_id)?; .create_character_with_id(self.owner_profile, model, realm_id)?;
} }
for (kind, ids) in collections { for (kind, ids) in collections {
if !matches!(kind.as_str(), "coa:appearance" | "coa:vanity") { if super::super::session::protocol::carried_kind_for(kind, ruleset) {
continue; let set = super::super::collection::IdSet::from_ids(ids.iter().copied())?;
self.owner
.merge_collection(self.owner_profile, ruleset, kind, &set)?;
} }
let set = super::super::collection::IdSet::from_ids(ids.iter().copied())?;
self.owner
.merge_collection(self.owner_profile, kind, &set)?;
} }
self.publish(); self.publish();
self.state() self.state()
@@ -1499,13 +1567,17 @@ impl PortableService {
let model = self.owner.load_current(cid)?; let model = self.owner.load_current(cid)?;
let encoded = super::super::snapshot::encode(&model)?; let encoded = super::super::snapshot::encode(&model)?;
let mut collections = BTreeMap::new(); let mut collections = BTreeMap::new();
for kind in ["coa:appearance", "coa:vanity"] { for kind in super::super::session::protocol::collection_kinds(model.ruleset) {
if let Ok(Some((_, set))) = self.owner.collection(self.owner_profile, kind) { if let Ok(Some((_, set))) =
self.owner
.collection(self.owner_profile, model.ruleset, kind)
{
collections.insert(kind.to_string(), set.ids().to_vec()); collections.insert(kind.to_string(), set.ids().to_vec());
} }
} }
Ok(ClaimBundle { Ok(ClaimBundle {
character_id: cid, character_id: cid,
ruleset: model.ruleset,
payload: encoded.payload, payload: encoded.payload,
content_hash: encoded.content_hash, content_hash: encoded.content_hash,
collections, collections,
@@ -1591,40 +1663,75 @@ impl PortableService {
let opts = self.options(&access, &caps); let opts = self.options(&access, &caps);
// Preflight compatibility check before ANY mutation // Preflight compatibility check before ANY mutation
let db_ruleset = super::super::realm::ruleset_of(&db)?;
if model.ruleset != db_ruleset {
return Err(fail(
"incompatible",
"Character ruleset does not match realm database ruleset.",
));
}
let caps_ruleset: crate::portable::model::Ruleset = caps.content.ruleset;
if model.ruleset != caps_ruleset {
return Err(fail(
"incompatible",
"Character ruleset does not match realm capability ruleset.",
));
}
let ops = [Operation::OnlineImport, Operation::RuntimeSession]; let ops = [Operation::OnlineImport, Operation::RuntimeSession];
let report = self.report(&model, &caps, &opts, &ops, true); let report = self.report(&model, &caps, &opts, &ops, true);
if verdict_of(report.verdict()) == Verdict::Incompatible { if verdict_of(report.verdict()) == Verdict::Incompatible {
#[cfg(test)]
eprintln!("Remote import compatibility: {report:?}");
return Err(fail( return Err(fail(
"incompatible", "incompatible",
"Character is incompatible with this realm; nothing was changed.", "Character is incompatible with this realm; nothing was changed.",
)); ));
} }
// Install or advance copy in host store
self.host
.host_install_copy(self.host_profile, &model, params.revision, "remote")?;
// Monotonic union of collections
for (kind, ids) in &params.collections {
if matches!(kind.as_str(), "coa:appearance" | "coa:vanity") {
if let Ok(set) = super::super::collection::IdSet::from_ids(ids.iter().copied()) {
let _ = self.host.merge_collection(self.host_profile, kind, &set);
}
}
}
let existing_mapping = self let existing_mapping = self
.host .host
.server_mappings(cid)? .server_mappings(cid)?
.into_iter() .into_iter()
.find(|m| m.server_id == realm_id); .find(|m| m.server_id == realm_id);
let session_id = SessionId::new(); // A live realm must never arm stale data as a new canonical revision.
if existing_mapping
.as_ref()
.is_some_and(|mapping| mapping.last_revision != params.revision)
{
return Err(fail("update_required", "The realm's existing copy needs an offline refresh by its owner before this revision can be played. Your canonical character is unchanged."));
}
// Install or advance copy in host store
self.host
.host_install_copy(self.host_profile, &model, params.revision, "remote")?;
// Monotonic union of collections
for (kind, ids) in &params.collections {
if !super::super::session::protocol::carried_kind_for(kind, model.ruleset) {
return Err(fail(
"incompatible",
format!(
"Foreign collection kind {kind:?} in {} remote transfer",
model.ruleset
),
));
}
if let Ok(set) = super::super::collection::IdSet::from_ids(ids.iter().copied()) {
let _ = self
.host
.merge_collection(self.host_profile, model.ruleset, kind, &set);
}
}
let session_id = SessionId::from_uuid(params.session_id)?;
let envelope = super::super::session::protocol::Envelope::from_encoded( let envelope = super::super::session::protocol::Envelope::from_encoded(
&super::super::snapshot::encode(&model)?, &super::super::snapshot::encode(&model)?,
); );
let offer = super::super::session::protocol::SessionOffer { let offer = super::super::session::protocol::SessionOffer {
protocol_version: super::super::session::protocol::PROTOCOL_VERSION, protocol_version: super::super::session::protocol::PROTOCOL_VERSION,
ruleset: model.ruleset,
session_id, session_id,
character_id: cid, character_id: cid,
server_id: realm_id.to_string(), server_id: realm_id.to_string(),
@@ -0,0 +1,345 @@
use super::*;
use crate::control::service::{RemoteSessionMessage, RemoteSessionState};
use crate::portable::session::protocol::{
self, CollectionAck, CollectionObserved, OwnerAck, PortableCheckpoint, PortableSessionStarted,
};
use coa_control_proto::app::SessionMessageKind;
pub fn owner_realm(realm: &str) -> String {
format!("remote-{realm}")
}
impl PortableService {
/// Open the Owner's durable session before its snapshot leaves this computer.
pub fn prepare_remote_transfer(
&mut self,
character: &str,
realm: &str,
) -> Res<(ClaimBundle, uuid::Uuid, u64)> {
let cid = self.cid(character)?;
let offer = OwnerService::new(&mut self.owner).offer(cid, &owner_realm(realm))?;
let bundle = self.export_for_remote_transfer(character)?;
self.publish();
Ok((bundle, offer.session_id.as_uuid(), offer.canonical_revision))
}
pub fn remote_session_closed(&self, session: uuid::Uuid) -> Res<bool> {
let sid = SessionId::from_uuid(session)?;
Ok(self
.owner
.owner_session_info(sid)?
.is_some_and(|row| row.0 == "closed"))
}
pub fn remote_session_idle(&self, session: uuid::Uuid) -> Res<bool> {
let sid = SessionId::from_uuid(session)?;
Ok(self
.owner
.owner_session_info(sid)?
.is_some_and(|row| row.0 == "offered" || row.0 == "superseded"))
}
pub fn next_remote_session(
&self,
character: uuid::Uuid,
realm: &str,
) -> Res<Option<uuid::Uuid>> {
Ok(self
.owner
.owner_next_session(CharacterId::from_uuid(character)?, &owner_realm(realm))?
.map(|sid| sid.as_uuid()))
}
/// The channel authenticates the public realm. Its private local id is never an Owner-side namespace.
pub fn apply_remote_session_message(
&mut self,
character: uuid::Uuid,
session: uuid::Uuid,
realm: &str,
kind: SessionMessageKind,
bytes: &[u8],
) -> Res<Vec<u8>> {
let cid = CharacterId::from_uuid(character)?;
let sid = SessionId::from_uuid(session)?;
let scope = owner_realm(realm);
if self.owner.owner_session_realm(sid)?.as_deref() != Some(scope.as_str()) {
return Err(fail(
"not_yours",
"This remote session was not opened by this Manager.",
));
}
let ruleset = self.owner.character(cid)?.ruleset;
let answer = match kind {
SessionMessageKind::Started => {
let mut message: PortableSessionStarted = protocol::from_json(bytes)?;
if message.character_id != cid
|| message.session_id != sid
|| message.ruleset != ruleset
{
return Err(fail(
"not_yours",
"The baseline belongs to another character or session.",
));
}
message.server_id = scope;
let ack = self.owner.owner_session_started(&message)?;
protocol::to_json(&ack)?
}
SessionMessageKind::Checkpoint => {
let mut message: PortableCheckpoint = protocol::from_json(bytes)?;
if message.character_id != cid
|| message.session_id != sid
|| message.ruleset != ruleset
{
return Err(fail(
"not_yours",
"The checkpoint belongs to another character or session.",
));
}
message.server_id = scope;
let ack = self.owner.owner_checkpoint(&message)?;
protocol::to_json(&ack)?
}
SessionMessageKind::Collection => {
let mut message: CollectionObserved = protocol::collection_from_json(bytes)?;
if message.ruleset != ruleset {
return Err(fail(
"incompatible",
"The collection belongs to another ruleset.",
));
}
message.server_id = scope;
let ack = OwnerService::new(&mut self.owner)
.handle_collection(&protocol::collection_to_json(&message)?)?;
protocol::collection_to_json(&ack)?
}
};
self.publish();
Ok(answer)
}
fn checked_remote_session(
&self,
realm: &str,
character: uuid::Uuid,
session: uuid::Uuid,
account: u32,
) -> Res<(RealmAccess, crate::portable::store::HostSession)> {
let access = self.access(realm)?;
let cid = CharacterId::from_uuid(character)?;
let sid = SessionId::from_uuid(session)?;
let row = self
.host
.host_session(sid)?
.ok_or_else(|| fail("not_yours", "Unknown portable session."))?;
if row.character_id != cid || row.server_id != realm {
return Err(fail(
"not_yours",
"The portable session belongs to another realm or character.",
));
}
let guid = row
.local_guid
.ok_or_else(|| fail("not_yours", "The portable session has no realm character."))?;
if realm::collections::account_of(&access.db()?, guid)? != Some(account) {
return Err(fail(
"not_yours",
"The portable session belongs to another account.",
));
}
Ok((access, row))
}
pub fn remote_session_message(
&mut self,
realm: &str,
character: uuid::Uuid,
session: uuid::Uuid,
account: u32,
) -> Res<RemoteSessionState> {
let (_, row) = self.checked_remote_session(realm, character, session, account)?;
let host = HostService::new(&mut self.host, realm, self.host_config.clone());
let collection = host
.collection_outbox()?
.into_iter()
.find(|message| message.account == account);
let message = if let Some(message) = collection {
Some(RemoteSessionMessage {
kind: SessionMessageKind::Collection,
bytes: message.bytes,
})
} else {
host.outbox()?
.into_iter()
.find(|message| message.session_id == row.session_id)
.map(|message| RemoteSessionMessage {
kind: if message.started {
SessionMessageKind::Started
} else {
SessionMessageKind::Checkpoint
},
bytes: message.bytes,
})
};
Ok(RemoteSessionState {
message,
closed: row.state == crate::portable::store::HostState::Closed,
})
}
pub fn apply_remote_session_ack(
&mut self,
realm: &str,
character: uuid::Uuid,
session: uuid::Uuid,
account: u32,
kind: SessionMessageKind,
bytes: &[u8],
) -> Res<()> {
let (access, row) = self.checked_remote_session(realm, character, session, account)?;
let db = access.db()?;
let knowledge = RealmKnowledge::from_data_dir(&access.data_dir)
.ok()
.map(Arc::new);
let mut bridge = LiveBridge::new(
&db,
access
.ra()
.map_err(|error| fail("realm_offline", error.to_string()))?,
)
.with_knowledge(knowledge);
let mut host = HostService::new(&mut self.host, realm, self.host_config.clone());
match kind {
SessionMessageKind::Collection => {
let ack: CollectionAck = protocol::collection_from_json(bytes)?;
host.receive_collection_ack(&mut bridge, account, &ack)?;
}
_ => {
let ack: OwnerAck = protocol::from_json(bytes)?;
if ack.session_id != row.session_id {
return Err(fail(
"not_yours",
"The acknowledgement belongs to another session.",
));
}
host.receive_ack(&mut bridge, &ack)?;
}
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::portable::{
fixtures::geared_level_eighty,
session::protocol::{AckOutcome, PortableCheckpoint, PortableSessionStarted},
};
#[test]
fn remote_progress_is_scoped_durable_and_idempotent() {
let dir = tempfile::tempdir().unwrap();
let mut service = PortableService::open(dir.path(), vec![]).unwrap();
let model = geared_level_eighty();
let cid = model.character_id;
service
.owner
.host_install_copy(service.owner_profile, &model, 7, "fixture")
.unwrap();
let (_, sid, revision) = service
.prepare_remote_transfer(&cid.to_string(), "public-realm")
.unwrap();
assert_eq!(revision, 7);
let session = SessionId::from_uuid(sid).unwrap();
let started =
PortableSessionStarted::new(session, cid, "private-host-id", revision, 1, &model, None)
.unwrap();
let bytes = protocol::to_json(&started).unwrap();
assert!(service
.apply_remote_session_message(
cid.as_uuid(),
sid,
"other-realm",
SessionMessageKind::Started,
&bytes
)
.is_err());
assert!(service
.apply_remote_session_message(
uuid::Uuid::now_v7(),
sid,
"public-realm",
SessionMessageKind::Started,
&bytes
)
.is_err());
let ack: OwnerAck = protocol::from_json(
&service
.apply_remote_session_message(
cid.as_uuid(),
sid,
"public-realm",
SessionMessageKind::Started,
&bytes,
)
.unwrap(),
)
.unwrap();
assert_eq!(ack.outcome, AckOutcome::Applied);
assert_eq!(service.state().characters[0].status, PlayStatus::Syncing);
assert!(service
.prepare_remote_transfer(&cid.to_string(), "other-realm")
.is_err());
drop(service);
let mut service = PortableService::open(dir.path(), vec![]).unwrap();
let mut changed = model.clone();
changed.progression.money += 123;
let checkpoint = PortableCheckpoint::new(
session,
cid,
"private-host-id",
revision,
1,
true,
&changed,
None,
)
.unwrap();
let bytes = protocol::to_json(&checkpoint).unwrap();
let first: OwnerAck = protocol::from_json(
&service
.apply_remote_session_message(
cid.as_uuid(),
sid,
"public-realm",
SessionMessageKind::Checkpoint,
&bytes,
)
.unwrap(),
)
.unwrap();
assert_eq!(first.outcome, AckOutcome::Applied);
let again: OwnerAck = protocol::from_json(
&service
.apply_remote_session_message(
cid.as_uuid(),
sid,
"public-realm",
SessionMessageKind::Checkpoint,
&bytes,
)
.unwrap(),
)
.unwrap();
assert_eq!(again.outcome, AckOutcome::Duplicate);
assert_eq!(first.canonical_revision, again.canonical_revision);
assert!(service.remote_session_closed(sid).unwrap());
drop(service);
let service = PortableService::open(dir.path(), vec![]).unwrap();
assert_eq!(
service.owner.load_current(cid).unwrap().progression.money,
changed.progression.money
);
}
}
@@ -53,6 +53,7 @@ pub struct CopyView {
pub struct CharacterView { pub struct CharacterView {
pub id: String, pub id: String,
pub name: String, pub name: String,
pub ruleset: super::super::model::Ruleset,
pub class_name: String, pub class_name: String,
pub race: String, pub race: String,
pub level: u8, pub level: u8,
@@ -7,7 +7,7 @@ use super::*;
use crate::portable::collection::IdSet; use crate::portable::collection::IdSet;
use crate::portable::fixtures::geared_level_eighty; use crate::portable::fixtures::geared_level_eighty;
use crate::portable::ids::{CharacterId, SessionId}; use crate::portable::ids::{CharacterId, SessionId};
use crate::portable::model::PortableCharacter; use crate::portable::model::{PortableCharacter, Ruleset};
use crate::portable::realm::knowledge::RealmKnowledge; use crate::portable::realm::knowledge::RealmKnowledge;
use crate::portable::store::Store; use crate::portable::store::Store;
@@ -328,10 +328,10 @@ fn a_realm_that_lacks_an_unlock_never_removes_it_and_gets_what_it_knows_back() {
// the Owner already holds a big wardrobe from other realms // the Owner already holds a big wardrobe from other realms
let profile = owner.default_profile().unwrap(); let profile = owner.default_profile().unwrap();
owner owner
.merge_collection(profile, APPEARANCE, &ids(1..=500)) .merge_collection(profile, Ruleset::Coa, APPEARANCE, &ids(1..=500))
.unwrap(); .unwrap();
owner owner
.merge_collection(profile, VANITY, &ids(1000..=1010)) .merge_collection(profile, Ruleset::Coa, VANITY, &ids(1000..=1010))
.unwrap(); .unwrap();
// this realm knows only part of it and holds only a few // this realm knows only part of it and holds only a few
realm.knowledge = knows(ids(1..=300), ids(1000..=1005)); realm.knowledge = knows(ids(1..=300), ids(1000..=1005));
@@ -344,7 +344,11 @@ fn a_realm_that_lacks_an_unlock_never_removes_it_and_gets_what_it_knows_back() {
// the Owner unioned the realm's ids (700 included: the realm showed it) and kept everything else // the Owner unioned the realm's ids (700 included: the realm showed it) and kept everything else
let appearance_ack = acks.iter().find(|a| a.kind == APPEARANCE).unwrap(); let appearance_ack = acks.iter().find(|a| a.kind == APPEARANCE).unwrap();
assert_eq!(appearance_ack.outcome, CollectionOutcome::Applied); assert_eq!(appearance_ack.outcome, CollectionOutcome::Applied);
let (_, canonical) = o.store().collection(profile, APPEARANCE).unwrap().unwrap(); let (_, canonical) = o
.store()
.collection(profile, Ruleset::Coa, APPEARANCE)
.unwrap()
.unwrap();
assert_eq!(canonical.len(), 501); assert_eq!(canonical.len(), 501);
assert!( assert!(
canonical.contains(700) && canonical.contains(1) && canonical.contains(500), canonical.contains(700) && canonical.contains(1) && canonical.contains(500),
@@ -371,12 +375,14 @@ fn an_account_with_unlocks_arrives_on_a_second_realm_from_the_owners_state_alone
let mut owner = Store::open_in_memory().unwrap(); let mut owner = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap(); let profile = owner.default_profile().unwrap();
owner owner
.merge_collection(profile, APPEARANCE, &ids(1..=40)) .merge_collection(profile, Ruleset::Coa, APPEARANCE, &ids(1..=40))
.unwrap(); .unwrap();
owner owner
.merge_collection(profile, VANITY, &ids(50..=60)) .merge_collection(profile, Ruleset::Coa, VANITY, &ids(50..=60))
.unwrap();
let states = OwnerService::new(&mut owner)
.collection_states(Ruleset::Coa)
.unwrap(); .unwrap();
let states = OwnerService::new(&mut owner).collection_states().unwrap();
assert_eq!(states.len(), 2); assert_eq!(states.len(), 2);
let mut host = Store::open_in_memory().unwrap(); let mut host = Store::open_in_memory().unwrap();
@@ -415,16 +421,17 @@ fn hostile_or_broken_collection_messages_change_nothing() {
let mut owner = Store::open_in_memory().unwrap(); let mut owner = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap(); let profile = owner.default_profile().unwrap();
let mut o = OwnerService::new(&mut owner); let mut o = OwnerService::new(&mut owner);
let good = let good = collection_to_json(
collection_to_json(&CollectionObserved::new(SERVER, APPEARANCE, &ids(1..=10)).unwrap()) &CollectionObserved::new(SERVER, Ruleset::Coa, APPEARANCE, &ids(1..=10)).unwrap(),
.unwrap(); )
.unwrap();
assert_eq!( assert_eq!(
o.handle_collection(&good).unwrap().outcome, o.handle_collection(&good).unwrap().outcome,
CollectionOutcome::Applied CollectionOutcome::Applied
); );
let state_of = |o: &OwnerService| { let state_of = |o: &OwnerService| {
o.store() o.store()
.collection_info(profile, APPEARANCE) .collection_info(profile, Ruleset::Coa, APPEARANCE)
.unwrap() .unwrap()
.unwrap() .unwrap()
}; };
@@ -487,13 +494,39 @@ fn hostile_or_broken_collection_messages_change_nothing() {
// a set that decodes to more ids than the cap allows is refused before it is built // a set that decodes to more ids than the cap allows is refused before it is built
let mut huge = vec![1u8]; let mut huge = vec![1u8];
huge.extend([0xFF, 0xFF, 0xFF, 0xFF, 0x0F]); huge.extend([0xFF, 0xFF, 0xFF, 0xFF, 0x0F]);
let message = serde_json::json!({"protocol_version": PROTOCOL_VERSION, "server_id": SERVER, "kind": APPEARANCE, "set": {"hash": "00".repeat(32), "count": 1, "ids": base64::Engine::encode(&base64::engine::general_purpose::STANDARD, huge)}}); let message = serde_json::json!({"protocol_version": COLLECTION_PROTOCOL_VERSION, "ruleset": "coa", "server_id": SERVER, "kind": APPEARANCE, "set": {"hash": "00".repeat(32), "count": 1, "ids": base64::Engine::encode(&base64::engine::general_purpose::STANDARD, huge)}});
assert!(matches!( assert!(matches!(
o.handle_collection(&serde_json::to_vec(&message).unwrap()) o.handle_collection(&serde_json::to_vec(&message).unwrap())
.unwrap() .unwrap()
.outcome, .outcome,
CollectionOutcome::Rejected(_) CollectionOutcome::Rejected(_)
)); ));
// attack test: prefix-confusion collection kinds are strictly rejected with zero state change
for evil_kind in [
"coax:appearance",
"coaevil:vanity",
"wildcard2:appearance",
"reborn-extra:vanity",
"coa:",
"unknown",
"coa:appearance:extra",
] {
let mut v: serde_json::Value = serde_json::from_slice(&good).unwrap();
v["kind"] = evil_kind.into();
let ack = o
.handle_collection(&serde_json::to_vec(&v).unwrap())
.unwrap();
assert!(
matches!(ack.outcome, CollectionOutcome::Rejected(_)),
"evil kind {evil_kind} must be rejected"
);
}
assert_eq!(
state_of(&o),
before,
"prefix confusion attacks must mutate nothing"
);
} }
#[test] #[test]
@@ -555,7 +588,7 @@ fn ten_thousand_and_fifty_thousand_ids_stay_cheap() {
assert_eq!(realm.full_reads, reads); assert_eq!(realm.full_reads, reads);
let stored = o let stored = o
.store() .store()
.collection_info(profile, APPEARANCE) .collection_info(profile, Ruleset::Coa, APPEARANCE)
.unwrap() .unwrap()
.unwrap(); .unwrap();
assert_eq!(stored.count, count as usize); assert_eq!(stored.count, count as usize);
@@ -565,7 +598,7 @@ fn ten_thousand_and_fifty_thousand_ids_stay_cheap() {
let mut empty_realm = FakeRealm::new(GUID); let mut empty_realm = FakeRealm::new(GUID);
empty_realm.knowledge = realm.knowledge.clone(); empty_realm.knowledge = realm.knowledge.clone();
let state = o let state = o
.collection_states() .collection_states(Ruleset::Coa)
.unwrap() .unwrap()
.into_iter() .into_iter()
.find(|s| s.kind == APPEARANCE) .find(|s| s.kind == APPEARANCE)
@@ -627,7 +660,7 @@ fn a_lost_acknowledgement_resends_the_same_set_and_the_owner_counts_it_once() {
.any(|p| p.kind == APPEARANCE)); .any(|p| p.kind == APPEARANCE));
assert_eq!( assert_eq!(
o.store() o.store()
.collection_info(profile, APPEARANCE) .collection_info(profile, Ruleset::Coa, APPEARANCE)
.unwrap() .unwrap()
.unwrap() .unwrap()
.revision, .revision,
@@ -738,3 +771,102 @@ fn a_session_that_changes_nothing_on_a_format_1_store_makes_no_new_revision() {
"the same character in a newer format is not a change" "the same character in a newer format is not a change"
); );
} }
#[test]
fn wildcard_and_coa_collections_remain_strictly_isolated() {
let mut owner = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap();
let coa_set = IdSet::from_ids([10, 20, 30]).unwrap();
let wc_set = IdSet::from_ids([10, 40, 50]).unwrap();
owner
.merge_collection(profile, Ruleset::Coa, "coa:appearance", &coa_set)
.unwrap();
owner
.merge_collection(profile, Ruleset::Wildcard, "wildcard:appearance", &wc_set)
.unwrap();
// Verify initial namespaces
let (_, s_coa) = owner
.collection(profile, Ruleset::Coa, "coa:appearance")
.unwrap()
.unwrap();
assert_eq!(s_coa.ids(), &[10, 20, 30]);
let (_, s_wc) = owner
.collection(profile, Ruleset::Wildcard, "wildcard:appearance")
.unwrap()
.unwrap();
assert_eq!(s_wc.ids(), &[10, 40, 50]);
let mut o = OwnerService::new(&mut owner);
// 1. Valid Wildcard observation updates Wildcard collection only
let wc_update = IdSet::from_ids([10, 40, 50, 60]).unwrap();
let msg_wc = CollectionObserved {
protocol_version: COLLECTION_PROTOCOL_VERSION,
ruleset: Ruleset::Wildcard,
server_id: "wc-realm".into(),
kind: "wildcard:appearance".into(),
set: CompactSet::seal("wildcard:appearance", &wc_update).unwrap(),
};
let ack = o.handle_collection(&to_json(&msg_wc).unwrap()).unwrap();
assert!(matches!(
ack.outcome,
CollectionOutcome::Applied | CollectionOutcome::Unchanged
));
// CoA remains exactly [10, 20, 30]
let (_, s_coa_after) = o
.store()
.collection(profile, Ruleset::Coa, "coa:appearance")
.unwrap()
.unwrap();
assert_eq!(s_coa_after.ids(), &[10, 20, 30]);
// Wildcard updated to [10, 40, 50, 60]
let (_, s_wc_after) = o
.store()
.collection(profile, Ruleset::Wildcard, "wildcard:appearance")
.unwrap()
.unwrap();
assert_eq!(s_wc_after.ids(), &[10, 40, 50, 60]);
// 2. Cross-ruleset injection attack: Wildcard message carrying coa:appearance is rejected
let rogue_wc = CollectionObserved {
protocol_version: COLLECTION_PROTOCOL_VERSION,
ruleset: Ruleset::Wildcard,
server_id: "wc-realm".into(),
kind: "coa:appearance".into(),
set: CompactSet::seal("coa:appearance", &IdSet::from_ids([999]).unwrap()).unwrap(),
};
let ack_rogue = o.handle_collection(&to_json(&rogue_wc).unwrap()).unwrap();
assert!(matches!(ack_rogue.outcome, CollectionOutcome::Rejected(_)));
// 3. Cross-ruleset injection attack: CoA message carrying wildcard:appearance is rejected
let rogue_coa = CollectionObserved {
protocol_version: COLLECTION_PROTOCOL_VERSION,
ruleset: Ruleset::Coa,
server_id: "coa-realm".into(),
kind: "wildcard:appearance".into(),
set: CompactSet::seal("wildcard:appearance", &IdSet::from_ids([999]).unwrap()).unwrap(),
};
let ack_rogue2 = o.handle_collection(&to_json(&rogue_coa).unwrap()).unwrap();
assert!(matches!(ack_rogue2.outcome, CollectionOutcome::Rejected(_)));
// Verify neither 999 touched CoA or Wildcard
let (_, s_coa_final) = o
.store()
.collection(profile, Ruleset::Coa, "coa:appearance")
.unwrap()
.unwrap();
assert_eq!(s_coa_final.ids(), &[10, 20, 30]);
let (_, s_wc_final) = o
.store()
.collection(profile, Ruleset::Wildcard, "wildcard:appearance")
.unwrap()
.unwrap();
assert_eq!(s_wc_final.ids(), &[10, 40, 50, 60]);
}
+8 -4
View File
@@ -467,16 +467,20 @@ impl RealmBridge for FakeRealm {
impl FakeRealm { impl FakeRealm {
fn rows(&self, kind: &str) -> Result<&IdSet> { fn rows(&self, kind: &str) -> Result<&IdSet> {
match kind { match kind {
"coa:appearance" => Ok(&self.appearance_rows), "coa:appearance" | "wildcard:appearance" | "reborn:appearance" => {
"coa:vanity" => Ok(&self.vanity_rows), Ok(&self.appearance_rows)
}
"coa:vanity" | "wildcard:vanity" | "reborn:vanity" => Ok(&self.vanity_rows),
other => Err(PortableError::Invalid(format!("unknown kind {other}"))), other => Err(PortableError::Invalid(format!("unknown kind {other}"))),
} }
} }
fn rows_mut(&mut self, kind: &str) -> Result<&mut IdSet> { fn rows_mut(&mut self, kind: &str) -> Result<&mut IdSet> {
match kind { match kind {
"coa:appearance" => Ok(&mut self.appearance_rows), "coa:appearance" | "wildcard:appearance" | "reborn:appearance" => {
"coa:vanity" => Ok(&mut self.vanity_rows), Ok(&mut self.appearance_rows)
}
"coa:vanity" | "wildcard:vanity" | "reborn:vanity" => Ok(&mut self.vanity_rows),
other => Err(PortableError::Invalid(format!("unknown kind {other}"))), other => Err(PortableError::Invalid(format!("unknown kind {other}"))),
} }
} }
+39 -5
View File
@@ -176,6 +176,26 @@ impl<'a> HostService<'a> {
found: model.character_id, found: model.character_id,
}); });
} }
if offer.ruleset != model.ruleset {
return Err(PortableError::RulesetMismatch {
character: model.ruleset,
realm: offer.ruleset,
});
}
if let Some((_, rs)) = self.server_id.split_once(':') {
let host_ruleset = rs.parse::<crate::portable::Ruleset>().map_err(|_| {
PortableError::Invalid(format!(
"malformed or unknown ruleset suffix in server_id: {:?}",
self.server_id
))
})?;
if offer.ruleset != host_ruleset || model.ruleset != host_ruleset {
return Err(PortableError::RulesetMismatch {
character: model.ruleset,
realm: host_ruleset,
});
}
}
self.store self.store
.host_install_copy(profile, &model, offer.canonical_revision, "owner")?; .host_install_copy(profile, &model, offer.canonical_revision, "owner")?;
self.store.host_prepare_session(offer, &model) self.store.host_prepare_session(offer, &model)
@@ -606,8 +626,16 @@ impl<'a> HostService<'a> {
let Some(account) = bridge.account_of(guid)? else { let Some(account) = bridge.account_of(guid)? else {
continue; continue;
}; };
for kind in COLLECTION_KINDS { let character = self.store.character(s.character_id)?;
self.observe_collection(bridge, account, kind, now_secs, events)?; for kind in collection_kinds(character.ruleset) {
self.observe_collection(
bridge,
account,
character.ruleset,
kind,
now_secs,
events,
)?;
} }
} }
Ok(()) Ok(())
@@ -619,6 +647,7 @@ impl<'a> HostService<'a> {
&mut self, &mut self,
bridge: &mut dyn RealmBridge, bridge: &mut dyn RealmBridge,
account: u32, account: u32,
ruleset: crate::portable::model::Ruleset,
kind: &str, kind: &str,
now_secs: u64, now_secs: u64,
events: &mut Vec<HostEvent>, events: &mut Vec<HostEvent>,
@@ -644,7 +673,12 @@ impl<'a> HostService<'a> {
)?; )?;
return Ok(()); return Ok(());
} }
let bytes = collection_to_json(&CollectionObserved::new(&self.server_id, kind, &set)?)?; let bytes = collection_to_json(&CollectionObserved::new(
&self.server_id,
ruleset,
kind,
&set,
)?)?;
self.store.host_collection_observe( self.store.host_collection_observe(
&self.server_id, &self.server_id,
account, account,
@@ -674,7 +708,7 @@ impl<'a> HostService<'a> {
account: u32, account: u32,
ack: &CollectionAck, ack: &CollectionAck,
) -> Result<Option<Applied>> { ) -> Result<Option<Applied>> {
if !carried_kind(&ack.kind) { if !carried_kind_for(&ack.kind, ack.ruleset) {
return Err(PortableError::Invalid( return Err(PortableError::Invalid(
"the acknowledgement is for a kind that is not carried".into(), "the acknowledgement is for a kind that is not carried".into(),
)); ));
@@ -742,7 +776,7 @@ impl<'a> HostService<'a> {
account: u32, account: u32,
state: &CollectionState, state: &CollectionState,
) -> Result<Option<Applied>> { ) -> Result<Option<Applied>> {
if !carried_kind(&state.kind) { if !carried_kind_for(&state.kind, state.ruleset) {
return Err(PortableError::Invalid( return Err(PortableError::Invalid(
"the collection kind is not carried".into(), "the collection kind is not carried".into(),
)); ));
+31 -14
View File
@@ -49,10 +49,15 @@ impl<'a> OwnerService<'a> {
pub fn handle_collection(&mut self, bytes: &[u8]) -> Result<CollectionAck> { pub fn handle_collection(&mut self, bytes: &[u8]) -> Result<CollectionAck> {
let msg: CollectionObserved = collection_from_json(bytes)?; let msg: CollectionObserved = collection_from_json(bytes)?;
let profile = self.store.default_profile()?; let profile = self.store.default_profile()?;
let ruleset = msg.ruleset;
let rejected = |store: &Store, reason: &str| -> Result<CollectionAck> { let rejected = |store: &Store, reason: &str| -> Result<CollectionAck> {
let info = store.collection_info(profile, &msg.kind).ok().flatten(); let info = store
.collection_info(profile, ruleset, &msg.kind)
.ok()
.flatten();
Ok(CollectionAck { Ok(CollectionAck {
protocol_version: PROTOCOL_VERSION, protocol_version: crate::portable::session::protocol::COLLECTION_PROTOCOL_VERSION,
ruleset,
kind: msg.kind.clone(), kind: msg.kind.clone(),
outcome: CollectionOutcome::Rejected(reason.to_string()), outcome: CollectionOutcome::Rejected(reason.to_string()),
collection_revision: info.as_ref().map_or(0, |i| i.revision), collection_revision: info.as_ref().map_or(0, |i| i.revision),
@@ -60,30 +65,39 @@ impl<'a> OwnerService<'a> {
canonical: None, canonical: None,
}) })
}; };
if !carried_kind(&msg.kind) { if !carried_kind_for(&msg.kind, ruleset) {
return rejected(self.store, "this collection kind is not carried"); return rejected(
self.store,
"this collection kind is not carried for this ruleset",
);
} }
let observed = match msg.set.open(&msg.kind) { let observed = match msg.set.open(&msg.kind) {
Ok(set) => set, Ok(set) => set,
Err(e) => return rejected(self.store, &e.to_string()), Err(e) => return rejected(self.store, &e.to_string()),
}; };
let merge = self.store.merge_collection(profile, &msg.kind, &observed)?; let merge = self
.store
.merge_collection(profile, ruleset, &msg.kind, &observed)?;
let (info, canonical) = self let (info, canonical) = self
.store .store
.collection(profile, &msg.kind)? .collection(profile, ruleset, &msg.kind)?
.map(|(i, s)| (Some(i), s)) .map(|(i, s)| (Some(i), s))
.unwrap_or((None, IdSet::new())); .unwrap_or((None, IdSet::new()));
let canonical_state = match ( let canonical_state = match (
&info, &info,
observed.count_new(&canonical) == 0 && canonical.count_new(&observed) == 0, observed.count_new(&canonical) == 0 && canonical.count_new(&observed) == 0,
) { ) {
(Some(info), false) => { (Some(info), false) => Some(CollectionState::new(
Some(CollectionState::new(&msg.kind, info.revision, &canonical)?) ruleset,
} &msg.kind,
info.revision,
&canonical,
)?),
_ => None, _ => None,
}; };
Ok(CollectionAck { Ok(CollectionAck {
protocol_version: PROTOCOL_VERSION, protocol_version: crate::portable::session::protocol::COLLECTION_PROTOCOL_VERSION,
ruleset,
kind: msg.kind, kind: msg.kind,
outcome: if merge.changed { outcome: if merge.changed {
CollectionOutcome::Applied CollectionOutcome::Applied
@@ -97,12 +111,15 @@ impl<'a> OwnerService<'a> {
} }
/// The canonical collections as messages (for a realm that has none of them yet, or a new one). /// The canonical collections as messages (for a realm that has none of them yet, or a new one).
pub fn collection_states(&mut self) -> Result<Vec<CollectionState>> { pub fn collection_states(
&mut self,
ruleset: crate::portable::model::Ruleset,
) -> Result<Vec<CollectionState>> {
let profile = self.store.default_profile()?; let profile = self.store.default_profile()?;
let mut out = Vec::new(); let mut out = Vec::new();
for kind in COLLECTION_KINDS { for kind in collection_kinds(ruleset) {
if let Some((info, set)) = self.store.collection(profile, kind)? { if let Some((info, set)) = self.store.collection(profile, ruleset, kind)? {
out.push(CollectionState::new(kind, info.revision, &set)?); out.push(CollectionState::new(ruleset, kind, info.revision, &set)?);
} }
} }
Ok(out) Ok(out)
@@ -128,7 +128,7 @@ fn a_changed_content_profile_makes_the_realm_report_its_collections_again_and_re
} = rig(|_| {}); } = rig(|_| {});
let profile = owner.default_profile().unwrap(); let profile = owner.default_profile().unwrap();
owner owner
.merge_collection(profile, APPEARANCE, &ids(1..=500)) .merge_collection(profile, Ruleset::Coa, APPEARANCE, &ids(1..=500))
.unwrap(); .unwrap();
// the realm's client data knows 1..=300 of the canonical 500 // the realm's client data knows 1..=300 of the canonical 500
realm.knowledge = RealmKnowledge::new(ids(1..=300), IdSet::new()); realm.knowledge = RealmKnowledge::new(ids(1..=300), IdSet::new());
@@ -186,7 +186,7 @@ fn a_changed_content_profile_makes_the_realm_report_its_collections_again_and_re
); );
assert_eq!( assert_eq!(
o.store() o.store()
.collection(profile, APPEARANCE) .collection(profile, Ruleset::Coa, APPEARANCE)
.unwrap() .unwrap()
.unwrap() .unwrap()
.1 .1
@@ -371,9 +371,10 @@ fn a_session_started_without_its_projection_or_with_a_wrong_one_is_not_opened()
); );
// an older protocol is not understood at all // an older protocol is not understood at all
let old = String::from_utf8(genuine.clone()) let old = String::from_utf8(genuine.clone()).unwrap().replace(
.unwrap() &format!("\"protocol_version\":{PROTOCOL_VERSION}"),
.replace("\"protocol_version\":2", "\"protocol_version\":1"); "\"protocol_version\":1",
);
assert!(o.handle_started(old.as_bytes()).is_err()); assert!(o.handle_started(old.as_bytes()).is_err());
assert_eq!( assert_eq!(
o.handle_started(&genuine).unwrap().outcome, o.handle_started(&genuine).unwrap().outcome,
+185 -19
View File
@@ -13,14 +13,19 @@ use super::super::model::{limits::MAX_COMPRESSED_BYTES, PortableCharacter};
use super::super::projection::{ProgressionPin, ProjectionContext}; use super::super::projection::{ProgressionPin, ProjectionContext};
use super::super::snapshot; use super::super::snapshot;
/// Version 2 (Phase 8): `PortableSessionStarted` carries the progression the session runs under, every `PortableCheckpoint` and `OwnerAck` its pin. /// Version 3: `SessionOffer`, `PortableSessionStarted`, `PortableCheckpoint`, and `OwnerAck` require explicit `ruleset`.
/// A version 1 peer and a version 2 peer read each other's messages as unsupported, and the realm's capability profile (`session_protocol`) /// Version 2 (Phase 8): `PortableSessionStarted` carried progression and pins.
/// says so before any character is armed. pub const SESSION_PROTOCOL_VERSION: u32 = 3;
pub const PROTOCOL_VERSION: u32 = 2; /// Protocol version for collection synchronization (`CollectionObserved`, `CollectionState`, `CollectionAck`).
pub const COLLECTION_PROTOCOL_VERSION: u32 = 2;
/// Backward-compatibility alias for session protocol version.
pub const PROTOCOL_VERSION: u32 = SESSION_PROTOCOL_VERSION;
/// A message carries at most one compressed snapshot (base64: 4/3) plus a little structure. /// A message carries at most one compressed snapshot (base64: 4/3) plus a little structure.
pub const MAX_MESSAGE_BYTES: usize = MAX_COMPRESSED_BYTES * 4 / 3 + 64 * 1024; pub const MAX_MESSAGE_BYTES: usize = MAX_COMPRESSED_BYTES * 4 / 3 + 64 * 1024;
/// The most item/pet ids an acknowledgement lists. /// The most item/pet ids an acknowledgement lists.
pub const MAX_ACK_IDS: usize = 20_000; pub const MAX_ACK_IDS: usize = 20_000;
/// The largest serialized collection message accepted.
pub const MAX_COLLECTION_MESSAGE_BYTES: usize = 1024 * 1024;
/// A sealed snapshot: the hash of the canonical JSON and the compressed bytes. /// A sealed snapshot: the hash of the canonical JSON and the compressed bytes.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
@@ -79,6 +84,7 @@ impl Envelope {
#[serde(deny_unknown_fields)] #[serde(deny_unknown_fields)]
pub struct SessionOffer { pub struct SessionOffer {
pub protocol_version: u32, pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub session_id: SessionId, pub session_id: SessionId,
pub character_id: CharacterId, pub character_id: CharacterId,
pub server_id: String, pub server_id: String,
@@ -123,6 +129,7 @@ impl SessionProgression {
#[serde(deny_unknown_fields)] #[serde(deny_unknown_fields)]
pub struct PortableSessionStarted { pub struct PortableSessionStarted {
pub protocol_version: u32, pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub session_id: SessionId, pub session_id: SessionId,
pub character_id: CharacterId, pub character_id: CharacterId,
pub server_id: String, pub server_id: String,
@@ -139,6 +146,7 @@ pub struct PortableSessionStarted {
#[serde(deny_unknown_fields)] #[serde(deny_unknown_fields)]
pub struct PortableCheckpoint { pub struct PortableCheckpoint {
pub protocol_version: u32, pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub session_id: SessionId, pub session_id: SessionId,
pub character_id: CharacterId, pub character_id: CharacterId,
pub server_id: String, pub server_id: String,
@@ -188,6 +196,7 @@ pub struct NextSession {
#[serde(deny_unknown_fields)] #[serde(deny_unknown_fields)]
pub struct OwnerAck { pub struct OwnerAck {
pub protocol_version: u32, pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub session_id: SessionId, pub session_id: SessionId,
/// 0 acknowledges `PortableSessionStarted`. /// 0 acknowledges `PortableSessionStarted`.
pub sequence: u64, pub sequence: u64,
@@ -250,16 +259,17 @@ impl PortableSessionStarted {
if let Some(p) = &progression { if let Some(p) = &progression {
p.validate()?; p.validate()?;
} }
let b0 = Envelope::seal(b0)?; let sealed_b0 = Envelope::seal(b0)?;
Ok(Self { Ok(Self {
protocol_version: PROTOCOL_VERSION, protocol_version: PROTOCOL_VERSION,
ruleset: b0.ruleset,
session_id, session_id,
character_id, character_id,
server_id: server_id.to_string(), server_id: server_id.to_string(),
base_canonical_revision, base_canonical_revision,
baseline_generation, baseline_generation,
content_hash: b0.content_hash.clone(), content_hash: sealed_b0.content_hash.clone(),
b0, b0: sealed_b0,
progression, progression,
}) })
} }
@@ -279,6 +289,7 @@ impl PortableCheckpoint {
let realm_snapshot = Envelope::seal(b1)?; let realm_snapshot = Envelope::seal(b1)?;
Ok(Self { Ok(Self {
protocol_version: PROTOCOL_VERSION, protocol_version: PROTOCOL_VERSION,
ruleset: b1.ruleset,
session_id, session_id,
character_id, character_id,
server_id: server_id.to_string(), server_id: server_id.to_string(),
@@ -300,15 +311,32 @@ impl PortableCheckpoint {
use super::super::collection::{valid_kind, IdSet, MAX_ENCODED_BYTES}; use super::super::collection::{valid_kind, IdSet, MAX_ENCODED_BYTES};
/// The collection kinds the v1 protocol carries. /// The collection kinds the protocol carries.
pub const COLLECTION_KINDS: [&str; 2] = ["coa:appearance", "coa:vanity"]; pub const COLLECTION_KINDS: [&str; 6] = [
/// A collection message carries at most one encoded set (base64: 4/3) plus a little structure. "coa:appearance",
pub const MAX_COLLECTION_MESSAGE_BYTES: usize = MAX_ENCODED_BYTES * 4 / 3 + 64 * 1024; "coa:vanity",
"wildcard:appearance",
"wildcard:vanity",
"reborn:appearance",
"reborn:vanity",
];
pub fn collection_kinds(ruleset: super::super::model::Ruleset) -> &'static [&'static str] {
match ruleset {
super::super::model::Ruleset::Coa => &["coa:appearance", "coa:vanity"],
super::super::model::Ruleset::Wildcard => &["wildcard:appearance", "wildcard:vanity"],
super::super::model::Ruleset::Reborn => &["reborn:appearance", "reborn:vanity"],
}
}
pub fn carried_kind(kind: &str) -> bool { pub fn carried_kind(kind: &str) -> bool {
valid_kind(kind) && COLLECTION_KINDS.contains(&kind) valid_kind(kind) && COLLECTION_KINDS.contains(&kind)
} }
pub fn carried_kind_for(kind: &str, ruleset: super::super::model::Ruleset) -> bool {
valid_kind(kind) && collection_kinds(ruleset).contains(&kind)
}
/// A compact id set as it travels: hash of the kind and content, number of ids, base64 of [`IdSet::encode`]. /// A compact id set as it travels: hash of the kind and content, number of ids, base64 of [`IdSet::encode`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)] #[serde(deny_unknown_fields)]
@@ -365,6 +393,7 @@ impl CompactSet {
#[serde(deny_unknown_fields)] #[serde(deny_unknown_fields)]
pub struct CollectionObserved { pub struct CollectionObserved {
pub protocol_version: u32, pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub server_id: String, pub server_id: String,
pub kind: String, pub kind: String,
pub set: CompactSet, pub set: CompactSet,
@@ -375,6 +404,7 @@ pub struct CollectionObserved {
#[serde(deny_unknown_fields)] #[serde(deny_unknown_fields)]
pub struct CollectionState { pub struct CollectionState {
pub protocol_version: u32, pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub kind: String, pub kind: String,
pub collection_revision: u64, pub collection_revision: u64,
pub set: CompactSet, pub set: CompactSet,
@@ -400,6 +430,7 @@ pub enum CollectionOutcome {
#[serde(deny_unknown_fields)] #[serde(deny_unknown_fields)]
pub struct CollectionAck { pub struct CollectionAck {
pub protocol_version: u32, pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub kind: String, pub kind: String,
pub outcome: CollectionOutcome, pub outcome: CollectionOutcome,
pub collection_revision: u64, pub collection_revision: u64,
@@ -430,24 +461,30 @@ pub fn collection_from_json<T: DeserializeOwned>(bytes: &[u8]) -> Result<T> {
.get("protocol_version") .get("protocol_version")
.and_then(|v| v.as_u64()) .and_then(|v| v.as_u64())
.ok_or_else(|| PortableError::Invalid("the message has no protocol version".into()))?; .ok_or_else(|| PortableError::Invalid("the message has no protocol version".into()))?;
if version != PROTOCOL_VERSION as u64 { if version != COLLECTION_PROTOCOL_VERSION as u64 {
return Err(PortableError::UnsupportedFormat { return Err(PortableError::UnsupportedFormat {
found: version.min(u32::MAX as u64) as u32, found: version.min(u32::MAX as u64) as u32,
supported: PROTOCOL_VERSION, supported: COLLECTION_PROTOCOL_VERSION,
}); });
} }
Ok(serde_json::from_value(value)?) Ok(serde_json::from_value(value)?)
} }
impl CollectionObserved { impl CollectionObserved {
pub fn new(server_id: &str, kind: &str, set: &IdSet) -> Result<Self> { pub fn new(
if !carried_kind(kind) { server_id: &str,
ruleset: super::super::model::Ruleset,
kind: &str,
set: &IdSet,
) -> Result<Self> {
if !carried_kind_for(kind, ruleset) {
return Err(PortableError::Invalid(format!( return Err(PortableError::Invalid(format!(
"collection kind {kind:?} is not carried" "collection kind {kind:?} is not carried for {ruleset:?}"
))); )));
} }
Ok(Self { Ok(Self {
protocol_version: PROTOCOL_VERSION, protocol_version: COLLECTION_PROTOCOL_VERSION,
ruleset,
server_id: server_id.to_string(), server_id: server_id.to_string(),
kind: kind.to_string(), kind: kind.to_string(),
set: CompactSet::seal(kind, set)?, set: CompactSet::seal(kind, set)?,
@@ -456,12 +493,141 @@ impl CollectionObserved {
} }
impl CollectionState { impl CollectionState {
pub fn new(kind: &str, revision: u64, set: &IdSet) -> Result<Self> { pub fn new(
ruleset: super::super::model::Ruleset,
kind: &str,
revision: u64,
set: &IdSet,
) -> Result<Self> {
Ok(Self { Ok(Self {
protocol_version: PROTOCOL_VERSION, protocol_version: COLLECTION_PROTOCOL_VERSION,
ruleset,
kind: kind.to_string(), kind: kind.to_string(),
collection_revision: revision, collection_revision: revision,
set: CompactSet::seal(kind, set)?, set: CompactSet::seal(kind, set)?,
}) })
} }
} }
/// Legacy Session Protocol v2 representation (Phase 8), where absence of ruleset is defined to mean CoA.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct LegacyV2SessionOffer {
pub protocol_version: u32,
pub session_id: SessionId,
pub character_id: CharacterId,
pub server_id: String,
pub canonical_revision: u64,
pub snapshot: Envelope,
}
impl LegacyV2SessionOffer {
pub fn into_session_offer(self) -> SessionOffer {
SessionOffer {
protocol_version: SESSION_PROTOCOL_VERSION,
ruleset: super::super::model::Ruleset::Coa,
session_id: self.session_id,
character_id: self.character_id,
server_id: self.server_id,
canonical_revision: self.canonical_revision,
snapshot: self.snapshot,
}
}
}
#[cfg(test)]
mod protocol_tests {
use super::*;
use crate::portable::Ruleset;
#[test]
fn session_protocol_v3_requires_ruleset_and_rejects_missing_or_unknown() {
let envelope = Envelope {
content_hash: "00".repeat(32),
payload: "AA==".to_string(),
};
// 1. Valid v3 SessionOffer with explicit ruleset (CoA, Wildcard, Reborn)
for r in [Ruleset::Coa, Ruleset::Wildcard, Ruleset::Reborn] {
let offer = SessionOffer {
protocol_version: SESSION_PROTOCOL_VERSION,
ruleset: r,
session_id: SessionId::new(),
character_id: CharacterId::new(),
server_id: "realm-1".to_string(),
canonical_revision: 1,
snapshot: envelope.clone(),
};
let bytes = to_json(&offer).unwrap();
let parsed: SessionOffer = from_json(&bytes).unwrap();
assert_eq!(parsed.ruleset, r);
}
// 2. Missing ruleset in v3 JSON is rejected (never silently defaults to CoA)
let missing_ruleset_v3 = serde_json::json!({
"protocol_version": SESSION_PROTOCOL_VERSION,
"session_id": SessionId::new().to_string(),
"character_id": CharacterId::new().to_string(),
"server_id": "realm-1",
"canonical_revision": 1,
"snapshot": {
"content_hash": "00".repeat(32),
"payload": "AA=="
}
});
let bytes = serde_json::to_vec(&missing_ruleset_v3).unwrap();
let err: std::result::Result<SessionOffer, _> = from_json(&bytes);
assert!(
err.is_err(),
"missing ruleset must be rejected in protocol v3"
);
// 3. Unknown ruleset in v3 JSON is rejected
let unknown_ruleset_v3 = serde_json::json!({
"protocol_version": SESSION_PROTOCOL_VERSION,
"ruleset": "cyberpunk",
"session_id": SessionId::new().to_string(),
"character_id": CharacterId::new().to_string(),
"server_id": "realm-1",
"canonical_revision": 1,
"snapshot": {
"content_hash": "00".repeat(32),
"payload": "AA=="
}
});
let bytes = serde_json::to_vec(&unknown_ruleset_v3).unwrap();
let err: std::result::Result<SessionOffer, _> = from_json(&bytes);
assert!(err.is_err(), "unknown ruleset must be rejected");
// 4. Old v2 peer message (protocol_version 2) is rejected by current v3 parser
let legacy_v2_json = serde_json::json!({
"protocol_version": 2,
"session_id": SessionId::new().to_string(),
"character_id": CharacterId::new().to_string(),
"server_id": "realm-1",
"canonical_revision": 1,
"snapshot": {
"content_hash": "00".repeat(32),
"payload": "AA=="
}
});
let bytes = serde_json::to_vec(&legacy_v2_json).unwrap();
let err: std::result::Result<SessionOffer, _> = from_json(&bytes);
assert!(
matches!(
err,
Err(PortableError::UnsupportedFormat {
found: 2,
supported: 3
})
),
"v2 peer must be rejected with UnsupportedFormat"
);
// 5. Explicit LegacyV2SessionOffer decode correctly interprets absence of ruleset as CoA
let v2_parsed: LegacyV2SessionOffer = serde_json::from_slice(&bytes).unwrap();
let upgraded = v2_parsed.into_session_offer();
assert_eq!(upgraded.ruleset, Ruleset::Coa);
assert_eq!(upgraded.protocol_version, SESSION_PROTOCOL_VERSION);
}
}
@@ -4,6 +4,7 @@ use super::bridge::*;
use super::fake::*; use super::fake::*;
use super::protocol::*; use super::protocol::*;
use super::*; use super::*;
use crate::portable::error::PortableError;
use crate::portable::fixtures::geared_level_eighty; use crate::portable::fixtures::geared_level_eighty;
use crate::portable::ids::{CharacterId, PortableItemId, SessionId}; use crate::portable::ids::{CharacterId, PortableItemId, SessionId};
use crate::portable::model::*; use crate::portable::model::*;
@@ -1051,3 +1052,611 @@ fn an_autosave_between_checkpoints_is_harmless() {
c0.progression.money + 10 c0.progression.money + 10
); );
} }
fn setup_wildcard_in(mut owner: Store, mut host: Store, server_id: &str) -> Setup {
let profile = owner.default_profile().unwrap();
let mut model = geared_level_eighty();
model.ruleset = Ruleset::Wildcard;
model.content_namespace = "wildcard".into();
let id = owner
.create_character(profile, model, "wildcard-origin")
.unwrap();
let c0 = owner.load_current(id).unwrap();
let offer = OwnerService::new(&mut owner).offer(id, server_id).unwrap();
let host_profile = host.default_profile().unwrap();
let mut realm = FakeRealm::new(GUID);
realm.normalize = normalizes;
{
let mut h = HostService::new(&mut host, server_id, HostConfig::default());
h.accept_offer(host_profile, &offer).unwrap();
realm
.import(
&mut host,
id,
server_id,
offer.canonical_revision,
offer.session_id,
)
.unwrap();
HostService::new(&mut host, server_id, HostConfig::default())
.bind(offer.session_id, GUID)
.unwrap();
}
Setup {
owner,
host,
realm,
id,
session: offer.session_id,
c0,
}
}
fn setup_reborn_in(mut owner: Store, mut host: Store, server_id: &str) -> Setup {
let profile = owner.default_profile().unwrap();
let mut model = geared_level_eighty();
model.ruleset = Ruleset::Reborn;
model.content_namespace = "reborn".into();
let id = owner
.create_character(profile, model, "reborn-origin")
.unwrap();
let c0 = owner.load_current(id).unwrap();
let offer = OwnerService::new(&mut owner).offer(id, server_id).unwrap();
let host_profile = host.default_profile().unwrap();
let mut realm = FakeRealm::new(GUID);
realm.normalize = normalizes;
{
let mut h = HostService::new(&mut host, server_id, HostConfig::default());
h.accept_offer(host_profile, &offer).unwrap();
realm
.import(
&mut host,
id,
server_id,
offer.canonical_revision,
offer.session_id,
)
.unwrap();
HostService::new(&mut host, server_id, HostConfig::default())
.bind(offer.session_id, GUID)
.unwrap();
}
Setup {
owner,
host,
realm,
id,
session: offer.session_id,
c0,
}
}
#[test]
fn wildcard_session_offer_carrying_coa_snapshot_is_rejected_with_zero_mutation() {
let mut owner = Store::open_in_memory().unwrap();
let mut host = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap();
let host_profile = host.default_profile().unwrap();
let coa_model = geared_level_eighty();
let id = owner
.create_character(profile, coa_model, "realm-a")
.unwrap();
let mut offer = OwnerService::new(&mut owner)
.offer(id, "srv-1:wildcard")
.unwrap();
// Tamper offer: claim it is Wildcard while snapshot is CoA
offer.ruleset = Ruleset::Wildcard;
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let res = h.accept_offer(host_profile, &offer);
assert!(matches!(
res,
Err(PortableError::RulesetMismatch {
character: Ruleset::Coa,
realm: Ruleset::Wildcard
})
));
// Zero mutation on host
assert!(host.character(id).is_err());
assert!(host.host_session(offer.session_id).unwrap().is_none());
}
#[test]
fn wildcard_portable_session_started_marked_coa_is_rejected() {
let Setup {
mut owner,
mut host,
mut realm,
session,
..
} = setup_wildcard_in(
Store::open_in_memory().unwrap(),
Store::open_in_memory().unwrap(),
"srv-1:wildcard",
);
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let mut o = OwnerService::new(&mut owner);
realm.login();
h.tick(&mut realm, 0).unwrap();
let outbox = h.outbox().unwrap();
assert_eq!(outbox.len(), 1);
let mut started: PortableSessionStarted = from_json(&outbox[0].bytes).unwrap();
// Tamper: mark as CoA
started.ruleset = Ruleset::Coa;
let tampered_bytes = to_json(&started).unwrap();
let ack = o.handle_started(&tampered_bytes).unwrap();
assert!(matches!(ack.outcome, AckOutcome::Rejected(_)));
// Owner session remains offered, never open
let (state, _, _) = o.session(session).unwrap().unwrap();
assert_eq!(state, "offered");
}
#[test]
fn wildcard_checkpoint_marked_reborn_is_rejected() {
let Setup {
mut owner,
mut host,
mut realm,
id,
..
} = setup_wildcard_in(
Store::open_in_memory().unwrap(),
Store::open_in_memory().unwrap(),
"srv-1:wildcard",
);
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let mut o = OwnerService::new(&mut owner);
start(&mut h, &mut o, &mut realm);
realm.play(|m| m.progression.money += 500);
h.tick(&mut realm, 100).unwrap();
h.tick(&mut realm, 101).unwrap();
let outbox = h.outbox().unwrap();
let checkpoint_msg = outbox.iter().find(|m| !m.started).unwrap();
let mut cp: PortableCheckpoint = from_json(&checkpoint_msg.bytes).unwrap();
// Tamper: mark as Reborn
cp.ruleset = Ruleset::Reborn;
let tampered_bytes = to_json(&cp).unwrap();
let initial_rev = o.store().character(id).unwrap().revision;
let initial_snapshot = o.store().load_snapshot(id, initial_rev).unwrap();
let ack = o.handle_checkpoint(&tampered_bytes).unwrap();
assert!(matches!(ack.outcome, AckOutcome::Rejected(_)));
// Zero canonical revision change or mutation
assert_eq!(o.store().character(id).unwrap().revision, initial_rev);
assert_eq!(
o.store().load_snapshot(id, initial_rev).unwrap(),
initial_snapshot
);
}
#[test]
fn wildcard_session_using_coa_server_id_is_rejected() {
let mut owner = Store::open_in_memory().unwrap();
let mut host = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap();
let host_profile = host.default_profile().unwrap();
let mut model = geared_level_eighty();
model.ruleset = Ruleset::Wildcard;
let id = owner
.create_character(profile, model, "wildcard-origin")
.unwrap();
// Offer for srv-1:coa
let offer = OwnerService::new(&mut owner)
.offer(id, "srv-1:coa")
.unwrap();
// Host configured for Wildcard realm
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let res = h.accept_offer(host_profile, &offer);
assert!(matches!(res, Err(PortableError::Invalid(_))));
}
#[test]
fn same_character_id_with_foreign_ruleset_is_rejected() {
let mut owner = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap();
let mut model = geared_level_eighty();
model.ruleset = Ruleset::Wildcard;
let id = owner
.create_character(profile, model.clone(), "srv-1:wildcard")
.unwrap();
// Tampered snapshot with same ID but Ruleset::Coa
let mut tampered = model.clone();
tampered.character_id = id;
tampered.ruleset = Ruleset::Coa;
let res = owner.commit_snapshot(id, 1, tampered, "srv-1:wildcard", None);
assert!(matches!(res, Err(PortableError::RulesetChange { .. })));
}
#[test]
fn owner_ack_with_different_ruleset_is_rejected_by_host() {
let Setup {
mut owner,
mut host,
mut realm,
..
} = setup_wildcard_in(
Store::open_in_memory().unwrap(),
Store::open_in_memory().unwrap(),
"srv-1:wildcard",
);
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let mut o = OwnerService::new(&mut owner);
realm.login();
h.tick(&mut realm, 0).unwrap();
let outbox = h.outbox().unwrap();
let mut ack = o.handle_started(&outbox[0].bytes).unwrap();
// Tamper ack ruleset to CoA
ack.ruleset = Ruleset::Coa;
let res = h.receive_ack(&mut realm, &ack);
assert!(matches!(
res,
Err(PortableError::RulesetMismatch {
character: Ruleset::Wildcard,
realm: Ruleset::Coa
})
));
}
#[test]
fn final_checkpoint_relabelled_coa_is_rejected() {
let Setup {
mut owner,
mut host,
mut realm,
id,
..
} = setup_wildcard_in(
Store::open_in_memory().unwrap(),
Store::open_in_memory().unwrap(),
"srv-1:wildcard",
);
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let mut o = OwnerService::new(&mut owner);
start(&mut h, &mut o, &mut realm);
realm.play(|m| m.progression.money += 1000);
realm.logout();
h.tick(&mut realm, 100).unwrap();
h.tick(&mut realm, 101).unwrap();
let outbox = h.outbox().unwrap();
let final_cp_msg = outbox.iter().find(|m| !m.started).unwrap();
let mut cp: PortableCheckpoint = from_json(&final_cp_msg.bytes).unwrap();
assert!(cp.final_checkpoint);
// Relabel as CoA
cp.ruleset = Ruleset::Coa;
let tampered_bytes = to_json(&cp).unwrap();
let initial_rev = o.store().character(id).unwrap().revision;
let ack = o.handle_checkpoint(&tampered_bytes).unwrap();
assert!(matches!(ack.outcome, AckOutcome::Rejected(_)));
// Revision must not advance and state must not be committed
assert_eq!(o.store().character(id).unwrap().revision, initial_rev);
}
#[test]
fn full_wildcard_session_lifecycle() {
let Setup {
mut owner,
mut host,
mut realm,
id,
session,
c0,
} = setup_wildcard_in(
Store::open_in_memory().unwrap(),
Store::open_in_memory().unwrap(),
"srv-1:wildcard",
);
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let mut o = OwnerService::new(&mut owner);
// 1. Start session
start(&mut h, &mut o, &mut realm);
assert_eq!(o.session(session).unwrap().unwrap().0, "open");
// 2. Play on Wildcard realm: earn gold and level up
realm.play(|m| {
m.progression.money += 50_000;
m.progression.xp += 1_000;
});
// 3. Online checkpoint
checkpoint(&mut h, &mut o, &mut realm, 100);
let rev2 = o.store().character(id).unwrap().revision;
assert_eq!(rev2, 2);
let curr2 = o.store().load_current(id).unwrap();
assert_eq!(curr2.ruleset, Ruleset::Wildcard);
assert_eq!(curr2.progression.money, c0.progression.money + 50_000);
// 4. More gameplay then logout
realm.play(|m| {
m.progression.money += 25_000;
});
realm.logout();
h.tick(&mut realm, 200).unwrap();
h.tick(&mut realm, 201).unwrap();
let acks = deliver(&mut h, &mut o, &mut realm);
assert!(acks.iter().any(|a| a.outcome == AckOutcome::Applied));
// 5. Verify final canonical state
let rec = o.store().character(id).unwrap();
assert_eq!(rec.revision, 3);
assert_eq!(rec.ruleset, Ruleset::Wildcard);
let final_model = o.store().load_current(id).unwrap();
assert_eq!(final_model.ruleset, Ruleset::Wildcard);
assert_eq!(final_model.progression.money, c0.progression.money + 75_000);
}
#[test]
fn reborn_hostile_attacks_are_rejected_with_zero_mutation() {
let mut owner = Store::open_in_memory().unwrap();
let mut host = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap();
let host_profile = host.default_profile().unwrap();
let coa_model = geared_level_eighty();
let id_coa = owner
.create_character(profile, coa_model, "realm-coa")
.unwrap();
let mut wc_model = geared_level_eighty();
wc_model.ruleset = Ruleset::Wildcard;
let id_wc = owner
.create_character(profile, wc_model, "realm-wc")
.unwrap();
let mut reb_model = geared_level_eighty();
reb_model.ruleset = Ruleset::Reborn;
let id_reb = owner
.create_character(profile, reb_model, "realm-reb")
.unwrap();
// 1. Reborn offer carrying CoA snapshot
let mut offer_reb_with_coa = OwnerService::new(&mut owner)
.offer(id_coa, "srv-1:reborn")
.unwrap();
offer_reb_with_coa.ruleset = Ruleset::Reborn;
{
let mut h_reborn = HostService::new(&mut host, "srv-1:reborn", HostConfig::default());
let res1 = h_reborn.accept_offer(host_profile, &offer_reb_with_coa);
assert!(matches!(
res1,
Err(PortableError::RulesetMismatch {
character: Ruleset::Coa,
realm: Ruleset::Reborn
})
));
}
assert!(host.character(id_coa).is_err());
// 2. Reborn offer carrying Wildcard snapshot
let mut offer_reb_with_wc = OwnerService::new(&mut owner)
.offer(id_wc, "srv-1:reborn")
.unwrap();
offer_reb_with_wc.ruleset = Ruleset::Reborn;
{
let mut h_reborn = HostService::new(&mut host, "srv-1:reborn", HostConfig::default());
let res2 = h_reborn.accept_offer(host_profile, &offer_reb_with_wc);
assert!(matches!(
res2,
Err(PortableError::RulesetMismatch {
character: Ruleset::Wildcard,
realm: Ruleset::Reborn
})
));
}
assert!(host.character(id_wc).is_err());
// 3. CoA offer -> Reborn realm
let mut offer_coa = OwnerService::new(&mut owner)
.offer(id_coa, "srv-1:reborn")
.unwrap();
offer_coa.ruleset = Ruleset::Coa;
{
let mut h_reborn = HostService::new(&mut host, "srv-1:reborn", HostConfig::default());
let res3 = h_reborn.accept_offer(host_profile, &offer_coa);
assert!(matches!(
res3,
Err(PortableError::RulesetMismatch {
character: Ruleset::Coa,
realm: Ruleset::Reborn
})
));
}
// 4. Wildcard offer -> Reborn realm
let mut offer_wc = OwnerService::new(&mut owner)
.offer(id_wc, "srv-1:reborn")
.unwrap();
offer_wc.ruleset = Ruleset::Wildcard;
{
let mut h_reborn = HostService::new(&mut host, "srv-1:reborn", HostConfig::default());
let res4 = h_reborn.accept_offer(host_profile, &offer_wc);
assert!(matches!(
res4,
Err(PortableError::RulesetMismatch {
character: Ruleset::Wildcard,
realm: Ruleset::Reborn
})
));
}
// 5. Reborn offer -> CoA realm
let mut offer_reb = OwnerService::new(&mut owner)
.offer(id_reb, "srv-1:coa")
.unwrap();
offer_reb.ruleset = Ruleset::Reborn;
{
let mut h_coa = HostService::new(&mut host, "srv-1:coa", HostConfig::default());
let res5 = h_coa.accept_offer(host_profile, &offer_reb);
assert!(matches!(
res5,
Err(PortableError::RulesetMismatch {
character: Ruleset::Reborn,
realm: Ruleset::Coa
})
));
}
// 6. Reborn offer -> Wildcard realm
let mut offer_reb_to_wc = OwnerService::new(&mut owner)
.offer(id_reb, "srv-1:wildcard")
.unwrap();
offer_reb_to_wc.ruleset = Ruleset::Reborn;
{
let mut h_wc = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let res6 = h_wc.accept_offer(host_profile, &offer_reb_to_wc);
assert!(matches!(
res6,
Err(PortableError::RulesetMismatch {
character: Ruleset::Reborn,
realm: Ruleset::Wildcard
})
));
}
// 7. Reborn session using foreign server ID srv-1:coa or srv-1:wildcard
{
let mut h_reborn = HostService::new(&mut host, "srv-1:reborn", HostConfig::default());
let offer_for_coa = OwnerService::new(&mut owner)
.offer(id_reb, "srv-1:coa")
.unwrap();
let res7 = h_reborn.accept_offer(host_profile, &offer_for_coa);
assert!(res7.is_err());
let offer_for_wc = OwnerService::new(&mut owner)
.offer(id_reb, "srv-1:wildcard")
.unwrap();
let res8 = h_reborn.accept_offer(host_profile, &offer_for_wc);
assert!(res8.is_err());
}
// 8. Reborn collection containing foreign collections coa:appearance or wildcard:vanity
let coll_err1 = host.merge_collection(
host_profile,
Ruleset::Reborn,
"coa:appearance",
&crate::portable::IdSet::from_ids([1]).unwrap(),
);
assert!(
coll_err1.is_err(),
"Reborn merging coa:appearance must fail"
);
let coll_err2 = host.merge_collection(
host_profile,
Ruleset::Reborn,
"wildcard:vanity",
&crate::portable::IdSet::from_ids([1]).unwrap(),
);
assert!(
coll_err2.is_err(),
"Reborn merging wildcard:vanity must fail"
);
// 9. HostService with malformed server_id ruleset suffixes fails closed
for bad_server_id in ["srv-1:unknown", "srv-1:garbage", "srv-1:reborn:extra"] {
let mut h_bad = HostService::new(&mut host, bad_server_id, HostConfig::default());
let mut offer_bad = OwnerService::new(&mut owner)
.offer(id_reb, "srv-1:reborn")
.unwrap();
offer_bad.server_id = bad_server_id.to_string();
let res_bad = h_bad.accept_offer(host_profile, &offer_bad);
assert!(
res_bad.is_err(),
"accept_offer on malformed server id {bad_server_id} must fail closed"
);
}
}
#[test]
fn full_reborn_session_lifecycle() {
let Setup {
mut owner,
mut host,
mut realm,
id,
session,
c0,
} = setup_reborn_in(
Store::open_in_memory().unwrap(),
Store::open_in_memory().unwrap(),
"srv-1:reborn",
);
let mut h = HostService::new(&mut host, "srv-1:reborn", HostConfig::default());
let mut o = OwnerService::new(&mut owner);
// 1. Start session
start(&mut h, &mut o, &mut realm);
assert_eq!(o.session(session).unwrap().unwrap().0, "open");
// 2. Play on Reborn realm: earn gold and level up
realm.play(|m| {
m.progression.money += 100_000;
m.progression.xp += 5_000;
});
// 3. Online checkpoint
checkpoint(&mut h, &mut o, &mut realm, 100);
let rev2 = o.store().character(id).unwrap().revision;
assert_eq!(rev2, 2);
let curr2 = o.store().load_current(id).unwrap();
assert_eq!(curr2.ruleset, Ruleset::Reborn);
assert_eq!(curr2.progression.money, c0.progression.money + 100_000);
// 4. Test Reborn checkpoint marked CoA / Wildcard rejected by owner
let outbox = h.outbox().unwrap();
if let Some(msg) = outbox.first() {
let mut cp: PortableCheckpoint = from_json(&msg.bytes).unwrap();
cp.ruleset = Ruleset::Coa;
let tampered_bytes = to_json(&cp).unwrap();
let initial_rev = o.store().character(id).unwrap().revision;
let ack = o.handle_checkpoint(&tampered_bytes).unwrap();
assert!(matches!(ack.outcome, AckOutcome::Rejected(_)));
assert_eq!(o.store().character(id).unwrap().revision, initial_rev);
}
// 5. Test OwnerAck marked CoA rejected by Reborn host
if let Some(msg) = outbox.first() {
if let Ok(mut ack) = o.handle_checkpoint(&msg.bytes) {
ack.ruleset = Ruleset::Coa;
let res_ack = h.receive_ack(&mut realm, &ack);
assert!(matches!(
res_ack,
Err(PortableError::RulesetMismatch {
character: Ruleset::Reborn,
realm: Ruleset::Coa
})
));
}
}
// 6. More gameplay then logout
realm.play(|m| {
m.progression.money += 50_000;
});
realm.logout();
h.tick(&mut realm, 200).unwrap();
h.tick(&mut realm, 201).unwrap();
let acks = deliver(&mut h, &mut o, &mut realm);
assert!(acks.iter().any(|a| a.outcome == AckOutcome::Applied));
// 7. Verify final canonical state
let rec = o.store().character(id).unwrap();
assert_eq!(rec.revision, 3);
assert_eq!(rec.ruleset, Ruleset::Reborn);
let final_model = o.store().load_current(id).unwrap();
assert_eq!(final_model.ruleset, Ruleset::Reborn);
assert_eq!(
final_model.progression.money,
c0.progression.money + 150_000
);
}
+91 -12
View File
@@ -27,6 +27,8 @@ const MIGRATIONS: &[&str] = &[
include_str!("migrations/006_collections.sql"), include_str!("migrations/006_collections.sql"),
include_str!("migrations/007_capabilities.sql"), include_str!("migrations/007_capabilities.sql"),
include_str!("migrations/008_projection.sql"), include_str!("migrations/008_projection.sql"),
include_str!("migrations/009_multiruleset.sql"),
include_str!("migrations/010_reborn_character_ruleset.sql"),
]; ];
pub const DEFAULT_HISTORY_KEEP: u32 = 20; pub const DEFAULT_HISTORY_KEEP: u32 = 20;
@@ -173,12 +175,12 @@ impl Store {
} }
fn init(conn: Connection) -> Result<Store> { fn init(conn: Connection) -> Result<Store> {
conn.pragma_update(None, "foreign_keys", true)?;
conn.busy_timeout(std::time::Duration::from_secs(5))?; conn.busy_timeout(std::time::Duration::from_secs(5))?;
let _ = conn.pragma_update(None, "journal_mode", "WAL"); let _ = conn.pragma_update(None, "journal_mode", "WAL");
let _ = conn.pragma_update(None, "synchronous", "NORMAL"); conn.pragma_update(None, "synchronous", "FULL")?;
let mut store = Store { conn }; let mut store = Store { conn };
store.migrate()?; store.migrate()?;
store.conn.pragma_update(None, "foreign_keys", true)?;
Ok(store) Ok(store)
} }
@@ -205,11 +207,13 @@ impl Store {
}); });
} }
for next in version..supported { for next in version..supported {
self.conn.pragma_update(None, "foreign_keys", false)?;
let tx = self.conn.transaction()?; let tx = self.conn.transaction()?;
tx.execute_batch(MIGRATIONS[next as usize])?; tx.execute_batch(MIGRATIONS[next as usize])?;
tx.pragma_update(None, "application_id", APPLICATION_ID)?; tx.pragma_update(None, "application_id", APPLICATION_ID)?;
tx.pragma_update(None, "user_version", next + 1)?; tx.pragma_update(None, "user_version", next + 1)?;
tx.commit()?; tx.commit()?;
self.conn.pragma_update(None, "foreign_keys", true)?;
} }
Ok(()) Ok(())
} }
@@ -328,6 +332,23 @@ impl Store {
read_character(&self.conn, id) read_character(&self.conn, id)
} }
pub fn get_character(
&self,
id: CharacterId,
expected_ruleset: Option<Ruleset>,
) -> Result<CharacterRecord> {
let rec = read_character(&self.conn, id)?;
if let Some(expected) = expected_ruleset {
if rec.ruleset != expected {
return Err(PortableError::RulesetMismatch {
character: rec.ruleset,
realm: expected,
});
}
}
Ok(rec)
}
pub fn list_characters(&self, profile: ProfileId) -> Result<Vec<CharacterRecord>> { pub fn list_characters(&self, profile: ProfileId) -> Result<Vec<CharacterRecord>> {
let mut stmt = self.conn.prepare( let mut stmt = self.conn.prepare(
"SELECT character_id FROM character WHERE profile_id = ?1 ORDER BY character_id", "SELECT character_id FROM character WHERE profile_id = ?1 ORDER BY character_id",
@@ -340,6 +361,22 @@ impl Store {
.collect() .collect()
} }
pub fn list_characters_by_ruleset(
&self,
profile: ProfileId,
ruleset: Ruleset,
) -> Result<Vec<CharacterRecord>> {
let mut stmt = self.conn.prepare(
"SELECT character_id FROM character WHERE profile_id = ?1 AND ruleset = ?2 ORDER BY character_id",
)?;
let ids: Vec<String> = stmt
.query_map(params![profile.to_string(), ruleset.as_str()], |r| r.get(0))?
.collect::<std::result::Result<_, _>>()?;
ids.iter()
.map(|text| read_character(&self.conn, text.parse()?))
.collect()
}
/// Every character of every profile (an overview for tools; normally the UI lists one profile). /// Every character of every profile (an overview for tools; normally the UI lists one profile).
pub fn list_characters_all(&self) -> Result<Vec<CharacterRecord>> { pub fn list_characters_all(&self) -> Result<Vec<CharacterRecord>> {
let mut stmt = self let mut stmt = self
@@ -663,6 +700,7 @@ impl Store {
pub fn merge_collection( pub fn merge_collection(
&mut self, &mut self,
profile: ProfileId, profile: ProfileId,
ruleset: Ruleset,
kind: &str, kind: &str,
incoming: &IdSet, incoming: &IdSet,
) -> Result<CollectionMerge> { ) -> Result<CollectionMerge> {
@@ -671,6 +709,13 @@ impl Store {
"invalid collection kind {kind:?}" "invalid collection kind {kind:?}"
))); )));
} }
if let Some((ns, _)) = kind.split_once(':') {
if matches!(ns, "coa" | "wildcard" | "reborn") && ns != ruleset.as_str() {
return Err(PortableError::Invalid(format!(
"collection kind namespace {ns:?} does not match ruleset {ruleset:?}"
)));
}
}
let tx = self.write_tx()?; let tx = self.write_tx()?;
let profile_exists: bool = tx.query_row( let profile_exists: bool = tx.query_row(
"SELECT EXISTS(SELECT 1 FROM profile WHERE profile_id = ?1)", "SELECT EXISTS(SELECT 1 FROM profile WHERE profile_id = ?1)",
@@ -682,7 +727,7 @@ impl Store {
"profile {profile} does not exist" "profile {profile} does not exist"
))); )));
} }
let stored = read_collection(&tx, profile, kind)?; let stored = read_collection(&tx, profile, ruleset, kind)?;
let (current_set, revision) = match &stored { let (current_set, revision) = match &stored {
Some((info, set)) => (set.clone(), info.revision), Some((info, set)) => (set.clone(), info.revision),
None => (IdSet::new(), 0), None => (IdSet::new(), 0),
@@ -701,11 +746,11 @@ impl Store {
let payload = merged.encode(); let payload = merged.encode();
let at = now(); let at = now();
tx.execute( tx.execute(
"INSERT INTO collection(profile_id, kind, collection_revision, collection_hash, format_version, item_count, updated_at, payload) "INSERT INTO collection(profile_id, ruleset, kind, collection_revision, collection_hash, format_version, item_count, updated_at, payload)
VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8) VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9)
ON CONFLICT(profile_id, kind) DO UPDATE SET collection_revision = excluded.collection_revision, collection_hash = excluded.collection_hash, ON CONFLICT(profile_id, ruleset, kind) DO UPDATE SET collection_revision = excluded.collection_revision, collection_hash = excluded.collection_hash,
format_version = excluded.format_version, item_count = excluded.item_count, updated_at = excluded.updated_at, payload = excluded.payload", format_version = excluded.format_version, item_count = excluded.item_count, updated_at = excluded.updated_at, payload = excluded.payload",
params![profile.to_string(), kind, (revision + 1) as i64, hash.as_slice(), PORTABLE_COLLECTION_FORMAT_VERSION, merged.len() as i64, at, payload], params![profile.to_string(), ruleset.as_str(), kind, (revision + 1) as i64, hash.as_slice(), PORTABLE_COLLECTION_FORMAT_VERSION, merged.len() as i64, at, payload],
)?; )?;
tx.commit()?; tx.commit()?;
Ok(CollectionMerge { Ok(CollectionMerge {
@@ -725,13 +770,14 @@ impl Store {
pub fn collection_info( pub fn collection_info(
&self, &self,
profile: ProfileId, profile: ProfileId,
ruleset: Ruleset,
kind: &str, kind: &str,
) -> Result<Option<CollectionInfo>> { ) -> Result<Option<CollectionInfo>> {
let row = self let row = self
.conn .conn
.query_row( .query_row(
"SELECT collection_revision, collection_hash, item_count, updated_at FROM collection WHERE profile_id = ?1 AND kind = ?2", "SELECT collection_revision, collection_hash, item_count, updated_at FROM collection WHERE profile_id = ?1 AND ruleset = ?2 AND kind = ?3",
params![profile.to_string(), kind], params![profile.to_string(), ruleset.as_str(), kind],
|r| Ok((r.get::<_, i64>(0)?, r.get::<_, Vec<u8>>(1)?, r.get::<_, i64>(2)?, r.get::<_, String>(3)?)), |r| Ok((r.get::<_, i64>(0)?, r.get::<_, Vec<u8>>(1)?, r.get::<_, i64>(2)?, r.get::<_, String>(3)?)),
) )
.optional()?; .optional()?;
@@ -750,9 +796,41 @@ impl Store {
pub fn collection( pub fn collection(
&self, &self,
profile: ProfileId, profile: ProfileId,
ruleset: Ruleset,
kind: &str, kind: &str,
) -> Result<Option<(CollectionInfo, IdSet)>> { ) -> Result<Option<(CollectionInfo, IdSet)>> {
read_collection(&self.conn, profile, kind) read_collection(&self.conn, profile, ruleset, kind)
}
pub fn list_collections(
&self,
profile: ProfileId,
ruleset: Ruleset,
) -> Result<Vec<CollectionInfo>> {
let mut stmt = self.conn.prepare(
"SELECT kind, collection_revision, collection_hash, item_count, updated_at FROM collection WHERE profile_id = ?1 AND ruleset = ?2 ORDER BY kind",
)?;
let rows = stmt.query_map(params![profile.to_string(), ruleset.as_str()], |r| {
Ok((
r.get::<_, String>(0)?,
r.get::<_, i64>(1)?,
r.get::<_, Vec<u8>>(2)?,
r.get::<_, i64>(3)?,
r.get::<_, String>(4)?,
))
})?;
let mut out = Vec::new();
for row in rows {
let (kind, revision, hash, count, updated_at) = row?;
out.push(CollectionInfo {
kind,
revision: revision as u64,
hash: hash_from_blob(hash)?,
count: count as usize,
updated_at,
});
}
Ok(out)
} }
/// Rewrite the current revision exactly as format 1 stored it (the stores of Phases 1-5 hold such snapshots). Tests only. /// Rewrite the current revision exactly as format 1 stored it (the stores of Phases 1-5 hold such snapshots). Tests only.
@@ -776,12 +854,13 @@ impl Store {
fn read_collection( fn read_collection(
conn: &Connection, conn: &Connection,
profile: ProfileId, profile: ProfileId,
ruleset: Ruleset,
kind: &str, kind: &str,
) -> Result<Option<(CollectionInfo, IdSet)>> { ) -> Result<Option<(CollectionInfo, IdSet)>> {
let row = conn let row = conn
.query_row( .query_row(
"SELECT collection_revision, collection_hash, item_count, updated_at, payload FROM collection WHERE profile_id = ?1 AND kind = ?2", "SELECT collection_revision, collection_hash, item_count, updated_at, payload FROM collection WHERE profile_id = ?1 AND ruleset = ?2 AND kind = ?3",
params![profile.to_string(), kind], params![profile.to_string(), ruleset.as_str(), kind],
|r| Ok((r.get::<_, i64>(0)?, r.get::<_, Vec<u8>>(1)?, r.get::<_, i64>(2)?, r.get::<_, String>(3)?, r.get::<_, Vec<u8>>(4)?)), |r| Ok((r.get::<_, i64>(0)?, r.get::<_, Vec<u8>>(1)?, r.get::<_, i64>(2)?, r.get::<_, String>(3)?, r.get::<_, Vec<u8>>(4)?)),
) )
.optional()?; .optional()?;
@@ -579,6 +579,13 @@ impl Store {
Some(_) => {} Some(_) => {}
} }
let at = now(); let at = now();
let record = read_character(&tx, s.character_id)?;
if ack.ruleset != record.ruleset {
return Err(PortableError::RulesetMismatch {
character: record.ruleset,
realm: ack.ruleset,
});
}
if ack.outcome.accepted() && ack.pin != s.pin { if ack.outcome.accepted() && ack.pin != s.pin {
return Err(PortableError::ProgressionChanged( return Err(PortableError::ProgressionChanged(
"the acknowledgement is under another progression profile than the session".into(), "the acknowledgement is under another progression profile than the session".into(),
+57 -4
View File
@@ -104,6 +104,7 @@ fn head_hash(conn: &Connection, id: CharacterId, revision: u64) -> Result<[u8; 3
} }
fn ack( fn ack(
ruleset: Ruleset,
session: SessionId, session: SessionId,
sequence: u64, sequence: u64,
outcome: AckOutcome, outcome: AckOutcome,
@@ -112,6 +113,7 @@ fn ack(
) -> OwnerAck { ) -> OwnerAck {
OwnerAck { OwnerAck {
protocol_version: PROTOCOL_VERSION, protocol_version: PROTOCOL_VERSION,
ruleset,
session_id: session, session_id: session,
sequence, sequence,
outcome, outcome,
@@ -136,9 +138,10 @@ fn owned_ids(
(items, pets) (items, pets)
} }
fn offer_from_row(row: &OwnerRow) -> SessionOffer { fn offer_from_row(row: &OwnerRow, ruleset: Ruleset) -> SessionOffer {
SessionOffer { SessionOffer {
protocol_version: PROTOCOL_VERSION, protocol_version: PROTOCOL_VERSION,
ruleset,
session_id: row.session_id, session_id: row.session_id,
character_id: row.character_id, character_id: row.character_id,
server_id: row.server_id.clone(), server_id: row.server_id.clone(),
@@ -163,6 +166,7 @@ fn open_offer(tx: &Transaction<'_>, id: CharacterId, server_id: &str) -> Result<
)?; )?;
Ok(offer_from_row( Ok(offer_from_row(
&read_owner_row(tx, session)?.expect("just inserted"), &read_owner_row(tx, session)?.expect("just inserted"),
record.ruleset,
)) ))
} }
@@ -177,6 +181,10 @@ impl Store {
check_server_id(server_id)?; check_server_id(server_id)?;
let tx = self.write_tx()?; let tx = self.write_tx()?;
let record = read_character(&tx, id)?; let record = read_character(&tx, id)?;
let busy: bool = tx.query_row("SELECT EXISTS(SELECT 1 FROM owner_session WHERE character_id = ?1 AND server_id != ?2 AND state = 'open')", params![id.to_string(), server_id], |row| row.get(0))?;
if busy {
return Err(PortableError::SessionOpen);
}
let live: Option<String> = tx let live: Option<String> = tx
.query_row("SELECT session_id FROM owner_session WHERE character_id = ?1 AND server_id = ?2 AND state IN ('offered', 'open')", params![id.to_string(), server_id], |r| r.get(0)) .query_row("SELECT session_id FROM owner_session WHERE character_id = ?1 AND server_id = ?2 AND state IN ('offered', 'open')", params![id.to_string(), server_id], |r| r.get(0))
.optional()?; .optional()?;
@@ -186,10 +194,12 @@ impl Store {
return Err(PortableError::SessionOpen); return Err(PortableError::SessionOpen);
} }
if row.c0_revision == record.revision { if row.c0_revision == record.revision {
return Ok(offer_from_row(&row)); return Ok(offer_from_row(&row, record.ruleset));
} }
tx.execute("UPDATE owner_session SET state = 'superseded', updated_at = ?2 WHERE session_id = ?1", params![live, now()])?; tx.execute("UPDATE owner_session SET state = 'superseded', updated_at = ?2 WHERE session_id = ?1", params![live, now()])?;
} }
// Only the selected realm may start the next session. Other idle offers must not come alive later.
tx.execute("UPDATE owner_session SET state='superseded', updated_at=?3 WHERE character_id=?1 AND server_id!=?2 AND state='offered'", params![id.to_string(), server_id, now()])?;
let offer = open_offer(&tx, id, server_id)?; let offer = open_offer(&tx, id, server_id)?;
tx.commit()?; tx.commit()?;
Ok(offer) Ok(offer)
@@ -200,6 +210,7 @@ impl Store {
let tx = self.write_tx()?; let tx = self.write_tx()?;
let Some(row) = read_owner_row(&tx, msg.session_id)? else { let Some(row) = read_owner_row(&tx, msg.session_id)? else {
return Ok(ack( return Ok(ack(
msg.ruleset,
msg.session_id, msg.session_id,
0, 0,
AckOutcome::Rejected("unknown session".into()), AckOutcome::Rejected("unknown session".into()),
@@ -207,9 +218,11 @@ impl Store {
[0; 32], [0; 32],
)); ));
}; };
let record = read_character(&tx, row.character_id)?;
let current_hash = head_hash(&tx, row.character_id, row.head_revision)?; let current_hash = head_hash(&tx, row.character_id, row.head_revision)?;
let reject = |why: &str| { let reject = |why: &str| {
ack( ack(
record.ruleset,
msg.session_id, msg.session_id,
0, 0,
AckOutcome::Rejected(why.into()), AckOutcome::Rejected(why.into()),
@@ -217,6 +230,9 @@ impl Store {
current_hash, current_hash,
) )
}; };
if msg.ruleset != record.ruleset {
return Ok(reject("the message ruleset does not match the character"));
}
if msg.character_id != row.character_id || msg.server_id != row.server_id { if msg.character_id != row.character_id || msg.server_id != row.server_id {
return Ok(reject("the message does not belong to this session")); return Ok(reject("the message does not belong to this session"));
} }
@@ -237,6 +253,7 @@ impl Store {
&& row.progression == msg.progression && row.progression == msg.progression
{ {
let mut a = ack( let mut a = ack(
record.ruleset,
msg.session_id, msg.session_id,
0, 0,
AckOutcome::Duplicate, AckOutcome::Duplicate,
@@ -253,6 +270,7 @@ impl Store {
"offered" => {} "offered" => {}
_ => { _ => {
return Ok(ack( return Ok(ack(
record.ruleset,
msg.session_id, msg.session_id,
0, 0,
AckOutcome::StaleSession, AckOutcome::StaleSession,
@@ -299,6 +317,7 @@ impl Store {
)?; )?;
tx.commit()?; tx.commit()?;
let mut a = ack( let mut a = ack(
record.ruleset,
msg.session_id, msg.session_id,
0, 0,
AckOutcome::Applied, AckOutcome::Applied,
@@ -315,6 +334,7 @@ impl Store {
let tx = self.write_tx()?; let tx = self.write_tx()?;
let Some(row) = read_owner_row(&tx, msg.session_id)? else { let Some(row) = read_owner_row(&tx, msg.session_id)? else {
return Ok(ack( return Ok(ack(
msg.ruleset,
msg.session_id, msg.session_id,
msg.sequence, msg.sequence,
AckOutcome::Rejected("unknown session".into()), AckOutcome::Rejected("unknown session".into()),
@@ -324,10 +344,23 @@ impl Store {
}; };
let record = read_character(&tx, row.character_id)?; let record = read_character(&tx, row.character_id)?;
let seen_hash = head_hash(&tx, row.character_id, record.revision)?; let seen_hash = head_hash(&tx, row.character_id, record.revision)?;
let outcome = let outcome = |o: AckOutcome| {
|o: AckOutcome| ack(msg.session_id, msg.sequence, o, record.revision, seen_hash); ack(
record.ruleset,
msg.session_id,
msg.sequence,
o,
record.revision,
seen_hash,
)
};
let reject = |why: &str| outcome(AckOutcome::Rejected(why.into())); let reject = |why: &str| outcome(AckOutcome::Rejected(why.into()));
if msg.ruleset != record.ruleset {
return Ok(reject(
"the checkpoint ruleset does not match the character",
));
}
if msg.character_id != row.character_id || msg.server_id != row.server_id { if msg.character_id != row.character_id || msg.server_id != row.server_id {
return Ok(reject("the message does not belong to this session")); return Ok(reject("the message does not belong to this session"));
} }
@@ -354,6 +387,7 @@ impl Store {
} }
let revision = revision as u64; let revision = revision as u64;
let mut a = ack( let mut a = ack(
record.ruleset,
msg.session_id, msg.session_id,
msg.sequence, msg.sequence,
AckOutcome::Duplicate, AckOutcome::Duplicate,
@@ -390,6 +424,7 @@ impl Store {
tx.execute("UPDATE owner_session SET state = 'superseded', updated_at = ?2 WHERE session_id = ?1", params![msg.session_id.to_string(), now()])?; tx.execute("UPDATE owner_session SET state = 'superseded', updated_at = ?2 WHERE session_id = ?1", params![msg.session_id.to_string(), now()])?;
tx.commit()?; tx.commit()?;
return Ok(ack( return Ok(ack(
record.ruleset,
msg.session_id, msg.session_id,
msg.sequence, msg.sequence,
AckOutcome::StaleSession, AckOutcome::StaleSession,
@@ -457,6 +492,7 @@ impl Store {
}; };
let mut a = ack( let mut a = ack(
record.ruleset,
msg.session_id, msg.session_id,
msg.sequence, msg.sequence,
AckOutcome::Applied, AckOutcome::Applied,
@@ -491,4 +527,21 @@ impl Store {
Ok(read_owner_row(&self.conn, session)? Ok(read_owner_row(&self.conn, session)?
.map(|r| (r.state, r.last_sequence, r.head_revision))) .map(|r| (r.state, r.last_sequence, r.head_revision)))
} }
pub fn owner_next_session(
&self,
character: CharacterId,
realm: &str,
) -> Result<Option<SessionId>> {
let sid: Option<String> = self.conn.query_row("SELECT session_id FROM owner_session WHERE character_id=?1 AND server_id=?2 AND state IN ('offered','open') ORDER BY updated_at DESC LIMIT 1", params![character.to_string(), realm], |row| row.get(0)).optional()?;
sid.map(|sid| sid.parse()).transpose()
}
pub fn owner_active_remote(&self, character: CharacterId) -> Result<Option<(String, String)>> {
self.conn.query_row("SELECT server_id, state FROM owner_session WHERE character_id=?1 AND server_id LIKE 'remote-%' AND state='open' ORDER BY updated_at DESC LIMIT 1", [character.to_string()], |row| Ok((row.get(0)?, row.get(1)?))).optional().map_err(Into::into)
}
pub fn owner_session_realm(&self, session: SessionId) -> Result<Option<String>> {
Ok(read_owner_row(&self.conn, session)?.map(|row| row.server_id))
}
} }
+677 -14
View File
@@ -7,6 +7,112 @@ fn fresh() -> (Store, ProfileId) {
(store, profile) (store, profile)
} }
#[test]
fn schema_nine_upgrade_preserves_characters_and_isolates_collections() {
let dir = tempfile::tempdir().unwrap();
let conn = Connection::open(Store::path_of(dir.path())).unwrap();
for sql in &MIGRATIONS[..8] {
conn.execute_batch(sql).unwrap();
}
conn.pragma_update(None, "application_id", APPLICATION_ID)
.unwrap();
conn.pragma_update(None, "user_version", 8).unwrap();
let mut old = Store { conn };
let profile = old.default_profile().unwrap();
let id = created(&mut old, profile);
old.bind_server(id, "realm-a", 42, 1, MappingState::Synced)
.unwrap();
let before = old.load_current(id).unwrap();
let set = IdSet::from_ids([10, 20]).unwrap();
let kind = "coa:wardrobe";
old.conn
.execute(
"INSERT INTO collection VALUES (?1, ?2, 7, ?3, ?4, 2, 'before', ?5)",
params![
profile.to_string(),
kind,
set.hash(kind).as_slice(),
PORTABLE_COLLECTION_FORMAT_VERSION,
set.encode()
],
)
.unwrap();
drop(old);
let mut store = Store::open(dir.path()).unwrap();
assert_eq!(store.schema_version().unwrap(), 10);
assert_eq!(store.load_current(id).unwrap(), before);
assert_eq!(store.server_mappings(id).unwrap()[0].local_guid, 42);
assert_eq!(
store
.collection(profile, Ruleset::Coa, kind)
.unwrap()
.unwrap()
.1,
set
);
assert_eq!(
store
.collection_info(profile, Ruleset::Coa, kind)
.unwrap()
.unwrap()
.revision,
7
);
// An experimental Manager may already have populated another partition.
store.conn.execute(
"INSERT INTO collection SELECT profile_id, 'reborn', kind, collection_revision, collection_hash, format_version, item_count, updated_at, payload FROM collection WHERE ruleset = 'coa'",
[],
).unwrap();
store
.merge_collection(profile, Ruleset::Coa, kind, &IdSet::from_ids([30]).unwrap())
.unwrap();
assert_eq!(
store
.collection(profile, Ruleset::Coa, kind)
.unwrap()
.unwrap()
.1,
IdSet::from_ids([10, 20, 30]).unwrap()
);
let foreign: (i64, Vec<u8>) = store
.conn
.query_row(
"SELECT collection_revision, payload FROM collection WHERE ruleset = 'reborn'",
[],
|r| Ok((r.get(0)?, r.get(1)?)),
)
.unwrap();
assert_eq!(foreign, (7, set.encode()));
drop(store);
assert_eq!(
Store::open(dir.path()).unwrap().load_current(id).unwrap(),
before
);
}
#[test]
#[ignore = "Requires a disposable SQLite backup in COA_PORTABLE_SCHEMA9_FIXTURE"]
fn schema_nine_existing_store_and_runtime_smoke() {
let root = std::path::PathBuf::from(
std::env::var_os("COA_PORTABLE_SCHEMA9_FIXTURE").expect("fixture path"),
);
for role in ["owner", "host"] {
let store = Store::open(&root.join(role)).unwrap();
assert_eq!(store.schema_version().unwrap(), 10);
let records = store.list_characters_all().unwrap();
assert!(!records.is_empty());
for record in records {
store.load_current(record.character_id).unwrap();
store.list_revisions(record.character_id).unwrap();
}
}
let runtime =
crate::portable::service::PortableRuntime::start(&root, Box::new(Vec::new), None).unwrap();
runtime.call(|_| ()).unwrap();
runtime.shutdown();
}
fn created(store: &mut Store, profile: ProfileId) -> CharacterId { fn created(store: &mut Store, profile: ProfileId) -> CharacterId {
store store
.create_character(profile, fixtures::geared_level_eighty(), "realm-a") .create_character(profile, fixtures::geared_level_eighty(), "realm-a")
@@ -918,16 +1024,22 @@ fn schema_1_item_mappings_survive_the_migration_as_unverified() {
fn collection_union_never_removes_and_unchanged_means_no_revision() { fn collection_union_never_removes_and_unchanged_means_no_revision() {
let (mut store, profile) = fresh(); let (mut store, profile) = fresh();
let kind = "coa:wardrobe"; let kind = "coa:wardrobe";
assert!(store.collection(profile, kind).unwrap().is_none()); let ruleset = Ruleset::Coa;
assert!(store.collection(profile, ruleset, kind).unwrap().is_none());
// nothing stored, nothing incoming: nothing is created // nothing stored, nothing incoming: nothing is created
let empty = store let empty = store
.merge_collection(profile, kind, &IdSet::new()) .merge_collection(profile, ruleset, kind, &IdSet::new())
.unwrap(); .unwrap();
assert!(!empty.changed && empty.info.is_none()); assert!(!empty.changed && empty.info.is_none());
let first = store let first = store
.merge_collection(profile, kind, &IdSet::from_ids([10, 20, 30]).unwrap()) .merge_collection(
profile,
ruleset,
kind,
&IdSet::from_ids([10, 20, 30]).unwrap(),
)
.unwrap(); .unwrap();
assert!(first.changed); assert!(first.changed);
assert_eq!(first.added, 3); assert_eq!(first.added, 3);
@@ -936,7 +1048,7 @@ fn collection_union_never_removes_and_unchanged_means_no_revision() {
// another realm returns a subset: nothing is lost, nothing changes // another realm returns a subset: nothing is lost, nothing changes
let subset = store let subset = store
.merge_collection(profile, kind, &IdSet::from_ids([20]).unwrap()) .merge_collection(profile, ruleset, kind, &IdSet::from_ids([20]).unwrap())
.unwrap(); .unwrap();
assert!(!subset.changed); assert!(!subset.changed);
assert_eq!( assert_eq!(
@@ -945,13 +1057,23 @@ fn collection_union_never_removes_and_unchanged_means_no_revision() {
"same revision, same hash" "same revision, same hash"
); );
let same = store let same = store
.merge_collection(profile, kind, &IdSet::from_ids([10, 20, 30]).unwrap()) .merge_collection(
profile,
ruleset,
kind,
&IdSet::from_ids([10, 20, 30]).unwrap(),
)
.unwrap(); .unwrap();
assert!(!same.changed); assert!(!same.changed);
// a realm with new unlocks (and without the old ones) only adds // a realm with new unlocks (and without the old ones) only adds
let more = store let more = store
.merge_collection(profile, kind, &IdSet::from_ids([30, 40, 5]).unwrap()) .merge_collection(
profile,
ruleset,
kind,
&IdSet::from_ids([30, 40, 5]).unwrap(),
)
.unwrap(); .unwrap();
assert!(more.changed); assert!(more.changed);
assert_eq!(more.added, 2); assert_eq!(more.added, 2);
@@ -959,22 +1081,25 @@ fn collection_union_never_removes_and_unchanged_means_no_revision() {
assert_eq!((info2.revision, info2.count), (2, 5)); assert_eq!((info2.revision, info2.count), (2, 5));
assert_ne!(info2.hash, info1.hash); assert_ne!(info2.hash, info1.hash);
let (info, set) = store.collection(profile, kind).unwrap().unwrap(); let (info, set) = store.collection(profile, ruleset, kind).unwrap().unwrap();
assert_eq!(set.ids(), &[5, 10, 20, 30, 40]); assert_eq!(set.ids(), &[5, 10, 20, 30, 40]);
assert_eq!(info, info2); assert_eq!(info, info2);
assert_eq!( assert_eq!(
store.collection_info(profile, kind).unwrap().unwrap(), store
.collection_info(profile, ruleset, kind)
.unwrap()
.unwrap(),
info2 info2
); );
// kinds are separate collections // kinds are separate collections
assert!(store assert!(store
.collection_info(profile, "coa:vanity") .collection_info(profile, ruleset, "coa:vanity")
.unwrap() .unwrap()
.is_none()); .is_none());
assert!( assert!(
store store
.merge_collection(profile, "wardrobe", &IdSet::new()) .merge_collection(profile, ruleset, "wardrobe", &IdSet::new())
.is_err(), .is_err(),
"kinds must be namespaced" "kinds must be namespaced"
); );
@@ -990,7 +1115,9 @@ fn collections_hold_tens_of_thousands_of_ids_compactly() {
] { ] {
let ids: Vec<u32> = (0..count).map(|n| n * 7 + (n % 5)).collect(); let ids: Vec<u32> = (0..count).map(|n| n * 7 + (n % 5)).collect();
let set = IdSet::from_ids(ids).unwrap(); let set = IdSet::from_ids(ids).unwrap();
let merge = store.merge_collection(profile, kind, &set).unwrap(); let merge = store
.merge_collection(profile, Ruleset::Coa, kind, &set)
.unwrap();
assert_eq!(merge.added, count as usize); assert_eq!(merge.added, count as usize);
let stored_bytes: i64 = store let stored_bytes: i64 = store
.conn .conn
@@ -1004,7 +1131,10 @@ fn collections_hold_tens_of_thousands_of_ids_compactly() {
stored_bytes < count as i64 * 2 + 16, stored_bytes < count as i64 * 2 + 16,
"{kind}: {count} ids took {stored_bytes} bytes" "{kind}: {count} ids took {stored_bytes} bytes"
); );
let (_, back) = store.collection(profile, kind).unwrap().unwrap(); let (_, back) = store
.collection(profile, Ruleset::Coa, kind)
.unwrap()
.unwrap();
assert_eq!(back, set); assert_eq!(back, set);
} }
} }
@@ -1013,7 +1143,12 @@ fn collections_hold_tens_of_thousands_of_ids_compactly() {
fn a_tampered_collection_is_detected() { fn a_tampered_collection_is_detected() {
let (mut store, profile) = fresh(); let (mut store, profile) = fresh();
store store
.merge_collection(profile, "coa:vanity", &IdSet::from_ids([1, 2, 3]).unwrap()) .merge_collection(
profile,
Ruleset::Coa,
"coa:vanity",
&IdSet::from_ids([1, 2, 3]).unwrap(),
)
.unwrap(); .unwrap();
let forged = IdSet::from_ids([1, 2, 3, 4]).unwrap().encode(); let forged = IdSet::from_ids([1, 2, 3, 4]).unwrap().encode();
store store
@@ -1021,7 +1156,7 @@ fn a_tampered_collection_is_detected() {
.execute("UPDATE collection SET payload = ?1", [forged]) .execute("UPDATE collection SET payload = ?1", [forged])
.unwrap(); .unwrap();
assert!(matches!( assert!(matches!(
store.collection(profile, "coa:vanity"), store.collection(profile, Ruleset::Coa, "coa:vanity"),
Err(PortableError::CorruptSnapshot(_)) Err(PortableError::CorruptSnapshot(_))
)); ));
} }
@@ -1939,3 +2074,531 @@ fn a_store_that_holds_format_1_snapshots_reads_them_and_compares_them_by_what_th
); );
assert_eq!(owner.load_current(id).unwrap(), other); assert_eq!(owner.load_current(id).unwrap(), other);
} }
#[test]
fn released_v0_7_x_database_upgrades_transactionally_through_migration_009_and_accepts_reborn() {
let dir = tempfile::tempdir().unwrap();
let file = Store::path_of(dir.path());
let profile = ProfileId::new();
let char_coa = CharacterId::new();
let char_wc = CharacterId::new();
let item_coa = PortableItemId::new();
let now = "2026-10-22T12:00:00Z";
// Build realistic pre-multiruleset v0.7.x database (migrations 0..8)
{
let conn = Connection::open(&file).unwrap();
conn.pragma_update(None, "foreign_keys", true).unwrap();
for m in &MIGRATIONS[..8] {
conn.execute_batch(m).unwrap();
}
conn.pragma_update(None, "application_id", APPLICATION_ID)
.unwrap();
conn.pragma_update(None, "user_version", 8).unwrap();
// 1. Profile
conn.execute(
"INSERT INTO profile (profile_id, created_at, format_version) VALUES (?1, ?2, 1)",
params![profile.to_string(), now],
)
.unwrap();
// 2. Characters (CoA and Wildcard allowed in pre-009 schema)
conn.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'coa', 'Varian', 'coa:race:1', 'coa:class:1', 0, 80, 1, ?3, ?3, 0)",
params![char_coa.to_string(), profile.to_string(), now],
).unwrap();
conn.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'wildcard', 'RogueMage', 'coa:race:1', 'coa:class:4', 1, 60, 2, ?3, ?3, 0)",
params![char_wc.to_string(), profile.to_string(), now],
).unwrap();
// Verify pre-009 CHECK constraint rejects 'reborn'
let err = conn.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'reborn', 'Paladin', 'coa:race:1', 'coa:class:2', 0, 70, 1, ?3, ?3, 0)",
params![CharacterId::new().to_string(), profile.to_string(), now],
);
assert!(err.is_err(), "pre-009 schema must reject reborn");
// 3. Snapshots and revisions
conn.execute(
"INSERT INTO snapshot (character_id, revision, snapshot_format_version, created_at, source_server_id, content_hash, uncompressed_size, payload, note)
VALUES (?1, 1, 2, ?2, 'realm-a', ?3, 4, X'01020304', 'genesis')",
params![char_coa.to_string(), now, [0x42u8; 32]],
).unwrap();
// 4. Mappings and server bindings
conn.execute(
"INSERT INTO character_server_mapping (character_id, server_id, local_guid, last_revision, state, updated_at)
VALUES (?1, 'realm-a', 101, 1, 'active', ?2)",
params![char_coa.to_string(), now],
).unwrap();
conn.execute(
"INSERT INTO item_mapping (character_id, server_id, portable_item_id, local_item_guid, entry, identity, state, created_revision, confirmed_revision, created_at, updated_at)
VALUES (?1, 'realm-a', ?2, 202, 'item_entry', 'ident', 'active', 1, 1, ?3, ?3)",
params![char_coa.to_string(), item_coa.to_string(), now],
).unwrap();
// 5. Baseline session (realm_baseline)
conn.execute(
"INSERT INTO realm_baseline (character_id, server_id, c0_revision, head_revision, state, c0_hash, c0_payload, b0_hash, b0_payload, created_at, updated_at)
VALUES (?1, 'realm-a', 1, 1, 'open', ?2, X'AA', ?2, X'BB', ?3, ?3)",
params![char_coa.to_string(), [0x42u8; 32], now],
).unwrap();
// 6. Pre-009 Collection (single profile_id, kind PK)
conn.execute(
"INSERT INTO collection (profile_id, kind, collection_revision, collection_hash, format_version, item_count, updated_at, payload)
VALUES (?1, 'coa:appearance', 1, ?2, 1, 0, ?3, X'00')",
params![profile.to_string(), [0x42u8; 32], now],
).unwrap();
}
// Upgrade through Store::open_file (applies migration 009)
let store = Store::open_file(&file).unwrap();
assert_eq!(store.schema_version().unwrap(), 10);
// Verify all original rows and fields survived byte-for-byte and constraint-wise
let coa_rec = store.character(char_coa).unwrap();
assert_eq!(coa_rec.ruleset, Ruleset::Coa);
assert_eq!(coa_rec.name, "Varian");
assert_eq!(coa_rec.revision, 1);
assert_eq!(coa_rec.level, 80);
assert_eq!(coa_rec.created_at, now);
let wc_rec = store.character(char_wc).unwrap();
assert_eq!(wc_rec.ruleset, Ruleset::Wildcard);
assert_eq!(wc_rec.name, "RogueMage");
assert_eq!(wc_rec.revision, 2);
// Verify child tables survived without cascading drop
let server_maps = store.server_mappings(char_coa).unwrap();
assert_eq!(server_maps.len(), 1);
assert_eq!(server_maps[0].local_guid, 101);
let item_maps = store.item_mappings(char_coa, "realm-a").unwrap();
assert_eq!(item_maps.len(), 1);
assert_eq!(item_maps[0].portable_item_id, item_coa);
assert_eq!(item_maps[0].local_item_guid, 202);
// Verify collection migrated to composite key (profile_id, ruleset, kind)
let coll_info = store
.collection_info(profile, Ruleset::Coa, "coa:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_info.revision, 1);
// Verify insertion of Reborn character succeeds now on migrated DB
let char_rb = CharacterId::new();
let rb_rec = store.conn.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'reborn', 'Mograine', 'coa:race:1', 'coa:class:2', 0, 70, 1, ?3, ?3, 0)",
params![char_rb.to_string(), profile.to_string(), now],
);
assert!(
rb_rec.is_ok(),
"migrated database must accept reborn ruleset"
);
let loaded_rb = store.character(char_rb).unwrap();
assert_eq!(loaded_rb.ruleset, Ruleset::Reborn);
assert_eq!(loaded_rb.name, "Mograine");
// Verify invalid ruleset is still rejected by CHECK constraint
let err = store.conn.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'invalid_ruleset', 'Bad', 'coa:race:1', 'coa:class:1', 0, 1, 1, ?3, ?3, 0)",
params![CharacterId::new().to_string(), profile.to_string(), now],
);
assert!(
err.is_err(),
"migrated database must reject invalid ruleset"
);
}
#[test]
fn mapping_isolation_between_coa_and_wildcard_on_same_installation() {
let mut store = Store::open_in_memory().unwrap();
let profile = store.default_profile().unwrap();
let mut model_coa = fixtures::geared_level_eighty();
model_coa.ruleset = Ruleset::Coa;
let char_coa = store
.create_character(profile, model_coa, "srv-1:coa")
.unwrap();
let mut model_wc = fixtures::geared_level_eighty();
model_wc.ruleset = Ruleset::Wildcard;
let char_wc = store
.create_character(profile, model_wc, "srv-1:wildcard")
.unwrap();
// 1. Both share local_guid = 100 on their respective server_id
store
.bind_server(char_coa, "srv-1:coa", 100, 1, MappingState::Active)
.unwrap();
store
.bind_server(char_wc, "srv-1:wildcard", 100, 1, MappingState::Active)
.unwrap();
// 2. Both share local_item_guid = 500 on their respective server_id
let item_coa = PortableItemId::new();
let item_wc = PortableItemId::new();
store
.reconcile_item_mappings(
char_coa,
"srv-1:coa",
1,
&[obs(item_coa, 500, 10, "entry1")],
)
.unwrap();
store
.reconcile_item_mappings(
char_wc,
"srv-1:wildcard",
1,
&[obs(item_wc, 500, 20, "entry2")],
)
.unwrap();
// Verify lookup isolation
assert_eq!(
store.find_by_local("srv-1:coa", 100).unwrap(),
Some(char_coa)
);
assert_eq!(
store.find_by_local("srv-1:wildcard", 100).unwrap(),
Some(char_wc)
);
let maps_coa = store.item_mappings(char_coa, "srv-1:coa").unwrap();
assert_eq!(maps_coa.len(), 1);
assert_eq!(maps_coa[0].portable_item_id, item_coa);
assert_eq!(maps_coa[0].local_item_guid, 500);
let maps_wc = store.item_mappings(char_wc, "srv-1:wildcard").unwrap();
assert_eq!(maps_wc.len(), 1);
assert_eq!(maps_wc[0].portable_item_id, item_wc);
assert_eq!(maps_wc[0].local_item_guid, 500);
}
#[test]
fn three_space_isolation_fixture_proves_wildcard_activity_leaves_coa_and_reborn_untouched() {
let mut store = Store::open_in_memory().unwrap();
let profile = store.default_profile().unwrap();
// Character A: CoA
let mut model_a = fixtures::geared_level_eighty();
model_a.identity.name = "Hero".into();
model_a.ruleset = Ruleset::Coa;
let char_a = store
.create_character(profile, model_a, "srv-1:coa")
.unwrap();
// Character B: Wildcard
let mut model_b = fixtures::geared_level_eighty();
model_b.identity.name = "Hero".into();
model_b.ruleset = Ruleset::Wildcard;
let char_b = store
.create_character(profile, model_b, "srv-1:wildcard")
.unwrap();
// Character C: Reborn
let mut model_c = fixtures::geared_level_eighty();
model_c.identity.name = "Hero".into();
model_c.ruleset = Ruleset::Reborn;
let char_c = store
.create_character(profile, model_c, "srv-1:reborn")
.unwrap();
// Initial identical mappings (local_guid = 100, item_guid = 200)
store
.bind_server(char_a, "srv-1:coa", 100, 1, MappingState::Active)
.unwrap();
store
.bind_server(char_b, "srv-1:wildcard", 100, 1, MappingState::Active)
.unwrap();
store
.bind_server(char_c, "srv-1:reborn", 100, 1, MappingState::Active)
.unwrap();
let item_a = PortableItemId::new();
let item_b = PortableItemId::new();
let item_c = PortableItemId::new();
store
.reconcile_item_mappings(char_a, "srv-1:coa", 1, &[obs(item_a, 200, 10, "e1")])
.unwrap();
store
.reconcile_item_mappings(char_b, "srv-1:wildcard", 1, &[obs(item_b, 200, 10, "e2")])
.unwrap();
store
.reconcile_item_mappings(char_c, "srv-1:reborn", 1, &[obs(item_c, 200, 10, "e3")])
.unwrap();
// Initial collections
store
.merge_collection(
profile,
Ruleset::Coa,
"coa:appearance",
&IdSet::from_ids([1, 2, 3]).unwrap(),
)
.unwrap();
store
.merge_collection(
profile,
Ruleset::Wildcard,
"wildcard:appearance",
&IdSet::from_ids([1, 2, 4]).unwrap(),
)
.unwrap();
store
.merge_collection(
profile,
Ruleset::Reborn,
"reborn:appearance",
&IdSet::from_ids([1, 2, 5]).unwrap(),
)
.unwrap();
// Record baseline hashes and revisions
let hash_a_before = store.load_snapshot(char_a, 1).unwrap();
let hash_c_before = store.load_snapshot(char_c, 1).unwrap();
// ---- MUTATE WILDCARD B ONLY ----
let mut model_b_mut = store.load_current(char_b).unwrap();
model_b_mut.progression.money += 100_000;
model_b_mut.progression.level = 80;
store
.commit_snapshot(
char_b,
1,
model_b_mut,
"srv-1:wildcard",
Some("wildcard gameplay"),
)
.unwrap();
store
.merge_collection(
profile,
Ruleset::Wildcard,
"wildcard:appearance",
&IdSet::from_ids([1, 2, 4, 999]).unwrap(),
)
.unwrap();
let new_item_b = PortableItemId::new();
store
.reconcile_item_mappings(
char_b,
"srv-1:wildcard",
2,
&[
obs(item_b, 200, 10, "e2"),
obs(new_item_b, 201, 10, "e2_new"),
],
)
.unwrap();
// ---- ASSERT WILDCARD B ADVANCED ----
let rec_b = store.character(char_b).unwrap();
assert_eq!(rec_b.revision, 2);
let (_, coll_b) = store
.collection(profile, Ruleset::Wildcard, "wildcard:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_b.ids(), &[1, 2, 4, 999]);
assert_eq!(
store.item_mappings(char_b, "srv-1:wildcard").unwrap().len(),
2
);
// ---- ASSERT COA A IS 100% UNTOUCHED ----
let rec_a = store.character(char_a).unwrap();
assert_eq!(rec_a.revision, 1);
let hash_a_after = store.load_snapshot(char_a, 1).unwrap();
assert_eq!(hash_a_before, hash_a_after);
let (_, coll_a) = store
.collection(profile, Ruleset::Coa, "coa:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_a.ids(), &[1, 2, 3]);
let items_a = store.item_mappings(char_a, "srv-1:coa").unwrap();
assert_eq!(items_a.len(), 1);
assert_eq!(items_a[0].portable_item_id, item_a);
assert_eq!(items_a[0].local_item_guid, 200);
// ---- ASSERT REBORN C IS 100% UNTOUCHED ----
let rec_c = store.character(char_c).unwrap();
assert_eq!(rec_c.revision, 1);
let hash_c_after = store.load_snapshot(char_c, 1).unwrap();
assert_eq!(hash_c_before, hash_c_after);
let (_, coll_c) = store
.collection(profile, Ruleset::Reborn, "reborn:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_c.ids(), &[1, 2, 5]);
let items_c = store.item_mappings(char_c, "srv-1:reborn").unwrap();
assert_eq!(items_c.len(), 1);
assert_eq!(items_c[0].portable_item_id, item_c);
assert_eq!(items_c[0].local_item_guid, 200);
// ---- MUTATE REBORN C ONLY ----
let mut model_c_mut = store.load_current(char_c).unwrap();
model_c_mut.progression.money += 300_000;
model_c_mut.progression.level = 80;
store
.commit_snapshot(
char_c,
1,
model_c_mut,
"srv-1:reborn",
Some("reborn gameplay progression"),
)
.unwrap();
store
.merge_collection(
profile,
Ruleset::Reborn,
"reborn:appearance",
&IdSet::from_ids([1, 2, 5, 8888]).unwrap(),
)
.unwrap();
let new_item_c = PortableItemId::new();
store
.reconcile_item_mappings(
char_c,
"srv-1:reborn",
2,
&[
obs(item_c, 200, 10, "e3"),
obs(new_item_c, 202, 10, "e3_new"),
],
)
.unwrap();
// ---- ASSERT REBORN C ADVANCED TO REV 2 ----
let rec_c2 = store.character(char_c).unwrap();
assert_eq!(rec_c2.revision, 2);
let (_, coll_c2) = store
.collection(profile, Ruleset::Reborn, "reborn:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_c2.ids(), &[1, 2, 5, 8888]);
assert_eq!(
store.item_mappings(char_c, "srv-1:reborn").unwrap().len(),
2
);
// ---- ASSERT COA A REMAINS 100% UNTOUCHED (STILL REV 1) ----
let rec_a2 = store.character(char_a).unwrap();
assert_eq!(rec_a2.revision, 1);
assert_eq!(store.load_snapshot(char_a, 1).unwrap(), hash_a_before);
let (_, coll_a2) = store
.collection(profile, Ruleset::Coa, "coa:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_a2.ids(), &[1, 2, 3]);
assert_eq!(store.item_mappings(char_a, "srv-1:coa").unwrap().len(), 1);
// ---- ASSERT WILDCARD B REMAINS 100% UNTOUCHED (STILL REV 2) ----
let rec_b2 = store.character(char_b).unwrap();
assert_eq!(rec_b2.revision, 2);
let (_, coll_b2) = store
.collection(profile, Ruleset::Wildcard, "wildcard:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_b2.ids(), &[1, 2, 4, 999]);
assert_eq!(
store.item_mappings(char_b, "srv-1:wildcard").unwrap().len(),
2
);
}
#[test]
fn reborn_store_corruption_fails_closed() {
let mut store = Store::open_in_memory().unwrap();
let profile = store.default_profile().unwrap();
// 1. summary = reborn + snapshot = coa
let mut model_coa = fixtures::geared_level_eighty();
model_coa.ruleset = Ruleset::Coa;
let enc_coa = crate::portable::snapshot::encode(&model_coa).unwrap();
// Insert corrupt summary with reborn ruleset but pointing to coa snapshot
let id_1 = CharacterId::new();
let at = "2026-10-22T12:00:00Z";
store
.conn
.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'reborn', 'HeroReborn', 'coa:race:1', 'coa:class:1', 0, 80, 1, ?3, ?3, 0)",
rusqlite::params![id_1.to_string(), profile.to_string(), at],
)
.unwrap();
store
.conn
.execute(
"INSERT INTO snapshot (character_id, revision, snapshot_format_version, created_at, source_server_id, content_hash, uncompressed_size, payload, note)
VALUES (?1, 1, 2, ?2, 'srv-1:reborn', ?3, ?4, ?5, 'corrupted snapshot test')",
rusqlite::params![id_1.to_string(), at, enc_coa.content_hash.as_slice(), enc_coa.payload.len() as i64, enc_coa.payload],
)
.unwrap();
// Loading current snapshot must FAIL CLOSED with ruleset mismatch error
let res1 = store.load_current(id_1);
assert!(
res1.is_err(),
"Loading reborn summary with CoA snapshot must fail closed"
);
// 2. summary = reborn + snapshot = wildcard
let mut model_wc = fixtures::geared_level_eighty();
model_wc.ruleset = Ruleset::Wildcard;
let enc_wc = crate::portable::snapshot::encode(&model_wc).unwrap();
let id_2 = CharacterId::new();
store
.conn
.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'reborn', 'HeroReborn2', 'coa:race:1', 'coa:class:1', 0, 80, 1, ?3, ?3, 0)",
rusqlite::params![id_2.to_string(), profile.to_string(), at],
)
.unwrap();
store
.conn
.execute(
"INSERT INTO snapshot (character_id, revision, snapshot_format_version, created_at, source_server_id, content_hash, uncompressed_size, payload, note)
VALUES (?1, 1, 2, ?2, 'srv-1:reborn', ?3, ?4, ?5, 'corrupted snapshot test 2')",
rusqlite::params![id_2.to_string(), at, enc_wc.content_hash.as_slice(), enc_wc.payload.len() as i64, enc_wc.payload],
)
.unwrap();
let res2 = store.load_current(id_2);
assert!(
res2.is_err(),
"Loading reborn summary with Wildcard snapshot must fail closed"
);
}
#[test]
fn canonical_file_retains_full_sync_after_initialization_and_reopen() {
let dir = tempfile::tempdir().unwrap();
for _ in 0..2 {
let store = Store::open(dir.path()).unwrap();
let sync: i64 = store
.conn
.pragma_query_value(None, "synchronous", |row| row.get(0))
.unwrap();
assert_eq!(sync, 2);
}
}
+45 -5
View File
@@ -122,23 +122,63 @@ pub fn modules_of(root: &Path) -> Vec<ModuleEntry> {
out out
} }
/// The realm a local id names: an installed server (`srv-<install id>` or the bare install id) or a prepared descriptor. /// The realm a local id names: an installed server (`srv-<install id>`, `srv-<install id>:<ruleset>` or the bare install id) or a prepared descriptor.
pub fn find_access( pub fn find_access(
descriptors: &Path, descriptors: &Path,
installs: &[(String, PathBuf)], installs: &[(String, PathBuf)],
local_id: &str, local_id: &str,
) -> Option<RealmAccess> { ) -> Option<RealmAccess> {
let (base_id, explicit_mode) = if let Some((base, rs)) = local_id.split_once(':') {
let m = match rs {
"coa" => crate::realms::Mode::Coa,
"wildcard" => crate::realms::Mode::Wildcard,
"reborn" => crate::realms::Mode::Reborn,
_ => return None,
};
(base, Some(m))
} else {
(local_id, None)
};
if let Some((id, root)) = installs if let Some((id, root)) = installs
.iter() .iter()
.find(|(id, _)| format!("srv-{id}") == local_id || id == local_id) .find(|(id, _)| format!("srv-{id}") == base_id || id == base_id)
{ {
return Some(RealmAccess::from_install(id, root)); let mut access = RealmAccess::from_install(id, root);
if let Some(m) = explicit_mode {
if let Ok(st) = crate::realms::state(root) {
let supported = match m {
crate::realms::Mode::Coa => {
st.active == crate::realms::Mode::Coa || st.simultaneous
}
crate::realms::Mode::Wildcard => {
st.active == crate::realms::Mode::Wildcard
|| (st.simultaneous && st.wildcard_created)
}
crate::realms::Mode::Reborn => st.active == crate::realms::Mode::Reborn,
};
if !supported {
return None;
}
}
access.id = format!("srv-{id}:{}", m.name());
access.name = format!("{} — {}", access.name, m.label());
access.mode = Some(m);
}
return Some(access);
} }
let (found, _) = load_descriptors(descriptors); let (found, _) = load_descriptors(descriptors);
found found
.into_iter() .into_iter()
.find(|d| d.id == local_id) .find(|d| d.id == local_id || d.id == base_id)
.and_then(|d| RealmAccess::from_descriptor(d).ok()) .and_then(|d| {
let mut access = RealmAccess::from_descriptor(d).ok()?;
if let Some(m) = explicit_mode {
access.id = format!("{}:{}", access.id, m.name());
access.name = format!("{} — {}", access.name, m.label());
access.mode = Some(m);
}
Some(access)
})
} }
struct Cached { struct Cached {
@@ -106,6 +106,7 @@ pub struct RealmPublishStatus {
pub language: String, pub language: String,
pub region: Option<String>, pub region: Option<String>,
pub existing_only: bool, pub existing_only: bool,
pub allow_portable: bool,
pub route: Option<String>, pub route: Option<String>,
pub metadata_revision: Option<u64>, pub metadata_revision: Option<u64>,
pub last_ok_unix: Option<i64>, pub last_ok_unix: Option<i64>,
@@ -347,6 +348,7 @@ impl RegistryHost {
&mut self, &mut self,
local_id: &str, local_id: &str,
existing_only: bool, existing_only: bool,
allow_portable: bool,
route: Option<&str>, route: Option<&str>,
) -> Result<()> { ) -> Result<()> {
let route = route let route = route
@@ -359,6 +361,7 @@ impl RegistryHost {
}; };
let before = cfg.clone(); let before = cfg.clone();
cfg.existing_only = existing_only; cfg.existing_only = existing_only;
cfg.allow_portable = allow_portable;
cfg.route = route; cfg.route = route;
let cfg = cfg.clone(); let cfg = cfg.clone();
if let Err(e) = self.save() { if let Err(e) = self.save() {
@@ -421,6 +424,7 @@ impl RegistryHost {
language: p.cfg.language.clone(), language: p.cfg.language.clone(),
region: p.cfg.region.clone(), region: p.cfg.region.clone(),
existing_only: p.cfg.existing_only, existing_only: p.cfg.existing_only,
allow_portable: p.cfg.allow_portable,
route: p.cfg.route.clone(), route: p.cfg.route.clone(),
metadata_revision: p.revision, metadata_revision: p.revision,
last_ok_unix: p.last_ok, last_ok_unix: p.last_ok,
@@ -26,6 +26,7 @@ enum Cmd {
SetAccess { SetAccess {
local_id: String, local_id: String,
existing_only: bool, existing_only: bool,
allow_portable: bool,
route: Option<String>, route: Option<String>,
reply: Sender<Result<()>>, reply: Sender<Result<()>>,
}, },
@@ -90,11 +91,12 @@ impl RegistryRuntime {
Ok(Cmd::SetAccess { Ok(Cmd::SetAccess {
local_id, local_id,
existing_only, existing_only,
allow_portable,
route, route,
reply, reply,
}) => { }) => {
let _ = let _ =
reply.send(host.set_access(&local_id, existing_only, route.as_deref())); reply.send(host.set_access(&local_id, existing_only, allow_portable, route.as_deref()));
} }
Ok(Cmd::Retry(local_id)) => host.retry(&local_id, Instant::now()), Ok(Cmd::Retry(local_id)) => host.retry(&local_id, Instant::now()),
Err(RecvTimeoutError::Timeout) => {} Err(RecvTimeoutError::Timeout) => {}
@@ -157,11 +159,13 @@ impl RegistryRuntime {
&self, &self,
local_id: &str, local_id: &str,
existing_only: bool, existing_only: bool,
allow_portable: bool,
route: Option<&str>, route: Option<&str>,
) -> Result<()> { ) -> Result<()> {
self.ask(|reply| Cmd::SetAccess { self.ask(|reply| Cmd::SetAccess {
local_id: local_id.into(), local_id: local_id.into(),
existing_only, existing_only,
allow_portable,
route: route.map(str::to_string), route: route.map(str::to_string),
reply, reply,
}) })
@@ -25,6 +25,9 @@ pub struct PublishConfig {
/// The realm does not create accounts for joining players (it only links accounts that exist). Off by default: new players get an account. /// The realm does not create accounts for joining players (it only links accounts that exist). Off by default: new players get an account.
#[serde(default)] #[serde(default)]
pub existing_only: bool, pub existing_only: bool,
/// Portable character admission is an explicit owner opt-in.
#[serde(default)]
pub allow_portable: bool,
/// An address a player's game client can reach right now (`host` or `host:port`), stated by the owner. It is not discovery and not a relay. /// An address a player's game client can reach right now (`host` or `host:port`), stated by the owner. It is not discovery and not a relay.
#[serde(default)] #[serde(default)]
pub route: Option<String>, pub route: Option<String>,
@@ -205,6 +208,7 @@ mod tests {
language: "en".into(), language: "en".into(),
region: None, region: None,
existing_only: false, existing_only: false,
allow_portable: false,
route: None, route: None,
}, },
); );
+295 -58
View File
@@ -23,10 +23,26 @@ pub enum Mode {
impl Mode { impl Mode {
pub fn name(self) -> &'static str { pub fn name(self) -> &'static str {
match self { Self::Coa => "coa", Self::Wildcard => "wildcard", Self::Reborn => "reborn" } match self {
Self::Coa => "coa",
Self::Wildcard => "wildcard",
Self::Reborn => "reborn",
}
}
pub fn realm_id(self) -> u32 {
match self {
Self::Coa => 1,
Self::Wildcard => 2,
Self::Reborn => 3,
}
}
pub fn label(self) -> &'static str {
match self {
Self::Coa => "Conquest of Azeroth",
Self::Wildcard => "Wildcard",
Self::Reborn => "Warcraft Reborn",
}
} }
pub fn realm_id(self) -> u32 { match self { Self::Coa => 1, Self::Wildcard => 2, Self::Reborn => 3 } }
pub fn label(self) -> &'static str { match self { Self::Coa => "Conquest of Azeroth", Self::Wildcard => "Wildcard", Self::Reborn => "Warcraft Reborn" } }
pub fn schema(self, kind: &str) -> Result<&'static str> { pub fn schema(self, kind: &str) -> Result<&'static str> {
match (self, kind) { match (self, kind) {
(_, "auth") => Ok("acore_auth"), (_, "auth") => Ok("acore_auth"),
@@ -56,10 +72,20 @@ pub struct RealmState {
} }
impl RealmState { impl RealmState {
pub fn created(&self, mode: Mode) -> bool { match mode { Mode::Coa => true, Mode::Wildcard => self.wildcard_created, Mode::Reborn => self.reborn_created } } pub fn created(&self, mode: Mode) -> bool {
match mode {
Mode::Coa => true,
Mode::Wildcard => self.wildcard_created,
Mode::Reborn => self.reborn_created,
}
}
pub fn modes(&self) -> Vec<Mode> { pub fn modes(&self) -> Vec<Mode> {
let mut modes = vec![self.active]; let mut modes = vec![self.active];
modes.extend([Mode::Coa, Mode::Wildcard, Mode::Reborn].into_iter().filter(|m| *m != self.active && self.created(*m))); modes.extend(
[Mode::Coa, Mode::Wildcard, Mode::Reborn]
.into_iter()
.filter(|m| *m != self.active && self.created(*m)),
);
modes modes
} }
} }
@@ -98,9 +124,23 @@ pub fn view(root: &Path) -> Result<View> {
let s = state(root)?; let s = state(root)?;
// Inspect the binary itself; templates or an old log cannot prove installed support. // Inspect the binary itself; templates or an old log cannot prove installed support.
let binary = fs::read(world_binary(root))?; let binary = fs::read(world_binary(root))?;
let reborn_supported = binary.windows(b"Warcraft Reborn class spells are unavailable".len()).any(|w| w == b"Warcraft Reborn class spells are unavailable"); let reborn_supported = binary
let supported = binary.windows(b"Wildcard synergy settings".len()).any(|w| w == b"Wildcard synergy settings"); .windows(b"Warcraft Reborn class spells are unavailable".len())
Ok(View { active: s.active, wildcard_created: s.wildcard_created, reborn_created: s.reborn_created, reborn_supported, supported, recovery_pending: root.join(JOURNAL).exists(), simultaneous: s.simultaneous, secondary_world_port: s.secondary_world_port, secondary_running: crate::multiworld::is_running(root) }) .any(|w| w == b"Warcraft Reborn class spells are unavailable");
let supported = binary
.windows(b"Wildcard synergy settings".len())
.any(|w| w == b"Wildcard synergy settings");
Ok(View {
active: s.active,
wildcard_created: s.wildcard_created,
reborn_created: s.reborn_created,
reborn_supported,
supported,
recovery_pending: root.join(JOURNAL).exists(),
simultaneous: s.simultaneous,
secondary_world_port: s.secondary_world_port,
secondary_running: crate::multiworld::is_running(root),
})
} }
pub fn guard_module(root: &Path, id: &str) -> Result<()> { pub fn guard_module(root: &Path, id: &str) -> Result<()> {
@@ -223,24 +263,53 @@ fn wildcard_configs(mut files: Files) -> Result<Files> {
value, value,
)?; )?;
} }
set(&mut files, "Core/configs/modules/playerbots.conf", "AiPlayerbot.Enabled", "0")?; set(
&mut files,
"Core/configs/modules/playerbots.conf",
"AiPlayerbot.Enabled",
"0",
)?;
Ok(files) Ok(files)
} }
fn reborn_configs(mut files: Files) -> Result<Files> { fn reborn_configs(mut files: Files) -> Result<Files> {
for (key, value) in [ for (key, value) in [
("CoA.ClassModel", "\"wcr\""), ("CoA.GameModeMask", "0"), ("CoA.ClassModel", "\"wcr\""),
("CoA.MapClass10ToWarrior", "0"), ("CoA.RealmType", "\"live\""), ("CoA.GameModeMask", "0"),
("CoA.MapClass10ToWarrior", "0"),
("CoA.RealmType", "\"live\""),
("CoA.ClientBooleanConfigs", "\"\""), ("CoA.ClientBooleanConfigs", "\"\""),
] { set(&mut files, "Core/configs/modules/coa.conf", key, value)?; } ] {
set(&mut files, "Core/configs/modules/mod-coa-challenges.conf", "CoAChallenges.GameModes.Realm", "\"\"")?; set(&mut files, "Core/configs/modules/coa.conf", key, value)?;
for path in ["Settings/worldserver.conf.template", "Core/configs/worldserver.conf"] { }
if files.contains_key(path) { set(&mut files, path, "RealmID", "3")?; } set(
&mut files,
"Core/configs/modules/mod-coa-challenges.conf",
"CoAChallenges.GameModes.Realm",
"\"\"",
)?;
for path in [
"Settings/worldserver.conf.template",
"Core/configs/worldserver.conf",
] {
if files.contains_key(path) {
set(&mut files, path, "RealmID", "3")?;
}
} }
for (key, value) in [("CoaBots.Enable", "0"), ("CoaBots.AutoLoginOnStartup", "0")] { for (key, value) in [("CoaBots.Enable", "0"), ("CoaBots.AutoLoginOnStartup", "0")] {
set(&mut files, "Core/configs/modules/mod_coa_playerbots.conf", key, value)?; set(
&mut files,
"Core/configs/modules/mod_coa_playerbots.conf",
key,
value,
)?;
} }
set(&mut files, "Core/configs/modules/playerbots.conf", "AiPlayerbot.Enabled", "0")?; set(
&mut files,
"Core/configs/modules/playerbots.conf",
"AiPlayerbot.Enabled",
"0",
)?;
Ok(files) Ok(files)
} }
@@ -278,8 +347,15 @@ pub fn recover(root: &Path) -> Result<()> {
fn create_databases(root: &Path, mode: Mode) -> Result<()> { fn create_databases(root: &Path, mode: Mode) -> Result<()> {
crate::backup::with_database(root, |_| { crate::backup::with_database(root, |_| {
let db = Db::from_repack(root, Account::Admin)?.for_realm(Mode::Coa); let db = Db::from_repack(root, Account::Admin)?.for_realm(Mode::Coa);
if db.query(&format!("SELECT COUNT(*) FROM acore_auth.realmlist WHERE id={};", mode.realm_id()))? != "0" { if db.query(&format!(
return Err(Error::Invalid(format!("Realm ID {} is already in use. Its settings were left intact.", mode.realm_id()))); "SELECT COUNT(*) FROM acore_auth.realmlist WHERE id={};",
mode.realm_id()
))? != "0"
{
return Err(Error::Invalid(format!(
"Realm ID {} is already in use. Its settings were left intact.",
mode.realm_id()
)));
} }
for kind in ["world", "characters"] { for kind in ["world", "characters"] {
let source = Mode::Coa.schema(kind)?; let source = Mode::Coa.schema(kind)?;
@@ -294,7 +370,10 @@ fn create_databases(root: &Path, mode: Mode) -> Result<()> {
)); ));
} }
} }
for (kind, tables) in crate::schema_check::WILDCARD_TABLES.iter().filter(|_| mode == Mode::Wildcard) { for (kind, tables) in crate::schema_check::WILDCARD_TABLES
.iter()
.filter(|_| mode == Mode::Wildcard)
{
let schema = crate::db::schema_of(kind)?; let schema = crate::db::schema_of(kind)?;
let present = db.tables(schema)?; let present = db.tables(schema)?;
let missing: Vec<_> = tables let missing: Vec<_> = tables
@@ -384,21 +463,37 @@ pub fn select(root: &Path, mode: Mode) -> Result<View> {
)); ));
} }
if mode == Mode::Reborn && !view(root)?.reborn_supported { if mode == Mode::Reborn && !view(root)?.reborn_supported {
return Err(Error::Invalid("Update the server to a build with Warcraft Reborn support first.".into())); return Err(Error::Invalid(
"Update the server to a build with Warcraft Reborn support first.".into(),
));
} }
if s.simultaneous && mode != s.active { if s.simultaneous && mode != s.active {
return Err(Error::Invalid("Disable simultaneous startup before switching realms.".into())); return Err(Error::Invalid(
"Disable simultaneous startup before switching realms.".into(),
));
} }
// Verify launcher support before creating databases or changing the selected realm. // Verify launcher support before creating databases or changing the selected realm.
prepare_launcher(root)?; prepare_launcher(root)?;
let before = configs(root)?; let before = configs(root)?;
fsx::atomic_write_json(&snapshot(root, s.active), &before)?; fsx::atomic_write_json(&snapshot(root, s.active), &before)?;
if !s.created(mode) { if !s.created(mode) {
let base = if s.active == Mode::Coa { before.clone() } else { fsx::read_json(&snapshot(root, Mode::Coa))? }; let base = if s.active == Mode::Coa {
let files = match mode { Mode::Wildcard => wildcard_configs(base)?, Mode::Reborn => reborn_configs(base)?, Mode::Coa => unreachable!() }; before.clone()
} else {
fsx::read_json(&snapshot(root, Mode::Coa))?
};
let files = match mode {
Mode::Wildcard => wildcard_configs(base)?,
Mode::Reborn => reborn_configs(base)?,
Mode::Coa => unreachable!(),
};
fsx::atomic_write_json(&snapshot(root, mode), &files)?; fsx::atomic_write_json(&snapshot(root, mode), &files)?;
create_databases(root, mode)?; create_databases(root, mode)?;
match mode { Mode::Wildcard => s.wildcard_created = true, Mode::Reborn => s.reborn_created = true, Mode::Coa => {} } match mode {
Mode::Wildcard => s.wildcard_created = true,
Mode::Reborn => s.reborn_created = true,
Mode::Coa => {}
}
fsx::atomic_write_json(&root.join(STATE), &s)?; fsx::atomic_write_json(&root.join(STATE), &s)?;
} }
let target: Files = fsx::read_json(&snapshot(root, mode))?; let target: Files = fsx::read_json(&snapshot(root, mode))?;
@@ -481,9 +576,16 @@ const LAUNCHER_REALM_REPLACEMENTS: &[(&str, &str)] = &[
const LAUNCHER_REALM_INSERT: &str = "# coa-manager-realm-profiles-v1\ndef coa_realm():\n path = ROOT / 'Settings/realm-profile.json'\n return json.loads(path.read_text(encoding='utf-8')).get('active', 'coa') if path.exists() else 'coa'\n\ndef coa_realm_id():\n return 2 if coa_realm() == 'wildcard' else 1\n\ndef coa_realm_name():\n return 'Wildcard' if coa_realm() == 'wildcard' else 'Conquest of Azeroth'\n\n"; const LAUNCHER_REALM_INSERT: &str = "# coa-manager-realm-profiles-v1\ndef coa_realm():\n path = ROOT / 'Settings/realm-profile.json'\n return json.loads(path.read_text(encoding='utf-8')).get('active', 'coa') if path.exists() else 'coa'\n\ndef coa_realm_id():\n return 2 if coa_realm() == 'wildcard' else 1\n\ndef coa_realm_name():\n return 'Wildcard' if coa_realm() == 'wildcard' else 'Conquest of Azeroth'\n\n";
fn launcher_insert() -> String { fn launcher_insert() -> String {
LAUNCHER_REALM_INSERT.replace("profiles-v1", "profiles-v2") LAUNCHER_REALM_INSERT
.replace("return 2 if", "return 3 if coa_realm() == 'reborn' else 2 if") .replace("profiles-v1", "profiles-v2")
.replace("return 'Wildcard' if", "return 'Warcraft Reborn' if coa_realm() == 'reborn' else 'Wildcard' if") .replace(
"return 2 if",
"return 3 if coa_realm() == 'reborn' else 2 if",
)
.replace(
"return 'Wildcard' if",
"return 'Warcraft Reborn' if coa_realm() == 'reborn' else 'Wildcard' if",
)
} }
fn launcher_replacements() -> Vec<(&'static str, String)> { fn launcher_replacements() -> Vec<(&'static str, String)> {
@@ -493,19 +595,31 @@ fn launcher_replacements() -> Vec<(&'static str, String)> {
} }
pub(crate) fn patch_launcher(source: &str) -> Result<String> { pub(crate) fn patch_launcher(source: &str) -> Result<String> {
if source.contains("# coa-manager-realm-profiles-v2") { return Ok(source.into()); } if source.contains("# coa-manager-realm-profiles-v2") {
return Ok(source.into());
}
if source.contains("# coa-manager-realm-profiles-v1") { if source.contains("# coa-manager-realm-profiles-v1") {
let original = unpatch_launcher(source).ok_or_else(|| Error::Invalid("Unrecognised realm launcher patch.".into()))?; let original = unpatch_launcher(source)
.ok_or_else(|| Error::Invalid("Unrecognised realm launcher patch.".into()))?;
return patch_launcher(&original); return patch_launcher(&original);
} }
let mut out = source.to_string(); let mut out = source.to_string();
for (from, to) in launcher_replacements() { for (from, to) in launcher_replacements() {
if !out.contains(from) { return Err(Error::Invalid("This launcher does not support realm profiles. Update the server package first.".into())); } if !out.contains(from) {
return Err(Error::Invalid(
"This launcher does not support realm profiles. Update the server package first."
.into(),
));
}
out = out.replace(from, &to); out = out.replace(from, &to);
} }
// Insert before the entry point so ROOT, json and functions are all defined when called. // Insert before the entry point so ROOT, json and functions are all defined when called.
let marker = "if __name__ == \"__main__\":"; let marker = "if __name__ == \"__main__\":";
if !out.contains(marker) { return Err(Error::Invalid("Unrecognised server launcher entry point.".into())); } if !out.contains(marker) {
return Err(Error::Invalid(
"Unrecognised server launcher entry point.".into(),
));
}
Ok(out.replace(marker, &format!("{}{marker}", launcher_insert()))) Ok(out.replace(marker, &format!("{}{marker}", launcher_insert())))
} }
@@ -514,13 +628,28 @@ pub(crate) fn unpatch_launcher(source: &str) -> Option<String> {
let (insert, replacements) = if source.contains(&launcher_insert()) { let (insert, replacements) = if source.contains(&launcher_insert()) {
(launcher_insert(), launcher_replacements()) (launcher_insert(), launcher_replacements())
} else if source.contains(LAUNCHER_REALM_INSERT) { } else if source.contains(LAUNCHER_REALM_INSERT) {
(LAUNCHER_REALM_INSERT.into(), LAUNCHER_REALM_REPLACEMENTS.iter().map(|(a,b)| (*a, b.to_string())).collect()) (
} else { return None; }; LAUNCHER_REALM_INSERT.into(),
LAUNCHER_REALM_REPLACEMENTS
.iter()
.map(|(a, b)| (*a, b.to_string()))
.collect(),
)
} else {
return None;
};
let mut original = source.replacen(&insert, "", 1); let mut original = source.replacen(&insert, "", 1);
for (from, to) in &replacements { original = original.replace(to, from); } for (from, to) in &replacements {
original = original.replace(to, from);
}
let mut check = original.clone(); let mut check = original.clone();
for (from, to) in &replacements { check = check.replace(from, to); } for (from, to) in &replacements {
check = check.replace("if __name__ == \"__main__\":", &format!("{insert}if __name__ == \"__main__\":")); check = check.replace(from, to);
}
check = check.replace(
"if __name__ == \"__main__\":",
&format!("{insert}if __name__ == \"__main__\":"),
);
(check == source).then_some(original) (check == source).then_some(original)
} }
@@ -531,18 +660,40 @@ pub fn before_start(root: &Path) -> Result<()> {
return Ok(()); return Ok(());
} }
prepare_launcher(root)?; prepare_launcher(root)?;
if s.simultaneous && !view(root)?.supported { return Err(Error::Invalid("The installed server build does not support simultaneous Wildcard startup.".into())); } if s.simultaneous && !view(root)?.supported {
if s.simultaneous && s.active == Mode::Reborn { return Err(Error::Invalid("Simultaneous startup supports CoA and Wildcard only.".into())); } return Err(Error::Invalid(
if s.simultaneous { fsx::atomic_write_json(&snapshot(root, s.active), &configs(root)?)?; } "The installed server build does not support simultaneous Wildcard startup.".into(),
if s.active == Mode::Reborn && !view(root)?.reborn_supported { return Err(Error::Invalid("The installed server build does not support Warcraft Reborn.".into())); } ));
}
if s.simultaneous && s.active == Mode::Reborn {
return Err(Error::Invalid(
"Simultaneous startup supports CoA and Wildcard only.".into(),
));
}
if s.simultaneous {
fsx::atomic_write_json(&snapshot(root, s.active), &configs(root)?)?;
}
if s.active == Mode::Reborn && !view(root)?.reborn_supported {
return Err(Error::Invalid(
"The installed server build does not support Warcraft Reborn.".into(),
));
}
if s.active != Mode::Coa { if s.active != Mode::Coa {
if s.active == Mode::Wildcard && !view(root)?.supported { return Err(Error::Invalid("The installed server build does not support Wildcard.".into())); } if s.active == Mode::Wildcard && !view(root)?.supported {
return Err(Error::Invalid(
"The installed server build does not support Wildcard.".into(),
));
}
let path = root.join("Core/configs/modules/mod_coa_playerbots.conf"); let path = root.join("Core/configs/modules/mod_coa_playerbots.conf");
let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?; let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?;
conf.set("CoaBots.Enable", "0", &[]); conf.set("CoaBots.Enable", "0", &[]);
fsx::atomic_write(&path, conf.to_text().as_bytes())?; fsx::atomic_write(&path, conf.to_text().as_bytes())?;
let path = root.join("Core/configs/modules/playerbots.conf"); let path = root.join("Core/configs/modules/playerbots.conf");
let bytes = if path.exists() { fs::read(&path)? } else { b"[worldserver]\n".to_vec() }; let bytes = if path.exists() {
fs::read(&path)?
} else {
b"[worldserver]\n".to_vec()
};
let mut conf = ConfFile::parse_bytes(&bytes)?; let mut conf = ConfFile::parse_bytes(&bytes)?;
conf.set("AiPlayerbot.Enabled", "0", &[]); conf.set("AiPlayerbot.Enabled", "0", &[]);
fsx::atomic_write(&path, conf.to_text().as_bytes())?; fsx::atomic_write(&path, conf.to_text().as_bytes())?;
@@ -552,7 +703,9 @@ pub fn before_start(root: &Path) -> Result<()> {
pub fn setup_realmlist(root: &Path) -> Result<()> { pub fn setup_realmlist(root: &Path) -> Result<()> {
let s = state(root)?; let s = state(root)?;
if !root.join(STATE).exists() { return Ok(()); } if !root.join(STATE).exists() {
return Ok(());
}
let db = Db::from_repack(root, Account::Admin)?.for_realm(Mode::Coa); let db = Db::from_repack(root, Account::Admin)?.for_realm(Mode::Coa);
let port = layout::read_ports(root).world; let port = layout::read_ports(root).world;
for mode in s.modes().into_iter().filter(|m| *m != Mode::Coa) { for mode in s.modes().into_iter().filter(|m| *m != Mode::Coa) {
@@ -560,8 +713,16 @@ pub fn setup_realmlist(root: &Path) -> Result<()> {
let name = mode.label(); let name = mode.label();
db.query(&format!("INSERT INTO acore_auth.realmlist (id,name,address,localAddress,localSubnetMask,port,icon,flag,timezone,gamebuild) SELECT {id},'{name}',address,localAddress,localSubnetMask,{port},icon,2,timezone,gamebuild FROM acore_auth.realmlist WHERE id=1 ON DUPLICATE KEY UPDATE port={port};"))?; db.query(&format!("INSERT INTO acore_auth.realmlist (id,name,address,localAddress,localSubnetMask,port,icon,flag,timezone,gamebuild) SELECT {id},'{name}',address,localAddress,localSubnetMask,{port},icon,2,timezone,gamebuild FROM acore_auth.realmlist WHERE id=1 ON DUPLICATE KEY UPDATE port={port};"))?;
} }
let ids = s.modes().iter().map(|m| m.realm_id().to_string()).collect::<Vec<_>>().join(","); let ids = s
db.query(&format!("UPDATE acore_auth.realmlist SET flag=2 WHERE id IN ({ids}) AND id<>{};", s.active.realm_id()))?; .modes()
.iter()
.map(|m| m.realm_id().to_string())
.collect::<Vec<_>>()
.join(",");
db.query(&format!(
"UPDATE acore_auth.realmlist SET flag=2 WHERE id IN ({ids}) AND id<>{};",
s.active.realm_id()
))?;
if s.simultaneous { if s.simultaneous {
let second = s let second = s
.secondary_world_port .secondary_world_port
@@ -576,16 +737,52 @@ pub fn setup_realmlist(root: &Path) -> Result<()> {
Ok(()) Ok(())
} }
pub fn world_port_for_mode(root: &Path, mode: Mode) -> Result<u16> {
let ports = crate::layout::read_ports(root);
let s = state(root)?;
if s.simultaneous {
let second = s
.secondary_world_port
.ok_or_else(|| Error::Invalid("Second realm port is missing.".into()))?;
let port = match (s.active, mode) {
(Mode::Coa, Mode::Coa) => ports.world,
(Mode::Coa, Mode::Wildcard) => second,
(Mode::Wildcard, Mode::Wildcard) => ports.world,
(Mode::Wildcard, Mode::Coa) => second,
_ => {
return Err(Error::Invalid(format!(
"Unsupported mode {mode:?} for simultaneous hosting (active: {:?})",
s.active
)))
}
};
Ok(port)
} else if mode == s.active {
Ok(ports.world)
} else {
Err(Error::Invalid(format!(
"Realm mode {mode:?} is not active (active: {:?}) and simultaneous mode is disabled.",
s.active
)))
}
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
#[test] #[test]
fn legacy_states_and_all_created_realms_are_enumerated_once() { fn legacy_states_and_all_created_realms_are_enumerated_once() {
let legacy: RealmState = serde_json::from_str(r#"{"active":"wildcard","wildcard_created":true}"#).unwrap(); let legacy: RealmState =
serde_json::from_str(r#"{"active":"wildcard","wildcard_created":true}"#).unwrap();
assert!(!legacy.reborn_created); assert!(!legacy.reborn_created);
assert_eq!(legacy.modes(), [Mode::Wildcard, Mode::Coa]); assert_eq!(legacy.modes(), [Mode::Wildcard, Mode::Coa]);
let all = RealmState { active: Mode::Reborn, wildcard_created: true, reborn_created: true, ..Default::default() }; let all = RealmState {
active: Mode::Reborn,
wildcard_created: true,
reborn_created: true,
..Default::default()
};
assert_eq!(all.modes(), [Mode::Reborn, Mode::Coa, Mode::Wildcard]); assert_eq!(all.modes(), [Mode::Reborn, Mode::Coa, Mode::Wildcard]);
assert_eq!(serde_json::to_string(&Mode::Reborn).unwrap(), "\"reborn\""); assert_eq!(serde_json::to_string(&Mode::Reborn).unwrap(), "\"reborn\"");
assert_eq!(Mode::Reborn.realm_id(), 3); assert_eq!(Mode::Reborn.realm_id(), 3);
@@ -596,19 +793,46 @@ mod tests {
fn reborn_has_its_own_settings_and_restores_the_coa_profile() { fn reborn_has_its_own_settings_and_restores_the_coa_profile() {
let t = tempfile::tempdir().unwrap(); let t = tempfile::tempdir().unwrap();
let mut coa = Files::new(); let mut coa = Files::new();
coa.insert("Core/configs/modules/coa.conf".into(), b"[worldserver]\nCoA.ClassModel = coa\nCoA.GameModeMask = 0\n".to_vec()); coa.insert(
coa.insert("Settings/worldserver.conf.template".into(), b"[worldserver]\nRealmID = 1\n".to_vec()); "Core/configs/modules/coa.conf".into(),
coa.insert("Core/configs/modules/playerbots.conf".into(), b"[worldserver]\nAiPlayerbot.Enabled = 1\n".to_vec()); b"[worldserver]\nCoA.ClassModel = coa\nCoA.GameModeMask = 0\n".to_vec(),
);
coa.insert(
"Settings/worldserver.conf.template".into(),
b"[worldserver]\nRealmID = 1\n".to_vec(),
);
coa.insert(
"Core/configs/modules/playerbots.conf".into(),
b"[worldserver]\nAiPlayerbot.Enabled = 1\n".to_vec(),
);
let reborn = reborn_configs(coa.clone()).unwrap(); let reborn = reborn_configs(coa.clone()).unwrap();
let conf = ConfFile::parse_bytes(&reborn["Core/configs/modules/coa.conf"]).unwrap(); let conf = ConfFile::parse_bytes(&reborn["Core/configs/modules/coa.conf"]).unwrap();
assert_eq!(conf.get("CoA.ClassModel"), Some("\"wcr\"")); assert_eq!(conf.get("CoA.ClassModel"), Some("\"wcr\""));
assert_eq!(conf.get("CoA.GameModeMask"), Some("0")); assert_eq!(conf.get("CoA.GameModeMask"), Some("0"));
assert_eq!(ConfFile::parse_bytes(&reborn["Settings/worldserver.conf.template"]).unwrap().get("RealmID"), Some("3")); assert_eq!(
assert_eq!(ConfFile::parse_bytes(&reborn["Core/configs/modules/playerbots.conf"]).unwrap().get("AiPlayerbot.Enabled"), Some("0")); ConfFile::parse_bytes(&reborn["Settings/worldserver.conf.template"])
.unwrap()
.get("RealmID"),
Some("3")
);
assert_eq!(
ConfFile::parse_bytes(&reborn["Core/configs/modules/playerbots.conf"])
.unwrap()
.get("AiPlayerbot.Enabled"),
Some("0")
);
write_configs(t.path(), &reborn).unwrap(); write_configs(t.path(), &reborn).unwrap();
write_configs(t.path(), &coa).unwrap(); write_configs(t.path(), &coa).unwrap();
assert_eq!(configs(t.path()).unwrap(), coa); assert_eq!(configs(t.path()).unwrap(), coa);
fsx::atomic_write_json(&t.path().join(STATE), &RealmState { active: Mode::Reborn, reborn_created: true, ..Default::default() }).unwrap(); fsx::atomic_write_json(
&t.path().join(STATE),
&RealmState {
active: Mode::Reborn,
reborn_created: true,
..Default::default()
},
)
.unwrap();
assert!(guard_module(t.path(), "companions").is_err()); assert!(guard_module(t.path(), "companions").is_err());
assert!(guard_module(t.path(), "playerbots").is_err()); assert!(guard_module(t.path(), "playerbots").is_err());
assert!(guard_module(t.path(), "content-scaling").is_ok()); assert!(guard_module(t.path(), "content-scaling").is_ok());
@@ -617,9 +841,17 @@ mod tests {
#[test] #[test]
fn reborn_support_requires_the_new_code_in_the_installed_binary() { fn reborn_support_requires_the_new_code_in_the_installed_binary() {
let t = tempfile::tempdir().unwrap(); let t = tempfile::tempdir().unwrap();
fsx::atomic_write(&t.path().join("Core/worldserver.exe"), b"Wildcard synergy settings").unwrap(); fsx::atomic_write(
&t.path().join("Core/worldserver.exe"),
b"Wildcard synergy settings",
)
.unwrap();
assert!(!view(t.path()).unwrap().reborn_supported); assert!(!view(t.path()).unwrap().reborn_supported);
fsx::atomic_write(&t.path().join("Core/worldserver.exe"), b"Warcraft Reborn class spells are unavailable").unwrap(); fsx::atomic_write(
&t.path().join("Core/worldserver.exe"),
b"Warcraft Reborn class spells are unavailable",
)
.unwrap();
let v = view(t.path()).unwrap(); let v = view(t.path()).unwrap();
assert!(v.reborn_supported); assert!(v.reborn_supported);
assert!(!v.supported); assert!(!v.supported);
@@ -629,8 +861,13 @@ mod tests {
fn old_launcher_upgrades_and_both_patch_versions_are_reversible() { fn old_launcher_upgrades_and_both_patch_versions_are_reversible() {
let original = "(\"WorldDatabaseInfo\", \"acore_world\")\n(\"CharacterDatabaseInfo\", \"acore_characters\")\nSET name='AzerothCore',address=\nWHERE id=1;\nmysql(\"UPDATE acore_auth.realmlist SET flag=0\nif __name__ == \"__main__\":\n"; let original = "(\"WorldDatabaseInfo\", \"acore_world\")\n(\"CharacterDatabaseInfo\", \"acore_characters\")\nSET name='AzerothCore',address=\nWHERE id=1;\nmysql(\"UPDATE acore_auth.realmlist SET flag=0\nif __name__ == \"__main__\":\n";
let mut old = original.to_string(); let mut old = original.to_string();
for (from, to) in LAUNCHER_REALM_REPLACEMENTS { old = old.replace(from, to); } for (from, to) in LAUNCHER_REALM_REPLACEMENTS {
old = old.replace("if __name__ == \"__main__\":", &format!("{LAUNCHER_REALM_INSERT}if __name__ == \"__main__\":")); old = old.replace(from, to);
}
old = old.replace(
"if __name__ == \"__main__\":",
&format!("{LAUNCHER_REALM_INSERT}if __name__ == \"__main__\":"),
);
assert_eq!(unpatch_launcher(&old).as_deref(), Some(original)); assert_eq!(unpatch_launcher(&old).as_deref(), Some(original));
let new = patch_launcher(&old).unwrap(); let new = patch_launcher(&old).unwrap();
assert!(new.contains("acore_world_reborn")); assert!(new.contains("acore_world_reborn"));
+52
View File
@@ -39,6 +39,8 @@ fn sql_in(dir: &Path) -> Vec<PathBuf> {
fn introduction_rank(repo: &Path, pathspecs: &[&str]) -> std::collections::HashMap<String, usize> { fn introduction_rank(repo: &Path, pathspecs: &[&str]) -> std::collections::HashMap<String, usize> {
let mut args = vec![ let mut args = vec![
"log", "log",
"--full-history",
"--diff-merges=first-parent",
"--reverse", "--reverse",
"--diff-filter=A", "--diff-filter=A",
"--name-only", "--name-only",
@@ -306,6 +308,56 @@ pub fn revision(commit: &str) -> Revision {
mod tests { mod tests {
use super::*; use super::*;
#[test]
fn migrations_added_by_a_merge_precede_later_dependent_updates() {
let directory = tempfile::tempdir().unwrap();
let root = directory.path();
let git = |args: &[&str]| {
let output = Command::new("git")
.current_dir(root)
.args(args)
.output()
.unwrap();
assert!(
output.status.success(),
"git {args:?}: {}",
String::from_utf8_lossy(&output.stderr)
);
};
git(&["init", "-b", "main"]);
git(&["config", "user.name", "Migration Test"]);
git(&["config", "user.email", "migration-test@example.invalid"]);
write(
root,
"data/sql/updates/pending_db_world/00_schema.sql",
"SELECT 1;",
);
git(&["add", "."]);
git(&["commit", "-m", "schema"]);
git(&["switch", "-c", "side"]);
git(&["commit", "--allow-empty", "-m", "side"]);
git(&["switch", "main"]);
git(&["commit", "--allow-empty", "-m", "main"]);
git(&["merge", "--no-ff", "--no-commit", "side"]);
write(
root,
"data/sql/updates/pending_db_world/10_snapshot.sql",
"SELECT 2;",
);
git(&["add", "."]);
git(&["commit", "-m", "merge with snapshot"]);
write(
root,
"data/sql/updates/pending_db_world/20_progression.sql",
"SELECT 3;",
);
git(&["add", "."]);
git(&["commit", "-m", "new progression"]);
let sql = collect_core_sql(root).unwrap();
let ids: Vec<_> = sql.iter().map(|file| file.id.as_str()).collect();
assert_eq!(ids, ["00_schema", "10_snapshot", "20_progression"]);
}
fn write(root: &Path, rel: &str, c: &str) { fn write(root: &Path, rel: &str, c: &str) {
let p = root.join(rel); let p = root.join(rel);
fs::create_dir_all(p.parent().unwrap()).unwrap(); fs::create_dir_all(p.parent().unwrap()).unwrap();
+67 -14
View File
@@ -4,23 +4,57 @@ use std::path::Path;
/// SQUID has its own import ledger, outside the signed package migration ledger. /// SQUID has its own import ledger, outside the signed package migration ledger.
/// Keep this read-only: a pending base import can contain player data and must not /// Keep this read-only: a pending base import can contain player data and must not
/// be replayed or cleared merely because the normal schema contract passes. /// be replayed or cleared merely because the normal schema contract passes.
pub(crate) fn database_problems(root: &Path, mode: crate::realms::Mode, query: &impl Fn(&str) -> crate::Result<String>) -> crate::Result<Vec<crate::schema_check::Problem>> { pub(crate) fn database_problems(
root: &Path,
mode: crate::realms::Mode,
query: &impl Fn(&str) -> crate::Result<String>,
) -> crate::Result<Vec<crate::schema_check::Problem>> {
let active = root.join("Core/configs/modules/playerbots.conf"); let active = root.join("Core/configs/modules/playerbots.conf");
let config = if active.is_file() { active } else { root.join("Core/configs/modules/playerbots.conf.dist") }; let config = if active.is_file() {
active
} else {
root.join("Core/configs/modules/playerbots.conf.dist")
};
let enabled = if config.is_file() { let enabled = if config.is_file() {
let conf = crate::config::parser::ConfFile::parse_bytes(&std::fs::read(config)?)?; let conf = crate::config::parser::ConfFile::parse_bytes(&std::fs::read(config)?)?;
!matches!(conf.get("AiPlayerbot.Enabled").unwrap_or("1").trim().trim_matches('"').to_ascii_lowercase().as_str(), "0" | "false" | "no" | "off") !matches!(
} else { false }; conf.get("AiPlayerbot.Enabled")
.unwrap_or("1")
.trim()
.trim_matches('"')
.to_ascii_lowercase()
.as_str(),
"0" | "false" | "no" | "off"
)
} else {
false
};
let mut problems = Vec::new(); let mut problems = Vec::new();
for schema in [mode.schema("characters")?, mode.schema("world")?, "acore_playerbots"] { for schema in [
let tables: std::collections::BTreeSet<_> = query(&format!("SELECT TABLE_NAME FROM information_schema.TABLES WHERE TABLE_SCHEMA='{schema}';"))?.lines().map(str::to_owned).collect(); mode.schema("characters")?,
mode.schema("world")?,
"acore_playerbots",
] {
let tables: std::collections::BTreeSet<_> = query(&format!(
"SELECT TABLE_NAME FROM information_schema.TABLES WHERE TABLE_SCHEMA='{schema}';"
))?
.lines()
.map(str::to_owned)
.collect();
if tables.contains("coa_squid_pending") { if tables.contains("coa_squid_pending") {
for pending in query(&format!("SELECT path FROM `{schema}`.coa_squid_pending;"))?.lines().filter(|path| !path.is_empty()) { for pending in query(&format!("SELECT path FROM `{schema}`.coa_squid_pending;"))?
.lines()
.filter(|path| !path.is_empty())
{
problems.push(crate::schema_check::Problem { database: schema.into(), table: "coa_squid_pending".into(), column: String::new(), detail: format!("SQUID base import was interrupted: {pending}. File repair and package SQL updates cannot complete this import. Restore a verified database backup from before the import; do not delete the pending record or replay base SQL.") }); problems.push(crate::schema_check::Problem { database: schema.into(), table: "coa_squid_pending".into(), column: String::new(), detail: format!("SQUID base import was interrupted: {pending}. File repair and package SQL updates cannot complete this import. Restore a verified database backup from before the import; do not delete the pending record or replay base SQL.") });
} }
} }
if enabled && schema == mode.schema("characters")? { if enabled && schema == mode.schema("characters")? {
for table in ["playerbots_names", "playerbots_guild_names", "playerbots_arena_team_names"] { for table in [
"playerbots_names",
"playerbots_guild_names",
"playerbots_arena_team_names",
] {
if !tables.contains(table) { if !tables.contains(table) {
problems.push(crate::schema_check::Problem { database: schema.into(), table: table.into(), column: String::new(), detail: "Required SQUID character table is missing. A normal server start provisions it when no interrupted import is present; an interrupted import requires database recovery first.".into() }); problems.push(crate::schema_check::Problem { database: schema.into(), table: table.into(), column: String::new(), detail: "Required SQUID character table is missing. A normal server start provisions it when no interrupted import is present; an interrupted import requires database recovery first.".into() });
} }
@@ -237,9 +271,13 @@ mod tests {
for mode in [crate::realms::Mode::Coa, crate::realms::Mode::Wildcard] { for mode in [crate::realms::Mode::Coa, crate::realms::Mode::Wildcard] {
let problems = database_problems(root.path(), mode, &|sql| { let problems = database_problems(root.path(), mode, &|sql| {
assert!(sql.starts_with("SELECT ")); assert!(sql.starts_with("SELECT "));
if sql.contains("information_schema.TABLES") { Ok("coa_squid_pending".into()) } if sql.contains("information_schema.TABLES") {
else { Ok("playerbots/base/ai_playerbot_texts.sql".into()) } Ok("coa_squid_pending".into())
}).unwrap(); } else {
Ok("playerbots/base/ai_playerbot_texts.sql".into())
}
})
.unwrap();
assert_eq!(problems.len(), 3); assert_eq!(problems.len(), 3);
assert_eq!(problems[0].database, mode.schema("characters").unwrap()); assert_eq!(problems[0].database, mode.schema("characters").unwrap());
assert!(problems.iter().all(|p| p.detail.contains("interrupted"))); assert!(problems.iter().all(|p| p.detail.contains("interrupted")));
@@ -252,11 +290,26 @@ mod tests {
let config = root.path().join("Core/configs/modules/playerbots.conf"); let config = root.path().join("Core/configs/modules/playerbots.conf");
crate::fsx::atomic_write(&config, b"AiPlayerbot.Enabled = 1\n").unwrap(); crate::fsx::atomic_write(&config, b"AiPlayerbot.Enabled = 1\n").unwrap();
let query = |_: &str| Ok(String::new()); let query = |_: &str| Ok(String::new());
assert_eq!(database_problems(root.path(), crate::realms::Mode::Wildcard, &query).unwrap().len(), 3); assert_eq!(
database_problems(root.path(), crate::realms::Mode::Wildcard, &query)
.unwrap()
.len(),
3
);
crate::fsx::atomic_write(&config, b"AiPlayerbot.Enabled = 0\n").unwrap(); crate::fsx::atomic_write(&config, b"AiPlayerbot.Enabled = 0\n").unwrap();
assert!(database_problems(root.path(), crate::realms::Mode::Wildcard, &query).unwrap().is_empty()); assert!(
database_problems(root.path(), crate::realms::Mode::Wildcard, &query)
.unwrap()
.is_empty()
);
crate::fsx::atomic_write(&config, b"AiPlayerbot.Enabled = 1\n").unwrap(); crate::fsx::atomic_write(&config, b"AiPlayerbot.Enabled = 1\n").unwrap();
assert!(database_problems(root.path(), crate::realms::Mode::Coa, &|_| Ok("playerbots_names\nplayerbots_guild_names\nplayerbots_arena_team_names".into())).unwrap().is_empty()); assert!(
database_problems(root.path(), crate::realms::Mode::Coa, &|_| Ok(
"playerbots_names\nplayerbots_guild_names\nplayerbots_arena_team_names".into()
))
.unwrap()
.is_empty()
);
} }
#[test] #[test]
fn a_setting_with_choices_only_accepts_one_of_them() { fn a_setting_with_choices_only_accepts_one_of_them() {
+10 -2
View File
@@ -1964,8 +1964,16 @@ fn database_identities(
let mut identities = BTreeMap::new(); let mut identities = BTreeMap::new();
for (schema, table, columns) in [ for (schema, table, columns) in [
("acore_characters", "characters", "guid,account,HEX(name)"), ("acore_characters", "characters", "guid,account,HEX(name)"),
("acore_characters_wildcard", "characters", "guid,account,HEX(name)"), (
("acore_characters_reborn", "characters", "guid,account,HEX(name)"), "acore_characters_wildcard",
"characters",
"guid,account,HEX(name)",
),
(
"acore_characters_reborn",
"characters",
"guid,account,HEX(name)",
),
("acore_auth", "account", "id,HEX(username)"), ("acore_auth", "account", "id,HEX(username)"),
] { ] {
if !db.schema_exists(schema)? || !db.tables(schema)?.iter().any(|name| name == table) { if !db.schema_exists(schema)? || !db.tables(schema)?.iter().any(|name| name == table) {
+141 -59
View File
@@ -1,41 +1,71 @@
use std::{collections::BTreeMap, fs, path::Path};
use serde::{Deserialize, Serialize};
use crate::{config::parser::ConfFile, fsx, Error, Result}; use crate::{config::parser::ConfFile, fsx, Error, Result};
use serde::{Deserialize, Serialize};
use std::{collections::BTreeMap, fs, path::Path};
const FILES: &[&str] = &[ const FILES: &[&str] = &[
"Settings/repack.json", "Settings/realm-profile.json", "Settings/repack.json",
"Settings/worldserver.conf.template", "Settings/authserver.conf.template", "Settings/realm-profile.json",
"Core/configs/worldserver.conf", "Core/configs/authserver.conf", "Settings/worldserver.conf.template",
"Settings/realm-profiles/coa.json", "Settings/realm-profiles/wildcard.json", "Settings/authserver.conf.template",
".realms/secondary/Settings/repack.json", ".realms/secondary/Settings/realm-profile.json", "Core/configs/worldserver.conf",
".realms/secondary/Settings/worldserver.conf.template", ".realms/secondary/Settings/authserver.conf.template", "Core/configs/authserver.conf",
".realms/secondary/Core/configs/worldserver.conf", ".realms/secondary/Core/configs/authserver.conf", "Settings/realm-profiles/coa.json",
"Settings/realm-profiles/wildcard.json",
".realms/secondary/Settings/repack.json",
".realms/secondary/Settings/realm-profile.json",
".realms/secondary/Settings/worldserver.conf.template",
".realms/secondary/Settings/authserver.conf.template",
".realms/secondary/Core/configs/worldserver.conf",
".realms/secondary/Core/configs/authserver.conf",
"Settings/realm-profiles/reborn.json", "Settings/realm-profiles/reborn.json",
]; ];
#[derive(Serialize, Deserialize)] #[derive(Serialize, Deserialize)]
#[serde(deny_unknown_fields)] #[serde(deny_unknown_fields)]
struct Saved { bytes: Option<Vec<u8>>, sha256: Option<String> } struct Saved {
bytes: Option<Vec<u8>>,
sha256: Option<String>,
}
pub(crate) fn pending(meta: &Path) -> bool { meta.join("validation-configs.json").exists() } pub(crate) fn pending(meta: &Path) -> bool {
meta.join("validation-configs.json").exists()
}
pub(crate) fn begin(root: &Path, meta: &Path) -> Result<()> { pub(crate) fn begin(root: &Path, meta: &Path) -> Result<()> {
if pending(meta) { return Err(Error::Invalid("Interrupted isolated validation must be recovered first.".into())); } if pending(meta) {
return Err(Error::Invalid(
"Interrupted isolated validation must be recovered first.".into(),
));
}
let mut saved = BTreeMap::new(); let mut saved = BTreeMap::new();
for rel in FILES { for rel in FILES {
let path = fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?; let path = fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?;
let bytes = if path.exists() { Some(fs::read(path)?) } else { None }; let bytes = if path.exists() {
Some(fs::read(path)?)
} else {
None
};
let sha256 = bytes.as_ref().map(|b| fsx::sha256_bytes(b)); let sha256 = bytes.as_ref().map(|b| fsx::sha256_bytes(b));
saved.insert(*rel, Saved { bytes, sha256 }); saved.insert(*rel, Saved { bytes, sha256 });
} }
let mut settings: serde_json::Value = fsx::read_json(&root.join("Settings/repack.json"))?; let mut settings: serde_json::Value = fsx::read_json(&root.join("Settings/repack.json"))?;
let mut realm: Option<serde_json::Value> = if root.join("Settings/realm-profile.json").exists() { let mut realm: Option<serde_json::Value> = if root.join("Settings/realm-profile.json").exists()
{
Some(fsx::read_json(&root.join("Settings/realm-profile.json"))?) Some(fsx::read_json(&root.join("Settings/realm-profile.json"))?)
} else { None }; } else {
let mut excluded: std::collections::BTreeSet<u64> = ["mysqlPort", "authPort", "worldPort", "raPort"].iter() None
.filter_map(|key| settings[*key].as_u64()).collect(); };
let mut excluded: std::collections::BTreeSet<u64> =
["mysqlPort", "authPort", "worldPort", "raPort"]
.iter()
.filter_map(|key| settings[*key].as_u64())
.collect();
if let Some(state) = &realm { if let Some(state) = &realm {
excluded.extend(["secondary_world_port", "secondary_ra_port"].iter().filter_map(|key| state[*key].as_u64())); excluded.extend(
["secondary_world_port", "secondary_ra_port"]
.iter()
.filter_map(|key| state[*key].as_u64()),
);
} }
let mut sockets = Vec::new(); let mut sockets = Vec::new();
let mut reserve = || -> Result<u16> { let mut reserve = || -> Result<u16> {
@@ -48,29 +78,84 @@ pub(crate) fn begin(root: &Path, meta: &Path) -> Result<()> {
} }
} }
}; };
for key in ["authPort", "worldPort", "raPort"] { settings[key] = reserve()?.into(); } for key in ["authPort", "worldPort", "raPort"] {
settings[key] = reserve()?.into();
}
if let Some(state) = &mut realm { if let Some(state) = &mut realm {
for key in ["secondary_world_port", "secondary_ra_port"] { for key in ["secondary_world_port", "secondary_ra_port"] {
state[key] = reserve()?.into(); state[key] = reserve()?.into();
} }
} }
let mut configs = Vec::new(); let mut configs = Vec::new();
for rel in ["Settings/worldserver.conf.template", "Settings/authserver.conf.template", "Core/configs/worldserver.conf", "Core/configs/authserver.conf"] { for rel in [
"Settings/worldserver.conf.template",
"Settings/authserver.conf.template",
"Core/configs/worldserver.conf",
"Core/configs/authserver.conf",
] {
let path = root.join(rel); let path = root.join(rel);
if !path.exists() && rel.ends_with(".template") { if !path.exists() && rel.ends_with(".template") {
return Err(Error::Invalid(format!("Cannot isolate validation without {rel}."))); return Err(Error::Invalid(format!(
"Cannot isolate validation without {rel}."
)));
} }
if path.exists() { if path.exists() {
let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?; let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?;
conf.set("BindIP", "\"127.0.0.1\"", &[]); conf.set("BindIP", "\"127.0.0.1\"", &[]);
if rel.contains("worldserver") { conf.set("Ra.IP", "\"127.0.0.1\"", &[]); } if rel.contains("worldserver") {
conf.set("Ra.IP", "\"127.0.0.1\"", &[]);
}
configs.push((path, conf.to_text())); configs.push((path, conf.to_text()));
} }
} }
fsx::atomic_write_json(&meta.join("validation-configs.json"), &saved)?; fsx::atomic_write_json(&meta.join("validation-configs.json"), &saved)?;
fsx::atomic_write_json(&root.join("Settings/repack.json"), &settings)?; fsx::atomic_write_json(&root.join("Settings/repack.json"), &settings)?;
if let Some(state) = realm { fsx::atomic_write_json(&root.join("Settings/realm-profile.json"), &state)?; } if let Some(state) = realm {
for (path, text) in configs { fsx::atomic_write(&path, text.as_bytes())?; } fsx::atomic_write_json(&root.join("Settings/realm-profile.json"), &state)?;
}
for (path, text) in configs {
fsx::atomic_write(&path, text.as_bytes())?;
}
Ok(())
}
pub(crate) fn restore(root: &Path, meta: &Path) -> Result<()> {
if !pending(meta) {
return Ok(());
}
let journal = meta.join("validation-configs.json");
let saved: BTreeMap<String, Saved> = fsx::read_json(&journal)?;
// Previous managers could journal only the first two profiles. Recover those
// journals too, while continuing to reject missing or unknown legacy entries.
let legacy = saved.len() == FILES.len() - 1
&& !saved.contains_key("Settings/realm-profiles/reborn.json");
let required = if legacy {
&FILES[..FILES.len() - 1]
} else {
FILES
};
if saved.len() != required.len() || required.iter().any(|rel| !saved.contains_key(*rel)) {
return Err(Error::Invalid(
"Isolated validation configuration journal is incomplete.".into(),
));
}
for (rel, file) in &saved {
fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?;
if file.bytes.as_ref().map(|b| fsx::sha256_bytes(b)) != file.sha256 {
return Err(Error::Invalid(format!(
"Isolated validation recovery copy {rel} is damaged."
)));
}
}
for (rel, file) in saved {
let path = fsx::ensure_within(root, &fsx::safe_join(root, &rel)?)?;
match file.bytes {
Some(bytes) => fsx::atomic_write(&path, &bytes)?,
None if path.exists() => fs::remove_file(path)?,
None => {}
}
}
fs::remove_file(journal)?;
Ok(()) Ok(())
} }
@@ -84,10 +169,18 @@ mod tests {
let meta = dir.path().join("metadata"); let meta = dir.path().join("metadata");
fs::create_dir_all(root.join("Settings")).unwrap(); fs::create_dir_all(root.join("Settings")).unwrap();
fs::create_dir_all(&meta).unwrap(); fs::create_dir_all(&meta).unwrap();
fsx::atomic_write_json(&root.join(FILES[0]), &serde_json::json!({"mysqlPort":3306,"authPort":3724,"worldPort":8085,"raPort":3443})).unwrap(); fsx::atomic_write_json(
&root.join(FILES[0]),
&serde_json::json!({"mysqlPort":3306,"authPort":3724,"worldPort":8085,"raPort":3443}),
)
.unwrap();
fsx::atomic_write_json(&root.join(FILES[1]), &serde_json::json!({"simultaneous":true,"secondary_world_port":8086,"secondary_ra_port":3444})).unwrap(); fsx::atomic_write_json(&root.join(FILES[1]), &serde_json::json!({"simultaneous":true,"secondary_world_port":8086,"secondary_ra_port":3444})).unwrap();
for rel in [FILES[2], FILES[3]] { for rel in [FILES[2], FILES[3]] {
fsx::atomic_write(&root.join(rel), b"BindIP = \"0.0.0.0\"\r\nRa.IP = \"0.0.0.0\"\r\n").unwrap(); fsx::atomic_write(
&root.join(rel),
b"BindIP = \"0.0.0.0\"\r\nRa.IP = \"0.0.0.0\"\r\n",
)
.unwrap();
} }
(dir, root, meta) (dir, root, meta)
} }
@@ -95,7 +188,11 @@ mod tests {
#[test] #[test]
fn interrupted_validation_restores_original_bytes_and_absent_files() { fn interrupted_validation_restores_original_bytes_and_absent_files() {
let (_dir, root, meta) = fixture(); let (_dir, root, meta) = fixture();
fsx::atomic_write(&root.join("Settings/realm-profiles/reborn.json"), b"saved reborn profile").unwrap(); fsx::atomic_write(
&root.join("Settings/realm-profiles/reborn.json"),
b"saved reborn profile",
)
.unwrap();
let original: Vec<_> = FILES.iter().map(|p| fs::read(root.join(p)).ok()).collect(); let original: Vec<_> = FILES.iter().map(|p| fs::read(root.join(p)).ok()).collect();
begin(&root, &meta).unwrap(); begin(&root, &meta).unwrap();
assert!(crate::update::ensure_recovered(&meta).is_err()); assert!(crate::update::ensure_recovered(&meta).is_err());
@@ -103,14 +200,28 @@ mod tests {
let settings: serde_json::Value = fsx::read_json(&root.join(FILES[0])).unwrap(); let settings: serde_json::Value = fsx::read_json(&root.join(FILES[0])).unwrap();
assert_eq!(settings["mysqlPort"], 3306); assert_eq!(settings["mysqlPort"], 3306);
let realm: serde_json::Value = fsx::read_json(&root.join(FILES[1])).unwrap(); let realm: serde_json::Value = fsx::read_json(&root.join(FILES[1])).unwrap();
let ports: std::collections::BTreeSet<_> = [settings["authPort"].as_u64(), settings["worldPort"].as_u64(), settings["raPort"].as_u64(), realm["secondary_world_port"].as_u64(), realm["secondary_ra_port"].as_u64()].into_iter().collect(); let ports: std::collections::BTreeSet<_> = [
settings["authPort"].as_u64(),
settings["worldPort"].as_u64(),
settings["raPort"].as_u64(),
realm["secondary_world_port"].as_u64(),
realm["secondary_ra_port"].as_u64(),
]
.into_iter()
.collect();
assert_eq!(ports.len(), 5); assert_eq!(ports.len(), 5);
let config = ConfFile::parse_bytes(&fs::read(root.join(FILES[2])).unwrap()).unwrap(); let config = ConfFile::parse_bytes(&fs::read(root.join(FILES[2])).unwrap()).unwrap();
assert_eq!(config.get("BindIP"), Some("\"127.0.0.1\"")); assert_eq!(config.get("BindIP"), Some("\"127.0.0.1\""));
fsx::atomic_write(&root.join(FILES[4]), b"rendered temporary configuration").unwrap(); fsx::atomic_write(&root.join(FILES[4]), b"rendered temporary configuration").unwrap();
fsx::atomic_write(&root.join("Settings/realm-profiles/reborn.json"), b"temporary reborn profile").unwrap(); fsx::atomic_write(
&root.join("Settings/realm-profiles/reborn.json"),
b"temporary reborn profile",
)
.unwrap();
restore(&root, &meta).unwrap(); restore(&root, &meta).unwrap();
for (rel, bytes) in FILES.iter().zip(original) { assert_eq!(fs::read(root.join(rel)).ok(), bytes); } for (rel, bytes) in FILES.iter().zip(original) {
assert_eq!(fs::read(root.join(rel)).ok(), bytes);
}
assert!(!pending(&meta)); assert!(!pending(&meta));
restore(&root, &meta).unwrap(); restore(&root, &meta).unwrap();
} }
@@ -139,32 +250,3 @@ mod tests {
assert_eq!(fs::read(root.join(FILES[0])).unwrap(), before); assert_eq!(fs::read(root.join(FILES[0])).unwrap(), before);
} }
} }
pub(crate) fn restore(root: &Path, meta: &Path) -> Result<()> {
if !pending(meta) { return Ok(()); }
let journal = meta.join("validation-configs.json");
let saved: BTreeMap<String, Saved> = fsx::read_json(&journal)?;
// Previous managers could journal only the first two profiles. Recover those
// journals too, while continuing to reject missing or unknown legacy entries.
let legacy = saved.len() == FILES.len() - 1 && !saved.contains_key("Settings/realm-profiles/reborn.json");
let required = if legacy { &FILES[..FILES.len() - 1] } else { FILES };
if saved.len() != required.len() || required.iter().any(|rel| !saved.contains_key(*rel)) {
return Err(Error::Invalid("Isolated validation configuration journal is incomplete.".into()));
}
for (rel, file) in &saved {
fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?;
if file.bytes.as_ref().map(|b| fsx::sha256_bytes(b)) != file.sha256 {
return Err(Error::Invalid(format!("Isolated validation recovery copy {rel} is damaged.")));
}
}
for (rel, file) in saved {
let path = fsx::ensure_within(root, &fsx::safe_join(root, &rel)?)?;
match file.bytes {
Some(bytes) => fsx::atomic_write(&path, &bytes)?,
None if path.exists() => fs::remove_file(path)?,
None => {},
}
}
fs::remove_file(journal)?;
Ok(())
}
+75 -17
View File
@@ -1,4 +1,9 @@
use crate::{manifest::Manifest, pkgsource::{self, Source}, registry::InstallMeta, update, Result}; use crate::{
manifest::Manifest,
pkgsource::{self, Source},
registry::InstallMeta,
update, Result,
};
#[derive(Debug)] #[derive(Debug)]
pub struct Selection { pub struct Selection {
@@ -8,13 +13,22 @@ pub struct Selection {
} }
pub fn select(meta: &InstallMeta, source: Source, key: &str) -> Result<Selection> { pub fn select(meta: &InstallMeta, source: Source, key: &str) -> Result<Selection> {
select_with(meta, source, &mut |source| pkgsource::fetch_manifest(source, key)) select_with(meta, source, &mut |source| {
pkgsource::fetch_manifest(source, key)
})
} }
fn select_with(meta: &InstallMeta, source: Source, fetch: &mut impl FnMut(&Source) -> Result<(Manifest, Vec<u8>)>) -> Result<Selection> { fn select_with(
meta: &InstallMeta,
source: Source,
fetch: &mut impl FnMut(&Source) -> Result<(Manifest, Vec<u8>)>,
) -> Result<Selection> {
let (manifest, _) = fetch(&source)?; let (manifest, _) = fetch(&source)?;
update::validate_candidate(meta, &manifest)?; update::validate_candidate(meta, &manifest)?;
Ok(Selection { source, latest_version: None }) Ok(Selection {
source,
latest_version: None,
})
} }
#[cfg(test)] #[cfg(test)]
@@ -42,23 +56,51 @@ mod tests {
let folder = tempfile::tempdir().unwrap(); let folder = tempfile::tempdir().unwrap();
let signing = SigningKey::from_bytes(&[37; 32]); let signing = SigningKey::from_bytes(&[37; 32]);
let bytes = serde_json::to_vec(value).unwrap(); let bytes = serde_json::to_vec(value).unwrap();
fs::write(folder.path().join("manifest.json.sig"), STANDARD.encode(signing.sign(&bytes).to_bytes())).unwrap(); fs::write(
fs::write(folder.path().join("manifest.json"), if tamper { b"tampered".as_slice() } else { &bytes }).unwrap(); folder.path().join("manifest.json.sig"),
STANDARD.encode(signing.sign(&bytes).to_bytes()),
)
.unwrap();
fs::write(
folder.path().join("manifest.json"),
if tamper {
b"tampered".as_slice()
} else {
&bytes
},
)
.unwrap();
(folder, STANDARD.encode(signing.verifying_key().to_bytes())) (folder, STANDARD.encode(signing.verifying_key().to_bytes()))
} }
#[test] #[test]
fn every_known_older_version_selects_the_latest_signed_package_once() { fn every_known_older_version_selects_the_latest_signed_package_once() {
for installed in ["0.2.0", "0.261004.20", "0.261005.0", "0.261007.24", "0.261011.800006", "0.261013.54", "0.261015.58"] { for installed in [
"0.2.0",
"0.261004.20",
"0.261005.0",
"0.261007.24",
"0.261011.800006",
"0.261013.54",
"0.261015.58",
] {
let (folder, key) = fixture(&package(), false); let (folder, key) = fixture(&package(), false);
for kind in [crate::registry::InstallKind::New, crate::registry::InstallKind::Imported] { for kind in [
crate::registry::InstallKind::New,
crate::registry::InstallKind::Imported,
] {
let mut installation = meta(installed); let mut installation = meta(installed);
installation.kind = kind; installation.kind = kind;
let mut calls = 0; let mut calls = 0;
let selected = select_with(&installation, Source::Dir(folder.path().into()), &mut |source| { let selected = select_with(
calls += 1; &installation,
pkgsource::fetch_manifest(source, &key) Source::Dir(folder.path().into()),
}).unwrap(); &mut |source| {
calls += 1;
pkgsource::fetch_manifest(source, &key)
},
)
.unwrap();
assert!(matches!(selected.source, Source::Dir(path) if path == folder.path())); assert!(matches!(selected.source, Source::Dir(path) if path == folder.path()));
assert!(selected.latest_version.is_none()); assert!(selected.latest_version.is_none());
assert_eq!(calls, 1, "no intermediate package fetches for {installed}"); assert_eq!(calls, 1, "no intermediate package fetches for {installed}");
@@ -77,17 +119,33 @@ mod tests {
#[test] #[test]
fn signed_target_is_required_even_for_unlisted_old_versions() { fn signed_target_is_required_even_for_unlisted_old_versions() {
let (folder, key) = fixture(&package(), true); let (folder, key) = fixture(&package(), true);
assert!(select(&meta("0.261004.20"), Source::Dir(folder.path().into()), &key).is_err()); assert!(select(
&meta("0.261004.20"),
Source::Dir(folder.path().into()),
&key
)
.is_err());
} }
#[test] #[test]
fn platform_and_manager_requirements_are_still_enforced() { fn platform_and_manager_requirements_are_still_enforced() {
for (field, value) in [("minManagerVersion", "99.0.0"), ("platform", "other-platform")] { for (field, value) in [
("minManagerVersion", "99.0.0"),
("platform", "other-platform"),
] {
let mut target = package(); let mut target = package();
if field == "platform" { target["compatibility"][field] = value.into(); } if field == "platform" {
else { target[field] = value.into(); } target["compatibility"][field] = value.into();
} else {
target[field] = value.into();
}
let (folder, key) = fixture(&target, false); let (folder, key) = fixture(&target, false);
assert!(select(&meta("0.261004.20"), Source::Dir(folder.path().into()), &key).is_err()); assert!(select(
&meta("0.261004.20"),
Source::Dir(folder.path().into()),
&key
)
.is_err());
} }
} }
} }
+2 -1
View File
@@ -229,7 +229,8 @@ impl ListQuery {
q.ruleset = Some(match value.as_str() { q.ruleset = Some(match value.as_str() {
"coa" => Ruleset::Coa, "coa" => Ruleset::Coa,
"wildcard" => Ruleset::Wildcard, "wildcard" => Ruleset::Wildcard,
_ => return invalid("ruleset is coa or wildcard"), "reborn" => Ruleset::Reborn,
_ => return invalid("ruleset is coa, wildcard or reborn"),
}) })
} }
"cap_min" => q.cap_min = Some(number("cap_min", &value, 255)?), "cap_min" => q.cap_min = Some(number("cap_min", &value, 255)?),
+11 -1
View File
@@ -20,11 +20,12 @@ pub const MAX_CATALOG_ENTRIES: usize = 8;
const MAX_TOKEN: usize = 64; const MAX_TOKEN: usize = 64;
const MAX_IDENTITY: usize = 128; const MAX_IDENTITY: usize = 128;
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")] #[serde(rename_all = "lowercase")]
pub enum Ruleset { pub enum Ruleset {
Coa, Coa,
Wildcard, Wildcard,
Reborn,
} }
impl Ruleset { impl Ruleset {
@@ -32,6 +33,15 @@ impl Ruleset {
match self { match self {
Ruleset::Coa => "coa", Ruleset::Coa => "coa",
Ruleset::Wildcard => "wildcard", Ruleset::Wildcard => "wildcard",
Ruleset::Reborn => "reborn",
}
}
pub fn display_name(self) -> &'static str {
match self {
Ruleset::Coa => "Conquest of Azeroth",
Ruleset::Wildcard => "Wildcard",
Ruleset::Reborn => "Warcraft Reborn",
} }
} }
} }
+71 -24
View File
@@ -56,58 +56,104 @@ fn run() -> Result<(), String> {
.unwrap_or(DEFAULT_PART_SIZE); .unwrap_or(DEFAULT_PART_SIZE);
match cmd.as_str() { match cmd.as_str() {
"plan-update" => { "plan-update" => {
let mut meta = coa_core::registry::InstallMeta::new(coa_core::registry::InstallKind::New, std::path::Path::new("unused")); let mut meta = coa_core::registry::InstallMeta::new(
coa_core::registry::InstallKind::New,
std::path::Path::new("unused"),
);
meta.core.version = Some(need(&a, "from")?.clone()); meta.core.version = Some(need(&a, "from")?.clone());
let selection = coa_core::update_route::select(&meta, coa_core::pkgsource::Source::Url(need(&a, "source")?.clone()), coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?; let selection = coa_core::update_route::select(
let (manifest, _) = coa_core::pkgsource::fetch_manifest(&selection.source, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?; &meta,
println!("{}", serde_json::json!({"from":meta.core.version,"next":manifest.version,"latest":selection.latest_version})); coa_core::pkgsource::Source::Url(need(&a, "source")?.clone()),
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
let (manifest, _) = coa_core::pkgsource::fetch_manifest(
&selection.source,
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
println!(
"{}",
serde_json::json!({"from":meta.core.version,"next":manifest.version,"latest":selection.latest_version})
);
} }
"verify-install" => { "verify-install" => {
coa_core::release_schema::verify_install_package( coa_core::release_schema::verify_install_package(
&PathBuf::from(need(&a, "dir")?), coa_core::signing::EMBEDDED_PUBLIC_KEY, &PathBuf::from(need(&a, "dir")?),
).map_err(e)?; coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
} }
"compose-install" => { "compose-install" => {
coa_core::release_schema::compose_install( coa_core::release_schema::compose_install(
&PathBuf::from(need(&a, "base")?), &PathBuf::from(need(&a, "candidate")?), &PathBuf::from(need(&a, "base")?),
&PathBuf::from(need(&a, "fixture")?), coa_core::signing::EMBEDDED_PUBLIC_KEY, &PathBuf::from(need(&a, "candidate")?),
).map_err(e)?; &PathBuf::from(need(&a, "fixture")?),
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
} }
"qualify-install" => { "qualify-install" => {
let report = coa_core::release_schema::qualify_install( let report = coa_core::release_schema::qualify_install(
&PathBuf::from(need(&a, "package")?), &PathBuf::from(need(&a, "fixture")?), &PathBuf::from(need(&a, "package")?),
&PathBuf::from(need(&a, "fixture")?),
coa_core::signing::EMBEDDED_PUBLIC_KEY, coa_core::signing::EMBEDDED_PUBLIC_KEY,
).map_err(e)?; )
coa_core::fsx::atomic_write_json(&PathBuf::from(need(&a, "report")?), &report).map_err(e)?; .map_err(e)?;
coa_core::fsx::atomic_write_json(&PathBuf::from(need(&a, "report")?), &report)
.map_err(e)?;
} }
"qualify-upgrade" => { "qualify-upgrade" => {
let report = coa_core::release_schema::qualify_upgrade( let report = coa_core::release_schema::qualify_upgrade(
&PathBuf::from(need(&a, "base")?), &PathBuf::from(need(&a, "source")?), &PathBuf::from(need(&a, "base")?),
&PathBuf::from(need(&a, "candidate")?), &PathBuf::from(need(&a, "fixture")?), &PathBuf::from(need(&a, "source")?),
&PathBuf::from(need(&a, "candidate")?),
&PathBuf::from(need(&a, "fixture")?),
coa_core::signing::EMBEDDED_PUBLIC_KEY, coa_core::signing::EMBEDDED_PUBLIC_KEY,
).map_err(e)?; )
coa_core::fsx::atomic_write_json(&PathBuf::from(need(&a, "report")?), &report).map_err(e)?; .map_err(e)?;
coa_core::fsx::atomic_write_json(&PathBuf::from(need(&a, "report")?), &report)
.map_err(e)?;
println!("Manager upgrade transaction passed isolated qualification"); println!("Manager upgrade transaction passed isolated qualification");
} }
"qualify-startup" => { "qualify-startup" => {
coa_core::release_schema::validate_startup( coa_core::release_schema::validate_startup(
&PathBuf::from(need(&a, "fixture")?), &PathBuf::from(need(&a, "tree")?), &PathBuf::from(need(&a, "fixture")?),
&PathBuf::from(need(&a, "base")?), coa_core::signing::EMBEDDED_PUBLIC_KEY, &PathBuf::from(need(&a, "tree")?),
).map_err(e)?; &PathBuf::from(need(&a, "base")?),
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
println!("authserver and worldserver passed isolated startup qualification"); println!("authserver and worldserver passed isolated startup qualification");
} }
"verify-channel" => { "verify-channel" => {
let bytes = std::fs::read(need(&a, "file")?).map_err(|x| x.to_string())?; let bytes = std::fs::read(need(&a, "file")?).map_err(|x| x.to_string())?;
let pointer = coa_core::channels::verify(&bytes, need(&a, "channel")?, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?; let pointer = coa_core::channels::verify(
println!("{}", serde_json::to_string(&pointer).map_err(|x| x.to_string())?); &bytes,
need(&a, "channel")?,
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
println!(
"{}",
serde_json::to_string(&pointer).map_err(|x| x.to_string())?
);
} }
"verify-manifest" => { "verify-manifest" => {
let source = coa_core::pkgsource::Source::Dir(PathBuf::from(need(&a, "dir")?)); let source = coa_core::pkgsource::Source::Dir(PathBuf::from(need(&a, "dir")?));
let (manifest, _) = coa_core::pkgsource::fetch_manifest(&source, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?; let (manifest, _) = coa_core::pkgsource::fetch_manifest(
&source,
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
println!("verified signed manifest {}", manifest.version); println!("verified signed manifest {}", manifest.version);
} }
"verify-upgrade-fixture" => { "verify-upgrade-fixture" => {
coa_core::release_schema::verify_upgrade_fixture(&PathBuf::from(need(&a, "dir")?), coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?; coa_core::release_schema::verify_upgrade_fixture(
&PathBuf::from(need(&a, "dir")?),
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
println!("verified signed upgrade fixture and every archive file"); println!("verified signed upgrade fixture and every archive file");
} }
"extract-schema-base" => { "extract-schema-base" => {
@@ -252,7 +298,8 @@ fn run() -> Result<(), String> {
} }
"sign-channel" => { "sign-channel" => {
let pointer = coa_core::channels::Pointer { let pointer = coa_core::channels::Pointer {
schema: 1, channel: need(&a, "channel")?.clone(), schema: 1,
channel: need(&a, "channel")?.clone(),
version: need(&a, "version")?.clone(), version: need(&a, "version")?.clone(),
release_tag: format!("server-{}", need(&a, "version")?), release_tag: format!("server-{}", need(&a, "version")?),
snapshot: need(&a, "snapshot")?.clone(), snapshot: need(&a, "snapshot")?.clone(),
+5 -4
View File
@@ -6,7 +6,7 @@ type into the game.
Code: `crates/coa-control-proto` (the protocol: pure, no I/O), `services/coa-coordinator` (the Coordinator), `crates/coa-core/src/control` (Host and Player sides), Code: `crates/coa-control-proto` (the protocol: pure, no I/O), `services/coa-coordinator` (the Coordinator), `crates/coa-core/src/control` (Host and Player sides),
`src-tauri/src/control_cmds.rs` and `src/screens/JoinPanel.tsx` (the interface). End-to-end tests: `services/coa-control-e2e`. Deployment: [REGISTRY_DEPLOYMENT.md](REGISTRY_DEPLOYMENT.md). `src-tauri/src/control_cmds.rs` and `src/screens/JoinPanel.tsx` (the interface). End-to-end tests: `services/coa-control-e2e`. Deployment: [REGISTRY_DEPLOYMENT.md](REGISTRY_DEPLOYMENT.md).
`CONTROL_PROTOCOL_VERSION = 1`; it is independent of the Registry protocol (2) and of the portable formats. `CONTROL_PROTOCOL_VERSION = 2` (bumped in MR1.1/MR2 to require explicit `ruleset` fields in transfer and claim negotiations); it is independent of the Registry protocol (2) and of the portable formats.
## 1. Shape ## 1. Shape
@@ -148,8 +148,8 @@ its profile, and only then sends `claim_ack`; the Host marks the binding `Portab
When a player selects a portable character that exists in their Player Manager but does not yet exist on the remote realm, the Player Manager performs an automated, transactional transfer over the encrypted Noise channel: When a player selects a portable character that exists in their Player Manager but does not yet exist on the remote realm, the Player Manager performs an automated, transactional transfer over the encrypted Noise channel:
1. **Preflight Compatibility Check**: The Player Manager checks the canonical character against the target realm's advertised capabilities (Phase 7/8). If incompatible, the transfer is refused immediately before any network mutation. 1. **Preflight Compatibility Check**: The Player Manager checks the canonical character against the target realm's advertised capabilities (Phase 7/8). If incompatible, the transfer is refused immediately before any network mutation.
2. **Transfer Offer (`TransferOffer`)**: Inside the end-to-end encrypted Noise channel, the Player Manager sends `transfer_offer{transfer_id, character_id, canonical_revision, content_hash, total_size, collections}`. 2. **Transfer Offer (`TransferOffer`)**: Inside the end-to-end encrypted Noise channel, the Player Manager sends `transfer_offer{transfer_id, character_id, canonical_revision, content_hash, total_size, collections, ruleset}`.
- The Host validates the PlayerIdentity, character ownership, format revision, hash format, size limit (≤ 4 MiB, `MAX_TRANSFER_REQUEST_BYTES`), and collection counts (≤ 100,000 items). - The Host validates the PlayerIdentity, character ownership, format revision, hash format, size limit (≤ 4 MiB, `MAX_TRANSFER_REQUEST_BYTES`), collection counts (≤ 100,000 items), and ruleset matching target realm.
- If the exact revision was already committed or an active transfer session exists, the Host responds with `transfer_ready{transfer_id, accepted_offset}`. - If the exact revision was already committed or an active transfer session exists, the Host responds with `transfer_ready{transfer_id, accepted_offset}`.
3. **Payload Transfer & Chunking (`TransferChunk` / `TransferStatus`)**: 3. **Payload Transfer & Chunking (`TransferChunk` / `TransferStatus`)**:
- The Player sends the payload in bounded chunks via `transfer_chunk{transfer_id, offset, data}`. - The Player sends the payload in bounded chunks via `transfer_chunk{transfer_id, offset, data}`.
@@ -157,7 +157,8 @@ When a player selects a portable character that exists in their Player Manager b
- If a connection is interrupted, the Player can query progress via `transfer_status{transfer_id}` and resume from `accepted_offset`. - If a connection is interrupted, the Player can query progress via `transfer_status{transfer_id}` and resume from `accepted_offset`.
4. **Validation & Atomic Commit (`TransferCommit`)**: 4. **Validation & Atomic Commit (`TransferCommit`)**:
- Once all chunks arrive, the Player sends `transfer_commit{transfer_id}`. - Once all chunks arrive, the Player sends `transfer_commit{transfer_id}`.
- The Host verifies the SHA-256 content hash of the assembled payload against the offer. - The Host verifies the SHA-256 content hash of the canonical JSON against the offer.
- The Host decodes the payload and verifies that `decoded.character_id == transfer.character_id`, `decoded.ruleset == transfer.ruleset`, and `transfer.ruleset == destination_realm.ruleset`.
- The Host runs the level projection engine (e.g. projecting level 80 down to realm cap 60 via Phase-8 oracle). - The Host runs the level projection engine (e.g. projecting level 80 down to realm cap 60 via Phase-8 oracle).
- The Host imports the character into the realm's characters database, updates/creates the working copy mapping, and arms the session. - The Host imports the character into the realm's characters database, updates/creates the working copy mapping, and arms the session.
- The Host returns `transferred{character_id, local_guid, session_id}`. - The Host returns `transferred{character_id, local_guid, session_id}`.
+153
View File
@@ -0,0 +1,153 @@
# Multi-Ruleset Realms & Portable Characters: Architectural Audit
This audit evaluates the architecture to support three independent, strictly isolated gameplay rulesets:
1. **Conquest of Azeroth (`coa`)**
2. **Wildcard (`wildcard`)**
3. **Warcraft Reborn (`reborn`)**
Date: October 2026
Status: Updated for MR2 Gate (Wildcard Vertical Slice Completed)
---
## 1. Executive Summary: Baseline vs Implemented vs Planned
### 1.1 Baseline Discovered Before Implementation (v0.7.0 Master)
- `realms::Mode` defined `Coa`, `Wildcard`, and `Reborn` for local realm profiles and database switching (`acore_characters`, `acore_characters_wildcard`, `acore_characters_reborn`).
- The **Portable Characters and Public Realm Registry subsystems** were designed almost entirely around `coa`, with experimental/preliminary partial awareness of `wildcard`, and an explicit blocking error for `reborn` (`ruleset_of`: *"Portable characters are not supported on Warcraft Reborn realms yet"*).
- SQLite `character` table had `CHECK (ruleset IN ('coa', 'wildcard'))`, which hard-failed on any `reborn` row.
- SQLite `collection` table was keyed by `(profile_id, kind)` without `ruleset`, causing cross-ruleset collision.
- `Request::TransferOffer`, `PortableSessionStarted`, `PortableCheckpoint`, `OwnerAck`, `CollectionObserved`, `CollectionState`, and `CollectionAck` lacked explicit protocol-level `ruleset` fields or version negotiation.
- Collection validation used unsafe prefix checks (`kind.starts_with(ruleset)`), permitting prefix confusion attacks.
- `Ruleset::schema(kind)` contained a fallback `_ => "acore_characters"`, routing unknown database kinds to CoA.
### 1.2 Implemented in MR1, MR1.1, and MR2
- **Authoritative Ruleset Enum:** `Ruleset` (`Coa`, `Wildcard`, `Reborn`) unified across `coa-core`, `coa-registry-proto`, `coa-control-proto`, and frontend models.
- **Transactional SQLite Migration 009:** Migrates released v0.7.x databases by recreating both `collection` (composite key `profile_id, ruleset, kind`) and `character` (CHECK constraint allowing `'coa', 'wildcard', 'reborn'`) with FK toggles ensuring zero child row loss.
- **Fail-Closed Realm Backend:** Removed unsafe `unwrap_or(Ruleset::Coa)` in `LocalBackend::info()`. Unreadable, unknown, or broken realms fail closed immediately with error rather than falling back to CoA.
- **Control Protocol 2 & Strict Envelopes:**
- `CONTROL_PROTOCOL_VERSION = 2`.
- `Request::TransferOffer` requires explicit `ruleset: String`.
- `Response::Claimed` returns explicit `ruleset: String`.
- Claiming and commit verify that the claimed envelope ruleset matches the decoded payload ruleset and matches target realm ruleset.
- `HostTransfer` stores `ruleset` in SQLite; `transfer_commit` verifies that canonical JSON hash and ruleset match the offer and destination realm before writing to disk.
- **Session Protocol 3 & Ruleset Enforcement:**
- `SESSION_PROTOCOL_VERSION = 3` and `COLLECTION_PROTOCOL_VERSION = 2`.
- `SessionOffer`, `PortableSessionStarted`, `PortableCheckpoint`, and `OwnerAck` require explicit `ruleset`.
- Any mismatch between character ruleset, offer ruleset, session ruleset, or checkpoint ruleset rejects immediately with zero DB mutation and zero canonical revision advance.
- **Wildcard Collections Isolation:**
- `wildcard:appearance` and `wildcard:vanity` isolated from `coa:appearance` and `coa:vanity`.
- Cross-ruleset collection merges strictly rejected by `carried_kind_for(kind, ruleset)`.
- **Database Routing & Three-Space Isolation:**
- Canonical SQL routes through `Db::query()` and `realm_schema` to `acore_characters_wildcard` and `acore_world_wildcard`.
- Multiple characters sharing local GUIDs on distinct server IDs (`srv-1:coa`, `srv-1:wildcard`, `srv-1:reborn`) coexist with zero collision in character mappings and item mappings.
- Mutating Wildcard character state, revisions, or collections leaves CoA and Reborn states 100% byte-for-byte untouched.
- **Direct & Relay Routing for Wildcard:**
- `world_port_for_mode` dynamically determines active world port (8085 for primary CoA, 8086 for secondary Wildcard in simultaneous mode).
- Direct Ingress proxy and Relay link dynamically route to the correct realm world port.
- Direct Ingress Auth rewrite replaces internal realm list address with external mapped Wildcard port (e.g. 48086) and never advertises CoA port 8085.
### 1.3 Still Planned (Subsequent Milestones)
- **MR3 (Warcraft Reborn Vertical Slice):** Unlocking `ruleset_of` for Reborn, import/export adapters, and live verification.
- **MR4 (Multi-Realm Publication UI & Registry):** Simultaneous publication of multiple RealmIds from a single Manager host under distinct identities and keypairs.
---
## 2. Current Implementation Architecture & Historical Baseline Inventory
### 2.1 Current Implementation State (As of MR1, MR1.1, MR2, MR2.1)
- **Authoritative Ruleset Representation:**
- `crates/coa-core/src/portable/model.rs`: `enum Ruleset { Coa, Wildcard, Reborn }` (strict parsing and schema routing without fallbacks).
- `crates/coa-registry-proto/src/caps.rs`: `enum Ruleset { Coa, Wildcard, Reborn }`.
- `services/coa-registry/src/pg.rs`: `ruleset: match ruleset.as_str() { "coa" => Ruleset::Coa, "wildcard" => Ruleset::Wildcard, "reborn" => Ruleset::Reborn, ... }`.
- `src/lib/browse.ts`: `export type Ruleset = "coa" | "wildcard" | "reborn";`.
- `crates/coa-core/src/realms.rs`: `enum Mode { Coa, Wildcard, Reborn }`.
- **Wire Protocols & Ruleset Requirements:**
- **Control Protocol 2:** `CONTROL_PROTOCOL_VERSION = 2`. `Request::TransferOffer` requires explicit, non-default `ruleset: String`. `Response::Claimed` returns explicit `ruleset: String`. `HostTransfer` records ruleset.
- **Session Protocol 3:** `SESSION_PROTOCOL_VERSION = 3`. `SessionOffer`, `PortableSessionStarted`, `PortableCheckpoint`, and `OwnerAck` require explicit, mandatory `ruleset: Ruleset`.
- **Collection Protocol 2:** `COLLECTION_PROTOCOL_VERSION = 2`. `CollectionObserved`, `CollectionState`, and `CollectionAck` require explicit, mandatory `ruleset: Ruleset`.
- **Database Routing & Fail-Closed Invariants:**
- `LocalBackend::info()` and `LocalBackend::access()` strictly enforce:
$$\text{local\_id ruleset} == \text{RealmAccess.mode} == \text{Db.realm()} == \text{RealmInfo.ruleset}$$
Any mismatch or malformed/unknown ruleset suffix returns an immediate error.
- `LocalBackend::world_port()` and `crates/coa-core/src/realms::world_port_for_mode()` return fallible `Result<u16>` without silent fallbacks to 8085. If a realm is not running or not simultaneous, port resolution fails closed and disables Direct and Relay routing for that realm.
- **Canonical Storage (`portable.db`):**
- Transactional SQLite Migration 009 upgraded `character` table constraint to `CHECK (ruleset IN ('coa', 'wildcard', 'reborn'))` while preserving rows byte-for-byte.
- `collection` table is partitioned by `(profile_id, ruleset, kind)`.
- Mappings (`character_server_mapping`, `item_mapping`, `pet_mapping`, sessions) isolate distinct server IDs (`srv-X:coa`, `srv-X:wildcard`, `srv-X:reborn`).
### 2.2 Historical Baseline Inventory (Pre-Implementation State as of v0.7.0 Master)
> [!NOTE]
> The following findings reflect the legacy v0.7.0 baseline discovered before MR1/MR2 implementation and are preserved for historical reference:
- *Historical:* `Ruleset` enum in `model.rs` and `caps.rs` lacked `Reborn`.
- *Historical:* `character` table had `CHECK (ruleset IN ('coa', 'wildcard'))`, causing SQLite constraint failures on Reborn.
- *Historical:* `collection` table was keyed only by `(profile_id, kind)` without `ruleset`.
- *Historical:* `TransferOffer`, `PortableSessionStarted`, `PortableCheckpoint`, and `CollectionState` lacked explicit protocol-level `ruleset` fields.
- *Historical:* `LocalBackend::info()` had an unsafe fallback `ruleset_of(db).unwrap_or(Ruleset::Coa)`.
- *Historical:* `world_port_for_mode()` fell back to `ports.world` (8085) even when Wildcard was inactive.
- *Historical:* `Ruleset::schema(kind)` had `_ => "acore_characters"`.
### 2.3 Realm Profiles & Databases (`crates/coa-core/src/realms.rs`, `db.rs`)
| Ruleset / Mode | Realm ID | Character Database | World Database | Auth Database | Configuration Profile |
|---|---|---|---|---|---|
| **CoA** | `1` | `acore_characters` | `acore_world` | `acore_auth` | `Settings/realm-profiles/coa.json` |
| **Wildcard** | `2` | `acore_characters_wildcard` | `acore_world_wildcard` | `acore_auth` | `Settings/realm-profiles/wildcard.json` |
| **Warcraft Reborn** | `3` | `acore_characters_reborn` | `acore_world_reborn` | `acore_auth` | `Settings/realm-profiles/reborn.json` |
- **Simultaneous Startup Policy:**
- CoA + Wildcard simultaneous is supported via `secondary_world_port` and `secondary_ra_port` (CoA on primary world port 8085, Wildcard on secondary e.g. 8086).
- Warcraft Reborn simultaneous startup is **strictly unsupported** (`s.simultaneous && s.active == Mode::Reborn` returns `Error::Invalid("Simultaneous startup supports CoA and Wildcard only.")`).
- **Worldserver Capability Detection:**
- Executable inspected directly (`Core/worldserver.exe` on Windows repack, `Core/worldserver` on Linux Docker).
- Wildcard detected by byte pattern: `b"Wildcard synergy settings"`.
- Reborn detected by byte pattern: `b"Warcraft Reborn class spells are unavailable"`.
### 2.4 Public Registry Model & Multi-Realm Publication
- `crates/coa-core/src/realm_registry/settings.rs`: `RegistrySettings.realms` is a `BTreeMap<String, PublishConfig>`.
- `src/screens/PublishCard.tsx`: Uses `localId = 'srv-' + serverId`.
- **Multi-Realm Publication on One Host:**
Each published realm possesses its own distinct local realm identity (`srv-<id>:<ruleset>`), unique `RealmId` (UUIDv7), and independent Ed25519 signing key in `KeyStore`. Direct Ingress proxy and Relay links dynamically route to the respective realm's active world port.
---
## 3. Strict Isolation Invariants
The fundamental architectural invariant is:
$$\text{portable\_character.ruleset} == \text{target\_realm.ruleset}$$
On mismatch:
1. **Zero DB Mutation:** No rows written to `acore_characters*`, `item_instance`, or modules.
2. **Zero Session Creation:** No `host_session` or `owner_session` record opened or armed.
3. **Zero Mapping Creation:** No entry in `character_server_mapping`, `item_mapping`, or pet mapping.
4. **Zero Collection Merge:** No union into collections of a different ruleset.
5. **Zero Canonical Revision Change:** Canonical revision remains unchanged; reject with explicit mismatch error.
6. **No Implicit Conversion:** Never attempt conversion, level projection across rulesets, or guessing missing rulesets.
---
## 4. Execution Plan & Phasing
1. **Authoritative RulesetId Abstraction (Section 3):**
- Normalize `RulesetId` / unified enum across `coa-core`, `coa-registry-proto`, `coa-control-proto`, and TypeScript models.
- Values: `coa`, `wildcard`, `reborn`.
2. **Partitioning Collections & Canonical Storage (Sections 8, 11):**
- Add SQLite migration `009_multiruleset_collections.sql` partitioning collections by `(profile_id, ruleset, kind)` and expanding `character` table ruleset constraint to allow `'reborn'`.
- Update `Store` APIs to accept `ruleset: Ruleset` on character operations and collection operations.
3. **Registry & Multi-Realm Publication on One Host (Sections 5, 6, 26):**
- Partition published realm keys: `srv-<serverId>:<ruleset>`.
- Each published realm receives its own `RealmId`, Ed25519 key, heartbeat, status, and capabilities.
- Registry PostgreSQL migration for `reborn` ruleset check.
4. **Remote Transfer Envelope & Session Binding (Sections 14, 22):**
- Add `ruleset` to `TransferOffer`, `PortableSessionStarted`, `PortableCheckpoint`.
- Enforce 4-way equality: envelope ruleset == payload ruleset == published realm ruleset == host target DB ruleset.
5. **Wildcard Vertical Slice (Section 15):**
- End-to-end testing of Wildcard claiming, transfer, session, checkpoint, and collection partitioning.
- Verify negative cross-ruleset attack scenarios.
6. **Warcraft Reborn Audit & Vertical Slice (Sections 18, 19):**
- Complete `docs/REBORN_PORTABLE_AUDIT.md`.
- Wire Reborn adapter into the unified engine and verify vertical slice.
7. **UI Multi-Ruleset Filtering (Sections 7, 27):**
- Server browser ruleset tabs/filters (`All`, `Conquest of Azeroth`, `Wildcard`, `Warcraft Reborn`).
- Portable character picker filtered by target realm ruleset.
8. **Regression & Cross-Ruleset Attack Test Suite (Section 29):**
- Comprehensive unit and integration attack tests ensuring strict isolation.
+18 -1
View File
@@ -4,7 +4,16 @@
**Portable characters are experimental.** The feature is in active development and may contain bugs. **Portable characters are experimental.** The feature is in active development and may contain bugs.
Portable characters let you keep a saved character in the Manager and play it on compatible CoA realms. Portable characters let you keep a saved character in the Manager and play it on compatible realms (Conquest of Azeroth and Wildcard).
## Multi-Ruleset Isolation Invariant
Portable characters are strictly isolated by gameplay ruleset (`coa`, `wildcard`, `reborn`):
- A character created or claimed on a **Conquest of Azeroth** realm is a CoA character and can only ever be played on CoA realms.
- A character created or claimed on a **Wildcard** realm is a Wildcard character and can only ever be played on Wildcard realms.
- A character created or claimed on a **Warcraft Reborn** realm can only ever be played on Reborn realms.
Cross-ruleset transfers, imports, joins, sessions, and collection merges are impossible: the Manager strictly rejects any mismatched request at every protocol, session, and database boundary with zero mutation to your characters or servers.
## Make your first character portable ## Make your first character portable
@@ -45,3 +54,11 @@ A realm with a lower level cap may play your character at a lower level. Check t
Use **Saved versions** to see when progress was saved. If the Manager reports a conflict, follow its explanation before continuing. Avoid playing two copies at once, and keep normal server backups as well. Use **Saved versions** to see when progress was saved. If the Manager reports a conflict, follow its explanation before continuing. Avoid playing two copies at once, and keep normal server backups as well.
[All guides](README.md) [All guides](README.md)
## Portable access and relay
In the realm's Public list card, enable “Allow portable characters on this realm” and save. It is off until the owner opts in. Turning it off blocks new exports and imports; it does not delete saved characters. Keep the host Manager running. The control connection and game relay have separate status indicators: a connected control channel does not establish a game tunnel. Characters stay within their original ruleset (CoA, Wildcard or Warcraft Reborn); changing servers does not convert their ruleset.
Keep both Managers running. Saving resumes after reconnecting or restarting, and later logins stay monitored. Wait for saving before switching realms. Your installed servers use local preparation and recovery. Experimental limitation: an older existing copy on another host cannot yet be refreshed automatically while its worldserver runs. Returning may require host maintenance. The stale copy is blocked and your canonical character stays saved. Do not delete the character or reinstall the server to bypass this message.
Stop the server before enabling this for the first time. Saving prepares portable sessions for its next start; disabling access leaves ongoing sessions intact.
+7 -5
View File
@@ -77,7 +77,8 @@ one place, no duplicate ids). Extension payloads must match their recorded hash.
* `rollback_to` creates a **new** revision whose state equals an old one; revision numbers never decrease. * `rollback_to` creates a **new** revision whose state equals an old one; revision numbers never decrease.
* The newest `history_keep` revisions are kept (default 20, 1..=1000, configurable). The current revision is never * The newest `history_keep` revisions are kept (default 20, 1..=1000, configurable). The current revision is never
pruned. pruned.
* A character's `ruleset` (`coa` | `wildcard`) can never change. * A character's `ruleset` (`coa` | `wildcard` | `reborn`) can never change.
* The character's `content_namespace` aligns strictly with `ruleset` (`coa`, `wildcard`, or `reborn`).
## Extensions ## Extensions
@@ -87,8 +88,9 @@ that does not support an extension simply does not receive it; the canonical cop
## Collections ## Collections
Account-wide sets of numeric ids (`coa:wardrobe`, `coa:vanity`, ...), stored per profile and kind: Account-wide sets of numeric ids (`coa:appearance`, `wildcard:appearance`, `reborn:appearance`, etc.), stored per `(profile_id, ruleset, kind)`:
* partitioned strictly by ruleset: collections of different rulesets never intersect or merge;
* union only: `stored = stored U incoming`; nothing is ever removed because a realm did not return it; * union only: `stored = stored U incoming`; nothing is ever removed because a realm did not return it;
* if the union equals what is stored, **no revision is created** and the hash is unchanged; * if the union equals what is stored, **no revision is created** and the hash is unchanged;
* encoding: `[format version][count][first id][gap]...`, unsigned LEB128 varints, strictly ascending ids, 1-2 bytes per * encoding: `[format version][count][first id][gap]...`, unsigned LEB128 varints, strictly ascending ids, 1-2 bytes per
@@ -98,17 +100,17 @@ Account-wide sets of numeric ids (`coa:wardrobe`, `coa:vanity`, ...), stored per
## Store (`%LOCALAPPDATA%\CoAServerManager\portable\portable.db`) ## Store (`%LOCALAPPDATA%\CoAServerManager\portable\portable.db`)
SQLite, WAL, `synchronous=FULL`, `foreign_keys=ON`, `application_id = 0x434F4150`, forward-only migrations tracked in SQLite, WAL, `synchronous=FULL`, `foreign_keys=ON`, `application_id = 0x434F4150`, forward-only migrations tracked in
`PRAGMA user_version` (currently 3). A database from a newer Manager, or a foreign SQLite file, is refused and left untouched. `PRAGMA user_version` (migration 009 adds multi-ruleset collection partitioning and reborn character support). A database from a newer Manager, or a foreign SQLite file, is refused and left untouched.
| Table | Purpose | | Table | Purpose |
|---|---| |---|---|
| `profile` | the owner | | `profile` | the owner |
| `character` | summary row + canonical revision | | `character` | summary row + canonical revision (`ruleset IN ('coa', 'wildcard', 'reborn')`) |
| `snapshot` | `(character_id, revision)` -> compressed canonical payload + hash | | `snapshot` | `(character_id, revision)` -> compressed canonical payload + hash |
| `character_server_mapping` | `(character_id, server_id)` -> local guid; `UNIQUE(server_id, local_guid)` | | `character_server_mapping` | `(character_id, server_id)` -> local guid; `UNIQUE(server_id, local_guid)` |
| `item_mapping` | one row per mapping with a lifecycle (schema 2, see below) | | `item_mapping` | one row per mapping with a lifecycle (schema 2, see below) |
| `import_journal` | schema 3: one row per import into a realm (`prepared` / `committed` / `aborted` / `needs_attention`) with the nonce/marker and the plan; see `PORTABLE_IMPORT.md` | | `import_journal` | schema 3: one row per import into a realm (`prepared` / `committed` / `aborted` / `needs_attention`) with the nonce/marker and the plan; see `PORTABLE_IMPORT.md` |
| `collection` | per profile and kind: revision, hash, encoded set | | `collection` | per profile, ruleset, and kind: revision, hash, encoded set |
| `setting` | `history_keep` | | `setting` | `history_keep` |
## Item mapping lifecycle (schema 2) ## Item mapping lifecycle (schema 2)
Loaded 100 of 135 files, more files were not shown because too many files have changed in this diff. Show more