feat: link discord account to existing account

This commit is contained in:
sam 2024-11-03 13:53:16 +01:00
parent c4cb08cdc1
commit 201c56c3dd
Signed by: sam
GPG key ID: B4EF20DDE721CAA1
12 changed files with 333 additions and 14 deletions

View file

@ -1,5 +1,6 @@
using System.Web; using System.Web;
using Foxnouns.Backend.Database; using Foxnouns.Backend.Database;
using Foxnouns.Backend.Database.Models;
using Foxnouns.Backend.Extensions; using Foxnouns.Backend.Extensions;
using Foxnouns.Backend.Middleware; using Foxnouns.Backend.Middleware;
using Foxnouns.Backend.Services; using Foxnouns.Backend.Services;
@ -50,6 +51,15 @@ public class AuthController(
Instant ExpiresAt Instant ExpiresAt
); );
public record SingleUrlResponse(string Url);
public record AddOauthAccountResponse(
Snowflake Id,
AuthType Type,
string RemoteId,
string? RemoteUsername
);
public record OauthRegisterRequest(string Ticket, string Username); public record OauthRegisterRequest(string Ticket, string Username);
public record CallbackRequest(string Code, string State); public record CallbackRequest(string Code, string State);

View file

@ -1,6 +1,10 @@
using System.Net;
using System.Web;
using EntityFramework.Exceptions.Common;
using Foxnouns.Backend.Database; using Foxnouns.Backend.Database;
using Foxnouns.Backend.Database.Models; using Foxnouns.Backend.Database.Models;
using Foxnouns.Backend.Extensions; using Foxnouns.Backend.Extensions;
using Foxnouns.Backend.Middleware;
using Foxnouns.Backend.Services; using Foxnouns.Backend.Services;
using Foxnouns.Backend.Services.Auth; using Foxnouns.Backend.Services.Auth;
using Foxnouns.Backend.Utils; using Foxnouns.Backend.Utils;
@ -94,6 +98,87 @@ public class DiscordAuthController(
return Ok(await authService.GenerateUserTokenAsync(user)); return Ok(await authService.GenerateUserTokenAsync(user));
} }
[HttpGet("add-account")]
[Authorize("*")]
public async Task<IActionResult> AddDiscordAccountAsync()
{
CheckRequirements();
var existingAccounts = await db
.AuthMethods.Where(m => m.UserId == CurrentUser!.Id && m.AuthType == AuthType.Discord)
.CountAsync();
if (existingAccounts > AuthUtils.MaxAuthMethodsPerType)
{
throw new ApiError.BadRequest(
"Too many linked Discord accounts, maximum of 3 per account."
);
}
var state = HttpUtility.UrlEncode(
await keyCacheService.GenerateAddExtraAccountStateAsync(
AuthType.Discord,
CurrentUser!.Id
)
);
var url =
$"https://discord.com/oauth2/authorize?response_type=code"
+ $"&client_id={config.DiscordAuth.ClientId}&scope=identify"
+ $"&prompt=none&state={state}"
+ $"&redirect_uri={HttpUtility.UrlEncode($"{config.BaseUrl}/auth/callback/discord")}";
return Ok(new AuthController.SingleUrlResponse(url));
}
[HttpPost("add-account/callback")]
[Authorize("*")]
public async Task<IActionResult> AddAccountCallbackAsync(
[FromBody] AuthController.CallbackRequest req
)
{
CheckRequirements();
var accountState = await keyCacheService.GetAddExtraAccountStateAsync(req.State);
if (
accountState is not { AuthType: AuthType.Discord }
|| accountState.UserId != CurrentUser!.Id
)
throw new ApiError.BadRequest("Invalid state", "state", req.State);
var remoteUser = await remoteAuthService.RequestDiscordTokenAsync(req.Code);
try
{
var authMethod = await authService.AddAuthMethodAsync(
CurrentUser.Id,
AuthType.Discord,
remoteUser.Id,
remoteUser.Username
);
_logger.Debug(
"Added new Discord auth method {AuthMethodId} to user {UserId}",
authMethod.Id,
CurrentUser.Id
);
return Ok(
new AuthController.AddOauthAccountResponse(
authMethod.Id,
AuthType.Discord,
authMethod.RemoteId,
authMethod.RemoteUsername
)
);
}
catch (UniqueConstraintException)
{
throw new ApiError(
"That account is already linked.",
HttpStatusCode.BadRequest,
ErrorCode.AccountAlreadyLinked
);
}
}
private void CheckRequirements() private void CheckRequirements()
{ {
if (!config.DiscordAuth.Enabled) if (!config.DiscordAuth.Enabled)

View file

@ -147,6 +147,7 @@ public enum ErrorCode
GenericApiError, GenericApiError,
UserNotFound, UserNotFound,
MemberNotFound, MemberNotFound,
AccountAlreadyLinked,
} }
public class ValidationError public class ValidationError

