hackthebox-gobot

README

HTBot

HTBot is a discord bot that connect to HackTheBox to retrieve informations about users, boxes... and to notify you and your friends when you flag a challenge or own a new box.

Commands :

Command     Options             Description                              
----------  ---------------     --------------------------------------------
ping                            Want to ping pong ?
echo        <sentence>          A simple echo command
help                            Shows this message

ippsec      <search_term>       Search through Ippsec videos
role       <role_name>         Add or remove Discord role

get_box     <box_name>          Get info on a box
get_chall   <chall_name>        Get info on a chall
get_user    <htb_user_name>     Stalk your competitors
last_box                        Get info on the newest box
list_boxes                      list all active boxs
list_challs <category>          list active challs by category

Restricted to team's members :
----------- -----------------   --------------------------------------------
verify      <api_token>         Verify your HTB account 
me                              Get your HTB info
leaderboard                     Get the leaderboard of the guild
prolab      <name>              Get progress of prolabs
progress    <box_name>          Get progress of boxes

In the shoutbox, display :

The pwn user / root of the boxes and challenges.
The pwn flags of the prolabs and fortress
If a member gets a VIP pass

In the htb category, display :

How long before the new box arrives
When the box arrived

Other :

Unlike Hack The Box's Discord server bot, this bot automatically updates your rank.
It automatically manage channel when a new box is out.

Install

You need a config.json in the config directory like this

{
  "Prefix" : ">",
  "HTB" : {
    "email" : "<htb email>",
    "password" : "<htb password>",
    "api_token" : "<htb api token>"
  },

  "discord" : {
    "guild_name" : "<name of your guild>",
    "bot_token" : "<token of your bot>",
    "guild_id" : "<id of your guild>",
    "shoutbox_id" : "<id of your shoutbox channel>"
  }
}

Then create users.json, ippsec.json, progress.json, challs.json and boxes.json files

Channels gestion

You need to create a "htb" category on your discord server with two channels. The bot will then automatically manage theses channels like this :

- when a new htb box is comming, it will create a new channel for this box in the "htb" category
- the bot will delete the penultimate (so there is always two boxes channels in this category)
- the bot will send a countdown and a notification when the new box is out

Acknowledgments

This bot is based on the work of mxrch (https://github.com/mxrch/HackTheBot/). I rewrited the bot in Go. Some features are missing and I'm still working on it. Some features are not implemented on purpose.