Eruditus - CTF helper bot

About

Eruditus is a Discord CTF helper bot built with Python, it was initially designed to be used internally within the CyberErudites CTF team in order to make team work as efficient as possible.
The bot implements a bunch of useful features and uses Discord's Slash commands to make its usage as intuitive as possible.

Features

Core functionalities

Manage channels and their permissions
Create Discord scheduled events for upocoming CTF competitions
Track CTFs progress
Track members' participation in challenges
Announcements upon solving a challenge
Flag submission from within the Discord guild

and more.

Miscellaneous

Provides a utility to lookup system calls from a specific architecture
Provides a utility for basic encoding schemes
Provides a utility for classic ciphers

Usage

Here's a list of the currently supported commands:

/help                                                (Show help about the bot usage)
/search <query> [<limit>]                            (Search for a topic in the CTF write-ups index)
/request                                             (Request a new feature from the developer)
/report                                              (Send a bug report to the developer)

/ctf createctf <ctf_name>                            (Create a new CTF)
/ctf renamectf <ctf_name>                            (Rename a CTF)
/ctf archivectf <mode> [<ctf_name>]                  (Archive a CTF's channels)
/ctf deletectf [<ctf_name>]                          (Delete a CTF as well as its channels)
/ctf join <ctf_name>                                 (Join a specific CTF channels)
/ctf leave                                           (Leave a CTF)
/ctf addcreds <username> <password> <url>            (Add credentials for the current CTF)
/ctf showcreds                                       (Show credentials of the current CTF)
/ctf status [<ctf_name>]                             (Show CTF(s) status)
/ctf workon <challenge_name>                         (Access the private channel associated to the challenge)
/ctf unworkon [<challenge_name>]                     (Leave the challenge channel)
/ctf solve                                           (Mark a challenge as solved)
/ctf unsolve                                         (Mark a challenge as not solved)
/ctf createchallenge <name> <category>               (Create a new challenge)
/ctf renamechallenge <new_name> <new_category>       (Rename a challenge)
/ctf deletechallenge [<challenge_name>]              (Delete a challenge)
/ctf pull [<ctfd_url>]                               (Pull unsolved challenges from the CTFd platform)
/ctf takenote <type> <note_format>                   (Copies the last message into the notes channel)
/ctf submit                                          (Submits a flag to CTFd)
/ctf remaining                                       (Show remaining time for the CTF)
/ctf register                                        (Register a CTFd account)

/syscalls show <arch> <syscall name/syscall id>      (Show information for a specific syscall)

/ctftime upcoming [<limit>]                          (Show upcoming CTF competitions)
/ctftime current                                     (Show ongoing CTF competitions)
/ctftime top [<year>]                                (Show leaderboard for a specific year)
/ctftime pull                                        (Create events starting in less than a week)
/ctftime setchannel                                  (Set the text channel where CTF reminders will be sent)

/cipher caesar <message> [<key>]                     (Caesar cipher)
/cipher rot13 <message>                              (Rot13 cipher)
/cipher atbash <message>                             (Atbash cipher)

/encoding base64 <encode/decode> <data>              (Base64 encoding/decoding)
/encoding base32 <encode/decode> <data>              (Base32 encoding/decoding)
/encoding binary <encode/decode> <data>              (Binary encoding/decoding)
/encoding hex <encode/decode> <data>                 (Hex encoding/decoding)
/encoding url <encode/decode> <data>                 (URL encoding/decoding)

Installation

Go to the Discord Developer Portal.
Create a new application.
Go to the Bot pane and add a bot for your application.
Enable Server Members Intent and Message Content Intent under Privileged Gateway Intents.
Put your Discord guild ID and bot token inside the .env file.
Deploy the bot using docker-compose up -d --build.
Go to the OAuth2 URL Generator pane, tick bot and applications.commands under the Scopes section, tick Administrator under the Bot Permissions section and copy the generated link.
Invite your bot to the guild using the generated link.
Enjoy.

Contribution Guidelines

Please consider reading our Contribution Guidelines before making a contribution.

Contributors

Credits

This work was inspired from these amazing projects:

License

Distributed under the MIT License. See LICENSE for more information.

fa2y / eruditus Goto Github PK

eruditus's Introduction

Eruditus - CTF helper bot