View file

@ -1,4 +1,5 @@
using Foxnouns.Backend.Database; using Foxnouns.Backend.Database;
using Foxnouns.Backend.Database.Models;
using Foxnouns.Backend.Services; using Foxnouns.Backend.Services;
using Foxnouns.Backend.Utils; using Foxnouns.Backend.Utils;
using Newtonsoft.Json; using Newtonsoft.Json;
@ -57,9 +58,39 @@ public static class KeyCacheExtensions
delete: true, delete: true,
ct ct
); );
public static async Task<string> GenerateAddExtraAccountStateAsync(
this KeyCacheService keyCacheService,
AuthType authType,
Snowflake userId,
CancellationToken ct = default
)
{
var state = AuthUtils.RandomToken();
await keyCacheService.SetKeyAsync(
$"add_account:{state}",
new AddExtraAccountState(authType, userId),
Duration.FromDays(1),
ct
);
return state;
}
public static async Task<AddExtraAccountState?> GetAddExtraAccountStateAsync(
this KeyCacheService keyCacheService,
string state,
CancellationToken ct = default
) =>
await keyCacheService.GetKeyAsync<AddExtraAccountState>(
$"add_account:{state}",
delete: true,
ct
);
} }
public record RegisterEmailState( public record RegisterEmailState(
string Email, string Email,
[property: JsonProperty(NullValueHandling = NullValueHandling.Ignore)] Snowflake? ExistingUserId [property: JsonProperty(NullValueHandling = NullValueHandling.Ignore)] Snowflake? ExistingUserId
); );
public record AddExtraAccountState(AuthType AuthType, Snowflake UserId);

View file

