Skip to content

MichaelTrenker/Chang

Repository files navigation

CHANG - Penetration Testing Planning

CHANG Logo

CHANG is a Penetration Testing Planning App, inspired by the quote "Without strategy, execution is aimless. Without execution, strategy is useless." by Morris Chang. This app is built using Streamlit, a Python web app framework, to assist penetration testers in planning and organizing their penetration testing activities. It provides a user-friendly interface for inputting and managing various aspects of a penetration test.

Live Preview

https://chang-notes.streamlit.app/

Table of Contents

Features

  • **Create Tasks **: Create Tasks and assign them with parametres like phase of the killchain, status, priority.
  • Create Tags: Create Tags which help to organize your notes and keep an simple overview.

Getting Started

Prerequisites

Before you start using CHANG, ensure you have the following dependencies installed:

  • Python 3.6 or higher
  • Pip (Python package manager)

Installation

  1. Clone the CHANG repository to your local machine.

    https://github.com/MichaelTrenker/Chang.git
  2. Install required dependencies.

    pip install -r requirements.txt

Usage

To start the Penetration Testing Planning App, execute the following command:

streamlit run Home.py

The app should open in your default web browser.

Contributing

Contributions to this project are welcome! If you would like to contribute or report issues, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine.
  3. Create a new branch for your feature or bug fix.
  4. Make your changes and commit them with descriptive commit messages.
  5. Push your branch to your fork on GitHub.
  6. Create a pull request to the main repository.

Please follow our Code of Conduct and Contribution Guidelines.

License

This Penetration Testing Planning App is open-source software released under the GNU General Public License version 3. You are free to use, modify, and distribute it as per the terms of the GPL-3.0 license.

Thank you for using the Penetration Testing Planning App. If you have any questions, suggestions, or issues, feel free to open an issue or contact us through the provided contact information in the app. Happy testing!