From 49d8032638bb110a6fcb9bd97ad96eb18527969d Mon Sep 17 00:00:00 2001 From: hippoz <10706925-hippoz@users.noreply.gitlab.com> Date: Sun, 30 Oct 2022 01:05:20 +0300 Subject: [PATCH] add a basic system for third-party applications to provide transparency about data collection practices --- frontend/public/global.css | 2 +- .../src/components/PresenceSidebar.svelte | 23 ++++++- frontend/src/components/Sidebar.svelte | 10 ++- .../overlays/OverlayProvider.svelte | 4 ++ .../overlays/ThirdPartyNotice.svelte | 53 ++++++++++++++++ .../src/components/overlays/UserInfo.svelte | 39 ++++++++++++ frontend/src/gateway.js | 4 +- frontend/src/stores.js | 25 +++++++- src/gateway/gatewaypresence.ts | 5 +- src/gateway/index.ts | 63 +++++++++++++++---- src/types/gatewayclientstate.d.ts | 5 +- 11 files changed, 214 insertions(+), 19 deletions(-) create mode 100644 frontend/src/components/overlays/ThirdPartyNotice.svelte create mode 100644 frontend/src/components/overlays/UserInfo.svelte diff --git a/frontend/public/global.css b/frontend/public/global.css index 33f7892..07f5b02 100644 --- a/frontend/public/global.css +++ b/frontend/public/global.css @@ -306,7 +306,7 @@ body { font-size: 1.2rem; } -.text_small { +.text-small { font-size: 0.833rem; } diff --git a/frontend/src/components/PresenceSidebar.svelte b/frontend/src/components/PresenceSidebar.svelte index 919a8fd..6191d2d 100644 --- a/frontend/src/components/PresenceSidebar.svelte +++ b/frontend/src/components/PresenceSidebar.svelte @@ -1,13 +1,31 @@ + +
User List @@ -17,6 +35,9 @@ {/each} {#if $smallViewport} diff --git a/frontend/src/components/Sidebar.svelte b/frontend/src/components/Sidebar.svelte index 148481a..e98c3fb 100644 --- a/frontend/src/components/Sidebar.svelte +++ b/frontend/src/components/Sidebar.svelte @@ -1,7 +1,8 @@ diff --git a/frontend/src/components/overlays/ThirdPartyNotice.svelte b/frontend/src/components/overlays/ThirdPartyNotice.svelte new file mode 100644 index 0000000..202c0e4 --- /dev/null +++ b/frontend/src/components/overlays/ThirdPartyNotice.svelte @@ -0,0 +1,53 @@ + + + + +
+
+
+ Third Party Services +
+ +

Certain third-party services on this server may have different data processing, data usage, and data collection policies, as well as Terms of Service or similar. Please carefully review each service in the list below. If you do not agree with any of these policies, you may be able to ask the user to opt out, or make an account deletion request to the server owner. The server owner may be able to aid you in the process of opting out.

+ + {#each $presenceStore as entry (entry.user.id)} + {#if entry.bridgesTo || entry.terms || entry.privacy} +
+ alternate_email + { entry.user.username } +
+ +
+
+ {/if} + {/each} + +
+ +
+
+
diff --git a/frontend/src/components/overlays/UserInfo.svelte b/frontend/src/components/overlays/UserInfo.svelte new file mode 100644 index 0000000..8d3726c --- /dev/null +++ b/frontend/src/components/overlays/UserInfo.svelte @@ -0,0 +1,39 @@ + + + + +
+ +
diff --git a/frontend/src/gateway.js b/frontend/src/gateway.js index 9f70491..0615b52 100644 --- a/frontend/src/gateway.js +++ b/frontend/src/gateway.js @@ -82,7 +82,9 @@ export default { case GatewayPayloadType.Hello: { this.send({ t: GatewayPayloadType.Authenticate, - d: token + d: { + token, + } }); this.heartbeatInterval = setInterval(() => { diff --git a/frontend/src/stores.js b/frontend/src/stores.js index 78f6551..3f6a695 100644 --- a/frontend/src/stores.js +++ b/frontend/src/stores.js @@ -401,6 +401,8 @@ export const OverlayType = { EditMessage: 5, Settings: 6, Prompt: 7, + UserInfo: 8, + ThirdPartyNotice: 9 }; class OverlayStore extends Store { constructor() { @@ -566,7 +568,10 @@ class PresenceStore extends Store { } else { // don't need to push the status, since we remove offline members from the presence list this.value.push({ - user: entry.user + user: entry.user, + bridgesTo: entry.bridgesTo, + privacy: entry.privacy, + terms: entry.terms }); } }); @@ -647,6 +652,23 @@ class PluginStore extends Store { } } +class ThirdPartyServicePresenceStore extends Store { + constructor() { + super(false, "ThirdPartyServicePresenceStore"); + + presenceStore.subscribe((value) => { + let hasService = false; + value.forEach(e => { + if (e.bridgesTo || e.privacy || e.terms) { + hasService = true; + return; + } + }); + this.set(hasService); + }); + } +} + export const selectedChannel = new Store({ id: -1, name: "none", creator_id: -1 }, "selectedChannel"); export const showSidebar = new Store(true, "showSidebar"); export const showPresenceSidebar = new Store(false, "showPresenceSidebar"); @@ -663,6 +685,7 @@ export const typingStore = new TypingStore(); export const presenceStore = new PresenceStore(); export const unreadStore = new UnreadStore(); export const pluginStore = new PluginStore(); +export const thirdPartyServicePresenceStore = new ThirdPartyServicePresenceStore(); export const setMessageInputEvent = new Store(null, "event:setMessageInput"); export const sendMessageAction = createAction("sendMessageAction", async ({channelId, content}) => { diff --git a/src/gateway/gatewaypresence.ts b/src/gateway/gatewaypresence.ts index 286af4c..e583f3e 100644 --- a/src/gateway/gatewaypresence.ts +++ b/src/gateway/gatewaypresence.ts @@ -3,7 +3,10 @@ import { GatewayPresenceStatus } from "./gatewaypayloadtype" export interface GatewayPresenceEntry { user: { username: string, - id: number + id: number, }, + bridgesTo?: string, + privacy?: string, + terms?: string, status: GatewayPresenceStatus } diff --git a/src/gateway/index.ts b/src/gateway/index.ts index 6399084..5c62f22 100644 --- a/src/gateway/index.ts +++ b/src/gateway/index.ts @@ -182,14 +182,29 @@ function sendPayload(ws: WebSocket, payload: GatewayPayload) { ws.send(JSON.stringify(payload)); } -function getPresenceEntryForUser(user: User, status: GatewayPresenceStatus): GatewayPresenceEntry { - return { +function getPresenceEntryForConnection(ws: WebSocket, status: GatewayPresenceStatus): GatewayPresenceEntry | null { + if (!ws.state || !ws.state.ready || !ws.state.user) { + return null; + } + + const entry: GatewayPresenceEntry = { user: { - id: user.id, - username: user.username + id: ws.state.user.id, + username: ws.state.user.username, }, status + }; + if (typeof ws.state.bridgesTo === "string") { + entry.bridgesTo = ws.state.bridgesTo; } + if (typeof ws.state.privacy === "string") { + entry.privacy = ws.state.privacy; + } + if (typeof ws.state.terms === "string") { + entry.terms = ws.state.terms; + } + + return entry; } // The initial presence entries are sent right when the user connects. @@ -204,7 +219,10 @@ function getInitialPresenceEntries(): GatewayPresenceEntry[] { const firstWs = wsList[0]; if (firstWs.state.ready && firstWs.state.user) { - entries.push(getPresenceEntryForUser(firstWs.state.user, GatewayPresenceStatus.Online)); + const entry = getPresenceEntryForConnection(firstWs, GatewayPresenceStatus.Online); + if (entry) { + entries.push(entry); + } } }); @@ -242,7 +260,8 @@ export default function(server: Server) { ready: false, lastAliveCheck: performance.now(), dispatchChannels: new Set(), - messagesSinceLastCheck: 0 + messagesSinceLastCheck: 0, + bridgesTo: undefined }; sendPayload(ws, { @@ -266,7 +285,7 @@ export default function(server: Server) { // user no longer has any sessions, update presence dispatch("*", { t: GatewayPayloadType.PresenceUpdate, - d: [getPresenceEntryForUser(ws.state.user, GatewayPresenceStatus.Offline)] + d: [getPresenceEntryForConnection(ws, GatewayPresenceStatus.Offline)] }); } } @@ -299,11 +318,28 @@ export default function(server: Server) { return closeWithError(ws, gatewayErrors.ALREADY_AUTHENTICATED); } - const token = payload.d; - if (typeof token !== "string") { - return closeWithBadPayload(ws, "d: expected string"); + const authData = payload.d; + if (typeof authData !== "object") { + return closeWithBadPayload(ws, "d: expected object"); } - const user = await decodeTokenOrNull(token); + + if (typeof authData.token !== "string") { + return closeWithBadPayload(ws, "d: invalid field 'token'"); + } + + if (typeof authData.bridgesTo !== "undefined" && typeof authData.bridgesTo !== "string" && authData.bridgesTo.length > 40) { + return closeWithBadPayload(ws, "d: invalid field 'bridgesTo'"); + } + + if (typeof authData.privacy !== "undefined" && typeof authData.privacy !== "string" && authData.privacy.length > 200) { + return closeWithBadPayload(ws, "d: invalid field 'privacy'"); + } + + if (typeof authData.terms !== "undefined" && typeof authData.terms !== "string" && authData.terms.length > 200) { + return closeWithBadPayload(ws, "d: invalid field 'terms'"); + } + + const user = await decodeTokenOrNull(authData.token); if (!user) { return closeWithError(ws, gatewayErrors.BAD_AUTH); } @@ -332,12 +368,15 @@ export default function(server: Server) { }); ws.state.user = user; + ws.state.bridgesTo = authData.bridgesTo; + ws.state.privacy = authData.privacy; + ws.state.terms = authData.terms; // first session, notify others that we are online if (sessions.length === 1) { dispatch("*", { t: GatewayPayloadType.PresenceUpdate, - d: [getPresenceEntryForUser(ws.state.user, GatewayPresenceStatus.Online)] + d: [getPresenceEntryForConnection(ws, GatewayPresenceStatus.Online)] }); } diff --git a/src/types/gatewayclientstate.d.ts b/src/types/gatewayclientstate.d.ts index 465f58b..4fc8d76 100644 --- a/src/types/gatewayclientstate.d.ts +++ b/src/types/gatewayclientstate.d.ts @@ -4,5 +4,8 @@ interface GatewayClientState { alive: boolean, lastAliveCheck: number, dispatchChannels: Set, - messagesSinceLastCheck: number + messagesSinceLastCheck: number, + bridgesTo?: string + privacy?: string, + terms?: string, }