@remit/backend 2.0.0 → 2.1.0

package/dist/src/config/api-config.d.ts

@@ -1,7 +1,10 @@
 import type { MsOAuthConfig } from "./msoauth.js";
+export type Switch = "Enabled" | "Disabled";
 export type AuthConfig = {
     mode: "BetterAuthJwt";
     contentSigningSecret: string;
+    signIn: Switch;
+    selfSignUp: Switch;
 } | {
     mode: "GatewayAuthorizer";
 };

package/dist/src/config/from-env.js

@@ -1,3 +1,4 @@
+import { resolveSelfSignUpEnabled, resolveSignInEnabled, } from "@remit/auth-service/verifier";
 import { msOAuthCredentialsFromSecret } from "./msoauth-secrets-manager.js";
 const DEFAULT_UPDATE_CONTROL_DIR = "/data/control";
 const optional = (env, key) => env[key] || undefined;
@@ -11,10 +12,13 @@ const commaList = (raw) => (raw ?? "")
     .split(",")
     .map((origin) => origin.trim())
     .filter((origin) => origin.length > 0);
+const switchOf = (on) => (on ? "Enabled" : "Disabled");
 const authFromEnv = (env) => env.DATA_BACKEND === "sqlite"
     ? {
         mode: "BetterAuthJwt",
         contentSigningSecret: required(env, "BETTER_AUTH_SECRET", "The self-host SQL backend signs content URLs with it."),
+        signIn: switchOf(resolveSignInEnabled(env.SIGN_IN_ENABLED)),
+        selfSignUp: switchOf(resolveSelfSignUpEnabled(env.SELF_SIGN_UP_ENABLED)),
     }
     : { mode: "GatewayAuthorizer" };
 const contentDeliveryDomainFromEnv = (env, auth, publicOrigin) => {

package/dist/src/handlers/calendar-feed.js

@@ -174,6 +174,12 @@ export const getCalendarFeedIcal = async (context, ctx) => {
     const feedToken = readCalendarFeedToken(context.request.path);
     if (feedToken === null)
         return feedNotFound();
+    // The kill switch stops every feed with the answer an unknown token gets;
+    // the rows stay, so feeds resume when sign-in is turned back on.
+    if (ctx.config.auth.mode === "BetterAuthJwt" &&
+        ctx.config.auth.signIn === "Disabled") {
+        return feedNotFound();
+    }
     const ifNoneMatch = context.request.headers["if-none-match"];
     const ifModifiedSince = context.request.headers["if-modified-since"];
     const deps = calendarDepsOf(ctx.client);

package/dist/src/handlers/index.d.ts

@@ -175,6 +175,11 @@ export declare const handlers: {
     AccountDetailOperations_deleteAccount: (context: import("openapi-backend").Context, ctx: import("../types.js").HandlerContext<"accountFanout">) => Promise<import("@remit/api-openapi-types").DeleteAccountResponse>;
     AccountOperations_createAccount: (context: import("openapi-backend").Context, ctx: import("../types.js").HandlerContext<"sync">) => Promise<import("@remit/api-openapi-types").AccountResponse>;
     AccountOperations_testConnection: (context: import("openapi-backend").Context, ctx: import("../types.js").HandlerContext) => Promise<import("@remit/api-openapi-types").TestConnectionResponse>;
+    PeopleOperations_listPeople: OperationHandler<import("../types.js").PeopleOperationIds>;
+    PeopleOperations_createStepUp: OperationHandler<import("../types.js").PeopleOperationIds>;
+    PeopleOperations_updatePerson: OperationHandler<import("../types.js").PeopleOperationIds>;
+    PeopleOperations_createPasswordReset: OperationHandler<import("../types.js").PeopleOperationIds>;
+    PeopleOperations_signOutPerson: OperationHandler<import("../types.js").PeopleOperationIds>;
     SystemOperations_getSystemUpdate: OperationHandler<import("../types.js").SystemOperationIds>;
     SystemOperations_applySystemUpdate: OperationHandler<import("../types.js").SystemOperationIds>;
     ConfigOperations_getConfig: (_context: import("openapi-backend").Context, ctx: import("../types.js").HandlerContext<"sync">) => Promise<import("@remit/api-openapi-types").ConfigDescriptionResponse>;

package/dist/src/handlers/index.js

@@ -15,6 +15,7 @@ import { MeOperations } from "./me.js";
 import { MessageBulkOperations, MessageOperations } from "./message.js";
 import { OrganizeJobDetailOperations, OrganizeOperations } from "./organize.js";
 import { OutboxAttachmentOperations, OutboxDetailOperations, OutboxOperations, } from "./outbox.js";
+import { PeopleOperations } from "./people.js";
 import { SyncOperations } from "./sync.js";
 import { SystemOperations } from "./system-update.js";
 import { ThreadDetailOperations, ThreadOperations } from "./thread.js";
@@ -24,6 +25,7 @@ export const handlers = {
     ...MeOperations,
     ...ConfigOperations,
     ...SystemOperations,
+    ...PeopleOperations,
     ...AccountOperations,
     ...AccountDetailOperations,
     ...MicrosoftOAuthOperations,

package/dist/src/handlers/people.d.ts

@@ -0,0 +1,2 @@
+import type { OperationHandler, PeopleOperationIds } from "../types.js";
+export declare const PeopleOperations: Record<PeopleOperationIds, OperationHandler<PeopleOperationIds>>;

package/dist/src/handlers/people.js

@@ -0,0 +1,119 @@
+import { getPeopleDirectory } from "../service/people-directory.js";
+const CLIENT_IP_HEADER = "x-remit-client-ip";
+const refuse = (statusCode, code, message) => ({ statusCode, body: { code, message } });
+const REFUSALS = {
+    caller_disabled: [403, "Your account is disabled."],
+    not_found: [404, "Not found"],
+    step_up_required: [403, "Confirm your password again."],
+    wrong_password: [403, "That password is not right."],
+    step_up_locked: [429, "Too many wrong passwords. Try again in 15 minutes."],
+    cannot_disable_self: [409, "You cannot disable your own account."],
+};
+const refusalOf = (refusal) => {
+    const [statusCode, message] = REFUSALS[refusal];
+    return refuse(statusCode, refusal, message);
+};
+const headerOf = (context, name) => {
+    const headers = context.request.headers;
+    const key = Object.keys(headers).find((each) => each.toLowerCase() === name);
+    const value = key === undefined ? undefined : headers[key];
+    return typeof value === "string" ? value : undefined;
+};
+/**
+ * The guards every People operation runs before any read or write. The
+ * surface does not exist (404) while anyone can sign up, since anyone could
+ * then make themselves an operator; the kill switch refuses it; an unsafe
+ * request from an origin this instance does not serve is refused. The caller's
+ * own row is checked inside the directory, in the transaction that acts.
+ */
+const guard = (context, ctx, targetId, unsafe) => {
+    const directory = getPeopleDirectory();
+    const { auth } = ctx.config;
+    if (auth.mode !== "BetterAuthJwt" ||
+        auth.selfSignUp === "Enabled" ||
+        !directory) {
+        return refusalOf("not_found");
+    }
+    const request = {
+        directory,
+        callerId: ctx.identity.sub,
+        clientIp: headerOf(context, CLIENT_IP_HEADER) ?? "unknown",
+    };
+    const refuseAudited = (outcome, code, message) => {
+        directory.recordRefusal({ ...request, targetId, outcome });
+        return refuse(403, code, message);
+    };
+    if (auth.signIn === "Disabled") {
+        return refuseAudited("RefusedSignInOff", "sign_in_disabled", "Sign-in is turned off on this server.");
+    }
+    const origin = headerOf(context, "origin");
+    if (unsafe &&
+        origin !== undefined &&
+        !ctx.config.corsAllowedOrigins.includes(origin)) {
+        return refuseAudited("RefusedForeignOrigin", "foreign_origin", "This request came from a page this server does not serve.");
+    }
+    return request;
+};
+const isGuarded = (value) => "directory" in value;
+const answer = (outcome) => outcome.ok ? outcome.value : refusalOf(outcome.refusal);
+const targetOf = (context) => context.request.params.userId;
+export const PeopleOperations = {
+    PeopleOperations_listPeople: async (context, ctx) => {
+        const guarded = guard(context, ctx, "all", false);
+        if (!isGuarded(guarded))
+            return guarded;
+        const listed = answer(await guarded.directory.listPeople(guarded));
+        return Array.isArray(listed) ? { people: listed } : listed;
+    },
+    PeopleOperations_createStepUp: async (context, ctx) => {
+        const body = context.request.requestBody;
+        const guarded = guard(context, ctx, body.userId, true);
+        if (!isGuarded(guarded))
+            return guarded;
+        return answer(await guarded.directory.createStepUp({
+            ...guarded,
+            targetId: body.userId,
+            action: body.action,
+            password: body.password,
+        }));
+    },
+    PeopleOperations_signOutPerson: async (context, ctx) => {
+        const targetId = targetOf(context);
+        const guarded = guard(context, ctx, targetId, true);
+        if (!isGuarded(guarded))
+            return guarded;
+        const { stepUpToken } = context.request.requestBody;
+        return answer(await guarded.directory.signOutPerson({
+            ...guarded,
+            targetId,
+            stepUpToken,
+        }));
+    },
+    PeopleOperations_updatePerson: async (context, ctx) => {
+        const targetId = targetOf(context);
+        const guarded = guard(context, ctx, targetId, true);
+        if (!isGuarded(guarded))
+            return guarded;
+        const { status, stepUpToken } = context.request
+            .requestBody;
+        return answer(await guarded.directory.updatePerson({
+            ...guarded,
+            targetId,
+            stepUpToken,
+            status,
+        }));
+    },
+    PeopleOperations_createPasswordReset: async (context, ctx) => {
+        const targetId = targetOf(context);
+        const guarded = guard(context, ctx, targetId, true);
+        if (!isGuarded(guarded))
+            return guarded;
+        const { stepUpToken } = context.request
+            .requestBody;
+        return answer(await guarded.directory.createPasswordReset({
+            ...guarded,
+            targetId,
+            stepUpToken,
+        }));
+    },
+};

package/dist/src/service/people-directory.d.ts

@@ -0,0 +1,8 @@
+import type { PeopleDirectory } from "@remit/auth-service/people";
+/**
+ * Register the self-host people directory from the composition root. A host
+ * that registers none answers every People operation with 404, which is what
+ * keeps better-auth out of any bundle that only serves the mail API.
+ */
+export declare const setPeopleDirectory: (directory: PeopleDirectory | null) => void;
+export declare const getPeopleDirectory: () => PeopleDirectory | null;

package/dist/src/service/people-directory.js

@@ -0,0 +1,10 @@
+let registered = null;
+/**
+ * Register the self-host people directory from the composition root. A host
+ * that registers none answers every People operation with 404, which is what
+ * keeps better-auth out of any bundle that only serves the mail API.
+ */
+export const setPeopleDirectory = (directory) => {
+    registered = directory;
+};
+export const getPeopleDirectory = () => registered;

package/dist/src/types.d.ts

@@ -3,10 +3,11 @@ import type { ApiConfig } from "./config/api-config.js";
 import type { RemitClient } from "./service/create-remit-client.js";
 import type { QueueName } from "./service/queues.js";
 type MatchPrefix<Prefix extends string, S extends string> = S extends `${Prefix}${infer _}` ? S : never;
-export type OperationIds = "MeOperations_deleteMe" | "MeOperations_listVipSuggestions" | "MeOperations_createExport" | "MeOperations_getExport" | "MeOperations_listQuarantine" | "ConfigOperations_getConfig" | "ConfigOperations_exportConfig" | "ConfigOperations_importConfig" | "SystemOperations_getSystemUpdate" | "SystemOperations_applySystemUpdate" | "AccountOperations_createAccount" | "AccountOperations_testConnection" | "AccountDetailOperations_updateAccount" | "AccountDetailOperations_deleteAccount" | "MicrosoftOAuthOperations_microsoftOAuthStart" | "MicrosoftOAuthOperations_microsoftOAuthCallback" | "MailboxOperations_listMailboxes" | "MailboxOperations_createMailbox" | "MailboxDetailOperations_getMailbox" | "MailboxDetailOperations_renameMailbox" | "MailboxDetailOperations_deleteMailbox" | "FolderRoleOperations_appointFolderRole" | "FilterOperations_listFilters" | "FilterOperations_createFilter" | "FilterDetailOperations_getFilter" | "FilterDetailOperations_updateFilter" | "FilterDetailOperations_deleteFilter" | "LabelOperations_listLabels" | "LabelOperations_createLabel" | "LabelDetailOperations_getLabel" | "LabelDetailOperations_updateLabel" | "LabelDetailOperations_deleteLabel" | "OrganizeOperations_createOrganizeJob" | "OrganizeOperations_previewOrganize" | "OrganizeJobDetailOperations_getOrganizeJob" | "SyncOperations_triggerSync" | "SyncOperations_getSyncStatus" | "ThreadDetailOperations_listThreadMessages" | "UnifiedThreadOperations_listAllThreads" | "ThreadOperations_listThreads" | "ThreadOperations_searchThreads" | "MessageOperations_describeMessage" | "MessageOperations_getRawMessage" | "MessageOperations_updateMessageFlags" | "MessageBulkOperations_deleteMessages" | "MessageBulkOperations_moveMessages" | "MessageBulkOperations_updateFlags" | "MessageBulkOperations_copyMessages" | "MessageBulkOperations_updateMessageLabels" | "MessageBulkOperations_reportSpam" | "MessageBulkOperations_notSpam" | "CalendarOperations_listCalendars" | "CalendarOperations_createCalendar" | "CalendarDetailOperations_getCalendar" | "CalendarDetailOperations_updateCalendar" | "CalendarDetailOperations_deleteCalendar" | "CalendarDetailOperations_getCalendarFeed" | "CalendarDetailOperations_putCalendarFeed" | "CalendarDetailOperations_revokeCalendarFeed" | "CalendarFeedOperations_getCalendarFeedIcal" | "CalendarEventOperations_listCalendarEvents" | "CalendarEventOperations_createCalendarEvent" | "CalendarEventDetailOperations_getCalendarEvent" | "CalendarEventDetailOperations_updateCalendarEvent" | "CalendarEventDetailOperations_deleteCalendarEvent" | "CalendarFreeBusyOperations_listCalendarFreeBusy" | "UserSettingsOperations_getUserSettings" | "UserSettingsOperations_updateUserSettings" | "UserSettingsOperations_clearDefaultInvitationSender" | "CalendarTaskOperations_listCalendarTasks" | "CalendarTaskOperations_createCalendarTask" | "CalendarTaskDetailOperations_getCalendarTask" | "CalendarTaskDetailOperations_updateCalendarTask" | "CalendarTaskDetailOperations_deleteCalendarTask" | "TrashOperations_emptyTrash" | "OutboxOperations_createOutboxMessage" | "OutboxOperations_listOutboxMessages" | "OutboxDetailOperations_getOutboxMessage" | "OutboxDetailOperations_updateOutboxMessage" | "OutboxDetailOperations_deleteOutboxMessage" | "OutboxDetailOperations_sendOutboxMessage" | "OutboxDetailOperations_mintOutboxAttachment" | "OutboxAttachmentOperations_completeOutboxAttachment" | "AddressOperations_searchAddresses" | "AddressDetailOperations_updateAddress" | "CalendarSuggestionOperations_listCalendarSuggestions" | "MessageCalendarSuggestionOperations_listMessageCalendarSuggestions" | "CalendarSuggestionActionOperations_acceptCalendarSuggestion" | "CalendarSuggestionActionOperations_declineCalendarSuggestion" | "CalendarSuggestionActionOperations_dismissCalendarSuggestion" | "CalendarSuggestionActionOperations_reopenCalendarSuggestion";
+export type OperationIds = "MeOperations_deleteMe" | "MeOperations_listVipSuggestions" | "MeOperations_createExport" | "MeOperations_getExport" | "MeOperations_listQuarantine" | "ConfigOperations_getConfig" | "ConfigOperations_exportConfig" | "ConfigOperations_importConfig" | "SystemOperations_getSystemUpdate" | "SystemOperations_applySystemUpdate" | "PeopleOperations_listPeople" | "PeopleOperations_createStepUp" | "PeopleOperations_signOutPerson" | "PeopleOperations_updatePerson" | "PeopleOperations_createPasswordReset" | "AccountOperations_createAccount" | "AccountOperations_testConnection" | "AccountDetailOperations_updateAccount" | "AccountDetailOperations_deleteAccount" | "MicrosoftOAuthOperations_microsoftOAuthStart" | "MicrosoftOAuthOperations_microsoftOAuthCallback" | "MailboxOperations_listMailboxes" | "MailboxOperations_createMailbox" | "MailboxDetailOperations_getMailbox" | "MailboxDetailOperations_renameMailbox" | "MailboxDetailOperations_deleteMailbox" | "FolderRoleOperations_appointFolderRole" | "FilterOperations_listFilters" | "FilterOperations_createFilter" | "FilterDetailOperations_getFilter" | "FilterDetailOperations_updateFilter" | "FilterDetailOperations_deleteFilter" | "LabelOperations_listLabels" | "LabelOperations_createLabel" | "LabelDetailOperations_getLabel" | "LabelDetailOperations_updateLabel" | "LabelDetailOperations_deleteLabel" | "OrganizeOperations_createOrganizeJob" | "OrganizeOperations_previewOrganize" | "OrganizeJobDetailOperations_getOrganizeJob" | "SyncOperations_triggerSync" | "SyncOperations_getSyncStatus" | "ThreadDetailOperations_listThreadMessages" | "UnifiedThreadOperations_listAllThreads" | "ThreadOperations_listThreads" | "ThreadOperations_searchThreads" | "MessageOperations_describeMessage" | "MessageOperations_getRawMessage" | "MessageOperations_updateMessageFlags" | "MessageBulkOperations_deleteMessages" | "MessageBulkOperations_moveMessages" | "MessageBulkOperations_updateFlags" | "MessageBulkOperations_copyMessages" | "MessageBulkOperations_updateMessageLabels" | "MessageBulkOperations_reportSpam" | "MessageBulkOperations_notSpam" | "CalendarOperations_listCalendars" | "CalendarOperations_createCalendar" | "CalendarDetailOperations_getCalendar" | "CalendarDetailOperations_updateCalendar" | "CalendarDetailOperations_deleteCalendar" | "CalendarDetailOperations_getCalendarFeed" | "CalendarDetailOperations_putCalendarFeed" | "CalendarDetailOperations_revokeCalendarFeed" | "CalendarFeedOperations_getCalendarFeedIcal" | "CalendarEventOperations_listCalendarEvents" | "CalendarEventOperations_createCalendarEvent" | "CalendarEventDetailOperations_getCalendarEvent" | "CalendarEventDetailOperations_updateCalendarEvent" | "CalendarEventDetailOperations_deleteCalendarEvent" | "CalendarFreeBusyOperations_listCalendarFreeBusy" | "UserSettingsOperations_getUserSettings" | "UserSettingsOperations_updateUserSettings" | "UserSettingsOperations_clearDefaultInvitationSender" | "CalendarTaskOperations_listCalendarTasks" | "CalendarTaskOperations_createCalendarTask" | "CalendarTaskDetailOperations_getCalendarTask" | "CalendarTaskDetailOperations_updateCalendarTask" | "CalendarTaskDetailOperations_deleteCalendarTask" | "TrashOperations_emptyTrash" | "OutboxOperations_createOutboxMessage" | "OutboxOperations_listOutboxMessages" | "OutboxDetailOperations_getOutboxMessage" | "OutboxDetailOperations_updateOutboxMessage" | "OutboxDetailOperations_deleteOutboxMessage" | "OutboxDetailOperations_sendOutboxMessage" | "OutboxDetailOperations_mintOutboxAttachment" | "OutboxAttachmentOperations_completeOutboxAttachment" | "AddressOperations_searchAddresses" | "AddressDetailOperations_updateAddress" | "CalendarSuggestionOperations_listCalendarSuggestions" | "MessageCalendarSuggestionOperations_listMessageCalendarSuggestions" | "CalendarSuggestionActionOperations_acceptCalendarSuggestion" | "CalendarSuggestionActionOperations_declineCalendarSuggestion" | "CalendarSuggestionActionOperations_dismissCalendarSuggestion" | "CalendarSuggestionActionOperations_reopenCalendarSuggestion";
 export type MeOperationIds = MatchPrefix<"MeOperations_", OperationIds>;
 export type ConfigOperationIds = MatchPrefix<"ConfigOperations_", OperationIds>;
 export type SystemOperationIds = MatchPrefix<"SystemOperations_", OperationIds>;
+export type PeopleOperationIds = MatchPrefix<"PeopleOperations_", OperationIds>;
 export type AccountOperationIds = MatchPrefix<"AccountOperations_", OperationIds>;
 export type AccountDetailOperationIds = MatchPrefix<"AccountDetailOperations_", OperationIds>;
 export type MailboxOperationIds = MatchPrefix<"MailboxOperations_", OperationIds>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remit/backend",
-	"version": "2.0.0",
+	"version": "2.1.0",
 	"description": "Remit Mail Inspector API backend",
 	"license": "MIT",
 	"author": "",