diff --git a/README.md b/README.md index 1d3844e..e202e37 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,42 @@ # PeTeReport +PeTeReport (**Pe**n**Te**st **Report**) is an open-source application vulnerability reporting tool designed to assist pentesting/redteaming efforts, by simplifying the task of writting and generation of reports. + +Focused in product security, the tool help security researchers and pentesters to provide detailed findings, appendix, attack paths and manage a finding template database to avoid wasting time spent in the reporting phase. + +PeTeReport (**Pe**n**Te**st **Report**) is written in Django and Python 3 with the aim to help pentesters to manage a finding repository, write reports (in Markdown) and generate reports in different formats (HTML, CSV, PDF, Jupyter and Markdown). +

Pentesting content management and reporting tool


- petereport + petereport

-PeTeReport (**Pe**n**Te**st **Report**), Pentest Reporting Tool written in Django and Python 3 with the aim to help pentesters to manage a finding repository, write reports (in Markdown) and generate reports in different formats (HTML, CSV, PDF and Markdown). - -Focused in product security the tool help security researchers and pentesters to write reports, and manage a finding template database to avoid wasting time spent in the reporting phase. +## Documentation -## Architecture - -![Architecture](images/architecture.png "Architecture") +![Documentation](https://1modm.github.io/petereport/ "Documentation") ## Installation and deployment -- [x] [Docker](doc/docker.md) -- [x] [Django](doc/django.md) +- [x] [Docker](https://1modm.github.io/petereport/docker/) +- [x] [Django](https://1modm.github.io/petereport//django/) ## Features - [x] Customizable reports output - [x] Customizable reports templates - [x] Findings template database -- [x] Possibility to add Appendix to findings +- [x] Possibility to add appendix to findings +- [x] Possibility to add attack trees [Deciduous](https://www.deciduous.app/) to findings - [x] HTML Output format - [x] CSV Output format - [x] PDF Output format -- [x] Jupyter Notebook Output format -- [x] Markdown Output format -- [x] CVSS 3.1 Score +- [x] Jupyter Notebook Output format +- [x] Markdown Output format +- [x] CVSS 3.1 Score - [x] Docker installation - [x] DefectDojo integration - [x] User management @@ -41,7 +44,7 @@ Focused in product security the tool help security researchers and pentesters to ## TODO -- [ ] Other Output formats +- [ ] More Output formats - [ ] API ## Demo @@ -50,11 +53,8 @@ Focused in product security the tool help security researchers and pentesters to ## Sample Reports -[PDF Sample](sample_reports/PEN-PDF_Offensive_Security_Network_202108181118.pdf "PDF Sample") - -[HTML Sample](sample_reports/PEN-HTML_Offensive_Security_Network_202108181117.html "HTML Sample") - -[MD Sample](sample_reports/PEN-MD_Offensive_Security_Network_202108181118.md "MD Sample") - -[CSV Sample](sample_reports/PEN-CSV_Offensive_Security_Network_202108181118.csv "CSV Sample") +- [PDF Sample](https://github.com/1modm/petereport/raw/main/sample_reports/PEN-PDF_Offensive_Security_Network_202108181118.pdf "PDF Sample") +- [HTML Sample](https://github.com/1modm/petereport/raw/main/sample_reports/PEN-HTML_Offensive_Security_Network_202108181117.html "HTML Sample") +- [MD Sample](https://github.com/1modm/petereport/raw/main/sample_reports/PEN-MD_Offensive_Security_Network_202108181118.md "MD Sample") +- [CSV Sample](https://github.com/1modm/petereport/raw/main/sample_reports/PEN-CSV_Offensive_Security_Network_202108181118.csv "CSV Sample") diff --git a/django/config/Dockerfile b/django/config/Dockerfile index cb169d4..8e528d0 100644 --- a/django/config/Dockerfile +++ b/django/config/Dockerfile @@ -47,4 +47,4 @@ RUN wget ${EISVOGEL_REPO}/v${EISVOGEL_VERSION}/eisvogel.tex -O ${TEMPLATES_DIR}/ WORKDIR /opt/petereport COPY Pipfile ./ -RUN pipenv install --system --deploy --ignore-pipfile +RUN pipenv install --system --deploy --ignore-pipfile \ No newline at end of file diff --git a/django/preport/templates/appendix/appendix_add.html b/django/preport/templates/appendix/appendix_add.html index 88208a7..35ca0a3 100644 --- a/django/preport/templates/appendix/appendix_add.html +++ b/django/preport/templates/appendix/appendix_add.html @@ -13,7 +13,7 @@
-

Report: {{DB_report_query.title}} - {{ DB_report_query.report_id }}

+

{{DB_report_query.title}} Report