feat: allow configuration of whether registration is enabled server-side

Signed-off-by: Thaddeus Kuah <[email protected]>

.env.example

@@ -18,6 +18,9 @@ PROHIBITED_SLUGS=""
 # Characters that are prohibited from being used in slugs. Defaults to "/".
 PROHIBITED_CHARACTERS_IN_SLUGS=""
 
+# Whether registration is enabled. Defaults to "true".
+REGISTRATION_ENABLED=""
+
 # Log level for the server, defaults to "info".
 # Possible values: "trace", "debug", "info", "warn", "error", "fatal".
 # Set to "silent" to disable logging. If the value is invalid, Nova will probably not start.

src/index.ts

@@ -21,6 +21,7 @@ const baseUrlRedirect = process.env['BASE_URL_REDIRECT'] || '';
 const allowedHosts = process.env['ALLOWED_HOSTS']?.split(',').filter((element) => element.length > 0) || [];
 const prohibitedSlugs = process.env['PROHIBITED_SLUGS']?.split(',').filter((element) => element.length > 0) || ['api'];
 const prohibitedCharacters = process.env['PROHIBITED_CHARACTERS_IN_SLUGS'] || '/';
+const registrationEnabled = process.env['REGISTRATION_ENABLED'] ? process.env['REGISTRATION_ENABLED'] == 'true' : true;
 
 const $ = pino({ level });
 const fastify = Fastify({ logger: false });
@@ -83,6 +84,7 @@ for (const route of readFiles(path.join(__dirname, 'routes'))) {
                 prohibitedSlugs,
                 prohibitedCharacters: [...prohibitedCharacters],
                 baseDirectory: __dirname,
+                registrationEnabled,
             } as ConfigObject,
         });
         $.debug(`Registered ${route}`);

src/routes/users/register.ts

@@ -2,7 +2,7 @@ import bcrypt from 'bcrypt';
 import { User } from '../../models.js';
 import type { Route } from '../../types.js';
 
-export const routes: Route = (fastify, { $ }, done) => {
+export const routes: Route = (fastify, { $, config }, done) => {
     fastify.route({
         method: ['POST'],
         url: '/api/users/register',
@@ -22,6 +22,10 @@ export const routes: Route = (fastify, { $ }, done) => {
                 reply.code(400).send({ error: true, message: 'Missing required fields' });
                 return;
             }
+            if (!config.registrationEnabled) {
+                reply.code(403).send({ error: true, message: 'Registration is disabled on this instance' });
+                return;
+            }
             if (await User.exists({
                 $or: [
                     { username: body.username.toLowerCase() },

src/types.ts

@@ -13,4 +13,5 @@ export type ConfigObject = {
     prohibitedSlugs: string[];
     prohibitedCharacters: string[];
     baseDirectory: string;
+    registrationEnabled: boolean;
 };