import { Column, Entity } from "typeorm"; import { BaseClassWithoutId, PrimaryIdColumn } from "./BaseClass"; import crypto from "crypto"; import { Snowflake } from "../util/Snowflake"; @Entity("config") export class ConfigEntity extends BaseClassWithoutId { @PrimaryIdColumn() key: string; @Column({ type: "simple-json", nullable: true }) value: number | boolean | null | string | undefined; } export interface RateLimitOptions { bot?: number; count: number; window: number; onyIp?: boolean; } export interface Region { id: string; name: string; endpoint: string; location?: { latitude: number; longitude: number; }; vip: boolean; custom: boolean; deprecated: boolean; } export interface KafkaBroker { ip: string; port: number; } export interface ConfigValue { gateway: { endpointClient: string | null; endpointPrivate: string | null; endpointPublic: string | null; }; cdn: { endpointClient: string | null; endpointPublic: string | null; endpointPrivate: string | null; }; general: { instanceId: string; }; limits: { user: { maxGuilds: number; maxUsername: number; maxFriends: number; }; guild: { maxRoles: number; maxEmojis: number; maxMembers: number; maxChannels: number; maxChannelsInCategory: number; hideOfflineMember: number; }; message: { maxCharacters: number; maxTTSCharacters: number; maxReactions: number; maxAttachmentSize: number; maxBulkDelete: number; }; channel: { maxPins: number; maxTopic: number; maxWebhooks: number; }; rate: { disabled: boolean; ip: Omit; global: RateLimitOptions; error: RateLimitOptions; routes: { guild: RateLimitOptions; webhook: RateLimitOptions; channel: RateLimitOptions; auth: { login: RateLimitOptions; register: RateLimitOptions; }; // TODO: rate limit configuration for all routes }; }; }; security: { autoUpdate: boolean | number; requestSignature: string; jwtSecret: string; forwadedFor: string | null; // header to get the real user ip address captcha: { enabled: boolean; service: "recaptcha" | "hcaptcha" | null; // TODO: hcaptcha, custom sitekey: string | null; secret: string | null; }; ipdataApiKey: string | null; }; login: { requireCaptcha: boolean; }; register: { email: { required: boolean; allowlist: boolean; blocklist: boolean; domains: string[]; }; dateOfBirth: { required: boolean; minimum: number; // in years }; disabled: boolean; requireCaptcha: boolean; requireInvite: boolean; guestsRequireInvite: boolean; allowNewRegistration: boolean; allowMultipleAccounts: boolean; blockProxies: boolean; password: { required: boolean; minLength: number; minNumbers: number; minUpperCase: number; minSymbols: number; }; }; regions: { default: string; useDefaultAsOptimal: boolean; available: Region[]; }; guild: { showAllGuildsInDiscovery: boolean; autoJoin: { enabled: boolean; guilds: string[]; canLeave: boolean; }; }; gif: { enabled: boolean; provider: "tenor"; // more coming soon apiKey?: string; }; rabbitmq: { host: string | null; }; kafka: { brokers: KafkaBroker[] | null; }; } export const DefaultConfigOptions: ConfigValue = { gateway: { endpointClient: null, endpointPrivate: null, endpointPublic: null, }, cdn: { endpointClient: null, endpointPrivate: null, endpointPublic: null, }, general: { instanceId: Snowflake.generate(), }, limits: { user: { maxGuilds: 100, maxUsername: 32, maxFriends: 1000, }, guild: { maxRoles: 250, maxEmojis: 50, // TODO: max emojis per guild per nitro level maxMembers: 250000, maxChannels: 500, maxChannelsInCategory: 50, hideOfflineMember: 1000, }, message: { maxCharacters: 2000, maxTTSCharacters: 200, maxReactions: 20, maxAttachmentSize: 8388608, maxBulkDelete: 100, }, channel: { maxPins: 50, maxTopic: 1024, maxWebhooks: 10, }, rate: { disabled: true, ip: { count: 500, window: 5, }, global: { count: 20, window: 5, bot: 250, }, error: { count: 10, window: 5, }, routes: { guild: { count: 5, window: 5, }, webhook: { count: 10, window: 5, }, channel: { count: 10, window: 5, }, auth: { login: { count: 5, window: 60, }, register: { count: 2, window: 60 * 60 * 12, }, }, }, }, }, security: { autoUpdate: true, requestSignature: crypto.randomBytes(32).toString("base64"), jwtSecret: crypto.randomBytes(256).toString("base64"), forwadedFor: null, // forwadedFor: "X-Forwarded-For" // nginx/reverse proxy // forwadedFor: "CF-Connecting-IP" // cloudflare: captcha: { enabled: false, service: null, sitekey: null, secret: null, }, ipdataApiKey: "eca677b284b3bac29eb72f5e496aa9047f26543605efe99ff2ce35c9", }, login: { requireCaptcha: false, }, register: { email: { required: false, allowlist: false, blocklist: true, domains: [], // TODO: efficiently save domain blocklist in database // domains: fs.readFileSync(__dirname + "/blockedEmailDomains.txt", { encoding: "utf8" }).split("\n"), }, dateOfBirth: { required: false, minimum: 13, }, disabled: false, requireInvite: false, guestsRequireInvite: true, requireCaptcha: true, allowNewRegistration: true, allowMultipleAccounts: true, blockProxies: true, password: { required: false, minLength: 8, minNumbers: 2, minUpperCase: 2, minSymbols: 0, }, }, regions: { default: "fosscord", useDefaultAsOptimal: true, available: [ { id: "fosscord", name: "Fosscord", endpoint: "127.0.0.1:3004", vip: false, custom: false, deprecated: false, }, ], }, guild: { showAllGuildsInDiscovery: false, autoJoin: { enabled: true, canLeave: true, guilds: [], }, }, gif: { enabled: true, provider: "tenor", apiKey: "LIVDSRZULELA", }, rabbitmq: { host: null, }, kafka: { brokers: null, }, };