Skip to content

jiveshkalra/SecureHack-Quest-TechBuzz

Repository files navigation

SecureHack Quest

Welcome to SecureHack Quest, a Flask application where you have to find and report vulnerabilities as quickly as possible. This project is designed for educational purposes, to help students learn about web security and improve their problem-solving skills.

📋 General Instructions:

  1. Objective: Find and report vulnerabilities in the code.
  2. Platform: Flask application with a MySQL database.
  3. Rules:
    • Do not use chatbots or external assistance.
    • Teaming up with other schools is not allowed.
    • Follow the guidelines and report issues properly on GitHub.

🚀 Getting Started

Prerequisites

  • Python 3.x
  • Flask
  • MySQL

Setup Instructions

  1. Clone this GitHub repository or your forked repository:
git clone https://github.com/jiveshkalra/SecureHack-Quest-TechBuzz.git
  1. Navigate to the project directory:
cd SecureHack-Quest-TechBuzz
  1. Install the required packages:
pip install -r requirements.txt
  1. Run the Flask application:
python server.py

📂 Project Structure

server.py: The main Flask application file.
requirements.txt: List of dependencies to be installed.
static/: Static files (CSS, JavaScript, images).
templates/: HTML templates for the web pages.

🛠️ Reporting Vulnerabilities

  1. Identify vulnerabilities in the code.
  2. Raise an issue on the GitHub issues tab with a detailed description:
  3. Clearly explain the issue, providing the file name, function, and line number if applicable. For example, "MongoDB API Exposed in xyz.py at the abc function around line 42".
  4. Fix the issue (if verified) by raising a Pull Request (PR):
  5. Ensure your PR includes a detailed explanation of the fix.

🤝 Contributions

To contribute to this project:

  1. Create a fork of the repository.
  2. Make your changes in your forked repository.
  3. Create a Pull Request (PR) with a detailed description of your changes.

General Contribution Guidelines

  1. Ensure your code follows the project's style guidelines.
  2. Write clear and concise commit messages.
  3. Test your changes thoroughly before submitting a PR.
  4. Be respectful and considerate in your communications and code reviews.

📌 Additional Tips

  1. Go through the code thoroughly before raising issues.
  2. Do not repeat issues; duplicate issues will be closed without comments.
  3. Focus on identifying as many issues as possible before moving to the PR stage.
  4. Be as descriptive as possible in your issue reports.

Good luck and happy hacking! 🎉

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •