Further the login process

* Matchmaking login locks (created and checked only in memory for now)
* Profile reputation temporary implementation
* Profiles now no longer initialize if a user with the same username is found
* vrMovementMode in presence is now required, falls back to 'Teleport'
* Progression implementation began
* API routes: Settings, player subscriptions, reputation, progression
* cropSquare in image query is not a boolean, rather a number representing a boolean
* Hile reporting uses forms, not json
* Presence heartbeat and logout
* Socket changes: Close event listener (destroy), send message function, targets further started
This commit is contained in:
2025-03-29 23:09:40 -04:00
parent 1af0206b6a
commit 026f9c8bd8
22 changed files with 294 additions and 56 deletions

View File

@@ -6,6 +6,7 @@ import { Config } from "./config.ts";
import { AuthType, User, UserTokenFormat } from "./data/users.ts";
import UnifiedProfile, { ProfileTokenFormat } from "./data/profiles.ts";
import z from "zod";
import Matchmaking from "./data/live/base.ts";
const config = Config.getConfig();
@@ -311,6 +312,21 @@ export function AuthenticationType(type: AuthType) {
}
}
export function LoginLock(rq: express.Request<NoBody, NoBody, { LoginLock: string }>, rs: express.Response, nxt: express.NextFunction) {
log.d(`LoginLock for ${rs.locals.profile.getId()}: ${rq.body.LoginLock}`);
const matches = Matchmaking.lockMatches(rs.locals.profile, rq.body.LoginLock);
if (matches == null) {
rs.json(genericResponseFormat(true, "Login Lock failure"));
return;
} else {
if (matches) nxt();
else {
rs.json(genericResponseFormat(true, "Login Lock failure"));
return;
}
}
}
export type NoBody = Record<string | number | symbol, never>;
export * as APIUtils from "./apiutils.ts";

View File

