documentation

README.md

@@ -1,47 +1,50 @@
 # 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).
+
 <h4 align="center">Pentesting content management and reporting tool</h4>
 
 <h1 align="center">
   <br>
-  <a href="https://github.com/1modm/petereport"><img src="images/Dashboard.png" alt="petereport" width="80%" height="80%"></a>
+  <a href="https://github.com/1modm/petereport"><img src="https://github.com/1modm/petereport/raw/main/images/dashboard.png" alt="petereport" width="80%" height="80%"></a>
   <br>
 </h1>
 
-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
 
 
 ## 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")
 

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

django/preport/templates/appendix/appendix_add.html

@@ -13,7 +13,7 @@
   <div class="container-fluid">
     <div class="row mb-2">
       <div class="col-sm-6">
-        <h1>Report: {{DB_report_query.title}} - {{ DB_report_query.report_id }} </h1>
+        <h1>{{DB_report_query.title}} Report</h1>
       </div>
       <div class="col-sm-6">
         <ol class="breadcrumb float-sm-right">

django/preport/templates/attacktree/attacktree_add.html

@@ -14,7 +14,7 @@
   <div class="container-fluid">
     <div class="row mb-2">
       <div class="col-sm-6">
-        <h1>Report: {{DB_report_query.title}} - {{ DB_report_query.report_id }} </h1>
+        <h1>{{DB_report_query.title}} Report</h1>
       </div>
       <div class="col-sm-6">
         <ol class="breadcrumb float-sm-right">
@@ -44,14 +44,6 @@ <h3 class="card-title">Security decision trees</h3>
                   The visualization of the attack path of a vulnerability or finding has been implemented adapting a web app that simplifies building attack decision trees as described in the Security Chaos Engineering report: <a href="https://www.deciduous.app/">Deciduous</a>
                   </p>
 
-                  <p>
-                  So all the credits to <a href="https://twitter.com/swagitda_">@swagitda</a>. How to / getting started guide: <a href="https://swagitda.com/blog/posts/deciduous-attack-tree-app/">https://swagitda.com/blog/posts/deciduous-attack-tree-app/</a>
-                  </p>
-
-                  <p>
-                  Also if needed to attach an Attack Path Planner I recommend you to take a look into: <a href="https://jackson_t.gitlab.io/walter-planner/">Walter: Attack Path Planner</a>
-                  </p>
-
                 </div>
         </div>