search

shatindle / discord-scam-terminator

MIT License
6 stars 2 forks source link

readme

Discord Scam Terminator

Bot Deployment Status

tl;dr

If you're just interested in the invite link, you can invite the bot here.

If you want to join the support server, you can do so here.

What the bot does

The bot is specifically designed to look for key attributes common in scams. It uses a combination of tools to de-obfuscate scam message attempts that contain text and a link. If the message is identified as a scam and the user is not a Moderator, it creates a UUID for the message and the user, stores it in memory, makes a record of the event in Firestore, then deletes the message. If the same message is encountered recently and identically from the same user, the user is also kicked from the server.

If the message doesn't contain any scam attributes but has a link, the bot will visit the link, impersonating a user to investigate data about the site. If the site seems to be pretending to be a service such as Discord, Steam, or a few others, the bot will flag the message as a scam and follow the protocol for deleting/kicking outlined above.

The bot is not perfect as it is not operating against a known set of bad domains. Instead, it is using a less certain tactic for assessing if something is a scam in disguise. It is highly advised to pair this bot with another bot that has a list of recent, known scam domains. Between the two, very little will get through these filters.

Scam hunter's hit rate is near 100%, but it's not perfect. Mods still need to be ready to remove links it and other bots may miss. No bot is perfect, but hopefully this bot reduces the Moderator workload dramatically.

Required permissions

The bot needs the following permissions to function:

Additionally, in order to kick users, the bot must have a role above all users you wish to kick. NOTE: the bot will only kick users that do not have the Manage Messages permission in the server. Moderators should not be kicked by the bot.

The bot was originally deployed without slash commands. Some slash commands have been added such as the log command. To enable it, you may need to re-invite the bot to update the scopes. You should not need to kick the bot.

To log all malicious detections, do 

/log to:CHANNEL

System requirements

The bot needs the following to function:

Configuration

In Cloud Firebase, create a new project, then create a Firestore database in the project. See the quickstart above for instructions on setting up Firestore. Once you have a database, create a Service account via Project Settings > Service Accounts. Set the type as Node.js and click "Generate new private key". Name this file firebase.json, and place it in the root of the project.

If you've never used Firestore before, the daily free tier is extremely generous. Further, the bot does some caching to reduce the read operations required of Firestore, so unless you're deploying this in a server with half a million users, you likely will not need more than what the free tier offers.

Copy/paste the settings.sample.json file and name it settings.json. In that file, fill in your Discord bot token, replacing the sample's DISCORD_BOT_TOKEN. UUID_NAMESPACE should be any valid guid such as 4988c338-97e3-48ae-b2fa-2fb22108f1fd. Whatever you pick, you should not change it. It is used to create unique, repeatable identifiers given the same inputs to eliminate the need to store user messages in Firestore. Replace FIREBASE_PROJECT_ID with your Firebase/Firestore project ID.

Install the node modules and run the bot:

npm install;
node ./index.js;

Production mode

For testing purposes, it's ok to run the bot via node in the terminal. It is recommended to run the bot via a process manager like pm2 in a production environment. A sample setup is listed below in the root directory of the application:

pm2 start index.js --name "scam-terminator";
pm2 save;