@@ -10,9 +10,9 @@ class MatchmakingBase {
}
lockMatches(prof: Profile, lock: string) {
const maybeLock = loginLocks.get(prof.getId());
if (maybeLock) return maybeLock == lock;
else return false;
const checkLock = loginLocks.get(prof.getId());
if (checkLock) return checkLock == lock;
else return null;
}
deleteLoginLock(prof: Profile) {

View File

@@ -46,7 +46,7 @@ class PlayerPresence {
playerId: number;
statusVisibility: PlayerStatusVisibility;
deviceClass: DeviceClass;
vrMovementMode: VRMovementMode | undefined;
vrMovementMode: VRMovementMode;
roomInstance: RoomInstance | null;
lastSeen: Date;
@@ -85,9 +85,9 @@ class PlayerPresence {
roomInstance: this.roomInstance,
statusVisibility: this.statusVisibility,
deviceClass: this.deviceClass,
vrMovementMode: this.vrMovementMode ? this.vrMovementMode : undefined
vrMovementMode: this.vrMovementMode
}
return Object.assign({}, exp); // hard copy/clone
return Object.assign({}, exp); // hard clone
}
updateOffline() {

View File

@@ -0,0 +1,5 @@
export class ProfileEventsManager {
}

View File

@@ -1,35 +1,79 @@
import Logging from "@proxnet/undead-logging";
import { Config } from "../../config.ts";
import { GameConfigs } from "../config.ts";
import { ProfileContentManager } from "./profilemanagerbase.ts";
import { ProfileContentManager } from "./base/profilemanagerbase.ts";
import { Redis } from "../../db.ts";
const log = new Logging("ProfileProgression");
const serverConfig = Config.getConfig();
const config = GameConfigs.getConfig();
/**
* Level -> Required XP
*/
const requiredXpMap: Map<number, number> = new Map();
export class ProfileProgressionManager extends ProfileContentManager {
constructor() {
super();
// fill `requiredXpMap` using `config.public` values
}
async #getNextLevelRequiredXp() {
const xp = await this.getXp();
if (typeof config?.LevelProgressionMaps == 'undefined') return null;
for (const item of config?.LevelProgressionMaps) {
if (xp >= item.RequiredXp) {
#getRequiredXp(level: number) {
if (level > serverConfig.public.maxLevels) return null;
else {
const req = requiredXpMap.get(level);
return req ? req : null;
const next = config?.LevelProgressionMaps[config?.LevelProgressionMaps.indexOf(item) + 1];
if (typeof next == 'undefined') return null;
else return next.RequiredXp;
}
}
}
getLevel() {
return 30; // temporary
/**
* Set the profile's exact # of XP
* @returns The new # of XP
*/
async setXp(xp: number) {
await Redis.Database.set(Redis.buildKey(Redis.KeyGroups.Profiles.Root, this.profileId!.toString(), Redis.KeyGroups.Profiles.Xp), xp.toString());
return xp;
}
getXp() {
return 0; // temporary
/**
* Adds an integer to the profile's # of XP
* @returns The new # of XP; returns 0 if data is in error
*/
async addXp(xp: number) {
const currentXp = await this.getXp();
if (currentXp == null) return 0;
await this.setXp(currentXp + xp);
return currentXp + xp;
}
/**
* Get the player's current level
* @returns The player's level based on their current XP; returns 1 if data is in error
*/
async getLevel() {
const xp = await this.getXp();
if (xp == null) return 1; // fallback since progression data is required
if (typeof config?.LevelProgressionMaps == 'undefined') return null;
for (const item of config?.LevelProgressionMaps) {
if (xp >= item.RequiredXp) {
const current = config?.LevelProgressionMaps[config?.LevelProgressionMaps.indexOf(item)];
if (typeof current == 'undefined') return null;
else return current.Level;
}
}
}
async getXp() {
if (!this.profileIsSet()) throw this.profileNotSetError;
let data = await Redis.Database.get(Redis.buildKey(Redis.KeyGroups.Profiles.Root, this.profileId!.toString(), Redis.KeyGroups.Profiles.Xp));
if (data == null) data = (await this.setXp(0)).toString();
const parsedData = parseInt(data);
if (isNaN(parsedData)) {
log.w(`Parsed xp data for ${this.profileId} is NaN!`);
return 0; // fallback since progression data is required
} else return parsedData;
}
}

View File

@@ -0,0 +1,20 @@
import { ProfileContentManager } from "./base/profilemanagerbase.ts";
export class ProfileReputationManager extends ProfileContentManager {
async getReputation() { // async temporary
return {
AccountId: this.profileId,
Noterity: 0.0,
CheerGeneral: 0,
CheerHelpful: 0,
CheerSportsman: 0,
CheerCreative: 0,
CheerCredit: 0,
SubscriberCount: 0,
SubscribedCount: 0,
SelectedCheer: 0
};
}
}

View File

@@ -1,6 +1,6 @@
import { Redis } from "../../db.ts";
import { SettingKey } from "../content/settings.ts";
import { ProfileContentManager } from "./profilemanagerbase.ts";
import { ProfileContentManager } from "./base/profilemanagerbase.ts";
export interface Setting {
Key: string;

View File

@@ -10,9 +10,13 @@ import { z } from "zod";
import { SignalRSocketHandler } from "../socket/socket.ts";
import { ProfileSettingsManager } from "./profile/settings.ts";
import { ProfileProgressionManager } from "./profile/progression.ts";
import { ProfileReputationManager } from "./profile/reputation.ts";
import Logging from "@proxnet/undead-logging";
const config = Config.getConfig();
const log = new Logging("Profiles");
interface ProfileInitOptions {
username: string;
}
@@ -79,6 +83,11 @@ class Profile {
static async init(options?: ProfileInitOptions) {
const optionsSpecified = typeof options !== "undefined";
if (options?.username) {
const existingUser = await Profile.byName(options.username);
if (existingUser == null) return null;
}
const newId = await this.getUniqueId();
const newUsername = optionsSpecified
? options.username
@@ -143,6 +152,7 @@ class Profile {
Settings = new ProfileSettingsManager();
Progression = new ProfileProgressionManager();
Reputation = new ProfileReputationManager();
constructor(id: number) {
this.#id = id;
@@ -150,6 +160,7 @@ class Profile {
// Set IDs for all content managers
this.Settings.setProfile(this.#id);
this.Progression.setProfile(this.#id);
this.Reputation.setProfile(this.#id);
}
setInstance(instance: RoomInstance | null) {
@@ -178,11 +189,20 @@ class Profile {
async getKnownDeviceClass() {
const data = await Redis.Database.get(Redis.buildKey(Redis.KeyGroups.Profiles.Root, this.#id.toString(), Redis.KeyGroups.Profiles.DeviceClass));
if (data == null) {
log.w(`No known device class for ${this.#id}`);
return DeviceClass.Unknown;
}
const parsedData = parseInt(data);
if (isNaN(parsedData)) {
log.w(`Malformed device class for ${this.#id}`);
return DeviceClass.Unknown;
}
const DeviceClassEnum = z.nativeEnum(DeviceClass);
type DeviceClassEnum = z.infer<typeof DeviceClassEnum>
const result = DeviceClassEnum.safeParse(data);
const result = DeviceClassEnum.safeParse(parsedData);
if (result.success) return result.data;
else return DeviceClass.Unknown;
}
@@ -193,11 +213,20 @@ class Profile {
async getVRMovementMode() {
const data = await this.Settings.getSetting(SettingKey.VRMovementMode);
if (data == null) {
log.w(`No known device class for ${this.#id}`);
return VRMovementMode.Teleport;
}
const parsedData = parseInt(data);
if (isNaN(parsedData)) {
log.w(`Malformed device class for ${this.#id}`);
return VRMovementMode.Teleport;
}
const VRMovementModeEnum = z.nativeEnum(VRMovementMode);
type VRMovementModeEnum = z.infer<typeof VRMovementModeEnum>
const result = VRMovementModeEnum.safeParse(data);
const result = VRMovementModeEnum.safeParse(parsedData);
if (result.success) return result.data;
else return VRMovementMode.Teleport;
}

View File

@@ -67,6 +67,7 @@ export const KeyGroups = {
DisplayName: "displayName",
Settings: "settings",
DeviceClass: "deviceClass",
Xp: "xp",
},
Operators: "operators",
Users: {

View File

@@ -137,7 +137,6 @@ try {
if (path === '/negotiate' && req.method == 'POST')
return new Response(JSON.stringify({}));
if (!upgrade) return new Response(null, { status: 401 });
const authResult = await authenticate(req);

View File

@@ -1,10 +1,14 @@
import { APIUtils } from "../apiutils.ts";
import { route as VersionCheckRoute } from "./api/versioncheck.ts";
import { route as ConfigRoute } from "./api/config.ts";
import { route as GameConfig } from "./api/gameconfigs.ts";
import { route as PlayerReportingRoute } from "./api/PlayerReporting.ts";
import { route as MessagesRoute } from "./api/messages.ts";
import { route as RelationshipsRoute } from "./api/relationships.ts";
import { APIUtils } from "../apiutils.ts";
import { route as PlayersRoute } from "./api/players.ts"
import { route as SettingsRoute } from "./api/settings.ts";
import { route as PlayerSubscriptionsRoute } from "./api/playersubscriptions.ts";
import { route as PlayerReputationRoute } from "./api/playerReputation.ts";
export const route = APIUtils.createRouter("/api");
@@ -14,3 +18,7 @@ route.router.use(GameConfig.path, GameConfig.router);
route.router.use(PlayerReportingRoute.path, PlayerReportingRoute.router);
route.router.use(MessagesRoute.path, MessagesRoute.router);
route.router.use(RelationshipsRoute.path, RelationshipsRoute.router);
route.router.use(PlayersRoute.path, PlayersRoute.router);
route.router.use(SettingsRoute.path, SettingsRoute.router);
route.router.use(PlayerSubscriptionsRoute.path, PlayerSubscriptionsRoute.router);
route.router.use(PlayerReputationRoute.path, PlayerReputationRoute.router);

View File

@@ -18,7 +18,7 @@ const HileMessageSchema = z.object({
route.router.post('/v1/hile',
APIUtils.Authentication,
express.json(),
express.urlencoded({ extended: true }),
APIUtils.validateRequestBody(HileMessageSchema),
(rq: express.Request<NoBody, NoBody, HileMessage>, rs) => {

View File

@@ -0,0 +1,24 @@
import { APIUtils } from "../../apiutils.ts";
import UnifiedProfile from "../../data/profiles.ts";
import { AuthType } from "../../data/users.ts";
import express from "express";
export const route = APIUtils.createRouter("/playerReputation");
route.router.get('/v1/:id',
APIUtils.Authentication,
APIUtils.AuthenticationType(AuthType.Game),
(rq: express.Request<{ id: string }>, rs) => {
const unparsedPlayerId = rq.params.id;
const parsedPlayerId = parseInt(unparsedPlayerId);
if (isNaN(parsedPlayerId)) {
rs.json(APIUtils.genericResponseFormat(true, 'The player ID was invalid.'));
return;
}
rs.json(UnifiedProfile.get(parsedPlayerId).Reputation.getReputation());
}
);

View File

@@ -1,4 +1,9 @@
import Logging from "@proxnet/undead-logging";
import { APIUtils } from "../../apiutils.ts";
import express from "express";
import UnifiedProfile from "../../data/profiles.ts";
const log = new Logging("ProgressionRoute");
export const route = APIUtils.createRouter("/players");
@@ -6,12 +11,22 @@ route.router.get('/v1/progression/:id',
APIUtils.Authentication,
async (_rq, rs) => {
rs.json({
PlayerId: rs.locals.profile.getId(),
Level: await rs.locals.profile.Progression.getLevel(), // await is temporary
Xp: await rs.locals.profile.Progression.getXp()
});
async (rq: express.Request<{ id: string }>, rs) => {
const unparsedPlayerId = rq.params.id;
const parsedPlayerId = parseInt(unparsedPlayerId);
if (isNaN(parsedPlayerId)) {
rs.json(APIUtils.genericResponseFormat(true, 'The player ID was invalid.'));
return;
}
const profile = UnifiedProfile.get(parsedPlayerId);
const res = {
PlayerId: profile.getId(),
Level: await profile.Progression.getLevel(),
XP: await profile.Progression.getXp()
};
log.d(`prog res: ${JSON.stringify(res)}`);
rs.json(res);
}
);

View File

@@ -0,0 +1,11 @@
import { APIUtils } from "../../apiutils.ts";
export const route = APIUtils.createRouter("/playersubscriptions");
route.router.get('/v1/my',
(_rq, rs) => {
rs.json([]); // temporary: todo
}
);

View File

@@ -0,0 +1,22 @@
import Logging from "@proxnet/undead-logging";
import { APIUtils } from "../../apiutils.ts";
import { AuthType } from "../../data/users.ts";
const log = new Logging("SettingsRoute");
export const route = APIUtils.createRouter("/settings");
route.router.get('/v2',
APIUtils.Authentication,
APIUtils.AuthenticationType(AuthType.Game),
async (_rq, rs) => {
const settings = await rs.locals.profile.Settings.getSettings();
log.d(`settings res: ${JSON.stringify(settings)}`);
rs.json(settings);
}
);

View File

@@ -44,10 +44,11 @@ route.router.get(
}
image = await Image.decode(imageSource);
let cropSquare: boolean = false;
let cropSquare: number | null = null;
if (typeof rq.query.cropSquare == "string") {
const d = JSON.parse(rq.query.cropSquare);
if (typeof d == "boolean" && d) cropSquare = true;
const num = parseInt(rq.query.cropSquare);
if (isNaN(num)) cropSquare = null;
else cropSquare = num;
}
let width: number | null = null;
if (typeof rq.query.width == "string") {
@@ -84,7 +85,7 @@ route.router.get(
}
} else if (width) image.resize(width, Image.RESIZE_AUTO);
else if (height) image.resize(Image.RESIZE_AUTO, height);
if (cropSquare) {
if (cropSquare == 1) {
if (image.width > image.height) {
image.crop(
Math.round(image.width / 2) - Math.round(image.height / 2),
@@ -100,6 +101,7 @@ route.router.get(
);}
}
rs.setHeader('content-signature', 'key-id=KEY:RSA:p1.rec.net; data=aGk='); // enable image signature patch on client
rs.type("png").send(Buffer.from(await image.encode()));
},
);

View File

@@ -4,6 +4,9 @@ import express from "express";
import Matchmaking from "../../data/live/base.ts";
import Presence from "../../data/live/presence.ts";
import { AuthType } from "../../data/users.ts";
import Logging from "@proxnet/undead-logging";
const log = new Logging("MatchPlayerRoute");
export const route = APIUtils.createRouter('/player');
@@ -28,4 +31,33 @@ route.router.post('/login',
rs.sendStatus(200);
},
);
route.router.post('/logout',
APIUtils.Authentication,
APIUtils.AuthenticationType(AuthType.Game),
express.urlencoded({extended: true}),
APIUtils.validateRequestBody(LoginSchema),
(rq, rs) => {
Matchmaking.deleteLoginLock(rs.locals.profile);
}
)
route.router.post('/heartbeat',
APIUtils.Authentication,
APIUtils.AuthenticationType(AuthType.Game),
express.urlencoded({extended: true}),
APIUtils.validateRequestBody(LoginSchema),
APIUtils.LoginLock,
async (_rq, rs) => {
const pres = await Presence.get(rs.locals.profile);
log.d(`pres heartbeat for ${rs.locals.profile.getId()}: ${JSON.stringify(await pres.export())}`);
rs.json(await pres.export());
}
);

View File

@@ -40,7 +40,7 @@ const AuthRequestRootSchema = z.object({
pubkey: z.string(),
});
const rateLimit = new APIUtils.RateLimiter(60, 1);
const rateLimit = new APIUtils.RateLimiter(60, 2);
route.router.post("/auth",
@@ -57,9 +57,7 @@ route.router.post("/auth",
}
if (rq.body.message.server_id !== config.public.serverId) {
log.w(
`Auth request failed (serverId mismatch), config error?\n given ID: '${rq.body.message.server_id}'\n our ID: '${config.public.serverId}'`,
);
log.w(`Auth request failed (serverId mismatch), config error?\n given ID: '${rq.body.message.server_id}'\n our ID: '${config.public.serverId}'`);
authFailed("Authentication request not intended for this server.");
return;
}
@@ -114,9 +112,7 @@ route.router.post("/auth",
} else user = obj;
}
if (!(await user.addNonce(rq.body.message.nonce))) {
log.w(
`Client '${rq.body.client_id}' has already used nonce. Replay attack?`,
);
log.w(`Client '${rq.body.client_id}' has already used nonce. Replay attack?`);
authFailed("Authentication request failed.");
return;
}

View File

@@ -34,17 +34,17 @@ export class SignalRSocketHandler {
#onMessage(message: Message) {
if (message.kind == MessageKind.Protocol) {
this.#send({});
this.sendRaw({});
return;
} else {
this.#log.d(`CLIENT MESSAGE\n Type: ${message.data.type} (${SignalMessageType[message.data.type - 1]})\n ${JSON.stringify(message.data)}`);
this.#log.d(`CLIENT MESSAGE\n Type: ${message.data.type} (${SignalMessageType[message.data.type]})\n ${JSON.stringify(message.data)}`);
}
}
async #init() {
this.#log.source += this.#profile.getId().toString();
this.#log.i(`Player '${(await this.#profile.export())?.username}' (${this.#profile.getId()}) created hub socket`);
this.#log.i(`Created hub socket`);
this.#socket.addEventListener('message', message => {
try {
@@ -68,9 +68,19 @@ export class SignalRSocketHandler {
this.#log.e(`Socket error: ${err}`);
}
});
this.#socket.addEventListener('close', this.destroy(this));
}
#send(data: object) {
destroy(sock: SignalRSocketHandler) {
return () => {
sock.sendRaw({ type: 7, error: "Socket closed by server" });
sock.#socket.close();
sock.#log.i(`Closed hub socket`);
}
}
sendRaw(data: object) {
this.#socket.send(`${JSON.stringify(data)}\u001e`);
}

View File

@@ -110,7 +110,8 @@ export const SignalRMessageSchema = z.discriminatedUnion("type", [
export enum TargetResultType {
Success,
Failure
Failure,
NotATarget
}
interface TargetResultBase {
type: TargetResultType
@@ -122,4 +123,7 @@ export interface TargetResultSuccess<T = unknown> extends TargetResultBase {
export interface TargetResultFailure extends TargetResultBase {
type: TargetResultType.Failure
}
export type TargetResult = TargetResultSuccess | TargetResultFailure;
export interface TargetResultNotATarget extends TargetResultBase {
type: TargetResultType.NotATarget
}
export type TargetResult = TargetResultSuccess | TargetResultFailure | TargetResultNotATarget;