feat: preserved usernames

Resolve #10704

packages/backend/src/core/SignupService.ts

@@ -13,8 +13,9 @@ import { UsedUsername } from '@/models/entities/UsedUsername.js';
 import generateUserToken from '@/misc/generate-native-user-token.js';
 import { UserEntityService } from '@/core/entities/UserEntityService.js';
 import { bindThis } from '@/decorators.js';
-import UsersChart from './chart/charts/users.js';
-import { UtilityService } from './UtilityService.js';
+import UsersChart from '@/core/chart/charts/users.js';
+import { UtilityService } from '@/core/UtilityService.js';
+import { MetaService } from '@/core/MetaService.js';
 
 @Injectable()
 export class SignupService {
@@ -34,6 +35,7 @@ export class SignupService {
 		private utilityService: UtilityService,
 		private userEntityService: UserEntityService,
 		private idService: IdService,
+		private metaService: MetaService,
 		private usersChart: UsersChart,
 	) {
 	}
@@ -44,6 +46,7 @@ export class SignupService {
 		password?: string | null;
 		passwordHash?: UserProfile['password'] | null;
 		host?: string | null;
+		ignorePreservedUsernames?: boolean;
 	}) {
 		const { username, password, passwordHash, host } = opts;
 		let hash = passwordHash;
@@ -76,6 +79,14 @@ export class SignupService {
 		if (await this.usedUsernamesRepository.findOneBy({ username: username.toLowerCase() })) {
 			throw new Error('USED_USERNAME');
 		}
+
+		if (!opts.ignorePreservedUsernames) {
+			const instance = await this.metaService.fetch(true);
+			const isPreserved = instance.preservedUsernames.map(x => x.toLowerCase()).includes(username.toLowerCase());
+			if (isPreserved) {
+				throw new Error('USED_USERNAME');
+			}
+		}
 	
 		const keyPair = await new Promise<string[]>((res, rej) =>
 			generateKeyPair('rsa', {

packages/backend/src/models/entities/Meta.ts

@@ -412,4 +412,9 @@ export class Meta {
 		default: '{}',
 	})
 	public serverRules: string[];
+
+	@Column('varchar', {
+		length: 1024, array: true, default: '{ "admin", "administrator", "root", "system", "maintainer", "host", "mod", "moderator", "owner", "superuser", "staff", "auth", "i", "me", "everyone", "all", "mention", "mentions", "example", "user", "users", "account", "accounts", "official", "help", "helps", "support", "supports", "info", "information", "informations", "announce", "announces", "announcement", "announcements", "notice", "notification", "notifications", "dev", "developer", "developers", "tech", "misskey" }',
+	})
+	public preservedUsernames: string[];
 }

packages/backend/src/server/api/SignupApiService.ts

@@ -1,6 +1,7 @@
 import { Inject, Injectable } from '@nestjs/common';
 import rndstr from 'rndstr';
 import bcrypt from 'bcryptjs';
+import { IsNull } from 'typeorm';
 import { DI } from '@/di-symbols.js';
 import type { RegistrationTicketsRepository, UsedUsernamesRepository, UserPendingsRepository, UserProfilesRepository, UsersRepository } from '@/models/index.js';
 import type { Config } from '@/config.js';
@@ -15,7 +16,6 @@ import { FastifyReplyError } from '@/misc/fastify-reply-error.js';
 import { bindThis } from '@/decorators.js';
 import { SigninService } from './SigninService.js';
 import type { FastifyRequest, FastifyReply } from 'fastify';
-import { IsNull } from 'typeorm';
 
 @Injectable()
 export class SignupApiService {
@@ -137,6 +137,11 @@ export class SignupApiService {
 				throw new FastifyReplyError(400, 'USED_USERNAME');
 			}
 
+			const isPreserved = instance.preservedUsernames.map(x => x.toLowerCase()).includes(username.toLowerCase());
+			if (isPreserved) {
+				throw new FastifyReplyError(400, 'USED_USERNAME');
+			}
+
 			const code = rndstr('a-z0-9', 16);
 
 			// Generate hash of password

packages/backend/src/server/api/endpoints/admin/accounts/create.ts

@@ -52,6 +52,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 			const { account, secret } = await this.signupService.signup({
 				username: ps.username,
 				password: ps.password,
+				ignorePreservedUsernames: true,
 			});
 
 			const res = await this.userEntityService.pack(account, account, {

packages/backend/src/server/api/endpoints/admin/meta.ts

@@ -118,6 +118,14 @@ export const meta = {
 					optional: false, nullable: false,
 				},
 			},
+			preservedUsernames: {
+				type: 'array',
+				optional: false, nullable: false,
+				items: {
+					type: 'string',
+					optional: false, nullable: false,
+				},
+			},
 			hcaptchaSecretKey: {
 				type: 'string',
 				optional: true, nullable: true,
@@ -311,6 +319,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 				hiddenTags: instance.hiddenTags,
 				blockedHosts: instance.blockedHosts,
 				sensitiveWords: instance.sensitiveWords,
+				preservedUsernames: instance.preservedUsernames,
 				hcaptchaSecretKey: instance.hcaptchaSecretKey,
 				recaptchaSecretKey: instance.recaptchaSecretKey,
 				turnstileSecretKey: instance.turnstileSecretKey,

packages/backend/src/server/api/endpoints/admin/update-meta.ts

@@ -95,6 +95,7 @@ export const paramDef = {
 		enableChartsForRemoteUser: { type: 'boolean' },
 		enableChartsForFederatedInstances: { type: 'boolean' },
 		serverRules: { type: 'array', items: { type: 'string' } },
+		preservedUsernames: { type: 'array', items: { type: 'string' } },
 	},
 	required: [],
 } as const;
@@ -392,6 +393,10 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 				set.serverRules = ps.serverRules;
 			}
 
+			if (ps.preservedUsernames !== undefined) {
+				set.preservedUsernames = ps.preservedUsernames;
+			}
+
 			await this.metaService.update(set);
 			this.moderationLogService.insertModerationLog(me, 'updateMeta');
 		});

packages/backend/src/server/api/endpoints/username/available.ts

@@ -4,6 +4,7 @@ import type { UsedUsernamesRepository, UsersRepository } from '@/models/index.js
 import { Endpoint } from '@/server/api/endpoint-base.js';
 import { localUsernameSchema } from '@/models/entities/User.js';
 import { DI } from '@/di-symbols.js';
+import { MetaService } from '@/core/MetaService.js';
 
 export const meta = {
 	tags: ['users'],
@@ -39,9 +40,10 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 
 		@Inject(DI.usedUsernamesRepository)
 		private usedUsernamesRepository: UsedUsernamesRepository,
+
+		private metaService: MetaService,
 	) {
 		super(meta, paramDef, async (ps, me) => {
-			// Get exist
 			const exist = await this.usersRepository.countBy({
 				host: IsNull(),
 				usernameLower: ps.username.toLowerCase(),
@@ -49,8 +51,11 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 
 			const exist2 = await this.usedUsernamesRepository.countBy({ username: ps.username.toLowerCase() });
 
+			const meta = await this.metaService.fetch();
+			const isPreserved = meta.preservedUsernames.map(x => x.toLowerCase()).includes(ps.username.toLowerCase());
+
 			return {
-				available: exist === 0 && exist2 === 0,
+				available: exist === 0 && exist2 === 0 && !isPreserved,
 			};
 		});
 	}