Welcome to the Practical Bug Bounty Content repository. This repository is designed to house structured content for the course, organized in a hierarchical folder structure for ease of use and contribution.
- Module 1: Basics
- Submodule: Writing a Report
- Topic: Report Writing
- Video: HTTP Request Smuggling - False Positives by PinkDraconian
- Video: Q: How to write a BUG BOUNTY report that actually gets paid?
- Note: The Importance of Report Writing in Bug Bounty
- Additional Link: Reporting Tips: Using Markdown
- Additional Link: Reporting tips: setting the severity of a report with the CVSS calculator
- Topic: Understanding CVSS
- Video: What is CVSS? | Common Vulnerability Scoring System
- ...
- Topic: Report Writing
- Submodule: Scope
- ...
- Submodule: Writing a Report
- Module 2: ...
- ...
- Each
moduleis a directory. - Within each
module, there aresubmodules, which are also directories. - Each
submodulecontainstopics, which are again directories. - Each
topicdirectory can have:info.json: Contains metadata about the topic.videos.json: Contains a list of video references associated with the topic.notes.md: Contains any textual notes or additional information about the topic.links.json: Contains a list of external links related to the topic.
- Navigate to the desired location in the folder structure.
- Modify existing files or add new files as required. Ensure you follow the structure mentioned above.
- Once you've added or modified content, navigate to the repository root and run the converter script:
python3 folder_to_json_converter.py
This script will traverse the folder structure, collect the data, and generate a Django-compatible JSON dump.
In this example, we will create a new module named Web Security, a submodule named XSS Attacks, and a topic named Reflected XSS.
To create a new module:
- Navigate to the root content directory.
- Create a directory named
Web Security.
Within the Web Security directory:
- Create a directory named
XSS Attacks.
Inside the XSS Attacks directory:
- Create a directory named
Reflected XSS.
Inside the Reflected XSS directory:
- Create a file named
info.json. - Add the following content to
info.json:
{
"description": "An introduction to Reflected XSS attacks."
}- Still within the Reflected XSS directory, create a file named
videos.json. - Add the following content to
videos.json:
[
{
"title": "Understanding Reflected XSS",
"url": "https://youtube.com/examplelink1"
}
]- Create a file named
notes.mdin the same directory. - Add your notes. For example:
# Reflected XSS
Reflected XSS attacks are a type of XSS where the injected script is reflected off a web server- Create a file named
links.json. - Add the following content:
[
{
"url": "https://security.example.com/reflected-xss",
"description": "Deep dive into Reflected XSS"
}
]
- Create a new directory in the root folder with the module name.
- Inside the module directory, you can add submodules as directories.
- Each submodule can then have topics, and so on.
- Navigate to the desired topic directory.
- Open
info.jsonto modify metadata,videos.jsonto add or modify videos,notes.mdto edit notes, andlinks.jsonto update external links.
Remember to run the converter script after making changes to generate an updated JSON dump.