HTNotes is a powerfull automatic tool that integrates a Vault Workspace in Obsidian. It can automate the first steps of taking Notes in a HTB Machine by generating a folder structure given a machine name. It has also an integration with the HTB API that makes requests and print the info into markdown files.
This can be performed with just a click on obsidian button.
Nothing except your eyes could
HTNotes.mp4
You need Obsidian to integrate the tool.
Open your browser and go to Download Obsidian. Install .deb and execute the following command under Dowloads
sudo dpkg -i <<Obsidian.deb>>
Now you need to clone this repository and install all the dependencies.
git clone https://github.com/0x4xel/HTNotes
cd HTNotes
pip install -r requirements.txt
- You have to login in HackTheBox.
- Explore under View Profile -> Profile Settings -> App Tokens -> Generate App token
- Create a token that will be needed to make requests on HTB API.
Put you API key in Constants.py file and save.
- Open obsidian and select open existing vault
- Select the folder HTB under HTNotes
- IMPORTANT: When prompt open asking for permisions, press enable. This vault has preconfigured plugins that is needed to work properly
Note: Consider that HTB folder will be the main vault folder, so scripts must be under HTNotes and with execute privileges with current user to keep working.
When the script creates a machine folder, it also creates a fileClass call "machine" that receive the data from the API and print it into the {{machine_name}}.md.
The profile of the machine is displayed like:
There are three dynamic tables that will show you the diferent machines in the vault. Machines fileClass are defined by the tag "machine".
This tables :
- Show all the machines in the vault
- Show the machines in the vault that have user flag but not root flag
- Show the machines in the vault that have not started
This is the main funtion of the integration. "Create Machine Note" button calls htb_api.py and makes all the implementation given below in the flowchart
This button is usefull trigger it when you have completed a machine, or you didnt access to HTB in a while. This button will ONLY update the machine info of all the machines you have in the vault, updating the state of flags and graphs.
https://github.com/clubby789/htb-api
With the support of xerosec team https://discord.gg/cZPaRurR ❤️



