Compare commits
11
Commits
ft/tickets
...
e2fe30b524
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e2fe30b524 | ||
|
|
fefa74e045 | ||
|
|
1ee6280d91 | ||
|
|
a364435bab | ||
|
|
136377d81a | ||
|
|
0218676e2d | ||
|
|
f285367511 | ||
|
|
e10e1f7a86 | ||
|
|
e453a9ba94 | ||
|
|
95072fcd53 | ||
|
|
3f87e68a2c |
No files matched your search
@@ -1,136 +1,76 @@
|
|||||||
# Velox Bot
|
# Velox Bot
|
||||||
|
|
||||||
A Discord bot written in Go with a PostgreSQL backing store.
|
Velox is a Discord bot written in Go, backed by PostgreSQL. It covers server security (anti-raid and anti-nuke), support tickets, moderation, leveling, music, meeting rooms, scheduling, Twitch alerts and a few games. Every module is off until a server turns it on.
|
||||||
|
|
||||||
It currently includes:
|
This repository is the bot. It has two companions that live in their own repositories:
|
||||||
|
|
||||||
- Fun commands (`/ping`, `/joke`, `/dice`, `/rps`, …)
|
- **velox-dashboard-api**: a Go REST API behind the web dashboard. It owns most of the database schema and runs the migrations.
|
||||||
- Leveling system (opt-in per server via `/slvl toggle`)
|
- **velox-dashboard-web**: the Vue dashboard and public website.
|
||||||
- Meeting rooms (voice lobby → auto-created temporary voice channels)
|
|
||||||
- Scheduling (1:1 sessions with DM invites + reaction-based accept/decline/reschedule)
|
|
||||||
- Projects (list/create projects + helpers)
|
|
||||||
- Support tickets (a panel with categories, a private thread per ticket, claim/close, transcripts to a log channel)
|
|
||||||
- Music (Lavalink-powered `/play`, `/queue`, `/volume`)
|
|
||||||
- Twitch live notifications (per-guild `/config` setup)
|
|
||||||
- Welcome messages, DMs, and default role assignment (per-guild `/config` setup)
|
|
||||||
- Focused moderation tools (`/moderation purge|timeout|untimeout|kick|ban|unban|slowmode`)
|
|
||||||
- Server logging system (edits/deletes/joins/leaves/roles/ban/kick/mod actions)
|
|
||||||
|
|
||||||
When the bot is added to a new server for the first time, toggleable systems are defaulted to **disabled** and a setup DM is sent to the inviter (or server owner fallback) with enable instructions.
|
The bot and the API share one PostgreSQL database. They never call each other over HTTP. The dashboard writes settings and requests into tables, and the bot reads them (and is woken through Postgres `NOTIFY` where it has to react at once). See [Architecture](docs/architecture.md).
|
||||||
|
|
||||||
## Requirements
|
## Documentation
|
||||||
|
|
||||||
- Go (see `go.mod`)
|
This README is the front page. The rest of the documentation lives in [`docs/`](docs/), organised like a wiki:
|
||||||
- PostgreSQL 16+ (or use the provided `docker-compose.yml`)
|
|
||||||
- (Optional) [Air](https://github.com/air-verse/air) for live reload during development
|
|
||||||
- (Optional) Lavalink if you want music commands
|
|
||||||
|
|
||||||
## Configuration
|
| Page | What is in it |
|
||||||
|
| --- | --- |
|
||||||
|
| [Getting started](docs/getting-started.md) | Requirements, creating the Discord application, configuration, database, running locally |
|
||||||
|
| [Deployment](docs/deployment.md) | Docker, Compose, upgrade order, backups |
|
||||||
|
| [Architecture](docs/architecture.md) | How the code is laid out, how an interaction flows through it, background loops, the link to the dashboard |
|
||||||
|
| [Features](docs/features.md) | What each module does and how it behaves |
|
||||||
|
| [Command reference](docs/commands.md) | Every slash command, its options and who may run it |
|
||||||
|
| [Database](docs/database.md) | Who owns the schema, the tables, the `NOTIFY` channels, how to change them |
|
||||||
|
| [Development guide](docs/development.md) | How to add commands, subcommands, buttons, events, background jobs, settings and tables; testing; code style |
|
||||||
|
| [Beta features](docs/beta-features.md) | How features are tried by a few testers before release |
|
||||||
|
| [Troubleshooting](docs/troubleshooting.md) | Common problems and what they mean |
|
||||||
|
|
||||||
The app loads environment variables from `.env` (see `internal/config/config.go`).
|
## Quick start
|
||||||
|
|
||||||
Required:
|
You need Go (the version in `go.mod`), PostgreSQL 16 or newer, and a Discord application with a bot token.
|
||||||
|
|
||||||
- `BOT_TOKEN`: Discord bot token
|
|
||||||
- `APP_ID`: Discord application ID
|
|
||||||
- `GUILD_ID`: Target guild/server ID (commands are registered per-guild)
|
|
||||||
- `DB_HOST`: Postgres connection string (pgx), e.g. `postgres://velox:velox_pwd@localhost:5432/velox?sslmode=disable`
|
|
||||||
|
|
||||||
Optional (music):
|
|
||||||
|
|
||||||
- `LAVALINK_HOST`: Lavalink WebSocket/HTTP host (depends on your Lavalink setup)
|
|
||||||
- `LAVALINK_PASSWORD`: Lavalink password
|
|
||||||
|
|
||||||
Optional (Twitch live notifications):
|
|
||||||
|
|
||||||
- `TWITCH_CLIENT_ID`: Twitch Client ID used to query live status
|
|
||||||
|
|
||||||
## Database setup
|
|
||||||
|
|
||||||
If you use the compose file:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker compose up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
Then apply the schema:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
git clone <this repository>
|
||||||
|
cd velox-bot
|
||||||
|
# create .env with BOT_TOKEN, APP_ID, GUILD_ID, DB_HOST and TWITCH_CLIENT_ID (see docs/getting-started.md)
|
||||||
|
docker compose up -d db # PostgreSQL on localhost:5432
|
||||||
psql "postgres://velox:velox_pwd@localhost:5432/velox?sslmode=disable" -f schema.sql
|
psql "postgres://velox:velox_pwd@localhost:5432/velox?sslmode=disable" -f schema.sql
|
||||||
```
|
|
||||||
|
|
||||||
## Run
|
|
||||||
|
|
||||||
Plain Go:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go run .
|
go run .
|
||||||
```
|
```
|
||||||
|
|
||||||
With live reload (Air):
|
On start the bot registers its slash commands in the server named by `GUILD_ID` (or globally if that is empty). The full walkthrough, including the Discord side, is in [Getting started](docs/getting-started.md).
|
||||||
|
|
||||||
```bash
|
## What it does
|
||||||
air
|
|
||||||
|
- **Security**: Join Gate, raid mode, anti-nuke with quarantine, lockdowns, snapshots and restore, and a spam "heat" system, modelled on Wick.
|
||||||
|
- **Tickets**: a panel with categories, a private thread per ticket, claim and close, transcripts to a log channel.
|
||||||
|
- **Moderation**: purge, timeout, kick, ban, unban, slowmode, plus server logs for edits, deletes, joins, leaves, role changes, bans and mod actions.
|
||||||
|
- **Leveling**: XP per message, level cards, leaderboard, role rewards.
|
||||||
|
- **Music**: Lavalink-powered playback with a queue, controlled from Discord or the dashboard.
|
||||||
|
- **Meeting rooms**: join a lobby voice channel and get a temporary room you can lock and invite people to.
|
||||||
|
- **Scheduling and projects**: 1:1 sessions with DM invites and reminders, and a simple project list.
|
||||||
|
- **Twitch alerts, welcome messages, default role**: per-server setup through `/config`.
|
||||||
|
- **Fun**: `/ping`, `/joke`, `/coinflip`, `/dice`, `/rps` with stats and a leaderboard.
|
||||||
|
|
||||||
|
When the bot joins a server for the first time, toggleable systems start **disabled** and the person who invited it gets a DM with setup instructions.
|
||||||
|
|
||||||
|
## Repository layout
|
||||||
|
|
||||||
|
```
|
||||||
|
main.go wiring: config, database, repos, services, bot
|
||||||
|
internal/config environment variables
|
||||||
|
internal/bot Discord session, intents, event registration, startup
|
||||||
|
internal/commands slash commands, one package per feature, plus the dispatcher
|
||||||
|
internal/events handlers for gateway events and background loops
|
||||||
|
internal/db connection, repos (SQL), services (rules)
|
||||||
|
internal/security anti-raid and anti-nuke engine
|
||||||
|
internal/tickets ticket flows
|
||||||
|
internal/music Lavalink player, queue, buttons
|
||||||
|
internal/beta beta access gate
|
||||||
|
internal/modlog, rankcard small shared helpers
|
||||||
|
schema.sql mirror of the tables the bot reads and writes
|
||||||
```
|
```
|
||||||
|
|
||||||
If you use `just`, a small workflow is included:
|
## Contributing
|
||||||
|
|
||||||
```bash
|
Start with the [Development guide](docs/development.md). In short: keep a command's definition and its handler in one package, keep SQL in a repo and rules in a service, and run `go build ./... && go vet ./... && go test ./...` before opening a pull request.
|
||||||
just up # start postgres
|
|
||||||
just start # start postgres + run air
|
|
||||||
just down # stop postgres
|
|
||||||
```
|
|
||||||
|
|
||||||
## Commands (high-level)
|
|
||||||
|
|
||||||
- **Fun**
|
|
||||||
- `/ping`, `/joke [type]`, `/coinflip`, `/dice <expr>`
|
|
||||||
- `/rps <hand>`, `/rpsstats`, `/rpsleaderboard` (server only)
|
|
||||||
- **Help**
|
|
||||||
- `/help` (sends a DM with command reference)
|
|
||||||
- **Leveling**
|
|
||||||
- `/slvl ...` admin/config
|
|
||||||
- `/rank`, `/leaderboard`, `/rewards`
|
|
||||||
- **Meetings** (**Manage Server**)
|
|
||||||
- `/meeting set-lobby`, `/meeting lock`, `/meeting lock-private`, `/meeting unlock`, `/meeting invite`, `/meeting uninvite`
|
|
||||||
- **Timezone**
|
|
||||||
- `/timezone set`, `/timezone show`
|
|
||||||
- **Scheduling**
|
|
||||||
- `/schedule create`, `/schedule list`, `/schedule reschedule`
|
|
||||||
- **Projects**
|
|
||||||
- `/projects list`, `/projects create`, `/projects add-helper`
|
|
||||||
- **Tickets**
|
|
||||||
- `/tickets setup channel:#tickets [log-channel] [staff-role]` — Where tickets open and closed ones are logged (**Manage Server**)
|
|
||||||
- `/tickets category add|remove|list` — One panel button per category, each with its own staff role (**Manage Server**)
|
|
||||||
- `/tickets panel` — Post or refresh the panel (**Manage Server**)
|
|
||||||
- `/ticket add`, `/ticket close [reason]` — Opener or staff; `/ticket claim`, `/ticket remove` — staff
|
|
||||||
- The bot needs View Channel, Send Messages, Embed Links, Create Private Threads, Send Messages in Threads and Manage Threads in the ticket channel, and Attach Files in the log channel. Give the staff role Manage Threads there too, so staff see every ticket.
|
|
||||||
- **Music** (requires **DJ** role)
|
|
||||||
- `/play`, `/queue`, `/volume`
|
|
||||||
- **Moderation** (focused + practical)
|
|
||||||
- `/moderation purge amount:<1-100>` — Fast recent message cleanup (**Manage Messages**)
|
|
||||||
- `/moderation timeout user:@someone duration:<10m|1h|...> [reason]` — Temporary member timeout (**Moderate Members**)
|
|
||||||
- `/moderation kick user:@someone [reason]` — Kick member (**Kick Members**)
|
|
||||||
- `/moderation ban user:@someone [delete_days] [reason]` — Ban member (**Ban Members**)
|
|
||||||
- `/moderation unban user_id:<id> [reason]` — Unban by user ID (**Ban Members**)
|
|
||||||
- `/moderation untimeout user:@someone [reason]` — Remove timeout (**Moderate Members**)
|
|
||||||
- `/moderation slowmode channel:#channel seconds:<0-21600>` — Control channel flood (**Manage Channels**)
|
|
||||||
- **Twitch live notifications** (**Manage Server**)
|
|
||||||
- `/config addstreamer username:<twitch-name>` — Add a streamer for notifications
|
|
||||||
- `/config removestreamer username:<twitch-name>` — Remove a streamer
|
|
||||||
- `/config settwitchnotificationchannel channel:#channel` — Channel for live pings
|
|
||||||
- **Welcome / onboarding** (**Manage Server**)
|
|
||||||
- `/config setwelcomechannel channel:#channel` — Channel for welcome messages
|
|
||||||
- `/config setwelcomemessage message:"..."` — Server welcome template (supports `{user}`, `{server}`)
|
|
||||||
- `/config setwelcomedm message:"..."` — DM welcome template (supports `{user}`, `{server}`)
|
|
||||||
- `/config setwelcomegif url:<image-url>` — GIF/image used in welcome embed
|
|
||||||
- `/config setdefaultrole role:@role` — Role automatically granted on join
|
|
||||||
- **Logging** (**Manage Server**)
|
|
||||||
- `/config setlogchannel channel:#channel` — Set where logs are sent
|
|
||||||
- `/config enablelogging` — Enable event/moderation logs
|
|
||||||
- `/config disablelogging` — Disable event/moderation logs
|
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
- Slash commands are registered to the configured `GUILD_ID` on startup.
|
|
||||||
- Some features require server permissions (e.g. **Manage Server**) or roles (e.g. **DJ** for music).
|
|
||||||
@@ -0,0 +1,131 @@
|
|||||||
|
# Architecture
|
||||||
|
|
||||||
|
This page explains how the bot is put together, so you know where to look and where to make a change.
|
||||||
|
|
||||||
|
## The big picture
|
||||||
|
|
||||||
|
```
|
||||||
|
Discord gateway (websocket)
|
||||||
|
|
|
||||||
|
discordgo session
|
||||||
|
|
|
||||||
|
+--------------------------+---------------------------+
|
||||||
|
| | |
|
||||||
|
interactions gateway events background loops
|
||||||
|
(slash commands, (messages, joins, bans, (Twitch, reminders,
|
||||||
|
buttons, modals) voice, audit log, ...) raid watch, snapshots)
|
||||||
|
| | |
|
||||||
|
internal/commands internal/events internal/events, security
|
||||||
|
| | |
|
||||||
|
+----------- services (rules) <------ repos (SQL) -----+
|
||||||
|
|
|
||||||
|
PostgreSQL <----> velox-dashboard-api <----> dashboard
|
||||||
|
```
|
||||||
|
|
||||||
|
The bot is one Go process. It keeps one websocket connection to Discord and one connection pool to PostgreSQL. It has no HTTP server of its own.
|
||||||
|
|
||||||
|
## Startup
|
||||||
|
|
||||||
|
`main.go` wires everything in this order:
|
||||||
|
|
||||||
|
1. **Config**: `config.LoadConfig()` reads the environment (and `.env`).
|
||||||
|
2. **Database**: `db.NewDB()` opens a `database/sql` pool using the pgx driver.
|
||||||
|
3. **Repos**: one repo per area (`levelrepo`, `settingsrepo`, `ticketrepo`, ...). A repo is the only place that writes SQL.
|
||||||
|
4. **Services**: small structs holding the rules for one area (`level`, `meeting`, `welcome`, ...), built on top of repos, collected in `services.Services`.
|
||||||
|
5. **Singletons for the bigger modules**: tickets and security get their repo with `cmdtickets.Init(...)` and `security.Configure(...)`, and are reached later through `tickets.Default()` and `security.Default()`.
|
||||||
|
6. **Bot**: `bot.NewBot()` creates the Discord session and chooses the gateway intents.
|
||||||
|
7. **`bot.Start()`** opens the connection and then:
|
||||||
|
- starts the music player (if Lavalink is configured) and its command listener,
|
||||||
|
- starts the ticket and security engines and their command listeners (each reconnects every 10 seconds if its database connection drops),
|
||||||
|
- registers every slash command in `GUILD_ID` (or globally),
|
||||||
|
- registers the gateway event handlers,
|
||||||
|
- starts the Twitch and schedule-reminder loops.
|
||||||
|
8. **`bot.WatchBeta()`** reads the beta settings from the database and keeps them fresh every 30 seconds. See [Beta features](beta-features.md).
|
||||||
|
9. The process waits for `SIGINT` or `SIGTERM`.
|
||||||
|
|
||||||
|
## Layers
|
||||||
|
|
||||||
|
The code follows one direction: commands and events call services, services call repos, repos run SQL.
|
||||||
|
|
||||||
|
| Layer | Where | Responsibility |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Commands | `internal/commands/<feature>` | Describe the slash command, check who is allowed, read the options, answer the user. No SQL. |
|
||||||
|
| Events | `internal/events` | React to gateway events and run background loops. |
|
||||||
|
| Engines | `internal/security`, `internal/tickets`, `internal/music` | The bigger modules, with their own state and flows. |
|
||||||
|
| Services | `internal/db/services/<area>` | Rules and orchestration (for example the XP rules in `level`). |
|
||||||
|
| Repos | `internal/db/repos/<area>repo` | SQL, and nothing else. |
|
||||||
|
|
||||||
|
Commands reach services through the package-level `services.Global`, set by `services.NewServices()`. A shared helper in each command package (for example `RequireMeetingService`) answers "service not available" if it is nil. Event handlers receive the services as an argument.
|
||||||
|
|
||||||
|
## How a slash command runs
|
||||||
|
|
||||||
|
1. Discord sends an interaction. discordgo calls `commands.HandleInteraction` (`internal/commands/commands.go`).
|
||||||
|
2. For a slash command, the dispatcher looks the command's name up in the `handlers` map and calls the handler.
|
||||||
|
3. The handler checks the context (server only? permissions?), finds the subcommand in `i.ApplicationCommandData().Options`, reads the options, calls a service, and responds with `s.InteractionRespond`.
|
||||||
|
|
||||||
|
Buttons, select menus and modals do not have a command name. They carry a **custom ID**, and the dispatcher sends them to a feature by its **prefix**: `music:`, `schedule:`, `projects:`, `tickets:` or `security:`. A feature owns everything after its prefix.
|
||||||
|
|
||||||
|
Some commands have a response that takes longer than three seconds (anything that calls Discord several times). Those answer with a deferred response first, then edit it when done. Search the code for `InteractionResponseDeferredChannelMessageWithSource` for examples.
|
||||||
|
|
||||||
|
## How a gateway event runs
|
||||||
|
|
||||||
|
`bot.Start()` registers one handler per event with `Session.AddHandler`. Most of them hand the event to a function in `internal/events`, together with the services. A few go to the security engine first, because it must decide before anything else happens:
|
||||||
|
|
||||||
|
- **Member joins**: the security engine runs first. If it removes the member (join lock, Join Gate, raid mode) there is no welcome message or default role. Otherwise the welcome, default role and join log run.
|
||||||
|
- **Messages**: the security engine's heat check runs, then the leveling handler.
|
||||||
|
- **Audit log entries**: only the security engine (anti-nuke, unauthorised bots).
|
||||||
|
- **Voice state changes**: meeting rooms and the music player.
|
||||||
|
|
||||||
|
## Background loops
|
||||||
|
|
||||||
|
| Loop | Where | Interval | What it does |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| Twitch live check | `events/twitch_live.go` | 30 s | Checks configured streamers and posts when one goes live |
|
||||||
|
| Schedule reminders | `events/schedule_reminders.go` | 1 min | DMs participants 10 minutes before a session |
|
||||||
|
| Raid watch | `security` | 30 s | Ends raid mode after a quiet period |
|
||||||
|
| Snapshots | `security` | 6 h | Saves roles and channels while anti-nuke is on (keeps three) |
|
||||||
|
| Beta settings | `bot/bot.go` (`WatchBeta`) | 30 s | Re-reads who the beta testers are |
|
||||||
|
| Command listeners | music, tickets, security | on `NOTIFY` | Carry out dashboard requests |
|
||||||
|
|
||||||
|
## The link to the dashboard
|
||||||
|
|
||||||
|
The bot and the dashboard API do not talk to each other directly. They meet in PostgreSQL, in two ways:
|
||||||
|
|
||||||
|
1. **Settings tables.** The dashboard writes settings (log channel, security thresholds, ticket categories, beta role). The bot reads them when it needs them. Hot paths cache them for a short time, so a raid of thousands of joins does not become thousands of queries.
|
||||||
|
2. **Command tables with `NOTIFY`.** When the dashboard needs the bot to *do* something (skip a song, post the ticket panel, release a quarantined member), it inserts a row in `music_commands`, `ticket_commands` or `security_commands` and issues `NOTIFY` on that channel. The bot has a long-lived connection that runs `LISTEN`, picks up the row, validates it again and carries it out. Never trust a row just because it is in the table: the listeners re-check permissions themselves.
|
||||||
|
|
||||||
|
Both directions are described table by table in [Database](database.md).
|
||||||
|
|
||||||
|
## Gateway intents
|
||||||
|
|
||||||
|
Set in `internal/bot/bot.go`:
|
||||||
|
|
||||||
|
| Intent | Why |
|
||||||
|
| --- | --- |
|
||||||
|
| Guilds | slash commands, channel and role events |
|
||||||
|
| Guild Moderation (bans, audit log) | ban logs, anti-nuke |
|
||||||
|
| Guild Members (privileged) | joins, leaves, member updates |
|
||||||
|
| Guild Messages and Message Content (privileged) | leveling, spam heat, message logs |
|
||||||
|
| Guild Voice States | meeting rooms, music |
|
||||||
|
| Direct Messages | direct messages sent to the bot |
|
||||||
|
|
||||||
|
If you add a feature that needs another event, add its intent here too, and enable it in the developer portal if it is privileged.
|
||||||
|
|
||||||
|
## Concurrency and safety notes
|
||||||
|
|
||||||
|
- discordgo calls event handlers on goroutines, so handlers must not share unsynchronised state. The engines use mutexes, and per-server memory is bounded.
|
||||||
|
- Security-sensitive actions do not rely on Discord's command permissions, because server admins can change those. The handlers check the owner and the trusted list themselves (see the [Security](features.md#security) section).
|
||||||
|
- User-controlled text (usernames, reasons) is escaped or kept out of mentions. Messages only ping roles that are configured for it.
|
||||||
|
- Settings that decide who has access (the beta role) fail closed: if they cannot be read, nobody gets access.
|
||||||
|
|
||||||
|
## Where things live
|
||||||
|
|
||||||
|
| I want to find... | Look in |
|
||||||
|
| --- | --- |
|
||||||
|
| The definition and handler of `/foo` | `internal/commands/foo/public/` (the `registry.go` next to it re-exports it) |
|
||||||
|
| The list of all commands and the dispatcher | `internal/commands/commands.go` |
|
||||||
|
| What happens on a gateway event | `internal/bot/bot.go`, then `internal/events/` |
|
||||||
|
| The SQL behind a feature | `internal/db/repos/<area>repo/repo.go` |
|
||||||
|
| The rules behind a feature | `internal/db/services/<area>/` |
|
||||||
|
| The table definitions | `schema.sql` and [Database](database.md) |
|
||||||
|
| Environment variables | `internal/config/config.go` |
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
# Beta features
|
||||||
|
|
||||||
|
A beta feature is one that only a few chosen people can use while it is still being tried out. The same rule applies on the bot and on the dashboard: you can use beta features if you are **a member of the beta server and hold the Beta Tester role**.
|
||||||
|
|
||||||
|
## Who the testers are
|
||||||
|
|
||||||
|
- The **beta server** and the **Beta Tester role** are chosen by the bot's owner on the dashboard, under **Admin, Beta access**. Only the owner can see or change this page.
|
||||||
|
- Giving someone the role in Discord makes them a tester. Taking it away removes their access: within about 30 seconds on the bot, and within about 30 seconds on the dashboard API.
|
||||||
|
- Until a role is chosen, **nobody** has beta access.
|
||||||
|
- The settings are stored in the `beta_settings` table (one row). The API writes it, and the bot polls it every 30 seconds. There is nothing to put in `.env`.
|
||||||
|
|
||||||
|
Access **fails closed**. If the settings cannot be read, if the role or the server is not set, if a person is not in the server, if a command is used in a DM, or if Discord cannot be reached, access is denied.
|
||||||
|
|
||||||
|
## On the bot
|
||||||
|
|
||||||
|
Code: `internal/beta` (the gate), `internal/commands/commands.go` (`RegisterBeta`), `internal/bot/bot.go` (`WatchBeta`, `registerBetaCommands`), `internal/commands/betacmd` (`/beta`).
|
||||||
|
|
||||||
|
- Beta commands are registered **only in the beta server**, so nobody else sees them in the command menu.
|
||||||
|
- Each beta handler is wrapped in `beta.Gate`, which checks that the interaction came from the beta server and that the member has the role. If not, the user gets "This feature is in beta and isn't available to you yet." (Autocomplete requests get an empty list.) Hiding the command is never the only protection.
|
||||||
|
- If the owner changes the beta server on the dashboard, the bot moves the beta commands to the new server within 30 seconds and removes them from the old one. Commands in the beta server that are neither regular nor beta commands are removed too. If the beta server is also `GUILD_ID`, the regular commands are kept.
|
||||||
|
- `/beta` shows the owner how access is set up. Only the owner of the Discord application can run it, and it is hidden from everyone but administrators.
|
||||||
|
|
||||||
|
### Add a beta command
|
||||||
|
|
||||||
|
Write the command like any other (see the [Development guide](development.md#add-a-simple-command)), but instead of adding it to `AllCommands` and `handlers`, register it from `commands.go`:
|
||||||
|
|
||||||
|
```go
|
||||||
|
func init() {
|
||||||
|
RegisterBeta(mything.MyThing, mything.MyThingHandler)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
`RegisterBeta` adds the definition to `BetaCommands` and the handler, wrapped in `beta.Gate`, to the dispatcher. Buttons and forms that belong to a beta command need the same care: check `beta.Guard(s, i)` at the top of their handlers, because a custom ID can be reached from an old message.
|
||||||
|
|
||||||
|
### Release it
|
||||||
|
|
||||||
|
Move the definition into `AllCommands` and the handler into the `handlers` map, and delete the `RegisterBeta` call. On the next start the command appears everywhere, and it is removed from the beta server's own list because it is now a regular command.
|
||||||
|
|
||||||
|
## On the API and dashboard
|
||||||
|
|
||||||
|
These live in the other two repositories.
|
||||||
|
|
||||||
|
- **API**: put the feature's routes under `/api/v1/beta`. That route group sits behind a `betaOnly` middleware, which asks Discord whether the signed-in user holds the role in the beta server (with a 30-second memory) and answers `403` otherwise. `GET /users/me` also returns `is_beta`, which the dashboard uses to decide what to show.
|
||||||
|
- **Dashboard**: give a route `meta: { requiresBeta: true }` to keep its page away from non-testers, and use `is_beta` to hide its links. This is only about display. The API checks access on every request, so a page that was shown by mistake still cannot read or change anything.
|
||||||
|
|
||||||
|
## Why it works this way
|
||||||
|
|
||||||
|
- The role in Discord is the single list of testers, so there is no second list to keep in step with it.
|
||||||
|
- Access is decided by the server (bot and API), never by the browser.
|
||||||
|
- Beta commands do not exist outside the beta server, and the gate checks again when they run.
|
||||||
|
- The settings are in the database, not in the environment, so the owner can change them without a deploy.
|
||||||
@@ -0,0 +1,178 @@
|
|||||||
|
# Command reference
|
||||||
|
|
||||||
|
Every slash command the bot registers. Options marked with `*` are required. "Needs" is what the handler checks, not just what Discord shows in its menu. Commands that need a server cannot be used in DMs.
|
||||||
|
|
||||||
|
This page is written by hand from the command definitions in `internal/commands/*/public`. If you change a command, update it here and in `/help` (`internal/commands/help/help.go`). The [Features](features.md) page explains the behaviour behind them.
|
||||||
|
|
||||||
|
- [Fun](#fun)
|
||||||
|
- [Help](#help)
|
||||||
|
- [Leveling](#leveling)
|
||||||
|
- [Music](#music)
|
||||||
|
- [Meeting rooms](#meeting-rooms)
|
||||||
|
- [Moderation](#moderation)
|
||||||
|
- [Timezone and scheduling](#timezone-and-scheduling)
|
||||||
|
- [Projects](#projects)
|
||||||
|
- [Server setup (`/config`)](#server-setup-config)
|
||||||
|
- [Tickets](#tickets)
|
||||||
|
- [Security](#security)
|
||||||
|
- [Beta](#beta)
|
||||||
|
|
||||||
|
## Fun
|
||||||
|
|
||||||
|
Anyone can use these. `/rps`, `/rpsstats` and `/rpsleaderboard` work in servers only.
|
||||||
|
|
||||||
|
| Command | Options | What it does |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `/ping` | | Replies "Pong!" |
|
||||||
|
| `/joke` | `type` | A random joke, optionally of a type |
|
||||||
|
| `/coinflip` | | Heads or tails |
|
||||||
|
| `/dice` | `expr`* | Rolls a dice expression: `d20`, `2d20+1`, `2#d20+1` |
|
||||||
|
| `/rps` | `hand`* | Rock paper scissors against the bot |
|
||||||
|
| `/rpsstats` | | Your rock-paper-scissors record |
|
||||||
|
| `/rpsleaderboard` | | The server's leaderboard |
|
||||||
|
|
||||||
|
## Help
|
||||||
|
|
||||||
|
| Command | What it does |
|
||||||
|
| --- | --- |
|
||||||
|
| `/help` | DMs you a command reference |
|
||||||
|
|
||||||
|
## Leveling
|
||||||
|
|
||||||
|
| Command | Options | Needs | What it does |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| `/slvl toggle` | | Manage Server | Turns leveling on or off |
|
||||||
|
| `/slvl set` | `user`*, `level`* | Manage Server, leveling on | Sets a member's level |
|
||||||
|
| `/slvl set-channel` | `channel`* | Manage Server, leveling on | Where level-up messages go |
|
||||||
|
| `/slvl set-message` | `message`* | Manage Server, leveling on | The level-up message. Variables: `{user}`, `{level}` |
|
||||||
|
| `/slvl set-reward` | `level`*, `role`* | Manage Server, leveling on | Role granted at a level |
|
||||||
|
| `/rank` | `user` | Leveling on | A rank card for you or another member |
|
||||||
|
| `/leaderboard` | | Leveling on | Top 10 in the server |
|
||||||
|
| `/rewards` | | Leveling on | The role rewards |
|
||||||
|
|
||||||
|
## Music
|
||||||
|
|
||||||
|
| Command | Options | Needs | What it does |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| `/play` | `query`* | **DJ** role | Plays a song by name or URL |
|
||||||
|
| `/queue` | | **DJ** role | Shows the queue |
|
||||||
|
| `/volume` | `value`* (0 to 150) | **DJ** role | Sets the volume |
|
||||||
|
| `/music toggle` | | Manage Server | Turns music on or off in this server |
|
||||||
|
|
||||||
|
Requires Lavalink. See [Getting started](getting-started.md#optional-music-with-lavalink).
|
||||||
|
|
||||||
|
## Meeting rooms
|
||||||
|
|
||||||
|
Every subcommand needs **Manage Server** and works in servers only.
|
||||||
|
|
||||||
|
| Command | Options | What it does |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `/meeting add-lobby` | `channel`* (voice) | Makes a voice channel a lobby (up to 10 per server) |
|
||||||
|
| `/meeting remove-lobby` | `channel`* (voice) | Stops using it as a lobby |
|
||||||
|
| `/meeting lobbies` | | Lists the lobbies |
|
||||||
|
| `/meeting lock` | | Locks the room you are in |
|
||||||
|
| `/meeting lock-private` | | Locks it and hides it |
|
||||||
|
| `/meeting unlock` | | Unlocks it |
|
||||||
|
| `/meeting invite` | `user`* | Lets a user into a locked room |
|
||||||
|
| `/meeting uninvite` | `user`* | Removes that access |
|
||||||
|
|
||||||
|
## Moderation
|
||||||
|
|
||||||
|
Each subcommand checks the Discord permission in its "Needs" column.
|
||||||
|
|
||||||
|
| Command | Options | Needs | What it does |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| `/moderation purge` | `amount`* (1 to 100) | Manage Messages | Deletes recent messages in the channel |
|
||||||
|
| `/moderation timeout` | `user`*, `duration`* (`10m`, `1h`, `2h30m`, up to 28d), `reason` | Moderate Members | Times a member out |
|
||||||
|
| `/moderation untimeout` | `user`*, `reason` | Moderate Members | Removes a timeout |
|
||||||
|
| `/moderation kick` | `user`*, `reason` | Kick Members | Kicks a member |
|
||||||
|
| `/moderation ban` | `user`*, `delete_days` (0 to 7), `reason` | Ban Members | Bans a member |
|
||||||
|
| `/moderation unban` | `user_id`*, `reason` | Ban Members | Unbans by ID |
|
||||||
|
| `/moderation slowmode` | `channel`*, `seconds`* (0 to 21600) | Manage Channels | Sets slowmode, 0 turns it off |
|
||||||
|
|
||||||
|
## Timezone and scheduling
|
||||||
|
|
||||||
|
Anyone can use these.
|
||||||
|
|
||||||
|
| Command | Options | What it does |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `/timezone set` | `zone`* (IANA name, such as `Europe/Lisbon`) | Saves your timezone |
|
||||||
|
| `/timezone show` | | Shows it |
|
||||||
|
| `/schedule create` | | Opens a form (date, time, description) to request a session with a member |
|
||||||
|
| `/schedule list` | | Your upcoming sessions |
|
||||||
|
| `/schedule reschedule` | `id`* (from `/schedule list`), `datetime`* (UTC, `2006-01-02 15:04`) | Proposes a new time |
|
||||||
|
|
||||||
|
## Projects
|
||||||
|
|
||||||
|
| Command | Needs | What it does |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `/projects list` | | Active projects with creators and helpers |
|
||||||
|
| `/projects create` | Manage Server | Opens a form to create a project |
|
||||||
|
| `/projects add-helper` | Manage Server | Adds a helper to a project |
|
||||||
|
| `/projects close` | Manage Server | Closes a project |
|
||||||
|
|
||||||
|
## Server setup (`/config`)
|
||||||
|
|
||||||
|
Every subcommand needs **Manage Server**.
|
||||||
|
|
||||||
|
| Command | Options | What it does |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `/config setwelcomechannel` | `channel`* | Where welcome messages go |
|
||||||
|
| `/config setwelcomemessage` | `message`* | Welcome template. `{user}` is a mention, `{server}` the server name |
|
||||||
|
| `/config setwelcomedm` | `message`* | The welcome DM template |
|
||||||
|
| `/config setwelcomegif` | `url`* | Image or GIF for the welcome embed |
|
||||||
|
| `/config setdefaultrole` | `role`* | Role given on join |
|
||||||
|
| `/config setlogchannel` | `channel`* | Where logs go |
|
||||||
|
| `/config enablelogging` | | Turns logging on |
|
||||||
|
| `/config disablelogging` | | Turns it off |
|
||||||
|
| `/config addstreamer` | `username`* | Adds a Twitch streamer to watch |
|
||||||
|
| `/config removestreamer` | `username`* | Removes one |
|
||||||
|
| `/config settwitchnotificationchannel` | `channel`* | Where live alerts go |
|
||||||
|
|
||||||
|
## Tickets
|
||||||
|
|
||||||
|
| Command | Options | Needs | What it does |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| `/tickets setup` | `channel`*, `log-channel`, `staff-role` | Manage Server | Where tickets open and where closed ones are logged. `staff-role` creates a Support category if there are none yet |
|
||||||
|
| `/tickets category add` | `name`*, `staff-role`, `emoji`, `description` | Manage Server | Adds a category to the panel's dropdown |
|
||||||
|
| `/tickets category remove` | `name`* | Manage Server | Removes a category |
|
||||||
|
| `/tickets category list` | | Manage Server | Lists categories |
|
||||||
|
| `/tickets panel` | | Manage Server | Posts the panel, or updates it after changing categories |
|
||||||
|
| `/ticket add` | `user`* | The opener or staff | Adds someone to the ticket |
|
||||||
|
| `/ticket remove` | `user`* | Staff | Removes someone |
|
||||||
|
| `/ticket claim` | | Staff | Takes the ticket |
|
||||||
|
| `/ticket close` | `reason` | The opener or staff | Closes it and posts a transcript |
|
||||||
|
|
||||||
|
## Security
|
||||||
|
|
||||||
|
All of these are hidden from members without Manage Server (and `/lockdown` from those without Manage Channels), but **hiding is not the check**. The handlers check again, and some need the **server owner or someone on the trusted list** whatever Discord permissions a person has.
|
||||||
|
|
||||||
|
In this table "Manage Server" also lets Administrators and trusted members through.
|
||||||
|
|
||||||
|
| Command | Options | Needs | What it does |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| `/security status` | | Manage Server | What is on, and who is trusted |
|
||||||
|
| `/security toggle` | `feature`* (Join Gate, Raid mode, Anti-nuke, Heat), `on`* | Manage Server to turn on; owner or trusted to turn off | Turns a protection on or off |
|
||||||
|
| `/security alerts` | `channel`*, `role` | Owner or trusted | Alert channel and the role to ping |
|
||||||
|
| `/security quarantine-role` | `role` | Owner or trusted | Role given to quarantined members (empty for none) |
|
||||||
|
| `/security trust add` | `user` or `role` | Owner only | Exempts a user or role from anti-nuke |
|
||||||
|
| `/security trust remove` | `user` or `role` | Owner only | Removes that exemption |
|
||||||
|
| `/security quarantined` | | Manage Server | Lists quarantined members |
|
||||||
|
| `/security release` | `user`* | Owner or trusted | Releases a member and gives their roles back |
|
||||||
|
| `/security end-raid` | | Owner or trusted | Ends raid mode now |
|
||||||
|
| `/security snapshot` | | Manage Server | Saves roles and channels |
|
||||||
|
| `/security restore` | | Owner or trusted | Recreates deleted roles and channels from the latest snapshot |
|
||||||
|
| `/lockdown channel` | `channel` (default: this one) | Manage Channels | Locks a channel |
|
||||||
|
| `/lockdown server` | | Manage Channels | Locks every channel |
|
||||||
|
| `/lockdown joins` | `action`* (Kick or Ban) | Manage Channels | Kicks or bans new members until unlocked |
|
||||||
|
| `/unlock channel` | `channel` | Owner or trusted | Unlocks a channel |
|
||||||
|
| `/unlock server` | | Owner or trusted | Unlocks every channel |
|
||||||
|
| `/unlock joins` | | Owner or trusted | Lets people join again |
|
||||||
|
|
||||||
|
## Beta
|
||||||
|
|
||||||
|
| Command | Needs | What it does |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `/beta` | The bot's owner | Shows how beta access is set up. Registered in the beta server only |
|
||||||
|
|
||||||
|
Beta features come and go. See [Beta features](beta-features.md).
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
# Database
|
||||||
|
|
||||||
|
The bot uses PostgreSQL through `database/sql` with the pgx driver. All SQL lives in repos under `internal/db/repos`.
|
||||||
|
|
||||||
|
## Who owns the schema
|
||||||
|
|
||||||
|
The bot and the dashboard API share one database, so two files describe it:
|
||||||
|
|
||||||
|
- **`schema.sql`** in this repository: the tables the bot reads and writes. It is safe to run more than once (`CREATE TABLE IF NOT EXISTS`). It is enough to run the bot **on its own**.
|
||||||
|
- **The API's migrations** (`velox-dashboard-api/cmd/db/migrations`): when the API is deployed, it creates and changes the tables, and runs its migrations on start. The bot never runs migrations.
|
||||||
|
|
||||||
|
Some tables are older and were created by the bot (levels, welcome, and so on). The API's migration `000005_bot_owned_tables` creates them for a fresh combined database. Newer modules (music, tickets, security, meeting lobbies, beta settings) were created by API migrations, and `schema.sql` carries a copy so the bot can run alone.
|
||||||
|
|
||||||
|
**The rule:** a table must have the same shape in `schema.sql` and in the API migrations. When you change one, change the other in the same release.
|
||||||
|
|
||||||
|
Two things only exist in the API's migrations, because the bot never inserts into those tables:
|
||||||
|
|
||||||
|
- the `NOTIFY` triggers on the three `*_commands` tables (see below),
|
||||||
|
- the migration history.
|
||||||
|
|
||||||
|
## Tables
|
||||||
|
|
||||||
|
| Area | Tables | Notes |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Leveling | `levels`, `levelsettings`, `levelrewards`, `levelup` | XP and level per member, settings, role rewards, the level-up channel |
|
||||||
|
| Welcome | `welcome`, `defaultrole` | Welcome channel, templates, GIF, default role |
|
||||||
|
| Logging | `logsettings` | Log channel and on/off |
|
||||||
|
| Twitch | `twitch`, `twitch_config` | Streamers and the notification channel |
|
||||||
|
| Fun | `rps` | Rock-paper-scissors stats |
|
||||||
|
| Meeting rooms | `meeting_lobbies`, `meeting_temp_channels`, `meeting_settings` | Lobbies (10 per server, enforced by a trigger), the temporary rooms and who created them. `meeting_settings.lobby_channel_id` is the old single lobby column and is no longer read |
|
||||||
|
| Projects | `projects`, `project_members` | |
|
||||||
|
| Scheduling | `schedules`, `schedule_messages`, `user_settings` | Sessions, the DM messages to update, and each member's timezone |
|
||||||
|
| Music | `music_settings`, `music_now_playing`, `music_queue`, `music_commands` | State for the dashboard's player, plus requests from the dashboard |
|
||||||
|
| Tickets | `ticket_settings`, `ticket_categories`, `tickets`, `ticket_commands` | |
|
||||||
|
| Security | `security_settings`, `security_trusted`, `security_quarantines`, `security_lockdowns`, `security_raids`, `security_raid_caught`, `security_snapshots`, `security_events`, `security_commands` | Settings, who is trusted, quarantines (with the roles to give back), locked channels (with the permission to restore), raids in progress, snapshots, an event history, and dashboard requests |
|
||||||
|
| Beta | `beta_settings` | One row: the beta server and the Beta Tester role. Written by the dashboard, read by the bot |
|
||||||
|
|
||||||
|
Discord IDs are `BIGINT` (snowflakes fit in 64 bits). In Go they are `int64`; Discord's own API gives them to you as strings, so convert at the edge.
|
||||||
|
|
||||||
|
## Dashboard to bot: settings and requests
|
||||||
|
|
||||||
|
There are two kinds of traffic from the dashboard, and the difference matters.
|
||||||
|
|
||||||
|
**Settings.** The dashboard writes a row, and the bot reads it when it next needs it. Nothing wakes the bot up. Hot paths cache settings for a short time. The bot's beta settings are polled every 30 seconds.
|
||||||
|
|
||||||
|
**Requests that need the bot to act.** `music_commands`, `ticket_commands` and `security_commands` work as a small queue:
|
||||||
|
|
||||||
|
1. The dashboard API inserts a row (`command_type`, a JSON `payload`, `requested_by`, `processed_at` empty).
|
||||||
|
2. A trigger in the database runs `pg_notify('<table>', id)`.
|
||||||
|
3. The bot holds one connection that ran `LISTEN <table>`. It wakes, loads **every** unprocessed row, carries each out, and sets `processed_at`.
|
||||||
|
|
||||||
|
Because the bot loads all unprocessed rows (also when it starts), nothing is lost if it was down when a request arrived. A command that fails is logged and marked processed anyway, since retrying would fail the same way.
|
||||||
|
|
||||||
|
Every listener **validates the request again**. The API checks that the requester is allowed, and the bot checks too, because it should not trust a row just because it exists. The listeners live in `internal/music/listener.go`, `internal/tickets/listener.go` and `internal/security/listener.go`, and each reconnects after 10 seconds if its connection drops.
|
||||||
|
|
||||||
|
## Changing the schema
|
||||||
|
|
||||||
|
1. Decide who owns the table (see above). New tables for the dashboard's modules are created by an API migration.
|
||||||
|
2. Write the API migration, **and** update `schema.sql` to match.
|
||||||
|
3. Add or change the repo method in `internal/db/repos/<area>repo`. Use `IF NOT EXISTS` and avoid destructive changes: the bot and the dashboard may be deployed a few minutes apart, so the old bot must keep working against the new schema for a moment. Add a column or table first, and remove old ones in a later release.
|
||||||
|
4. If the dashboard must make the bot do something, add a `command_type` to the `CHECK` in the right `*_commands` table and handle it in the listener.
|
||||||
|
5. Say in the release notes if the API, bot and dashboard have to deploy together.
|
||||||
|
|
||||||
|
## Connection settings
|
||||||
|
|
||||||
|
`internal/db/db.go` opens the pool with up to 100 open and 10 idle connections, and recycles them after an hour. The listeners use their own separate connections, because `LISTEN` needs one that stays open.
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
# Deployment
|
||||||
|
|
||||||
|
## Docker
|
||||||
|
|
||||||
|
The `Dockerfile` is a two-stage build: it compiles a static binary with Go, then copies it into a small Alpine image (with CA certificates and timezone data, which `/timezone` and scheduling need).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker build -t velox-bot .
|
||||||
|
docker run --env-file .env velox-bot
|
||||||
|
```
|
||||||
|
|
||||||
|
The container reads its configuration from environment variables, exactly like a local run. See [Getting started](getting-started.md#2-configure-the-environment).
|
||||||
|
|
||||||
|
## Docker Compose
|
||||||
|
|
||||||
|
`docker-compose.yml` defines two services:
|
||||||
|
|
||||||
|
- `db`: PostgreSQL 16 with a named volume (`velox_pgdata`) and a health check.
|
||||||
|
- `bot`: the bot, built from this directory, started after the database is healthy. It takes `.env` through `env_file`, and defaults `DB_HOST` to the `db` service and `LAVALINK_HOST` to `ws://lavalink:2333` if you have not set them.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose up -d # database and bot
|
||||||
|
docker compose logs -f bot
|
||||||
|
```
|
||||||
|
|
||||||
|
Compose does not include Lavalink. Run it separately (or add a service) if you want music.
|
||||||
|
|
||||||
|
Change the default database password (`velox_pwd`) before exposing PostgreSQL to anything other than your own machine, and remove the published `5432` port if only the bot needs it.
|
||||||
|
|
||||||
|
## Running next to the dashboard
|
||||||
|
|
||||||
|
If you also run `velox-dashboard-api` and `velox-dashboard-web`:
|
||||||
|
|
||||||
|
1. They all use the **same database**. Give each the same PostgreSQL, and point `DB_HOST` (bot) and the API's `DB_ADDR` at it.
|
||||||
|
2. The API runs the migrations when it starts. The bot does not run migrations.
|
||||||
|
3. **Deploy order for changes that touch the database:** API first (it applies the migration), then the bot and the dashboard.
|
||||||
|
|
||||||
|
Some changes need the API, the bot and the dashboard to go out together. For example, when a table the dashboard writes changes shape, an old dashboard talking to a new API fails. The release notes for such a change say so.
|
||||||
|
|
||||||
|
## Updating
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git pull
|
||||||
|
docker compose build bot
|
||||||
|
docker compose up -d bot
|
||||||
|
```
|
||||||
|
|
||||||
|
Slash commands are re-registered on every start, so new and changed commands appear after a restart. Commands you removed from the code are not deleted from Discord automatically, except for the beta server (see [Beta features](beta-features.md)).
|
||||||
|
|
||||||
|
## Backups
|
||||||
|
|
||||||
|
All state is in PostgreSQL. Back it up with `pg_dump`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pg_dump "postgres://velox:velox_pwd@localhost:5432/velox" > velox-backup.sql
|
||||||
|
```
|
||||||
|
|
||||||
|
Raid mode, quarantines, lockdowns and ticket state live in the database, so the bot picks them up again after a restart.
|
||||||
|
|
||||||
|
## Shutting down
|
||||||
|
|
||||||
|
Send `SIGINT` or `SIGTERM` (Docker does on `docker stop`). Slash commands stay registered in Discord while the bot is down, and are registered again (updated in place) on the next start.
|
||||||
@@ -0,0 +1,298 @@
|
|||||||
|
# Development guide
|
||||||
|
|
||||||
|
How to change the bot and how to add to it. Read [Architecture](architecture.md) first if you have not: it explains the layers this page keeps referring to.
|
||||||
|
|
||||||
|
- [Daily workflow](#daily-workflow)
|
||||||
|
- [Add a simple command](#add-a-simple-command)
|
||||||
|
- [Add a subcommand](#add-a-subcommand)
|
||||||
|
- [Command options and permissions](#command-options-and-permissions)
|
||||||
|
- [Buttons, select menus and forms](#buttons-select-menus-and-forms)
|
||||||
|
- [Add a feature that stores settings](#add-a-feature-that-stores-settings)
|
||||||
|
- [React to a gateway event](#react-to-a-gateway-event)
|
||||||
|
- [Add a background job](#add-a-background-job)
|
||||||
|
- [Add an environment variable](#add-an-environment-variable)
|
||||||
|
- [Make a command beta](#make-a-command-beta)
|
||||||
|
- [Testing](#testing)
|
||||||
|
- [Style and safety rules](#style-and-safety-rules)
|
||||||
|
- [Checklist before a pull request](#checklist-before-a-pull-request)
|
||||||
|
|
||||||
|
## Daily workflow
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose up -d db # PostgreSQL
|
||||||
|
air # rebuild and restart on every change
|
||||||
|
```
|
||||||
|
|
||||||
|
Set `GUILD_ID` to a test server in `.env`, so commands update within seconds. Before pushing:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
gofmt -l .
|
||||||
|
go build ./... && go vet ./... && go test ./...
|
||||||
|
```
|
||||||
|
|
||||||
|
Some older files are not gofmt-clean. Format the files you touch, and leave the others alone so reviews stay readable.
|
||||||
|
|
||||||
|
## Add a simple command
|
||||||
|
|
||||||
|
A command is a definition (what Discord shows) plus a handler (what runs). Each feature has a package under `internal/commands/<feature>`, with this shape:
|
||||||
|
|
||||||
|
```
|
||||||
|
internal/commands/fun/
|
||||||
|
registry.go re-exports the commands and handlers of the feature
|
||||||
|
public/ the definitions and handlers
|
||||||
|
ping.go
|
||||||
|
shared/ helpers used by several commands of the feature
|
||||||
|
```
|
||||||
|
|
||||||
|
Example: a `/hello` command in the `fun` feature.
|
||||||
|
|
||||||
|
**1. The definition and handler**, in `internal/commands/fun/public/hello.go`:
|
||||||
|
|
||||||
|
```go
|
||||||
|
package public
|
||||||
|
|
||||||
|
import "github.com/bwmarrin/discordgo"
|
||||||
|
|
||||||
|
var Hello = &discordgo.ApplicationCommand{
|
||||||
|
Name: "hello",
|
||||||
|
Description: "Say hello",
|
||||||
|
}
|
||||||
|
|
||||||
|
func HelloHandler(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
_ = s.InteractionRespond(i.Interaction, &discordgo.InteractionResponse{
|
||||||
|
Type: discordgo.InteractionResponseChannelMessageWithSource,
|
||||||
|
Data: &discordgo.InteractionResponseData{Content: "Hello!"},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**2. Re-export it**, in `internal/commands/fun/registry.go`:
|
||||||
|
|
||||||
|
```go
|
||||||
|
var Hello *discordgo.ApplicationCommand = public.Hello
|
||||||
|
|
||||||
|
func HelloHandler(s *discordgo.Session, i *discordgo.InteractionCreate) { public.HelloHandler(s, i) }
|
||||||
|
```
|
||||||
|
|
||||||
|
**3. Register it**, in `internal/commands/commands.go`: add `fun.Hello` to `AllCommands`, and `"hello": fun.HelloHandler` to the `handlers` map. The key is the command's name. A command that is in `AllCommands` but not in `handlers` is shown in Discord and then does nothing.
|
||||||
|
|
||||||
|
**4. Restart the bot.** It re-registers all commands on start.
|
||||||
|
|
||||||
|
**5. Document it:** add it to `/help` (`internal/commands/help/help.go`) and to the [Command reference](commands.md).
|
||||||
|
|
||||||
|
Names must be lowercase, up to 32 characters, and unique. Descriptions are required and limited to 100 characters.
|
||||||
|
|
||||||
|
For an entirely new feature, create a new package with the same shape, and import it in `commands.go`.
|
||||||
|
|
||||||
|
## Add a subcommand
|
||||||
|
|
||||||
|
A command with subcommands (like `/meeting`) lists them in `Options`, and its handler switches on the name of the first option. Add the subcommand to the definition:
|
||||||
|
|
||||||
|
```go
|
||||||
|
{
|
||||||
|
Type: discordgo.ApplicationCommandOptionSubCommand,
|
||||||
|
Name: "lobbies",
|
||||||
|
Description: "List this server's meeting lobbies",
|
||||||
|
},
|
||||||
|
```
|
||||||
|
|
||||||
|
and a case to the handler's switch:
|
||||||
|
|
||||||
|
```go
|
||||||
|
switch data.Options[0].Name {
|
||||||
|
case "lobbies":
|
||||||
|
handleListLobbies(s, i)
|
||||||
|
// ...
|
||||||
|
default:
|
||||||
|
shared.RespondEphemeral(s, i, "Unknown subcommand.")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Keep one `handleX` function per subcommand. For a group (`/tickets category add`), the first option is the group and its first option is the subcommand.
|
||||||
|
|
||||||
|
## Command options and permissions
|
||||||
|
|
||||||
|
**Options** go in the definition's `Options` (or in a subcommand's). Types are `String`, `Integer`, `Boolean`, `User`, `Channel`, `Role`, `Number`, and others. A channel option can be limited with `ChannelTypes`. A string can offer fixed `Choices`.
|
||||||
|
|
||||||
|
Inside a subcommand, `shared.SubcommandOptionMap(i)` (in the meeting, level and other `shared` packages) turns the options into a map by name:
|
||||||
|
|
||||||
|
```go
|
||||||
|
opts := shared.SubcommandOptionMap(i)
|
||||||
|
channel := opts["channel"].ChannelValue(s) // *discordgo.Channel
|
||||||
|
```
|
||||||
|
|
||||||
|
**Where a command may be used.** `Contexts` lists where Discord offers it (`InteractionContextGuild`, `InteractionContextBotDM`, `InteractionContextPrivateChannel`). A server-only command should also refuse politely if `i.GuildID == ""`: the shared packages have `RequireGuild` for this.
|
||||||
|
|
||||||
|
**Who may use it.** There are two layers, and you need both:
|
||||||
|
|
||||||
|
1. `DefaultMemberPermissions` on the definition only decides who **sees** the command in Discord's menu. Server admins can change it in their settings, so it is not security.
|
||||||
|
2. The handler must check again, using `i.Member.Permissions`. The shared packages have helpers such as `RequireManageGuild`. Moderation uses `hasPerm(i, discordgo.PermissionKickMembers)` and so on.
|
||||||
|
|
||||||
|
For anything where a mistake hurts (security settings, anything destructive), check the **owner or trusted list** as well, as `internal/commands/security` does with `allowedOrTrusted`. Do not rely on Discord's permissions alone.
|
||||||
|
|
||||||
|
**Responses.**
|
||||||
|
|
||||||
|
- Answer within three seconds. If a command takes longer, respond with `InteractionResponseDeferredChannelMessageWithSource` first, then edit the response with `InteractionResponseEdit`.
|
||||||
|
- Use `Flags: discordgo.MessageFlagsEphemeral` for replies only the user should see (errors, settings). `shared.RespondEphemeral` does this.
|
||||||
|
- When the message contains user-controlled text, set `AllowedMentions: &discordgo.MessageAllowedMentions{}` so it cannot ping anyone.
|
||||||
|
|
||||||
|
## Buttons, select menus and forms
|
||||||
|
|
||||||
|
Components and modals carry a **custom ID**, and the dispatcher routes them by prefix (`internal/commands/commands.go`, `HandleInteraction`). To add one to a feature:
|
||||||
|
|
||||||
|
1. Use the feature's prefix when you build the component: `CustomID: "projects:close:" + id`. Put whatever you need in the ID after the prefix, split with `:`.
|
||||||
|
2. The dispatcher already sends `music:`, `schedule:`, `projects:`, `tickets:` and `security:` to that feature's `HandleComponent`, and `schedule:`, `projects:`, `tickets:` modals to its `HandleModalSubmit`.
|
||||||
|
3. In `HandleComponent`, parse the rest of the ID, check permissions **again** (the button may be clicked by anyone who can see the message), and respond.
|
||||||
|
|
||||||
|
For a **new prefix**, add a case to the `switch` in `HandleInteraction`, and write `HandleComponent` and/or `HandleModalSubmit` in your feature.
|
||||||
|
|
||||||
|
Custom IDs are limited to 100 characters, and a modal can have up to five inputs.
|
||||||
|
|
||||||
|
Never trust the contents of a custom ID. A user cannot edit it, but old messages stay around with old IDs, and IDs may refer to things that no longer exist.
|
||||||
|
|
||||||
|
## Add a feature that stores settings
|
||||||
|
|
||||||
|
The usual path is table, repo, service, command. The meeting-room lobbies are a complete small example (`/meeting add-lobby`).
|
||||||
|
|
||||||
|
**1. The table.** Add it to `schema.sql`, and to an API migration if the dashboard will show it (see [Database](database.md#changing-the-schema)).
|
||||||
|
|
||||||
|
**2. The repo**, in `internal/db/repos/<area>repo/repo.go`. SQL only, returning plain Go values:
|
||||||
|
|
||||||
|
```go
|
||||||
|
func (r *Repo) ListMeetingLobbies(ctx context.Context, guildID int64) ([]int64, error) {
|
||||||
|
rows, err := r.db.QueryContext(ctx,
|
||||||
|
`SELECT channel_id FROM meeting_lobbies WHERE guild_id = $1 ORDER BY created_at`, guildID)
|
||||||
|
// ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Always pass values as parameters (`$1`), never build SQL with string formatting.
|
||||||
|
|
||||||
|
**3. The service**, in `internal/db/services/<area>/service.go`. It wraps the repo and holds the rules (limits, defaults, validation):
|
||||||
|
|
||||||
|
```go
|
||||||
|
type Service struct{ settings *settingsrepo.Repo }
|
||||||
|
|
||||||
|
func New(settings *settingsrepo.Repo) *Service { return &Service{settings: settings} }
|
||||||
|
```
|
||||||
|
|
||||||
|
**4. Wire it up.** Add a field to `services.Services` and the constructor in `internal/db/services/services.go`, and build the repo and service in `main.go` next to the others.
|
||||||
|
|
||||||
|
**5. Use it from the command**, through `services.Global`:
|
||||||
|
|
||||||
|
```go
|
||||||
|
if services.Global == nil || services.Global.Meeting == nil {
|
||||||
|
shared.RespondEphemeral(s, i, "Meeting service is not available.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
added, err := services.Global.Meeting.AddLobby(ctx, guildID, channelID)
|
||||||
|
```
|
||||||
|
|
||||||
|
**6. Enforce limits in the database when you can.** The 10-lobby limit is a trigger, so the bot and the dashboard cannot disagree and two simultaneous requests cannot both slip through.
|
||||||
|
|
||||||
|
**7. Default to off.** A module that does something to a server without being asked (posts messages, moderates, grants roles) must start disabled and be turned on by an admin.
|
||||||
|
|
||||||
|
## React to a gateway event
|
||||||
|
|
||||||
|
1. Write the function in `internal/events/`, taking the session, the event and the services:
|
||||||
|
|
||||||
|
```go
|
||||||
|
func HandleChannelDelete(_ *discordgo.Session, c *discordgo.ChannelDelete, svc *services.Services) { ... }
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Register it in `bot.Start()` (`internal/bot/bot.go`):
|
||||||
|
|
||||||
|
```go
|
||||||
|
b.Session.AddHandler(func(s *discordgo.Session, c *discordgo.ChannelDelete) {
|
||||||
|
events.HandleChannelDelete(s, c, b.Services)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Check that the **intent** for that event is enabled in `NewBot`. Events from an intent you did not ask for never arrive. Privileged intents must also be enabled in the developer portal.
|
||||||
|
|
||||||
|
Handlers run concurrently on goroutines. Do not share unsynchronised state, and do not block: slow work belongs in its own goroutine.
|
||||||
|
|
||||||
|
If the event is something security cares about (joins, messages, audit log), look at how `bot.go` calls the security engine **before** your handler.
|
||||||
|
|
||||||
|
## Add a background job
|
||||||
|
|
||||||
|
Follow `StartScheduleReminderLoop` in `internal/events/schedule_reminders.go`: a function that returns immediately and starts a goroutine with a ticker.
|
||||||
|
|
||||||
|
```go
|
||||||
|
func StartMyLoop(s *discordgo.Session, svc *services.Services) {
|
||||||
|
if svc == nil || svc.Thing == nil || s == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
go func() {
|
||||||
|
time.Sleep(10 * time.Second) // let the bot finish starting
|
||||||
|
ticker := time.NewTicker(time.Minute)
|
||||||
|
defer ticker.Stop()
|
||||||
|
for range ticker.C {
|
||||||
|
// check, act, log errors, never panic
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Call it at the end of `bot.Start()`. Log errors instead of returning them, and make one failing server not stop the loop for the others.
|
||||||
|
|
||||||
|
## Add an environment variable
|
||||||
|
|
||||||
|
1. Add a field to `Config` and read it in `LoadConfig()` (`internal/config/config.go`). Return an error if the bot cannot work without it.
|
||||||
|
2. Document it in [Getting started](getting-started.md#2-configure-the-environment).
|
||||||
|
3. Pass it where it is needed from `main.go`.
|
||||||
|
|
||||||
|
Never log a secret, and never put one in a message to a user.
|
||||||
|
|
||||||
|
Use an environment variable for deployment settings (tokens, hosts). Settings an admin or owner should change at runtime belong in the database and on the dashboard instead. That is how the beta settings work.
|
||||||
|
|
||||||
|
## Make a command beta
|
||||||
|
|
||||||
|
Register it with `commands.RegisterBeta` instead of adding it to `AllCommands` and `handlers`. See [Beta features](beta-features.md).
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go test ./... # unit tests, no database needed
|
||||||
|
go test -race ./... # recommended before a pull request
|
||||||
|
```
|
||||||
|
|
||||||
|
Where the code allows it, the Discord and database calls go through small interfaces, so flows can be tested with fakes. `internal/tickets` and `internal/security` are the models: look at their `fakes_test.go`.
|
||||||
|
|
||||||
|
Tests that need a real PostgreSQL are behind the `integration` build tag and skip themselves when their environment variable is missing:
|
||||||
|
|
||||||
|
| Package | Variable |
|
||||||
|
| --- | --- |
|
||||||
|
| `internal/db/repos/settingsrepo` | `TEST_DB` |
|
||||||
|
| `internal/db/repos/ticketrepo`, `internal/tickets` | `TICKETS_TEST_DB` |
|
||||||
|
| `internal/db/repos/securityrepo` | `SECURITY_TEST_DB` |
|
||||||
|
|
||||||
|
```bash
|
||||||
|
TEST_DB="postgres://velox:velox_pwd@localhost:5432/velox?sslmode=disable" \
|
||||||
|
go test -tags integration ./internal/db/repos/settingsrepo
|
||||||
|
```
|
||||||
|
|
||||||
|
Use a throwaway database for these, not one with real data. The tables must already exist (load `schema.sql`).
|
||||||
|
|
||||||
|
Good things to test: permission checks (does the wrong person get refused?), limits, anything that parses user input, and "what if the service or the database fails".
|
||||||
|
|
||||||
|
## Style and safety rules
|
||||||
|
|
||||||
|
- **One feature per package, SQL only in repos, rules in services.** Commands never contain SQL.
|
||||||
|
- **Match the code around you**: naming, comment density, error handling. Comments explain *why*, not *what*.
|
||||||
|
- **Fail closed.** If you cannot tell whether someone is allowed, they are not.
|
||||||
|
- **Validate everything that comes from a user or the dashboard**: option values, custom IDs, `payload` JSON in command rows.
|
||||||
|
- **Escape user text** in messages, and set `AllowedMentions` so it cannot ping.
|
||||||
|
- **Bound everything per server**: caches, lists, loops. One server must not be able to use unlimited memory.
|
||||||
|
- **Do not leak internals** to users: reply with a short message, log the detail.
|
||||||
|
- **Idempotent writes**: use `ON CONFLICT` for "add" operations, so double clicks and retries are harmless.
|
||||||
|
- Handle the bot being **restarted at any time**. State that must survive (raid mode, quarantines) lives in the database.
|
||||||
|
|
||||||
|
## Checklist before a pull request
|
||||||
|
|
||||||
|
- [ ] `gofmt` on the files you touched, `go build ./...`, `go vet ./...`, `go test -race ./...`
|
||||||
|
- [ ] Commands: in `AllCommands` and `handlers`, permission check in the handler, ephemeral errors
|
||||||
|
- [ ] New table: in `schema.sql` **and** in an API migration, with a note about deploy order
|
||||||
|
- [ ] Module that acts on a server: off by default
|
||||||
|
- [ ] `/help`, [Command reference](commands.md) and [Features](features.md) updated
|
||||||
|
- [ ] No secrets, tokens or personal IDs in code, logs or tests
|
||||||
@@ -0,0 +1,120 @@
|
|||||||
|
# Features
|
||||||
|
|
||||||
|
What each module does and how it behaves. For the exact options of every command, see the [Command reference](commands.md). To change how a module works, see the [Development guide](development.md).
|
||||||
|
|
||||||
|
Unless a section says otherwise, a module is **off** in a new server and a server admin turns it on.
|
||||||
|
|
||||||
|
## Security
|
||||||
|
|
||||||
|
Anti-raid and anti-nuke, modelled on Wick. Code: `internal/security`, commands in `internal/commands/security`.
|
||||||
|
|
||||||
|
**Join Gate** checks every new member: no avatar, account too new, invite links or blocked words in the name, unverified bots. Each check has its own action. It also removes bots added by anyone who is not trusted.
|
||||||
|
|
||||||
|
**Raid mode** starts when many members join in a short time. Raiders are timed out, kicked or banned, invites can be paused, staff are alerted, and raid mode ends after a quiet period or when staff end it with `/security end-raid`. It survives a bot restart: the quiet timer carries on and the summary still lists everyone caught.
|
||||||
|
|
||||||
|
**Anti-nuke** counts destructive actions per person from the audit log: deleting channels or roles, mass bans and kicks, creating webhooks, granting dangerous permissions. Someone who is not the owner or trusted and goes over a limit is **quarantined**: their roles are removed and saved, and they are timed out. `/security release` gives every role back.
|
||||||
|
|
||||||
|
**Lockdown** (`/lockdown`, `/unlock`) locks one channel, every channel, or joins. Unlocking puts back exactly the permission overwrite that was there before.
|
||||||
|
|
||||||
|
**Snapshots** save the server's roles and channels. They are taken every 6 hours while anti-nuke is on (the last three are kept) and on request with `/security snapshot`. `/security restore` recreates deleted roles and channels and reverts dangerous permission changes. It can also run automatically after a stopped nuke.
|
||||||
|
|
||||||
|
**Heat** is the anti-spam system. Each member has a score that rises with messages and cools over time. Spam, repeats, mass mentions and invite links max it, which deletes the message and times the member out (the timeout doubles for repeat offences). A wave of spammers turns on *heat panic* (newcomers are timed out on sight for 10 minutes), and a mention flood can lock the server. Members with Manage Messages and trusted members are exempt.
|
||||||
|
|
||||||
|
**Alerts** go to a channel you choose, and critical ones (raids, stopped nukes, restores, spam waves, removed bots) are also DMed to the owner and trusted users, because the alert channel may be the first thing a nuker deletes. One setting turns the DMs off.
|
||||||
|
|
||||||
|
Rules that hold everywhere in this module:
|
||||||
|
|
||||||
|
- Turning protection off, changing limits, releasing a quarantine and unlocking need the **server owner or someone on the trusted list**. Editing the trusted list needs the owner. Discord's own command permissions are never relied on, because admins can change them.
|
||||||
|
- The owner and the bot are never punished.
|
||||||
|
- Roles that are configured (such as the quarantine role) are checked when they are used, not only when saved. A quarantine role that gained dangerous permissions is not assigned.
|
||||||
|
- Messages ping only the configured alert role, and names are escaped.
|
||||||
|
|
||||||
|
Thresholds, Join Gate filters and heat settings are set on the dashboard. The bot's role must be above the roles it protects against: it can only quarantine members whose highest role is below its own.
|
||||||
|
|
||||||
|
## Tickets
|
||||||
|
|
||||||
|
Support tickets in private threads. Code: `internal/tickets`, commands in `internal/commands/tickets`.
|
||||||
|
|
||||||
|
1. An admin runs `/tickets setup`, adds categories with `/tickets category add` (each with its own staff role), and posts the panel with `/tickets panel`.
|
||||||
|
2. The panel has a category dropdown and a **Create ticket** button. A short form asks what the ticket is about.
|
||||||
|
3. A **private thread** is created in the ticket channel. The opener and the category's staff role can see it.
|
||||||
|
4. Staff can `/ticket claim`. Anyone involved can `/ticket add` someone, staff can `/ticket remove`, and the opener or staff can `/ticket close [reason]`.
|
||||||
|
5. Closing locks and archives the thread and posts a **transcript** to the log channel.
|
||||||
|
|
||||||
|
The bot needs View Channel, Send Messages, Embed Links, Create Private Threads, Send Messages in Threads and Manage Threads in the ticket channel, and Attach Files in the log channel. Give the staff role Manage Threads there too, so staff see every ticket.
|
||||||
|
|
||||||
|
The flows go through small interfaces for Discord and the database, so they are tested without either. The slash commands and buttons only translate interactions into those calls.
|
||||||
|
|
||||||
|
## Moderation
|
||||||
|
|
||||||
|
`/moderation` with `purge`, `timeout`, `kick`, `ban`, `unban`, `untimeout` and `slowmode`. Each subcommand checks the matching Discord permission in the handler (Manage Messages, Moderate Members, Kick Members, Ban Members, Manage Channels). Durations accept `10m`, `1h`, `2h30m` and so on, up to 28 days. Actions are written to the log channel if logging is on.
|
||||||
|
|
||||||
|
## Logging
|
||||||
|
|
||||||
|
When enabled with `/config enablelogging` and a channel set with `/config setlogchannel`, the bot logs edited and deleted messages, joins and leaves, member and role updates, bans and unbans, and moderation actions. Code: `internal/events/logging.go` and `internal/modlog`.
|
||||||
|
|
||||||
|
## Leveling
|
||||||
|
|
||||||
|
Opt in per server with `/slvl toggle`. Code: `internal/db/services/level` (the rules) and `internal/events/event_handlers.go` (the message handler).
|
||||||
|
|
||||||
|
- Every message may give 1 to 3 XP. Below level 5 every message counts. From level 5 on, a message counts with a chance of 1 in `level / 4`, so leveling slows down.
|
||||||
|
- 100 XP makes a level, and XP resets to 0.
|
||||||
|
- A level-up posts the level-up message (set with `/slvl set-message`, variables `{user}` and `{level}`) in the channel chosen with `/slvl set-channel`, or in the channel of the message.
|
||||||
|
- `/slvl set-reward` gives a role at a level. `/rank` draws a rank card (`internal/rankcard`), `/leaderboard` shows the top 10 and `/rewards` lists role rewards.
|
||||||
|
|
||||||
|
## Music
|
||||||
|
|
||||||
|
Lavalink-powered playback. Code: `internal/music`, commands in `internal/commands/music`.
|
||||||
|
|
||||||
|
- `/play` takes a name or a URL, `/queue` shows the queue, `/volume` sets 0 to 150 percent. These need a role called **DJ**.
|
||||||
|
- The now-playing message has buttons for playback and repeat. Buttons also check for the DJ role.
|
||||||
|
- `/music toggle` (Manage Server) turns music on or off in a server.
|
||||||
|
- The dashboard shows the queue and can control playback. It does so through the `music_commands` table and a `NOTIFY` (see [Database](database.md)).
|
||||||
|
- Music needs a Lavalink server. Without `LAVALINK_HOST` the rest of the bot works and music does not.
|
||||||
|
|
||||||
|
## Meeting rooms
|
||||||
|
|
||||||
|
Join a **lobby** voice channel and get your own temporary room. Code: `internal/events/meeting_voice.go`, commands in `internal/commands/meeting`.
|
||||||
|
|
||||||
|
- A server can have up to **10 lobbies** (`/meeting add-lobby`, `remove-lobby`, `lobbies`). The limit is enforced by a database trigger, so the bot and the dashboard obey the same rule.
|
||||||
|
- When someone joins a lobby, the bot creates a voice channel in the same category with the lobby's user limit and bitrate, named after the lobby and the time, and moves the member in.
|
||||||
|
- When the temporary room is empty, it is deleted.
|
||||||
|
- If a lobby channel is deleted in Discord, it is dropped from the lobbies.
|
||||||
|
- `/meeting lock`, `lock-private` (also hides the room), `unlock`, `invite` and `uninvite` act on the room you are in. Every `/meeting` subcommand, including these, currently needs **Manage Server**.
|
||||||
|
|
||||||
|
## Scheduling and timezones
|
||||||
|
|
||||||
|
1:1 sessions between two members. Code: `internal/commands/schedule`, `internal/db/services/schedule`, reminders in `internal/events/schedule_reminders.go`.
|
||||||
|
|
||||||
|
- Each member sets a timezone with `/timezone set` (an IANA name such as `Europe/Lisbon`).
|
||||||
|
- `/schedule create` opens a form (date, time in your timezone, optional description) and DMs the other member a request with **Accept**, **Decline** and **Propose different time** buttons.
|
||||||
|
- `/schedule list` shows your upcoming sessions, and `/schedule reschedule` proposes a new time (in UTC, `2006-01-02 15:04`). The other side can accept or decline the proposal.
|
||||||
|
- Every minute, a loop DMs the participants of sessions starting within 10 minutes.
|
||||||
|
|
||||||
|
## Projects
|
||||||
|
|
||||||
|
A simple list of ongoing projects. `/projects create` opens a form (name, optional description), `/projects list` shows active projects with creators and helpers, `/projects add-helper` and `/projects close` manage them. Creating, adding helpers and closing need Manage Server.
|
||||||
|
|
||||||
|
## Welcome messages and default role
|
||||||
|
|
||||||
|
Set up with `/config` (Manage Server). Code: `internal/events/welcome.go`.
|
||||||
|
|
||||||
|
- A welcome message in a channel, and an optional DM, both templates where `{user}` becomes a mention and `{server}` the server name. An optional GIF or image URL goes in the welcome embed.
|
||||||
|
- A default role is granted when a member joins.
|
||||||
|
- Bots are skipped, and members the security engine removes get nothing.
|
||||||
|
|
||||||
|
## Twitch alerts
|
||||||
|
|
||||||
|
`/config addstreamer`, `removestreamer` and `settwitchnotificationchannel` (Manage Server). Every 30 seconds a loop checks each configured streamer and posts in the notification channel when one goes live. Code: `internal/events/twitch_live.go`. It needs `TWITCH_CLIENT_ID`.
|
||||||
|
|
||||||
|
## Onboarding
|
||||||
|
|
||||||
|
When the bot is added to a server, it applies safe defaults (modules off) and DMs setup instructions to the person who invited it, falling back to the server owner. Code: `internal/events/onboarding.go`.
|
||||||
|
|
||||||
|
## Fun
|
||||||
|
|
||||||
|
`/ping`, `/joke [type]`, `/coinflip`, `/dice` (expressions like `d20`, `2d20+1`, `2#d20+1`, parsed in `internal/diceexpr`), and `/rps` with `/rpsstats` and `/rpsleaderboard`.
|
||||||
|
|
||||||
|
## Help
|
||||||
|
|
||||||
|
`/help` DMs a command reference. The text is hand-written in `internal/commands/help/help.go`, so update it when you add or change a command.
|
||||||
@@ -0,0 +1,118 @@
|
|||||||
|
# Getting started
|
||||||
|
|
||||||
|
This page takes you from nothing to a bot running on your machine.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- **Go**: the version in `go.mod` (the Dockerfile builds with the same one).
|
||||||
|
- **PostgreSQL 16 or newer**: the included `docker-compose.yml` starts one for you.
|
||||||
|
- **A Discord application** with a bot user (see below).
|
||||||
|
- Optional: [Air](https://github.com/air-verse/air) for live reload, [Just](https://github.com/casey/just) for shortcuts, and a [Lavalink](https://github.com/lavalink-devs/Lavalink) server if you want music.
|
||||||
|
|
||||||
|
## 1. Create the Discord application
|
||||||
|
|
||||||
|
1. Open the [Discord developer portal](https://discord.com/developers/applications) and create an application. Copy its **Application ID**: this is `APP_ID`.
|
||||||
|
2. Under **Bot**, create the bot user and copy its token: this is `BOT_TOKEN`. Keep it secret.
|
||||||
|
3. Under **Bot**, switch on these **privileged gateway intents**: **Server Members Intent** (welcome messages, security) and **Message Content Intent** (leveling and spam detection). The bot also uses the non-privileged Guilds, Guild Moderation (bans and the audit log), Guild Messages, Guild Voice States and Direct Messages intents. You do not need to enable those by hand.
|
||||||
|
4. Invite the bot with the `bot` and `applications.commands` scopes. It needs these permissions, depending on which modules you use:
|
||||||
|
|
||||||
|
| Permission | Used by |
|
||||||
|
| --- | --- |
|
||||||
|
| View Channels, Send Messages, Embed Links, Attach Files | everything that posts, ticket transcripts |
|
||||||
|
| Read Message History, Manage Messages | moderation purge, spam heat |
|
||||||
|
| Manage Roles | default role, level rewards, quarantine |
|
||||||
|
| Manage Channels | lockdown, slowmode, meeting rooms, snapshot restore |
|
||||||
|
| Manage Server | pausing invites during a raid |
|
||||||
|
| Kick Members, Ban Members, Moderate Members | moderation commands, Join Gate, raid mode, anti-nuke |
|
||||||
|
| View Audit Log | anti-nuke, unauthorised bot detection |
|
||||||
|
| Create Private Threads, Send Messages in Threads, Manage Threads | tickets |
|
||||||
|
| Connect, Speak, Move Members | music, meeting rooms |
|
||||||
|
|
||||||
|
The bot's role must sit **above** the roles it manages or protects against. Discord does not let a bot change members whose highest role is higher than its own.
|
||||||
|
|
||||||
|
## 2. Configure the environment
|
||||||
|
|
||||||
|
The bot reads environment variables, and loads a `.env` file from the working directory if there is one (`internal/config/config.go`).
|
||||||
|
|
||||||
|
| Variable | Required | Meaning |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `BOT_TOKEN` | yes | The bot token. |
|
||||||
|
| `APP_ID` | yes | The application ID. |
|
||||||
|
| `GUILD_ID` | no | If set, slash commands are registered in this server only, and appear within seconds. If empty they are registered globally, which Discord can take up to an hour to show. Use a test server while developing. |
|
||||||
|
| `DB_HOST` | yes | A pgx connection string, for example `postgres://velox:velox_pwd@localhost:5432/velox?sslmode=disable`. |
|
||||||
|
| `TWITCH_CLIENT_ID` | yes | A Twitch client ID, used to check who is live. The bot refuses to start without it, even if you never use Twitch alerts. Any non-empty value works if you do not use them. |
|
||||||
|
| `LAVALINK_HOST` | no | Lavalink address, for example `ws://localhost:2333`. Leave empty to run without music. |
|
||||||
|
| `LAVALINK_PASSWORD` | no | Lavalink password. |
|
||||||
|
|
||||||
|
A minimal `.env` for local development:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
BOT_TOKEN=your-bot-token
|
||||||
|
APP_ID=123456789012345678
|
||||||
|
GUILD_ID=123456789012345678
|
||||||
|
DB_HOST=postgres://velox:velox_pwd@localhost:5432/velox?sslmode=disable
|
||||||
|
TWITCH_CLIENT_ID=unused
|
||||||
|
```
|
||||||
|
|
||||||
|
`.env` is ignored by git. Never commit it.
|
||||||
|
|
||||||
|
Who the beta testers are is **not** an environment variable. It is set on the dashboard and stored in the database. See [Beta features](beta-features.md).
|
||||||
|
|
||||||
|
## 3. Set up the database
|
||||||
|
|
||||||
|
Start PostgreSQL with Compose:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose up -d db
|
||||||
|
```
|
||||||
|
|
||||||
|
Then load the schema:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
psql "postgres://velox:velox_pwd@localhost:5432/velox?sslmode=disable" -f schema.sql
|
||||||
|
```
|
||||||
|
|
||||||
|
`schema.sql` is written with `CREATE TABLE IF NOT EXISTS`, so running it again is safe. It is a mirror of the tables the bot uses. If you run the dashboard API as well, the API's migrations create and change these tables, and you do not need `schema.sql` at all. Read [Database](database.md) before changing a table.
|
||||||
|
|
||||||
|
## 4. Run
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go run .
|
||||||
|
```
|
||||||
|
|
||||||
|
You should see the bot connect, and the slash commands appear in your test server. Type `/ping`.
|
||||||
|
|
||||||
|
With live reload:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
air
|
||||||
|
```
|
||||||
|
|
||||||
|
With Just (`Justfile`):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
just up # start PostgreSQL
|
||||||
|
just start # start PostgreSQL and run Air
|
||||||
|
just down # stop PostgreSQL
|
||||||
|
```
|
||||||
|
|
||||||
|
## 5. Turn modules on
|
||||||
|
|
||||||
|
Nothing is on by default. In your server:
|
||||||
|
|
||||||
|
- `/security toggle` to enable Join Gate, raid mode, anti-nuke or heat.
|
||||||
|
- `/tickets setup`, then `/tickets category add` and `/tickets panel`.
|
||||||
|
- `/slvl toggle` for leveling.
|
||||||
|
- `/config setlogchannel` and `/config enablelogging` for logs.
|
||||||
|
- `/music toggle` for music (needs Lavalink).
|
||||||
|
|
||||||
|
The [Features](features.md) page explains each module, and the [Command reference](commands.md) lists every option.
|
||||||
|
|
||||||
|
## Optional: music with Lavalink
|
||||||
|
|
||||||
|
Music needs a running Lavalink server and `LAVALINK_HOST` / `LAVALINK_PASSWORD`. Without them the bot starts normally and music simply does not work. Members need a role named exactly **DJ** to use `/play`, `/queue` and `/volume`.
|
||||||
|
|
||||||
|
## Next steps
|
||||||
|
|
||||||
|
- Running it for real: [Deployment](deployment.md).
|
||||||
|
- Changing or adding things: [Development guide](development.md).
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
# Troubleshooting
|
||||||
|
|
||||||
|
## The bot does not start
|
||||||
|
|
||||||
|
| Message | Cause |
|
||||||
|
| --- | --- |
|
||||||
|
| `BOT_TOKEN is not set`, `APP_ID is not set`, `DB_HOST is not set` | A required variable is missing. See [Getting started](getting-started.md#2-configure-the-environment). |
|
||||||
|
| `TWITCH_CLIENT_ID is not set` | It is required even if you do not use Twitch alerts. Set any non-empty value. |
|
||||||
|
| `Error creating database` | `DB_HOST` is wrong, or PostgreSQL is not running or not reachable. Try the connection string with `psql`. |
|
||||||
|
| `Error starting bot` | The token is wrong, or a privileged intent is not enabled in the developer portal. |
|
||||||
|
| `Disallowed intents` | Enable **Server Members Intent** and **Message Content Intent** in the developer portal, under Bot. |
|
||||||
|
|
||||||
|
## Slash commands do not appear
|
||||||
|
|
||||||
|
- With `GUILD_ID` set, commands appear in that server within seconds. If it is empty they are global and can take up to an hour.
|
||||||
|
- The bot must be invited with the `applications.commands` scope.
|
||||||
|
- If a command is defined but not in the `handlers` map in `internal/commands/commands.go`, it shows up and does nothing.
|
||||||
|
- If the bot logs `Cannot create '<name>' command`, read the error. A name or description that is too long, or an invalid option, makes Discord reject that one command.
|
||||||
|
- Commands that you removed from the code stay in Discord until you delete them (in the developer portal or through the API).
|
||||||
|
|
||||||
|
## A command says "You don't have permission"
|
||||||
|
|
||||||
|
Many commands need **Manage Server** (see the [Command reference](commands.md)), and the music commands need a role called exactly **DJ**. Security actions such as turning protection off need the **server owner or a trusted user**, whatever permissions you have.
|
||||||
|
|
||||||
|
## The bot cannot do something in a server
|
||||||
|
|
||||||
|
Most failures are about the bot's role:
|
||||||
|
|
||||||
|
- The bot's role must be **above** the roles it manages and the members it moderates or quarantines.
|
||||||
|
- It needs the permissions listed in [Getting started](getting-started.md#1-create-the-discord-application). Check the channel's own permission overrides too: a channel can deny what the server role allows.
|
||||||
|
- Security messages say "Check that Velox's role is high enough and has the permissions it needs" for this reason.
|
||||||
|
|
||||||
|
## Music does not play
|
||||||
|
|
||||||
|
- `LAVALINK_HOST` and `LAVALINK_PASSWORD` must match your Lavalink server, and Lavalink must be running and reachable from the bot (in Compose, use the service name, not `localhost`).
|
||||||
|
- You need the **DJ** role.
|
||||||
|
- A server admin can turn music off with `/music toggle`.
|
||||||
|
|
||||||
|
## Level-ups, logs or welcome messages do nothing
|
||||||
|
|
||||||
|
They are off until enabled: `/slvl toggle`, `/config enablelogging` with `/config setlogchannel`, and `/config setwelcomechannel`. Leveling and spam detection read message text, so the **Message Content Intent** must be on. Welcome messages and security need the **Server Members Intent**.
|
||||||
|
|
||||||
|
## Dashboard actions have no effect
|
||||||
|
|
||||||
|
The dashboard talks to the bot through the database (see [Database](database.md#dashboard-to-bot-settings-and-requests)).
|
||||||
|
|
||||||
|
- Check that the bot and the API use the **same database**.
|
||||||
|
- For a request such as skipping a song or ending a raid, look in the matching `*_commands` table. A row with an empty `processed_at` is waiting. If many are waiting, the bot's listener is down: look for `command listener stopped` in its log. It reconnects every 10 seconds.
|
||||||
|
- Settings are read when needed and may be cached briefly (the beta settings are polled every 30 seconds).
|
||||||
|
|
||||||
|
## Beta features are not available to a tester
|
||||||
|
|
||||||
|
Go through [Beta features](beta-features.md): is the Beta Tester role chosen on the dashboard? Is the person in the beta server, and do they have the role? Has 30 seconds passed? `/beta` (owner only) shows how access is set up.
|
||||||
|
|
||||||
|
## Getting more detail
|
||||||
|
|
||||||
|
The bot logs to standard output. Run `docker compose logs -f bot`, or just `go run .`, and reproduce the problem. Errors from Discord calls are logged with the server and channel IDs involved.
|
||||||
@@ -0,0 +1,145 @@
|
|||||||
|
// Package beta gates features that are still being tried out. A beta feature
|
||||||
|
// works only for members of the beta server who have the Beta Tester role:
|
||||||
|
// the server comes from BETA_GUILD_ID and the role from BETA_ROLE_ID, both set
|
||||||
|
// by the bot's owner in its environment, so nobody can change them from
|
||||||
|
// Discord.
|
||||||
|
//
|
||||||
|
// Everything fails closed. With no role configured, or an ID that isn't a
|
||||||
|
// Discord ID, nobody gets access.
|
||||||
|
package beta
|
||||||
|
|
||||||
|
import (
|
||||||
|
"log"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
"sync/atomic"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Handler is a slash command handler.
|
||||||
|
type Handler = func(s *discordgo.Session, i *discordgo.InteractionCreate)
|
||||||
|
|
||||||
|
type settings struct{ guildID, roleID string }
|
||||||
|
|
||||||
|
var current atomic.Pointer[settings]
|
||||||
|
|
||||||
|
var snowflake = regexp.MustCompile(`^[0-9]{1,20}$`)
|
||||||
|
|
||||||
|
// idOrEmpty keeps a Discord ID and drops anything else, so a typo in the
|
||||||
|
// environment turns beta features off instead of matching something odd.
|
||||||
|
func idOrEmpty(name, v string) string {
|
||||||
|
v = strings.TrimSpace(v)
|
||||||
|
if v == "" {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
if !snowflake.MatchString(v) {
|
||||||
|
log.Printf("beta: %s %q isn't a Discord ID; beta features stay locked", name, v)
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
|
||||||
|
// Configure sets the beta server and the Beta Tester role. Call it once at
|
||||||
|
// startup.
|
||||||
|
func Configure(guildID, roleID string) {
|
||||||
|
current.Store(&settings{
|
||||||
|
guildID: idOrEmpty("BETA_GUILD_ID", guildID),
|
||||||
|
roleID: idOrEmpty("BETA_ROLE_ID", roleID),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func get() settings {
|
||||||
|
if s := current.Load(); s != nil {
|
||||||
|
return *s
|
||||||
|
}
|
||||||
|
return settings{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// GuildID is the beta server, or "" when beta features are off.
|
||||||
|
func GuildID() string { return get().guildID }
|
||||||
|
|
||||||
|
// Status describes where a member stands, for the /beta command.
|
||||||
|
type Status struct {
|
||||||
|
InBetaGuild bool // the interaction came from the beta server
|
||||||
|
RoleConfigured bool // the owner has set a Beta Tester role
|
||||||
|
HasRole bool // the member has it
|
||||||
|
}
|
||||||
|
|
||||||
|
// StatusOf reports a member's standing in the guild they're acting in.
|
||||||
|
func StatusOf(guildID string, member *discordgo.Member) Status {
|
||||||
|
c := get()
|
||||||
|
st := Status{
|
||||||
|
InBetaGuild: c.guildID != "" && guildID == c.guildID,
|
||||||
|
RoleConfigured: c.roleID != "",
|
||||||
|
}
|
||||||
|
if st.InBetaGuild && st.RoleConfigured && member != nil {
|
||||||
|
for _, r := range member.Roles {
|
||||||
|
if r == c.roleID {
|
||||||
|
st.HasRole = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return st
|
||||||
|
}
|
||||||
|
|
||||||
|
// Allowed reports whether a member may use beta features in guildID: it has
|
||||||
|
// to be the beta server, and the member has to have the Beta Tester role.
|
||||||
|
// Use it for anything that isn't a command, such as an event handler.
|
||||||
|
func Allowed(guildID string, member *discordgo.Member) bool {
|
||||||
|
st := StatusOf(guildID, member)
|
||||||
|
return st.InBetaGuild && st.RoleConfigured && st.HasRole
|
||||||
|
}
|
||||||
|
|
||||||
|
// AllowedInteraction is Allowed for an interaction. A DM has no member, so it
|
||||||
|
// never qualifies. The member and their roles come from Discord with the
|
||||||
|
// interaction, not from anything the user typed.
|
||||||
|
func AllowedInteraction(i *discordgo.InteractionCreate) bool {
|
||||||
|
return i != nil && i.Interaction != nil && Allowed(i.GuildID, i.Member)
|
||||||
|
}
|
||||||
|
|
||||||
|
// respond is how a refusal is sent; tests replace it.
|
||||||
|
var respond = func(s *discordgo.Session, i *discordgo.InteractionCreate, msg string) {
|
||||||
|
if i.Type == discordgo.InteractionApplicationCommandAutocomplete {
|
||||||
|
// Nothing to suggest, and a message isn't a valid reply here.
|
||||||
|
_ = s.InteractionRespond(i.Interaction, &discordgo.InteractionResponse{
|
||||||
|
Type: discordgo.InteractionApplicationCommandAutocompleteResult,
|
||||||
|
Data: &discordgo.InteractionResponseData{Choices: []*discordgo.ApplicationCommandOptionChoice{}},
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
_ = s.InteractionRespond(i.Interaction, &discordgo.InteractionResponse{
|
||||||
|
Type: discordgo.InteractionResponseChannelMessageWithSource,
|
||||||
|
Data: &discordgo.InteractionResponseData{
|
||||||
|
Content: msg,
|
||||||
|
Flags: discordgo.MessageFlagsEphemeral,
|
||||||
|
AllowedMentions: &discordgo.MessageAllowedMentions{},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const denied = "This feature is in beta and isn't available to you yet."
|
||||||
|
|
||||||
|
// Guard is for the start of a beta feature's handler, and for its component,
|
||||||
|
// modal and autocomplete handlers too (the command's gate doesn't cover
|
||||||
|
// those). It answers the user and returns false when they aren't allowed:
|
||||||
|
//
|
||||||
|
// if !beta.Guard(s, i) { return }
|
||||||
|
func Guard(s *discordgo.Session, i *discordgo.InteractionCreate) bool {
|
||||||
|
if AllowedInteraction(i) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
respond(s, i, denied)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Gate wraps a command handler so it only runs for beta testers.
|
||||||
|
func Gate(h Handler) Handler {
|
||||||
|
return func(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
if !Guard(s, i) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
h(s, i)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,115 @@
|
|||||||
|
package beta
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
betaGuild = "1170934850157547600"
|
||||||
|
testerRol = "555000000000000001"
|
||||||
|
)
|
||||||
|
|
||||||
|
func member(roles ...string) *discordgo.Member { return &discordgo.Member{Roles: roles} }
|
||||||
|
|
||||||
|
func interaction(guildID string, m *discordgo.Member) *discordgo.InteractionCreate {
|
||||||
|
return &discordgo.InteractionCreate{Interaction: &discordgo.Interaction{GuildID: guildID, Member: m}}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAllowed(t *testing.T) {
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
guild, role string // configuration
|
||||||
|
inGuild string
|
||||||
|
member *discordgo.Member
|
||||||
|
want bool
|
||||||
|
inBeta, hasRole bool
|
||||||
|
}{
|
||||||
|
{"tester in the beta server", betaGuild, testerRol, betaGuild, member("1", testerRol), true, true, true},
|
||||||
|
{"member without the role", betaGuild, testerRol, betaGuild, member("1", "2"), false, true, false},
|
||||||
|
{"member with no roles at all", betaGuild, testerRol, betaGuild, member(), false, true, false},
|
||||||
|
{"the role in another server doesn't count", betaGuild, testerRol, "999000000000000001", member(testerRol), false, false, false},
|
||||||
|
{"a DM has no member", betaGuild, testerRol, "", nil, false, false, false},
|
||||||
|
{"a nil member in the beta server", betaGuild, testerRol, betaGuild, nil, false, true, false},
|
||||||
|
{"no role configured: nobody", betaGuild, "", betaGuild, member(testerRol, ""), false, true, false},
|
||||||
|
{"no beta server configured: nobody", "", testerRol, betaGuild, member(testerRol), false, false, false},
|
||||||
|
{"a role ID that isn't a number is dropped", betaGuild, "tester-role", betaGuild, member("tester-role"), false, true, false},
|
||||||
|
{"a server ID that isn't a number is dropped", "my-server", testerRol, "my-server", member(testerRol), false, false, false},
|
||||||
|
{"a role that only contains the ID isn't a match", betaGuild, testerRol, betaGuild, member(testerRol + "9"), false, true, false},
|
||||||
|
{"stray spaces in the configuration are ignored", " " + betaGuild + " ", " " + testerRol + "\n", betaGuild, member(testerRol), true, true, true},
|
||||||
|
}
|
||||||
|
for _, tc := range cases {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
Configure(tc.guild, tc.role)
|
||||||
|
if got := Allowed(tc.inGuild, tc.member); got != tc.want {
|
||||||
|
t.Errorf("Allowed = %v, want %v", got, tc.want)
|
||||||
|
}
|
||||||
|
if got := AllowedInteraction(interaction(tc.inGuild, tc.member)); got != tc.want {
|
||||||
|
t.Errorf("AllowedInteraction = %v, want %v", got, tc.want)
|
||||||
|
}
|
||||||
|
st := StatusOf(tc.inGuild, tc.member)
|
||||||
|
if st.InBetaGuild != tc.inBeta || st.HasRole != tc.hasRole {
|
||||||
|
t.Errorf("StatusOf = %+v, want in beta server %v, has role %v", st, tc.inBeta, tc.hasRole)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNotConfiguredAtAll(t *testing.T) {
|
||||||
|
current.Store(nil)
|
||||||
|
if Allowed(betaGuild, member(testerRol)) || GuildID() != "" {
|
||||||
|
t.Error("before Configure nothing is allowed and there's no beta server")
|
||||||
|
}
|
||||||
|
if AllowedInteraction(nil) || AllowedInteraction(&discordgo.InteractionCreate{}) {
|
||||||
|
t.Error("a missing interaction is never allowed")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGateRunsTheHandlerOnlyForTesters(t *testing.T) {
|
||||||
|
Configure(betaGuild, testerRol)
|
||||||
|
var answered []string
|
||||||
|
orig := respond
|
||||||
|
respond = func(_ *discordgo.Session, _ *discordgo.InteractionCreate, msg string) {
|
||||||
|
answered = append(answered, msg)
|
||||||
|
}
|
||||||
|
t.Cleanup(func() { respond = orig })
|
||||||
|
|
||||||
|
ran := 0
|
||||||
|
h := Gate(func(*discordgo.Session, *discordgo.InteractionCreate) { ran++ })
|
||||||
|
|
||||||
|
h(nil, interaction(betaGuild, member(testerRol)))
|
||||||
|
if ran != 1 || len(answered) != 0 {
|
||||||
|
t.Fatalf("a tester runs the handler without being refused: ran=%d answered=%v", ran, answered)
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, i := range map[string]*discordgo.InteractionCreate{
|
||||||
|
"no role": interaction(betaGuild, member("1")),
|
||||||
|
"wrong server": interaction("999000000000000001", member(testerRol)),
|
||||||
|
"DM": interaction("", nil),
|
||||||
|
} {
|
||||||
|
before := ran
|
||||||
|
h(nil, i)
|
||||||
|
if ran != before {
|
||||||
|
t.Errorf("%s: the handler must not run", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(answered) != 3 || answered[0] != denied {
|
||||||
|
t.Errorf("each refusal is answered with the beta message: %v", answered)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGuardOnItsOwn(t *testing.T) {
|
||||||
|
Configure(betaGuild, testerRol)
|
||||||
|
n := 0
|
||||||
|
orig := respond
|
||||||
|
respond = func(*discordgo.Session, *discordgo.InteractionCreate, string) { n++ }
|
||||||
|
t.Cleanup(func() { respond = orig })
|
||||||
|
|
||||||
|
if !Guard(nil, interaction(betaGuild, member(testerRol))) || n != 0 {
|
||||||
|
t.Error("a tester passes without a reply")
|
||||||
|
}
|
||||||
|
if Guard(nil, interaction(betaGuild, member())) || n != 1 {
|
||||||
|
t.Error("someone else is refused with a reply")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,11 +4,13 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"log"
|
"log"
|
||||||
"time"
|
"time"
|
||||||
|
"velox-bot/internal/beta"
|
||||||
"velox-bot/internal/commands"
|
"velox-bot/internal/commands"
|
||||||
"velox-bot/internal/db/repos/musicrepo"
|
"velox-bot/internal/db/repos/musicrepo"
|
||||||
"velox-bot/internal/db/services"
|
"velox-bot/internal/db/services"
|
||||||
"velox-bot/internal/events"
|
"velox-bot/internal/events"
|
||||||
"velox-bot/internal/music"
|
"velox-bot/internal/music"
|
||||||
|
"velox-bot/internal/security"
|
||||||
"velox-bot/internal/tickets"
|
"velox-bot/internal/tickets"
|
||||||
|
|
||||||
"github.com/bwmarrin/discordgo"
|
"github.com/bwmarrin/discordgo"
|
||||||
@@ -25,6 +27,7 @@ type Bot struct {
|
|||||||
DBHost string
|
DBHost string
|
||||||
LavalinkHost string
|
LavalinkHost string
|
||||||
LavalinkPass string
|
LavalinkPass string
|
||||||
|
betaGuild string // where beta commands are registered right now
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewBot(token, appID, guildID, lavalinkHost, lavalinkPass string, cmds []*discordgo.ApplicationCommand, services *services.Services, musicRepo *musicrepo.Repo, dbHost string) (*Bot, error) {
|
func NewBot(token, appID, guildID, lavalinkHost, lavalinkPass string, cmds []*discordgo.ApplicationCommand, services *services.Services, musicRepo *musicrepo.Repo, dbHost string) (*Bot, error) {
|
||||||
@@ -84,6 +87,24 @@ func (b *Bot) Start() error {
|
|||||||
}()
|
}()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if eng := security.Start(b.Session, b.Session.State.User.ID); eng != nil {
|
||||||
|
// Moderators are exempt from heat; their permissions come from the
|
||||||
|
// gateway cache so a message never costs an API call.
|
||||||
|
eng.ChannelPerms = b.Session.State.UserChannelPermissions
|
||||||
|
eng.ResumeRaids(context.Background())
|
||||||
|
go eng.WatchRaids(context.Background(), 30*time.Second)
|
||||||
|
go eng.WatchSnapshots(context.Background())
|
||||||
|
go func() {
|
||||||
|
// Reconnect if the database connection drops, instead of
|
||||||
|
// silently ignoring the dashboard from then on.
|
||||||
|
for {
|
||||||
|
err := eng.StartCommandListener(context.Background(), b.DBHost)
|
||||||
|
log.Printf("security: command listener stopped: %v (retrying in 10s)", err)
|
||||||
|
time.Sleep(10 * time.Second)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
|
||||||
b.registeredCommands = make([]*discordgo.ApplicationCommand, len(b.Commands))
|
b.registeredCommands = make([]*discordgo.ApplicationCommand, len(b.Commands))
|
||||||
for _, cmd := range b.Commands {
|
for _, cmd := range b.Commands {
|
||||||
created, err := b.Session.ApplicationCommandCreate(b.AppID, b.GuildID, cmd)
|
created, err := b.Session.ApplicationCommandCreate(b.AppID, b.GuildID, cmd)
|
||||||
@@ -96,13 +117,29 @@ func (b *Bot) Start() error {
|
|||||||
|
|
||||||
b.Session.AddHandler(commands.HandleInteraction)
|
b.Session.AddHandler(commands.HandleInteraction)
|
||||||
|
|
||||||
|
b.Session.AddHandler(func(s *discordgo.Session, c *discordgo.ChannelDelete) {
|
||||||
|
events.HandleChannelDelete(s, c, b.Services)
|
||||||
|
})
|
||||||
|
|
||||||
b.Session.AddHandler(func(s *discordgo.Session, m *discordgo.MessageCreate) {
|
b.Session.AddHandler(func(s *discordgo.Session, m *discordgo.MessageCreate) {
|
||||||
|
if eng := security.Default(); eng != nil {
|
||||||
|
eng.OnMessage(context.Background(), m)
|
||||||
|
}
|
||||||
events.HandleMessageCreate(s, m, b.Services)
|
events.HandleMessageCreate(s, m, b.Services)
|
||||||
})
|
})
|
||||||
|
|
||||||
b.Session.AddHandler(func(s *discordgo.Session, m *discordgo.GuildMemberAdd) {
|
b.Session.AddHandler(func(s *discordgo.Session, m *discordgo.GuildMemberAdd) {
|
||||||
events.HandleBotAddedOnGuild(s, m, b.Services)
|
events.HandleBotAddedOnGuild(s, m, b.Services)
|
||||||
|
|
||||||
|
// Security runs first: someone it removes (join lock, Join Gate,
|
||||||
|
// raid) gets no welcome message or default role.
|
||||||
|
if eng := security.Default(); eng != nil && m != nil && m.Member != nil {
|
||||||
|
if eng.OnMemberJoin(context.Background(), m.GuildID, m.Member) {
|
||||||
|
events.HandleGuildMemberAddLog(s, m, b.Services)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Ignore bot members for welcome/log onboarding of normal users.
|
// Ignore bot members for welcome/log onboarding of normal users.
|
||||||
if m != nil && m.Member != nil && m.User != nil && m.User.Bot {
|
if m != nil && m.Member != nil && m.User != nil && m.User.Bot {
|
||||||
return
|
return
|
||||||
@@ -112,6 +149,14 @@ func (b *Bot) Start() error {
|
|||||||
events.HandleGuildMemberAddLog(s, m, b.Services)
|
events.HandleGuildMemberAddLog(s, m, b.Services)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
// Anti-nuke and unauthorized bot additions read the audit log as it
|
||||||
|
// happens (needs the Guild Moderation intent and View Audit Log).
|
||||||
|
b.Session.AddHandler(func(s *discordgo.Session, ev *discordgo.GuildAuditLogEntryCreate) {
|
||||||
|
if eng := security.Default(); eng != nil && ev.AuditLogEntry != nil {
|
||||||
|
eng.OnAuditLogEntry(context.Background(), ev.GuildID, ev.AuditLogEntry)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
b.Session.AddHandler(func(s *discordgo.Session, m *discordgo.GuildMemberRemove) {
|
b.Session.AddHandler(func(s *discordgo.Session, m *discordgo.GuildMemberRemove) {
|
||||||
events.HandleGuildMemberRemoveLog(s, m, b.Services)
|
events.HandleGuildMemberRemoveLog(s, m, b.Services)
|
||||||
})
|
})
|
||||||
@@ -157,6 +202,95 @@ func (b *Bot) Start() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// betaPollEvery is how often the bot looks for a change to the beta settings
|
||||||
|
// made on the dashboard.
|
||||||
|
const betaPollEvery = 30 * time.Second
|
||||||
|
|
||||||
|
// WatchBeta keeps the bot's idea of who the beta testers are in step with the
|
||||||
|
// settings the owner saves on the dashboard. When the beta server changes, the
|
||||||
|
// beta commands move with it. If the settings can't be read, the last known
|
||||||
|
// ones stay in force (and before the first read, beta stays locked).
|
||||||
|
func (b *Bot) WatchBeta(ctx context.Context, load func(context.Context) (guildID, roleID string, err error)) {
|
||||||
|
sync := func() {
|
||||||
|
guildID, roleID, err := load(ctx)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("beta: cannot read settings, keeping the last ones: %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
beta.Configure(guildID, roleID)
|
||||||
|
if now := beta.GuildID(); now != b.betaGuild {
|
||||||
|
b.registerBetaCommands(b.betaGuild, now)
|
||||||
|
b.betaGuild = now
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sync()
|
||||||
|
go func() {
|
||||||
|
t := time.NewTicker(betaPollEvery)
|
||||||
|
defer t.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-t.C:
|
||||||
|
sync()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
|
||||||
|
// registerBetaCommands puts the beta commands in the beta server, and only
|
||||||
|
// there, so nobody else sees them. Commands this bot left there that are no
|
||||||
|
// longer beta (or no longer exist) are removed. When the beta server is also
|
||||||
|
// the bot's main server, its regular commands are kept. If the beta server
|
||||||
|
// changed, the beta commands are taken out of the old one.
|
||||||
|
func (b *Bot) registerBetaCommands(previous, guildID string) {
|
||||||
|
if previous != "" && previous != guildID {
|
||||||
|
isBeta := map[string]bool{}
|
||||||
|
for _, cmd := range commands.BetaCommands {
|
||||||
|
isBeta[cmd.Name] = true
|
||||||
|
}
|
||||||
|
if old, err := b.Session.ApplicationCommands(b.AppID, previous); err != nil {
|
||||||
|
log.Printf("beta: cannot list commands in the previous server: %v", err)
|
||||||
|
} else {
|
||||||
|
for _, cmd := range old {
|
||||||
|
if isBeta[cmd.Name] {
|
||||||
|
if err := b.Session.ApplicationCommandDelete(b.AppID, previous, cmd.ID); err != nil {
|
||||||
|
log.Printf("beta: cannot remove '%v' from the previous server: %v", cmd.Name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if guildID == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
keep := map[string]bool{}
|
||||||
|
for _, cmd := range b.Commands {
|
||||||
|
if b.GuildID == guildID {
|
||||||
|
keep[cmd.Name] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, cmd := range commands.BetaCommands {
|
||||||
|
keep[cmd.Name] = true
|
||||||
|
if _, err := b.Session.ApplicationCommandCreate(b.AppID, guildID, cmd); err != nil {
|
||||||
|
log.Printf("beta: cannot create '%v' command: %v", cmd.Name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
existing, err := b.Session.ApplicationCommands(b.AppID, guildID)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("beta: cannot list commands, leaving stale ones alone: %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
for _, cmd := range existing {
|
||||||
|
if keep[cmd.Name] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if err := b.Session.ApplicationCommandDelete(b.AppID, guildID, cmd.ID); err != nil {
|
||||||
|
log.Printf("beta: cannot remove stale '%v' command: %v", cmd.Name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func (b *Bot) Close() error {
|
func (b *Bot) Close() error {
|
||||||
for _, cmd := range b.registeredCommands {
|
for _, cmd := range b.registeredCommands {
|
||||||
if err := b.Session.ApplicationCommandDelete(b.AppID, b.GuildID, cmd.ID); err != nil {
|
if err := b.Session.ApplicationCommandDelete(b.AppID, b.GuildID, cmd.ID); err != nil {
|
||||||
|
|||||||
@@ -0,0 +1,86 @@
|
|||||||
|
// Package betacmd is the /beta command: it shows how beta access is set up.
|
||||||
|
// It exists only in the beta server (see commands.BetaCommands), is hidden
|
||||||
|
// from everyone but administrators in Discord's command picker, and only the
|
||||||
|
// bot's owner can actually run it (the owner is looked up from the Discord
|
||||||
|
// application, so there's nothing to configure).
|
||||||
|
package betacmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sync"
|
||||||
|
"velox-bot/internal/beta"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
noDM = false
|
||||||
|
noPerms = int64(0) // hides the command from everyone but administrators
|
||||||
|
ownerIDs sync.Map // user ID -> struct{}, filled once from the application
|
||||||
|
loadOnce sync.Mutex
|
||||||
|
loaded bool
|
||||||
|
)
|
||||||
|
|
||||||
|
var Beta = &discordgo.ApplicationCommand{
|
||||||
|
Name: "beta",
|
||||||
|
Description: "Show how beta access is set up (bot owner only)",
|
||||||
|
DMPermission: &noDM,
|
||||||
|
DefaultMemberPermissions: &noPerms,
|
||||||
|
}
|
||||||
|
|
||||||
|
// isOwner reports whether the user owns the bot's Discord application (or is
|
||||||
|
// on its team). If the application can't be read, nobody is the owner.
|
||||||
|
func isOwner(s *discordgo.Session, userID string) bool {
|
||||||
|
if userID == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
loadOnce.Lock()
|
||||||
|
if !loaded {
|
||||||
|
app, err := s.Application("@me")
|
||||||
|
if err == nil && app != nil {
|
||||||
|
if app.Owner != nil {
|
||||||
|
ownerIDs.Store(app.Owner.ID, struct{}{})
|
||||||
|
}
|
||||||
|
if app.Team != nil {
|
||||||
|
ownerIDs.Store(app.Team.OwnerID, struct{}{})
|
||||||
|
for _, m := range app.Team.Members {
|
||||||
|
if m != nil && m.User != nil {
|
||||||
|
ownerIDs.Store(m.User.ID, struct{}{})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
loaded = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
loadOnce.Unlock()
|
||||||
|
_, ok := ownerIDs.Load(userID)
|
||||||
|
return ok
|
||||||
|
}
|
||||||
|
|
||||||
|
func Handler(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
var userID string
|
||||||
|
if i.Member != nil && i.Member.User != nil {
|
||||||
|
userID = i.Member.User.ID
|
||||||
|
}
|
||||||
|
var msg string
|
||||||
|
st := beta.StatusOf(i.GuildID, i.Member)
|
||||||
|
switch {
|
||||||
|
case !isOwner(s, userID):
|
||||||
|
msg = "Only the bot's owner can use this command."
|
||||||
|
case !st.InBetaGuild:
|
||||||
|
msg = "Beta features aren't available here."
|
||||||
|
case !st.RoleConfigured:
|
||||||
|
msg = "No Beta Tester role is set up, so beta features are locked for everyone."
|
||||||
|
case st.HasRole:
|
||||||
|
msg = "You're a beta tester: beta features are unlocked for you in this server."
|
||||||
|
default:
|
||||||
|
msg = "You don't have the Beta Tester role, so beta features are locked for you."
|
||||||
|
}
|
||||||
|
_ = s.InteractionRespond(i.Interaction, &discordgo.InteractionResponse{
|
||||||
|
Type: discordgo.InteractionResponseChannelMessageWithSource,
|
||||||
|
Data: &discordgo.InteractionResponseData{
|
||||||
|
Content: msg,
|
||||||
|
Flags: discordgo.MessageFlagsEphemeral,
|
||||||
|
AllowedMentions: &discordgo.MessageAllowedMentions{},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
@@ -2,6 +2,8 @@ package commands
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"strings"
|
"strings"
|
||||||
|
"velox-bot/internal/beta"
|
||||||
|
"velox-bot/internal/commands/betacmd"
|
||||||
"velox-bot/internal/commands/config"
|
"velox-bot/internal/commands/config"
|
||||||
"velox-bot/internal/commands/fun"
|
"velox-bot/internal/commands/fun"
|
||||||
"velox-bot/internal/commands/help"
|
"velox-bot/internal/commands/help"
|
||||||
@@ -11,6 +13,7 @@ import (
|
|||||||
cmdmusic "velox-bot/internal/commands/music"
|
cmdmusic "velox-bot/internal/commands/music"
|
||||||
"velox-bot/internal/commands/projects"
|
"velox-bot/internal/commands/projects"
|
||||||
"velox-bot/internal/commands/schedule"
|
"velox-bot/internal/commands/schedule"
|
||||||
|
cmdsecurity "velox-bot/internal/commands/security"
|
||||||
cmdtickets "velox-bot/internal/commands/tickets"
|
cmdtickets "velox-bot/internal/commands/tickets"
|
||||||
"velox-bot/internal/commands/timezone"
|
"velox-bot/internal/commands/timezone"
|
||||||
"velox-bot/internal/music"
|
"velox-bot/internal/music"
|
||||||
@@ -43,6 +46,9 @@ var AllCommands = []*discordgo.ApplicationCommand{
|
|||||||
config.Config,
|
config.Config,
|
||||||
cmdtickets.Tickets,
|
cmdtickets.Tickets,
|
||||||
cmdtickets.Ticket,
|
cmdtickets.Ticket,
|
||||||
|
cmdsecurity.Security,
|
||||||
|
cmdsecurity.Lockdown,
|
||||||
|
cmdsecurity.Unlock,
|
||||||
}
|
}
|
||||||
|
|
||||||
var handlers = map[string]func(s *discordgo.Session, i *discordgo.InteractionCreate){
|
var handlers = map[string]func(s *discordgo.Session, i *discordgo.InteractionCreate){
|
||||||
@@ -70,6 +76,27 @@ var handlers = map[string]func(s *discordgo.Session, i *discordgo.InteractionCre
|
|||||||
"config": config.ConfigHandler,
|
"config": config.ConfigHandler,
|
||||||
"tickets": cmdtickets.TicketsHandler,
|
"tickets": cmdtickets.TicketsHandler,
|
||||||
"ticket": cmdtickets.TicketHandler,
|
"ticket": cmdtickets.TicketHandler,
|
||||||
|
"security": cmdsecurity.SecurityHandler,
|
||||||
|
"lockdown": cmdsecurity.LockdownHandler,
|
||||||
|
"unlock": cmdsecurity.UnlockHandler,
|
||||||
|
}
|
||||||
|
|
||||||
|
// BetaCommands are the beta features' slash commands. They're registered in
|
||||||
|
// the beta server only, so nobody else even sees them, and each handler is
|
||||||
|
// wrapped so it runs only for members with the Beta Tester role (see the beta
|
||||||
|
// package). To put a feature in beta, add it with RegisterBeta instead of to
|
||||||
|
// AllCommands and handlers; to release it, move it there.
|
||||||
|
var BetaCommands = []*discordgo.ApplicationCommand{betacmd.Beta}
|
||||||
|
|
||||||
|
func init() {
|
||||||
|
// /beta itself is open to the whole beta server (see betacmd).
|
||||||
|
handlers[betacmd.Beta.Name] = betacmd.Handler
|
||||||
|
}
|
||||||
|
|
||||||
|
// RegisterBeta adds a slash command that only beta testers can use.
|
||||||
|
func RegisterBeta(cmd *discordgo.ApplicationCommand, h func(s *discordgo.Session, i *discordgo.InteractionCreate)) {
|
||||||
|
BetaCommands = append(BetaCommands, cmd)
|
||||||
|
handlers[cmd.Name] = beta.Gate(h)
|
||||||
}
|
}
|
||||||
|
|
||||||
func HandleInteraction(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
func HandleInteraction(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
@@ -89,6 +116,8 @@ func HandleInteraction(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
|||||||
projects.HandleComponent(s, i)
|
projects.HandleComponent(s, i)
|
||||||
case strings.HasPrefix(data.CustomID, "tickets:"):
|
case strings.HasPrefix(data.CustomID, "tickets:"):
|
||||||
cmdtickets.HandleComponent(s, i)
|
cmdtickets.HandleComponent(s, i)
|
||||||
|
case strings.HasPrefix(data.CustomID, "security:"):
|
||||||
|
cmdsecurity.HandleComponent(s, i)
|
||||||
}
|
}
|
||||||
case discordgo.InteractionModalSubmit:
|
case discordgo.InteractionModalSubmit:
|
||||||
data := i.ModalSubmitData()
|
data := i.ModalSubmitData()
|
||||||
|
|||||||
@@ -93,10 +93,22 @@ func HelpHandler(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
|||||||
"`/ticket claim`, `/ticket remove user:@someone` — Staff only\n" +
|
"`/ticket claim`, `/ticket remove user:@someone` — Staff only\n" +
|
||||||
"`/tickets setup`, `/tickets category add|remove|list`, `/tickets panel` — Set up (**Manage Server**)",
|
"`/tickets setup`, `/tickets category add|remove|list`, `/tickets panel` — Set up (**Manage Server**)",
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
Name: "Security (anti-raid & anti-nuke)",
|
||||||
|
Value: "" +
|
||||||
|
"`/security status` — What's on and who is trusted\n" +
|
||||||
|
"`/security toggle` — Join Gate, raid mode, anti-nuke on/off (off: owner or trusted)\n" +
|
||||||
|
"`/security alerts`, `/security quarantine-role`, `/security release`, `/security end-raid` — Owner or trusted\n" +
|
||||||
|
"`/security trust add|remove` — Owner only\n" +
|
||||||
|
"`/security snapshot` — Save roles and channels; `/security restore` — Rebuild what a nuke deleted (owner or trusted)\n" +
|
||||||
|
"`/lockdown channel|server|joins`, `/unlock …` (unlock: owner or trusted)",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
Name: "Meetings (**Manage Server**)",
|
Name: "Meetings (**Manage Server**)",
|
||||||
Value: "" +
|
Value: "" +
|
||||||
"`/meeting set-lobby channel:#voice` — Set voice lobby used to create meetings\n" +
|
"`/meeting add-lobby channel:#voice` — Add a voice lobby that creates meetings (up to 10)\n" +
|
||||||
|
"`/meeting remove-lobby channel:#voice` — Stop using a voice lobby\n" +
|
||||||
|
"`/meeting lobbies` — List the voice lobbies\n" +
|
||||||
"`/meeting lock` — Lock your meeting room\n" +
|
"`/meeting lock` — Lock your meeting room\n" +
|
||||||
"`/meeting lock-private` — Lock + hide your meeting room\n" +
|
"`/meeting lock-private` — Lock + hide your meeting room\n" +
|
||||||
"`/meeting unlock` — Unlock your meeting room\n" +
|
"`/meeting unlock` — Unlock your meeting room\n" +
|
||||||
|
|||||||
@@ -2,11 +2,14 @@ package public
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"strconv"
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"velox-bot/internal/commands/meeting/shared"
|
"velox-bot/internal/commands/meeting/shared"
|
||||||
"velox-bot/internal/db/services"
|
"velox-bot/internal/db/services"
|
||||||
|
meetingsvc "velox-bot/internal/db/services/meeting"
|
||||||
|
|
||||||
"github.com/bwmarrin/discordgo"
|
"github.com/bwmarrin/discordgo"
|
||||||
)
|
)
|
||||||
@@ -17,18 +20,37 @@ var Meeting = &discordgo.ApplicationCommand{
|
|||||||
Options: []*discordgo.ApplicationCommandOption{
|
Options: []*discordgo.ApplicationCommandOption{
|
||||||
{
|
{
|
||||||
Type: discordgo.ApplicationCommandOptionSubCommand,
|
Type: discordgo.ApplicationCommandOptionSubCommand,
|
||||||
Name: "set-lobby",
|
Name: "add-lobby",
|
||||||
Description: "Set the voice lobby channel used to create meetings",
|
Description: "Add a voice lobby: joining it creates a meeting room",
|
||||||
Options: []*discordgo.ApplicationCommandOption{
|
Options: []*discordgo.ApplicationCommandOption{
|
||||||
{
|
{
|
||||||
Type: discordgo.ApplicationCommandOptionChannel,
|
Type: discordgo.ApplicationCommandOptionChannel,
|
||||||
Name: "channel",
|
Name: "channel",
|
||||||
Description: "Voice channel lobby",
|
Description: "Voice channel to use as a lobby",
|
||||||
Required: true,
|
Required: true,
|
||||||
ChannelTypes: []discordgo.ChannelType{discordgo.ChannelTypeGuildVoice},
|
ChannelTypes: []discordgo.ChannelType{discordgo.ChannelTypeGuildVoice},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
Type: discordgo.ApplicationCommandOptionSubCommand,
|
||||||
|
Name: "remove-lobby",
|
||||||
|
Description: "Stop using a voice channel as a lobby",
|
||||||
|
Options: []*discordgo.ApplicationCommandOption{
|
||||||
|
{
|
||||||
|
Type: discordgo.ApplicationCommandOptionChannel,
|
||||||
|
Name: "channel",
|
||||||
|
Description: "The lobby to remove",
|
||||||
|
Required: true,
|
||||||
|
ChannelTypes: []discordgo.ChannelType{discordgo.ChannelTypeGuildVoice},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
Type: discordgo.ApplicationCommandOptionSubCommand,
|
||||||
|
Name: "lobbies",
|
||||||
|
Description: "List this server's meeting lobbies",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
Type: discordgo.ApplicationCommandOptionSubCommand,
|
Type: discordgo.ApplicationCommandOptionSubCommand,
|
||||||
Name: "lock",
|
Name: "lock",
|
||||||
@@ -85,8 +107,12 @@ func MeetingHandler(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
switch data.Options[0].Name {
|
switch data.Options[0].Name {
|
||||||
case "set-lobby":
|
case "add-lobby":
|
||||||
handleSetLobby(s, i)
|
handleAddLobby(s, i)
|
||||||
|
case "remove-lobby":
|
||||||
|
handleRemoveLobby(s, i)
|
||||||
|
case "lobbies":
|
||||||
|
handleListLobbies(s, i)
|
||||||
case "lock":
|
case "lock":
|
||||||
handleLock(s, i)
|
handleLock(s, i)
|
||||||
case "lock-private":
|
case "lock-private":
|
||||||
@@ -102,37 +128,97 @@ func MeetingHandler(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func handleSetLobby(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
// lobbyChannelOption reads the "channel" option of add-lobby and
|
||||||
guildID, ok := shared.ParseGuildID(s, i)
|
// remove-lobby, answering the user itself if it's missing or not a voice
|
||||||
if !ok {
|
// channel.
|
||||||
return
|
func lobbyChannelOption(s *discordgo.Session, i *discordgo.InteractionCreate) (*discordgo.Channel, int64, bool) {
|
||||||
}
|
|
||||||
|
|
||||||
optMap := shared.SubcommandOptionMap(i)
|
optMap := shared.SubcommandOptionMap(i)
|
||||||
channelOpt, ok := optMap["channel"]
|
channelOpt, ok := optMap["channel"]
|
||||||
if !ok {
|
if !ok {
|
||||||
shared.RespondEphemeral(s, i, "Missing channel option.")
|
shared.RespondEphemeral(s, i, "Missing channel option.")
|
||||||
return
|
return nil, 0, false
|
||||||
}
|
}
|
||||||
|
|
||||||
ch := channelOpt.ChannelValue(s)
|
ch := channelOpt.ChannelValue(s)
|
||||||
if ch == nil || ch.Type != discordgo.ChannelTypeGuildVoice {
|
if ch == nil || ch.Type != discordgo.ChannelTypeGuildVoice {
|
||||||
shared.RespondEphemeral(s, i, "Invalid voice channel.")
|
shared.RespondEphemeral(s, i, "Invalid voice channel.")
|
||||||
return
|
return nil, 0, false
|
||||||
}
|
}
|
||||||
|
|
||||||
channelID, err := strconv.ParseInt(ch.ID, 10, 64)
|
channelID, err := strconv.ParseInt(ch.ID, 10, 64)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
shared.RespondEphemeral(s, i, "Invalid channel ID.")
|
shared.RespondEphemeral(s, i, "Invalid channel ID.")
|
||||||
|
return nil, 0, false
|
||||||
|
}
|
||||||
|
return ch, channelID, true
|
||||||
|
}
|
||||||
|
|
||||||
|
func handleAddLobby(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
guildID, ok := shared.ParseGuildID(s, i)
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
ch, channelID, ok := lobbyChannelOption(s, i)
|
||||||
|
if !ok {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := services.Global.Meeting.SetLobbyChannel(context.Background(), guildID, channelID); err != nil {
|
added, err := services.Global.Meeting.AddLobby(context.Background(), guildID, channelID)
|
||||||
shared.RespondEphemeral(s, i, "Failed to set meeting lobby.")
|
switch {
|
||||||
|
case errors.Is(err, meetingsvc.ErrLobbyLimit):
|
||||||
|
shared.RespondEphemeral(s, i, fmt.Sprintf("This server already has %d lobbies. Remove one with `/meeting remove-lobby` first.", meetingsvc.MaxLobbies))
|
||||||
|
case err != nil:
|
||||||
|
shared.RespondEphemeral(s, i, "Failed to add the meeting lobby.")
|
||||||
|
case !added:
|
||||||
|
shared.RespondEphemeral(s, i, ch.Mention()+" is already a meeting lobby.")
|
||||||
|
default:
|
||||||
|
shared.RespondEphemeral(s, i, ch.Mention()+" is now a meeting lobby.")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func handleRemoveLobby(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
guildID, ok := shared.ParseGuildID(s, i)
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
ch, channelID, ok := lobbyChannelOption(s, i)
|
||||||
|
if !ok {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
shared.RespondEphemeral(s, i, "Meeting lobby set to "+ch.Mention()+".")
|
removed, err := services.Global.Meeting.RemoveLobby(context.Background(), guildID, channelID)
|
||||||
|
switch {
|
||||||
|
case err != nil:
|
||||||
|
shared.RespondEphemeral(s, i, "Failed to remove the meeting lobby.")
|
||||||
|
case !removed:
|
||||||
|
shared.RespondEphemeral(s, i, ch.Mention()+" isn't a meeting lobby.")
|
||||||
|
default:
|
||||||
|
shared.RespondEphemeral(s, i, ch.Mention()+" is no longer a meeting lobby.")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func handleListLobbies(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
guildID, ok := shared.ParseGuildID(s, i)
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
ids, err := services.Global.Meeting.ListLobbies(context.Background(), guildID)
|
||||||
|
if err != nil {
|
||||||
|
shared.RespondEphemeral(s, i, "Failed to list the meeting lobbies.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if len(ids) == 0 {
|
||||||
|
shared.RespondEphemeral(s, i, "No meeting lobbies yet. Add one with `/meeting add-lobby`.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
var b strings.Builder
|
||||||
|
fmt.Fprintf(&b, "Meeting lobbies (%d of %d):\n", len(ids), meetingsvc.MaxLobbies)
|
||||||
|
for _, id := range ids {
|
||||||
|
fmt.Fprintf(&b, "<#%d>\n", id)
|
||||||
|
}
|
||||||
|
shared.RespondEphemeral(s, i, b.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
func handleLock(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
func handleLock(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
|||||||
@@ -0,0 +1,575 @@
|
|||||||
|
package public
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
"velox-bot/internal/security"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Every handler re-checks permissions through the security engine. The
|
||||||
|
// DefaultMemberPermissions below only hide commands from the menu; server
|
||||||
|
// admins can change them, so they are never what keeps anyone out.
|
||||||
|
|
||||||
|
var (
|
||||||
|
manageGuild = int64(discordgo.PermissionManageGuild)
|
||||||
|
manageChannel = int64(discordgo.PermissionManageChannels)
|
||||||
|
guildOnly = &[]discordgo.InteractionContextType{discordgo.InteractionContextGuild}
|
||||||
|
textChannels = []discordgo.ChannelType{discordgo.ChannelTypeGuildText, discordgo.ChannelTypeGuildNews}
|
||||||
|
chatChannels = []discordgo.ChannelType{
|
||||||
|
discordgo.ChannelTypeGuildText, discordgo.ChannelTypeGuildNews, discordgo.ChannelTypeGuildForum,
|
||||||
|
discordgo.ChannelTypeGuildVoice, discordgo.ChannelTypeGuildStageVoice,
|
||||||
|
}
|
||||||
|
opTimeout = 3 * time.Minute
|
||||||
|
genericFailed = "Something went wrong. Check that Velox's role is high enough and has the permissions it needs, then try again."
|
||||||
|
)
|
||||||
|
|
||||||
|
var featureChoices = []*discordgo.ApplicationCommandOptionChoice{
|
||||||
|
{Name: "Join Gate", Value: securityrepo.FeatureJoinGate},
|
||||||
|
{Name: "Raid mode", Value: securityrepo.FeatureAntiRaid},
|
||||||
|
{Name: "Anti-nuke", Value: securityrepo.FeatureAntiNuke},
|
||||||
|
{Name: "Heat (anti-spam)", Value: securityrepo.FeatureHeat},
|
||||||
|
}
|
||||||
|
|
||||||
|
var Security = &discordgo.ApplicationCommand{
|
||||||
|
Name: "security",
|
||||||
|
Description: "Anti-raid and anti-nuke protection",
|
||||||
|
DefaultMemberPermissions: &manageGuild,
|
||||||
|
Contexts: guildOnly,
|
||||||
|
Options: []*discordgo.ApplicationCommandOption{
|
||||||
|
{Type: discordgo.ApplicationCommandOptionSubCommand, Name: "status", Description: "Show what's on and who is trusted"},
|
||||||
|
{
|
||||||
|
Type: discordgo.ApplicationCommandOptionSubCommand, Name: "toggle", Description: "Turn a protection on or off",
|
||||||
|
Options: []*discordgo.ApplicationCommandOption{
|
||||||
|
{Type: discordgo.ApplicationCommandOptionString, Name: "feature", Description: "Which protection", Required: true, Choices: featureChoices},
|
||||||
|
{Type: discordgo.ApplicationCommandOptionBoolean, Name: "on", Description: "On or off", Required: true},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
Type: discordgo.ApplicationCommandOptionSubCommand, Name: "alerts", Description: "Where alerts go and which role they ping (owner or trusted)",
|
||||||
|
Options: []*discordgo.ApplicationCommandOption{
|
||||||
|
{Type: discordgo.ApplicationCommandOptionChannel, Name: "channel", Description: "Alert channel", Required: true, ChannelTypes: textChannels},
|
||||||
|
{Type: discordgo.ApplicationCommandOptionRole, Name: "role", Description: "Role to ping for raids and nukes"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
Type: discordgo.ApplicationCommandOptionSubCommand, Name: "quarantine-role", Description: "Role given to quarantined members (owner or trusted)",
|
||||||
|
Options: []*discordgo.ApplicationCommandOption{
|
||||||
|
{Type: discordgo.ApplicationCommandOptionRole, Name: "role", Description: "Leave empty to use none"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
Type: discordgo.ApplicationCommandOptionSubCommandGroup, Name: "trust", Description: "Who is exempt from anti-nuke (owner only)",
|
||||||
|
Options: []*discordgo.ApplicationCommandOption{
|
||||||
|
{
|
||||||
|
Type: discordgo.ApplicationCommandOptionSubCommand, Name: "add", Description: "Trust a user or a role",
|
||||||
|
Options: []*discordgo.ApplicationCommandOption{
|
||||||
|
{Type: discordgo.ApplicationCommandOptionUser, Name: "user", Description: "A user"},
|
||||||
|
{Type: discordgo.ApplicationCommandOptionRole, Name: "role", Description: "A role"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
Type: discordgo.ApplicationCommandOptionSubCommand, Name: "remove", Description: "Stop trusting a user or a role",
|
||||||
|
Options: []*discordgo.ApplicationCommandOption{
|
||||||
|
{Type: discordgo.ApplicationCommandOptionUser, Name: "user", Description: "A user"},
|
||||||
|
{Type: discordgo.ApplicationCommandOptionRole, Name: "role", Description: "A role"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
Type: discordgo.ApplicationCommandOptionSubCommand, Name: "release", Description: "Release a quarantined member (owner or trusted)",
|
||||||
|
Options: []*discordgo.ApplicationCommandOption{
|
||||||
|
{Type: discordgo.ApplicationCommandOptionUser, Name: "user", Description: "Who to release", Required: true},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{Type: discordgo.ApplicationCommandOptionSubCommand, Name: "quarantined", Description: "List quarantined members"},
|
||||||
|
{Type: discordgo.ApplicationCommandOptionSubCommand, Name: "end-raid", Description: "End raid mode now (owner or trusted)"},
|
||||||
|
{Type: discordgo.ApplicationCommandOptionSubCommand, Name: "snapshot", Description: "Save a snapshot of roles and channels to restore from"},
|
||||||
|
{Type: discordgo.ApplicationCommandOptionSubCommand, Name: "restore", Description: "Recreate deleted roles and channels from the latest snapshot (owner or trusted)"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
func lockOptions(unlock bool) []*discordgo.ApplicationCommandOption {
|
||||||
|
verb := "Lock"
|
||||||
|
if unlock {
|
||||||
|
verb = "Unlock"
|
||||||
|
}
|
||||||
|
joins := &discordgo.ApplicationCommandOption{Type: discordgo.ApplicationCommandOptionSubCommand, Name: "joins", Description: verb + " joins"}
|
||||||
|
if !unlock {
|
||||||
|
joins.Description = "Kick or ban everyone who joins until unlocked"
|
||||||
|
joins.Options = []*discordgo.ApplicationCommandOption{{
|
||||||
|
Type: discordgo.ApplicationCommandOptionString, Name: "action", Description: "What happens to new members", Required: true,
|
||||||
|
Choices: []*discordgo.ApplicationCommandOptionChoice{{Name: "Kick", Value: securityrepo.ActionKick}, {Name: "Ban", Value: securityrepo.ActionBan}},
|
||||||
|
}}
|
||||||
|
}
|
||||||
|
return []*discordgo.ApplicationCommandOption{
|
||||||
|
{
|
||||||
|
Type: discordgo.ApplicationCommandOptionSubCommand, Name: "channel", Description: verb + " one channel",
|
||||||
|
Options: []*discordgo.ApplicationCommandOption{{Type: discordgo.ApplicationCommandOptionChannel, Name: "channel", Description: "Defaults to this channel", ChannelTypes: chatChannels}},
|
||||||
|
},
|
||||||
|
{Type: discordgo.ApplicationCommandOptionSubCommand, Name: "server", Description: verb + " every channel"},
|
||||||
|
joins,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var Lockdown = &discordgo.ApplicationCommand{
|
||||||
|
Name: "lockdown", Description: "Stop members from talking, or from joining", DefaultMemberPermissions: &manageChannel,
|
||||||
|
Contexts: guildOnly, Options: lockOptions(false),
|
||||||
|
}
|
||||||
|
|
||||||
|
var Unlock = &discordgo.ApplicationCommand{
|
||||||
|
Name: "unlock", Description: "Undo a lockdown (owner or trusted)", DefaultMemberPermissions: &manageChannel,
|
||||||
|
Contexts: guildOnly, Options: lockOptions(true),
|
||||||
|
}
|
||||||
|
|
||||||
|
func reply(s *discordgo.Session, i *discordgo.InteractionCreate, msg string) {
|
||||||
|
_ = s.InteractionRespond(i.Interaction, &discordgo.InteractionResponse{
|
||||||
|
Type: discordgo.InteractionResponseChannelMessageWithSource,
|
||||||
|
Data: &discordgo.InteractionResponseData{Content: msg, Flags: discordgo.MessageFlagsEphemeral, AllowedMentions: &discordgo.MessageAllowedMentions{}},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func deferReply(s *discordgo.Session, i *discordgo.InteractionCreate) bool {
|
||||||
|
return s.InteractionRespond(i.Interaction, &discordgo.InteractionResponse{
|
||||||
|
Type: discordgo.InteractionResponseDeferredChannelMessageWithSource,
|
||||||
|
Data: &discordgo.InteractionResponseData{Flags: discordgo.MessageFlagsEphemeral},
|
||||||
|
}) == nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func edit(s *discordgo.Session, i *discordgo.InteractionCreate, msg string) {
|
||||||
|
_, _ = s.InteractionResponseEdit(i.Interaction, &discordgo.WebhookEdit{Content: &msg, AllowedMentions: &discordgo.MessageAllowedMentions{}})
|
||||||
|
}
|
||||||
|
|
||||||
|
func message(where string, err error) string {
|
||||||
|
var ue security.UserError
|
||||||
|
if errors.As(err, &ue) {
|
||||||
|
return string(ue)
|
||||||
|
}
|
||||||
|
log.Printf("security command %s: %v", where, err)
|
||||||
|
return genericFailed
|
||||||
|
}
|
||||||
|
|
||||||
|
func opts(o []*discordgo.ApplicationCommandInteractionDataOption) map[string]*discordgo.ApplicationCommandInteractionDataOption {
|
||||||
|
m := map[string]*discordgo.ApplicationCommandInteractionDataOption{}
|
||||||
|
for _, x := range o {
|
||||||
|
m[x.Name] = x
|
||||||
|
}
|
||||||
|
return m
|
||||||
|
}
|
||||||
|
|
||||||
|
func perms(i *discordgo.InteractionCreate) int64 {
|
||||||
|
if i.Member == nil {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
return i.Member.Permissions
|
||||||
|
}
|
||||||
|
|
||||||
|
func userID(i *discordgo.InteractionCreate) string {
|
||||||
|
if i.Member == nil || i.Member.User == nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return i.Member.User.ID
|
||||||
|
}
|
||||||
|
|
||||||
|
func engine(s *discordgo.Session, i *discordgo.InteractionCreate) *security.Engine {
|
||||||
|
e := security.Default()
|
||||||
|
if e == nil || i.GuildID == "" || i.Member == nil {
|
||||||
|
reply(s, i, "Security isn't available right now.")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return e
|
||||||
|
}
|
||||||
|
|
||||||
|
// allowedOrTrusted lets an action through when the member has one of the
|
||||||
|
// permissions, or is the owner or trusted.
|
||||||
|
func allowedOrTrusted(ctx context.Context, e *security.Engine, i *discordgo.InteractionCreate, need int64) bool {
|
||||||
|
if perms(i)&(need|discordgo.PermissionAdministrator) != 0 {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return e.RequireTrusted(ctx, i.GuildID, i.Member) == nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func SecurityHandler(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
e := engine(s, i)
|
||||||
|
if e == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
data := i.ApplicationCommandData()
|
||||||
|
if len(data.Options) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
sub := data.Options[0]
|
||||||
|
args := opts(sub.Options)
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), opTimeout)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
switch sub.Name {
|
||||||
|
case "status":
|
||||||
|
if !allowedOrTrusted(ctx, e, i, discordgo.PermissionManageGuild) {
|
||||||
|
reply(s, i, "You need Manage Server to see the security settings.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
reply(s, i, status(ctx, e, i.GuildID))
|
||||||
|
case "toggle":
|
||||||
|
feature, on := args["feature"].StringValue(), args["on"].BoolValue()
|
||||||
|
if err := e.SetFeature(ctx, i.GuildID, i.Member, perms(i), feature, on); err != nil {
|
||||||
|
reply(s, i, message("toggle", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
state := "off"
|
||||||
|
if on {
|
||||||
|
state = "on"
|
||||||
|
}
|
||||||
|
reply(s, i, fmt.Sprintf("%s is now **%s**.", featureName(feature), state))
|
||||||
|
case "alerts":
|
||||||
|
ch := args["channel"].ChannelValue(nil).ID
|
||||||
|
role := ""
|
||||||
|
if r, ok := args["role"]; ok {
|
||||||
|
role = r.RoleValue(nil, i.GuildID).ID
|
||||||
|
}
|
||||||
|
if err := e.SetAlerts(ctx, i.GuildID, i.Member, ch, role); err != nil {
|
||||||
|
reply(s, i, message("alerts", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
reply(s, i, fmt.Sprintf("Alerts will go to <#%s>.", ch))
|
||||||
|
case "quarantine-role":
|
||||||
|
role := ""
|
||||||
|
if r, ok := args["role"]; ok {
|
||||||
|
role = r.RoleValue(nil, i.GuildID).ID
|
||||||
|
}
|
||||||
|
if err := e.SetQuarantineRole(ctx, i.GuildID, i.Member, role); err != nil {
|
||||||
|
reply(s, i, message("quarantine-role", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if role == "" {
|
||||||
|
reply(s, i, "Quarantined members won't get a role; they still lose their roles and are timed out.")
|
||||||
|
} else {
|
||||||
|
reply(s, i, fmt.Sprintf("Quarantined members will get <@&%s>.", role))
|
||||||
|
}
|
||||||
|
case "trust":
|
||||||
|
if len(sub.Options) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
handleTrust(ctx, s, i, e, sub.Options[0])
|
||||||
|
case "release":
|
||||||
|
if err := e.RequireTrusted(ctx, i.GuildID, i.Member); err != nil {
|
||||||
|
reply(s, i, message("release", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
target := args["user"].UserValue(nil)
|
||||||
|
if !deferReply(s, i) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := e.Release(ctx, i.GuildID, target.ID, userID(i)); err != nil {
|
||||||
|
edit(s, i, message("release", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
edit(s, i, fmt.Sprintf("<@%s> was released and got their roles back.", target.ID))
|
||||||
|
case "quarantined":
|
||||||
|
if !allowedOrTrusted(ctx, e, i, discordgo.PermissionManageGuild) {
|
||||||
|
reply(s, i, "You need Manage Server to see this.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
qs, err := e.Quarantines(ctx, i.GuildID)
|
||||||
|
if err != nil {
|
||||||
|
reply(s, i, message("quarantined", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if len(qs) == 0 {
|
||||||
|
reply(s, i, "Nobody is quarantined.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
var b strings.Builder
|
||||||
|
for _, q := range qs {
|
||||||
|
fmt.Fprintf(&b, "• <@%d>, <t:%d:R>: %s\n", q.UserID, q.CreatedAt.Unix(), q.Reason)
|
||||||
|
}
|
||||||
|
reply(s, i, clip(b.String(), 1900))
|
||||||
|
case "end-raid":
|
||||||
|
endRaid(ctx, s, i, e)
|
||||||
|
case "snapshot":
|
||||||
|
if !allowedOrTrusted(ctx, e, i, discordgo.PermissionManageGuild) {
|
||||||
|
reply(s, i, "You need Manage Server to take a snapshot.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if !deferReply(s, i) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
roles, channels, err := e.TakeSnapshot(ctx, i.GuildID, userID(i))
|
||||||
|
if err != nil {
|
||||||
|
edit(s, i, message("snapshot", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
edit(s, i, fmt.Sprintf("Snapshot saved: %d roles and %d channels. The last three are kept.", roles, channels))
|
||||||
|
case "restore":
|
||||||
|
if err := e.RequireTrusted(ctx, i.GuildID, i.Member); err != nil {
|
||||||
|
reply(s, i, message("restore", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if !deferReply(s, i) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// Recreating many channels takes a while under Discord's rate limits.
|
||||||
|
res, err := e.Restore(ctx, i.GuildID, userID(i))
|
||||||
|
if err != nil {
|
||||||
|
edit(s, i, message("restore", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
edit(s, i, fmt.Sprintf("Restored from the snapshot of <t:%d:f>: %d roles and %d channels recreated, %d roles had dangerous permissions reverted, %d steps failed.",
|
||||||
|
res.SnapshotAt.Unix(), res.RolesCreated, res.ChannelsCreated, res.RolesReverted, res.Failed))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func handleTrust(ctx context.Context, s *discordgo.Session, i *discordgo.InteractionCreate, e *security.Engine, sub *discordgo.ApplicationCommandInteractionDataOption) {
|
||||||
|
args := opts(sub.Options)
|
||||||
|
kind, target := "", ""
|
||||||
|
if u, ok := args["user"]; ok {
|
||||||
|
kind, target = "user", u.UserValue(nil).ID
|
||||||
|
}
|
||||||
|
if r, ok := args["role"]; ok {
|
||||||
|
if target != "" {
|
||||||
|
reply(s, i, "Pick a user or a role, not both.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
kind, target = "role", r.RoleValue(nil, i.GuildID).ID
|
||||||
|
}
|
||||||
|
if target == "" {
|
||||||
|
reply(s, i, "Pick a user or a role.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
mention := "<@" + target + ">"
|
||||||
|
if kind == "role" {
|
||||||
|
mention = "<@&" + target + ">"
|
||||||
|
}
|
||||||
|
switch sub.Name {
|
||||||
|
case "add":
|
||||||
|
if err := e.Trust(ctx, i.GuildID, i.Member, kind, target); err != nil {
|
||||||
|
reply(s, i, message("trust add", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
reply(s, i, mention+" is now trusted: exempt from anti-nuke and able to change security settings.")
|
||||||
|
case "remove":
|
||||||
|
if err := e.Untrust(ctx, i.GuildID, i.Member, target); err != nil {
|
||||||
|
reply(s, i, message("trust remove", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
reply(s, i, mention+" is no longer trusted.")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func endRaid(ctx context.Context, s *discordgo.Session, i *discordgo.InteractionCreate, e *security.Engine) {
|
||||||
|
if err := e.RequireTrusted(ctx, i.GuildID, i.Member); err != nil {
|
||||||
|
reply(s, i, message("end raid", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if !deferReply(s, i) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := e.EndRaid(ctx, i.GuildID, userID(i)); err != nil {
|
||||||
|
edit(s, i, message("end raid", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
edit(s, i, "Raid mode is off.")
|
||||||
|
}
|
||||||
|
|
||||||
|
func featureName(f string) string {
|
||||||
|
switch f {
|
||||||
|
case securityrepo.FeatureJoinGate:
|
||||||
|
return "Join Gate"
|
||||||
|
case securityrepo.FeatureAntiRaid:
|
||||||
|
return "Raid mode"
|
||||||
|
case securityrepo.FeatureAntiNuke:
|
||||||
|
return "Anti-nuke"
|
||||||
|
case securityrepo.FeatureHeat:
|
||||||
|
return "Heat"
|
||||||
|
}
|
||||||
|
return f
|
||||||
|
}
|
||||||
|
|
||||||
|
func onOff(b bool) string {
|
||||||
|
if b {
|
||||||
|
return "✅ on"
|
||||||
|
}
|
||||||
|
return "⬜ off"
|
||||||
|
}
|
||||||
|
|
||||||
|
func status(ctx context.Context, e *security.Engine, guildID string) string {
|
||||||
|
st, trusted, err := e.Settings(ctx, guildID)
|
||||||
|
if err != nil {
|
||||||
|
return message("status", err)
|
||||||
|
}
|
||||||
|
var b strings.Builder
|
||||||
|
fmt.Fprintf(&b, "**Join Gate:** %s\n**Raid mode:** %s (%d joins in %ds → %s)\n**Anti-nuke:** %s (auto restore %s)\n**Heat:** %s (%s)\n",
|
||||||
|
onOff(st.JoinGateEnabled), onOff(st.AntiRaidEnabled), st.RaidJoinCount, st.RaidJoinSeconds, st.RaidAction,
|
||||||
|
onOff(st.AntiNukeEnabled), onOff(st.AntiNukeAutoRestore), onOff(st.HeatEnabled), st.HeatStrictness)
|
||||||
|
if e.RaidActive(guildID) {
|
||||||
|
b.WriteString("🚨 **A raid is in progress.**\n")
|
||||||
|
}
|
||||||
|
if st.JoinLock != securityrepo.ActionOff {
|
||||||
|
fmt.Fprintf(&b, "🔒 Joins are locked (%s).\n", st.JoinLock)
|
||||||
|
}
|
||||||
|
if st.AlertChannelID != 0 {
|
||||||
|
fmt.Fprintf(&b, "**Alerts:** <#%d>", st.AlertChannelID)
|
||||||
|
if st.AlertRoleID != 0 {
|
||||||
|
fmt.Fprintf(&b, ", pinging <@&%d>", st.AlertRoleID)
|
||||||
|
}
|
||||||
|
b.WriteString("\n")
|
||||||
|
} else {
|
||||||
|
b.WriteString("**Alerts:** not set. Use `/security alerts`.\n")
|
||||||
|
}
|
||||||
|
if owner, err := e.OwnerID(guildID); err == nil {
|
||||||
|
fmt.Fprintf(&b, "**Trusted:** <@%s> (owner)", owner)
|
||||||
|
}
|
||||||
|
for _, t := range trusted {
|
||||||
|
if t.Kind == "role" {
|
||||||
|
fmt.Fprintf(&b, ", <@&%d>", t.TargetID)
|
||||||
|
} else {
|
||||||
|
fmt.Fprintf(&b, ", <@%d>", t.TargetID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
b.WriteString("\nFine-tune filters, limits and actions on the dashboard.")
|
||||||
|
return b.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
func clip(s string, n int) string {
|
||||||
|
if r := []rune(s); len(r) > n {
|
||||||
|
return string(r[:n-1]) + "…"
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
func LockdownHandler(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
e := engine(s, i)
|
||||||
|
if e == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
data := i.ApplicationCommandData()
|
||||||
|
if len(data.Options) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
sub := data.Options[0]
|
||||||
|
args := opts(sub.Options)
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), opTimeout)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
switch sub.Name {
|
||||||
|
case "channel":
|
||||||
|
if !allowedOrTrusted(ctx, e, i, discordgo.PermissionManageChannels) {
|
||||||
|
reply(s, i, "You need Manage Channels to lock a channel.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
ch := i.ChannelID
|
||||||
|
if c, ok := args["channel"]; ok {
|
||||||
|
ch = c.ChannelValue(nil).ID
|
||||||
|
}
|
||||||
|
if err := e.LockChannel(ctx, i.GuildID, ch, userID(i), false); err != nil {
|
||||||
|
reply(s, i, message("lock channel", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
reply(s, i, fmt.Sprintf("🔒 <#%s> is locked. `/unlock channel` puts it back as it was.", ch))
|
||||||
|
case "server":
|
||||||
|
if !allowedOrTrusted(ctx, e, i, discordgo.PermissionManageGuild) {
|
||||||
|
reply(s, i, "You need Manage Server to lock the server.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if !deferReply(s, i) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
locked, failed, err := e.LockServer(ctx, i.GuildID, userID(i))
|
||||||
|
if err != nil {
|
||||||
|
edit(s, i, message("lock server", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
msg := fmt.Sprintf("🔒 Locked %d channels.", locked)
|
||||||
|
if failed > 0 {
|
||||||
|
msg += fmt.Sprintf(" %d couldn't be locked (Velox needs Manage Channels there).", failed)
|
||||||
|
}
|
||||||
|
edit(s, i, msg+" `/unlock server` puts them back as they were.")
|
||||||
|
case "joins":
|
||||||
|
if !allowedOrTrusted(ctx, e, i, discordgo.PermissionManageGuild) {
|
||||||
|
reply(s, i, "You need Manage Server to lock joins.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
mode := args["action"].StringValue()
|
||||||
|
if err := e.SetJoinLock(ctx, i.GuildID, mode, userID(i)); err != nil {
|
||||||
|
reply(s, i, message("lock joins", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
reply(s, i, fmt.Sprintf("🔒 Everyone who joins will be %s until `/unlock joins`.", map[string]string{"kick": "kicked", "ban": "banned"}[mode]))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnlockHandler relaxes protection, so it is owner or trusted only.
|
||||||
|
func UnlockHandler(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
e := engine(s, i)
|
||||||
|
if e == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
data := i.ApplicationCommandData()
|
||||||
|
if len(data.Options) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
sub := data.Options[0]
|
||||||
|
args := opts(sub.Options)
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), opTimeout)
|
||||||
|
defer cancel()
|
||||||
|
if err := e.RequireTrusted(ctx, i.GuildID, i.Member); err != nil {
|
||||||
|
reply(s, i, message("unlock", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
switch sub.Name {
|
||||||
|
case "channel":
|
||||||
|
ch := i.ChannelID
|
||||||
|
if c, ok := args["channel"]; ok {
|
||||||
|
ch = c.ChannelValue(nil).ID
|
||||||
|
}
|
||||||
|
if err := e.UnlockChannel(ctx, i.GuildID, ch, userID(i)); err != nil {
|
||||||
|
reply(s, i, message("unlock channel", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
reply(s, i, fmt.Sprintf("🔓 <#%s> is unlocked.", ch))
|
||||||
|
case "server":
|
||||||
|
if !deferReply(s, i) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
unlocked, failed, err := e.UnlockServer(ctx, i.GuildID, userID(i))
|
||||||
|
if err != nil {
|
||||||
|
edit(s, i, message("unlock server", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
msg := fmt.Sprintf("🔓 Unlocked %d channels.", unlocked)
|
||||||
|
if failed > 0 {
|
||||||
|
msg += fmt.Sprintf(" %d failed; try `/unlock server` again.", failed)
|
||||||
|
}
|
||||||
|
edit(s, i, msg)
|
||||||
|
case "joins":
|
||||||
|
if err := e.SetJoinLock(ctx, i.GuildID, securityrepo.ActionOff, userID(i)); err != nil {
|
||||||
|
reply(s, i, message("unlock joins", err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
reply(s, i, "🔓 Joins are open again.")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// HandleComponent handles the alert's "End raid" button. Anyone in the alert
|
||||||
|
// channel can press it, so it checks trust like the command.
|
||||||
|
func HandleComponent(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
e := engine(s, i)
|
||||||
|
if e == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if i.MessageComponentData().CustomID != security.CustomIDEndRaid {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), opTimeout)
|
||||||
|
defer cancel()
|
||||||
|
endRaid(ctx, s, i, e)
|
||||||
|
}
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"velox-bot/internal/commands/security/public"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
Security *discordgo.ApplicationCommand = public.Security
|
||||||
|
Lockdown *discordgo.ApplicationCommand = public.Lockdown
|
||||||
|
Unlock *discordgo.ApplicationCommand = public.Unlock
|
||||||
|
)
|
||||||
|
|
||||||
|
func SecurityHandler(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
public.SecurityHandler(s, i)
|
||||||
|
}
|
||||||
|
|
||||||
|
func LockdownHandler(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
public.LockdownHandler(s, i)
|
||||||
|
}
|
||||||
|
|
||||||
|
func UnlockHandler(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
public.UnlockHandler(s, i)
|
||||||
|
}
|
||||||
|
|
||||||
|
func HandleComponent(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
public.HandleComponent(s, i)
|
||||||
|
}
|
||||||
@@ -60,7 +60,7 @@ var Tickets = &discordgo.ApplicationCommand{
|
|||||||
{
|
{
|
||||||
Type: discordgo.ApplicationCommandOptionSubCommand,
|
Type: discordgo.ApplicationCommandOptionSubCommand,
|
||||||
Name: "add",
|
Name: "add",
|
||||||
Description: "Add a category (one button on the panel)",
|
Description: "Add a category (an option in the panel's dropdown)",
|
||||||
Options: []*discordgo.ApplicationCommandOption{
|
Options: []*discordgo.ApplicationCommandOption{
|
||||||
{Type: discordgo.ApplicationCommandOptionString, Name: "name", Description: "e.g. Support, Report, Appeal", Required: true, MaxLength: 40},
|
{Type: discordgo.ApplicationCommandOptionString, Name: "name", Description: "e.g. Support, Report, Appeal", Required: true, MaxLength: 40},
|
||||||
{Type: discordgo.ApplicationCommandOptionRole, Name: "staff-role", Description: "Who handles these tickets"},
|
{Type: discordgo.ApplicationCommandOptionRole, Name: "staff-role", Description: "Who handles these tickets"},
|
||||||
@@ -424,7 +424,7 @@ func closeTicket(s *discordgo.Session, i *discordgo.InteractionCreate, reason st
|
|||||||
edit(s, i, "Ticket closed.")
|
edit(s, i, "Ticket closed.")
|
||||||
}
|
}
|
||||||
|
|
||||||
// HandleComponent handles the panel buttons and dropdown and the Claim and
|
// HandleComponent handles the panel dropdown and Create ticket button and the Claim and
|
||||||
// Close buttons in a ticket.
|
// Close buttons in a ticket.
|
||||||
func HandleComponent(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
func HandleComponent(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
if Repo == nil {
|
if Repo == nil {
|
||||||
@@ -434,9 +434,12 @@ func HandleComponent(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
|||||||
data := i.MessageComponentData()
|
data := i.MessageComponentData()
|
||||||
switch {
|
switch {
|
||||||
case strings.HasPrefix(data.CustomID, "tickets:open:"):
|
case strings.HasPrefix(data.CustomID, "tickets:open:"):
|
||||||
|
// Panels posted before the dropdown had one button per category.
|
||||||
showOpenForm(s, i, strings.TrimPrefix(data.CustomID, "tickets:open:"))
|
showOpenForm(s, i, strings.TrimPrefix(data.CustomID, "tickets:open:"))
|
||||||
case data.CustomID == "tickets:select" && len(data.Values) > 0:
|
case data.CustomID == "tickets:select" && len(data.Values) > 0:
|
||||||
showOpenForm(s, i, data.Values[0])
|
rememberPick(s, i, data.Values[0])
|
||||||
|
case data.CustomID == "tickets:create":
|
||||||
|
createFromPick(s, i)
|
||||||
case data.CustomID == "tickets:claim":
|
case data.CustomID == "tickets:claim":
|
||||||
claim(s, i)
|
claim(s, i)
|
||||||
case data.CustomID == "tickets:close":
|
case data.CustomID == "tickets:close":
|
||||||
@@ -450,6 +453,31 @@ func HandleComponent(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// rememberPick stores the dropdown choice for the Create ticket button and
|
||||||
|
// acknowledges it without changing the panel, so the choice stays visible.
|
||||||
|
func rememberPick(s *discordgo.Session, i *discordgo.InteractionCreate, rawCategory string) {
|
||||||
|
catID, err := strconv.ParseInt(rawCategory, 10, 64)
|
||||||
|
if err != nil || i.Member == nil || i.Member.User == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
userID, _ := strconv.ParseInt(i.Member.User.ID, 10, 64)
|
||||||
|
tickets.RememberPick(guildID(i), userID, catID)
|
||||||
|
_ = s.InteractionRespond(i.Interaction, &discordgo.InteractionResponse{Type: discordgo.InteractionResponseDeferredMessageUpdate})
|
||||||
|
}
|
||||||
|
|
||||||
|
func createFromPick(s *discordgo.Session, i *discordgo.InteractionCreate) {
|
||||||
|
if i.Member == nil || i.Member.User == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
userID, _ := strconv.ParseInt(i.Member.User.ID, 10, 64)
|
||||||
|
catID, ok := tickets.PickedCategory(guildID(i), userID)
|
||||||
|
if !ok {
|
||||||
|
reply(s, i, "Pick a category from the menu first, then press **Create ticket**.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
showOpenForm(s, i, strconv.FormatInt(catID, 10))
|
||||||
|
}
|
||||||
|
|
||||||
func showOpenForm(s *discordgo.Session, i *discordgo.InteractionCreate, rawCategory string) {
|
func showOpenForm(s *discordgo.Session, i *discordgo.InteractionCreate, rawCategory string) {
|
||||||
catID, err := strconv.ParseInt(rawCategory, 10, 64)
|
catID, err := strconv.ParseInt(rawCategory, 10, 64)
|
||||||
if err != nil || i.Member == nil || i.Member.User == nil {
|
if err != nil || i.Member == nil || i.Member.User == nil {
|
||||||
|
|||||||
@@ -0,0 +1,584 @@
|
|||||||
|
// Package securityrepo stores the anti-raid and anti-nuke settings, the
|
||||||
|
// trusted list, quarantines, locked channels, the event history and the
|
||||||
|
// dashboard's requests. Discord IDs are int64; 0 means "not set".
|
||||||
|
package securityrepo
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"database/sql"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Repo struct {
|
||||||
|
db *sql.DB
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewRepo(db *sql.DB) *Repo {
|
||||||
|
return &Repo{db: db}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Filter actions.
|
||||||
|
const (
|
||||||
|
ActionOff = "off"
|
||||||
|
ActionAlert = "alert" // raid mode only: alert staff, touch nobody
|
||||||
|
ActionTimeout = "timeout"
|
||||||
|
ActionKick = "kick"
|
||||||
|
ActionBan = "ban"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Anti-nuke limit keys.
|
||||||
|
const (
|
||||||
|
LimitChannelDelete = "channel_delete"
|
||||||
|
LimitChannelCreate = "channel_create"
|
||||||
|
LimitRoleDelete = "role_delete"
|
||||||
|
LimitRoleCreate = "role_create"
|
||||||
|
LimitBan = "ban"
|
||||||
|
LimitKick = "kick"
|
||||||
|
LimitWebhookCreate = "webhook_create"
|
||||||
|
)
|
||||||
|
|
||||||
|
// DefaultLimits mirrors the column default in the migration.
|
||||||
|
func DefaultLimits() map[string]int {
|
||||||
|
return map[string]int{
|
||||||
|
LimitChannelDelete: 2, LimitChannelCreate: 5, LimitRoleDelete: 2, LimitRoleCreate: 5,
|
||||||
|
LimitBan: 3, LimitKick: 5, LimitWebhookCreate: 3,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type Settings struct {
|
||||||
|
GuildID int64
|
||||||
|
AlertChannelID int64
|
||||||
|
AlertRoleID int64
|
||||||
|
AlertDM bool
|
||||||
|
|
||||||
|
JoinGateEnabled bool
|
||||||
|
NoAvatar string
|
||||||
|
NewAccount string
|
||||||
|
MinAccountAgeDays int
|
||||||
|
AdvertisingName string
|
||||||
|
UsernameFilter string
|
||||||
|
UsernamePatterns []string
|
||||||
|
UnverifiedBot string
|
||||||
|
UnauthorizedBot string
|
||||||
|
AntiRaidEnabled bool
|
||||||
|
RaidJoinCount int
|
||||||
|
RaidJoinSeconds int
|
||||||
|
RaidAction string
|
||||||
|
RaidPauseInvites bool
|
||||||
|
RaidQuietMinutes int
|
||||||
|
AntiNukeEnabled bool
|
||||||
|
AntiNukeWindowSeconds int
|
||||||
|
AntiNukeLimits map[string]int
|
||||||
|
AntiNukeLockServer bool
|
||||||
|
QuarantineRoleID int64
|
||||||
|
AntiNukeAutoRestore bool
|
||||||
|
HeatEnabled bool
|
||||||
|
HeatStrictness string
|
||||||
|
HeatAction string
|
||||||
|
HeatTimeoutMinutes int
|
||||||
|
HeatEscalate bool
|
||||||
|
HeatBlockedWords []string
|
||||||
|
HeatPanicMembers int
|
||||||
|
HeatLockdownMentions int
|
||||||
|
JoinLock string
|
||||||
|
|
||||||
|
// Configured is false when the guild has no row yet; the fields then
|
||||||
|
// hold the defaults, with every system off.
|
||||||
|
Configured bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func Defaults(guildID int64) *Settings {
|
||||||
|
return &Settings{
|
||||||
|
GuildID: guildID,
|
||||||
|
AlertDM: true,
|
||||||
|
NoAvatar: ActionOff, NewAccount: ActionOff, MinAccountAgeDays: 7, AdvertisingName: ActionOff,
|
||||||
|
UsernameFilter: ActionOff, UnverifiedBot: ActionOff, UnauthorizedBot: ActionKick,
|
||||||
|
RaidJoinCount: 10, RaidJoinSeconds: 10, RaidAction: ActionKick, RaidPauseInvites: true, RaidQuietMinutes: 10,
|
||||||
|
AntiNukeWindowSeconds: 10, AntiNukeLimits: DefaultLimits(),
|
||||||
|
HeatStrictness: "medium", HeatAction: ActionTimeout, HeatTimeoutMinutes: 10, HeatEscalate: true, HeatPanicMembers: 3,
|
||||||
|
JoinLock: ActionOff,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func nullID(v int64) sql.NullInt64 { return sql.NullInt64{Int64: v, Valid: v != 0} }
|
||||||
|
|
||||||
|
func (r *Repo) GetSettings(ctx context.Context, guildID int64) (*Settings, error) {
|
||||||
|
const q = `
|
||||||
|
SELECT alert_channel_id, alert_role_id, alert_dm,
|
||||||
|
joingate_enabled, joingate_no_avatar, joingate_new_account, joingate_min_account_age_days,
|
||||||
|
joingate_advertising_name, joingate_username_filter, to_json(joingate_username_patterns),
|
||||||
|
joingate_unverified_bot, joingate_unauthorized_bot,
|
||||||
|
antiraid_enabled, raid_join_count, raid_join_seconds, raid_action, raid_pause_invites, raid_quiet_minutes,
|
||||||
|
antinuke_enabled, antinuke_window_seconds, antinuke_limits, antinuke_lock_server, quarantine_role_id,
|
||||||
|
antinuke_auto_restore, heat_enabled, heat_strictness, heat_action, heat_timeout_minutes, heat_escalate,
|
||||||
|
to_json(heat_blocked_words), heat_panic_members, heat_lockdown_mentions,
|
||||||
|
join_lock
|
||||||
|
FROM security_settings WHERE guild_id = $1`
|
||||||
|
s := &Settings{GuildID: guildID, Configured: true}
|
||||||
|
var alertCh, alertRole, qRole sql.NullInt64
|
||||||
|
var patterns, words []byte
|
||||||
|
var limits []byte
|
||||||
|
err := r.db.QueryRowContext(ctx, q, guildID).Scan(
|
||||||
|
&alertCh, &alertRole, &s.AlertDM,
|
||||||
|
&s.JoinGateEnabled, &s.NoAvatar, &s.NewAccount, &s.MinAccountAgeDays,
|
||||||
|
&s.AdvertisingName, &s.UsernameFilter, &patterns,
|
||||||
|
&s.UnverifiedBot, &s.UnauthorizedBot,
|
||||||
|
&s.AntiRaidEnabled, &s.RaidJoinCount, &s.RaidJoinSeconds, &s.RaidAction, &s.RaidPauseInvites, &s.RaidQuietMinutes,
|
||||||
|
&s.AntiNukeEnabled, &s.AntiNukeWindowSeconds, &limits, &s.AntiNukeLockServer, &qRole,
|
||||||
|
&s.AntiNukeAutoRestore, &s.HeatEnabled, &s.HeatStrictness, &s.HeatAction, &s.HeatTimeoutMinutes, &s.HeatEscalate,
|
||||||
|
&words, &s.HeatPanicMembers, &s.HeatLockdownMentions,
|
||||||
|
&s.JoinLock,
|
||||||
|
)
|
||||||
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
|
return Defaults(guildID), nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
s.AlertChannelID, s.AlertRoleID, s.QuarantineRoleID = alertCh.Int64, alertRole.Int64, qRole.Int64
|
||||||
|
_ = json.Unmarshal(patterns, &s.UsernamePatterns)
|
||||||
|
_ = json.Unmarshal(words, &s.HeatBlockedWords)
|
||||||
|
s.AntiNukeLimits = DefaultLimits()
|
||||||
|
if len(limits) > 0 {
|
||||||
|
// Saved values override the defaults key by key, so a limit added
|
||||||
|
// in a later version still has a value for older rows.
|
||||||
|
var saved map[string]int
|
||||||
|
if err := json.Unmarshal(limits, &saved); err == nil {
|
||||||
|
for k, v := range saved {
|
||||||
|
s.AntiNukeLimits[k] = v
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return s, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ensureRow makes sure the guild has a settings row so single-column updates
|
||||||
|
// below can be plain UPDATEs.
|
||||||
|
func (r *Repo) ensureRow(ctx context.Context, guildID int64) error {
|
||||||
|
_, err := r.db.ExecContext(ctx, `INSERT INTO security_settings (guild_id) VALUES ($1) ON CONFLICT DO NOTHING`, guildID)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) update(ctx context.Context, guildID int64, set string, args ...any) error {
|
||||||
|
if err := r.ensureRow(ctx, guildID); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
_, err := r.db.ExecContext(ctx, `UPDATE security_settings SET `+set+` WHERE guild_id = $1`, append([]any{guildID}, args...)...)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Feature names accepted by SetEnabled.
|
||||||
|
const (
|
||||||
|
FeatureJoinGate = "joingate"
|
||||||
|
FeatureAntiRaid = "antiraid"
|
||||||
|
FeatureAntiNuke = "antinuke"
|
||||||
|
FeatureHeat = "heat"
|
||||||
|
)
|
||||||
|
|
||||||
|
func (r *Repo) SetEnabled(ctx context.Context, guildID int64, feature string, on bool) error {
|
||||||
|
col := map[string]string{FeatureJoinGate: "joingate_enabled", FeatureAntiRaid: "antiraid_enabled", FeatureAntiNuke: "antinuke_enabled", FeatureHeat: "heat_enabled"}[feature]
|
||||||
|
if col == "" {
|
||||||
|
return errors.New("unknown feature " + feature)
|
||||||
|
}
|
||||||
|
return r.update(ctx, guildID, col+` = $2`, on)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) SetAlerts(ctx context.Context, guildID, channelID, roleID int64) error {
|
||||||
|
return r.update(ctx, guildID, `alert_channel_id = $2, alert_role_id = $3`, nullID(channelID), nullID(roleID))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) SetQuarantineRole(ctx context.Context, guildID, roleID int64) error {
|
||||||
|
return r.update(ctx, guildID, `quarantine_role_id = $2`, nullID(roleID))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) SetJoinLock(ctx context.Context, guildID int64, mode string) error {
|
||||||
|
return r.update(ctx, guildID, `join_lock = $2`, mode)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Trusted ----
|
||||||
|
|
||||||
|
type Trusted struct {
|
||||||
|
TargetID int64
|
||||||
|
Kind string // "user" or "role"
|
||||||
|
AddedBy int64
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) ListTrusted(ctx context.Context, guildID int64) ([]Trusted, error) {
|
||||||
|
rows, err := r.db.QueryContext(ctx, `SELECT target_id, kind, added_by FROM security_trusted WHERE guild_id = $1 ORDER BY created_at`, guildID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
var out []Trusted
|
||||||
|
for rows.Next() {
|
||||||
|
var t Trusted
|
||||||
|
if err := rows.Scan(&t.TargetID, &t.Kind, &t.AddedBy); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out = append(out, t)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) AddTrusted(ctx context.Context, guildID int64, t Trusted) error {
|
||||||
|
_, err := r.db.ExecContext(ctx, `
|
||||||
|
INSERT INTO security_trusted (guild_id, target_id, kind, added_by) VALUES ($1, $2, $3, $4)
|
||||||
|
ON CONFLICT (guild_id, target_id) DO UPDATE SET kind = EXCLUDED.kind`, guildID, t.TargetID, t.Kind, t.AddedBy)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) RemoveTrusted(ctx context.Context, guildID, targetID int64) (bool, error) {
|
||||||
|
res, err := r.db.ExecContext(ctx, `DELETE FROM security_trusted WHERE guild_id = $1 AND target_id = $2`, guildID, targetID)
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
n, err := res.RowsAffected()
|
||||||
|
return n > 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Quarantine ----
|
||||||
|
|
||||||
|
type Quarantine struct {
|
||||||
|
GuildID int64
|
||||||
|
UserID int64
|
||||||
|
PreviousRoleIDs []int64
|
||||||
|
Reason string
|
||||||
|
CreatedAt time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// SaveQuarantine records a quarantine. If the member is already quarantined
|
||||||
|
// the first record is kept, since its roles are the ones to give back.
|
||||||
|
func (r *Repo) SaveQuarantine(ctx context.Context, q Quarantine) error {
|
||||||
|
_, err := r.db.ExecContext(ctx, `
|
||||||
|
INSERT INTO security_quarantines (guild_id, user_id, previous_role_ids, reason)
|
||||||
|
VALUES ($1, $2, COALESCE($3::bigint[], '{}'), $4)
|
||||||
|
ON CONFLICT (guild_id, user_id) DO NOTHING`, q.GuildID, q.UserID, q.PreviousRoleIDs, q.Reason)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func scanQuarantine(row interface{ Scan(...any) error }) (Quarantine, error) {
|
||||||
|
var q Quarantine
|
||||||
|
var roles []byte
|
||||||
|
err := row.Scan(&q.GuildID, &q.UserID, &roles, &q.Reason, &q.CreatedAt)
|
||||||
|
if err == nil {
|
||||||
|
err = json.Unmarshal(roles, &q.PreviousRoleIDs)
|
||||||
|
}
|
||||||
|
return q, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetQuarantine returns nil when the member isn't quarantined.
|
||||||
|
func (r *Repo) GetQuarantine(ctx context.Context, guildID, userID int64) (*Quarantine, error) {
|
||||||
|
q, err := scanQuarantine(r.db.QueryRowContext(ctx, `
|
||||||
|
SELECT guild_id, user_id, to_json(previous_role_ids), reason, created_at FROM security_quarantines
|
||||||
|
WHERE guild_id = $1 AND user_id = $2`, guildID, userID))
|
||||||
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return &q, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) ListQuarantines(ctx context.Context, guildID int64) ([]Quarantine, error) {
|
||||||
|
rows, err := r.db.QueryContext(ctx, `
|
||||||
|
SELECT guild_id, user_id, to_json(previous_role_ids), reason, created_at FROM security_quarantines
|
||||||
|
WHERE guild_id = $1 ORDER BY created_at DESC`, guildID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
var out []Quarantine
|
||||||
|
for rows.Next() {
|
||||||
|
q, err := scanQuarantine(rows)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out = append(out, q)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) DeleteQuarantine(ctx context.Context, guildID, userID int64) error {
|
||||||
|
_, err := r.db.ExecContext(ctx, `DELETE FROM security_quarantines WHERE guild_id = $1 AND user_id = $2`, guildID, userID)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Lockdowns ----
|
||||||
|
|
||||||
|
type Lockdown struct {
|
||||||
|
GuildID int64
|
||||||
|
ChannelID int64
|
||||||
|
HadOverwrite bool
|
||||||
|
PreviousAllow int64
|
||||||
|
PreviousDeny int64
|
||||||
|
ServerWide bool
|
||||||
|
LockedBy int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// SaveLockdown remembers a channel's @everyone overwrite from before it was
|
||||||
|
// locked. A channel that is already locked keeps its first record, which is
|
||||||
|
// the state to go back to.
|
||||||
|
func (r *Repo) SaveLockdown(ctx context.Context, l Lockdown) error {
|
||||||
|
_, err := r.db.ExecContext(ctx, `
|
||||||
|
INSERT INTO security_lockdowns (guild_id, channel_id, had_overwrite, previous_allow, previous_deny, server_wide, locked_by)
|
||||||
|
VALUES ($1, $2, $3, $4, $5, $6, $7)
|
||||||
|
ON CONFLICT (guild_id, channel_id) DO NOTHING`,
|
||||||
|
l.GuildID, l.ChannelID, l.HadOverwrite, l.PreviousAllow, l.PreviousDeny, l.ServerWide, l.LockedBy)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetLockdown returns nil when the channel isn't locked by the bot.
|
||||||
|
func (r *Repo) GetLockdown(ctx context.Context, guildID, channelID int64) (*Lockdown, error) {
|
||||||
|
var l Lockdown
|
||||||
|
err := r.db.QueryRowContext(ctx, `
|
||||||
|
SELECT guild_id, channel_id, had_overwrite, previous_allow, previous_deny, server_wide, locked_by
|
||||||
|
FROM security_lockdowns WHERE guild_id = $1 AND channel_id = $2`, guildID, channelID).
|
||||||
|
Scan(&l.GuildID, &l.ChannelID, &l.HadOverwrite, &l.PreviousAllow, &l.PreviousDeny, &l.ServerWide, &l.LockedBy)
|
||||||
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return &l, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ListLockdowns lists locked channels; serverWideOnly limits it to the ones a
|
||||||
|
// server lockdown locked.
|
||||||
|
func (r *Repo) ListLockdowns(ctx context.Context, guildID int64, serverWideOnly bool) ([]Lockdown, error) {
|
||||||
|
rows, err := r.db.QueryContext(ctx, `
|
||||||
|
SELECT guild_id, channel_id, had_overwrite, previous_allow, previous_deny, server_wide, locked_by
|
||||||
|
FROM security_lockdowns WHERE guild_id = $1 AND (NOT $2 OR server_wide) ORDER BY locked_at`, guildID, serverWideOnly)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
var out []Lockdown
|
||||||
|
for rows.Next() {
|
||||||
|
var l Lockdown
|
||||||
|
if err := rows.Scan(&l.GuildID, &l.ChannelID, &l.HadOverwrite, &l.PreviousAllow, &l.PreviousDeny, &l.ServerWide, &l.LockedBy); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out = append(out, l)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) DeleteLockdown(ctx context.Context, guildID, channelID int64) error {
|
||||||
|
_, err := r.db.ExecContext(ctx, `DELETE FROM security_lockdowns WHERE guild_id = $1 AND channel_id = $2`, guildID, channelID)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Events ----
|
||||||
|
|
||||||
|
type Event struct {
|
||||||
|
GuildID int64
|
||||||
|
Kind string
|
||||||
|
ActorID int64
|
||||||
|
TargetID int64
|
||||||
|
Detail string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Event kinds.
|
||||||
|
const (
|
||||||
|
EventJoinGate = "joingate"
|
||||||
|
EventRaidStarted = "raid_started"
|
||||||
|
EventRaidEnded = "raid_ended"
|
||||||
|
EventNuke = "nuke"
|
||||||
|
EventQuarantined = "quarantined"
|
||||||
|
EventReleased = "released"
|
||||||
|
EventUnauthorizedBot = "unauthorized_bot"
|
||||||
|
EventLocked = "locked"
|
||||||
|
EventUnlocked = "unlocked"
|
||||||
|
EventHeat = "heat"
|
||||||
|
EventHeatPanic = "heat_panic"
|
||||||
|
EventSnapshot = "snapshot"
|
||||||
|
EventRestored = "restored"
|
||||||
|
)
|
||||||
|
|
||||||
|
func (r *Repo) AddEvent(ctx context.Context, e Event) error {
|
||||||
|
_, err := r.db.ExecContext(ctx, `
|
||||||
|
INSERT INTO security_events (guild_id, kind, actor_id, target_id, detail) VALUES ($1, $2, $3, $4, $5)`,
|
||||||
|
e.GuildID, e.Kind, nullID(e.ActorID), nullID(e.TargetID), e.Detail)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Dashboard commands ----
|
||||||
|
|
||||||
|
type Command struct {
|
||||||
|
ID int64
|
||||||
|
GuildID int64
|
||||||
|
CommandType string
|
||||||
|
Payload []byte
|
||||||
|
RequestedBy int64
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) ListUnprocessedCommands(ctx context.Context) ([]Command, error) {
|
||||||
|
rows, err := r.db.QueryContext(ctx, `
|
||||||
|
SELECT id, guild_id, command_type, COALESCE(payload, '{}'::jsonb), requested_by
|
||||||
|
FROM security_commands WHERE processed_at IS NULL ORDER BY id`)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
var out []Command
|
||||||
|
for rows.Next() {
|
||||||
|
var c Command
|
||||||
|
if err := rows.Scan(&c.ID, &c.GuildID, &c.CommandType, &c.Payload, &c.RequestedBy); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out = append(out, c)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) MarkCommandProcessed(ctx context.Context, id int64) error {
|
||||||
|
_, err := r.db.ExecContext(ctx, `UPDATE security_commands SET processed_at = NOW() WHERE id = $1`, id)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Raids in progress ----
|
||||||
|
|
||||||
|
type Raid struct {
|
||||||
|
GuildID int64
|
||||||
|
StartedAt time.Time
|
||||||
|
LastJoinAt time.Time
|
||||||
|
InvitesPaused bool
|
||||||
|
CaughtTotal int
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) SaveRaid(ctx context.Context, x Raid) error {
|
||||||
|
_, err := r.db.ExecContext(ctx, `
|
||||||
|
INSERT INTO security_raids (guild_id, started_at, last_join_at, invites_paused, caught_total)
|
||||||
|
VALUES ($1, $2, $3, $4, $5)
|
||||||
|
ON CONFLICT (guild_id) DO UPDATE SET
|
||||||
|
last_join_at = EXCLUDED.last_join_at, invites_paused = EXCLUDED.invites_paused, caught_total = EXCLUDED.caught_total`,
|
||||||
|
x.GuildID, x.StartedAt, x.LastJoinAt, x.InvitesPaused, x.CaughtTotal)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) ListRaids(ctx context.Context) ([]Raid, error) {
|
||||||
|
rows, err := r.db.QueryContext(ctx, `SELECT guild_id, started_at, last_join_at, invites_paused, caught_total FROM security_raids`)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
var out []Raid
|
||||||
|
for rows.Next() {
|
||||||
|
var x Raid
|
||||||
|
if err := rows.Scan(&x.GuildID, &x.StartedAt, &x.LastJoinAt, &x.InvitesPaused, &x.CaughtTotal); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out = append(out, x)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteRaid ends a raid's record and its caught list.
|
||||||
|
func (r *Repo) DeleteRaid(ctx context.Context, guildID int64) error {
|
||||||
|
if _, err := r.db.ExecContext(ctx, `DELETE FROM security_raid_caught WHERE guild_id = $1`, guildID); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
_, err := r.db.ExecContext(ctx, `DELETE FROM security_raids WHERE guild_id = $1`, guildID)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
type Caught struct {
|
||||||
|
UserID int64
|
||||||
|
Action string
|
||||||
|
Name string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) AddRaidCaught(ctx context.Context, guildID int64, c Caught) error {
|
||||||
|
_, err := r.db.ExecContext(ctx, `
|
||||||
|
INSERT INTO security_raid_caught (guild_id, user_id, action, name) VALUES ($1, $2, $3, $4)
|
||||||
|
ON CONFLICT (guild_id, user_id) DO NOTHING`, guildID, c.UserID, c.Action, c.Name)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Repo) ListRaidCaught(ctx context.Context, guildID int64, limit int) ([]Caught, error) {
|
||||||
|
rows, err := r.db.QueryContext(ctx, `
|
||||||
|
SELECT user_id, action, name FROM security_raid_caught WHERE guild_id = $1 ORDER BY caught_at LIMIT $2`, guildID, limit)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
var out []Caught
|
||||||
|
for rows.Next() {
|
||||||
|
var c Caught
|
||||||
|
if err := rows.Scan(&c.UserID, &c.Action, &c.Name); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out = append(out, c)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Snapshots ----
|
||||||
|
|
||||||
|
const keepSnapshots = 3
|
||||||
|
|
||||||
|
type Snapshot struct {
|
||||||
|
ID int64
|
||||||
|
GuildID int64
|
||||||
|
Data []byte
|
||||||
|
Roles int
|
||||||
|
Channels int
|
||||||
|
CreatedAt time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// SaveSnapshot stores a snapshot and drops all but the newest three.
|
||||||
|
func (r *Repo) SaveSnapshot(ctx context.Context, s Snapshot) error {
|
||||||
|
if _, err := r.db.ExecContext(ctx, `
|
||||||
|
INSERT INTO security_snapshots (guild_id, data, roles, channels) VALUES ($1, $2, $3, $4)`,
|
||||||
|
s.GuildID, s.Data, s.Roles, s.Channels); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
_, err := r.db.ExecContext(ctx, `
|
||||||
|
DELETE FROM security_snapshots WHERE guild_id = $1 AND id NOT IN (
|
||||||
|
SELECT id FROM security_snapshots WHERE guild_id = $1 ORDER BY created_at DESC, id DESC LIMIT $2)`,
|
||||||
|
s.GuildID, keepSnapshots)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// LatestSnapshot returns nil when the guild has none.
|
||||||
|
func (r *Repo) LatestSnapshot(ctx context.Context, guildID int64) (*Snapshot, error) {
|
||||||
|
var s Snapshot
|
||||||
|
err := r.db.QueryRowContext(ctx, `
|
||||||
|
SELECT id, guild_id, data, roles, channels, created_at FROM security_snapshots
|
||||||
|
WHERE guild_id = $1 ORDER BY created_at DESC, id DESC LIMIT 1`, guildID).
|
||||||
|
Scan(&s.ID, &s.GuildID, &s.Data, &s.Roles, &s.Channels, &s.CreatedAt)
|
||||||
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return &s, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GuildsDueForSnapshot lists guilds with anti-nuke on whose newest snapshot
|
||||||
|
// is older than maxAge (or that have none).
|
||||||
|
func (r *Repo) GuildsDueForSnapshot(ctx context.Context, maxAge time.Duration) ([]int64, error) {
|
||||||
|
rows, err := r.db.QueryContext(ctx, `
|
||||||
|
SELECT s.guild_id FROM security_settings s
|
||||||
|
WHERE s.antinuke_enabled AND NOT EXISTS (
|
||||||
|
SELECT 1 FROM security_snapshots p WHERE p.guild_id = s.guild_id AND p.created_at > NOW() - make_interval(secs => $1))`,
|
||||||
|
maxAge.Seconds())
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
var out []int64
|
||||||
|
for rows.Next() {
|
||||||
|
var g int64
|
||||||
|
if err := rows.Scan(&g); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out = append(out, g)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
@@ -0,0 +1,231 @@
|
|||||||
|
//go:build integration
|
||||||
|
|
||||||
|
// Runs against a real Postgres with the dashboard API's migrations applied:
|
||||||
|
//
|
||||||
|
// SECURITY_TEST_DB=postgres://... go test -tags integration ./internal/db/repos/securityrepo
|
||||||
|
package securityrepo
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"database/sql"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
_ "github.com/jackc/pgx/v5/stdlib"
|
||||||
|
)
|
||||||
|
|
||||||
|
func testRepo(t *testing.T) (*Repo, int64) {
|
||||||
|
t.Helper()
|
||||||
|
dsn := os.Getenv("SECURITY_TEST_DB")
|
||||||
|
if dsn == "" {
|
||||||
|
t.Skip("SECURITY_TEST_DB not set")
|
||||||
|
}
|
||||||
|
db, err := sql.Open("pgx", dsn)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
t.Cleanup(func() { db.Close() })
|
||||||
|
const g = 777
|
||||||
|
for _, tbl := range []string{"security_settings", "security_trusted", "security_quarantines", "security_lockdowns", "security_events", "security_commands"} {
|
||||||
|
if _, err := db.Exec(`DELETE FROM `+tbl+` WHERE guild_id = $1`, g); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return NewRepo(db), g
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSettings(t *testing.T) {
|
||||||
|
r, g := testRepo(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
s, err := r.GetSettings(ctx, g)
|
||||||
|
if err != nil || s.Configured || s.JoinGateEnabled || s.AntiNukeEnabled || s.UnauthorizedBot != ActionKick || s.AntiNukeLimits[LimitChannelDelete] != 2 || !s.AlertDM {
|
||||||
|
t.Fatalf("defaults wrong: %+v %v", s, err)
|
||||||
|
}
|
||||||
|
for _, f := range []string{FeatureJoinGate, FeatureAntiRaid, FeatureAntiNuke} {
|
||||||
|
if err := r.SetEnabled(ctx, g, f, true); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := r.SetEnabled(ctx, g, "drop table", true); err == nil {
|
||||||
|
t.Error("unknown features must be refused, never put into SQL")
|
||||||
|
}
|
||||||
|
_ = r.SetAlerts(ctx, g, 10, 20)
|
||||||
|
if _, err := r.db.Exec(`UPDATE security_settings SET alert_dm = false WHERE guild_id = $1`, g); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
_ = r.SetQuarantineRole(ctx, g, 30)
|
||||||
|
_ = r.SetJoinLock(ctx, g, ActionBan)
|
||||||
|
if _, err := r.db.Exec(`UPDATE security_settings SET joingate_username_patterns = '{nitro,free}', antinuke_limits = '{"ban": 0}' WHERE guild_id = $1`, g); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
s, err = r.GetSettings(ctx, g)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !s.Configured || s.AlertDM || !s.JoinGateEnabled || !s.AntiRaidEnabled || !s.AntiNukeEnabled || s.AlertChannelID != 10 || s.AlertRoleID != 20 || s.QuarantineRoleID != 30 || s.JoinLock != ActionBan {
|
||||||
|
t.Errorf("saved settings wrong: %+v", s)
|
||||||
|
}
|
||||||
|
if len(s.UsernamePatterns) != 2 || s.AntiNukeLimits[LimitBan] != 0 || s.AntiNukeLimits[LimitKick] != 5 {
|
||||||
|
t.Errorf("patterns or limits wrong (saved limits override defaults key by key): %+v %+v", s.UsernamePatterns, s.AntiNukeLimits)
|
||||||
|
}
|
||||||
|
if err := r.SetJoinLock(ctx, g, "everyone"); err == nil {
|
||||||
|
t.Error("the database must refuse unknown join lock modes")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTrustedQuarantineLockdown(t *testing.T) {
|
||||||
|
r, g := testRepo(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
_ = r.AddTrusted(ctx, g, Trusted{TargetID: 5, Kind: "user", AddedBy: 1})
|
||||||
|
_ = r.AddTrusted(ctx, g, Trusted{TargetID: 6, Kind: "role", AddedBy: 1})
|
||||||
|
if err := r.AddTrusted(ctx, g, Trusted{TargetID: 7, Kind: "everyone", AddedBy: 1}); err == nil {
|
||||||
|
t.Error("unknown kinds must be refused")
|
||||||
|
}
|
||||||
|
list, _ := r.ListTrusted(ctx, g)
|
||||||
|
if len(list) != 2 {
|
||||||
|
t.Fatalf("trusted = %+v", list)
|
||||||
|
}
|
||||||
|
if ok, _ := r.RemoveTrusted(ctx, g, 5); !ok {
|
||||||
|
t.Error("remove should report true")
|
||||||
|
}
|
||||||
|
|
||||||
|
_ = r.SaveQuarantine(ctx, Quarantine{GuildID: g, UserID: 9, PreviousRoleIDs: []int64{1, 2}, Reason: "first"})
|
||||||
|
_ = r.SaveQuarantine(ctx, Quarantine{GuildID: g, UserID: 9, PreviousRoleIDs: nil, Reason: "second"})
|
||||||
|
q, _ := r.GetQuarantine(ctx, g, 9)
|
||||||
|
if q == nil || len(q.PreviousRoleIDs) != 2 || q.Reason != "first" {
|
||||||
|
t.Errorf("the first quarantine record must be kept: %+v", q)
|
||||||
|
}
|
||||||
|
qs, _ := r.ListQuarantines(ctx, g)
|
||||||
|
if len(qs) != 1 {
|
||||||
|
t.Errorf("list = %+v", qs)
|
||||||
|
}
|
||||||
|
_ = r.DeleteQuarantine(ctx, g, 9)
|
||||||
|
if q, _ := r.GetQuarantine(ctx, g, 9); q != nil {
|
||||||
|
t.Error("deleted")
|
||||||
|
}
|
||||||
|
|
||||||
|
_ = r.SaveLockdown(ctx, Lockdown{GuildID: g, ChannelID: 50, HadOverwrite: true, PreviousAllow: 1, PreviousDeny: 2, ServerWide: true, LockedBy: 1})
|
||||||
|
_ = r.SaveLockdown(ctx, Lockdown{GuildID: g, ChannelID: 50, HadOverwrite: false, PreviousAllow: 9, PreviousDeny: 9, LockedBy: 2})
|
||||||
|
_ = r.SaveLockdown(ctx, Lockdown{GuildID: g, ChannelID: 51, LockedBy: 1})
|
||||||
|
l, _ := r.GetLockdown(ctx, g, 50)
|
||||||
|
if l == nil || !l.HadOverwrite || l.PreviousAllow != 1 || !l.ServerWide {
|
||||||
|
t.Errorf("the first lockdown record must be kept: %+v", l)
|
||||||
|
}
|
||||||
|
if all, _ := r.ListLockdowns(ctx, g, false); len(all) != 2 {
|
||||||
|
t.Errorf("all = %+v", all)
|
||||||
|
}
|
||||||
|
if server, _ := r.ListLockdowns(ctx, g, true); len(server) != 1 {
|
||||||
|
t.Errorf("server-wide = %+v", server)
|
||||||
|
}
|
||||||
|
_ = r.DeleteLockdown(ctx, g, 50)
|
||||||
|
if l, _ := r.GetLockdown(ctx, g, 50); l != nil {
|
||||||
|
t.Error("deleted")
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := r.AddEvent(ctx, Event{GuildID: g, Kind: EventNuke, ActorID: 3, Detail: "x"}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := r.db.Exec(`INSERT INTO security_commands (guild_id, command_type, payload, requested_by) VALUES ($1, 'release_quarantine', '{"user_id":"9"}', 1)`, g); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := r.db.Exec(`INSERT INTO security_commands (guild_id, command_type, requested_by) VALUES ($1, 'grant_admin', 1)`, g); err == nil {
|
||||||
|
t.Error("unknown commands must be refused")
|
||||||
|
}
|
||||||
|
cmds, _ := r.ListUnprocessedCommands(ctx)
|
||||||
|
var mine *Command
|
||||||
|
for i := range cmds {
|
||||||
|
if cmds[i].GuildID == g {
|
||||||
|
mine = &cmds[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if mine == nil || string(mine.Payload) != `{"user_id": "9"}` {
|
||||||
|
t.Fatalf("command = %+v", mine)
|
||||||
|
}
|
||||||
|
_ = r.MarkCommandProcessed(ctx, mine.ID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRaidsSnapshotsAndHeatSettings(t *testing.T) {
|
||||||
|
r, g := testRepo(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
if _, err := r.db.Exec(`DELETE FROM security_raids WHERE guild_id = $1`, g); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
_, _ = r.db.Exec(`DELETE FROM security_raid_caught WHERE guild_id = $1`, g)
|
||||||
|
_, _ = r.db.Exec(`DELETE FROM security_snapshots WHERE guild_id = $1`, g)
|
||||||
|
|
||||||
|
s, _ := r.GetSettings(ctx, g)
|
||||||
|
if s.HeatEnabled || s.HeatStrictness != "medium" || s.HeatTimeoutMinutes != 10 || !s.HeatEscalate || s.HeatPanicMembers != 3 {
|
||||||
|
t.Errorf("heat defaults wrong: %+v", s)
|
||||||
|
}
|
||||||
|
_ = r.SetEnabled(ctx, g, FeatureHeat, true)
|
||||||
|
if _, err := r.db.Exec(`UPDATE security_settings SET heat_blocked_words = '{scam}', antinuke_auto_restore = true WHERE guild_id = $1`, g); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
s, _ = r.GetSettings(ctx, g)
|
||||||
|
if !s.HeatEnabled || !s.AntiNukeAutoRestore || len(s.HeatBlockedWords) != 1 {
|
||||||
|
t.Errorf("heat settings not read back: %+v", s)
|
||||||
|
}
|
||||||
|
if _, err := r.db.Exec(`UPDATE security_settings SET heat_strictness = 'insane' WHERE guild_id = $1`, g); err == nil {
|
||||||
|
t.Error("unknown strictness must be refused by the database")
|
||||||
|
}
|
||||||
|
|
||||||
|
start := time.Now().Add(-time.Minute).UTC().Truncate(time.Millisecond)
|
||||||
|
_ = r.SaveRaid(ctx, Raid{GuildID: g, StartedAt: start, LastJoinAt: start, InvitesPaused: true, CaughtTotal: 1})
|
||||||
|
_ = r.SaveRaid(ctx, Raid{GuildID: g, StartedAt: time.Now(), LastJoinAt: start.Add(time.Second), InvitesPaused: true, CaughtTotal: 2})
|
||||||
|
_ = r.AddRaidCaught(ctx, g, Caught{UserID: 1, Action: "kick", Name: "a"})
|
||||||
|
_ = r.AddRaidCaught(ctx, g, Caught{UserID: 1, Action: "ban", Name: "a"})
|
||||||
|
_ = r.AddRaidCaught(ctx, g, Caught{UserID: 2, Action: "kick", Name: "b"})
|
||||||
|
raids, _ := r.ListRaids(ctx)
|
||||||
|
var mine *Raid
|
||||||
|
for i := range raids {
|
||||||
|
if raids[i].GuildID == g {
|
||||||
|
mine = &raids[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if mine == nil || !mine.StartedAt.Equal(start) || mine.CaughtTotal != 2 {
|
||||||
|
t.Fatalf("raid = %+v (the start time is kept on update)", mine)
|
||||||
|
}
|
||||||
|
caught, _ := r.ListRaidCaught(ctx, g, 10)
|
||||||
|
if len(caught) != 2 || caught[0].Action != "kick" {
|
||||||
|
t.Errorf("caught = %+v (one row per raider)", caught)
|
||||||
|
}
|
||||||
|
_ = r.DeleteRaid(ctx, g)
|
||||||
|
if c, _ := r.ListRaidCaught(ctx, g, 10); len(c) != 0 {
|
||||||
|
t.Error("deleting a raid clears its list")
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := 0; i < 5; i++ {
|
||||||
|
if err := r.SaveSnapshot(ctx, Snapshot{GuildID: g, Data: []byte(`{"roles":[],"channels":[]}`), Roles: i}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var n int
|
||||||
|
_ = r.db.QueryRow(`SELECT COUNT(*) FROM security_snapshots WHERE guild_id = $1`, g).Scan(&n)
|
||||||
|
if n != 3 {
|
||||||
|
t.Errorf("only the last three snapshots are kept, have %d", n)
|
||||||
|
}
|
||||||
|
latest, _ := r.LatestSnapshot(ctx, g)
|
||||||
|
if latest == nil || latest.Roles != 4 {
|
||||||
|
t.Errorf("latest = %+v", latest)
|
||||||
|
}
|
||||||
|
_ = r.SetEnabled(ctx, g, FeatureAntiNuke, true)
|
||||||
|
due, _ := r.GuildsDueForSnapshot(ctx, time.Hour)
|
||||||
|
for _, d := range due {
|
||||||
|
if d == g {
|
||||||
|
t.Error("a guild with a fresh snapshot is not due")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
due, _ = r.GuildsDueForSnapshot(ctx, 0)
|
||||||
|
found := false
|
||||||
|
for _, d := range due {
|
||||||
|
found = found || d == g
|
||||||
|
}
|
||||||
|
if !found {
|
||||||
|
t.Error("with a zero max age every anti-nuke guild is due")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,182 @@
|
|||||||
|
//go:build integration
|
||||||
|
|
||||||
|
// Runs against a real Postgres with the dashboard API's migrations applied
|
||||||
|
// (the lobby limit is a trigger from migration 000020):
|
||||||
|
//
|
||||||
|
// TEST_DB=postgres://... go test -tags integration ./internal/db/repos/settingsrepo
|
||||||
|
package settingsrepo
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"database/sql"
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
_ "github.com/jackc/pgx/v5/stdlib"
|
||||||
|
)
|
||||||
|
|
||||||
|
func testRepo(t *testing.T) (*Repo, int64) {
|
||||||
|
t.Helper()
|
||||||
|
dsn := os.Getenv("TEST_DB")
|
||||||
|
if dsn == "" {
|
||||||
|
t.Skip("TEST_DB not set")
|
||||||
|
}
|
||||||
|
db, err := sql.Open("pgx", dsn)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
t.Cleanup(func() { db.Close() })
|
||||||
|
const guild = 4242
|
||||||
|
if _, err := db.Exec(`DELETE FROM meeting_lobbies WHERE guild_id IN ($1, $2)`, guild, guild+1); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return NewRepo(db), guild
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMeetingLobbies(t *testing.T) {
|
||||||
|
r, g := testRepo(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if ids, err := r.ListMeetingLobbies(ctx, g); err != nil || len(ids) != 0 {
|
||||||
|
t.Fatalf("a fresh server has no lobbies: %v %v", ids, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for ch := int64(1); ch <= MaxMeetingLobbies; ch++ {
|
||||||
|
added, err := r.AddMeetingLobby(ctx, g, ch)
|
||||||
|
if err != nil || !added {
|
||||||
|
t.Fatalf("adding lobby %d: added=%v err=%v", ch, added, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := r.AddMeetingLobby(ctx, g, 99); !errors.Is(err, ErrMeetingLobbyLimit) {
|
||||||
|
t.Errorf("an 11th lobby must hit the limit, got %v", err)
|
||||||
|
}
|
||||||
|
if added, err := r.AddMeetingLobby(ctx, g, 3); err != nil || added {
|
||||||
|
t.Errorf("adding an existing lobby is a no-op even at the limit: added=%v err=%v", added, err)
|
||||||
|
}
|
||||||
|
if added, err := r.AddMeetingLobby(ctx, g+1, 99); err != nil || !added {
|
||||||
|
t.Errorf("the limit is per server: added=%v err=%v", added, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if ok, _ := r.IsMeetingLobby(ctx, g, 7); !ok {
|
||||||
|
t.Error("7 is a lobby")
|
||||||
|
}
|
||||||
|
if ok, _ := r.IsMeetingLobby(ctx, g, 99); ok {
|
||||||
|
t.Error("99 isn't a lobby of this server (it is one of the other server's)")
|
||||||
|
}
|
||||||
|
|
||||||
|
if removed, err := r.RemoveMeetingLobby(ctx, g, 7); err != nil || !removed {
|
||||||
|
t.Errorf("removing 7: removed=%v err=%v", removed, err)
|
||||||
|
}
|
||||||
|
if removed, _ := r.RemoveMeetingLobby(ctx, g, 7); removed {
|
||||||
|
t.Error("7 was already removed")
|
||||||
|
}
|
||||||
|
if ok, _ := r.IsMeetingLobby(ctx, g, 7); ok {
|
||||||
|
t.Error("7 is no longer a lobby")
|
||||||
|
}
|
||||||
|
if added, err := r.AddMeetingLobby(ctx, g, 99); err != nil || !added {
|
||||||
|
t.Errorf("removing one makes room: added=%v err=%v", added, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
ids, err := r.ListMeetingLobbies(ctx, g)
|
||||||
|
if err != nil || len(ids) != MaxMeetingLobbies || ids[len(ids)-1] != 99 {
|
||||||
|
t.Errorf("oldest first, newest last: %v %v", ids, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Two people adding a lobby at the same moment must not both fit under the limit.
|
||||||
|
func TestMeetingLobbiesConcurrent(t *testing.T) {
|
||||||
|
r, g := testRepo(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
for ch := int64(1); ch < MaxMeetingLobbies; ch++ {
|
||||||
|
if _, err := r.AddMeetingLobby(ctx, g, ch); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
var mu sync.Mutex
|
||||||
|
succeeded := 0
|
||||||
|
for i := 0; i < 8; i++ {
|
||||||
|
wg.Add(1)
|
||||||
|
go func(ch int64) {
|
||||||
|
defer wg.Done()
|
||||||
|
if added, err := r.AddMeetingLobby(ctx, g, ch); err == nil && added {
|
||||||
|
mu.Lock()
|
||||||
|
succeeded++
|
||||||
|
mu.Unlock()
|
||||||
|
}
|
||||||
|
}(int64(100 + i))
|
||||||
|
}
|
||||||
|
wg.Wait()
|
||||||
|
if succeeded != 1 {
|
||||||
|
t.Errorf("exactly one of the concurrent adds fits, %d did", succeeded)
|
||||||
|
}
|
||||||
|
if ids, _ := r.ListMeetingLobbies(ctx, g); len(ids) != MaxMeetingLobbies {
|
||||||
|
t.Errorf("have %d lobbies, want %d", len(ids), MaxMeetingLobbies)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetBetaSettings(t *testing.T) {
|
||||||
|
r, _ := testRepo(t)
|
||||||
|
db := r.db
|
||||||
|
ctx := context.Background()
|
||||||
|
_, err := db.ExecContext(ctx, `CREATE TABLE IF NOT EXISTS beta_settings (
|
||||||
|
id BOOLEAN PRIMARY KEY DEFAULT TRUE CHECK (id), guild_id BIGINT, role_id BIGINT, updated_by BIGINT,
|
||||||
|
updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW())`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
var wasG, wasR sql.NullInt64
|
||||||
|
hadRow := db.QueryRowContext(ctx, `SELECT guild_id, role_id FROM beta_settings WHERE id`).Scan(&wasG, &wasR) == nil
|
||||||
|
t.Cleanup(func() {
|
||||||
|
if hadRow {
|
||||||
|
_, _ = db.ExecContext(ctx, `UPDATE beta_settings SET guild_id=$1, role_id=$2 WHERE id`, wasG, wasR)
|
||||||
|
} else {
|
||||||
|
_, _ = db.ExecContext(ctx, `DELETE FROM beta_settings`)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
_, err = db.ExecContext(ctx, `DELETE FROM beta_settings`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
g, role, err := r.GetBetaSettings(ctx)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if g != "" {
|
||||||
|
t.Fatalf("g = %q, want empty", g)
|
||||||
|
}
|
||||||
|
if role != "" {
|
||||||
|
t.Fatalf("role = %q, want empty", role)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = db.ExecContext(ctx, `INSERT INTO beta_settings (id, guild_id) VALUES (TRUE, 1170934850157547600)`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
g, role, err = r.GetBetaSettings(ctx)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if g != "1170934850157547600" {
|
||||||
|
t.Fatalf("g = %q, want %q", g, "1170934850157547600")
|
||||||
|
}
|
||||||
|
if role != "" {
|
||||||
|
t.Fatalf("role = %q, want empty", role)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = db.ExecContext(ctx, `UPDATE beta_settings SET role_id = 42`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
_, role, err = r.GetBetaSettings(ctx)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if role != "42" {
|
||||||
|
t.Fatalf("role = %q, want %q", role, "42")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -3,6 +3,10 @@ package settingsrepo
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"database/sql"
|
"database/sql"
|
||||||
|
"errors"
|
||||||
|
"strconv"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgconn"
|
||||||
)
|
)
|
||||||
|
|
||||||
type Repo struct {
|
type Repo struct {
|
||||||
@@ -25,36 +29,75 @@ func NewRepo(db *sql.DB) *Repo {
|
|||||||
return &Repo{db: db}
|
return &Repo{db: db}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (r *Repo) SetMeetingLobbyChannel(ctx context.Context, guildID int64, lobbyChannelID int64) error {
|
// MaxMeetingLobbies is how many lobby channels one server can have. The
|
||||||
|
// database enforces it too (a trigger from the API's migration 000020), so
|
||||||
|
// the command and the dashboard can't disagree.
|
||||||
|
const MaxMeetingLobbies = 10
|
||||||
|
|
||||||
|
// ErrMeetingLobbyLimit means the server already has MaxMeetingLobbies.
|
||||||
|
var ErrMeetingLobbyLimit = errors.New("meeting lobby limit reached")
|
||||||
|
|
||||||
|
// pgLimitExceeded is the error code the database raises for one lobby too many.
|
||||||
|
const pgLimitExceeded = "54000"
|
||||||
|
|
||||||
|
// AddMeetingLobby makes channelID a lobby. added is false when it already
|
||||||
|
// was one; going over the limit is ErrMeetingLobbyLimit.
|
||||||
|
func (r *Repo) AddMeetingLobby(ctx context.Context, guildID, channelID int64) (added bool, err error) {
|
||||||
const q = `
|
const q = `
|
||||||
INSERT INTO meeting_settings (guild_id, lobby_channel_id)
|
INSERT INTO meeting_lobbies (guild_id, channel_id)
|
||||||
VALUES ($1, $2)
|
VALUES ($1, $2)
|
||||||
ON CONFLICT (guild_id)
|
ON CONFLICT DO NOTHING
|
||||||
DO UPDATE SET lobby_channel_id = EXCLUDED.lobby_channel_id
|
|
||||||
`
|
`
|
||||||
_, err := r.db.ExecContext(ctx, q, guildID, lobbyChannelID)
|
res, err := r.db.ExecContext(ctx, q, guildID, channelID)
|
||||||
return err
|
var pgErr *pgconn.PgError
|
||||||
|
if errors.As(err, &pgErr) && pgErr.Code == pgLimitExceeded {
|
||||||
|
return false, ErrMeetingLobbyLimit
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
n, err := res.RowsAffected()
|
||||||
|
return n > 0, err
|
||||||
}
|
}
|
||||||
|
|
||||||
func (r *Repo) GetMeetingLobbyChannel(ctx context.Context, guildID int64) (channelID int64, ok bool, err error) {
|
// RemoveMeetingLobby takes a channel off the lobby list; removed is false
|
||||||
const q = `
|
// when it wasn't one.
|
||||||
SELECT lobby_channel_id
|
func (r *Repo) RemoveMeetingLobby(ctx context.Context, guildID, channelID int64) (removed bool, err error) {
|
||||||
FROM meeting_settings
|
const q = `DELETE FROM meeting_lobbies WHERE guild_id = $1 AND channel_id = $2`
|
||||||
WHERE guild_id = $1
|
res, err := r.db.ExecContext(ctx, q, guildID, channelID)
|
||||||
`
|
if err != nil {
|
||||||
row := r.db.QueryRowContext(ctx, q, guildID)
|
return false, err
|
||||||
var ch sql.NullInt64
|
|
||||||
switch err := row.Scan(&ch); err {
|
|
||||||
case nil:
|
|
||||||
if !ch.Valid {
|
|
||||||
return 0, false, nil
|
|
||||||
}
|
}
|
||||||
return ch.Int64, true, nil
|
n, err := res.RowsAffected()
|
||||||
case sql.ErrNoRows:
|
return n > 0, err
|
||||||
return 0, false, nil
|
}
|
||||||
default:
|
|
||||||
return 0, false, err
|
// ListMeetingLobbies returns a server's lobbies, oldest first.
|
||||||
|
func (r *Repo) ListMeetingLobbies(ctx context.Context, guildID int64) ([]int64, error) {
|
||||||
|
const q = `SELECT channel_id FROM meeting_lobbies WHERE guild_id = $1 ORDER BY created_at, channel_id`
|
||||||
|
rows, err := r.db.QueryContext(ctx, q, guildID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
}
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
var out []int64
|
||||||
|
for rows.Next() {
|
||||||
|
var id int64
|
||||||
|
if err := rows.Scan(&id); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out = append(out, id)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsMeetingLobby reports whether channelID is one of the server's lobbies.
|
||||||
|
// It runs whenever someone joins a voice channel, so it's one indexed lookup.
|
||||||
|
func (r *Repo) IsMeetingLobby(ctx context.Context, guildID, channelID int64) (bool, error) {
|
||||||
|
const q = `SELECT EXISTS (SELECT 1 FROM meeting_lobbies WHERE guild_id = $1 AND channel_id = $2)`
|
||||||
|
var ok bool
|
||||||
|
err := r.db.QueryRowContext(ctx, q, guildID, channelID).Scan(&ok)
|
||||||
|
return ok, err
|
||||||
}
|
}
|
||||||
|
|
||||||
func (r *Repo) AddMeetingTempChannel(ctx context.Context, guildID, channelID, createdBy int64) error {
|
func (r *Repo) AddMeetingTempChannel(ctx context.Context, guildID, channelID, createdBy int64) error {
|
||||||
@@ -359,3 +402,23 @@ func (r *Repo) SetMusicEnabled(ctx context.Context, guildID int64, enabled bool)
|
|||||||
_, err := r.db.ExecContext(ctx, q, guildID, enabled)
|
_, err := r.db.ExecContext(ctx, q, guildID, enabled)
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetBetaSettings returns the beta server and Beta Tester role as set on the
|
||||||
|
// dashboard. Either is "" when not set (or when there's no row yet).
|
||||||
|
func (r *Repo) GetBetaSettings(ctx context.Context) (guildID, roleID string, err error) {
|
||||||
|
var g, role sql.NullInt64
|
||||||
|
err = r.db.QueryRowContext(ctx, `SELECT guild_id, role_id FROM beta_settings WHERE id = TRUE`).Scan(&g, &role)
|
||||||
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
|
return "", "", nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
if g.Valid {
|
||||||
|
guildID = strconv.FormatInt(g.Int64, 10)
|
||||||
|
}
|
||||||
|
if role.Valid {
|
||||||
|
roleID = strconv.FormatInt(role.Int64, 10)
|
||||||
|
}
|
||||||
|
return guildID, roleID, nil
|
||||||
|
}
|
||||||
@@ -93,9 +93,10 @@ func (r *Repo) GetSettings(ctx context.Context, guildID int64) (*Settings, error
|
|||||||
err := r.db.QueryRowContext(ctx, q, guildID).Scan(&s.Enabled, &ch, &logCh, &panel, &s.PanelTitle, &s.PanelDescription, &s.MaxOpenPerUser)
|
err := r.db.QueryRowContext(ctx, q, guildID).Scan(&s.Enabled, &ch, &logCh, &panel, &s.PanelTitle, &s.PanelDescription, &s.MaxOpenPerUser)
|
||||||
switch {
|
switch {
|
||||||
case errors.Is(err, sql.ErrNoRows):
|
case errors.Is(err, sql.ErrNoRows):
|
||||||
|
// Modules start off until the server sets them up.
|
||||||
return &Settings{
|
return &Settings{
|
||||||
GuildID: guildID,
|
GuildID: guildID,
|
||||||
Enabled: true,
|
Enabled: false,
|
||||||
PanelTitle: DefaultPanelTitle,
|
PanelTitle: DefaultPanelTitle,
|
||||||
PanelDescription: DefaultPanelDescription,
|
PanelDescription: DefaultPanelDescription,
|
||||||
MaxOpenPerUser: DefaultMaxOpenPerUser,
|
MaxOpenPerUser: DefaultMaxOpenPerUser,
|
||||||
@@ -109,11 +110,12 @@ func (r *Repo) GetSettings(ctx context.Context, guildID int64) (*Settings, error
|
|||||||
}
|
}
|
||||||
|
|
||||||
// SetChannels saves where tickets live and where transcripts go. A zero log
|
// SetChannels saves where tickets live and where transcripts go. A zero log
|
||||||
// channel clears it.
|
// channel clears it. Setting tickets up for the first time turns them on
|
||||||
|
// (they start off); after that, the on/off switch is left alone.
|
||||||
func (r *Repo) SetChannels(ctx context.Context, guildID, channelID, logChannelID int64) error {
|
func (r *Repo) SetChannels(ctx context.Context, guildID, channelID, logChannelID int64) error {
|
||||||
const q = `
|
const q = `
|
||||||
INSERT INTO ticket_settings (guild_id, channel_id, log_channel_id)
|
INSERT INTO ticket_settings (guild_id, channel_id, log_channel_id, enabled)
|
||||||
VALUES ($1, $2, $3)
|
VALUES ($1, $2, $3, TRUE)
|
||||||
ON CONFLICT (guild_id) DO UPDATE SET
|
ON CONFLICT (guild_id) DO UPDATE SET
|
||||||
channel_id = EXCLUDED.channel_id,
|
channel_id = EXCLUDED.channel_id,
|
||||||
log_channel_id = EXCLUDED.log_channel_id`
|
log_channel_id = EXCLUDED.log_channel_id`
|
||||||
|
|||||||
@@ -102,10 +102,13 @@ func (r *Repo) GetNotificationChannel(ctx context.Context, guildID int64) (int64
|
|||||||
return chID.Int64, true, nil
|
return chID.Int64, true, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetNotificationChannel sets where live alerts go. Setting it for the first
|
||||||
|
// time turns alerts on (they start off); after that, the on/off switch is
|
||||||
|
// left alone.
|
||||||
func (r *Repo) SetNotificationChannel(ctx context.Context, guildID, channelID int64) error {
|
func (r *Repo) SetNotificationChannel(ctx context.Context, guildID, channelID int64) error {
|
||||||
const q = `
|
const q = `
|
||||||
INSERT INTO twitch_config (guild_id, twitch_channel_id)
|
INSERT INTO twitch_config (guild_id, twitch_channel_id, enabled)
|
||||||
VALUES ($1, $2)
|
VALUES ($1, $2, TRUE)
|
||||||
ON CONFLICT (guild_id)
|
ON CONFLICT (guild_id)
|
||||||
DO UPDATE SET twitch_channel_id = EXCLUDED.twitch_channel_id
|
DO UPDATE SET twitch_channel_id = EXCLUDED.twitch_channel_id
|
||||||
`
|
`
|
||||||
@@ -114,15 +117,14 @@ func (r *Repo) SetNotificationChannel(ctx context.Context, guildID, channelID in
|
|||||||
}
|
}
|
||||||
|
|
||||||
// IsEnabled reports whether Twitch notifications are enabled for guildID.
|
// IsEnabled reports whether Twitch notifications are enabled for guildID.
|
||||||
// A guild with no twitch_config row yet defaults to enabled, matching the
|
// A guild with no twitch_config row yet is off: modules start off until
|
||||||
// column's own DEFAULT TRUE - "never configured" and "explicitly on" are
|
// the server sets them up.
|
||||||
// the same state until someone actually flips it off.
|
|
||||||
func (r *Repo) IsEnabled(ctx context.Context, guildID int64) (bool, error) {
|
func (r *Repo) IsEnabled(ctx context.Context, guildID int64) (bool, error) {
|
||||||
const q = `SELECT enabled FROM twitch_config WHERE guild_id = $1`
|
const q = `SELECT enabled FROM twitch_config WHERE guild_id = $1`
|
||||||
var enabled bool
|
var enabled bool
|
||||||
err := r.db.QueryRowContext(ctx, q, guildID).Scan(&enabled)
|
err := r.db.QueryRowContext(ctx, q, guildID).Scan(&enabled)
|
||||||
if err == sql.ErrNoRows {
|
if err == sql.ErrNoRows {
|
||||||
return true, nil
|
return false, nil
|
||||||
}
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return false, err
|
return false, err
|
||||||
|
|||||||
@@ -14,12 +14,26 @@ func New(settings *settingsrepo.Repo) *Service {
|
|||||||
return &Service{settings: settings}
|
return &Service{settings: settings}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *Service) SetLobbyChannel(ctx context.Context, guildID int64, lobbyChannelID int64) error {
|
// MaxLobbies is how many lobbies a server can have.
|
||||||
return s.settings.SetMeetingLobbyChannel(ctx, guildID, lobbyChannelID)
|
const MaxLobbies = settingsrepo.MaxMeetingLobbies
|
||||||
|
|
||||||
|
// ErrLobbyLimit means the server already has MaxLobbies.
|
||||||
|
var ErrLobbyLimit = settingsrepo.ErrMeetingLobbyLimit
|
||||||
|
|
||||||
|
func (s *Service) AddLobby(ctx context.Context, guildID, channelID int64) (added bool, err error) {
|
||||||
|
return s.settings.AddMeetingLobby(ctx, guildID, channelID)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *Service) GetLobbyChannel(ctx context.Context, guildID int64) (channelID int64, ok bool, err error) {
|
func (s *Service) RemoveLobby(ctx context.Context, guildID, channelID int64) (removed bool, err error) {
|
||||||
return s.settings.GetMeetingLobbyChannel(ctx, guildID)
|
return s.settings.RemoveMeetingLobby(ctx, guildID, channelID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) ListLobbies(ctx context.Context, guildID int64) ([]int64, error) {
|
||||||
|
return s.settings.ListMeetingLobbies(ctx, guildID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) IsLobby(ctx context.Context, guildID, channelID int64) (bool, error) {
|
||||||
|
return s.settings.IsMeetingLobby(ctx, guildID, channelID)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *Service) AddTempChannel(ctx context.Context, guildID, channelID, createdBy int64) error {
|
func (s *Service) AddTempChannel(ctx context.Context, guildID, channelID, createdBy int64) error {
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
// HandleVoiceStateUpdate implements the "meeting lobby" behavior:
|
// HandleVoiceStateUpdate implements the "meeting lobby" behavior:
|
||||||
// - When a user joins the configured lobby voice channel, create a temporary voice channel
|
// - When a user joins one of the server's lobby voice channels, create a temporary voice channel
|
||||||
// with the same UserLimit and move the user into it.
|
// with the same UserLimit and move the user into it.
|
||||||
// - When a temporary channel becomes empty, delete it.
|
// - When a temporary channel becomes empty, delete it.
|
||||||
func HandleVoiceStateUpdate(s *discordgo.Session, vs *discordgo.VoiceStateUpdate, svc *services.Services) {
|
func HandleVoiceStateUpdate(s *discordgo.Session, vs *discordgo.VoiceStateUpdate, svc *services.Services) {
|
||||||
@@ -40,11 +40,12 @@ func HandleVoiceStateUpdate(s *discordgo.Session, vs *discordgo.VoiceStateUpdate
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
lobbyID, ok, err := svc.Meeting.GetLobbyChannel(ctx, guildID64)
|
joinedID, err := strconv.ParseInt(vs.ChannelID, 10, 64)
|
||||||
if err != nil || !ok || lobbyID == 0 {
|
if err != nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if vs.ChannelID != strconv.FormatInt(lobbyID, 10) {
|
isLobby, err := svc.Meeting.IsLobby(ctx, guildID64, joinedID)
|
||||||
|
if err != nil || !isLobby {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -114,3 +115,21 @@ func tryCleanupTempChannel(s *discordgo.Session, ctx context.Context, svc *servi
|
|||||||
_ = svc.Meeting.RemoveTempChannel(ctx, guildID64, chID64)
|
_ = svc.Meeting.RemoveTempChannel(ctx, guildID64, chID64)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// HandleChannelDelete drops a deleted voice channel from the meeting lobbies,
|
||||||
|
// so it doesn't keep using up one of the server's slots.
|
||||||
|
func HandleChannelDelete(_ *discordgo.Session, c *discordgo.ChannelDelete, svc *services.Services) {
|
||||||
|
if svc == nil || svc.Meeting == nil || c == nil || c.Channel == nil || c.GuildID == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if c.Type != discordgo.ChannelTypeGuildVoice {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
guildID, err1 := strconv.ParseInt(c.GuildID, 10, 64)
|
||||||
|
channelID, err2 := strconv.ParseInt(c.ID, 10, 64)
|
||||||
|
if err1 != nil || err2 != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if _, err := svc.Meeting.RemoveLobby(context.Background(), guildID, channelID); err != nil {
|
||||||
|
log.Printf("meeting: removing deleted lobby guild=%s channel=%s err=%v", c.GuildID, c.ID, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,144 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"log"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
colorAlert = 0xdc2626
|
||||||
|
colorWarn = 0xf59e0b
|
||||||
|
colorOK = 0x16a34a
|
||||||
|
)
|
||||||
|
|
||||||
|
type alert struct {
|
||||||
|
embed *discordgo.MessageEmbed
|
||||||
|
ping bool // ping the alert role (raids and nukes, not routine join gate actions)
|
||||||
|
pingOwner bool
|
||||||
|
// critical alerts also go by DM to the owner and trusted users, since
|
||||||
|
// the alert channel may be gone or locked in exactly these moments.
|
||||||
|
critical bool
|
||||||
|
components []discordgo.MessageComponent
|
||||||
|
file *discordgo.File
|
||||||
|
}
|
||||||
|
|
||||||
|
// send posts an alert to the configured channel. It only ever pings the
|
||||||
|
// configured alert role (never @everyone, even if that was saved somehow) and
|
||||||
|
// optionally the owner.
|
||||||
|
func (e *Engine) send(ctx context.Context, guildID string, s *securityrepo.Settings, a alert) *discordgo.Message {
|
||||||
|
if a.critical && s.AlertDM {
|
||||||
|
if e.syncDMs {
|
||||||
|
e.dmAlert(ctx, guildID, s, a)
|
||||||
|
} else {
|
||||||
|
go e.dmAlert(context.Background(), guildID, s, a)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if s.AlertChannelID == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
msg := &discordgo.MessageSend{
|
||||||
|
Embeds: []*discordgo.MessageEmbed{a.embed},
|
||||||
|
Components: a.components,
|
||||||
|
AllowedMentions: &discordgo.MessageAllowedMentions{},
|
||||||
|
}
|
||||||
|
if a.ping && s.AlertRoleID != 0 && id(s.AlertRoleID) != guildID {
|
||||||
|
msg.Content = "<@&" + id(s.AlertRoleID) + ">"
|
||||||
|
msg.AllowedMentions.Roles = []string{id(s.AlertRoleID)}
|
||||||
|
}
|
||||||
|
if a.pingOwner {
|
||||||
|
if owner, err := e.OwnerID(guildID); err == nil && owner != "" {
|
||||||
|
msg.Content += " <@" + owner + ">"
|
||||||
|
msg.AllowedMentions.Users = []string{owner}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if a.file != nil {
|
||||||
|
msg.Files = []*discordgo.File{a.file}
|
||||||
|
}
|
||||||
|
m, err := e.d.ChannelMessageSendComplex(id(s.AlertChannelID), msg)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("security: alert in guild %s: %v", guildID, err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return m
|
||||||
|
}
|
||||||
|
|
||||||
|
func textFile(name, content string) *discordgo.File {
|
||||||
|
return &discordgo.File{Name: name, ContentType: "text/plain; charset=utf-8", Reader: bytes.NewReader([]byte(content))}
|
||||||
|
}
|
||||||
|
|
||||||
|
// maxAlertDMs caps how many people get each critical alert by DM. Mass DMs
|
||||||
|
// from a bot look like spam to Discord.
|
||||||
|
const maxAlertDMs = 10
|
||||||
|
|
||||||
|
// alertDMRecipients is the owner plus trusted users (not roles, which could
|
||||||
|
// hold many members), without duplicates or the bot itself.
|
||||||
|
func (e *Engine) alertDMRecipients(ctx context.Context, guildID string) []string {
|
||||||
|
seen := map[string]bool{e.botID: true}
|
||||||
|
var out []string
|
||||||
|
add := func(u string) {
|
||||||
|
if u != "" && !seen[u] && len(out) < maxAlertDMs {
|
||||||
|
seen[u] = true
|
||||||
|
out = append(out, u)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if owner, err := e.OwnerID(guildID); err == nil {
|
||||||
|
add(owner)
|
||||||
|
}
|
||||||
|
if _, trusted, err := e.load(ctx, guildID); err == nil {
|
||||||
|
for _, t := range trusted {
|
||||||
|
if t.Kind == "user" {
|
||||||
|
add(id(t.TargetID))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// dmAlert sends a critical alert to each recipient's DMs. Closed DMs and
|
||||||
|
// other failures are skipped: the alert channel is still the main record.
|
||||||
|
func (e *Engine) dmAlert(ctx context.Context, guildID string, s *securityrepo.Settings, a alert) {
|
||||||
|
if a.embed == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
server := e.guildName(guildID)
|
||||||
|
if server == "" {
|
||||||
|
server = "a server"
|
||||||
|
}
|
||||||
|
embed := *a.embed
|
||||||
|
embed.Footer = &discordgo.MessageEmbedFooter{Text: clip("Velox security · "+server, 200)}
|
||||||
|
extra := ""
|
||||||
|
if a.file != nil {
|
||||||
|
if s.AlertChannelID != 0 {
|
||||||
|
extra = "\nThe full list is posted in the alert channel."
|
||||||
|
} else {
|
||||||
|
extra = "\nSet an alert channel on the dashboard to also get the full list of accounts."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if extra != "" {
|
||||||
|
embed.Description = clip(embed.Description+extra, 4000)
|
||||||
|
}
|
||||||
|
msg := &discordgo.MessageSend{
|
||||||
|
Content: "Security alert in **" + escapeText(server) + "**. Use the dashboard or `/security` in the server to act.",
|
||||||
|
Embeds: []*discordgo.MessageEmbed{&embed},
|
||||||
|
AllowedMentions: &discordgo.MessageAllowedMentions{},
|
||||||
|
}
|
||||||
|
for _, u := range e.alertDMRecipients(ctx, guildID) {
|
||||||
|
ch, err := e.d.UserChannelCreate(u)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if _, err := e.d.ChannelMessageSendComplex(ch.ID, msg); err != nil {
|
||||||
|
log.Printf("security: DM alert to %s for guild %s: %v", u, guildID, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// escapeText defuses markdown and mentions in a name (e.g. a server name).
|
||||||
|
func escapeText(s string) string {
|
||||||
|
return safeName(&discordgo.User{Username: s})
|
||||||
|
}
|
||||||
@@ -0,0 +1,207 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The configuration calls below do their own permission checks, so every
|
||||||
|
// way in (slash commands, buttons, anything added later) gets the same rules:
|
||||||
|
//
|
||||||
|
// - switching a system on: Manage Server, or owner/trusted
|
||||||
|
// - switching a system off, alert and quarantine settings: owner/trusted
|
||||||
|
// - the trusted list: owner only
|
||||||
|
//
|
||||||
|
// actorPerms is the actor's permission set as Discord sent it with the
|
||||||
|
// interaction.
|
||||||
|
|
||||||
|
const maxTrusted = 25
|
||||||
|
|
||||||
|
func hasManageGuild(perms int64) bool {
|
||||||
|
return perms&(discordgo.PermissionAdministrator|discordgo.PermissionManageGuild) != 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetFeature turns the Join Gate, raid mode or anti-nuke on or off.
|
||||||
|
func (e *Engine) SetFeature(ctx context.Context, guildID string, actor *discordgo.Member, actorPerms int64, feature string, on bool) error {
|
||||||
|
if actor == nil || actor.User == nil {
|
||||||
|
return ErrNotTrusted
|
||||||
|
}
|
||||||
|
switch feature {
|
||||||
|
case securityrepo.FeatureJoinGate, securityrepo.FeatureAntiRaid, securityrepo.FeatureAntiNuke, securityrepo.FeatureHeat:
|
||||||
|
default:
|
||||||
|
return UserError("Unknown feature.")
|
||||||
|
}
|
||||||
|
trustedErr := e.RequireTrusted(ctx, guildID, actor)
|
||||||
|
if !on && trustedErr != nil {
|
||||||
|
return trustedErr
|
||||||
|
}
|
||||||
|
if on && trustedErr != nil && !hasManageGuild(actorPerms) {
|
||||||
|
return UserError("You need Manage Server to turn security features on.")
|
||||||
|
}
|
||||||
|
if err := e.st.SetEnabled(ctx, parseID(guildID), feature, on); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
e.Invalidate(guildID)
|
||||||
|
state := "off"
|
||||||
|
if on {
|
||||||
|
state = "on"
|
||||||
|
}
|
||||||
|
e.event(ctx, guildID, "settings", actor.User.ID, "", feature+" "+state)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *Engine) roleByID(guildID, roleID string) (*discordgo.Role, []*discordgo.Role, error) {
|
||||||
|
roles, err := e.d.GuildRoles(guildID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, fmt.Errorf("listing roles: %w", err)
|
||||||
|
}
|
||||||
|
for _, r := range roles {
|
||||||
|
if r.ID == roleID {
|
||||||
|
return r, roles, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil, roles, UserError("That role isn't in this server.")
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetAlerts sets where alerts go and which role they ping. Changing it could
|
||||||
|
// hide alerts from the staff, so it needs owner or trusted.
|
||||||
|
func (e *Engine) SetAlerts(ctx context.Context, guildID string, actor *discordgo.Member, channelID, roleID string) error {
|
||||||
|
if err := e.RequireTrusted(ctx, guildID, actor); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
ch, err := e.d.Channel(channelID)
|
||||||
|
if err != nil || ch.GuildID != guildID {
|
||||||
|
return UserError("That channel isn't in this server.")
|
||||||
|
}
|
||||||
|
if ch.Type != discordgo.ChannelTypeGuildText && ch.Type != discordgo.ChannelTypeGuildNews {
|
||||||
|
return UserError("Alerts need a text channel.")
|
||||||
|
}
|
||||||
|
if roleID != "" {
|
||||||
|
if roleID == guildID {
|
||||||
|
return UserError("Alerts can't ping @everyone. Pick a staff role.")
|
||||||
|
}
|
||||||
|
if _, _, err := e.roleByID(guildID, roleID); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := e.st.SetAlerts(ctx, parseID(guildID), parseID(channelID), parseID(roleID)); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
e.Invalidate(guildID)
|
||||||
|
e.event(ctx, guildID, "settings", actor.User.ID, channelID, "alerts channel and role changed")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ValidateQuarantineRole checks a role can safely be the quarantine role:
|
||||||
|
// in this server, not @everyone, not managed, no dangerous permissions, and
|
||||||
|
// below Velox's highest role so the bot can assign it.
|
||||||
|
func (e *Engine) ValidateQuarantineRole(guildID, roleID string) error {
|
||||||
|
if roleID == guildID {
|
||||||
|
return UserError("@everyone can't be the quarantine role.")
|
||||||
|
}
|
||||||
|
role, roles, err := e.roleByID(guildID, roleID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if role.Managed {
|
||||||
|
return UserError("That role is managed by an integration and can't be assigned.")
|
||||||
|
}
|
||||||
|
if role.Permissions&DangerousPerms != 0 {
|
||||||
|
return UserError("The quarantine role can't have Administrator, Manage Server, Manage Roles or Manage Webhooks.")
|
||||||
|
}
|
||||||
|
me, err := e.d.GuildMember(guildID, e.botID)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("looking up Velox: %w", err)
|
||||||
|
}
|
||||||
|
top := -1
|
||||||
|
for _, r := range roles {
|
||||||
|
for _, mine := range me.Roles {
|
||||||
|
if r.ID == mine && r.Position > top {
|
||||||
|
top = r.Position
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if role.Position >= top {
|
||||||
|
return UserError("That role is above Velox's highest role, so Velox couldn't assign it. Move it below Velox's role.")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetQuarantineRole sets (or with "" clears) the quarantine role.
|
||||||
|
func (e *Engine) SetQuarantineRole(ctx context.Context, guildID string, actor *discordgo.Member, roleID string) error {
|
||||||
|
if err := e.RequireTrusted(ctx, guildID, actor); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if roleID != "" {
|
||||||
|
if err := e.ValidateQuarantineRole(guildID, roleID); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := e.st.SetQuarantineRole(ctx, parseID(guildID), parseID(roleID)); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
e.Invalidate(guildID)
|
||||||
|
e.event(ctx, guildID, "settings", actor.User.ID, roleID, "quarantine role changed")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Trust adds a user or role to the trusted list. Owner only: anyone trusted
|
||||||
|
// can switch protection off, so trust must not spread on its own.
|
||||||
|
func (e *Engine) Trust(ctx context.Context, guildID string, actor *discordgo.Member, kind, targetID string) error {
|
||||||
|
if actor == nil || actor.User == nil || !e.IsOwner(guildID, actor.User.ID) {
|
||||||
|
return ErrNotOwner
|
||||||
|
}
|
||||||
|
_, trusted, err := e.load(ctx, guildID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if len(trusted) >= maxTrusted {
|
||||||
|
return UserError(fmt.Sprintf("The trusted list can hold at most %d entries.", maxTrusted))
|
||||||
|
}
|
||||||
|
switch kind {
|
||||||
|
case "role":
|
||||||
|
if targetID == guildID {
|
||||||
|
return UserError("Trusting @everyone would make everyone trusted.")
|
||||||
|
}
|
||||||
|
role, _, err := e.roleByID(guildID, targetID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if role.Managed {
|
||||||
|
return UserError("Integration roles can't be trusted; trust the bot user instead.")
|
||||||
|
}
|
||||||
|
case "user":
|
||||||
|
if _, err := e.d.GuildMember(guildID, targetID); err != nil {
|
||||||
|
return UserError("That user isn't in this server.")
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return UserError("Trust a user or a role.")
|
||||||
|
}
|
||||||
|
if err := e.st.AddTrusted(ctx, parseID(guildID), securityrepo.Trusted{TargetID: parseID(targetID), Kind: kind, AddedBy: parseID(actor.User.ID)}); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
e.Invalidate(guildID)
|
||||||
|
e.event(ctx, guildID, "trusted_added", actor.User.ID, targetID, kind)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Untrust removes a user or role from the trusted list. Owner only.
|
||||||
|
func (e *Engine) Untrust(ctx context.Context, guildID string, actor *discordgo.Member, targetID string) error {
|
||||||
|
if actor == nil || actor.User == nil || !e.IsOwner(guildID, actor.User.ID) {
|
||||||
|
return ErrNotOwner
|
||||||
|
}
|
||||||
|
ok, err := e.st.RemoveTrusted(ctx, parseID(guildID), parseID(targetID))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !ok {
|
||||||
|
return UserError("That isn't on the trusted list.")
|
||||||
|
}
|
||||||
|
e.Invalidate(guildID)
|
||||||
|
e.event(ctx, guildID, "trusted_removed", actor.User.ID, targetID, "")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
func nuke(e *Engine) {
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberPrune, "50", ""))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCriticalAlertsAreDMed(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
d.guildName = "Velox **HQ** @everyone"
|
||||||
|
// Owner (1) is also on the list as a user; a trusted role must not be expanded.
|
||||||
|
st.trusted[100] = []securityrepo.Trusted{{TargetID: 1, Kind: "user"}, {TargetID: 60, Kind: "user"}, {TargetID: 201, Kind: "role"}, {TargetID: 999, Kind: "user"}}
|
||||||
|
refresh(e)
|
||||||
|
nuke(e)
|
||||||
|
|
||||||
|
got := strings.Join(d.dmsTo(), ",")
|
||||||
|
if got != "1,60" {
|
||||||
|
t.Fatalf("DMs went to %q, want the owner and the trusted user once each (no role members, not the bot)", got)
|
||||||
|
}
|
||||||
|
var dm *discordgo.MessageSend
|
||||||
|
for i, ch := range d.sentTo {
|
||||||
|
if ch == "dm-1" {
|
||||||
|
dm = d.sent[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !strings.Contains(dm.Embeds[0].Title, "Nuke attempt stopped") {
|
||||||
|
t.Errorf("DM should carry the alert: %+v", dm.Embeds[0])
|
||||||
|
}
|
||||||
|
if strings.Contains(dm.Content, "@everyone") || strings.Contains(dm.Content, "**HQ**") || dm.AllowedMentions == nil {
|
||||||
|
t.Errorf("the server name must be escaped and nothing pinged: %q", dm.Content)
|
||||||
|
}
|
||||||
|
if len(dm.Components) != 0 {
|
||||||
|
t.Error("no action buttons in DMs")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDMsWorkWithoutAnAlertChannel(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
st.set(100).AlertChannelID = 0
|
||||||
|
refresh(e)
|
||||||
|
nuke(e)
|
||||||
|
if strings.Join(d.dmsTo(), ",") != "1" {
|
||||||
|
t.Errorf("the owner should still be told: %v", d.dmsTo())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDMsCanBeTurnedOff(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
st.set(100).AlertDM = false
|
||||||
|
refresh(e)
|
||||||
|
nuke(e)
|
||||||
|
if len(d.dmsTo()) != 0 {
|
||||||
|
t.Errorf("DMs are off: %v", d.dmsTo())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRoutineAlertsAreNotDMed(t *testing.T) {
|
||||||
|
e, d, st, now := testEngine(t)
|
||||||
|
s := st.set(100)
|
||||||
|
s.JoinGateEnabled, s.NoAvatar = true, securityrepo.ActionKick
|
||||||
|
refresh(e)
|
||||||
|
e.OnMemberJoin(ctx, guild, &discordgo.Member{User: &discordgo.User{ID: snowflakeAt(now.AddDate(-1, 0, 0), 1)}})
|
||||||
|
if len(d.dmsTo()) != 0 {
|
||||||
|
t.Error("Join Gate actions only go to the alert channel")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestClosedDMsAreSkippedAndListIsCapped(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
d.closedDMs = map[string]bool{"1": true}
|
||||||
|
for i := 0; i < 15; i++ {
|
||||||
|
st.trusted[100] = append(st.trusted[100], securityrepo.Trusted{TargetID: int64(700 + i), Kind: "user"})
|
||||||
|
}
|
||||||
|
refresh(e)
|
||||||
|
nuke(e)
|
||||||
|
got := d.dmsTo()
|
||||||
|
if len(got) != maxAlertDMs-1 {
|
||||||
|
t.Errorf("owner's DMs are closed and the list is capped at %d: got %d (%v)", maxAlertDMs, len(got), got)
|
||||||
|
}
|
||||||
|
if got[0] != fmt.Sprint(700) {
|
||||||
|
t.Errorf("the others still get it: %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,557 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"sort"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fakeStore keeps everything in memory with the same rules as the SQL.
|
||||||
|
type fakeStore struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
settings map[int64]*securityrepo.Settings
|
||||||
|
trusted map[int64][]securityrepo.Trusted
|
||||||
|
quarantines map[string]securityrepo.Quarantine
|
||||||
|
lockdowns map[string]securityrepo.Lockdown
|
||||||
|
events []securityrepo.Event
|
||||||
|
cmds []securityrepo.Command
|
||||||
|
done map[int64]bool
|
||||||
|
raids map[int64]securityrepo.Raid
|
||||||
|
caught map[int64][]securityrepo.Caught
|
||||||
|
snapshots []securityrepo.Snapshot
|
||||||
|
}
|
||||||
|
|
||||||
|
func newStore() *fakeStore {
|
||||||
|
return &fakeStore{
|
||||||
|
settings: map[int64]*securityrepo.Settings{}, trusted: map[int64][]securityrepo.Trusted{},
|
||||||
|
quarantines: map[string]securityrepo.Quarantine{}, lockdowns: map[string]securityrepo.Lockdown{}, done: map[int64]bool{},
|
||||||
|
raids: map[int64]securityrepo.Raid{}, caught: map[int64][]securityrepo.Caught{},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fakeStore) SaveRaid(_ context.Context, x securityrepo.Raid) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
if old, ok := f.raids[x.GuildID]; ok {
|
||||||
|
x.StartedAt = old.StartedAt
|
||||||
|
}
|
||||||
|
f.raids[x.GuildID] = x
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) ListRaids(context.Context) ([]securityrepo.Raid, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
var out []securityrepo.Raid
|
||||||
|
for _, x := range f.raids {
|
||||||
|
out = append(out, x)
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) DeleteRaid(_ context.Context, g int64) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
delete(f.raids, g)
|
||||||
|
delete(f.caught, g)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) AddRaidCaught(_ context.Context, g int64, c securityrepo.Caught) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
for _, x := range f.caught[g] {
|
||||||
|
if x.UserID == c.UserID {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
f.caught[g] = append(f.caught[g], c)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) ListRaidCaught(_ context.Context, g int64, limit int) ([]securityrepo.Caught, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
out := f.caught[g]
|
||||||
|
if len(out) > limit {
|
||||||
|
out = out[:limit]
|
||||||
|
}
|
||||||
|
return append([]securityrepo.Caught(nil), out...), nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) SaveSnapshot(_ context.Context, s securityrepo.Snapshot) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
s.ID = int64(len(f.snapshots) + 1)
|
||||||
|
s.CreatedAt = time.Date(2026, 10, 20, 6, 0, 0, 0, time.UTC)
|
||||||
|
f.snapshots = append(f.snapshots, s)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) LatestSnapshot(_ context.Context, g int64) (*securityrepo.Snapshot, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
for i := len(f.snapshots) - 1; i >= 0; i-- {
|
||||||
|
if f.snapshots[i].GuildID == g {
|
||||||
|
s := f.snapshots[i]
|
||||||
|
return &s, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) GuildsDueForSnapshot(context.Context, time.Duration) ([]int64, error) {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func key(a, b int64) string { return fmt.Sprint(a, "/", b) }
|
||||||
|
|
||||||
|
func (f *fakeStore) set(g int64) *securityrepo.Settings {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
s, ok := f.settings[g]
|
||||||
|
if !ok {
|
||||||
|
s = securityrepo.Defaults(g)
|
||||||
|
s.Configured = true
|
||||||
|
f.settings[g] = s
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fakeStore) GetSettings(_ context.Context, g int64) (*securityrepo.Settings, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
if s, ok := f.settings[g]; ok {
|
||||||
|
cp := *s
|
||||||
|
return &cp, nil
|
||||||
|
}
|
||||||
|
return securityrepo.Defaults(g), nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) SetEnabled(_ context.Context, g int64, feature string, on bool) error {
|
||||||
|
s := f.set(g)
|
||||||
|
switch feature {
|
||||||
|
case securityrepo.FeatureJoinGate:
|
||||||
|
s.JoinGateEnabled = on
|
||||||
|
case securityrepo.FeatureAntiRaid:
|
||||||
|
s.AntiRaidEnabled = on
|
||||||
|
case securityrepo.FeatureAntiNuke:
|
||||||
|
s.AntiNukeEnabled = on
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) SetAlerts(_ context.Context, g, ch, role int64) error {
|
||||||
|
s := f.set(g)
|
||||||
|
s.AlertChannelID, s.AlertRoleID = ch, role
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) SetQuarantineRole(_ context.Context, g, role int64) error {
|
||||||
|
f.set(g).QuarantineRoleID = role
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) SetJoinLock(_ context.Context, g int64, mode string) error {
|
||||||
|
f.set(g).JoinLock = mode
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) ListTrusted(_ context.Context, g int64) ([]securityrepo.Trusted, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
return append([]securityrepo.Trusted(nil), f.trusted[g]...), nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) AddTrusted(_ context.Context, g int64, t securityrepo.Trusted) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
f.trusted[g] = append(f.trusted[g], t)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) RemoveTrusted(_ context.Context, g, target int64) (bool, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
var keep []securityrepo.Trusted
|
||||||
|
found := false
|
||||||
|
for _, t := range f.trusted[g] {
|
||||||
|
if t.TargetID == target {
|
||||||
|
found = true
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
keep = append(keep, t)
|
||||||
|
}
|
||||||
|
f.trusted[g] = keep
|
||||||
|
return found, nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) SaveQuarantine(_ context.Context, q securityrepo.Quarantine) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
if _, ok := f.quarantines[key(q.GuildID, q.UserID)]; !ok {
|
||||||
|
f.quarantines[key(q.GuildID, q.UserID)] = q
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) GetQuarantine(_ context.Context, g, u int64) (*securityrepo.Quarantine, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
if q, ok := f.quarantines[key(g, u)]; ok {
|
||||||
|
return &q, nil
|
||||||
|
}
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) ListQuarantines(_ context.Context, g int64) ([]securityrepo.Quarantine, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
var out []securityrepo.Quarantine
|
||||||
|
for _, q := range f.quarantines {
|
||||||
|
if q.GuildID == g {
|
||||||
|
out = append(out, q)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) DeleteQuarantine(_ context.Context, g, u int64) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
delete(f.quarantines, key(g, u))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) SaveLockdown(_ context.Context, l securityrepo.Lockdown) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
if _, ok := f.lockdowns[key(l.GuildID, l.ChannelID)]; !ok {
|
||||||
|
f.lockdowns[key(l.GuildID, l.ChannelID)] = l
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) GetLockdown(_ context.Context, g, ch int64) (*securityrepo.Lockdown, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
if l, ok := f.lockdowns[key(g, ch)]; ok {
|
||||||
|
return &l, nil
|
||||||
|
}
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) ListLockdowns(_ context.Context, g int64, serverOnly bool) ([]securityrepo.Lockdown, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
var out []securityrepo.Lockdown
|
||||||
|
for _, l := range f.lockdowns {
|
||||||
|
if l.GuildID == g && (!serverOnly || l.ServerWide) {
|
||||||
|
out = append(out, l)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Slice(out, func(i, j int) bool { return out[i].ChannelID < out[j].ChannelID })
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) DeleteLockdown(_ context.Context, g, ch int64) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
delete(f.lockdowns, key(g, ch))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) AddEvent(_ context.Context, e securityrepo.Event) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
f.events = append(f.events, e)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) eventKinds() []string {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
var out []string
|
||||||
|
for _, e := range f.events {
|
||||||
|
out = append(out, e.Kind)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
func (f *fakeStore) ListUnprocessedCommands(context.Context) ([]securityrepo.Command, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
var out []securityrepo.Command
|
||||||
|
for _, c := range f.cmds {
|
||||||
|
if !f.done[c.ID] {
|
||||||
|
out = append(out, c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
func (f *fakeStore) MarkCommandProcessed(_ context.Context, id int64) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
f.done[id] = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// fakeDiscord is a tiny in-memory guild.
|
||||||
|
type fakeDiscord struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
ownerID string
|
||||||
|
roles []*discordgo.Role
|
||||||
|
members map[string]*discordgo.Member
|
||||||
|
users map[string]*discordgo.User
|
||||||
|
channels map[string]*discordgo.Channel
|
||||||
|
kicked []string
|
||||||
|
banned []string
|
||||||
|
timeouts map[string]*time.Time
|
||||||
|
sent []*discordgo.MessageSend
|
||||||
|
sentTo []string
|
||||||
|
files map[string]string
|
||||||
|
requests []string // "METHOD url body"
|
||||||
|
deletedMsgs []string
|
||||||
|
nextID int
|
||||||
|
failEdits error
|
||||||
|
rejectRole string // edits that assign this role fail, like a role above Velox's
|
||||||
|
lookups int // member and role lookups, to check harmless entries cost nothing
|
||||||
|
closedDMs map[string]bool
|
||||||
|
guildName string
|
||||||
|
}
|
||||||
|
|
||||||
|
const guild = "100"
|
||||||
|
|
||||||
|
func newDiscord() *fakeDiscord {
|
||||||
|
return &fakeDiscord{
|
||||||
|
ownerID: "1",
|
||||||
|
roles: []*discordgo.Role{
|
||||||
|
{ID: guild, Name: "@everyone", Position: 0},
|
||||||
|
{ID: "200", Name: "Admin", Position: 5, Permissions: discordgo.PermissionAdministrator},
|
||||||
|
{ID: "201", Name: "Mod", Position: 3, Permissions: discordgo.PermissionKickMembers},
|
||||||
|
{ID: "202", Name: "Member", Position: 1},
|
||||||
|
{ID: "203", Name: "Quarantine", Position: 2},
|
||||||
|
{ID: "204", Name: "Booster", Position: 1, Managed: true},
|
||||||
|
{ID: "299", Name: "Velox", Position: 9, Managed: true, Permissions: discordgo.PermissionAdministrator},
|
||||||
|
},
|
||||||
|
members: map[string]*discordgo.Member{
|
||||||
|
"1": {User: &discordgo.User{ID: "1", Username: "owner"}},
|
||||||
|
"999": {User: &discordgo.User{ID: "999", Username: "velox", Bot: true}, Roles: []string{"299"}},
|
||||||
|
},
|
||||||
|
users: map[string]*discordgo.User{},
|
||||||
|
channels: map[string]*discordgo.Channel{},
|
||||||
|
timeouts: map[string]*time.Time{},
|
||||||
|
files: map[string]string{},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fakeDiscord) addMember(id string, roles ...string) *discordgo.Member {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
m := &discordgo.Member{User: &discordgo.User{ID: id, Username: "user" + id, Avatar: "a"}, Roles: roles}
|
||||||
|
f.members[id] = m
|
||||||
|
return m
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fakeDiscord) Guild(g string, _ ...discordgo.RequestOption) (*discordgo.Guild, error) {
|
||||||
|
return &discordgo.Guild{ID: g, OwnerID: f.ownerID, Name: f.guildName}, nil
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) UserChannelCreate(u string, _ ...discordgo.RequestOption) (*discordgo.Channel, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
if f.closedDMs[u] {
|
||||||
|
return nil, errors.New("Cannot send messages to this user")
|
||||||
|
}
|
||||||
|
return &discordgo.Channel{ID: "dm-" + u, Type: discordgo.ChannelTypeDM}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// dmsTo lists who got a DM, in order.
|
||||||
|
func (f *fakeDiscord) dmsTo() []string {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
var out []string
|
||||||
|
for _, ch := range f.sentTo {
|
||||||
|
if len(ch) > 3 && ch[:3] == "dm-" {
|
||||||
|
out = append(out, ch[3:])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) User(id string, _ ...discordgo.RequestOption) (*discordgo.User, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
if u, ok := f.users[id]; ok {
|
||||||
|
return u, nil
|
||||||
|
}
|
||||||
|
return nil, errors.New("unknown user")
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) GuildRoles(string, ...discordgo.RequestOption) ([]*discordgo.Role, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
f.lookups++
|
||||||
|
return f.roles, nil
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) GuildChannels(g string, _ ...discordgo.RequestOption) ([]*discordgo.Channel, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
var out []*discordgo.Channel
|
||||||
|
for _, c := range f.channels {
|
||||||
|
if c.GuildID == g {
|
||||||
|
out = append(out, c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Slice(out, func(i, j int) bool { return out[i].ID < out[j].ID })
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) GuildMember(_, u string, _ ...discordgo.RequestOption) (*discordgo.Member, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
f.lookups++
|
||||||
|
if m, ok := f.members[u]; ok {
|
||||||
|
cp := *m
|
||||||
|
cp.Roles = append([]string(nil), m.Roles...)
|
||||||
|
return &cp, nil
|
||||||
|
}
|
||||||
|
return nil, errors.New("unknown member")
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) GuildMemberEdit(_, u string, data *discordgo.GuildMemberParams, _ ...discordgo.RequestOption) (*discordgo.Member, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
if f.failEdits != nil {
|
||||||
|
return nil, f.failEdits
|
||||||
|
}
|
||||||
|
if data.Roles != nil && f.rejectRole != "" {
|
||||||
|
for _, r := range *data.Roles {
|
||||||
|
if r == f.rejectRole {
|
||||||
|
return nil, errors.New("403 Missing Permissions")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
m, ok := f.members[u]
|
||||||
|
if !ok {
|
||||||
|
return nil, errors.New("unknown member")
|
||||||
|
}
|
||||||
|
if data.Roles != nil {
|
||||||
|
m.Roles = append([]string(nil), (*data.Roles)...)
|
||||||
|
}
|
||||||
|
return m, nil
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) GuildMemberTimeout(_, u string, until *time.Time, _ ...discordgo.RequestOption) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
f.timeouts[u] = until
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) GuildMemberDeleteWithReason(_, u, _ string, _ ...discordgo.RequestOption) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
f.kicked = append(f.kicked, u)
|
||||||
|
delete(f.members, u)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) GuildBanCreateWithReason(_, u, _ string, _ int, _ ...discordgo.RequestOption) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
f.banned = append(f.banned, u)
|
||||||
|
delete(f.members, u)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) Channel(id string, _ ...discordgo.RequestOption) (*discordgo.Channel, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
if c, ok := f.channels[id]; ok {
|
||||||
|
cp := *c
|
||||||
|
cp.PermissionOverwrites = nil
|
||||||
|
for _, o := range c.PermissionOverwrites {
|
||||||
|
oc := *o
|
||||||
|
cp.PermissionOverwrites = append(cp.PermissionOverwrites, &oc)
|
||||||
|
}
|
||||||
|
return &cp, nil
|
||||||
|
}
|
||||||
|
return nil, errors.New("unknown channel")
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) ChannelPermissionSet(ch, target string, t discordgo.PermissionOverwriteType, allow, deny int64, _ ...discordgo.RequestOption) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
c := f.channels[ch]
|
||||||
|
for _, o := range c.PermissionOverwrites {
|
||||||
|
if o.ID == target {
|
||||||
|
o.Allow, o.Deny = allow, deny
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
c.PermissionOverwrites = append(c.PermissionOverwrites, &discordgo.PermissionOverwrite{ID: target, Type: t, Allow: allow, Deny: deny})
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) ChannelPermissionDelete(ch, target string, _ ...discordgo.RequestOption) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
c := f.channels[ch]
|
||||||
|
var keep []*discordgo.PermissionOverwrite
|
||||||
|
for _, o := range c.PermissionOverwrites {
|
||||||
|
if o.ID != target {
|
||||||
|
keep = append(keep, o)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
c.PermissionOverwrites = keep
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) ChannelMessageSendComplex(ch string, data *discordgo.MessageSend, _ ...discordgo.RequestOption) (*discordgo.Message, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
f.sentTo = append(f.sentTo, ch)
|
||||||
|
for _, file := range data.Files {
|
||||||
|
raw, _ := io.ReadAll(file.Reader)
|
||||||
|
f.files[file.Name] = string(raw)
|
||||||
|
}
|
||||||
|
f.sent = append(f.sent, data)
|
||||||
|
return &discordgo.Message{ID: "m"}, nil
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) RequestWithBucketID(method, url string, data interface{}, _ string, _ ...discordgo.RequestOption) ([]byte, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
f.requests = append(f.requests, fmt.Sprintf("%s %s %v", method, url, data))
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// sentCount counts channel alerts (not DMs).
|
||||||
|
func (f *fakeDiscord) sentCount() int {
|
||||||
|
return len(f.channelSends())
|
||||||
|
}
|
||||||
|
|
||||||
|
// channelSends lists messages sent to channels, leaving out DMs.
|
||||||
|
func (f *fakeDiscord) channelSends() []*discordgo.MessageSend {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
var out []*discordgo.MessageSend
|
||||||
|
for i, m := range f.sent {
|
||||||
|
if i >= len(f.sentTo) || len(f.sentTo[i]) < 3 || f.sentTo[i][:3] != "dm-" {
|
||||||
|
out = append(out, m)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fakeDiscord) newID() string {
|
||||||
|
f.nextID++
|
||||||
|
return fmt.Sprint(8000 + f.nextID)
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) ChannelMessageDelete(ch, msg string, _ ...discordgo.RequestOption) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
f.deletedMsgs = append(f.deletedMsgs, msg)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) GuildRoleCreate(_ string, p *discordgo.RoleParams, _ ...discordgo.RequestOption) (*discordgo.Role, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
r := &discordgo.Role{ID: f.newID(), Name: p.Name}
|
||||||
|
if p.Permissions != nil {
|
||||||
|
r.Permissions = *p.Permissions
|
||||||
|
}
|
||||||
|
f.roles = append(f.roles, r)
|
||||||
|
return r, nil
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) GuildRoleEdit(_, roleID string, p *discordgo.RoleParams, _ ...discordgo.RequestOption) (*discordgo.Role, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
for _, r := range f.roles {
|
||||||
|
if r.ID == roleID {
|
||||||
|
if p.Permissions != nil {
|
||||||
|
r.Permissions = *p.Permissions
|
||||||
|
}
|
||||||
|
return r, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil, errors.New("unknown role")
|
||||||
|
}
|
||||||
|
func (f *fakeDiscord) GuildChannelCreateComplex(g string, d discordgo.GuildChannelCreateData, _ ...discordgo.RequestOption) (*discordgo.Channel, error) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
c := &discordgo.Channel{ID: f.newID(), GuildID: g, Name: d.Name, Type: d.Type, ParentID: d.ParentID, PermissionOverwrites: d.PermissionOverwrites}
|
||||||
|
f.channels[c.ID] = c
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,328 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ---- Raid persistence ----
|
||||||
|
|
||||||
|
func TestRaidSurvivesARestart(t *testing.T) {
|
||||||
|
e, d, st, now := testEngine(t)
|
||||||
|
s := st.set(100)
|
||||||
|
s.AntiRaidEnabled, s.RaidJoinCount, s.RaidAction, s.RaidQuietMinutes = true, 3, securityrepo.ActionKick, 5
|
||||||
|
refresh(e)
|
||||||
|
for i := 0; i < 4; i++ {
|
||||||
|
e.OnMemberJoin(ctx, guild, d.addMember(snowflakeAt(now.AddDate(-1, 0, 0), i)))
|
||||||
|
}
|
||||||
|
if r, ok := st.raids[100]; !ok || !r.InvitesPaused || r.CaughtTotal != 4 || len(st.caught[100]) != 4 {
|
||||||
|
t.Fatalf("raid not persisted: %+v caught=%d", st.raids[100], len(st.caught[100]))
|
||||||
|
}
|
||||||
|
|
||||||
|
// The bot restarts: a fresh engine on the same database.
|
||||||
|
e2 := New(d, st, "999")
|
||||||
|
e2.now = e.now
|
||||||
|
e2.ResumeRaids(ctx)
|
||||||
|
if !e2.RaidActive(guild) {
|
||||||
|
t.Fatal("raid mode must resume after a restart")
|
||||||
|
}
|
||||||
|
// A join after the restart is still treated as a raider.
|
||||||
|
*now = now.Add(time.Minute)
|
||||||
|
m := d.addMember(snowflakeAt(now.AddDate(-1, 0, 0), 50))
|
||||||
|
e2.OnMemberJoin(ctx, guild, m)
|
||||||
|
if !contains(d.kicked, m.User.ID) {
|
||||||
|
t.Error("raid actions continue after a restart")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Quiet period: it ends, invites resume, the list covers both lifetimes.
|
||||||
|
*now = now.Add(6 * time.Minute)
|
||||||
|
e2.checkRaids(ctx)
|
||||||
|
if e2.RaidActive(guild) {
|
||||||
|
t.Fatal("the resumed raid should end after the quiet period")
|
||||||
|
}
|
||||||
|
if !strings.Contains(d.requests[len(d.requests)-1], "invites_disabled_until:<nil>") {
|
||||||
|
t.Error("invites paused before the restart must be resumed")
|
||||||
|
}
|
||||||
|
var list string
|
||||||
|
for name, content := range d.files {
|
||||||
|
if strings.HasPrefix(name, "raid-") {
|
||||||
|
list = content
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if strings.Count(list, "\tkick\t") != 5 {
|
||||||
|
t.Errorf("summary should list all 5 raiders:\n%s", list)
|
||||||
|
}
|
||||||
|
if _, ok := st.raids[100]; ok {
|
||||||
|
t.Error("the raid record should be cleared")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Heat ----
|
||||||
|
|
||||||
|
func heatEngine(t *testing.T) (*Engine, *fakeDiscord, *fakeStore, *time.Time) {
|
||||||
|
e, d, st, now := testEngine(t)
|
||||||
|
s := st.set(100)
|
||||||
|
s.HeatEnabled, s.HeatPanicMembers = true, 0
|
||||||
|
refresh(e)
|
||||||
|
return e, d, st, now
|
||||||
|
}
|
||||||
|
|
||||||
|
var msgN int
|
||||||
|
|
||||||
|
func say(e *Engine, userID, content string, edit ...func(m *discordgo.MessageCreate)) *discordgo.MessageCreate {
|
||||||
|
msgN++
|
||||||
|
m := &discordgo.MessageCreate{Message: &discordgo.Message{
|
||||||
|
ID: "msg" + string(rune('A'+msgN%26)) + strings.Repeat("x", msgN/26), GuildID: guild, ChannelID: "300", Content: content,
|
||||||
|
Author: &discordgo.User{ID: userID, Username: "u" + userID},
|
||||||
|
Member: &discordgo.Member{Roles: []string{}, JoinedAt: time.Date(2025, 1, 1, 0, 0, 0, 0, time.UTC)},
|
||||||
|
}}
|
||||||
|
for _, f := range edit {
|
||||||
|
f(m)
|
||||||
|
}
|
||||||
|
e.OnMessage(ctx, m)
|
||||||
|
return m
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNormalChatNeverHeatsUp(t *testing.T) {
|
||||||
|
e, d, _, now := heatEngine(t)
|
||||||
|
for i := 0; i < 60; i++ {
|
||||||
|
say(e, "50", "just talking about the game tonight, number "+string(rune('a'+i%26)))
|
||||||
|
*now = now.Add(2 * time.Second)
|
||||||
|
}
|
||||||
|
if len(d.deletedMsgs) != 0 || len(d.timeouts) != 0 {
|
||||||
|
t.Error("a message every two seconds is normal conversation")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSpamIsPunishedAndEscalates(t *testing.T) {
|
||||||
|
e, d, st, now := heatEngine(t)
|
||||||
|
var last *discordgo.MessageCreate
|
||||||
|
for i := 0; i < 6 && d.timeouts["50"] == nil; i++ {
|
||||||
|
last = say(e, "50", "BUY CHEAP STUFF NOW")
|
||||||
|
*now = now.Add(200 * time.Millisecond)
|
||||||
|
}
|
||||||
|
first := d.timeouts["50"]
|
||||||
|
if first == nil || first.Sub(*now) > 11*time.Minute || first.Sub(*now) < 9*time.Minute {
|
||||||
|
t.Fatalf("repeated spam should earn the 10 minute timeout, got %v", first)
|
||||||
|
}
|
||||||
|
if !contains(d.deletedMsgs, last.ID) {
|
||||||
|
t.Error("the message that maxed the heat should be deleted")
|
||||||
|
}
|
||||||
|
if !contains(st.eventKinds(), securityrepo.EventHeat) {
|
||||||
|
t.Error("recorded")
|
||||||
|
}
|
||||||
|
|
||||||
|
// A second offence the same day doubles it.
|
||||||
|
*now = now.Add(time.Hour)
|
||||||
|
d.timeouts["50"] = nil
|
||||||
|
for i := 0; i < 6 && d.timeouts["50"] == nil; i++ {
|
||||||
|
say(e, "50", "BUY CHEAP STUFF NOW")
|
||||||
|
*now = now.Add(200 * time.Millisecond)
|
||||||
|
}
|
||||||
|
if second := d.timeouts["50"]; second == nil || second.Sub(*now) < 19*time.Minute {
|
||||||
|
t.Errorf("second offence should be 20 minutes, got %v", second)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInviteLinksAndMassMentions(t *testing.T) {
|
||||||
|
e, d, _, _ := heatEngine(t)
|
||||||
|
say(e, "51", "join my server discord.gg/abcdef")
|
||||||
|
if d.timeouts["51"] == nil {
|
||||||
|
t.Error("an invite link is an instant max")
|
||||||
|
}
|
||||||
|
say(e, "52", "hey @everyone check this")
|
||||||
|
say(e, "52", "@everyone again")
|
||||||
|
if d.timeouts["52"] == nil {
|
||||||
|
t.Error("repeated @everyone should max out fast")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHeatExemptions(t *testing.T) {
|
||||||
|
e, d, st, _ := heatEngine(t)
|
||||||
|
st.trusted[100] = []securityrepo.Trusted{{TargetID: 60, Kind: "user"}}
|
||||||
|
refresh(e)
|
||||||
|
e.ChannelPerms = func(userID, _ string) (int64, error) {
|
||||||
|
if userID == "61" {
|
||||||
|
return discordgo.PermissionManageMessages, nil
|
||||||
|
}
|
||||||
|
return 0, nil
|
||||||
|
}
|
||||||
|
for _, who := range []string{"1", "60", "61"} {
|
||||||
|
say(e, who, "discord.gg/x")
|
||||||
|
}
|
||||||
|
say(e, "62", "discord.gg/x", func(m *discordgo.MessageCreate) { m.Author.Bot = true })
|
||||||
|
say(e, "63", "discord.gg/x", func(m *discordgo.MessageCreate) { m.WebhookID = "w" })
|
||||||
|
if len(d.timeouts) != 0 || len(d.deletedMsgs) != 0 {
|
||||||
|
t.Errorf("owner, trusted, moderators, bots and webhooks are exempt: %v", d.timeouts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHeatPanicTimesOutNewMembers(t *testing.T) {
|
||||||
|
e, d, st, now := heatEngine(t)
|
||||||
|
st.set(100).HeatPanicMembers = 3
|
||||||
|
refresh(e)
|
||||||
|
for _, u := range []string{"70", "71", "72"} {
|
||||||
|
say(e, u, "discord.gg/spam")
|
||||||
|
}
|
||||||
|
if !contains(st.eventKinds(), securityrepo.EventHeatPanic) {
|
||||||
|
t.Fatal("three members maxing out within a minute starts heat panic")
|
||||||
|
}
|
||||||
|
newcomer := func(m *discordgo.MessageCreate) { m.Member.JoinedAt = now.Add(-time.Hour) }
|
||||||
|
say(e, "80", "hello everyone", newcomer)
|
||||||
|
if d.timeouts["80"] == nil {
|
||||||
|
t.Error("someone who joined an hour ago speaking during panic is timed out")
|
||||||
|
}
|
||||||
|
say(e, "81", "hello everyone")
|
||||||
|
if d.timeouts["81"] != nil {
|
||||||
|
t.Error("established members are unaffected by panic")
|
||||||
|
}
|
||||||
|
*now = now.Add(11 * time.Minute)
|
||||||
|
say(e, "82", "hello", newcomer)
|
||||||
|
if d.timeouts["82"] != nil {
|
||||||
|
t.Error("panic ends after 10 minutes")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMentionFloodLocksTheServer(t *testing.T) {
|
||||||
|
e, d, st, _ := heatEngine(t)
|
||||||
|
s := st.set(100)
|
||||||
|
s.HeatLockdownMentions, s.HeatStrictness = 20, "low"
|
||||||
|
refresh(e)
|
||||||
|
d.channels["300"] = &discordgo.Channel{ID: "300", GuildID: guild, Type: discordgo.ChannelTypeGuildText}
|
||||||
|
five := func(m *discordgo.MessageCreate) {
|
||||||
|
m.Mentions = []*discordgo.User{{ID: "a"}, {ID: "b"}, {ID: "c"}, {ID: "d"}, {ID: "e"}}
|
||||||
|
}
|
||||||
|
for i, u := range []string{"90", "91", "92", "93"} {
|
||||||
|
_ = i
|
||||||
|
say(e, u, "hi", five)
|
||||||
|
}
|
||||||
|
deadline := time.Now().Add(2 * time.Second)
|
||||||
|
for time.Now().Before(deadline) {
|
||||||
|
st.mu.Lock()
|
||||||
|
n := len(st.lockdowns)
|
||||||
|
st.mu.Unlock()
|
||||||
|
if n > 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
time.Sleep(20 * time.Millisecond)
|
||||||
|
}
|
||||||
|
t.Error("20 mentions within 30 seconds should lock the server")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHeatAlertsAreCapped(t *testing.T) {
|
||||||
|
e, d, _, _ := heatEngine(t)
|
||||||
|
for i := 0; i < 20; i++ {
|
||||||
|
say(e, string(rune('A'+i)), "discord.gg/x")
|
||||||
|
}
|
||||||
|
if n := d.sentCount(); n > heatAlertsPerMin {
|
||||||
|
t.Errorf("a spam wave produced %d alerts, cap is %d", n, heatAlertsPerMin)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Snapshots and restore ----
|
||||||
|
|
||||||
|
func TestSnapshotAndRestore(t *testing.T) {
|
||||||
|
e, d, st, _ := testEngine(t)
|
||||||
|
d.channels["400"] = &discordgo.Channel{ID: "400", GuildID: guild, Type: discordgo.ChannelTypeGuildCategory, Name: "Staff"}
|
||||||
|
d.channels["401"] = &discordgo.Channel{ID: "401", GuildID: guild, Type: discordgo.ChannelTypeGuildText, Name: "mod-chat", ParentID: "400",
|
||||||
|
PermissionOverwrites: []*discordgo.PermissionOverwrite{
|
||||||
|
{ID: guild, Type: discordgo.PermissionOverwriteTypeRole, Deny: discordgo.PermissionViewChannel},
|
||||||
|
{ID: "201", Type: discordgo.PermissionOverwriteTypeRole, Allow: discordgo.PermissionViewChannel},
|
||||||
|
}}
|
||||||
|
d.channels["402"] = &discordgo.Channel{ID: "402", GuildID: guild, Type: discordgo.ChannelTypeGuildPublicThread, Name: "a thread"}
|
||||||
|
|
||||||
|
if _, err := e.Restore(ctx, guild, "1"); !errors.As(err, new(UserError)) {
|
||||||
|
t.Fatalf("no snapshot yet should be a clear message: %v", err)
|
||||||
|
}
|
||||||
|
roles, channels, err := e.TakeSnapshot(ctx, guild, "1")
|
||||||
|
if err != nil || roles != 5 || channels != 2 {
|
||||||
|
t.Fatalf("snapshot = %d roles, %d channels, %v (managed roles and threads are skipped)", roles, channels, err)
|
||||||
|
}
|
||||||
|
var data snapshotData
|
||||||
|
_ = json.Unmarshal(st.snapshots[0].Data, &data)
|
||||||
|
for _, r := range data.Roles {
|
||||||
|
if r.ID == "204" || r.ID == "299" {
|
||||||
|
t.Error("integration roles must not be in the snapshot")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The nuke: the Mod role and the whole Staff category are deleted, and
|
||||||
|
// the Member role is given Administrator.
|
||||||
|
var keep []*discordgo.Role
|
||||||
|
for _, r := range d.roles {
|
||||||
|
if r.ID != "201" {
|
||||||
|
keep = append(keep, r)
|
||||||
|
}
|
||||||
|
if r.ID == "202" {
|
||||||
|
r.Permissions |= discordgo.PermissionAdministrator
|
||||||
|
}
|
||||||
|
}
|
||||||
|
d.roles = keep
|
||||||
|
delete(d.channels, "400")
|
||||||
|
delete(d.channels, "401")
|
||||||
|
|
||||||
|
res, err := e.Restore(ctx, guild, "1")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if res.RolesCreated != 1 || res.RolesReverted != 1 || res.ChannelsCreated != 2 || res.Failed != 0 {
|
||||||
|
t.Fatalf("restore result = %+v", res)
|
||||||
|
}
|
||||||
|
var newMod, newCat, newText *string
|
||||||
|
for _, r := range d.roles {
|
||||||
|
if r.Name == "Mod" {
|
||||||
|
newMod = &r.ID
|
||||||
|
}
|
||||||
|
if r.ID == "202" && r.Permissions&discordgo.PermissionAdministrator != 0 {
|
||||||
|
t.Error("Administrator added to Member should be reverted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, c := range d.channels {
|
||||||
|
switch c.Name {
|
||||||
|
case "Staff":
|
||||||
|
newCat = &c.ID
|
||||||
|
case "mod-chat":
|
||||||
|
newText = &c.ID
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if newMod == nil || newCat == nil || newText == nil {
|
||||||
|
t.Fatal("role or channels not recreated")
|
||||||
|
}
|
||||||
|
text := d.channels[*newText]
|
||||||
|
if text.ParentID != *newCat {
|
||||||
|
t.Error("the channel should go back into the recreated category")
|
||||||
|
}
|
||||||
|
foundMod := false
|
||||||
|
for _, o := range text.PermissionOverwrites {
|
||||||
|
if o.ID == *newMod && o.Allow == discordgo.PermissionViewChannel {
|
||||||
|
foundMod = true
|
||||||
|
}
|
||||||
|
if o.ID == "201" {
|
||||||
|
t.Error("overwrites must point at the recreated role, not the deleted one")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !foundMod {
|
||||||
|
t.Errorf("the Mod overwrite should be restored: %+v", text.PermissionOverwrites)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Restoring again finds nothing missing.
|
||||||
|
res, _ = e.Restore(ctx, guild, "1")
|
||||||
|
if res.RolesCreated+res.ChannelsCreated+res.RolesReverted != 0 {
|
||||||
|
t.Errorf("a second restore should change nothing: %+v", res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestOnlyOneRestoreAtATime(t *testing.T) {
|
||||||
|
e, _, _, _ := testEngine(t)
|
||||||
|
e.restoring[guild] = true
|
||||||
|
if _, err := e.Restore(ctx, guild, "1"); err == nil || !strings.Contains(err.Error(), "already running") {
|
||||||
|
t.Errorf("err = %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,368 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"math"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Heat is a per-member spam score, like Wick's. Every message adds heat,
|
||||||
|
// more for what spam looks like; heat cools down over time, so normal
|
||||||
|
// conversation never builds up. At maxHeat the message is deleted and the
|
||||||
|
// configured action applied.
|
||||||
|
const (
|
||||||
|
maxHeat = 100.0
|
||||||
|
heatDecayPerSec = 8.0 // a message every couple of seconds never accumulates
|
||||||
|
heatBase = 8.0
|
||||||
|
heatRepeat = 25.0
|
||||||
|
heatMention = 10.0
|
||||||
|
heatEveryone = 60.0
|
||||||
|
heatEmoji = 2.0
|
||||||
|
heatLine = 2.0 // per line beyond the fourth
|
||||||
|
heatPer100Chars = 1.0
|
||||||
|
heatAttachment = 10.0
|
||||||
|
heatLink = 8.0
|
||||||
|
heatBlockedWord = 60.0
|
||||||
|
maxHeatUsers = 50000 // per guild, swept when exceeded
|
||||||
|
panicWindow = time.Minute
|
||||||
|
panicDuration = 10 * time.Minute
|
||||||
|
panicTimeout = time.Hour
|
||||||
|
panicNewMember = 24 * time.Hour
|
||||||
|
mentionWindow = 30 * time.Second
|
||||||
|
floodCooldown = 10 * time.Minute
|
||||||
|
heatAlertsPerMin = 5
|
||||||
|
maxTimeout = 28*24*time.Hour - time.Hour
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
linkRe = regexp.MustCompile(`https?://\S+`)
|
||||||
|
customEmojiRe = regexp.MustCompile(`<a?:\w+:\d+>`)
|
||||||
|
)
|
||||||
|
|
||||||
|
var strictness = map[string]float64{"low": 0.6, "medium": 1.0, "high": 1.5}
|
||||||
|
|
||||||
|
type memberHeat struct {
|
||||||
|
heat float64
|
||||||
|
last time.Time
|
||||||
|
recent []string // last few messages, normalized, for repeats
|
||||||
|
offences int // within the last day
|
||||||
|
lastOffence time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
type guildHeat struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
members map[string]*memberHeat
|
||||||
|
maxedAt map[string]time.Time // who hit max heat recently, for panic
|
||||||
|
panicUntil time.Time
|
||||||
|
mentions []time.Time // mentions by non-exempt members, for flood lockdown
|
||||||
|
lastFlood time.Time
|
||||||
|
alertTimes []time.Time
|
||||||
|
alertsMuted int
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *Engine) heatFor(guildID string) *guildHeat {
|
||||||
|
e.mu.Lock()
|
||||||
|
defer e.mu.Unlock()
|
||||||
|
g, ok := e.heat[guildID]
|
||||||
|
if !ok {
|
||||||
|
g = &guildHeat{members: map[string]*memberHeat{}, maxedAt: map[string]time.Time{}}
|
||||||
|
e.heat[guildID] = g
|
||||||
|
}
|
||||||
|
return g
|
||||||
|
}
|
||||||
|
|
||||||
|
func normalize(s string) string {
|
||||||
|
return strings.Join(strings.Fields(strings.ToLower(s)), " ")
|
||||||
|
}
|
||||||
|
|
||||||
|
func countEmoji(s string) int {
|
||||||
|
n := len(customEmojiRe.FindAllString(s, -1))
|
||||||
|
for _, r := range s {
|
||||||
|
if r >= 0x1F000 || (r >= 0x2600 && r <= 0x27BF) {
|
||||||
|
n++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return n
|
||||||
|
}
|
||||||
|
|
||||||
|
// MessageHeat scores one message. recent is the author's last few messages
|
||||||
|
// (normalized) for spotting repeats. The second result is true when the
|
||||||
|
// message is an instant maximum (an invite link).
|
||||||
|
func MessageHeat(s *securityrepo.Settings, m *discordgo.Message, recent []string) (float64, bool, string) {
|
||||||
|
content := m.Content
|
||||||
|
lower := strings.ToLower(content)
|
||||||
|
if inviteRe.MatchString(lower) {
|
||||||
|
return maxHeat, true, "invite link"
|
||||||
|
}
|
||||||
|
reason := "spam"
|
||||||
|
h := heatBase
|
||||||
|
norm := normalize(content)
|
||||||
|
if norm != "" {
|
||||||
|
for _, r := range recent {
|
||||||
|
if r == norm {
|
||||||
|
h += heatRepeat
|
||||||
|
reason = "repeated messages"
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
mentions := len(m.Mentions) + len(m.MentionRoles)
|
||||||
|
h += float64(mentions) * heatMention
|
||||||
|
if m.MentionEveryone || strings.Contains(lower, "@everyone") || strings.Contains(lower, "@here") {
|
||||||
|
h += heatEveryone
|
||||||
|
reason = "mass mentions"
|
||||||
|
} else if mentions >= 3 {
|
||||||
|
reason = "mention spam"
|
||||||
|
}
|
||||||
|
h += float64(countEmoji(content)) * heatEmoji
|
||||||
|
if lines := strings.Count(content, "\n") + 1; lines > 4 {
|
||||||
|
h += float64(lines-4) * heatLine
|
||||||
|
}
|
||||||
|
h += float64(len([]rune(content))/100) * heatPer100Chars
|
||||||
|
h += float64(len(m.Attachments)+len(m.StickerItems)) * heatAttachment
|
||||||
|
h += float64(len(linkRe.FindAllString(content, -1))) * heatLink
|
||||||
|
for _, w := range s.HeatBlockedWords {
|
||||||
|
if w = strings.ToLower(strings.TrimSpace(w)); w != "" && strings.Contains(lower, w) {
|
||||||
|
h += heatBlockedWord
|
||||||
|
reason = "blocked word"
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
mult := strictness[s.HeatStrictness]
|
||||||
|
if mult == 0 {
|
||||||
|
mult = 1
|
||||||
|
}
|
||||||
|
return h * mult, false, reason
|
||||||
|
}
|
||||||
|
|
||||||
|
// heatExempt: bots, webhooks, the owner, trusted members and anyone who can
|
||||||
|
// manage messages in the channel.
|
||||||
|
func (e *Engine) heatExempt(ctx context.Context, m *discordgo.MessageCreate) bool {
|
||||||
|
if m.Author == nil || m.Author.Bot || m.WebhookID != "" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
var roles []string
|
||||||
|
if m.Member != nil {
|
||||||
|
roles = m.Member.Roles
|
||||||
|
}
|
||||||
|
if e.IsTrusted(ctx, m.GuildID, m.Author.ID, nonNil(roles)) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if e.ChannelPerms != nil {
|
||||||
|
if p, err := e.ChannelPerms(m.Author.ID, m.ChannelID); err == nil &&
|
||||||
|
p&(discordgo.PermissionAdministrator|discordgo.PermissionManageMessages) != 0 {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// OnMessage runs the heat system on a guild message.
|
||||||
|
func (e *Engine) OnMessage(ctx context.Context, m *discordgo.MessageCreate) {
|
||||||
|
if m == nil || m.Message == nil || m.GuildID == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s, _, err := e.load(ctx, m.GuildID)
|
||||||
|
if err != nil || !s.HeatEnabled {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if e.heatExempt(ctx, m) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
now := e.now()
|
||||||
|
g := e.heatFor(m.GuildID)
|
||||||
|
|
||||||
|
// Mention flood: lock the server once, then cool down.
|
||||||
|
if s.HeatLockdownMentions > 0 {
|
||||||
|
n := len(m.Mentions) + len(m.MentionRoles)
|
||||||
|
if m.MentionEveryone {
|
||||||
|
n += 10
|
||||||
|
}
|
||||||
|
if n > 0 && e.mentionFlood(g, now, n, s.HeatLockdownMentions) {
|
||||||
|
go e.floodLockdown(context.Background(), m.GuildID, s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
g.mu.Lock()
|
||||||
|
if now.Before(g.panicUntil) && m.Member != nil && !m.Member.JoinedAt.IsZero() && now.Sub(m.Member.JoinedAt) < panicNewMember {
|
||||||
|
g.mu.Unlock()
|
||||||
|
e.heatPunish(ctx, m, s, "heat panic: new member speaking during a spam wave", panicTimeout, securityrepo.ActionTimeout)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
mh, ok := g.members[m.Author.ID]
|
||||||
|
if !ok {
|
||||||
|
if len(g.members) >= maxHeatUsers {
|
||||||
|
g.sweep(now)
|
||||||
|
}
|
||||||
|
mh = &memberHeat{}
|
||||||
|
g.members[m.Author.ID] = mh
|
||||||
|
}
|
||||||
|
if !mh.last.IsZero() {
|
||||||
|
mh.heat = math.Max(0, mh.heat-now.Sub(mh.last).Seconds()*heatDecayPerSec)
|
||||||
|
}
|
||||||
|
mh.last = now
|
||||||
|
add, instant, reason := MessageHeat(s, m.Message, mh.recent)
|
||||||
|
mh.heat += add
|
||||||
|
if norm := normalize(m.Content); norm != "" {
|
||||||
|
mh.recent = append(mh.recent, norm)
|
||||||
|
if len(mh.recent) > 3 {
|
||||||
|
mh.recent = mh.recent[len(mh.recent)-3:]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if mh.heat < maxHeat && !instant {
|
||||||
|
g.mu.Unlock()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// Over the top: reset, count the offence, and work out the timeout.
|
||||||
|
mh.heat = 0
|
||||||
|
if now.Sub(mh.lastOffence) > 24*time.Hour {
|
||||||
|
mh.offences = 0
|
||||||
|
}
|
||||||
|
mh.offences++
|
||||||
|
mh.lastOffence = now
|
||||||
|
timeout := time.Duration(s.HeatTimeoutMinutes) * time.Minute
|
||||||
|
if s.HeatEscalate && mh.offences > 1 {
|
||||||
|
timeout *= time.Duration(1 << min(mh.offences-1, 12))
|
||||||
|
}
|
||||||
|
if timeout > maxTimeout {
|
||||||
|
timeout = maxTimeout
|
||||||
|
}
|
||||||
|
// Heat panic: enough different members maxing out within a minute.
|
||||||
|
g.maxedAt[m.Author.ID] = now
|
||||||
|
for u, t := range g.maxedAt {
|
||||||
|
if now.Sub(t) > panicWindow {
|
||||||
|
delete(g.maxedAt, u)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
startPanic := s.HeatPanicMembers > 0 && len(g.maxedAt) >= s.HeatPanicMembers && !now.Before(g.panicUntil)
|
||||||
|
if startPanic {
|
||||||
|
g.panicUntil = now.Add(panicDuration)
|
||||||
|
}
|
||||||
|
g.mu.Unlock()
|
||||||
|
|
||||||
|
e.heatPunish(ctx, m, s, reason, timeout, s.HeatAction)
|
||||||
|
if startPanic {
|
||||||
|
e.event(ctx, m.GuildID, securityrepo.EventHeatPanic, e.botID, "", fmt.Sprintf("%d members hit max heat within a minute", s.HeatPanicMembers))
|
||||||
|
e.send(ctx, m.GuildID, s, alert{ping: true, critical: true, embed: &discordgo.MessageEmbed{
|
||||||
|
Title: "🔥 Spam wave: heat panic on",
|
||||||
|
Description: fmt.Sprintf("%d members hit max heat within a minute. For the next 10 minutes, anyone who joined in the last day is timed out as soon as they speak.", s.HeatPanicMembers),
|
||||||
|
Color: colorAlert,
|
||||||
|
}})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (g *guildHeat) sweep(now time.Time) {
|
||||||
|
for u, mh := range g.members {
|
||||||
|
cooled := mh.heat-now.Sub(mh.last).Seconds()*heatDecayPerSec <= 0
|
||||||
|
if cooled && now.Sub(mh.lastOffence) > 24*time.Hour {
|
||||||
|
delete(g.members, u)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// mentionFlood records n mentions and reports whether the guild just went
|
||||||
|
// over the limit (once per cooldown).
|
||||||
|
func (e *Engine) mentionFlood(g *guildHeat, now time.Time, n, limit int) bool {
|
||||||
|
g.mu.Lock()
|
||||||
|
defer g.mu.Unlock()
|
||||||
|
for i := 0; i < n && len(g.mentions) < 5000; i++ {
|
||||||
|
g.mentions = append(g.mentions, now)
|
||||||
|
}
|
||||||
|
cut := 0
|
||||||
|
for cut < len(g.mentions) && now.Sub(g.mentions[cut]) > mentionWindow {
|
||||||
|
cut++
|
||||||
|
}
|
||||||
|
g.mentions = g.mentions[cut:]
|
||||||
|
if len(g.mentions) >= limit && now.Sub(g.lastFlood) > floodCooldown {
|
||||||
|
g.lastFlood = now
|
||||||
|
g.mentions = nil
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *Engine) floodLockdown(ctx context.Context, guildID string, s *securityrepo.Settings) {
|
||||||
|
locked, failed, err := e.LockServer(ctx, guildID, e.botID)
|
||||||
|
desc := fmt.Sprintf("%d or more mentions within 30 seconds: every channel is locked (%d locked", s.HeatLockdownMentions, locked)
|
||||||
|
if failed > 0 {
|
||||||
|
desc += fmt.Sprintf(", %d failed", failed)
|
||||||
|
}
|
||||||
|
desc += "). Unlock with `/unlock server` once it's under control."
|
||||||
|
if err != nil {
|
||||||
|
desc = "A mention flood was detected but locking the server failed: " + clip(err.Error(), 200)
|
||||||
|
}
|
||||||
|
e.send(ctx, guildID, s, alert{ping: true, critical: true, embed: &discordgo.MessageEmbed{Title: "🔒 Mention flood: server locked", Description: desc, Color: colorAlert}})
|
||||||
|
}
|
||||||
|
|
||||||
|
// heatPunish deletes the message and applies the action. Alerts are capped
|
||||||
|
// per minute so a spam wave can't flood the alert channel.
|
||||||
|
func (e *Engine) heatPunish(ctx context.Context, m *discordgo.MessageCreate, s *securityrepo.Settings, reason string, timeout time.Duration, action string) {
|
||||||
|
if err := e.d.ChannelMessageDelete(m.ChannelID, m.ID, discordgo.WithAuditLogReason("Velox heat: "+reason)); err != nil {
|
||||||
|
log.Printf("security: deleting a hot message in guild %s: %v", m.GuildID, err)
|
||||||
|
}
|
||||||
|
var err error
|
||||||
|
if action == securityrepo.ActionTimeout {
|
||||||
|
if m.Author.ID == e.botID || e.IsOwner(m.GuildID, m.Author.ID) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
until := e.now().Add(timeout)
|
||||||
|
err = e.d.GuildMemberTimeout(m.GuildID, m.Author.ID, &until, discordgo.WithAuditLogReason(clip("Velox heat: "+reason, 400)))
|
||||||
|
} else {
|
||||||
|
err = e.punish(m.GuildID, m.Author, action, "heat: "+reason)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("security: heat action on %s in guild %s: %v", m.Author.ID, m.GuildID, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
what := action
|
||||||
|
if action == securityrepo.ActionTimeout {
|
||||||
|
what = "timed out for " + humanize(timeout)
|
||||||
|
}
|
||||||
|
e.event(ctx, m.GuildID, securityrepo.EventHeat, e.botID, m.Author.ID, what+": "+reason)
|
||||||
|
|
||||||
|
g := e.heatFor(m.GuildID)
|
||||||
|
now := e.now()
|
||||||
|
g.mu.Lock()
|
||||||
|
cut := 0
|
||||||
|
for cut < len(g.alertTimes) && now.Sub(g.alertTimes[cut]) > time.Minute {
|
||||||
|
cut++
|
||||||
|
}
|
||||||
|
g.alertTimes = g.alertTimes[cut:]
|
||||||
|
allowed := len(g.alertTimes) < heatAlertsPerMin
|
||||||
|
muted := 0
|
||||||
|
if allowed {
|
||||||
|
g.alertTimes = append(g.alertTimes, now)
|
||||||
|
muted, g.alertsMuted = g.alertsMuted, 0
|
||||||
|
} else {
|
||||||
|
g.alertsMuted++
|
||||||
|
}
|
||||||
|
g.mu.Unlock()
|
||||||
|
if !allowed {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
desc := fmt.Sprintf("<@%s> (%s) was %s: %s. Their message was deleted.", m.Author.ID, safeName(m.Author), what, reason)
|
||||||
|
if muted > 0 {
|
||||||
|
desc += fmt.Sprintf("\n(%d more since the last alert weren't posted, to keep this channel readable.)", muted)
|
||||||
|
}
|
||||||
|
e.send(ctx, m.GuildID, s, alert{embed: &discordgo.MessageEmbed{Title: "Heat", Description: desc, Color: colorWarn}})
|
||||||
|
}
|
||||||
|
|
||||||
|
func humanize(d time.Duration) string {
|
||||||
|
switch {
|
||||||
|
case d >= 24*time.Hour:
|
||||||
|
return fmt.Sprintf("%.0f days", d.Hours()/24)
|
||||||
|
case d >= time.Hour:
|
||||||
|
return fmt.Sprintf("%.0f hours", d.Hours())
|
||||||
|
default:
|
||||||
|
return fmt.Sprintf("%.0f minutes", math.Max(1, d.Minutes()))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,176 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Invite links in a name: discord.gg/x, discord.com/invite/x, dsc.gg/x and
|
||||||
|
// the common lookalikes. Matched case-insensitively against the lowercased
|
||||||
|
// name; the pattern is fixed, never built from user input.
|
||||||
|
var inviteRe = regexp.MustCompile(`(discord(app)?\.(gg|com/invite|io|me|li)|dsc\.gg|\.gg/)`)
|
||||||
|
|
||||||
|
var severity = map[string]int{
|
||||||
|
securityrepo.ActionOff: 0, securityrepo.ActionAlert: 1, securityrepo.ActionTimeout: 2,
|
||||||
|
securityrepo.ActionKick: 3, securityrepo.ActionBan: 4,
|
||||||
|
}
|
||||||
|
|
||||||
|
// GateResult is what the Join Gate decided about one member.
|
||||||
|
type GateResult struct {
|
||||||
|
Action string // off, timeout, kick, ban
|
||||||
|
Reason string
|
||||||
|
}
|
||||||
|
|
||||||
|
// CheckJoin runs the Join Gate filters on a new member. When several match,
|
||||||
|
// the strictest action wins. Bots are only checked for being unverified;
|
||||||
|
// bots added by untrusted members are handled from the audit log.
|
||||||
|
func CheckJoin(s *securityrepo.Settings, u *discordgo.User, now time.Time) GateResult {
|
||||||
|
var res GateResult
|
||||||
|
consider := func(action, reason string) {
|
||||||
|
if severity[action] > severity[res.Action] {
|
||||||
|
res = GateResult{Action: action, Reason: reason}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
res.Action = securityrepo.ActionOff
|
||||||
|
if !s.JoinGateEnabled || u == nil {
|
||||||
|
return res
|
||||||
|
}
|
||||||
|
|
||||||
|
if u.Bot {
|
||||||
|
if u.PublicFlags&discordgo.UserFlagVerifiedBot == 0 {
|
||||||
|
consider(s.UnverifiedBot, "unverified bot")
|
||||||
|
}
|
||||||
|
return res
|
||||||
|
}
|
||||||
|
|
||||||
|
names := strings.ToLower(u.Username + " " + u.GlobalName)
|
||||||
|
if inviteRe.MatchString(names) {
|
||||||
|
consider(s.AdvertisingName, "invite link in name")
|
||||||
|
}
|
||||||
|
if s.UsernameFilter != securityrepo.ActionOff {
|
||||||
|
for _, p := range s.UsernamePatterns {
|
||||||
|
p = strings.ToLower(strings.TrimSpace(p))
|
||||||
|
if p != "" && strings.Contains(names, p) {
|
||||||
|
consider(s.UsernameFilter, "blocked word in name")
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if created, err := discordgo.SnowflakeTimestamp(u.ID); err == nil {
|
||||||
|
if now.Sub(created) < time.Duration(s.MinAccountAgeDays)*24*time.Hour {
|
||||||
|
consider(s.NewAccount, fmt.Sprintf("account younger than %d days", s.MinAccountAgeDays))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if u.Avatar == "" {
|
||||||
|
consider(s.NoAvatar, "no avatar")
|
||||||
|
}
|
||||||
|
return res
|
||||||
|
}
|
||||||
|
|
||||||
|
// errProtected is returned when asked to punish the owner or the bot.
|
||||||
|
var errProtected = errors.New("the owner and the bot are never punished")
|
||||||
|
|
||||||
|
// punish applies a member action. It never touches the owner or the bot.
|
||||||
|
func (e *Engine) punish(guildID string, u *discordgo.User, action, reason string) error {
|
||||||
|
if u == nil || u.ID == e.botID || e.IsOwner(guildID, u.ID) {
|
||||||
|
return errProtected
|
||||||
|
}
|
||||||
|
reason = clip("Velox security: "+reason, 400)
|
||||||
|
switch action {
|
||||||
|
case securityrepo.ActionTimeout:
|
||||||
|
until := e.now().Add(timeoutJoin)
|
||||||
|
return e.d.GuildMemberTimeout(guildID, u.ID, &until, discordgo.WithAuditLogReason(reason))
|
||||||
|
case securityrepo.ActionKick:
|
||||||
|
return e.d.GuildMemberDeleteWithReason(guildID, u.ID, reason)
|
||||||
|
case securityrepo.ActionBan:
|
||||||
|
return e.d.GuildBanCreateWithReason(guildID, u.ID, reason, 1)
|
||||||
|
}
|
||||||
|
return errors.New("no action " + action)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OnMemberJoin runs every check for a new member: the join lock, the Join
|
||||||
|
// Gate and raid detection. It reports whether the member was removed, so
|
||||||
|
// welcome messages and default roles can be skipped.
|
||||||
|
func (e *Engine) OnMemberJoin(ctx context.Context, guildID string, m *discordgo.Member) (removed bool) {
|
||||||
|
if m == nil || m.User == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
s, _, err := e.load(ctx, guildID)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("security: settings for guild %s: %v", guildID, err)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1. Join lockdown: everyone new is kicked or banned.
|
||||||
|
if s.JoinLock == securityrepo.ActionKick || s.JoinLock == securityrepo.ActionBan {
|
||||||
|
if err := e.punish(guildID, m.User, s.JoinLock, "joins are locked"); err != nil {
|
||||||
|
if !errors.Is(err, errProtected) {
|
||||||
|
log.Printf("security: join lock in guild %s: %v", guildID, err)
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
e.raidJoin(ctx, guildID, s, m, true)
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// 2. Join Gate. A bot's verified flag isn't always in the join event, so
|
||||||
|
// it's read from Discord; if that fails the bot is left alone rather than
|
||||||
|
// risk kicking a verified one.
|
||||||
|
u := m.User
|
||||||
|
if u.Bot && s.JoinGateEnabled && s.UnverifiedBot != securityrepo.ActionOff {
|
||||||
|
fresh, err := e.d.User(u.ID)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("security: looking up bot %s: %v", u.ID, err)
|
||||||
|
a := e.raidJoin(ctx, guildID, s, m, false)
|
||||||
|
return a == securityrepo.ActionKick || a == securityrepo.ActionBan
|
||||||
|
}
|
||||||
|
u = fresh
|
||||||
|
}
|
||||||
|
gate := CheckJoin(s, u, e.now())
|
||||||
|
if gate.Action != securityrepo.ActionOff {
|
||||||
|
if err := e.punish(guildID, m.User, gate.Action, gate.Reason); err != nil {
|
||||||
|
if !errors.Is(err, errProtected) {
|
||||||
|
log.Printf("security: join gate in guild %s: %v", guildID, err)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
removed = gate.Action == securityrepo.ActionKick || gate.Action == securityrepo.ActionBan
|
||||||
|
// During a raid the summary lists everyone; one alert per
|
||||||
|
// raider would flood the channel and Discord's rate limit.
|
||||||
|
if !e.RaidActive(guildID) {
|
||||||
|
e.event(ctx, guildID, securityrepo.EventJoinGate, e.botID, m.User.ID, gate.Action+": "+gate.Reason)
|
||||||
|
e.send(ctx, guildID, s, alert{embed: &discordgo.MessageEmbed{
|
||||||
|
Title: "Join Gate",
|
||||||
|
Description: fmt.Sprintf("%s <@%s> (%s): %s.", actionPast(gate.Action), m.User.ID, safeName(m.User), gate.Reason),
|
||||||
|
Color: colorWarn,
|
||||||
|
}})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 3. Raid detection, which counts every join, gated or not.
|
||||||
|
if a := e.raidJoin(ctx, guildID, s, m, removed); a == securityrepo.ActionKick || a == securityrepo.ActionBan {
|
||||||
|
removed = true
|
||||||
|
}
|
||||||
|
return removed
|
||||||
|
}
|
||||||
|
|
||||||
|
func actionPast(a string) string {
|
||||||
|
switch a {
|
||||||
|
case securityrepo.ActionTimeout:
|
||||||
|
return "Timed out"
|
||||||
|
case securityrepo.ActionKick:
|
||||||
|
return "Kicked"
|
||||||
|
case securityrepo.ActionBan:
|
||||||
|
return "Banned"
|
||||||
|
}
|
||||||
|
return "Flagged"
|
||||||
|
}
|
||||||
@@ -0,0 +1,90 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"strconv"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5"
|
||||||
|
)
|
||||||
|
|
||||||
|
// StartCommandListener carries out the dashboard's requests
|
||||||
|
// (security_commands rows announced with NOTIFY). The dashboard API checks
|
||||||
|
// that the requester is the owner or trusted before inserting; the payload
|
||||||
|
// is still validated here.
|
||||||
|
func (e *Engine) StartCommandListener(ctx context.Context, connString string) error {
|
||||||
|
conn, err := pgx.Connect(ctx, connString)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("connect: %w", err)
|
||||||
|
}
|
||||||
|
defer conn.Close(ctx)
|
||||||
|
if _, err := conn.Exec(ctx, "LISTEN security_commands"); err != nil {
|
||||||
|
return fmt.Errorf("listen: %w", err)
|
||||||
|
}
|
||||||
|
e.ProcessCommands(ctx)
|
||||||
|
for {
|
||||||
|
if _, err := conn.WaitForNotification(ctx); err != nil {
|
||||||
|
return fmt.Errorf("waiting for notifications: %w", err)
|
||||||
|
}
|
||||||
|
e.ProcessCommands(ctx)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ProcessCommands runs every pending command once and marks it done, even
|
||||||
|
// when it fails (the error is logged; retrying would only fail again).
|
||||||
|
func (e *Engine) ProcessCommands(ctx context.Context) {
|
||||||
|
cmds, err := e.st.ListUnprocessedCommands(ctx)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("security: listing dashboard commands: %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
for _, c := range cmds {
|
||||||
|
if err := e.runCommand(ctx, c); err != nil {
|
||||||
|
log.Printf("security: dashboard command %d (%s) for guild %d: %v", c.ID, c.CommandType, c.GuildID, err)
|
||||||
|
}
|
||||||
|
if err := e.st.MarkCommandProcessed(ctx, c.ID); err != nil {
|
||||||
|
log.Printf("security: marking command %d done: %v", c.ID, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *Engine) runCommand(ctx context.Context, c securityrepo.Command) error {
|
||||||
|
guildID, by := id(c.GuildID), id(c.RequestedBy)
|
||||||
|
switch c.CommandType {
|
||||||
|
case "end_raid":
|
||||||
|
return e.EndRaid(ctx, guildID, by)
|
||||||
|
case "unlock_server":
|
||||||
|
_, _, err := e.UnlockServer(ctx, guildID, by)
|
||||||
|
return err
|
||||||
|
case "unlock_joins":
|
||||||
|
return e.SetJoinLock(ctx, guildID, securityrepo.ActionOff, by)
|
||||||
|
case "snapshot":
|
||||||
|
_, _, err := e.TakeSnapshot(ctx, guildID, by)
|
||||||
|
return err
|
||||||
|
case "restore":
|
||||||
|
// Recreating many channels takes minutes under Discord's rate
|
||||||
|
// limits; don't hold up the other commands meanwhile.
|
||||||
|
go func() {
|
||||||
|
if _, err := e.Restore(context.Background(), guildID, by); err != nil {
|
||||||
|
log.Printf("security: restore for guild %s from the dashboard: %v", guildID, err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
return nil
|
||||||
|
case "release_quarantine":
|
||||||
|
var p struct {
|
||||||
|
UserID string `json:"user_id"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(c.Payload, &p); err != nil {
|
||||||
|
return fmt.Errorf("bad payload: %w", err)
|
||||||
|
}
|
||||||
|
if _, err := strconv.ParseUint(p.UserID, 10, 64); err != nil {
|
||||||
|
return fmt.Errorf("bad user id %q", p.UserID)
|
||||||
|
}
|
||||||
|
return e.Release(ctx, guildID, p.UserID, by)
|
||||||
|
}
|
||||||
|
return fmt.Errorf("unknown command %q", c.CommandType)
|
||||||
|
}
|
||||||
@@ -0,0 +1,166 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// LockBits are what a lockdown denies @everyone: talking, threads, reactions.
|
||||||
|
const LockBits = discordgo.PermissionSendMessages | discordgo.PermissionSendMessagesInThreads |
|
||||||
|
discordgo.PermissionCreatePublicThreads | discordgo.PermissionCreatePrivateThreads | discordgo.PermissionAddReactions
|
||||||
|
|
||||||
|
// lockable reports whether a channel type has a chat to lock.
|
||||||
|
func lockable(t discordgo.ChannelType) bool {
|
||||||
|
switch t {
|
||||||
|
case discordgo.ChannelTypeGuildText, discordgo.ChannelTypeGuildNews, discordgo.ChannelTypeGuildForum,
|
||||||
|
discordgo.ChannelTypeGuildVoice, discordgo.ChannelTypeGuildStageVoice, discordgo.ChannelTypeGuildMedia:
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func everyoneOverwrite(ch *discordgo.Channel, guildID string) (allow, deny int64, found bool) {
|
||||||
|
for _, o := range ch.PermissionOverwrites {
|
||||||
|
if o.ID == guildID && o.Type == discordgo.PermissionOverwriteTypeRole {
|
||||||
|
return o.Allow, o.Deny, true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0, 0, false
|
||||||
|
}
|
||||||
|
|
||||||
|
// LockChannel stops @everyone from talking in a channel, remembering the
|
||||||
|
// overwrite it had so UnlockChannel can put it back.
|
||||||
|
func (e *Engine) LockChannel(ctx context.Context, guildID, channelID, by string, serverWide bool) error {
|
||||||
|
ch, err := e.d.Channel(channelID)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("looking up the channel: %w", err)
|
||||||
|
}
|
||||||
|
// Never act on a channel of another server, whatever ID was passed in.
|
||||||
|
if ch.GuildID != guildID {
|
||||||
|
return UserError("That channel isn't in this server.")
|
||||||
|
}
|
||||||
|
if !lockable(ch.Type) {
|
||||||
|
return UserError("That channel has no chat to lock.")
|
||||||
|
}
|
||||||
|
allow, deny, had := everyoneOverwrite(ch, guildID)
|
||||||
|
if err := e.st.SaveLockdown(ctx, securityrepo.Lockdown{
|
||||||
|
GuildID: parseID(guildID), ChannelID: parseID(channelID), HadOverwrite: had,
|
||||||
|
PreviousAllow: allow, PreviousDeny: deny, ServerWide: serverWide, LockedBy: parseID(by),
|
||||||
|
}); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := e.d.ChannelPermissionSet(channelID, guildID, discordgo.PermissionOverwriteTypeRole, allow&^LockBits, deny|LockBits,
|
||||||
|
discordgo.WithAuditLogReason("Velox lockdown")); err != nil {
|
||||||
|
_ = e.st.DeleteLockdown(ctx, parseID(guildID), parseID(channelID))
|
||||||
|
return fmt.Errorf("locking: %w", err)
|
||||||
|
}
|
||||||
|
if !serverWide {
|
||||||
|
e.event(ctx, guildID, securityrepo.EventLocked, by, channelID, "channel")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnlockChannel restores the lock bits of @everyone's overwrite to what they
|
||||||
|
// were before. Anything else changed in the overwrite during the lockdown is
|
||||||
|
// kept. Unlocking relaxes protection, so callers must check the actor first.
|
||||||
|
func (e *Engine) UnlockChannel(ctx context.Context, guildID, channelID, by string) error {
|
||||||
|
rec, err := e.st.GetLockdown(ctx, parseID(guildID), parseID(channelID))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if rec == nil {
|
||||||
|
return UserError("That channel isn't locked by Velox.")
|
||||||
|
}
|
||||||
|
ch, err := e.d.Channel(channelID)
|
||||||
|
if err != nil {
|
||||||
|
// The channel is gone: nothing to unlock.
|
||||||
|
return e.st.DeleteLockdown(ctx, rec.GuildID, rec.ChannelID)
|
||||||
|
}
|
||||||
|
allow, deny, _ := everyoneOverwrite(ch, guildID)
|
||||||
|
allow = allow&^LockBits | rec.PreviousAllow&LockBits
|
||||||
|
deny = deny&^LockBits | rec.PreviousDeny&LockBits
|
||||||
|
|
||||||
|
reason := discordgo.WithAuditLogReason("Velox unlock")
|
||||||
|
if allow == 0 && deny == 0 && !rec.HadOverwrite {
|
||||||
|
err = e.d.ChannelPermissionDelete(channelID, guildID, reason)
|
||||||
|
} else {
|
||||||
|
err = e.d.ChannelPermissionSet(channelID, guildID, discordgo.PermissionOverwriteTypeRole, allow, deny, reason)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("unlocking: %w", err)
|
||||||
|
}
|
||||||
|
if err := e.st.DeleteLockdown(ctx, rec.GuildID, rec.ChannelID); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !rec.ServerWide {
|
||||||
|
e.event(ctx, guildID, securityrepo.EventUnlocked, by, channelID, "channel")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// LockServer locks every channel with a chat.
|
||||||
|
func (e *Engine) LockServer(ctx context.Context, guildID, by string) (locked, failed int, err error) {
|
||||||
|
chans, err := e.d.GuildChannels(guildID)
|
||||||
|
if err != nil {
|
||||||
|
return 0, 0, fmt.Errorf("listing channels: %w", err)
|
||||||
|
}
|
||||||
|
for _, ch := range chans {
|
||||||
|
if !lockable(ch.Type) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if err := e.LockChannel(ctx, guildID, ch.ID, by, true); err != nil {
|
||||||
|
log.Printf("security: locking channel %s in guild %s: %v", ch.ID, guildID, err)
|
||||||
|
failed++
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
locked++
|
||||||
|
}
|
||||||
|
e.event(ctx, guildID, securityrepo.EventLocked, by, "", fmt.Sprintf("server: %d channels locked, %d failed", locked, failed))
|
||||||
|
return locked, failed, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnlockServer unlocks every channel the last server lockdown locked.
|
||||||
|
func (e *Engine) UnlockServer(ctx context.Context, guildID, by string) (unlocked, failed int, err error) {
|
||||||
|
recs, err := e.st.ListLockdowns(ctx, parseID(guildID), true)
|
||||||
|
if err != nil {
|
||||||
|
return 0, 0, err
|
||||||
|
}
|
||||||
|
if len(recs) == 0 {
|
||||||
|
return 0, 0, UserError("The server isn't locked by Velox.")
|
||||||
|
}
|
||||||
|
for _, r := range recs {
|
||||||
|
if err := e.UnlockChannel(ctx, guildID, id(r.ChannelID), by); err != nil {
|
||||||
|
log.Printf("security: unlocking channel %d in guild %s: %v", r.ChannelID, guildID, err)
|
||||||
|
failed++
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
unlocked++
|
||||||
|
}
|
||||||
|
e.event(ctx, guildID, securityrepo.EventUnlocked, by, "", fmt.Sprintf("server: %d channels unlocked, %d failed", unlocked, failed))
|
||||||
|
return unlocked, failed, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetJoinLock turns the join lockdown on ("kick" or "ban") or off. Turning it
|
||||||
|
// off relaxes protection, so callers must check the actor first.
|
||||||
|
func (e *Engine) SetJoinLock(ctx context.Context, guildID, mode, by string) error {
|
||||||
|
switch mode {
|
||||||
|
case securityrepo.ActionOff, securityrepo.ActionKick, securityrepo.ActionBan:
|
||||||
|
default:
|
||||||
|
return UserError("Joins can be locked with kick or ban.")
|
||||||
|
}
|
||||||
|
if err := e.st.SetJoinLock(ctx, parseID(guildID), mode); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
e.Invalidate(guildID)
|
||||||
|
kind := securityrepo.EventLocked
|
||||||
|
if mode == securityrepo.ActionOff {
|
||||||
|
kind = securityrepo.EventUnlocked
|
||||||
|
}
|
||||||
|
e.event(ctx, guildID, kind, by, "", "joins: "+mode)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,446 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"strconv"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// nukeCounter counts destructive actions per server, person and kind over a
|
||||||
|
// sliding window, and remembers whom it just punished so one nuke attempt
|
||||||
|
// is answered once.
|
||||||
|
type nukeCounter struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
hits map[string][]time.Time
|
||||||
|
punished map[string]time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
const (
|
||||||
|
maxHitsPerKey = 200
|
||||||
|
punishCooldown = time.Minute
|
||||||
|
)
|
||||||
|
|
||||||
|
func newNukeCounter() *nukeCounter {
|
||||||
|
return &nukeCounter{hits: map[string][]time.Time{}, punished: map[string]time.Time{}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// add records a hit and returns how many fall inside the window.
|
||||||
|
func (c *nukeCounter) add(key string, now time.Time, window time.Duration) int {
|
||||||
|
c.mu.Lock()
|
||||||
|
defer c.mu.Unlock()
|
||||||
|
h := append(c.hits[key], now)
|
||||||
|
cut := 0
|
||||||
|
for cut < len(h) && now.Sub(h[cut]) > window {
|
||||||
|
cut++
|
||||||
|
}
|
||||||
|
h = h[cut:]
|
||||||
|
if len(h) > maxHitsPerKey {
|
||||||
|
h = h[len(h)-maxHitsPerKey:]
|
||||||
|
}
|
||||||
|
c.hits[key] = h
|
||||||
|
// Opportunistic cleanup so the map can't grow forever.
|
||||||
|
if len(c.hits) > 5000 {
|
||||||
|
for k, v := range c.hits {
|
||||||
|
if len(v) == 0 || now.Sub(v[len(v)-1]) > window {
|
||||||
|
delete(c.hits, k)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return len(h)
|
||||||
|
}
|
||||||
|
|
||||||
|
// claim reports whether this person may be punished now (not punished in the
|
||||||
|
// last minute), and marks them.
|
||||||
|
func (c *nukeCounter) claim(key string, now time.Time) bool {
|
||||||
|
c.mu.Lock()
|
||||||
|
defer c.mu.Unlock()
|
||||||
|
if t, ok := c.punished[key]; ok && now.Sub(t) < punishCooldown {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
c.punished[key] = now
|
||||||
|
if len(c.punished) > 5000 {
|
||||||
|
for k, t := range c.punished {
|
||||||
|
if now.Sub(t) > punishCooldown {
|
||||||
|
delete(c.punished, k)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
func changeKey(c *discordgo.AuditLogChange) string {
|
||||||
|
if c == nil || c.Key == nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return string(*c.Key)
|
||||||
|
}
|
||||||
|
|
||||||
|
func permValue(v any) int64 {
|
||||||
|
switch x := v.(type) {
|
||||||
|
case string:
|
||||||
|
n, _ := strconv.ParseInt(x, 10, 64)
|
||||||
|
return n
|
||||||
|
case float64:
|
||||||
|
return int64(x)
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// Classify maps an audit log entry to a limit key, or flags it as always
|
||||||
|
// forbidden for untrusted members (instant). rolePerms looks up a role's
|
||||||
|
// permissions for role grants.
|
||||||
|
func Classify(entry *discordgo.AuditLogEntry, rolePerms func(roleID string) int64) (key string, instant bool, what string) {
|
||||||
|
if entry == nil || entry.ActionType == nil {
|
||||||
|
return "", false, ""
|
||||||
|
}
|
||||||
|
switch *entry.ActionType {
|
||||||
|
case discordgo.AuditLogActionChannelCreate:
|
||||||
|
return securityrepo.LimitChannelCreate, false, "created channels"
|
||||||
|
case discordgo.AuditLogActionChannelDelete:
|
||||||
|
return securityrepo.LimitChannelDelete, false, "deleted channels"
|
||||||
|
case discordgo.AuditLogActionRoleDelete:
|
||||||
|
return securityrepo.LimitRoleDelete, false, "deleted roles"
|
||||||
|
case discordgo.AuditLogActionMemberBanAdd:
|
||||||
|
return securityrepo.LimitBan, false, "banned members"
|
||||||
|
case discordgo.AuditLogActionMemberKick:
|
||||||
|
return securityrepo.LimitKick, false, "kicked members"
|
||||||
|
case discordgo.AuditLogActionWebhookCreate:
|
||||||
|
return securityrepo.LimitWebhookCreate, false, "created webhooks"
|
||||||
|
case discordgo.AuditLogActionMemberPrune:
|
||||||
|
return "", true, "pruned members"
|
||||||
|
case discordgo.AuditLogActionRoleCreate:
|
||||||
|
for _, c := range entry.Changes {
|
||||||
|
if changeKey(c) == "permissions" && permValue(c.NewValue)&DangerousPerms != 0 {
|
||||||
|
return "", true, "created a role with dangerous permissions"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return securityrepo.LimitRoleCreate, false, "created roles"
|
||||||
|
case discordgo.AuditLogActionRoleUpdate:
|
||||||
|
for _, c := range entry.Changes {
|
||||||
|
if changeKey(c) == "permissions" {
|
||||||
|
added := permValue(c.NewValue) &^ permValue(c.OldValue)
|
||||||
|
if added&DangerousPerms != 0 {
|
||||||
|
return "", true, "gave a role dangerous permissions"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case discordgo.AuditLogActionMemberRoleUpdate:
|
||||||
|
for _, c := range entry.Changes {
|
||||||
|
if changeKey(c) != "$add" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
list, _ := c.NewValue.([]any)
|
||||||
|
for _, item := range list {
|
||||||
|
if r, ok := item.(map[string]any); ok {
|
||||||
|
if rid, _ := r["id"].(string); rid != "" && rolePerms != nil && rolePerms(rid)&DangerousPerms != 0 {
|
||||||
|
return "", true, "gave someone a role with dangerous permissions"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case discordgo.AuditLogActionGuildUpdate:
|
||||||
|
for _, c := range entry.Changes {
|
||||||
|
if changeKey(c) == "vanity_url_code" {
|
||||||
|
return "", true, "changed the vanity URL"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "", false, ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// OnAuditLogEntry watches what members do: bots added by untrusted members
|
||||||
|
// (Join Gate) and destructive actions over the limits (anti-nuke).
|
||||||
|
func (e *Engine) OnAuditLogEntry(ctx context.Context, guildID string, entry *discordgo.AuditLogEntry) {
|
||||||
|
if entry == nil || entry.ActionType == nil || entry.UserID == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s, _, err := e.load(ctx, guildID)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("security: settings for guild %s: %v", guildID, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if *entry.ActionType == discordgo.AuditLogActionBotAdd {
|
||||||
|
e.checkBotAdd(ctx, guildID, s, entry)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if !s.AntiNukeEnabled || !worthChecking(entry) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Role grants need care: someone could give themselves (or an alt) a
|
||||||
|
// trusted role to slip past everything below. Roles added by this very
|
||||||
|
// entry never count towards the actor's own trust, and an untrusted
|
||||||
|
// member granting a trusted role is stopped and the role taken back.
|
||||||
|
added := addedRoles(entry)
|
||||||
|
var actorRoles []string
|
||||||
|
if m, err := e.d.GuildMember(guildID, entry.UserID); err == nil {
|
||||||
|
actorRoles = m.Roles
|
||||||
|
if entry.TargetID == entry.UserID {
|
||||||
|
actorRoles = without(actorRoles, added)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if e.IsTrusted(ctx, guildID, entry.UserID, nonNil(actorRoles)) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
key, instant, what := Classify(entry, func(roleID string) int64 { return e.rolePerms(guildID, roleID) })
|
||||||
|
if granted := e.trustedAmong(ctx, guildID, added); len(granted) > 0 {
|
||||||
|
instant, what = true, "gave someone a trusted role"
|
||||||
|
e.revokeRoles(guildID, entry.TargetID, granted)
|
||||||
|
}
|
||||||
|
if *entry.ActionType == discordgo.AuditLogActionRoleUpdate && e.isBotRole(guildID, entry.TargetID) {
|
||||||
|
instant, what = true, "changed Velox's own role"
|
||||||
|
}
|
||||||
|
if key == "" && !instant {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
who := guildID + "|" + entry.UserID
|
||||||
|
if !instant {
|
||||||
|
limit, ok := s.AntiNukeLimits[key]
|
||||||
|
if !ok {
|
||||||
|
limit = securityrepo.DefaultLimits()[key]
|
||||||
|
}
|
||||||
|
n := e.nukes.add(who+"|"+key, e.now(), time.Duration(s.AntiNukeWindowSeconds)*time.Second)
|
||||||
|
if n <= limit {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
what = fmt.Sprintf("%s %d times in %d seconds (limit %d)", what, n, s.AntiNukeWindowSeconds, limit)
|
||||||
|
}
|
||||||
|
if !e.nukes.claim(who, e.now()) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
e.stopNuke(ctx, guildID, s, entry.UserID, what)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *Engine) rolePerms(guildID, roleID string) int64 {
|
||||||
|
for _, r := range e.guildRoles(guildID) {
|
||||||
|
if r.ID == roleID {
|
||||||
|
return r.Permissions
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// worthChecking skips audit log entries that can never trigger anti-nuke
|
||||||
|
// before anything is looked up on Discord. A busy server writes many entries
|
||||||
|
// (message deletes, nickname changes...), and lookups for each would eat
|
||||||
|
// into the rate limit the bot needs most during an attack.
|
||||||
|
func worthChecking(entry *discordgo.AuditLogEntry) bool {
|
||||||
|
switch *entry.ActionType {
|
||||||
|
case discordgo.AuditLogActionChannelCreate, discordgo.AuditLogActionChannelDelete,
|
||||||
|
discordgo.AuditLogActionRoleCreate, discordgo.AuditLogActionRoleDelete, discordgo.AuditLogActionRoleUpdate,
|
||||||
|
discordgo.AuditLogActionMemberBanAdd, discordgo.AuditLogActionMemberKick, discordgo.AuditLogActionMemberPrune,
|
||||||
|
discordgo.AuditLogActionWebhookCreate:
|
||||||
|
return true
|
||||||
|
case discordgo.AuditLogActionMemberRoleUpdate:
|
||||||
|
return len(addedRoles(entry)) > 0 // removing roles is harmless
|
||||||
|
case discordgo.AuditLogActionGuildUpdate:
|
||||||
|
for _, c := range entry.Changes {
|
||||||
|
if changeKey(c) == "vanity_url_code" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
const roleCacheTTL = 10 * time.Second
|
||||||
|
|
||||||
|
type cachedRoles struct {
|
||||||
|
roles []*discordgo.Role
|
||||||
|
at time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// guildRoles returns the guild's roles, cached briefly. Staleness can't hide
|
||||||
|
// an escalation: creating or editing a role with dangerous permissions is
|
||||||
|
// caught from its own audit log entry.
|
||||||
|
func (e *Engine) guildRoles(guildID string) []*discordgo.Role {
|
||||||
|
e.mu.Lock()
|
||||||
|
c, ok := e.roleCache[guildID]
|
||||||
|
e.mu.Unlock()
|
||||||
|
if ok && e.now().Sub(c.at) < roleCacheTTL {
|
||||||
|
return c.roles
|
||||||
|
}
|
||||||
|
roles, err := e.d.GuildRoles(guildID)
|
||||||
|
if err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
e.mu.Lock()
|
||||||
|
if e.roleCache == nil {
|
||||||
|
e.roleCache = map[string]cachedRoles{}
|
||||||
|
}
|
||||||
|
e.roleCache[guildID] = cachedRoles{roles: roles, at: e.now()}
|
||||||
|
e.mu.Unlock()
|
||||||
|
return roles
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *Engine) stopNuke(ctx context.Context, guildID string, s *securityrepo.Settings, userID, what string) {
|
||||||
|
reason := "anti-nuke: " + what
|
||||||
|
e.event(ctx, guildID, securityrepo.EventNuke, userID, userID, what)
|
||||||
|
|
||||||
|
desc := fmt.Sprintf("<@%s> %s.", userID, what)
|
||||||
|
if err := e.Quarantine(ctx, guildID, userID, reason); err != nil {
|
||||||
|
log.Printf("security: quarantining %s in guild %s: %v", userID, guildID, err)
|
||||||
|
desc += "\n⚠️ I couldn't fully quarantine them: " + clip(err.Error(), 300) +
|
||||||
|
"\nMove the Velox role above their highest role and give it Manage Roles, Moderate Members and Kick Members."
|
||||||
|
} else {
|
||||||
|
desc += "\nThey were quarantined: roles removed (saved) and timed out. Release them with `/security release` if this was a mistake."
|
||||||
|
}
|
||||||
|
if s.AntiNukeLockServer {
|
||||||
|
locked, failed, err := e.LockServer(ctx, guildID, e.botID)
|
||||||
|
switch {
|
||||||
|
case err != nil:
|
||||||
|
desc += "\n⚠️ Locking the server failed: " + clip(err.Error(), 200)
|
||||||
|
default:
|
||||||
|
desc += fmt.Sprintf("\nThe server is locked (%d channels", locked)
|
||||||
|
if failed > 0 {
|
||||||
|
desc += fmt.Sprintf(", %d couldn't be locked", failed)
|
||||||
|
}
|
||||||
|
desc += "). Unlock it with `/unlock server`."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if s.AntiNukeAutoRestore {
|
||||||
|
desc += "\nRestoring deleted roles and channels from the latest snapshot; a report follows."
|
||||||
|
go func() {
|
||||||
|
// Give the attack a moment to stop, then rebuild.
|
||||||
|
time.Sleep(5 * time.Second)
|
||||||
|
if _, err := e.Restore(context.Background(), guildID, e.botID); err != nil {
|
||||||
|
log.Printf("security: auto restore in guild %s: %v", guildID, err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
e.send(ctx, guildID, s, alert{
|
||||||
|
ping: true, pingOwner: true, critical: true,
|
||||||
|
embed: &discordgo.MessageEmbed{
|
||||||
|
Title: "🛡️ Nuke attempt stopped", Description: desc, Color: colorAlert,
|
||||||
|
Timestamp: e.now().UTC().Format(time.RFC3339),
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// checkBotAdd removes a bot that someone other than the owner or a trusted
|
||||||
|
// member added, when the Join Gate is on.
|
||||||
|
func (e *Engine) checkBotAdd(ctx context.Context, guildID string, s *securityrepo.Settings, entry *discordgo.AuditLogEntry) {
|
||||||
|
if !s.JoinGateEnabled || s.UnauthorizedBot == securityrepo.ActionOff || entry.TargetID == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if e.IsTrusted(ctx, guildID, entry.UserID, nil) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
bot := &discordgo.User{ID: entry.TargetID}
|
||||||
|
if err := e.punish(guildID, bot, s.UnauthorizedBot, fmt.Sprintf("bot added by %s, who isn't trusted", entry.UserID)); err != nil {
|
||||||
|
log.Printf("security: removing unauthorized bot %s in guild %s: %v", entry.TargetID, guildID, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
e.event(ctx, guildID, securityrepo.EventUnauthorizedBot, entry.UserID, entry.TargetID, s.UnauthorizedBot)
|
||||||
|
e.send(ctx, guildID, s, alert{
|
||||||
|
ping: true, critical: true,
|
||||||
|
embed: &discordgo.MessageEmbed{
|
||||||
|
Title: "Bot removed",
|
||||||
|
Description: fmt.Sprintf("<@%s> added the bot <@%s> but isn't on the trusted list, so the bot was %s.", entry.UserID, entry.TargetID, map[string]string{securityrepo.ActionKick: "kicked", securityrepo.ActionBan: "banned"}[s.UnauthorizedBot]),
|
||||||
|
Color: colorWarn,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// addedRoles lists the role IDs a member role update added.
|
||||||
|
func addedRoles(entry *discordgo.AuditLogEntry) []string {
|
||||||
|
if entry.ActionType == nil || *entry.ActionType != discordgo.AuditLogActionMemberRoleUpdate {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
var out []string
|
||||||
|
for _, c := range entry.Changes {
|
||||||
|
if changeKey(c) != "$add" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
list, _ := c.NewValue.([]any)
|
||||||
|
for _, item := range list {
|
||||||
|
if r, ok := item.(map[string]any); ok {
|
||||||
|
if rid, _ := r["id"].(string); rid != "" {
|
||||||
|
out = append(out, rid)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func without(list, remove []string) []string {
|
||||||
|
drop := map[string]bool{}
|
||||||
|
for _, r := range remove {
|
||||||
|
drop[r] = true
|
||||||
|
}
|
||||||
|
out := []string{}
|
||||||
|
for _, r := range list {
|
||||||
|
if !drop[r] {
|
||||||
|
out = append(out, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// nonNil keeps an empty role list from meaning "look the member up".
|
||||||
|
func nonNil(roles []string) []string {
|
||||||
|
if roles == nil {
|
||||||
|
return []string{}
|
||||||
|
}
|
||||||
|
return roles
|
||||||
|
}
|
||||||
|
|
||||||
|
// trustedAmong returns which of the roles are on the trusted list.
|
||||||
|
func (e *Engine) trustedAmong(ctx context.Context, guildID string, roles []string) []string {
|
||||||
|
if len(roles) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
_, trusted, err := e.load(ctx, guildID)
|
||||||
|
if err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
var out []string
|
||||||
|
for _, r := range roles {
|
||||||
|
for _, t := range trusted {
|
||||||
|
if t.Kind == "role" && id(t.TargetID) == r {
|
||||||
|
out = append(out, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// revokeRoles takes roles back from a member (best effort; never the owner).
|
||||||
|
func (e *Engine) revokeRoles(guildID, userID string, roles []string) {
|
||||||
|
if userID == "" || e.IsOwner(guildID, userID) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
m, err := e.d.GuildMember(guildID, userID)
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
next := without(m.Roles, roles)
|
||||||
|
if _, err := e.d.GuildMemberEdit(guildID, userID, &discordgo.GuildMemberParams{Roles: &next},
|
||||||
|
discordgo.WithAuditLogReason("Velox anti-nuke: trusted role granted by someone untrusted")); err != nil {
|
||||||
|
log.Printf("security: taking back trusted roles from %s in guild %s: %v", userID, guildID, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// isBotRole reports whether roleID is one of Velox's own roles.
|
||||||
|
func (e *Engine) isBotRole(guildID, roleID string) bool {
|
||||||
|
m, err := e.d.GuildMember(guildID, e.botID)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
for _, r := range m.Roles {
|
||||||
|
if r == roleID {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
@@ -0,0 +1,187 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// usableQuarantineRole returns the configured quarantine role if it is safe
|
||||||
|
// to hand out right now: it exists, isn't @everyone or managed by an
|
||||||
|
// integration, and has none of the dangerous permissions. Checked at use, so
|
||||||
|
// a role that gained permissions since it was configured is never assigned.
|
||||||
|
func usableQuarantineRole(s *securityrepo.Settings, guildID string, roles []*discordgo.Role) string {
|
||||||
|
if s.QuarantineRoleID == 0 || id(s.QuarantineRoleID) == guildID {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
for _, r := range roles {
|
||||||
|
if r.ID == id(s.QuarantineRoleID) {
|
||||||
|
if r.Managed || r.Permissions&DangerousPerms != 0 {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return r.ID
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// Quarantine neutralises a member: every role it can remove is taken away
|
||||||
|
// (and saved, so it can be given back), the quarantine role is added if one
|
||||||
|
// is configured, and the member is timed out for the longest Discord allows.
|
||||||
|
// Bots are kicked instead, since their own integration role can't be
|
||||||
|
// removed. The owner and the bot itself are never touched.
|
||||||
|
func (e *Engine) Quarantine(ctx context.Context, guildID, userID, reason string) error {
|
||||||
|
if userID == "" || userID == e.botID || e.IsOwner(guildID, userID) {
|
||||||
|
return errors.New("refusing to quarantine the owner or the bot")
|
||||||
|
}
|
||||||
|
s, _, err := e.load(ctx, guildID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
m, err := e.d.GuildMember(guildID, userID)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("looking up the member: %w", err)
|
||||||
|
}
|
||||||
|
if m.User != nil && m.User.Bot {
|
||||||
|
return e.d.GuildMemberDeleteWithReason(guildID, userID, clip("Velox anti-nuke: "+reason, 400))
|
||||||
|
}
|
||||||
|
roles, err := e.d.GuildRoles(guildID)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("listing roles: %w", err)
|
||||||
|
}
|
||||||
|
managed := map[string]bool{}
|
||||||
|
for _, r := range roles {
|
||||||
|
if r.Managed {
|
||||||
|
managed[r.ID] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var keep []string
|
||||||
|
var previous []int64
|
||||||
|
for _, r := range m.Roles {
|
||||||
|
if managed[r] {
|
||||||
|
keep = append(keep, r) // can't be removed (e.g. a Nitro booster role)
|
||||||
|
} else {
|
||||||
|
previous = append(previous, parseID(r))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
qRole := usableQuarantineRole(s, guildID, roles)
|
||||||
|
withRole := keep
|
||||||
|
if qRole != "" {
|
||||||
|
withRole = append(append([]string(nil), keep...), qRole)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Save first: if Discord fails half-way, the roles are still on record.
|
||||||
|
if err := e.st.SaveQuarantine(ctx, securityrepo.Quarantine{
|
||||||
|
GuildID: parseID(guildID), UserID: parseID(userID), PreviousRoleIDs: previous, Reason: clip(reason, 300),
|
||||||
|
}); err != nil {
|
||||||
|
return fmt.Errorf("saving the quarantine: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
audit := discordgo.WithAuditLogReason(clip("Velox anti-nuke: "+reason, 400))
|
||||||
|
var errs []error
|
||||||
|
if _, err := e.d.GuildMemberEdit(guildID, userID, &discordgo.GuildMemberParams{Roles: &withRole}, audit); err != nil {
|
||||||
|
// A quarantine role Velox can't assign (e.g. moved above its own
|
||||||
|
// role) must not stop the roles from being removed: retry without it.
|
||||||
|
if qRole == "" {
|
||||||
|
errs = append(errs, fmt.Errorf("removing roles: %w", err))
|
||||||
|
} else if _, err2 := e.d.GuildMemberEdit(guildID, userID, &discordgo.GuildMemberParams{Roles: &keep}, audit); err2 != nil {
|
||||||
|
errs = append(errs, fmt.Errorf("removing roles: %w", err2))
|
||||||
|
} else {
|
||||||
|
log.Printf("security: quarantine role %s couldn't be assigned in guild %s (%v); roles were still removed", qRole, guildID, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
until := e.now().Add(timeoutQuarantine)
|
||||||
|
if err := e.d.GuildMemberTimeout(guildID, userID, &until, audit); err != nil {
|
||||||
|
errs = append(errs, fmt.Errorf("timing out: %w", err))
|
||||||
|
}
|
||||||
|
e.event(ctx, guildID, securityrepo.EventQuarantined, e.botID, userID, reason)
|
||||||
|
return errors.Join(errs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Release undoes a quarantine: the saved roles that still exist are given
|
||||||
|
// back, the quarantine role and the timeout are removed. Releasing relaxes
|
||||||
|
// protection, so callers must check the actor first.
|
||||||
|
func (e *Engine) Release(ctx context.Context, guildID, userID, by string) error {
|
||||||
|
rec, err := e.st.GetQuarantine(ctx, parseID(guildID), parseID(userID))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if rec == nil {
|
||||||
|
return UserError("That member isn't quarantined.")
|
||||||
|
}
|
||||||
|
s, _, err := e.load(ctx, guildID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
m, err := e.d.GuildMember(guildID, userID)
|
||||||
|
if err != nil {
|
||||||
|
// They left: there's nothing to give back.
|
||||||
|
if derr := e.st.DeleteQuarantine(ctx, parseID(guildID), parseID(userID)); derr != nil {
|
||||||
|
return derr
|
||||||
|
}
|
||||||
|
e.event(ctx, guildID, securityrepo.EventReleased, by, userID, "member had left")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
roles, err := e.d.GuildRoles(guildID)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("listing roles: %w", err)
|
||||||
|
}
|
||||||
|
exists := map[string]bool{}
|
||||||
|
for _, r := range roles {
|
||||||
|
if !r.Managed && r.ID != guildID {
|
||||||
|
exists[r.ID] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
qRole := ""
|
||||||
|
if s.QuarantineRoleID != 0 {
|
||||||
|
qRole = id(s.QuarantineRoleID)
|
||||||
|
}
|
||||||
|
|
||||||
|
seen := map[string]bool{}
|
||||||
|
var next []string
|
||||||
|
add := func(r string) {
|
||||||
|
if !seen[r] && r != qRole {
|
||||||
|
seen[r] = true
|
||||||
|
next = append(next, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, r := range m.Roles {
|
||||||
|
add(r)
|
||||||
|
}
|
||||||
|
for _, r := range rec.PreviousRoleIDs {
|
||||||
|
if exists[id(r)] {
|
||||||
|
add(id(r))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
audit := discordgo.WithAuditLogReason("Velox security: quarantine released")
|
||||||
|
if _, err := e.d.GuildMemberEdit(guildID, userID, &discordgo.GuildMemberParams{Roles: &next}, audit); err != nil {
|
||||||
|
return fmt.Errorf("giving the roles back: %w", err)
|
||||||
|
}
|
||||||
|
if err := e.d.GuildMemberTimeout(guildID, userID, nil, audit); err != nil {
|
||||||
|
log.Printf("security: removing the timeout of %s in guild %s: %v", userID, guildID, err)
|
||||||
|
}
|
||||||
|
if err := e.st.DeleteQuarantine(ctx, parseID(guildID), parseID(userID)); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
e.event(ctx, guildID, securityrepo.EventReleased, by, userID, fmt.Sprintf("%d roles given back", len(rec.PreviousRoleIDs)))
|
||||||
|
e.send(ctx, guildID, s, alert{embed: &discordgo.MessageEmbed{
|
||||||
|
Title: "Quarantine released",
|
||||||
|
Description: fmt.Sprintf("<@%s> was released by <@%s> and got their roles back.", userID, by),
|
||||||
|
Color: colorOK,
|
||||||
|
Timestamp: e.now().UTC().Format(time.RFC3339),
|
||||||
|
}})
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Quarantines lists who is quarantined in a guild.
|
||||||
|
func (e *Engine) Quarantines(ctx context.Context, guildID string) ([]securityrepo.Quarantine, error) {
|
||||||
|
return e.st.ListQuarantines(ctx, parseID(guildID))
|
||||||
|
}
|
||||||
@@ -0,0 +1,333 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Memory bounds per server, so a huge raid can't exhaust the bot.
|
||||||
|
const (
|
||||||
|
maxRecentJoins = 500
|
||||||
|
maxCaught = 20000
|
||||||
|
)
|
||||||
|
|
||||||
|
// CustomIDEndRaid is the alert's "End raid" button.
|
||||||
|
const CustomIDEndRaid = "security:endraid"
|
||||||
|
|
||||||
|
type joinRec struct {
|
||||||
|
user *discordgo.User
|
||||||
|
at time.Time
|
||||||
|
handled bool // already removed by the join lock or Join Gate
|
||||||
|
}
|
||||||
|
|
||||||
|
type caughtRec struct {
|
||||||
|
userID, name, action string
|
||||||
|
}
|
||||||
|
|
||||||
|
type raid struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
joins []joinRec
|
||||||
|
active bool
|
||||||
|
started time.Time
|
||||||
|
lastJoin time.Time
|
||||||
|
caught []caughtRec
|
||||||
|
caughtTotal int
|
||||||
|
pausedInvites bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *Engine) raidFor(guildID string) *raid {
|
||||||
|
e.mu.Lock()
|
||||||
|
defer e.mu.Unlock()
|
||||||
|
r, ok := e.raids[guildID]
|
||||||
|
if !ok {
|
||||||
|
r = &raid{}
|
||||||
|
e.raids[guildID] = r
|
||||||
|
}
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// RaidActive reports whether raid mode is on in a guild.
|
||||||
|
func (e *Engine) RaidActive(guildID string) bool {
|
||||||
|
e.mu.Lock()
|
||||||
|
r, ok := e.raids[guildID]
|
||||||
|
e.mu.Unlock()
|
||||||
|
if !ok {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
r.mu.Lock()
|
||||||
|
defer r.mu.Unlock()
|
||||||
|
return r.active
|
||||||
|
}
|
||||||
|
|
||||||
|
// raidJoin records a join and, during a raid, acts on the raiders. It returns
|
||||||
|
// the action taken on this member ("" when none).
|
||||||
|
func (e *Engine) raidJoin(ctx context.Context, guildID string, s *securityrepo.Settings, m *discordgo.Member, handled bool) string {
|
||||||
|
if !s.AntiRaidEnabled {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
now := e.now()
|
||||||
|
window := time.Duration(s.RaidJoinSeconds) * time.Second
|
||||||
|
r := e.raidFor(guildID)
|
||||||
|
|
||||||
|
r.mu.Lock()
|
||||||
|
r.joins = append(r.joins, joinRec{user: m.User, at: now, handled: handled})
|
||||||
|
cut := 0
|
||||||
|
for cut < len(r.joins) && now.Sub(r.joins[cut].at) > window {
|
||||||
|
cut++
|
||||||
|
}
|
||||||
|
r.joins = r.joins[cut:]
|
||||||
|
if len(r.joins) > maxRecentJoins {
|
||||||
|
r.joins = r.joins[len(r.joins)-maxRecentJoins:]
|
||||||
|
}
|
||||||
|
r.lastJoin = now
|
||||||
|
|
||||||
|
var targets []joinRec
|
||||||
|
starting := false
|
||||||
|
switch {
|
||||||
|
case !r.active && len(r.joins) >= s.RaidJoinCount:
|
||||||
|
// Raid starts: everyone in the burst that triggered it is a raider.
|
||||||
|
starting = true
|
||||||
|
r.active, r.started, r.caught, r.caughtTotal, r.pausedInvites = true, now, nil, 0, false
|
||||||
|
targets = append(targets, r.joins...)
|
||||||
|
case r.active:
|
||||||
|
targets = []joinRec{{user: m.User, at: now, handled: handled}}
|
||||||
|
}
|
||||||
|
r.mu.Unlock()
|
||||||
|
|
||||||
|
if starting {
|
||||||
|
e.startRaid(ctx, guildID, s, len(targets))
|
||||||
|
}
|
||||||
|
|
||||||
|
action := s.RaidAction
|
||||||
|
thisMember := ""
|
||||||
|
for _, t := range targets {
|
||||||
|
did := action
|
||||||
|
if t.handled || action == securityrepo.ActionAlert {
|
||||||
|
did = "flagged"
|
||||||
|
} else if err := e.punish(guildID, t.user, action, "raid"); errors.Is(err, errProtected) {
|
||||||
|
did = "skipped"
|
||||||
|
} else if err != nil {
|
||||||
|
log.Printf("security: raid action on %s in guild %s: %v", t.user.ID, guildID, err)
|
||||||
|
did = "failed"
|
||||||
|
}
|
||||||
|
r.mu.Lock()
|
||||||
|
r.caughtTotal++
|
||||||
|
keep := len(r.caught) < maxCaught
|
||||||
|
if keep {
|
||||||
|
r.caught = append(r.caught, caughtRec{userID: t.user.ID, name: safeName(t.user), action: did})
|
||||||
|
}
|
||||||
|
r.mu.Unlock()
|
||||||
|
if keep {
|
||||||
|
if err := e.st.AddRaidCaught(ctx, parseID(guildID), securityrepo.Caught{UserID: parseID(t.user.ID), Action: did, Name: safeName(t.user)}); err != nil {
|
||||||
|
log.Printf("security: recording raider %s in guild %s: %v", t.user.ID, guildID, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if t.user.ID == m.User.ID && did == action {
|
||||||
|
thisMember = action
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(targets) > 0 {
|
||||||
|
e.persistRaid(ctx, guildID, r)
|
||||||
|
}
|
||||||
|
return thisMember
|
||||||
|
}
|
||||||
|
|
||||||
|
// persistRaid writes the raid's state so a restart can resume it.
|
||||||
|
func (e *Engine) persistRaid(ctx context.Context, guildID string, r *raid) {
|
||||||
|
r.mu.Lock()
|
||||||
|
x := securityrepo.Raid{GuildID: parseID(guildID), StartedAt: r.started, LastJoinAt: r.lastJoin, InvitesPaused: r.pausedInvites, CaughtTotal: r.caughtTotal}
|
||||||
|
active := r.active
|
||||||
|
r.mu.Unlock()
|
||||||
|
if !active {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := e.st.SaveRaid(ctx, x); err != nil {
|
||||||
|
log.Printf("security: saving raid state for guild %s: %v", guildID, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ResumeRaids reloads raids that were in progress when the bot stopped, so
|
||||||
|
// raid mode stays on, its quiet timer keeps counting from the last join, and
|
||||||
|
// paused invites are resumed when it ends.
|
||||||
|
func (e *Engine) ResumeRaids(ctx context.Context) {
|
||||||
|
raids, err := e.st.ListRaids(ctx)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("security: loading raids in progress: %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
for _, x := range raids {
|
||||||
|
r := e.raidFor(id(x.GuildID))
|
||||||
|
r.mu.Lock()
|
||||||
|
r.active, r.started, r.lastJoin, r.pausedInvites, r.caughtTotal = true, x.StartedAt, x.LastJoinAt, x.InvitesPaused, x.CaughtTotal
|
||||||
|
r.mu.Unlock()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *Engine) startRaid(ctx context.Context, guildID string, s *securityrepo.Settings, joins int) {
|
||||||
|
e.event(ctx, guildID, securityrepo.EventRaidStarted, e.botID, "", fmt.Sprintf("%d joins in %ds", joins, s.RaidJoinSeconds))
|
||||||
|
|
||||||
|
paused := false
|
||||||
|
if s.RaidPauseInvites {
|
||||||
|
if err := e.setInvitesPaused(guildID, true); err != nil {
|
||||||
|
log.Printf("security: pausing invites in guild %s: %v", guildID, err)
|
||||||
|
} else {
|
||||||
|
paused = true
|
||||||
|
r := e.raidFor(guildID)
|
||||||
|
r.mu.Lock()
|
||||||
|
r.pausedInvites = true
|
||||||
|
r.mu.Unlock()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
e.persistRaid(ctx, guildID, e.raidFor(guildID))
|
||||||
|
|
||||||
|
what := map[string]string{
|
||||||
|
securityrepo.ActionAlert: "nobody is being removed (alert only)", securityrepo.ActionTimeout: "raiders are being timed out",
|
||||||
|
securityrepo.ActionKick: "raiders are being kicked", securityrepo.ActionBan: "raiders are being banned",
|
||||||
|
}[s.RaidAction]
|
||||||
|
desc := fmt.Sprintf("%d members joined within %d seconds. Raid mode is on: %s.", joins, s.RaidJoinSeconds, what)
|
||||||
|
if paused {
|
||||||
|
desc += "\nInvites are paused until the raid ends."
|
||||||
|
}
|
||||||
|
desc += fmt.Sprintf("\nIt ends after %d minutes without a join, or with the button below (owner or trusted only).", s.RaidQuietMinutes)
|
||||||
|
e.send(ctx, guildID, s, alert{
|
||||||
|
ping: true, critical: true,
|
||||||
|
embed: &discordgo.MessageEmbed{
|
||||||
|
Title: "🚨 Raid detected", Description: desc, Color: colorAlert,
|
||||||
|
Timestamp: e.now().UTC().Format(time.RFC3339),
|
||||||
|
},
|
||||||
|
components: []discordgo.MessageComponent{discordgo.ActionsRow{Components: []discordgo.MessageComponent{
|
||||||
|
discordgo.Button{Label: "End raid", Style: discordgo.SecondaryButton, CustomID: CustomIDEndRaid},
|
||||||
|
}}},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// EndRaid turns raid mode off. by is who ended it ("" for the quiet timer).
|
||||||
|
// Ending a raid relaxes protection, so callers must check the actor first.
|
||||||
|
func (e *Engine) EndRaid(ctx context.Context, guildID, by string) error {
|
||||||
|
e.mu.Lock()
|
||||||
|
r, ok := e.raids[guildID]
|
||||||
|
e.mu.Unlock()
|
||||||
|
if !ok {
|
||||||
|
return UserError("There's no raid going on.")
|
||||||
|
}
|
||||||
|
r.mu.Lock()
|
||||||
|
if !r.active {
|
||||||
|
r.mu.Unlock()
|
||||||
|
return UserError("There's no raid going on.")
|
||||||
|
}
|
||||||
|
started, caught, total, paused := r.started, r.caught, r.caughtTotal, r.pausedInvites
|
||||||
|
r.active, r.caught, r.caughtTotal, r.pausedInvites, r.joins = false, nil, 0, false, nil
|
||||||
|
r.mu.Unlock()
|
||||||
|
|
||||||
|
if paused {
|
||||||
|
if err := e.setInvitesPaused(guildID, false); err != nil {
|
||||||
|
log.Printf("security: resuming invites in guild %s: %v", guildID, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
how := "after a quiet period"
|
||||||
|
if by != "" {
|
||||||
|
how = "by <@" + by + ">"
|
||||||
|
}
|
||||||
|
e.event(ctx, guildID, securityrepo.EventRaidEnded, by, "", fmt.Sprintf("%d raiders caught", total))
|
||||||
|
|
||||||
|
// The database has the full list even across a restart; memory is the
|
||||||
|
// fallback if it can't be read.
|
||||||
|
if saved, err := e.st.ListRaidCaught(ctx, parseID(guildID), maxCaught); err == nil && len(saved) >= len(caught) {
|
||||||
|
caught = caught[:0]
|
||||||
|
for _, c := range saved {
|
||||||
|
caught = append(caught, caughtRec{userID: id(c.UserID), action: c.Action, name: c.Name})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := e.st.DeleteRaid(ctx, parseID(guildID)); err != nil {
|
||||||
|
log.Printf("security: clearing raid state for guild %s: %v", guildID, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var list strings.Builder
|
||||||
|
fmt.Fprintf(&list, "Raid from %s to %s (UTC)\n\n", started.UTC().Format("2006-01-02 15:04:05"), e.now().UTC().Format("15:04:05"))
|
||||||
|
for _, c := range caught {
|
||||||
|
fmt.Fprintf(&list, "%s\t%s\t%s\n", c.userID, c.action, c.name)
|
||||||
|
}
|
||||||
|
if total > len(caught) {
|
||||||
|
fmt.Fprintf(&list, "... and %d more\n", total-len(caught))
|
||||||
|
}
|
||||||
|
desc := fmt.Sprintf("Raid mode ended %s. %d accounts were caught; the list is attached.", how, total)
|
||||||
|
if paused {
|
||||||
|
desc += "\nInvites are open again."
|
||||||
|
}
|
||||||
|
if s, _, err := e.load(ctx, guildID); err == nil {
|
||||||
|
e.send(ctx, guildID, s, alert{
|
||||||
|
critical: true,
|
||||||
|
embed: &discordgo.MessageEmbed{Title: "Raid over", Description: desc, Color: colorOK},
|
||||||
|
file: textFile("raid-"+started.UTC().Format("20060102-1504")+".txt", list.String()),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// WatchRaids ends raids after their quiet period and frees memory for
|
||||||
|
// servers that have gone quiet. It runs until ctx ends.
|
||||||
|
func (e *Engine) WatchRaids(ctx context.Context, every time.Duration) {
|
||||||
|
t := time.NewTicker(every)
|
||||||
|
defer t.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-t.C:
|
||||||
|
e.checkRaids(ctx)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *Engine) checkRaids(ctx context.Context) {
|
||||||
|
e.mu.Lock()
|
||||||
|
guilds := make([]string, 0, len(e.raids))
|
||||||
|
for g := range e.raids {
|
||||||
|
guilds = append(guilds, g)
|
||||||
|
}
|
||||||
|
e.mu.Unlock()
|
||||||
|
|
||||||
|
now := e.now()
|
||||||
|
for _, g := range guilds {
|
||||||
|
s, _, err := e.load(ctx, g)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
r := e.raidFor(g)
|
||||||
|
r.mu.Lock()
|
||||||
|
active, last := r.active, r.lastJoin
|
||||||
|
r.mu.Unlock()
|
||||||
|
switch {
|
||||||
|
case active && now.Sub(last) >= time.Duration(s.RaidQuietMinutes)*time.Minute:
|
||||||
|
_ = e.EndRaid(ctx, g, "")
|
||||||
|
case !active && now.Sub(last) > 10*time.Minute:
|
||||||
|
e.mu.Lock()
|
||||||
|
delete(e.raids, g)
|
||||||
|
e.mu.Unlock()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// setInvitesPaused uses Discord's built-in "pause invites" (guild incident
|
||||||
|
// actions). Paused for up to 24 hours, Discord's maximum; resumed when the
|
||||||
|
// raid ends.
|
||||||
|
func (e *Engine) setInvitesPaused(guildID string, paused bool) error {
|
||||||
|
body := map[string]any{"invites_disabled_until": nil}
|
||||||
|
if paused {
|
||||||
|
body["invites_disabled_until"] = e.now().Add(24 * time.Hour).UTC().Format(time.RFC3339)
|
||||||
|
}
|
||||||
|
url := discordgo.EndpointGuild(guildID) + "/incident-actions"
|
||||||
|
_, err := e.d.RequestWithBucketID("PUT", url, body, url)
|
||||||
|
return err
|
||||||
|
}
|
||||||
@@ -0,0 +1,322 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"sort"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Snapshots record a guild's roles and channels (names, settings,
|
||||||
|
// permissions, channel permission overwrites) so a nuke can be undone.
|
||||||
|
// Messages and who had which role can't be captured or brought back; Discord
|
||||||
|
// offers no way to.
|
||||||
|
const (
|
||||||
|
snapshotEvery = 6 * time.Hour
|
||||||
|
snapshotCheckGap = 30 * time.Minute
|
||||||
|
)
|
||||||
|
|
||||||
|
type snapRole struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
Color int `json:"color"`
|
||||||
|
Hoist bool `json:"hoist"`
|
||||||
|
Mentionable bool `json:"mentionable"`
|
||||||
|
Permissions int64 `json:"permissions"`
|
||||||
|
Position int `json:"position"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type snapOverwrite struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Type int `json:"type"`
|
||||||
|
Allow int64 `json:"allow"`
|
||||||
|
Deny int64 `json:"deny"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type snapChannel struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
Type int `json:"type"`
|
||||||
|
Topic string `json:"topic,omitempty"`
|
||||||
|
ParentID string `json:"parent_id,omitempty"`
|
||||||
|
Position int `json:"position"`
|
||||||
|
NSFW bool `json:"nsfw,omitempty"`
|
||||||
|
RateLimit int `json:"rate_limit,omitempty"`
|
||||||
|
Bitrate int `json:"bitrate,omitempty"`
|
||||||
|
UserLimit int `json:"user_limit,omitempty"`
|
||||||
|
Overwrites []snapOverwrite `json:"overwrites,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type snapshotData struct {
|
||||||
|
Roles []snapRole `json:"roles"`
|
||||||
|
Channels []snapChannel `json:"channels"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// restorable channel types: no threads, which belong to their parent.
|
||||||
|
func restorable(t discordgo.ChannelType) bool {
|
||||||
|
switch t {
|
||||||
|
case discordgo.ChannelTypeGuildText, discordgo.ChannelTypeGuildVoice, discordgo.ChannelTypeGuildCategory,
|
||||||
|
discordgo.ChannelTypeGuildNews, discordgo.ChannelTypeGuildStageVoice, discordgo.ChannelTypeGuildForum:
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// TakeSnapshot records the guild's current roles and channels.
|
||||||
|
func (e *Engine) TakeSnapshot(ctx context.Context, guildID, by string) (roles, channels int, err error) {
|
||||||
|
rs, err := e.d.GuildRoles(guildID)
|
||||||
|
if err != nil {
|
||||||
|
return 0, 0, fmt.Errorf("listing roles: %w", err)
|
||||||
|
}
|
||||||
|
cs, err := e.d.GuildChannels(guildID)
|
||||||
|
if err != nil {
|
||||||
|
return 0, 0, fmt.Errorf("listing channels: %w", err)
|
||||||
|
}
|
||||||
|
var data snapshotData
|
||||||
|
for _, r := range rs {
|
||||||
|
if r.Managed {
|
||||||
|
continue // integration roles come back with their bot
|
||||||
|
}
|
||||||
|
data.Roles = append(data.Roles, snapRole{ID: r.ID, Name: r.Name, Color: r.Color, Hoist: r.Hoist,
|
||||||
|
Mentionable: r.Mentionable, Permissions: r.Permissions, Position: r.Position})
|
||||||
|
}
|
||||||
|
for _, c := range cs {
|
||||||
|
if !restorable(c.Type) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
sc := snapChannel{ID: c.ID, Name: c.Name, Type: int(c.Type), Topic: c.Topic, ParentID: c.ParentID, Position: c.Position,
|
||||||
|
NSFW: c.NSFW, RateLimit: c.RateLimitPerUser, Bitrate: c.Bitrate, UserLimit: c.UserLimit}
|
||||||
|
for _, o := range c.PermissionOverwrites {
|
||||||
|
sc.Overwrites = append(sc.Overwrites, snapOverwrite{ID: o.ID, Type: int(o.Type), Allow: o.Allow, Deny: o.Deny})
|
||||||
|
}
|
||||||
|
data.Channels = append(data.Channels, sc)
|
||||||
|
}
|
||||||
|
raw, err := json.Marshal(data)
|
||||||
|
if err != nil {
|
||||||
|
return 0, 0, err
|
||||||
|
}
|
||||||
|
if err := e.st.SaveSnapshot(ctx, securityrepo.Snapshot{GuildID: parseID(guildID), Data: raw, Roles: len(data.Roles), Channels: len(data.Channels)}); err != nil {
|
||||||
|
return 0, 0, err
|
||||||
|
}
|
||||||
|
if by != "" {
|
||||||
|
e.event(ctx, guildID, securityrepo.EventSnapshot, by, "", fmt.Sprintf("%d roles, %d channels", len(data.Roles), len(data.Channels)))
|
||||||
|
}
|
||||||
|
return len(data.Roles), len(data.Channels), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// WatchSnapshots takes a snapshot of every guild with anti-nuke on whose
|
||||||
|
// newest one is older than six hours. It runs until ctx ends.
|
||||||
|
func (e *Engine) WatchSnapshots(ctx context.Context) {
|
||||||
|
run := func() {
|
||||||
|
due, err := e.st.GuildsDueForSnapshot(ctx, snapshotEvery)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("security: finding guilds due a snapshot: %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
for _, g := range due {
|
||||||
|
if _, _, err := e.TakeSnapshot(ctx, id(g), ""); err != nil {
|
||||||
|
log.Printf("security: snapshot of guild %d: %v", g, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
run()
|
||||||
|
t := time.NewTicker(snapshotCheckGap)
|
||||||
|
defer t.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-t.C:
|
||||||
|
run()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RestoreResult says what a restore did.
|
||||||
|
type RestoreResult struct {
|
||||||
|
RolesCreated, RolesReverted, ChannelsCreated, Failed int
|
||||||
|
SnapshotAt time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// Restore brings the guild back towards its latest snapshot:
|
||||||
|
//
|
||||||
|
// - roles that are gone are recreated (same name, colour, permissions);
|
||||||
|
// - roles that gained Administrator, Manage Server, Manage Roles or Manage
|
||||||
|
// Webhooks since the snapshot get their snapshot permissions back;
|
||||||
|
// - channels that are gone are recreated, categories first, with their
|
||||||
|
// permission overwrites pointing at the recreated roles.
|
||||||
|
//
|
||||||
|
// Nothing is deleted: channels and roles made since the snapshot stay, since
|
||||||
|
// some may be legitimate. Restoring rewrites the server, so callers must check
|
||||||
|
// the actor is the owner or trusted. One restore per guild runs at a time.
|
||||||
|
func (e *Engine) Restore(ctx context.Context, guildID, by string) (*RestoreResult, error) {
|
||||||
|
e.mu.Lock()
|
||||||
|
if e.restoring[guildID] {
|
||||||
|
e.mu.Unlock()
|
||||||
|
return nil, UserError("A restore is already running for this server.")
|
||||||
|
}
|
||||||
|
e.restoring[guildID] = true
|
||||||
|
e.mu.Unlock()
|
||||||
|
defer func() {
|
||||||
|
e.mu.Lock()
|
||||||
|
delete(e.restoring, guildID)
|
||||||
|
e.mu.Unlock()
|
||||||
|
}()
|
||||||
|
|
||||||
|
snap, err := e.st.LatestSnapshot(ctx, parseID(guildID))
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if snap == nil {
|
||||||
|
return nil, UserError("There's no snapshot to restore from yet. Turn anti-nuke on (snapshots are taken every 6 hours) or take one with `/security snapshot`.")
|
||||||
|
}
|
||||||
|
var data snapshotData
|
||||||
|
if err := json.Unmarshal(snap.Data, &data); err != nil {
|
||||||
|
return nil, fmt.Errorf("reading the snapshot: %w", err)
|
||||||
|
}
|
||||||
|
res := &RestoreResult{SnapshotAt: snap.CreatedAt}
|
||||||
|
reason := discordgo.WithAuditLogReason("Velox restore from snapshot")
|
||||||
|
|
||||||
|
// Roles.
|
||||||
|
current, err := e.d.GuildRoles(guildID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("listing roles: %w", err)
|
||||||
|
}
|
||||||
|
now := map[string]*discordgo.Role{}
|
||||||
|
for _, r := range current {
|
||||||
|
now[r.ID] = r
|
||||||
|
}
|
||||||
|
roleMap := map[string]string{} // snapshot role ID -> current role ID
|
||||||
|
sort.Slice(data.Roles, func(i, j int) bool { return data.Roles[i].Position < data.Roles[j].Position })
|
||||||
|
for _, sr := range data.Roles {
|
||||||
|
if cur, ok := now[sr.ID]; ok {
|
||||||
|
roleMap[sr.ID] = sr.ID
|
||||||
|
if added := cur.Permissions &^ sr.Permissions; added&DangerousPerms != 0 && !cur.Managed {
|
||||||
|
perms := sr.Permissions
|
||||||
|
if _, err := e.d.GuildRoleEdit(guildID, sr.ID, &discordgo.RoleParams{Permissions: &perms}, reason); err != nil {
|
||||||
|
log.Printf("security: restore: reverting role %s in guild %s: %v", sr.ID, guildID, err)
|
||||||
|
res.Failed++
|
||||||
|
} else {
|
||||||
|
res.RolesReverted++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if sr.ID == guildID {
|
||||||
|
continue // @everyone always exists
|
||||||
|
}
|
||||||
|
color, hoist, mention, perms := sr.Color, sr.Hoist, sr.Mentionable, sr.Permissions
|
||||||
|
r, err := e.d.GuildRoleCreate(guildID, &discordgo.RoleParams{Name: sr.Name, Color: &color, Hoist: &hoist, Mentionable: &mention, Permissions: &perms}, reason)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("security: restore: recreating role %q in guild %s: %v", sr.Name, guildID, err)
|
||||||
|
res.Failed++
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
roleMap[sr.ID] = r.ID
|
||||||
|
res.RolesCreated++
|
||||||
|
}
|
||||||
|
|
||||||
|
// Channels: categories first so the others can be put back in them.
|
||||||
|
chans, err := e.d.GuildChannels(guildID)
|
||||||
|
if err != nil {
|
||||||
|
return res, fmt.Errorf("listing channels: %w", err)
|
||||||
|
}
|
||||||
|
exists := map[string]bool{}
|
||||||
|
for _, c := range chans {
|
||||||
|
exists[c.ID] = true
|
||||||
|
}
|
||||||
|
chanMap := map[string]string{}
|
||||||
|
for _, c := range chans {
|
||||||
|
chanMap[c.ID] = c.ID
|
||||||
|
}
|
||||||
|
sort.SliceStable(data.Channels, func(i, j int) bool {
|
||||||
|
ci := data.Channels[i].Type == int(discordgo.ChannelTypeGuildCategory)
|
||||||
|
cj := data.Channels[j].Type == int(discordgo.ChannelTypeGuildCategory)
|
||||||
|
if ci != cj {
|
||||||
|
return ci
|
||||||
|
}
|
||||||
|
return data.Channels[i].Position < data.Channels[j].Position
|
||||||
|
})
|
||||||
|
for _, sc := range data.Channels {
|
||||||
|
if exists[sc.ID] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
var overwrites []*discordgo.PermissionOverwrite
|
||||||
|
for _, o := range sc.Overwrites {
|
||||||
|
target := o.ID
|
||||||
|
if discordgo.PermissionOverwriteType(o.Type) == discordgo.PermissionOverwriteTypeRole {
|
||||||
|
mapped, ok := roleMap[o.ID]
|
||||||
|
if !ok {
|
||||||
|
continue // the role couldn't be brought back
|
||||||
|
}
|
||||||
|
target = mapped
|
||||||
|
}
|
||||||
|
overwrites = append(overwrites, &discordgo.PermissionOverwrite{ID: target, Type: discordgo.PermissionOverwriteType(o.Type), Allow: o.Allow, Deny: o.Deny})
|
||||||
|
}
|
||||||
|
parent := ""
|
||||||
|
if sc.ParentID != "" {
|
||||||
|
parent = chanMap[sc.ParentID] // "" if the category couldn't be restored
|
||||||
|
}
|
||||||
|
c, err := e.d.GuildChannelCreateComplex(guildID, discordgo.GuildChannelCreateData{
|
||||||
|
Name: sc.Name, Type: discordgo.ChannelType(sc.Type), Topic: sc.Topic, Bitrate: sc.Bitrate, UserLimit: sc.UserLimit,
|
||||||
|
RateLimitPerUser: sc.RateLimit, Position: sc.Position, PermissionOverwrites: overwrites, ParentID: parent, NSFW: sc.NSFW,
|
||||||
|
}, reason)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("security: restore: recreating channel %q in guild %s: %v", sc.Name, guildID, err)
|
||||||
|
res.Failed++
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
chanMap[sc.ID] = c.ID
|
||||||
|
res.ChannelsCreated++
|
||||||
|
}
|
||||||
|
|
||||||
|
// Point the snapshot at the recreated roles and channels, so restoring
|
||||||
|
// again doesn't create them a second time. The content stays the
|
||||||
|
// snapshot's: nothing made since (or by an attacker) is added.
|
||||||
|
if res.RolesCreated+res.ChannelsCreated > 0 {
|
||||||
|
for i := range data.Roles {
|
||||||
|
if nid, ok := roleMap[data.Roles[i].ID]; ok {
|
||||||
|
data.Roles[i].ID = nid
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for i := range data.Channels {
|
||||||
|
c := &data.Channels[i]
|
||||||
|
if nid, ok := chanMap[c.ID]; ok {
|
||||||
|
c.ID = nid
|
||||||
|
}
|
||||||
|
if nid, ok := chanMap[c.ParentID]; ok && c.ParentID != "" {
|
||||||
|
c.ParentID = nid
|
||||||
|
}
|
||||||
|
for j := range c.Overwrites {
|
||||||
|
if c.Overwrites[j].Type == int(discordgo.PermissionOverwriteTypeRole) {
|
||||||
|
if nid, ok := roleMap[c.Overwrites[j].ID]; ok {
|
||||||
|
c.Overwrites[j].ID = nid
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if raw, err := json.Marshal(data); err == nil {
|
||||||
|
if err := e.st.SaveSnapshot(ctx, securityrepo.Snapshot{GuildID: parseID(guildID), Data: raw, Roles: snap.Roles, Channels: snap.Channels}); err != nil {
|
||||||
|
log.Printf("security: saving the remapped snapshot for guild %s: %v", guildID, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
e.event(ctx, guildID, securityrepo.EventRestored, by, "", fmt.Sprintf("%d roles recreated, %d reverted, %d channels recreated, %d failed",
|
||||||
|
res.RolesCreated, res.RolesReverted, res.ChannelsCreated, res.Failed))
|
||||||
|
if s, _, err := e.load(ctx, guildID); err == nil {
|
||||||
|
e.send(ctx, guildID, s, alert{critical: true, embed: &discordgo.MessageEmbed{
|
||||||
|
Title: "♻️ Server restored from snapshot",
|
||||||
|
Description: fmt.Sprintf("Snapshot from <t:%d:f>. Recreated %d roles and %d channels, reverted dangerous permissions on %d roles. %d steps failed.\nMembers need their recreated roles given back by hand; Discord doesn't let bots see who had them.",
|
||||||
|
res.SnapshotAt.Unix(), res.RolesCreated, res.ChannelsCreated, res.RolesReverted, res.Failed),
|
||||||
|
Color: colorOK,
|
||||||
|
}})
|
||||||
|
}
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,354 @@
|
|||||||
|
// Package security is the bot's anti-raid and anti-nuke system, modelled on
|
||||||
|
// Wick:
|
||||||
|
//
|
||||||
|
// - Join Gate: checks on every join (no avatar, new account, invite links
|
||||||
|
// or blocked words in the name, unverified bots), each with its own
|
||||||
|
// action, plus kicking bots added by anyone who isn't trusted.
|
||||||
|
// - Raid mode: a burst of joins starts it; raiders are timed out, kicked or
|
||||||
|
// banned, invites can be paused, staff are alerted, and it ends after a
|
||||||
|
// quiet period or when staff end it.
|
||||||
|
// - Anti-nuke: destructive actions (deleting channels or roles, mass bans
|
||||||
|
// and kicks, webhooks, dangerous permissions) are counted per person from
|
||||||
|
// the audit log; anyone who isn't the owner or trusted and goes over a
|
||||||
|
// limit is quarantined: roles removed and saved, timed out.
|
||||||
|
// - Lockdown: lock a channel, every channel, or joins, and unlock exactly
|
||||||
|
// back to how they were.
|
||||||
|
//
|
||||||
|
// Safety rules every entry point follows:
|
||||||
|
//
|
||||||
|
// - Turning protection off, changing limits, releasing a quarantine and
|
||||||
|
// unlocking need the server owner or someone on the trusted list.
|
||||||
|
// Editing the trusted list needs the owner. Discord's command
|
||||||
|
// permissions are never relied on, since admins can change them.
|
||||||
|
// - The owner and the bot itself are never punished.
|
||||||
|
// - Configured roles are checked when used, not just when saved: a
|
||||||
|
// quarantine role that gained dangerous permissions is not assigned.
|
||||||
|
// - Messages only ever ping the configured alert role, and user-controlled
|
||||||
|
// text (names) is escaped.
|
||||||
|
// - Memory per server is bounded, and settings are cached briefly so a
|
||||||
|
// raid of thousands of joins doesn't turn into thousands of queries.
|
||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Store is the subset of securityrepo.Repo the system uses.
|
||||||
|
type Store interface {
|
||||||
|
GetSettings(ctx context.Context, guildID int64) (*securityrepo.Settings, error)
|
||||||
|
SetEnabled(ctx context.Context, guildID int64, feature string, on bool) error
|
||||||
|
SetAlerts(ctx context.Context, guildID, channelID, roleID int64) error
|
||||||
|
SetQuarantineRole(ctx context.Context, guildID, roleID int64) error
|
||||||
|
SetJoinLock(ctx context.Context, guildID int64, mode string) error
|
||||||
|
ListTrusted(ctx context.Context, guildID int64) ([]securityrepo.Trusted, error)
|
||||||
|
AddTrusted(ctx context.Context, guildID int64, t securityrepo.Trusted) error
|
||||||
|
RemoveTrusted(ctx context.Context, guildID, targetID int64) (bool, error)
|
||||||
|
SaveQuarantine(ctx context.Context, q securityrepo.Quarantine) error
|
||||||
|
GetQuarantine(ctx context.Context, guildID, userID int64) (*securityrepo.Quarantine, error)
|
||||||
|
ListQuarantines(ctx context.Context, guildID int64) ([]securityrepo.Quarantine, error)
|
||||||
|
DeleteQuarantine(ctx context.Context, guildID, userID int64) error
|
||||||
|
SaveLockdown(ctx context.Context, l securityrepo.Lockdown) error
|
||||||
|
GetLockdown(ctx context.Context, guildID, channelID int64) (*securityrepo.Lockdown, error)
|
||||||
|
ListLockdowns(ctx context.Context, guildID int64, serverWideOnly bool) ([]securityrepo.Lockdown, error)
|
||||||
|
DeleteLockdown(ctx context.Context, guildID, channelID int64) error
|
||||||
|
AddEvent(ctx context.Context, e securityrepo.Event) error
|
||||||
|
ListUnprocessedCommands(ctx context.Context) ([]securityrepo.Command, error)
|
||||||
|
MarkCommandProcessed(ctx context.Context, id int64) error
|
||||||
|
SaveRaid(ctx context.Context, x securityrepo.Raid) error
|
||||||
|
ListRaids(ctx context.Context) ([]securityrepo.Raid, error)
|
||||||
|
DeleteRaid(ctx context.Context, guildID int64) error
|
||||||
|
AddRaidCaught(ctx context.Context, guildID int64, c securityrepo.Caught) error
|
||||||
|
ListRaidCaught(ctx context.Context, guildID int64, limit int) ([]securityrepo.Caught, error)
|
||||||
|
SaveSnapshot(ctx context.Context, s securityrepo.Snapshot) error
|
||||||
|
LatestSnapshot(ctx context.Context, guildID int64) (*securityrepo.Snapshot, error)
|
||||||
|
GuildsDueForSnapshot(ctx context.Context, maxAge time.Duration) ([]int64, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Discord is the subset of *discordgo.Session the system uses.
|
||||||
|
type Discord interface {
|
||||||
|
Guild(guildID string, options ...discordgo.RequestOption) (*discordgo.Guild, error)
|
||||||
|
UserChannelCreate(recipientID string, options ...discordgo.RequestOption) (*discordgo.Channel, error)
|
||||||
|
User(userID string, options ...discordgo.RequestOption) (*discordgo.User, error)
|
||||||
|
GuildRoles(guildID string, options ...discordgo.RequestOption) ([]*discordgo.Role, error)
|
||||||
|
GuildChannels(guildID string, options ...discordgo.RequestOption) ([]*discordgo.Channel, error)
|
||||||
|
GuildMember(guildID, userID string, options ...discordgo.RequestOption) (*discordgo.Member, error)
|
||||||
|
GuildMemberEdit(guildID, userID string, data *discordgo.GuildMemberParams, options ...discordgo.RequestOption) (*discordgo.Member, error)
|
||||||
|
GuildMemberTimeout(guildID, userID string, until *time.Time, options ...discordgo.RequestOption) error
|
||||||
|
GuildMemberDeleteWithReason(guildID, userID, reason string, options ...discordgo.RequestOption) error
|
||||||
|
GuildBanCreateWithReason(guildID, userID, reason string, days int, options ...discordgo.RequestOption) error
|
||||||
|
Channel(channelID string, options ...discordgo.RequestOption) (*discordgo.Channel, error)
|
||||||
|
ChannelPermissionSet(channelID, targetID string, targetType discordgo.PermissionOverwriteType, allow, deny int64, options ...discordgo.RequestOption) error
|
||||||
|
ChannelPermissionDelete(channelID, targetID string, options ...discordgo.RequestOption) error
|
||||||
|
ChannelMessageSendComplex(channelID string, data *discordgo.MessageSend, options ...discordgo.RequestOption) (*discordgo.Message, error)
|
||||||
|
RequestWithBucketID(method, urlStr string, data interface{}, bucketID string, options ...discordgo.RequestOption) ([]byte, error)
|
||||||
|
ChannelMessageDelete(channelID, messageID string, options ...discordgo.RequestOption) error
|
||||||
|
GuildRoleCreate(guildID string, data *discordgo.RoleParams, options ...discordgo.RequestOption) (*discordgo.Role, error)
|
||||||
|
GuildRoleEdit(guildID, roleID string, data *discordgo.RoleParams, options ...discordgo.RequestOption) (*discordgo.Role, error)
|
||||||
|
GuildChannelCreateComplex(guildID string, data discordgo.GuildChannelCreateData, options ...discordgo.RequestOption) (*discordgo.Channel, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UserError is shown to the person who acted, as written.
|
||||||
|
type UserError string
|
||||||
|
|
||||||
|
func (e UserError) Error() string { return string(e) }
|
||||||
|
|
||||||
|
const (
|
||||||
|
ErrNotTrusted = UserError("Only the server owner or someone on the security trusted list can do that.")
|
||||||
|
ErrNotOwner = UserError("Only the server owner can change the trusted list.")
|
||||||
|
)
|
||||||
|
|
||||||
|
// Dangerous permissions: what a nuker needs, and what no quarantine or alert
|
||||||
|
// role may have.
|
||||||
|
const DangerousPerms = discordgo.PermissionAdministrator | discordgo.PermissionManageGuild |
|
||||||
|
discordgo.PermissionManageRoles | discordgo.PermissionManageWebhooks
|
||||||
|
|
||||||
|
const (
|
||||||
|
timeoutJoin = 24 * time.Hour
|
||||||
|
timeoutQuarantine = 28*24*time.Hour - time.Hour // Discord's maximum is 28 days
|
||||||
|
settingsTTL = 15 * time.Second
|
||||||
|
ownerTTL = 10 * time.Minute
|
||||||
|
)
|
||||||
|
|
||||||
|
// Engine holds the system's state. One per bot.
|
||||||
|
type Engine struct {
|
||||||
|
d Discord
|
||||||
|
st Store
|
||||||
|
botID string
|
||||||
|
now func() time.Time
|
||||||
|
|
||||||
|
mu sync.Mutex
|
||||||
|
settings map[string]cachedSettings
|
||||||
|
owners map[string]cachedOwner
|
||||||
|
raids map[string]*raid
|
||||||
|
nukes *nukeCounter
|
||||||
|
roleCache map[string]cachedRoles
|
||||||
|
heat map[string]*guildHeat
|
||||||
|
restoring map[string]bool
|
||||||
|
|
||||||
|
// syncDMs sends alert DMs before returning (tests); normally they go out
|
||||||
|
// in the background so an alert never waits on them.
|
||||||
|
syncDMs bool
|
||||||
|
|
||||||
|
// ChannelPerms reports a member's permissions in a channel from the
|
||||||
|
// gateway cache (no REST call), used to exempt moderators from heat.
|
||||||
|
// Nil means nobody is exempt by permission.
|
||||||
|
ChannelPerms func(userID, channelID string) (int64, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
type cachedSettings struct {
|
||||||
|
s *securityrepo.Settings
|
||||||
|
trusted []securityrepo.Trusted
|
||||||
|
at time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
type cachedOwner struct {
|
||||||
|
id string
|
||||||
|
name string
|
||||||
|
at time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
func New(d Discord, st Store, botID string) *Engine {
|
||||||
|
return &Engine{
|
||||||
|
d: d, st: st, botID: botID, now: time.Now,
|
||||||
|
settings: map[string]cachedSettings{},
|
||||||
|
owners: map[string]cachedOwner{},
|
||||||
|
raids: map[string]*raid{},
|
||||||
|
nukes: newNukeCounter(),
|
||||||
|
heat: map[string]*guildHeat{},
|
||||||
|
restoring: map[string]bool{},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
defaultEngine *Engine
|
||||||
|
pendingStore Store
|
||||||
|
)
|
||||||
|
|
||||||
|
// Configure sets the store; Start creates the engine once the bot knows its
|
||||||
|
// own user ID (after the gateway connects).
|
||||||
|
func Configure(st Store) { pendingStore = st }
|
||||||
|
|
||||||
|
// Start creates the default engine for a connected session. It returns nil
|
||||||
|
// when no store was configured.
|
||||||
|
func Start(d Discord, botID string) *Engine {
|
||||||
|
if pendingStore == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
defaultEngine = New(d, pendingStore, botID)
|
||||||
|
return defaultEngine
|
||||||
|
}
|
||||||
|
|
||||||
|
func Init(e *Engine) { defaultEngine = e }
|
||||||
|
|
||||||
|
func Default() *Engine { return defaultEngine }
|
||||||
|
|
||||||
|
func parseID(s string) int64 {
|
||||||
|
n, _ := strconv.ParseInt(s, 10, 64)
|
||||||
|
return n
|
||||||
|
}
|
||||||
|
|
||||||
|
func id(n int64) string { return strconv.FormatInt(n, 10) }
|
||||||
|
|
||||||
|
// load returns the guild's settings and trusted list, cached briefly.
|
||||||
|
func (e *Engine) load(ctx context.Context, guildID string) (*securityrepo.Settings, []securityrepo.Trusted, error) {
|
||||||
|
e.mu.Lock()
|
||||||
|
c, ok := e.settings[guildID]
|
||||||
|
e.mu.Unlock()
|
||||||
|
if ok && e.now().Sub(c.at) < settingsTTL {
|
||||||
|
return c.s, c.trusted, nil
|
||||||
|
}
|
||||||
|
g := parseID(guildID)
|
||||||
|
s, err := e.st.GetSettings(ctx, g)
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
trusted, err := e.st.ListTrusted(ctx, g)
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
e.mu.Lock()
|
||||||
|
e.settings[guildID] = cachedSettings{s: s, trusted: trusted, at: e.now()}
|
||||||
|
e.mu.Unlock()
|
||||||
|
return s, trusted, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Invalidate drops the cached settings after a change, so it applies at once.
|
||||||
|
func (e *Engine) Invalidate(guildID string) {
|
||||||
|
e.mu.Lock()
|
||||||
|
delete(e.settings, guildID)
|
||||||
|
e.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Settings returns the current settings (for status displays).
|
||||||
|
func (e *Engine) Settings(ctx context.Context, guildID string) (*securityrepo.Settings, []securityrepo.Trusted, error) {
|
||||||
|
return e.load(ctx, guildID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OwnerID returns the guild owner's ID, cached.
|
||||||
|
func (e *Engine) OwnerID(guildID string) (string, error) {
|
||||||
|
e.mu.Lock()
|
||||||
|
c, ok := e.owners[guildID]
|
||||||
|
e.mu.Unlock()
|
||||||
|
if ok && e.now().Sub(c.at) < ownerTTL {
|
||||||
|
return c.id, nil
|
||||||
|
}
|
||||||
|
g, err := e.d.Guild(guildID)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
e.mu.Lock()
|
||||||
|
e.owners[guildID] = cachedOwner{id: g.OwnerID, name: g.Name, at: e.now()}
|
||||||
|
e.mu.Unlock()
|
||||||
|
return g.OwnerID, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// guildName returns the guild's name (cached with the owner), or "".
|
||||||
|
func (e *Engine) guildName(guildID string) string {
|
||||||
|
if _, err := e.OwnerID(guildID); err != nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
e.mu.Lock()
|
||||||
|
defer e.mu.Unlock()
|
||||||
|
return e.owners[guildID].name
|
||||||
|
}
|
||||||
|
|
||||||
|
// trustedBy reports whether a user (with their role IDs) is on the list.
|
||||||
|
func trustedBy(list []securityrepo.Trusted, userID string, roles []string) bool {
|
||||||
|
uid := parseID(userID)
|
||||||
|
for _, t := range list {
|
||||||
|
switch t.Kind {
|
||||||
|
case "user":
|
||||||
|
if t.TargetID == uid {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
case "role":
|
||||||
|
for _, r := range roles {
|
||||||
|
if parseID(r) == t.TargetID {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsTrusted reports whether a user is exempt from anti-nuke and may change
|
||||||
|
// security settings: the owner, the bot itself, or someone on the trusted
|
||||||
|
// list (directly or by role). When roles is nil the member is looked up.
|
||||||
|
// Any lookup failure counts as not trusted.
|
||||||
|
func (e *Engine) IsTrusted(ctx context.Context, guildID, userID string, roles []string) bool {
|
||||||
|
if userID == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if userID == e.botID {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if owner, err := e.OwnerID(guildID); err == nil && owner == userID {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
_, trusted, err := e.load(ctx, guildID)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if roles == nil {
|
||||||
|
m, err := e.d.GuildMember(guildID, userID)
|
||||||
|
if err != nil {
|
||||||
|
return trustedBy(trusted, userID, nil)
|
||||||
|
}
|
||||||
|
roles = m.Roles
|
||||||
|
}
|
||||||
|
return trustedBy(trusted, userID, roles)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsOwner reports whether the user owns the guild. Lookup failures are "no".
|
||||||
|
func (e *Engine) IsOwner(guildID, userID string) bool {
|
||||||
|
owner, err := e.OwnerID(guildID)
|
||||||
|
return err == nil && owner != "" && owner == userID
|
||||||
|
}
|
||||||
|
|
||||||
|
// RequireTrusted returns ErrNotTrusted unless the actor is owner or trusted.
|
||||||
|
func (e *Engine) RequireTrusted(ctx context.Context, guildID string, actor *discordgo.Member) error {
|
||||||
|
if actor == nil || actor.User == nil || !e.IsTrusted(ctx, guildID, actor.User.ID, actor.Roles) {
|
||||||
|
return ErrNotTrusted
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *Engine) event(ctx context.Context, guildID string, kind string, actor, target string, detail string) {
|
||||||
|
_ = e.st.AddEvent(ctx, securityrepo.Event{
|
||||||
|
GuildID: parseID(guildID), Kind: kind, ActorID: parseID(actor), TargetID: parseID(target), Detail: clip(detail, 1000),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func clip(s string, n int) string {
|
||||||
|
if r := []rune(s); len(r) > n {
|
||||||
|
return string(r[:n-1]) + "…"
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// safeName renders a user-controlled name for an embed: markdown escaped and
|
||||||
|
// mentions defused (allowed mentions are restricted too, this is belt and
|
||||||
|
// braces).
|
||||||
|
func safeName(u *discordgo.User) string {
|
||||||
|
if u == nil {
|
||||||
|
return "unknown"
|
||||||
|
}
|
||||||
|
name := u.Username
|
||||||
|
if u.GlobalName != "" && u.GlobalName != u.Username {
|
||||||
|
name = u.GlobalName + " (" + u.Username + ")"
|
||||||
|
}
|
||||||
|
r := strings.NewReplacer(
|
||||||
|
`\`, `\\`, `*`, `\*`, `_`, `\_`, "`", "\\`", `~`, `\~`, `|`, `\|`, `>`, `\>`, `#`, `\#`,
|
||||||
|
`[`, `\[`, `]`, `\]`, `(`, `\(`, `)`, `\)`, `@`, "@", `<`, "<",
|
||||||
|
)
|
||||||
|
return clip(r.Replace(name), 80)
|
||||||
|
}
|
||||||
@@ -0,0 +1,594 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
|
|
||||||
|
"github.com/bwmarrin/discordgo"
|
||||||
|
)
|
||||||
|
|
||||||
|
var ctx = context.Background()
|
||||||
|
|
||||||
|
// testEngine is a guild (id 100) owned by user 1, with Velox as user 999,
|
||||||
|
// alerts going to channel 500 and pinging role 201.
|
||||||
|
func testEngine(t *testing.T) (*Engine, *fakeDiscord, *fakeStore, *time.Time) {
|
||||||
|
t.Helper()
|
||||||
|
d, st := newDiscord(), newStore()
|
||||||
|
e := New(d, st, "999")
|
||||||
|
e.syncDMs = true
|
||||||
|
now := time.Date(2026, 10, 20, 12, 0, 0, 0, time.UTC)
|
||||||
|
e.now = func() time.Time { return now }
|
||||||
|
s := st.set(100)
|
||||||
|
s.AlertChannelID, s.AlertRoleID = 500, 201
|
||||||
|
return e, d, st, &now
|
||||||
|
}
|
||||||
|
|
||||||
|
func refresh(e *Engine) { e.Invalidate(guild) }
|
||||||
|
|
||||||
|
// snowflake for an account created at t.
|
||||||
|
func snowflakeAt(t time.Time, n int) string {
|
||||||
|
ms := t.UnixMilli() - 1420070400000
|
||||||
|
return fmt.Sprint(ms<<22 | int64(n))
|
||||||
|
}
|
||||||
|
|
||||||
|
func entry(action discordgo.AuditLogAction, user, target string, changes ...*discordgo.AuditLogChange) *discordgo.AuditLogEntry {
|
||||||
|
return &discordgo.AuditLogEntry{ActionType: &action, UserID: user, TargetID: target, Changes: changes}
|
||||||
|
}
|
||||||
|
|
||||||
|
func change(key discordgo.AuditLogChangeKey, old, new any) *discordgo.AuditLogChange {
|
||||||
|
return &discordgo.AuditLogChange{Key: &key, OldValue: old, NewValue: new}
|
||||||
|
}
|
||||||
|
|
||||||
|
func contains(list []string, v string) bool {
|
||||||
|
for _, x := range list {
|
||||||
|
if x == v {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Join Gate ----
|
||||||
|
|
||||||
|
func TestCheckJoin(t *testing.T) {
|
||||||
|
now := time.Date(2026, 10, 20, 12, 0, 0, 0, time.UTC)
|
||||||
|
s := securityrepo.Defaults(1)
|
||||||
|
s.JoinGateEnabled = true
|
||||||
|
s.NoAvatar, s.NewAccount, s.AdvertisingName = securityrepo.ActionTimeout, securityrepo.ActionKick, securityrepo.ActionBan
|
||||||
|
s.UsernameFilter, s.UsernamePatterns = securityrepo.ActionKick, []string{" FreeNitro "}
|
||||||
|
s.UnverifiedBot = securityrepo.ActionKick
|
||||||
|
|
||||||
|
old := snowflakeAt(now.AddDate(-1, 0, 0), 1)
|
||||||
|
young := snowflakeAt(now.Add(-48*time.Hour), 2)
|
||||||
|
|
||||||
|
for _, c := range []struct {
|
||||||
|
name string
|
||||||
|
u *discordgo.User
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{"clean", &discordgo.User{ID: old, Username: "ana", Avatar: "x"}, "off"},
|
||||||
|
{"no avatar", &discordgo.User{ID: old, Username: "ana"}, "timeout"},
|
||||||
|
{"new account beats no avatar", &discordgo.User{ID: young, Username: "ana"}, "kick"},
|
||||||
|
{"invite in display name", &discordgo.User{ID: old, Username: "ana", GlobalName: "join DISCORD.GG/abc", Avatar: "x"}, "ban"},
|
||||||
|
{"blocked word, case-insensitive", &discordgo.User{ID: old, Username: "freenitro_giveaway", Avatar: "x"}, "kick"},
|
||||||
|
{"verified bot passes", &discordgo.User{ID: young, Bot: true, PublicFlags: discordgo.UserFlagVerifiedBot}, "off"},
|
||||||
|
{"unverified bot", &discordgo.User{ID: young, Bot: true}, "kick"},
|
||||||
|
} {
|
||||||
|
if got := CheckJoin(s, c.u, now).Action; got != c.want {
|
||||||
|
t.Errorf("%s: got %s, want %s", c.name, got, c.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
s.JoinGateEnabled = false
|
||||||
|
if CheckJoin(s, &discordgo.User{ID: young}, now).Action != "off" {
|
||||||
|
t.Error("a disabled Join Gate must not act")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestJoinGateAndJoinLock(t *testing.T) {
|
||||||
|
e, d, st, now := testEngine(t)
|
||||||
|
s := st.set(100)
|
||||||
|
s.JoinGateEnabled, s.NewAccount = true, securityrepo.ActionKick
|
||||||
|
refresh(e)
|
||||||
|
|
||||||
|
young := d.addMember(snowflakeAt(now.Add(-time.Hour), 5))
|
||||||
|
if removed := e.OnMemberJoin(ctx, guild, young); !removed || !contains(d.kicked, young.User.ID) {
|
||||||
|
t.Errorf("new account should be kicked: removed=%v kicked=%v", removed, d.kicked)
|
||||||
|
}
|
||||||
|
if d.sentCount() != 1 || !contains(st.eventKinds(), securityrepo.EventJoinGate) {
|
||||||
|
t.Error("the action should be alerted and recorded")
|
||||||
|
}
|
||||||
|
|
||||||
|
st.set(100).JoinLock = securityrepo.ActionBan
|
||||||
|
refresh(e)
|
||||||
|
m := d.addMember(snowflakeAt(now.AddDate(-2, 0, 0), 6))
|
||||||
|
if !e.OnMemberJoin(ctx, guild, m) || !contains(d.banned, m.User.ID) {
|
||||||
|
t.Error("a join lock bans everyone new")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestOwnerAndBotAreNeverPunished(t *testing.T) {
|
||||||
|
e, d, st, _ := testEngine(t)
|
||||||
|
st.set(100).JoinLock = securityrepo.ActionBan
|
||||||
|
refresh(e)
|
||||||
|
if e.OnMemberJoin(ctx, guild, d.members["1"]) || len(d.banned) != 0 {
|
||||||
|
t.Error("the owner must never be banned")
|
||||||
|
}
|
||||||
|
if err := e.Quarantine(ctx, guild, "1", "x"); err == nil {
|
||||||
|
t.Error("the owner must never be quarantined")
|
||||||
|
}
|
||||||
|
if err := e.Quarantine(ctx, guild, "999", "x"); err == nil {
|
||||||
|
t.Error("the bot must never quarantine itself")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Raids ----
|
||||||
|
|
||||||
|
func TestRaidModeStartsActsAndEnds(t *testing.T) {
|
||||||
|
e, d, st, now := testEngine(t)
|
||||||
|
s := st.set(100)
|
||||||
|
s.AntiRaidEnabled, s.RaidJoinCount, s.RaidJoinSeconds, s.RaidAction, s.RaidQuietMinutes = true, 3, 10, securityrepo.ActionKick, 5
|
||||||
|
refresh(e)
|
||||||
|
|
||||||
|
old := now.AddDate(-1, 0, 0)
|
||||||
|
join := func(n int) *discordgo.Member {
|
||||||
|
m := d.addMember(snowflakeAt(old, n))
|
||||||
|
e.OnMemberJoin(ctx, guild, m)
|
||||||
|
return m
|
||||||
|
}
|
||||||
|
a := join(1)
|
||||||
|
*now = now.Add(2 * time.Second)
|
||||||
|
join(2)
|
||||||
|
if len(d.kicked) != 0 || e.RaidActive(guild) {
|
||||||
|
t.Fatal("two joins are not a raid")
|
||||||
|
}
|
||||||
|
*now = now.Add(2 * time.Second)
|
||||||
|
join(3)
|
||||||
|
if !e.RaidActive(guild) || len(d.kicked) != 3 || !contains(d.kicked, a.User.ID) {
|
||||||
|
t.Fatalf("the third join starts a raid and the whole burst is kicked: %v", d.kicked)
|
||||||
|
}
|
||||||
|
if len(d.requests) != 1 || !strings.Contains(d.requests[0], "/incident-actions") || !strings.Contains(d.requests[0], "2026-10-21") {
|
||||||
|
t.Errorf("invites should be paused for 24h: %v", d.requests)
|
||||||
|
}
|
||||||
|
alert := d.channelSends()[0]
|
||||||
|
if alert.Content != "<@&201>" || strings.Join(alert.AllowedMentions.Roles, ",") != "201" || len(alert.AllowedMentions.Users) != 0 {
|
||||||
|
t.Errorf("a raid pings only the alert role: %+v", alert)
|
||||||
|
}
|
||||||
|
|
||||||
|
// During the raid every join is acted on.
|
||||||
|
*now = now.Add(time.Minute)
|
||||||
|
join(4)
|
||||||
|
if len(d.kicked) != 4 {
|
||||||
|
t.Errorf("joins during a raid are kicked: %v", d.kicked)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Quiet for 5 minutes: it ends, invites resume, the list is posted.
|
||||||
|
*now = now.Add(6 * time.Minute)
|
||||||
|
e.checkRaids(ctx)
|
||||||
|
if e.RaidActive(guild) {
|
||||||
|
t.Fatal("the raid should end after the quiet period")
|
||||||
|
}
|
||||||
|
if len(d.requests) != 2 || !strings.Contains(d.requests[1], "invites_disabled_until:<nil>") {
|
||||||
|
t.Errorf("invites should be resumed: %v", d.requests)
|
||||||
|
}
|
||||||
|
var list string
|
||||||
|
for name, content := range d.files {
|
||||||
|
if strings.HasPrefix(name, "raid-") {
|
||||||
|
list = content
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if strings.Count(list, "\tkick\t") != 4 {
|
||||||
|
t.Errorf("the summary should list the 4 kicked accounts:\n%s", list)
|
||||||
|
}
|
||||||
|
if err := e.EndRaid(ctx, guild, "1"); err == nil {
|
||||||
|
t.Error("ending twice should say there's no raid")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNoAlertFloodDuringARaid(t *testing.T) {
|
||||||
|
e, d, st, now := testEngine(t)
|
||||||
|
s := st.set(100)
|
||||||
|
s.JoinGateEnabled, s.NoAvatar = true, securityrepo.ActionKick
|
||||||
|
s.AntiRaidEnabled, s.RaidJoinCount, s.RaidAction, s.RaidPauseInvites = true, 3, securityrepo.ActionKick, false
|
||||||
|
refresh(e)
|
||||||
|
for i := 0; i < 50; i++ {
|
||||||
|
e.OnMemberJoin(ctx, guild, &discordgo.Member{User: &discordgo.User{ID: snowflakeAt(now.AddDate(-1, 0, 0), i)}}) // no avatar
|
||||||
|
}
|
||||||
|
if n := d.sentCount(); n > 4 {
|
||||||
|
t.Errorf("a raid of 50 should produce a handful of alerts, got %d", n)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRaidAlertOnlyTouchesNobody(t *testing.T) {
|
||||||
|
e, d, st, now := testEngine(t)
|
||||||
|
s := st.set(100)
|
||||||
|
s.AntiRaidEnabled, s.RaidJoinCount, s.RaidAction, s.RaidPauseInvites = true, 3, securityrepo.ActionAlert, false
|
||||||
|
refresh(e)
|
||||||
|
for i := 0; i < 5; i++ {
|
||||||
|
e.OnMemberJoin(ctx, guild, d.addMember(snowflakeAt(now.AddDate(-1, 0, 0), i)))
|
||||||
|
}
|
||||||
|
if !e.RaidActive(guild) || len(d.kicked)+len(d.banned) != 0 || len(d.requests) != 0 {
|
||||||
|
t.Error("alert-only raid mode must not remove anyone or pause invites")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRaidMemoryIsBounded(t *testing.T) {
|
||||||
|
e, d, st, now := testEngine(t)
|
||||||
|
s := st.set(100)
|
||||||
|
s.AntiRaidEnabled, s.RaidJoinCount, s.RaidAction = true, 3, securityrepo.ActionAlert
|
||||||
|
refresh(e)
|
||||||
|
for i := 0; i < maxRecentJoins+300; i++ {
|
||||||
|
e.OnMemberJoin(ctx, guild, &discordgo.Member{User: &discordgo.User{ID: snowflakeAt(now.AddDate(-1, 0, 0), i), Avatar: "a"}})
|
||||||
|
}
|
||||||
|
r := e.raidFor(guild)
|
||||||
|
if len(r.joins) > maxRecentJoins {
|
||||||
|
t.Errorf("recent joins not capped: %d", len(r.joins))
|
||||||
|
}
|
||||||
|
_ = d
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Anti-nuke ----
|
||||||
|
|
||||||
|
func nukeEngine(t *testing.T) (*Engine, *fakeDiscord, *fakeStore) {
|
||||||
|
e, d, st, _ := testEngine(t)
|
||||||
|
st.set(100).AntiNukeEnabled = true
|
||||||
|
refresh(e)
|
||||||
|
d.addMember("50", "200", "202", "204") // a rogue admin with a booster role
|
||||||
|
return e, d, st
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNukeOverTheLimitIsQuarantined(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
// Limit is 2 channel deletes per 10s.
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionChannelDelete, "50", "c1"))
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionChannelDelete, "50", "c2"))
|
||||||
|
if _, ok := st.quarantines[key(100, 50)]; ok {
|
||||||
|
t.Fatal("two deletes are within the limit")
|
||||||
|
}
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionChannelDelete, "50", "c3"))
|
||||||
|
|
||||||
|
q, ok := st.quarantines[key(100, 50)]
|
||||||
|
if !ok || fmt.Sprint(q.PreviousRoleIDs) != "[200 202]" {
|
||||||
|
t.Fatalf("roles should be saved (not the managed one): %+v", q)
|
||||||
|
}
|
||||||
|
if got := strings.Join(d.members["50"].Roles, ","); got != "204" {
|
||||||
|
t.Errorf("only the unremovable booster role should remain, got %s", got)
|
||||||
|
}
|
||||||
|
if d.timeouts["50"] == nil {
|
||||||
|
t.Error("the nuker should be timed out")
|
||||||
|
}
|
||||||
|
sends := d.channelSends()
|
||||||
|
last := sends[len(sends)-1]
|
||||||
|
if !strings.Contains(last.Embeds[0].Title, "Nuke attempt stopped") || !contains(last.AllowedMentions.Users, "1") {
|
||||||
|
t.Errorf("the owner should be pinged: %+v", last)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The next delete within a minute doesn't trigger a second response.
|
||||||
|
before := len(d.sent)
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionChannelDelete, "50", "c4"))
|
||||||
|
if len(d.sent) != before {
|
||||||
|
t.Error("one attempt should be answered once")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTrustedOwnerAndBotAreExempt(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
d.addMember("60", "201")
|
||||||
|
st.trusted[100] = []securityrepo.Trusted{{TargetID: 50, Kind: "user"}, {TargetID: 201, Kind: "role"}}
|
||||||
|
refresh(e)
|
||||||
|
for _, who := range []string{"50", "60", "1", "999"} {
|
||||||
|
for i := 0; i < 5; i++ {
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberBanAdd, who, "x"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(st.quarantines) != 0 {
|
||||||
|
t.Errorf("trusted users, trusted roles, the owner and the bot are exempt: %v", st.quarantines)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInstantTriggers(t *testing.T) {
|
||||||
|
for name, ent := range map[string]*discordgo.AuditLogEntry{
|
||||||
|
"prune": entry(discordgo.AuditLogActionMemberPrune, "50", ""),
|
||||||
|
"vanity": entry(discordgo.AuditLogActionGuildUpdate, "50", guild, change("vanity_url_code", "old", "scam")),
|
||||||
|
"perms": entry(discordgo.AuditLogActionRoleUpdate, "50", "202", change("permissions", "0", fmt.Sprint(discordgo.PermissionAdministrator))),
|
||||||
|
"grant": entry(discordgo.AuditLogActionMemberRoleUpdate, "50", "70", change("$add", nil, []any{map[string]any{"id": "200"}})),
|
||||||
|
"newrole": entry(discordgo.AuditLogActionRoleCreate, "50", "x", change("permissions", nil, fmt.Sprint(discordgo.PermissionManageRoles))),
|
||||||
|
"botrole": entry(discordgo.AuditLogActionRoleUpdate, "50", "299", change("name", "Velox", "x")),
|
||||||
|
} {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
d.addMember("70")
|
||||||
|
e.OnAuditLogEntry(ctx, guild, ent)
|
||||||
|
if _, ok := st.quarantines[key(100, 50)]; !ok {
|
||||||
|
t.Errorf("%s should quarantine at once", name)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHarmlessChangesAreIgnored(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
d.addMember("70")
|
||||||
|
// Renaming a role, removing permissions, giving a plain role.
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionRoleUpdate, "50", "202", change("permissions", fmt.Sprint(discordgo.PermissionAdministrator), "0")))
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberRoleUpdate, "50", "70", change("$add", nil, []any{map[string]any{"id": "202"}})))
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionChannelUpdate, "50", "c"))
|
||||||
|
if len(st.quarantines) != 0 {
|
||||||
|
t.Error("harmless changes must not trigger anything")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHarmlessEntriesCostNoLookups(t *testing.T) {
|
||||||
|
e, d, _ := nukeEngine(t)
|
||||||
|
d.lookups = 0
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMessageDelete, "50", "x"))
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberUpdate, "50", "x"))
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberRoleUpdate, "50", "70", change("$remove", nil, []any{map[string]any{"id": "202"}})))
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionGuildUpdate, "50", guild, change("name", "a", "b")))
|
||||||
|
if d.lookups != 0 {
|
||||||
|
t.Errorf("harmless entries made %d Discord lookups", d.lookups)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSelfGrantedTrustedRoleIsNotABypass(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
st.trusted[100] = []securityrepo.Trusted{{TargetID: 201, Kind: "role"}}
|
||||||
|
refresh(e)
|
||||||
|
// The rogue admin gives themselves the trusted role...
|
||||||
|
d.members["50"].Roles = append(d.members["50"].Roles, "201")
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberRoleUpdate, "50", "50", change("$add", nil, []any{map[string]any{"id": "201"}})))
|
||||||
|
if _, ok := st.quarantines[key(100, 50)]; !ok {
|
||||||
|
t.Fatal("granting yourself a trusted role must be stopped, not count as trust")
|
||||||
|
}
|
||||||
|
if contains(d.members["50"].Roles, "201") {
|
||||||
|
t.Error("the trusted role should be gone")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTrustedRoleGrantedToAnAltIsTakenBack(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
st.trusted[100] = []securityrepo.Trusted{{TargetID: 201, Kind: "role"}}
|
||||||
|
refresh(e)
|
||||||
|
d.addMember("71", "201")
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberRoleUpdate, "50", "71", change("$add", nil, []any{map[string]any{"id": "201"}})))
|
||||||
|
if _, ok := st.quarantines[key(100, 50)]; !ok {
|
||||||
|
t.Error("the granter should be quarantined")
|
||||||
|
}
|
||||||
|
if contains(d.members["71"].Roles, "201") {
|
||||||
|
t.Error("the alt should lose the trusted role")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNukingBotIsKicked(t *testing.T) {
|
||||||
|
e, d, _ := nukeEngine(t)
|
||||||
|
d.members["80"] = &discordgo.Member{User: &discordgo.User{ID: "80", Bot: true}}
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberPrune, "80", ""))
|
||||||
|
if !contains(d.kicked, "80") {
|
||||||
|
t.Error("a nuking bot should be kicked")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAntiNukeOffDoesNothing(t *testing.T) {
|
||||||
|
e, _, st := nukeEngine(t)
|
||||||
|
st.set(100).AntiNukeEnabled = false
|
||||||
|
refresh(e)
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberPrune, "50", ""))
|
||||||
|
if len(st.quarantines) != 0 {
|
||||||
|
t.Error("anti-nuke off must not act")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnauthorizedBotAdd(t *testing.T) {
|
||||||
|
e, d, st, _ := testEngine(t)
|
||||||
|
st.set(100).JoinGateEnabled = true
|
||||||
|
refresh(e)
|
||||||
|
d.addMember("50", "200")
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionBotAdd, "50", "81"))
|
||||||
|
if !contains(d.kicked, "81") {
|
||||||
|
t.Error("a bot added by someone untrusted should be kicked")
|
||||||
|
}
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionBotAdd, "1", "82"))
|
||||||
|
if contains(d.kicked, "82") {
|
||||||
|
t.Error("the owner may add bots")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDangerousQuarantineRoleIsNotAssigned(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
st.set(100).QuarantineRoleID = 200 // misconfigured: the Admin role
|
||||||
|
refresh(e)
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberPrune, "50", ""))
|
||||||
|
if contains(d.members["50"].Roles, "200") {
|
||||||
|
t.Error("a quarantine role with dangerous permissions must never be assigned")
|
||||||
|
}
|
||||||
|
|
||||||
|
st.set(100).QuarantineRoleID = 203
|
||||||
|
refresh(e)
|
||||||
|
d.addMember("51", "201")
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberPrune, "51", ""))
|
||||||
|
if !contains(d.members["51"].Roles, "203") {
|
||||||
|
t.Error("a safe quarantine role should be assigned")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestQuarantineRoleVeloxCantAssignDoesNotBlockQuarantine(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
st.set(100).QuarantineRoleID = 203
|
||||||
|
refresh(e)
|
||||||
|
d.rejectRole = "203" // e.g. moved above Velox's role after it was configured
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberPrune, "50", ""))
|
||||||
|
if got := strings.Join(d.members["50"].Roles, ","); got != "204" {
|
||||||
|
t.Errorf("roles must still be removed without the quarantine role, got %s", got)
|
||||||
|
}
|
||||||
|
if d.timeouts["50"] == nil {
|
||||||
|
t.Error("and the member still timed out")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReleaseGivesRolesBack(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
st.set(100).QuarantineRoleID = 203
|
||||||
|
refresh(e)
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberPrune, "50", ""))
|
||||||
|
|
||||||
|
// The Mod role was deleted meanwhile... no wait, Member (202) was.
|
||||||
|
d.roles = append(d.roles[:3], d.roles[4:]...)
|
||||||
|
if err := e.Release(ctx, guild, "50", "1"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got := strings.Join(d.members["50"].Roles, ",")
|
||||||
|
if got != "204,200" {
|
||||||
|
t.Errorf("roles after release = %s (want the booster role kept, Admin back, deleted Member skipped, quarantine role gone)", got)
|
||||||
|
}
|
||||||
|
if d.timeouts["50"] != nil {
|
||||||
|
t.Error("the timeout should be removed")
|
||||||
|
}
|
||||||
|
if _, ok := st.quarantines[key(100, 50)]; ok {
|
||||||
|
t.Error("the quarantine record should be gone")
|
||||||
|
}
|
||||||
|
if err := e.Release(ctx, guild, "50", "1"); err == nil {
|
||||||
|
t.Error("releasing twice should fail")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Lockdown ----
|
||||||
|
|
||||||
|
func TestLockAndUnlockRestoreExactly(t *testing.T) {
|
||||||
|
e, d, _, _ := testEngine(t)
|
||||||
|
d.channels["300"] = &discordgo.Channel{ID: "300", GuildID: guild, Type: discordgo.ChannelTypeGuildText,
|
||||||
|
PermissionOverwrites: []*discordgo.PermissionOverwrite{{ID: guild, Type: discordgo.PermissionOverwriteTypeRole,
|
||||||
|
Allow: discordgo.PermissionAddReactions, Deny: discordgo.PermissionAttachFiles}}}
|
||||||
|
d.channels["301"] = &discordgo.Channel{ID: "301", GuildID: guild, Type: discordgo.ChannelTypeGuildText}
|
||||||
|
d.channels["302"] = &discordgo.Channel{ID: "302", GuildID: guild, Type: discordgo.ChannelTypeGuildCategory}
|
||||||
|
d.channels["400"] = &discordgo.Channel{ID: "400", GuildID: "other", Type: discordgo.ChannelTypeGuildText}
|
||||||
|
|
||||||
|
if err := e.LockChannel(ctx, guild, "400", "1", false); err == nil {
|
||||||
|
t.Fatal("a channel of another server must never be touched")
|
||||||
|
}
|
||||||
|
|
||||||
|
locked, failed, err := e.LockServer(ctx, guild, "1")
|
||||||
|
if err != nil || locked != 2 || failed != 0 {
|
||||||
|
t.Fatalf("locked=%d failed=%d err=%v (categories are skipped)", locked, failed, err)
|
||||||
|
}
|
||||||
|
o := d.channels["300"].PermissionOverwrites[0]
|
||||||
|
if o.Deny&discordgo.PermissionSendMessages == 0 || o.Allow&discordgo.PermissionAddReactions != 0 || o.Deny&discordgo.PermissionAttachFiles == 0 {
|
||||||
|
t.Errorf("lock should deny chat and keep other bits: %+v", o)
|
||||||
|
}
|
||||||
|
// Someone changes an unrelated bit during the lockdown; it must survive.
|
||||||
|
o.Allow |= discordgo.PermissionEmbedLinks
|
||||||
|
// Locking again must not overwrite the saved "before" state.
|
||||||
|
_ = e.LockChannel(ctx, guild, "300", "1", false)
|
||||||
|
|
||||||
|
if _, _, err := e.UnlockServer(ctx, guild, "1"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
o = d.channels["300"].PermissionOverwrites[0]
|
||||||
|
if o.Allow != discordgo.PermissionAddReactions|discordgo.PermissionEmbedLinks || o.Deny != discordgo.PermissionAttachFiles {
|
||||||
|
t.Errorf("unlock should restore the original lock bits and keep the new one: allow=%d deny=%d", o.Allow, o.Deny)
|
||||||
|
}
|
||||||
|
if len(d.channels["301"].PermissionOverwrites) != 0 {
|
||||||
|
t.Error("a channel that had no overwrite should have none again")
|
||||||
|
}
|
||||||
|
if _, _, err := e.UnlockServer(ctx, guild, "1"); err == nil {
|
||||||
|
t.Error("unlocking an unlocked server should say so")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Configuration rules ----
|
||||||
|
|
||||||
|
func TestConfigurationPermissions(t *testing.T) {
|
||||||
|
e, d, st, _ := testEngine(t)
|
||||||
|
admin := d.addMember("50", "200")
|
||||||
|
owner := d.members["1"]
|
||||||
|
trustedUser := d.addMember("60")
|
||||||
|
st.trusted[100] = []securityrepo.Trusted{{TargetID: 60, Kind: "user"}}
|
||||||
|
refresh(e)
|
||||||
|
|
||||||
|
// Turning on: Manage Server is enough. Turning off: owner or trusted only.
|
||||||
|
if err := e.SetFeature(ctx, guild, admin, discordgo.PermissionManageGuild, securityrepo.FeatureAntiNuke, true); err != nil {
|
||||||
|
t.Errorf("an admin may turn anti-nuke on: %v", err)
|
||||||
|
}
|
||||||
|
if err := e.SetFeature(ctx, guild, admin, discordgo.PermissionAdministrator, securityrepo.FeatureAntiNuke, false); !errors.Is(err, ErrNotTrusted) {
|
||||||
|
t.Errorf("an untrusted admin must not turn anti-nuke off: %v", err)
|
||||||
|
}
|
||||||
|
if err := e.SetFeature(ctx, guild, trustedUser, 0, securityrepo.FeatureAntiNuke, false); err != nil {
|
||||||
|
t.Errorf("a trusted user may: %v", err)
|
||||||
|
}
|
||||||
|
if err := e.SetFeature(ctx, guild, d.addMember("61"), 0, securityrepo.FeatureJoinGate, true); err == nil {
|
||||||
|
t.Error("a regular member must not turn things on")
|
||||||
|
}
|
||||||
|
if err := e.SetFeature(ctx, guild, nil, discordgo.PermissionAdministrator, securityrepo.FeatureJoinGate, true); err == nil {
|
||||||
|
t.Error("no actor, no change")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Alerts: trusted only, never @everyone, only this server's channels.
|
||||||
|
d.channels["500"] = &discordgo.Channel{ID: "500", GuildID: guild, Type: discordgo.ChannelTypeGuildText}
|
||||||
|
d.channels["501"] = &discordgo.Channel{ID: "501", GuildID: "other", Type: discordgo.ChannelTypeGuildText}
|
||||||
|
if err := e.SetAlerts(ctx, guild, admin, "500", "201"); !errors.Is(err, ErrNotTrusted) {
|
||||||
|
t.Errorf("untrusted alert change: %v", err)
|
||||||
|
}
|
||||||
|
if err := e.SetAlerts(ctx, guild, owner, "500", guild); err == nil {
|
||||||
|
t.Error("alerts must never ping @everyone")
|
||||||
|
}
|
||||||
|
if err := e.SetAlerts(ctx, guild, owner, "501", ""); err == nil {
|
||||||
|
t.Error("another server's channel must be refused")
|
||||||
|
}
|
||||||
|
if err := e.SetAlerts(ctx, guild, owner, "500", "201"); err != nil {
|
||||||
|
t.Error(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Quarantine role: safe roles below Velox only.
|
||||||
|
for role, ok := range map[string]bool{"200": false, guild: false, "204": false, "299": false, "203": true} {
|
||||||
|
err := e.SetQuarantineRole(ctx, guild, owner, role)
|
||||||
|
if (err == nil) != ok {
|
||||||
|
t.Errorf("quarantine role %s: err=%v", role, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Trust: owner only, never @everyone, bounded.
|
||||||
|
if err := e.Trust(ctx, guild, trustedUser, "user", "50"); !errors.Is(err, ErrNotOwner) {
|
||||||
|
t.Errorf("trusted users must not spread trust: %v", err)
|
||||||
|
}
|
||||||
|
if err := e.Trust(ctx, guild, owner, "role", guild); err == nil {
|
||||||
|
t.Error("trusting @everyone must be refused")
|
||||||
|
}
|
||||||
|
if err := e.Trust(ctx, guild, owner, "user", "404"); err == nil {
|
||||||
|
t.Error("trusting someone not in the server must be refused")
|
||||||
|
}
|
||||||
|
if err := e.Trust(ctx, guild, owner, "role", "201"); err != nil {
|
||||||
|
t.Error(err)
|
||||||
|
}
|
||||||
|
if err := e.Untrust(ctx, guild, admin, "201"); !errors.Is(err, ErrNotOwner) {
|
||||||
|
t.Errorf("only the owner untrusts: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDashboardCommands(t *testing.T) {
|
||||||
|
e, d, st := nukeEngine(t)
|
||||||
|
e.OnAuditLogEntry(ctx, guild, entry(discordgo.AuditLogActionMemberPrune, "50", ""))
|
||||||
|
st.cmds = []securityrepo.Command{
|
||||||
|
{ID: 1, GuildID: 100, CommandType: "release_quarantine", Payload: []byte(`{"user_id":"50; DROP"}`), RequestedBy: 1},
|
||||||
|
{ID: 2, GuildID: 100, CommandType: "release_quarantine", Payload: []byte(`{"user_id":"50"}`), RequestedBy: 1},
|
||||||
|
{ID: 3, GuildID: 100, CommandType: "nope", RequestedBy: 1},
|
||||||
|
}
|
||||||
|
e.ProcessCommands(ctx)
|
||||||
|
if _, ok := st.quarantines[key(100, 50)]; ok {
|
||||||
|
t.Error("the valid release should have run")
|
||||||
|
}
|
||||||
|
if len(st.done) != 3 {
|
||||||
|
t.Errorf("every command must be marked done: %v", st.done)
|
||||||
|
}
|
||||||
|
_ = d
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSafeNameDefusesMentionsAndMarkdown(t *testing.T) {
|
||||||
|
got := safeName(&discordgo.User{Username: "x", GlobalName: "@everyone **hi** <@&1> [link](http://a)"})
|
||||||
|
if strings.Contains(got, "@everyone") || strings.Contains(got, "<@&") || strings.Contains(got, "**") || strings.Contains(got, "](") {
|
||||||
|
t.Errorf("unsafe name rendering: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
package security
|
||||||
|
|
||||||
|
import "github.com/bwmarrin/discordgo"
|
||||||
|
|
||||||
|
// The real session must provide everything the system calls.
|
||||||
|
var _ Discord = (*discordgo.Session)(nil)
|
||||||
@@ -182,7 +182,7 @@ func postLog(ctx context.Context, d Discord, st Store, t *ticketrepo.Ticket, tra
|
|||||||
embed := &discordgo.MessageEmbed{
|
embed := &discordgo.MessageEmbed{
|
||||||
Title: fmt.Sprintf("Ticket #%04d closed · %s", t.Number, clip(t.CategoryName, 60)),
|
Title: fmt.Sprintf("Ticket #%04d closed · %s", t.Number, clip(t.CategoryName, 60)),
|
||||||
Description: "**" + clip(t.Subject, maxSubject) + "**",
|
Description: "**" + clip(t.Subject, maxSubject) + "**",
|
||||||
Color: 0x6b7280,
|
Color: accent,
|
||||||
Fields: []*discordgo.MessageEmbedField{
|
Fields: []*discordgo.MessageEmbedField{
|
||||||
{Name: "Opened by", Value: "<@" + id(t.OpenerID) + ">", Inline: true},
|
{Name: "Opened by", Value: "<@" + id(t.OpenerID) + ">", Inline: true},
|
||||||
{Name: "Claimed by", Value: claimed, Inline: true},
|
{Name: "Claimed by", Value: claimed, Inline: true},
|
||||||
|
|||||||
@@ -86,7 +86,6 @@ func IntroEmbed(t *ticketrepo.Ticket, details string) *discordgo.MessageEmbed {
|
|||||||
Footer: &discordgo.MessageEmbedFooter{Text: "Staff can claim this ticket. Anyone here can close it once it's sorted."},
|
Footer: &discordgo.MessageEmbedFooter{Text: "Staff can claim this ticket. Anyone here can close it once it's sorted."},
|
||||||
}
|
}
|
||||||
if t.Status == ticketrepo.StatusClosed {
|
if t.Status == ticketrepo.StatusClosed {
|
||||||
e.Color = 0x6b7280
|
|
||||||
e.Footer.Text = "This ticket is closed."
|
e.Footer.Text = "This ticket is closed."
|
||||||
}
|
}
|
||||||
return e
|
return e
|
||||||
|
|||||||
+16
-27
@@ -15,8 +15,9 @@ import (
|
|||||||
// Custom IDs. Everything starts with "tickets:" so the interaction router can
|
// Custom IDs. Everything starts with "tickets:" so the interaction router can
|
||||||
// hand it to this package.
|
// hand it to this package.
|
||||||
const (
|
const (
|
||||||
idOpenPrefix = "tickets:open:" // panel button, + category ID
|
idOpenPrefix = "tickets:open:" // older panels: one button per category, + category ID
|
||||||
idSelect = "tickets:select" // panel dropdown (many categories)
|
idSelect = "tickets:select" // panel dropdown
|
||||||
|
idCreate = "tickets:create" // panel "Create ticket" button
|
||||||
idOpenFormPrefix = "tickets:openform:" // opening form, + category ID
|
idOpenFormPrefix = "tickets:openform:" // opening form, + category ID
|
||||||
idClaim = "tickets:claim"
|
idClaim = "tickets:claim"
|
||||||
idClose = "tickets:close"
|
idClose = "tickets:close"
|
||||||
@@ -42,8 +43,8 @@ func parseEmoji(s string) *discordgo.ComponentEmoji {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// BuildPanel is the message members open tickets from: an embed with the
|
// BuildPanel is the message members open tickets from: an embed with the
|
||||||
// guild's text and one button per category, or a dropdown once there are
|
// guild's text and each category's description, a dropdown to pick the
|
||||||
// more categories than fit comfortably in a row.
|
// category, and a Create ticket button that opens the form for that pick.
|
||||||
func BuildPanel(s *ticketrepo.Settings, cats []ticketrepo.Category) (*discordgo.MessageEmbed, []discordgo.MessageComponent) {
|
func BuildPanel(s *ticketrepo.Settings, cats []ticketrepo.Category) (*discordgo.MessageEmbed, []discordgo.MessageComponent) {
|
||||||
embed := &discordgo.MessageEmbed{
|
embed := &discordgo.MessageEmbed{
|
||||||
Title: clip(s.PanelTitle, 256),
|
Title: clip(s.PanelTitle, 256),
|
||||||
@@ -54,27 +55,7 @@ func BuildPanel(s *ticketrepo.Settings, cats []ticketrepo.Category) (*discordgo.
|
|||||||
cats = cats[:maxCategories]
|
cats = cats[:maxCategories]
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(cats) <= maxPanelButtons {
|
opts := make([]discordgo.SelectMenuOption, 0, len(cats))
|
||||||
var buttons []discordgo.MessageComponent
|
|
||||||
for _, c := range cats {
|
|
||||||
buttons = append(buttons, discordgo.Button{
|
|
||||||
Label: clip(c.Name, 80),
|
|
||||||
Style: discordgo.PrimaryButton,
|
|
||||||
CustomID: idOpenPrefix + id(c.ID),
|
|
||||||
Emoji: parseEmoji(c.Emoji),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
// With few categories their descriptions go in the embed, since a
|
|
||||||
// button has no room for one.
|
|
||||||
for _, c := range cats {
|
|
||||||
if c.Description != "" {
|
|
||||||
embed.Fields = append(embed.Fields, &discordgo.MessageEmbedField{Name: clip(c.Name, 256), Value: clip(c.Description, 1024)})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return embed, []discordgo.MessageComponent{discordgo.ActionsRow{Components: buttons}}
|
|
||||||
}
|
|
||||||
|
|
||||||
var opts []discordgo.SelectMenuOption
|
|
||||||
for _, c := range cats {
|
for _, c := range cats {
|
||||||
opts = append(opts, discordgo.SelectMenuOption{
|
opts = append(opts, discordgo.SelectMenuOption{
|
||||||
Label: clip(c.Name, 100),
|
Label: clip(c.Name, 100),
|
||||||
@@ -82,10 +63,18 @@ func BuildPanel(s *ticketrepo.Settings, cats []ticketrepo.Category) (*discordgo.
|
|||||||
Description: clip(c.Description, 100),
|
Description: clip(c.Description, 100),
|
||||||
Emoji: parseEmoji(c.Emoji),
|
Emoji: parseEmoji(c.Emoji),
|
||||||
})
|
})
|
||||||
|
if c.Description != "" {
|
||||||
|
embed.Fields = append(embed.Fields, &discordgo.MessageEmbedField{Name: clip(c.Name, 256), Value: clip(c.Description, 1024)})
|
||||||
}
|
}
|
||||||
return embed, []discordgo.MessageComponent{discordgo.ActionsRow{Components: []discordgo.MessageComponent{
|
}
|
||||||
|
return embed, []discordgo.MessageComponent{
|
||||||
|
discordgo.ActionsRow{Components: []discordgo.MessageComponent{
|
||||||
discordgo.SelectMenu{CustomID: idSelect, Placeholder: "Choose what you need help with", Options: opts},
|
discordgo.SelectMenu{CustomID: idSelect, Placeholder: "Choose what you need help with", Options: opts},
|
||||||
}}}
|
}},
|
||||||
|
discordgo.ActionsRow{Components: []discordgo.MessageComponent{
|
||||||
|
discordgo.Button{Label: "Create ticket", Style: discordgo.PrimaryButton, CustomID: idCreate, Emoji: &discordgo.ComponentEmoji{Name: "🎫"}},
|
||||||
|
}},
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// PostPanel posts the panel in the ticket channel, or updates the one it
|
// PostPanel posts the panel in the ticket channel, or updates the one it
|
||||||
|
|||||||
@@ -0,0 +1,59 @@
|
|||||||
|
package tickets
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Discord doesn't send a dropdown's value along with a button click, so the
|
||||||
|
// panel's category pick is remembered here between the two interactions:
|
||||||
|
// per guild and member, for a short while, in memory. A bot restart forgets
|
||||||
|
// it, which only means picking the category again.
|
||||||
|
const (
|
||||||
|
pickTTL = 15 * time.Minute
|
||||||
|
maxPicks = 10000 // a ceiling, so a flood of picks can't grow this forever
|
||||||
|
)
|
||||||
|
|
||||||
|
type pickKey struct{ guild, user int64 }
|
||||||
|
|
||||||
|
type pick struct {
|
||||||
|
category int64
|
||||||
|
at time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
picksMu sync.Mutex
|
||||||
|
picks = map[pickKey]pick{}
|
||||||
|
now = time.Now
|
||||||
|
)
|
||||||
|
|
||||||
|
// RememberPick records the category a member chose in the panel dropdown.
|
||||||
|
func RememberPick(guildID, userID, categoryID int64) {
|
||||||
|
picksMu.Lock()
|
||||||
|
defer picksMu.Unlock()
|
||||||
|
t := now()
|
||||||
|
k := pickKey{guildID, userID}
|
||||||
|
if _, ok := picks[k]; !ok && len(picks) >= maxPicks {
|
||||||
|
for k, p := range picks {
|
||||||
|
if t.Sub(p.at) > pickTTL {
|
||||||
|
delete(picks, k)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(picks) >= maxPicks {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
picks[k] = pick{categoryID, t}
|
||||||
|
}
|
||||||
|
|
||||||
|
// PickedCategory returns the category a member chose, if they did recently.
|
||||||
|
func PickedCategory(guildID, userID int64) (int64, bool) {
|
||||||
|
picksMu.Lock()
|
||||||
|
defer picksMu.Unlock()
|
||||||
|
p, ok := picks[pickKey{guildID, userID}]
|
||||||
|
if !ok || now().Sub(p.at) > pickTTL {
|
||||||
|
delete(picks, pickKey{guildID, userID})
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
return p.category, true
|
||||||
|
}
|
||||||
@@ -1,7 +1,8 @@
|
|||||||
// Package tickets is the support ticket system: a panel message with one
|
// Package tickets is the support ticket system: a panel message with a
|
||||||
// button per category, a short form, and a private thread per ticket that
|
// category dropdown and a Create ticket button, a short form, and a private
|
||||||
// staff can claim and anyone involved can close. Closing locks and archives
|
// thread per ticket that staff can claim and anyone involved can close.
|
||||||
// the thread and posts a transcript to the log channel.
|
// Closing locks and archives the thread and posts a transcript to the log
|
||||||
|
// channel.
|
||||||
//
|
//
|
||||||
// The Discord and database calls go through small interfaces so the flows
|
// The Discord and database calls go through small interfaces so the flows
|
||||||
// can be tested without either; the slash command and button handlers in
|
// can be tested without either; the slash command and button handlers in
|
||||||
@@ -67,7 +68,9 @@ const (
|
|||||||
|
|
||||||
var (
|
var (
|
||||||
defaultStore Store
|
defaultStore Store
|
||||||
accent = 0x2b7bfa
|
// Every ticket embed (panel, ticket, log) is orange, so support stands
|
||||||
|
// apart from the bot's other messages.
|
||||||
|
accent = 0xf97316
|
||||||
)
|
)
|
||||||
|
|
||||||
func Init(s Store) { defaultStore = s }
|
func Init(s Store) { defaultStore = s }
|
||||||
@@ -80,7 +83,6 @@ const (
|
|||||||
maxSubject = 100
|
maxSubject = 100
|
||||||
maxDetails = 1000
|
maxDetails = 1000
|
||||||
maxReason = 300
|
maxReason = 300
|
||||||
maxPanelButtons = 5 // more categories than this switch the panel to a dropdown
|
|
||||||
maxCategories = 25
|
maxCategories = 25
|
||||||
autoArchiveWeek = 10080
|
autoArchiveWeek = 10080
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -74,26 +74,77 @@ func TestBuildPanel(t *testing.T) {
|
|||||||
{ID: 2, Name: "Appeal", Emoji: "<a:party:123>"},
|
{ID: 2, Name: "Appeal", Emoji: "<a:party:123>"},
|
||||||
}
|
}
|
||||||
embed, comps := BuildPanel(s, cats)
|
embed, comps := BuildPanel(s, cats)
|
||||||
row := comps[0].(discordgo.ActionsRow)
|
if embed.Title != "Help" || embed.Color != 0xf97316 {
|
||||||
b1, b2 := row.Components[0].(discordgo.Button), row.Components[1].(discordgo.Button)
|
t.Errorf("panel embed wrong: %+v", embed)
|
||||||
if embed.Title != "Help" || b1.CustomID != "tickets:open:1" || b1.Emoji.Name != "🛟" {
|
|
||||||
t.Errorf("first button wrong: %+v", b1)
|
|
||||||
}
|
}
|
||||||
if b2.Emoji.ID != "123" || b2.Emoji.Name != "party" || !b2.Emoji.Animated {
|
if len(comps) != 2 {
|
||||||
t.Errorf("custom emoji not parsed: %+v", b2.Emoji)
|
t.Fatalf("want a dropdown row and a button row, got %d rows", len(comps))
|
||||||
|
}
|
||||||
|
menu := comps[0].(discordgo.ActionsRow).Components[0].(discordgo.SelectMenu)
|
||||||
|
if menu.CustomID != "tickets:select" || len(menu.Options) != 2 || menu.Options[0].Value != "1" || menu.Options[0].Emoji.Name != "🛟" {
|
||||||
|
t.Errorf("dropdown wrong: %+v", menu)
|
||||||
|
}
|
||||||
|
if e := menu.Options[1].Emoji; e.ID != "123" || e.Name != "party" || !e.Animated {
|
||||||
|
t.Errorf("custom emoji not parsed: %+v", e)
|
||||||
|
}
|
||||||
|
button := comps[1].(discordgo.ActionsRow).Components[0].(discordgo.Button)
|
||||||
|
if button.CustomID != "tickets:create" || button.Label != "Create ticket" {
|
||||||
|
t.Errorf("create button wrong: %+v", button)
|
||||||
}
|
}
|
||||||
if len(embed.Fields) != 1 || embed.Fields[0].Value != "General help" {
|
if len(embed.Fields) != 1 || embed.Fields[0].Value != "General help" {
|
||||||
t.Errorf("descriptions belong in the embed: %+v", embed.Fields)
|
t.Errorf("descriptions belong in the embed: %+v", embed.Fields)
|
||||||
}
|
}
|
||||||
|
|
||||||
var many []ticketrepo.Category
|
var many []ticketrepo.Category
|
||||||
for i := 1; i <= 7; i++ {
|
for i := 1; i <= 30; i++ {
|
||||||
many = append(many, ticketrepo.Category{ID: int64(i), Name: fmt.Sprint("Cat ", i)})
|
many = append(many, ticketrepo.Category{ID: int64(i), Name: fmt.Sprint("Cat ", i)})
|
||||||
}
|
}
|
||||||
_, comps = BuildPanel(s, many)
|
_, comps = BuildPanel(s, many)
|
||||||
menu := comps[0].(discordgo.ActionsRow).Components[0].(discordgo.SelectMenu)
|
if n := len(comps[0].(discordgo.ActionsRow).Components[0].(discordgo.SelectMenu).Options); n != 25 {
|
||||||
if menu.CustomID != "tickets:select" || len(menu.Options) != 7 || menu.Options[6].Value != "7" {
|
t.Errorf("a dropdown holds at most 25 options, got %d", n)
|
||||||
t.Errorf("more than 5 categories should use a dropdown: %+v", menu)
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPicks(t *testing.T) {
|
||||||
|
clock := time.Date(2026, 10, 21, 12, 0, 0, 0, time.UTC)
|
||||||
|
now = func() time.Time { return clock }
|
||||||
|
t.Cleanup(func() { now = time.Now; picks = map[pickKey]pick{} })
|
||||||
|
|
||||||
|
if _, ok := PickedCategory(guild, 5); ok {
|
||||||
|
t.Error("nothing picked yet")
|
||||||
|
}
|
||||||
|
RememberPick(guild, 5, 3)
|
||||||
|
RememberPick(guild, 5, 4)
|
||||||
|
RememberPick(guild, 6, 9)
|
||||||
|
if c, ok := PickedCategory(guild, 5); !ok || c != 4 {
|
||||||
|
t.Errorf("the latest pick wins: %d %v", c, ok)
|
||||||
|
}
|
||||||
|
if _, ok := PickedCategory(guild+1, 5); ok {
|
||||||
|
t.Error("picks are per guild")
|
||||||
|
}
|
||||||
|
|
||||||
|
clock = clock.Add(pickTTL + time.Second)
|
||||||
|
if _, ok := PickedCategory(guild, 5); ok {
|
||||||
|
t.Error("a pick expires")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Full: new members can't add more, but expired ones make room.
|
||||||
|
picks = map[pickKey]pick{}
|
||||||
|
for i := 0; i < maxPicks; i++ {
|
||||||
|
picks[pickKey{guild + 100, int64(i)}] = pick{1, clock}
|
||||||
|
}
|
||||||
|
RememberPick(guild, 7, 1)
|
||||||
|
if _, ok := PickedCategory(guild, 7); ok {
|
||||||
|
t.Error("a full map takes no new members")
|
||||||
|
}
|
||||||
|
RememberPick(guild+100, 0, 2)
|
||||||
|
if c, _ := PickedCategory(guild+100, 0); c != 2 {
|
||||||
|
t.Error("someone already in the map can still change their pick")
|
||||||
|
}
|
||||||
|
clock = clock.Add(pickTTL + time.Second)
|
||||||
|
RememberPick(guild, 7, 1)
|
||||||
|
if _, ok := PickedCategory(guild, 7); !ok {
|
||||||
|
t.Error("expired picks should be cleared to make room")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log"
|
"log"
|
||||||
"os"
|
"os"
|
||||||
@@ -17,6 +18,7 @@ import (
|
|||||||
"velox-bot/internal/db/repos/projectsrepo"
|
"velox-bot/internal/db/repos/projectsrepo"
|
||||||
"velox-bot/internal/db/repos/rpsrepo"
|
"velox-bot/internal/db/repos/rpsrepo"
|
||||||
"velox-bot/internal/db/repos/schedulerepo"
|
"velox-bot/internal/db/repos/schedulerepo"
|
||||||
|
"velox-bot/internal/db/repos/securityrepo"
|
||||||
"velox-bot/internal/db/repos/settingsrepo"
|
"velox-bot/internal/db/repos/settingsrepo"
|
||||||
"velox-bot/internal/db/repos/ticketrepo"
|
"velox-bot/internal/db/repos/ticketrepo"
|
||||||
"velox-bot/internal/db/repos/twitchrepo"
|
"velox-bot/internal/db/repos/twitchrepo"
|
||||||
@@ -35,6 +37,7 @@ import (
|
|||||||
"velox-bot/internal/db/services/twitch"
|
"velox-bot/internal/db/services/twitch"
|
||||||
"velox-bot/internal/db/services/usersettings"
|
"velox-bot/internal/db/services/usersettings"
|
||||||
"velox-bot/internal/db/services/welcome"
|
"velox-bot/internal/db/services/welcome"
|
||||||
|
"velox-bot/internal/security"
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
@@ -62,6 +65,7 @@ func main() {
|
|||||||
twitchRepo := twitchrepo.NewRepo(db)
|
twitchRepo := twitchrepo.NewRepo(db)
|
||||||
defaultRoleRepo := defaultrolerepo.NewRepo(db)
|
defaultRoleRepo := defaultrolerepo.NewRepo(db)
|
||||||
cmdtickets.Init(ticketrepo.NewRepo(db))
|
cmdtickets.Init(ticketrepo.NewRepo(db))
|
||||||
|
security.Configure(securityrepo.NewRepo(db))
|
||||||
levelService := level.New(levelRepo, settingsRepo)
|
levelService := level.New(levelRepo, settingsRepo)
|
||||||
levelSettingsService := levelsettings.New(settingsRepo)
|
levelSettingsService := levelsettings.New(settingsRepo)
|
||||||
logSettingsService := logsettings.New(settingsRepo)
|
logSettingsService := logsettings.New(settingsRepo)
|
||||||
@@ -89,6 +93,9 @@ func main() {
|
|||||||
|
|
||||||
defer bot.Close()
|
defer bot.Close()
|
||||||
|
|
||||||
|
// Who the beta testers are is set on the dashboard; follow it.
|
||||||
|
bot.WatchBeta(context.Background(), settingsRepo.GetBetaSettings)
|
||||||
|
|
||||||
fmt.Println("Bot is running...")
|
fmt.Println("Bot is running...")
|
||||||
|
|
||||||
sc := make(chan os.Signal, 1)
|
sc := make(chan os.Signal, 1)
|
||||||
|
|||||||
+199
-2
@@ -46,7 +46,7 @@ CREATE TABLE IF NOT EXISTS levelup (
|
|||||||
CREATE TABLE IF NOT EXISTS twitch_config (
|
CREATE TABLE IF NOT EXISTS twitch_config (
|
||||||
guild_id BIGINT PRIMARY KEY,
|
guild_id BIGINT PRIMARY KEY,
|
||||||
twitch_channel_id BIGINT,
|
twitch_channel_id BIGINT,
|
||||||
enabled BOOLEAN NOT NULL DEFAULT TRUE
|
enabled BOOLEAN NOT NULL DEFAULT FALSE
|
||||||
);
|
);
|
||||||
|
|
||||||
CREATE TABLE IF NOT EXISTS rps (
|
CREATE TABLE IF NOT EXISTS rps (
|
||||||
@@ -73,6 +73,44 @@ CREATE TABLE IF NOT EXISTS meeting_settings (
|
|||||||
lobby_channel_id BIGINT
|
lobby_channel_id BIGINT
|
||||||
);
|
);
|
||||||
|
|
||||||
|
-- Who counts as a beta tester: holders of role_id in guild_id. One row, set by
|
||||||
|
-- the owner on the dashboard's admin page (the API creates and writes it, see
|
||||||
|
-- its migration 000021); the bot only reads it.
|
||||||
|
CREATE TABLE IF NOT EXISTS beta_settings (
|
||||||
|
id BOOLEAN PRIMARY KEY DEFAULT TRUE CHECK (id),
|
||||||
|
guild_id BIGINT,
|
||||||
|
role_id BIGINT,
|
||||||
|
updated_by BIGINT,
|
||||||
|
updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW()
|
||||||
|
);
|
||||||
|
|
||||||
|
-- A server can have several lobbies (at most 10; the trigger enforces it, and
|
||||||
|
-- is the same as the API's migration 000020). meeting_settings.lobby_channel_id
|
||||||
|
-- is the old single-lobby column, no longer read.
|
||||||
|
CREATE TABLE IF NOT EXISTS meeting_lobbies (
|
||||||
|
guild_id BIGINT NOT NULL,
|
||||||
|
channel_id BIGINT NOT NULL,
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
|
||||||
|
PRIMARY KEY (guild_id, channel_id)
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE OR REPLACE FUNCTION meeting_lobbies_limit() RETURNS trigger AS $$
|
||||||
|
BEGIN
|
||||||
|
PERFORM pg_advisory_xact_lock(NEW.guild_id);
|
||||||
|
IF EXISTS (SELECT 1 FROM meeting_lobbies WHERE guild_id = NEW.guild_id AND channel_id = NEW.channel_id) THEN
|
||||||
|
RETURN NEW;
|
||||||
|
END IF;
|
||||||
|
IF (SELECT COUNT(*) FROM meeting_lobbies WHERE guild_id = NEW.guild_id) >= 10 THEN
|
||||||
|
RAISE EXCEPTION 'a server can have at most 10 lobby channels' USING ERRCODE = '54000';
|
||||||
|
END IF;
|
||||||
|
RETURN NEW;
|
||||||
|
END;
|
||||||
|
$$ LANGUAGE plpgsql;
|
||||||
|
|
||||||
|
DROP TRIGGER IF EXISTS meeting_lobbies_limit ON meeting_lobbies;
|
||||||
|
CREATE TRIGGER meeting_lobbies_limit BEFORE INSERT ON meeting_lobbies
|
||||||
|
FOR EACH ROW EXECUTE FUNCTION meeting_lobbies_limit();
|
||||||
|
|
||||||
CREATE TABLE IF NOT EXISTS meeting_temp_channels (
|
CREATE TABLE IF NOT EXISTS meeting_temp_channels (
|
||||||
guild_id BIGINT NOT NULL,
|
guild_id BIGINT NOT NULL,
|
||||||
channel_id BIGINT NOT NULL,
|
channel_id BIGINT NOT NULL,
|
||||||
@@ -180,7 +218,7 @@ CREATE TABLE IF NOT EXISTS music_commands (
|
|||||||
-- Tickets (mirror of velox-dashboard-api migration 000016_tickets)
|
-- Tickets (mirror of velox-dashboard-api migration 000016_tickets)
|
||||||
CREATE TABLE IF NOT EXISTS ticket_settings (
|
CREATE TABLE IF NOT EXISTS ticket_settings (
|
||||||
guild_id BIGINT PRIMARY KEY,
|
guild_id BIGINT PRIMARY KEY,
|
||||||
enabled BOOLEAN NOT NULL DEFAULT TRUE,
|
enabled BOOLEAN NOT NULL DEFAULT FALSE,
|
||||||
channel_id BIGINT,
|
channel_id BIGINT,
|
||||||
log_channel_id BIGINT,
|
log_channel_id BIGINT,
|
||||||
panel_message_id BIGINT,
|
panel_message_id BIGINT,
|
||||||
@@ -228,3 +266,162 @@ CREATE TABLE IF NOT EXISTS ticket_commands (
|
|||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
|
created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
|
||||||
processed_at TIMESTAMPTZ
|
processed_at TIMESTAMPTZ
|
||||||
);
|
);
|
||||||
|
|
||||||
|
-- Security: anti-raid and anti-nuke (mirror of velox-dashboard-api migration 000017_security)
|
||||||
|
CREATE TABLE IF NOT EXISTS security_settings (
|
||||||
|
guild_id BIGINT PRIMARY KEY,
|
||||||
|
-- Where alerts go, and who gets pinged for raids and nukes.
|
||||||
|
alert_channel_id BIGINT,
|
||||||
|
alert_role_id BIGINT,
|
||||||
|
|
||||||
|
-- Join Gate: checks run on every join, each with its own action.
|
||||||
|
joingate_enabled BOOLEAN NOT NULL DEFAULT FALSE,
|
||||||
|
joingate_no_avatar TEXT NOT NULL DEFAULT 'off' CHECK (joingate_no_avatar IN ('off', 'timeout', 'kick', 'ban')),
|
||||||
|
joingate_new_account TEXT NOT NULL DEFAULT 'off' CHECK (joingate_new_account IN ('off', 'timeout', 'kick', 'ban')),
|
||||||
|
joingate_min_account_age_days INT NOT NULL DEFAULT 7 CHECK (joingate_min_account_age_days BETWEEN 1 AND 365),
|
||||||
|
joingate_advertising_name TEXT NOT NULL DEFAULT 'off' CHECK (joingate_advertising_name IN ('off', 'timeout', 'kick', 'ban')),
|
||||||
|
joingate_username_filter TEXT NOT NULL DEFAULT 'off' CHECK (joingate_username_filter IN ('off', 'timeout', 'kick', 'ban')),
|
||||||
|
joingate_username_patterns TEXT[] NOT NULL DEFAULT '{}',
|
||||||
|
joingate_unverified_bot TEXT NOT NULL DEFAULT 'off' CHECK (joingate_unverified_bot IN ('off', 'kick', 'ban')),
|
||||||
|
-- A bot added by someone who isn't the owner or trusted.
|
||||||
|
joingate_unauthorized_bot TEXT NOT NULL DEFAULT 'kick' CHECK (joingate_unauthorized_bot IN ('off', 'kick', 'ban')),
|
||||||
|
|
||||||
|
-- Raid mode: raid_join_count joins within raid_join_seconds starts it; it
|
||||||
|
-- ends after raid_quiet_minutes without a join, or when staff end it.
|
||||||
|
antiraid_enabled BOOLEAN NOT NULL DEFAULT FALSE,
|
||||||
|
raid_join_count INT NOT NULL DEFAULT 10 CHECK (raid_join_count BETWEEN 3 AND 100),
|
||||||
|
raid_join_seconds INT NOT NULL DEFAULT 10 CHECK (raid_join_seconds BETWEEN 5 AND 300),
|
||||||
|
raid_action TEXT NOT NULL DEFAULT 'kick' CHECK (raid_action IN ('alert', 'timeout', 'kick', 'ban')),
|
||||||
|
raid_pause_invites BOOLEAN NOT NULL DEFAULT TRUE,
|
||||||
|
raid_quiet_minutes INT NOT NULL DEFAULT 10 CHECK (raid_quiet_minutes BETWEEN 1 AND 120),
|
||||||
|
|
||||||
|
-- Anti-nuke: anyone who isn't the owner or trusted and goes over a limit
|
||||||
|
-- within antinuke_window_seconds is quarantined. Limits are per action
|
||||||
|
-- (channel_delete, channel_create, role_delete, role_create, ban, kick,
|
||||||
|
-- webhook_create); a limit of 0 means the action is never allowed.
|
||||||
|
antinuke_enabled BOOLEAN NOT NULL DEFAULT FALSE,
|
||||||
|
antinuke_window_seconds INT NOT NULL DEFAULT 10 CHECK (antinuke_window_seconds BETWEEN 5 AND 300),
|
||||||
|
antinuke_limits JSONB NOT NULL DEFAULT '{"channel_delete": 2, "channel_create": 5, "role_delete": 2, "role_create": 5, "ban": 3, "kick": 5, "webhook_create": 3}',
|
||||||
|
-- Also lock every channel when a nuke is stopped.
|
||||||
|
antinuke_lock_server BOOLEAN NOT NULL DEFAULT FALSE,
|
||||||
|
quarantine_role_id BIGINT,
|
||||||
|
|
||||||
|
-- Restore: snapshots of roles and channels are taken every few hours; a
|
||||||
|
-- restore recreates what's missing. Automatic after a stopped nuke when
|
||||||
|
-- antinuke_auto_restore is on, otherwise by the owner or trusted.
|
||||||
|
antinuke_auto_restore BOOLEAN NOT NULL DEFAULT FALSE,
|
||||||
|
|
||||||
|
-- Heat: every message adds heat to its author (more for repeats,
|
||||||
|
-- mentions, emoji walls, links, blocked words; an invite link maxes it),
|
||||||
|
-- and heat cools down over time. Reaching the maximum deletes the message
|
||||||
|
-- and applies heat_action. heat_strictness scales how fast heat builds.
|
||||||
|
heat_enabled BOOLEAN NOT NULL DEFAULT FALSE,
|
||||||
|
heat_strictness TEXT NOT NULL DEFAULT 'medium' CHECK (heat_strictness IN ('low', 'medium', 'high')),
|
||||||
|
heat_action TEXT NOT NULL DEFAULT 'timeout' CHECK (heat_action IN ('timeout', 'kick', 'ban')),
|
||||||
|
heat_timeout_minutes INT NOT NULL DEFAULT 10 CHECK (heat_timeout_minutes BETWEEN 1 AND 10080),
|
||||||
|
-- Each new offence within a day doubles the timeout (capped at 28 days).
|
||||||
|
heat_escalate BOOLEAN NOT NULL DEFAULT TRUE,
|
||||||
|
heat_blocked_words TEXT[] NOT NULL DEFAULT '{}',
|
||||||
|
-- Heat panic: this many members maxing out within a minute times out
|
||||||
|
-- anyone who joined in the last day as soon as they speak, for 10
|
||||||
|
-- minutes. 0 turns it off.
|
||||||
|
heat_panic_members INT NOT NULL DEFAULT 3 CHECK (heat_panic_members BETWEEN 0 AND 50),
|
||||||
|
-- Mention flood: this many mentions by non-exempt members within 30
|
||||||
|
-- seconds locks every channel. 0 turns it off.
|
||||||
|
heat_lockdown_mentions INT NOT NULL DEFAULT 0 CHECK (heat_lockdown_mentions BETWEEN 0 AND 1000),
|
||||||
|
|
||||||
|
-- Join lockdown (/lockdown joins): every new member is kicked or banned.
|
||||||
|
join_lock TEXT NOT NULL DEFAULT 'off' CHECK (join_lock IN ('off', 'kick', 'ban'))
|
||||||
|
);
|
||||||
|
|
||||||
|
-- Users and roles exempt from anti-nuke, who may also manage its settings.
|
||||||
|
-- The server owner is always trusted and never listed here.
|
||||||
|
CREATE TABLE IF NOT EXISTS security_trusted (
|
||||||
|
guild_id BIGINT NOT NULL,
|
||||||
|
target_id BIGINT NOT NULL,
|
||||||
|
kind TEXT NOT NULL CHECK (kind IN ('user', 'role')),
|
||||||
|
added_by BIGINT NOT NULL,
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
|
||||||
|
PRIMARY KEY (guild_id, target_id)
|
||||||
|
);
|
||||||
|
|
||||||
|
-- Members currently quarantined, with the roles they had, so releasing them
|
||||||
|
-- gives every role back.
|
||||||
|
CREATE TABLE IF NOT EXISTS security_quarantines (
|
||||||
|
guild_id BIGINT NOT NULL,
|
||||||
|
user_id BIGINT NOT NULL,
|
||||||
|
previous_role_ids BIGINT[] NOT NULL DEFAULT '{}',
|
||||||
|
reason TEXT NOT NULL,
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
|
||||||
|
PRIMARY KEY (guild_id, user_id)
|
||||||
|
);
|
||||||
|
|
||||||
|
-- Channels the bot locked, with @everyone's permission overwrite from before,
|
||||||
|
-- so unlocking puts back exactly what was there.
|
||||||
|
CREATE TABLE IF NOT EXISTS security_lockdowns (
|
||||||
|
guild_id BIGINT NOT NULL,
|
||||||
|
channel_id BIGINT NOT NULL,
|
||||||
|
had_overwrite BOOLEAN NOT NULL,
|
||||||
|
previous_allow BIGINT NOT NULL DEFAULT 0,
|
||||||
|
previous_deny BIGINT NOT NULL DEFAULT 0,
|
||||||
|
server_wide BOOLEAN NOT NULL DEFAULT FALSE,
|
||||||
|
locked_by BIGINT NOT NULL,
|
||||||
|
locked_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
|
||||||
|
PRIMARY KEY (guild_id, channel_id)
|
||||||
|
);
|
||||||
|
|
||||||
|
-- A raid in progress, so raid mode survives a bot restart: the quiet timer
|
||||||
|
-- carries on and the summary still lists everyone caught.
|
||||||
|
CREATE TABLE IF NOT EXISTS security_raids (
|
||||||
|
guild_id BIGINT PRIMARY KEY,
|
||||||
|
started_at TIMESTAMPTZ NOT NULL,
|
||||||
|
last_join_at TIMESTAMPTZ NOT NULL,
|
||||||
|
invites_paused BOOLEAN NOT NULL DEFAULT FALSE,
|
||||||
|
caught_total INT NOT NULL DEFAULT 0
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS security_raid_caught (
|
||||||
|
guild_id BIGINT NOT NULL,
|
||||||
|
user_id BIGINT NOT NULL,
|
||||||
|
action TEXT NOT NULL,
|
||||||
|
name TEXT NOT NULL,
|
||||||
|
caught_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
|
||||||
|
PRIMARY KEY (guild_id, user_id)
|
||||||
|
);
|
||||||
|
|
||||||
|
-- Snapshots of a guild's roles and channels for restoring after a nuke. The
|
||||||
|
-- bot keeps the last three per guild.
|
||||||
|
CREATE TABLE IF NOT EXISTS security_snapshots (
|
||||||
|
id BIGSERIAL PRIMARY KEY,
|
||||||
|
guild_id BIGINT NOT NULL,
|
||||||
|
data JSONB NOT NULL,
|
||||||
|
roles INT NOT NULL,
|
||||||
|
channels INT NOT NULL,
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT NOW()
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE INDEX IF NOT EXISTS security_snapshots_guild_idx ON security_snapshots (guild_id, created_at DESC);
|
||||||
|
|
||||||
|
-- What the system did, for the dashboard's history.
|
||||||
|
CREATE TABLE IF NOT EXISTS security_events (
|
||||||
|
id BIGSERIAL PRIMARY KEY,
|
||||||
|
guild_id BIGINT NOT NULL,
|
||||||
|
kind TEXT NOT NULL,
|
||||||
|
actor_id BIGINT,
|
||||||
|
target_id BIGINT,
|
||||||
|
detail TEXT NOT NULL DEFAULT '',
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT NOW()
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE INDEX IF NOT EXISTS security_events_guild_idx ON security_events (guild_id, created_at DESC);
|
||||||
|
|
||||||
|
-- Dashboard -> bot requests, same pattern as music_commands.
|
||||||
|
CREATE TABLE IF NOT EXISTS security_commands (
|
||||||
|
id BIGSERIAL PRIMARY KEY,
|
||||||
|
guild_id BIGINT NOT NULL,
|
||||||
|
command_type TEXT NOT NULL CHECK (command_type IN ('end_raid', 'release_quarantine', 'unlock_server', 'unlock_joins', 'snapshot', 'restore')),
|
||||||
|
payload JSONB,
|
||||||
|
requested_by BIGINT NOT NULL,
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
|
||||||
|
processed_at TIMESTAMPTZ
|
||||||
|
);
|
||||||
Reference in new issue
Block a user