mirror of
https://github.com/Corfirean/coa-server-manager.git
synced 2026-11-21 19:25:56 +00:00
Restore remote portable progress and resilient relay connections
This commit is contained in:
1 parent
9e9778af74
commit
b61a186470
27 files changed
+2579
-145
No files matched your search
@@ -65,10 +65,16 @@ 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) {
|
||||
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()))
|
||||
Err(Error::Invalid(
|
||||
"The realm owner has disabled portable characters.".into(),
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -116,6 +122,38 @@ impl 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> {
|
||||
let cfg = settings::load(&self.settings_dir)?.realms.remove(local_id);
|
||||
let access = self.access(local_id)?;
|
||||
@@ -310,6 +348,23 @@ impl RealmBackend for LocalBackend {
|
||||
.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>() {
|
||||
@@ -346,20 +401,560 @@ mod tests {
|
||||
#[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 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,
|
||||
});
|
||||
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"));
|
||||
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"));
|
||||
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]
|
||||
@@ -414,6 +1009,25 @@ mod tests {
|
||||
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);
|
||||
|
||||
|
||||
@@ -303,7 +303,21 @@ fn attempt_route_discovery(
|
||||
let local_auth = std::env::var("COA_OVERRIDE_LOCAL_AUTH_PORT")
|
||||
.ok()
|
||||
.and_then(|p| p.parse().ok())
|
||||
.unwrap_or(coa_control_proto::relay::LOCAL_AUTH_PORT);
|
||||
.map(Ok)
|
||||
.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()
|
||||
.and_then(|p| p.parse().ok())
|
||||
|
||||
@@ -36,6 +36,7 @@ pub struct HostControl {
|
||||
struct Running {
|
||||
realm_id: RealmId,
|
||||
url: String,
|
||||
ports: Option<(u16, u16)>,
|
||||
link: HostLink,
|
||||
#[allow(dead_code)]
|
||||
relay_link: Option<Arc<crate::control::relay_link::RelayLink>>,
|
||||
@@ -84,7 +85,7 @@ impl HostControl {
|
||||
running.retain(|id, r| {
|
||||
wanted
|
||||
.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 {
|
||||
if running.contains_key(&local_id) {
|
||||
@@ -96,15 +97,17 @@ impl HostControl {
|
||||
store.clone(),
|
||||
backend.clone(),
|
||||
));
|
||||
let relay_link = match service.local_world_port() {
|
||||
Ok(world_port) => {
|
||||
let ports = service.local_auth_port().ok().zip(service.local_world_port().ok());
|
||||
let relay_link = match ports {
|
||||
Some((auth_port, world_port)) => {
|
||||
crate::control::transport::relay_url(&base, "/relay/v1/host").map(
|
||||
|r_url| {
|
||||
let rl =
|
||||
crate::control::relay_link::RelayLink::start_with_ports(
|
||||
crate::control::relay_link::RelayLink::start_with_local_ports(
|
||||
r_url,
|
||||
realm_id,
|
||||
key.clone(),
|
||||
auth_port,
|
||||
Some(world_port),
|
||||
);
|
||||
service.set_relay(rl.clone());
|
||||
@@ -112,8 +115,8 @@ impl HostControl {
|
||||
},
|
||||
)
|
||||
}
|
||||
Err(e) => {
|
||||
eprintln!("Relay link unavailable for {local_id}: cannot resolve world port: {e}");
|
||||
None => {
|
||||
tracing::warn!(%local_id, "relay is waiting for valid local auth and world ports");
|
||||
None
|
||||
}
|
||||
};
|
||||
@@ -129,6 +132,7 @@ impl HostControl {
|
||||
Running {
|
||||
realm_id,
|
||||
url,
|
||||
ports,
|
||||
link,
|
||||
relay_link,
|
||||
direct_route,
|
||||
|
||||
@@ -20,6 +20,8 @@ use super::store::{AccountKind, ControlStore};
|
||||
use super::transport::{self, LinkError};
|
||||
use crate::{Error, Result};
|
||||
|
||||
mod portable_sync;
|
||||
|
||||
/// Where and as whom to reach a realm.
|
||||
#[derive(Clone, Debug)]
|
||||
pub struct RealmTarget {
|
||||
@@ -412,9 +414,11 @@ impl PlayerControl {
|
||||
}
|
||||
|
||||
/// 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,
|
||||
ch: &mut PlayerChannel,
|
||||
transfer_id: Uuid,
|
||||
owned_session: bool,
|
||||
character_id: Uuid,
|
||||
ruleset: &str,
|
||||
canonical_revision: u64,
|
||||
@@ -422,16 +426,27 @@ impl PlayerControl {
|
||||
content_hash: [u8; 32],
|
||||
collections: BTreeMap<String, Vec<u32>>,
|
||||
) -> R<RemoteTransferOutcome> {
|
||||
let transfer_id = Uuid::now_v7();
|
||||
let content_hash_str = hex::encode(content_hash);
|
||||
let offer = Request::TransferOffer {
|
||||
transfer_id,
|
||||
character_id,
|
||||
ruleset: ruleset.to_string(),
|
||||
canonical_revision,
|
||||
content_hash: content_hash_str.clone(),
|
||||
total_size: payload.len(),
|
||||
collections,
|
||||
let offer = if owned_session {
|
||||
Request::OwnedTransferOffer {
|
||||
transfer_id,
|
||||
character_id,
|
||||
ruleset: ruleset.to_string(),
|
||||
canonical_revision,
|
||||
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 mut offset = match r {
|
||||
@@ -456,7 +471,21 @@ impl PlayerControl {
|
||||
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(
|
||||
"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));
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -13,6 +13,9 @@ use super::identity::PlayerIdentity;
|
||||
use super::transport::{self, LinkError, Ws};
|
||||
|
||||
pub struct PlayerChannel {
|
||||
pub(crate) realm_id: RealmId,
|
||||
pub(crate) realm_key: VerifyingKey,
|
||||
pub(crate) coordinator: String,
|
||||
ws: Ws,
|
||||
channel: Channel,
|
||||
conn: u32,
|
||||
@@ -35,7 +38,11 @@ impl PlayerChannel {
|
||||
Duration::from_millis(500),
|
||||
)?;
|
||||
let nonce = match transport::next_frame(&mut ws, STEP)? {
|
||||
Frame::Challenge { protocol, nonce } if protocol == coord::COORDINATOR_PROTOCOL_VERSION => nonce,
|
||||
Frame::Challenge { protocol, nonce }
|
||||
if protocol == coord::COORDINATOR_PROTOCOL_VERSION =>
|
||||
{
|
||||
nonce
|
||||
}
|
||||
_ => return Err(LinkError::Protocol("a challenge was expected".into())),
|
||||
};
|
||||
transport::send_text(
|
||||
@@ -67,7 +74,14 @@ impl PlayerChannel {
|
||||
{
|
||||
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 {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
//! Outbound Host <-> Game Relay tunnel link (Phase 13).
|
||||
//! 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::io::{Read, Write};
|
||||
@@ -79,6 +79,22 @@ impl RelayLink {
|
||||
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 status = Arc::new(Mutex::new(RelayStatus::default()));
|
||||
@@ -88,7 +104,18 @@ impl RelayLink {
|
||||
let st = status.clone();
|
||||
let join = std::thread::Builder::new()
|
||||
.name("control-relay-host".into())
|
||||
.spawn(move || run(&url, realm_id, &key, alloc_rx, &s, &st, local_world_port))
|
||||
.spawn(move || {
|
||||
run(
|
||||
&url,
|
||||
realm_id,
|
||||
&key,
|
||||
alloc_rx,
|
||||
&s,
|
||||
&st,
|
||||
local_auth_port,
|
||||
local_world_port,
|
||||
)
|
||||
})
|
||||
.ok();
|
||||
|
||||
Arc::new(RelayLink {
|
||||
@@ -136,12 +163,22 @@ fn run(
|
||||
)>,
|
||||
stop: &AtomicBool,
|
||||
status: &Mutex<RelayStatus>,
|
||||
local_auth_port: u16,
|
||||
local_world_port: Option<u16>,
|
||||
) {
|
||||
let mut failures = 0u32;
|
||||
while !stop.load(Ordering::SeqCst) {
|
||||
let began = Instant::now();
|
||||
let result = session(url, realm, key, &alloc_rx, stop, status, local_world_port);
|
||||
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");
|
||||
}
|
||||
@@ -176,6 +213,15 @@ fn run(
|
||||
|
||||
struct StreamWorker {
|
||||
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(
|
||||
@@ -189,6 +235,7 @@ fn session(
|
||||
)>,
|
||||
stop: &AtomicBool,
|
||||
status: &Mutex<RelayStatus>,
|
||||
local_auth_port: u16,
|
||||
local_world_port: Option<u16>,
|
||||
) -> Result<(), LinkError> {
|
||||
let mut ws = transport::connect(url, POLL)?;
|
||||
@@ -257,6 +304,7 @@ fn session(
|
||||
let (ws_out_tx, ws_out_rx) = channel::<TunnelMsg>();
|
||||
|
||||
let mut last_ping = Instant::now();
|
||||
let mut last_pong = Instant::now();
|
||||
|
||||
while !stop.load(Ordering::SeqCst) {
|
||||
// Drain pending allocation requests
|
||||
@@ -277,10 +325,14 @@ fn session(
|
||||
}
|
||||
|
||||
// Keepalive
|
||||
if last_pong.elapsed() > Duration::from_secs(90) {
|
||||
return Err(LinkError::Timeout);
|
||||
}
|
||||
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(),
|
||||
));
|
||||
))
|
||||
.map_err(|error| LinkError::Io(error.to_string()))?;
|
||||
last_ping = Instant::now();
|
||||
}
|
||||
|
||||
@@ -321,7 +373,7 @@ fn session(
|
||||
} => {
|
||||
// Strictly predefined local targets: Auth (3724) or World (8085 or bound realm world port)
|
||||
let local_port = match target {
|
||||
RelayTarget::Auth => target.local_port(),
|
||||
RelayTarget::Auth => local_auth_port,
|
||||
RelayTarget::World => match local_world_port {
|
||||
Some(p) => p,
|
||||
None => {
|
||||
@@ -341,7 +393,13 @@ fn session(
|
||||
|
||||
// Spawn worker for this stream
|
||||
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
|
||||
let ok_msg = TunnelMsg::ConnectOk { stream_id };
|
||||
@@ -367,7 +425,8 @@ fn session(
|
||||
}
|
||||
}
|
||||
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 });
|
||||
}
|
||||
set_status(status, |s| s.active_streams = streams.len());
|
||||
@@ -378,7 +437,9 @@ fn session(
|
||||
}
|
||||
set_status(status, |s| s.active_streams = streams.len());
|
||||
}
|
||||
TunnelMsg::Pong => {}
|
||||
TunnelMsg::Pong => {
|
||||
last_pong = Instant::now();
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
@@ -460,3 +521,105 @@ fn spawn_local_tcp_bridge(
|
||||
})
|
||||
.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,
|
||||
});
|
||||
assert_eq!(peer.read(&mut [0u8; 1]).unwrap(), 0);
|
||||
}
|
||||
}
|
||||
@@ -20,6 +20,20 @@ use uuid::Uuid;
|
||||
use super::store::{AccountKind, ClaimState, ControlStore, HostTransfer, TransferState};
|
||||
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)]
|
||||
pub struct RealmInfo {
|
||||
/// Create accounts for joining players (the default). When false the realm only links accounts that exist.
|
||||
@@ -64,6 +78,7 @@ pub struct ClaimExport {
|
||||
|
||||
#[derive(Clone, Debug)]
|
||||
pub struct RemoteImportParams {
|
||||
pub session_id: Uuid,
|
||||
pub character_id: Uuid,
|
||||
pub revision: u64,
|
||||
pub payload: Vec<u8>,
|
||||
@@ -89,6 +104,30 @@ pub enum PreflightVerdict {
|
||||
|
||||
/// The realm itself: its login database, its console and the portable engine.
|
||||
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 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>>;
|
||||
@@ -121,6 +160,9 @@ pub trait RealmBackend: Send + Sync {
|
||||
params: RemoteImportParams,
|
||||
) -> 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>;
|
||||
}
|
||||
|
||||
@@ -148,7 +190,7 @@ impl Session {
|
||||
}
|
||||
|
||||
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_WINDOW: Duration = Duration::from_secs(600);
|
||||
|
||||
@@ -222,6 +264,10 @@ impl HostService {
|
||||
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)
|
||||
}
|
||||
@@ -246,7 +292,12 @@ impl HostService {
|
||||
public_key: &str,
|
||||
request: Request,
|
||||
) -> Response {
|
||||
if matches!(request, Request::TransferChunk { .. }) {
|
||||
if matches!(
|
||||
request,
|
||||
Request::TransferChunk { .. }
|
||||
| Request::SessionRead { .. }
|
||||
| Request::SessionAck { .. }
|
||||
) {
|
||||
session.transfer_chunks += 1;
|
||||
if session.transfer_chunks > MAX_TRANSFER_CHUNKS_PER_SESSION {
|
||||
return err(
|
||||
@@ -325,6 +376,26 @@ impl HostService {
|
||||
content_hash,
|
||||
total_size,
|
||||
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 {
|
||||
transfer_id,
|
||||
@@ -337,6 +408,32 @@ impl HostService {
|
||||
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 } => {
|
||||
self.allocate_relay(session, player, &player_id)
|
||||
}
|
||||
@@ -742,6 +839,7 @@ impl HostService {
|
||||
content_hash: String,
|
||||
total_size: usize,
|
||||
collections: BTreeMap<String, Vec<u32>>,
|
||||
owned_session: bool,
|
||||
) -> Response {
|
||||
let Ok(_guard) = self.write.lock() else {
|
||||
return err(AppError::Unavailable, "Busy.");
|
||||
@@ -792,6 +890,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
|
||||
match self.backend.presence(&self.local_id, m.account_id) {
|
||||
Ok(p) if p.account_online && p.online_characters > 0 => {
|
||||
@@ -819,30 +952,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
|
||||
if let Ok(Some(cur)) = self
|
||||
.store
|
||||
@@ -1099,6 +1208,7 @@ impl HostService {
|
||||
};
|
||||
|
||||
let params = RemoteImportParams {
|
||||
session_id: t.transfer_id,
|
||||
character_id: t.character_id,
|
||||
revision: t.revision,
|
||||
payload,
|
||||
@@ -2258,6 +2368,82 @@ 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]
|
||||
fn wrong_player_identity_cannot_overwrite_another_players_realm_copy() {
|
||||
let (_realm, s, p, _acc) = claimed_setup();
|
||||
|
||||
@@ -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),
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -72,6 +72,13 @@ CREATE TABLE IF NOT EXISTS host_transfer(
|
||||
updated_at TEXT NOT NULL
|
||||
);
|
||||
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 {
|
||||
@@ -177,6 +184,15 @@ pub struct PlayerRealm {
|
||||
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 {
|
||||
conn: Connection,
|
||||
}
|
||||
@@ -186,6 +202,66 @@ fn uuid(s: String) -> Result<Uuid> {
|
||||
}
|
||||
|
||||
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> {
|
||||
std::fs::create_dir_all(dir)?;
|
||||
let conn = Connection::open(dir.join("control.sqlite")).map_err(db)?;
|
||||
@@ -574,6 +650,43 @@ fn row_transfer(r: &rusqlite::Row<'_>) -> rusqlite::Result<Result<HostTransfer>>
|
||||
mod tests {
|
||||
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]
|
||||
fn a_player_owns_one_account_per_realm_and_an_account_one_player() {
|
||||
let s = ControlStore::open_in_memory().unwrap();
|
||||
|
||||
Reference in new issue
Block a user