@ -72,8 +72,9 @@ public class UserRendererService(
a.Id, a.Id,
a.AuthType, a.AuthType,
a.RemoteId, a.RemoteId,
a.RemoteUsername, a.FediverseApplication != null
a.FediverseApplication?.Domain ? $"@{a.RemoteUsername}@{a.FediverseApplication.Domain}"
: a.RemoteUsername
)) ))
: null, : null,
tokenHidden ? user.ListHidden : null, tokenHidden ? user.ListHidden : null,
@ -130,9 +131,7 @@ public class UserRendererService(
[property: JsonConverter(typeof(ScreamingSnakeCaseEnumConverter))] AuthType Type, [property: JsonConverter(typeof(ScreamingSnakeCaseEnumConverter))] AuthType Type,
string RemoteId, string RemoteId,
[property: JsonProperty(NullValueHandling = NullValueHandling.Ignore)] [property: JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
string? RemoteUsername, string? RemoteUsername
[property: JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
string? FediverseInstance
); );
public record PartialUser( public record PartialUser(

View file

@ -140,6 +140,8 @@ export const errorCodeDesc = (t: TFunction, code: ErrorCode) => {
return t("error.errors.member-not-found"); return t("error.errors.member-not-found");
case ErrorCode.UserNotFound: case ErrorCode.UserNotFound:
return t("error.errors.user-not-found"); return t("error.errors.user-not-found");
case ErrorCode.AccountAlreadyLinked:
return t("error.errors.account-already-linked");
} }
return t("error.errors.generic-error"); return t("error.errors.generic-error");

View file

@ -16,6 +16,7 @@ export enum ErrorCode {
GenericApiError = "GENERIC_API_ERROR", GenericApiError = "GENERIC_API_ERROR",
UserNotFound = "USER_NOT_FOUND", UserNotFound = "USER_NOT_FOUND",
MemberNotFound = "MEMBER_NOT_FOUND", MemberNotFound = "MEMBER_NOT_FOUND",
AccountAlreadyLinked = "ACCOUNT_ALREADY_LINKED",
} }
export type ValidationError = { export type ValidationError = {

View file

@ -71,7 +71,6 @@ export type AuthMethod = {
type: "DISCORD" | "GOOGLE" | "TUMBLR" | "FEDIVERSE" | "EMAIL"; type: "DISCORD" | "GOOGLE" | "TUMBLR" | "FEDIVERSE" | "EMAIL";
remote_id: string; remote_id: string;
remote_username?: string; remote_username?: string;
fediverse_instance?: string;
}; };
export type CustomPreference = { export type CustomPreference = {

View file

@ -5,8 +5,8 @@ import {
LoaderFunctionArgs, LoaderFunctionArgs,
MetaFunction, MetaFunction,
} from "@remix-run/node"; } from "@remix-run/node";
import { type ApiError, ErrorCode, firstErrorFor } from "~/lib/api/error"; import { type ApiError, ErrorCode } from "~/lib/api/error";
import serverRequest, { writeCookie } from "~/lib/request.server"; import serverRequest, { getToken, writeCookie } from "~/lib/request.server";
import { AuthResponse, CallbackResponse } from "~/lib/api/auth"; import { AuthResponse, CallbackResponse } from "~/lib/api/auth";
import { import {
Form as RemixForm, Form as RemixForm,
@ -17,12 +17,13 @@ import {
useNavigate, useNavigate,
} from "@remix-run/react"; } from "@remix-run/react";
import { Trans, useTranslation } from "react-i18next"; import { Trans, useTranslation } from "react-i18next";
import { Form, Button, Alert } from "react-bootstrap"; import { Form, Button } from "react-bootstrap";
import ErrorAlert from "~/components/ErrorAlert";
import i18n from "~/i18next.server"; import i18n from "~/i18next.server";
import { tokenCookieName } from "~/lib/utils"; import { tokenCookieName } from "~/lib/utils";
import { useEffect } from "react"; import { useEffect } from "react";
import RegisterError from "~/components/RegisterError"; import RegisterError from "~/components/RegisterError";
import { AuthMethod } from "~/lib/api/user";
import { errorCodeDesc } from "~/components/ErrorAlert";
export const meta: MetaFunction<typeof loader> = ({ data }) => { export const meta: MetaFunction<typeof loader> = ({ data }) => {
return [{ title: `${data?.meta.title || "Log in"} • pronouns.cc` }]; return [{ title: `${data?.meta.title || "Log in"} • pronouns.cc` }];
@ -39,9 +40,43 @@ export const loader = async ({ request }: LoaderFunctionArgs) => {
const code = url.searchParams.get("code"); const code = url.searchParams.get("code");
const state = url.searchParams.get("state"); const state = url.searchParams.get("state");
const token = getToken(request);
if (!code || !state) if (!code || !state)
throw { status: 400, code: ErrorCode.BadRequest, message: "Missing code or state" } as ApiError; throw { status: 400, code: ErrorCode.BadRequest, message: "Missing code or state" } as ApiError;
if (token) {
try {
const resp = await serverRequest<AuthMethod>("POST", "/auth/discord/add-account/callback", {
body: { code, state },
token,
isInternal: true,
});
return json({
isLinkRequest: true,
meta: { title: t("log-in.callback.title.discord-link") },
error: null,
hasAccount: false,
user: null,
ticket: null,
remoteUser: null,
newAuthMethod: resp,
});
} catch (e) {
return json({
isLinkRequest: true,
meta: { title: t("log-in.callback.title.discord-link") },
error: e as ApiError,
hasAccount: false,
user: null,
ticket: null,
remoteUser: null,
newAuthMethod: null,
});
}
}
const resp = await serverRequest<CallbackResponse>("POST", "/auth/discord/callback", { const resp = await serverRequest<CallbackResponse>("POST", "/auth/discord/callback", {
body: { code, state }, body: { code, state },
isInternal: true, isInternal: true,
@ -50,11 +85,14 @@ export const loader = async ({ request }: LoaderFunctionArgs) => {
if (resp.has_account) { if (resp.has_account) {
return json( return json(
{ {
isLinkRequest: false,
meta: { title: t("log-in.callback.title.discord-success") }, meta: { title: t("log-in.callback.title.discord-success") },
error: null,
hasAccount: true, hasAccount: true,
user: resp.user!, user: resp.user!,
ticket: null, ticket: null,
remoteUser: null, remoteUser: null,
newAuthMethod: null,
}, },
{ {
headers: { headers: {
@ -65,11 +103,14 @@ export const loader = async ({ request }: LoaderFunctionArgs) => {
} }
return json({ return json({
isLinkRequest: false,
meta: { title: t("log-in.callback.title.discord-register") }, meta: { title: t("log-in.callback.title.discord-register") },
error: null,
hasAccount: false, hasAccount: false,
user: null, user: null,
ticket: resp.ticket!, ticket: resp.ticket!,
remoteUser: resp.remote_username!, remoteUser: resp.remote_username!,
newAuthMethod: null,
}); });
}; };
@ -122,6 +163,30 @@ export default function DiscordCallbackPage() {
// eslint-disable-next-line react-hooks/exhaustive-deps // eslint-disable-next-line react-hooks/exhaustive-deps
}, []); }, []);
if (data.isLinkRequest) {
if (data.error) {
return (
<>
<h1>{t("log-in.callback.link-error")}</h1>
<p>{errorCodeDesc(t, data.error.code)}</p>
</>
);
}
const authMethod = data.newAuthMethod!;
return (
<>
<h1>{t("log-in.callback.discord-link-success")}</h1>
<p>
{t("log-in.callback.discord-link-success-hint", {
username: authMethod.remote_username ?? authMethod.remote_id,
})}
</p>
</>
);
}
if (data.hasAccount) { if (data.hasAccount) {
const username = data.user!.username; const username = data.user!.username;

View file

@ -23,7 +23,13 @@ export default function AuthSettings() {
const { urls } = useLoaderData<typeof loader>(); const { urls } = useLoaderData<typeof loader>();
const { user } = useRouteLoaderData<typeof settingsLoader>("routes/settings")!; const { user } = useRouteLoaderData<typeof settingsLoader>("routes/settings")!;
return <div className="px-md-5">{urls.email_enabled && <EmailSettings user={user} />}</div>; return (
<div className="px-md-5">
{urls.email_enabled && <EmailSettings user={user} />}
{urls.discord && <DiscordSettings user={user} />}
<FediverseSettings user={user} />
</div>
);
} }
function EmailSettings({ user }: { user: MeUser }) { function EmailSettings({ user }: { user: MeUser }) {
@ -75,3 +81,86 @@ function EmailRow({ email, disabled }: { email: AuthMethod; disabled: boolean })
</ListGroup.Item> </ListGroup.Item>
); );
} }
function DiscordSettings({ user }: { user: MeUser }) {
const { t } = useTranslation();
const oneAuthMethod = user.auth_methods.length === 1;
const discordAccounts = user.auth_methods.filter((m) => m.type === "DISCORD");
return (
<>
<h3>{t("settings.auth.discord-accounts")}</h3>
{discordAccounts.length > 0 && (
<>
<ListGroup className="pt-2 pb-3">
{discordAccounts.map((a) => (
<NonEmailRow account={a} key={a.id} disabled={oneAuthMethod} />
))}
</ListGroup>
</>
)}
{discordAccounts.length < 3 && (
<p>
{/* @ts-expect-error as=Link */}
<Button variant="primary" as={Link} to="/settings/auth/add-discord-account">
{discordAccounts.length === 0
? t("settings.auth.form.add-first-discord-account")
: t("settings.auth.form.add-extra-discord-account")}
</Button>
</p>
)}
</>
);
}
function FediverseSettings({ user }: { user: MeUser }) {
const { t } = useTranslation();
const oneAuthMethod = user.auth_methods.length === 1;
const fediAccounts = user.auth_methods.filter((m) => m.type === "FEDIVERSE");
return (
<>
<h3>{t("settings.auth.fediverse-accounts")}</h3>
{fediAccounts.length > 0 && (
<>
<ListGroup className="pt-2 pb-3">
{fediAccounts.map((a) => (
<NonEmailRow account={a} key={a.id} disabled={oneAuthMethod} />
))}
</ListGroup>
</>
)}
{fediAccounts.length < 3 && (
<p>
{/* @ts-expect-error as=Link */}
<Button variant="primary" as={Link} to="/settings/auth/add-fediverse-account">
{fediAccounts.length === 0
? t("settings.auth.form.add-first-fediverse-account")
: t("settings.auth.form.add-extra-fediverse-account")}
</Button>
</p>
)}
</>
);
}
function NonEmailRow({ account, disabled }: { account: AuthMethod; disabled: boolean }) {
const { t } = useTranslation();
return (
<ListGroup.Item>
<div className="row">
<div className="col">
{account.remote_username} {account.type !== "FEDIVERSE" && <>({account.remote_id})</>}
</div>
{!disabled && (
<div className="col text-end">
<Link to={`/settings/auth/remove-method/${account.id}`}>
{t("settings.auth.remove-auth-method")}
</Link>
</div>
)}
</div>
</ListGroup.Item>
);
}

View file

@ -0,0 +1,26 @@
import { LoaderFunctionArgs, redirect, json } from "@remix-run/node";
import serverRequest, { getToken } from "~/lib/request.server";
import { ApiError } from "~/lib/api/error";
import { useLoaderData } from "@remix-run/react";
import ErrorAlert from "~/components/ErrorAlert";
export const loader = async ({ request }: LoaderFunctionArgs) => {
const token = getToken(request);
try {
const { url } = await serverRequest<{ url: string }>("GET", "/auth/discord/add-account", {
isInternal: true,
token,
});
return redirect(url, 303);
} catch (e) {
return json({ error: e as ApiError });
}
};
export default function AddDiscordAccountPage() {
const { error } = useLoaderData<typeof loader>();
return <ErrorAlert error={error} />;
}

View file

@ -16,7 +16,8 @@
"generic-error": "An unknown error occurred.", "generic-error": "An unknown error occurred.",
"internal-server-error": "Server experienced an internal error, please try again later.", "internal-server-error": "Server experienced an internal error, please try again later.",
"member-not-found": "Member not found, please check your spelling and try again.", "member-not-found": "Member not found, please check your spelling and try again.",
"user-not-found": "User not found, please check your spelling and try again." "user-not-found": "User not found, please check your spelling and try again.",
"account-already-linked": "This account is already linked with a pronouns.cc account."
}, },
"title": "An error occurred", "title": "An error occurred",
"more-info": "Click here for a more detailed error" "more-info": "Click here for a more detailed error"
@ -51,11 +52,15 @@
"invalid-username": "Invalid username", "invalid-username": "Invalid username",
"username-taken": "That username is already taken, please try something else.", "username-taken": "That username is already taken, please try something else.",
"title": { "title": {
"discord-link": "Link a new Discord account",
"discord-success": "Log in with Discord", "discord-success": "Log in with Discord",
"discord-register": "Register with Discord", "discord-register": "Register with Discord",
"fediverse-success": "Log in with a Fediverse account", "fediverse-success": "Log in with a Fediverse account",
"fediverse-register": "Register with a Fediverse account" "fediverse-register": "Register with a Fediverse account"
}, },
"link-error": "Could not link account",
"discord-link-success": "Linked a new Discord account!",
"discord-link-success-hint": "Successfully linked the Discord account {{username}} with your pronouns.cc account. You can now close this page.",
"success": "Successfully logged in!", "success": "Successfully logged in!",
"success-link": "Welcome back, <1>@{{username}}</1>!", "success-link": "Welcome back, <1>@{{username}}</1>!",
"redirect-hint": "If you're not redirected to your profile in a few seconds, press the link above.", "redirect-hint": "If you're not redirected to your profile in a few seconds, press the link above.",
@ -126,14 +131,20 @@
"email-address": "Email address", "email-address": "Email address",
"password-1": "Password", "password-1": "Password",
"password-2": "Confirm password", "password-2": "Confirm password",
"add-email-button": "Add email address" "add-email-button": "Add email address",
"add-first-discord-account": "Link a Discord account",
"add-extra-discord-account": "Link another Discord account",
"add-first-fediverse-account": "Link a Fediverse account",
"add-extra-fediverse-account": "Link another Fediverse account"
}, },
"no-email": "You haven't linked any email addresses yet. You can add one using this form.", "no-email": "You haven't linked any email addresses yet. You can add one using this form.",
"new-email-pending": "Email address added! Click the link in your inbox to confirm.", "new-email-pending": "Email address added! Click the link in your inbox to confirm.",
"email-link-success": "Email successfully linked", "email-link-success": "Email successfully linked",
"redirect-to-auth-hint": "You will be redirected back to the authentication page in a few seconds.", "redirect-to-auth-hint": "You will be redirected back to the authentication page in a few seconds.",
"email-addresses": "Email addresses", "email-addresses": "Email addresses",
"remove-auth-method": "Remove" "remove-auth-method": "Remove",
"discord-accounts": "Linked Discord accounts",
"fediverse-accounts": "Linked Fediverse accounts"
}, },
"title": "Settings", "title": "Settings",
"nav": { "nav": {