This site is the archived OWASP Foundation Wiki and is no longer accepting Account Requests.
To view the new OWASP Foundation website, please visit https://owasp.org

Difference between revisions of "OWASP DefectDojo Project"

From OWASP
Jump to: navigation, search
(Road Map and Getting Involved)
(Updated Leaders)
 
(33 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
=Main=
 
=Main=
  
<div style="width:100%;height:160px;border:0,margin:0;overflow: hidden;">[[File:OWASP_Project_Header.jpg|link=]]</div>
+
<div style="width:100%;height:90px;border:0,margin:0;overflow: hidden;">[[File: flagship_big.jpg|link=]]</div>
  
 
{| style="padding: 0;margin:0;margin-top:10px;text-align:left;" |-
 
{| style="padding: 0;margin:0;margin-top:10px;text-align:left;" |-
| valign="top" style="border-right: 1px dotted gray;padding-right:25px;" |
+
| valign="top" style="border-right: 1px dotted gray;padding-right:25px;" |
 
 
  
 
==OWASP DefectDojo Tool Project ==
 
==OWASP DefectDojo Tool Project ==
 
An open source vulnerability management tool that streamlines the testing process by offering templating, report generation, metrics, and baseline self-service tools.
 
An open source vulnerability management tool that streamlines the testing process by offering templating, report generation, metrics, and baseline self-service tools.
  
DefectDojo is a tracking tool written in Python / Django. DefectDojo was created in 2013 and open-sourced on March 13th, 2015. The project was started to make optimizing vulnerability tracking less painful. The top goal of DefectDojo is to reduce the amount of time security professionals spend logging vulnerabilities. DefectDojo accomplishes this by offering a templating system for vulnerabilities, imports for common vulnerability scanners, report generation, and metrics.
+
DefectDojo is an Application Security Program tool written in Python / Django. DefectDojo was created in 2013 and open-sourced on March 13th, 2015. The project was started to make optimizing vulnerability tracking less painful. The top goal of DefectDojo is to reduce the amount of time security professionals spend logging vulnerabilities. DefectDojo accomplishes this by offering a templating system for vulnerabilities, imports for common vulnerability scanners, report generation, and metrics.
  
 
==Description==
 
==Description==
DefectDojo streamlines the testing process through several 'models' that an admin can manipulate with Python code. The core models include: 'engagements', 'tests' and 'findings'. DefectDojo has supplemental models that facilitate metrics, authentication, report generation, and tools. DefectDojo is written in Python 2.7 with Django 1.8.
+
DefectDojo streamlines the testing process through several 'models' that an admin can manipulate with Python code. The core models include: 'engagements', 'tests' and 'findings'. DefectDojo has supplemental models that facilitate metrics, authentication, report generation, and tools. DefectDojo is written in Python and Django.
  
Testing or installing DefectDojo is easy. There is a live demo for interested parties to try Dojo [https://github.com/rackerlabs/django-DefectDojo#demo here]. If you decide to setup an instance of Dojo for your organization, we have developed a script that handles all dependencies, configures the database, and creates a super user. Complete installation instructions are found [https://github.com/rackerlabs/django-DefectDojo#installation here]. A complete walk-through can be found [http://defectdojo.readthedocs.org/en/latest/ here]. Documented example workflows can be found [https://github.com/rackerlabs/django-DefectDojo/blob/master/doc/workflows.md].
+
Testing or installing DefectDojo is easy. If you decide to setup an instance of Dojo for your organization, we have developed a script that handles all dependencies, configures the database, and creates a super user. Complete installation instructions are found [https://github.com/DefectDojo/django-DefectDojo#installation here]. A complete walk-through can be found [http://defectdojo.readthedocs.org/en/latest/ here]. Documented example workflows can be found [https://github.com/rackerlabs/django-DefectDojo/blob/master/doc/workflows.md].
  
 
==Licensing==
 
==Licensing==
DefectDojo is licensed under the [https://github.com/rackerlabs/django-DefectDojo/blob/master/LICENSE.md BSD Simplified License].
+
DefectDojo is licensed under the [https://github.com/defectdojo/django-DefectDojo/blob/master/LICENSE.md BSD Simplified License].
  
 
== Project Resources ==
 
== Project Resources ==
  
[https://github.com/rackerlabs/django-DefectDojo#demo Live Demo]
+
[https://www.defectdojo.org/ DefectDojo Product Page]
  
[https://github.com/rackerlabs/django-DefectDojo Source Code]
+
[https://github.com/DefectDojo/django-DefectDojo/ Source Code]
  
[https://github.com/rackerlabs/django-DefectDojo/blob/master/doc/getting_started.md Getting Started Guide]
+
[https://github.com/DefectDojo/django-DefectDojo/blob/master/docs/getting-started.rst Getting Started Guide]
  
[https://github.com/rackerlabs/django-DefectDojo/releases What's New ]
+
[https://github.com/DefectDojo/django-DefectDojo/releases What's New]
  
[https://github.com/rackerlabs/django-DefectDojo/issues Issue Tracker]
+
[https://github.com/DefectDojo/django-DefectDojo/issues Issue Tracker]
  
 
== Project Leaders ==
 
== Project Leaders ==
 
[https://www.owasp.org/index.php/User:Devgreg Greg Anderson] [mailto:[email protected] @]
 
[https://www.owasp.org/index.php/User:Devgreg Greg Anderson] [mailto:[email protected] @]
  
Charles Neill
+
[https://www.owasp.org/index.php/User:Aweaver Aaron Weaver][mailto:[email protected] @]
  
[https://www.owasp.org/index.php/User:Grendel Jay Paz]
+
[mailto:[email protected] Charles Neill]
 +
 
 +
[https://www.owasp.org/index.php/User:Grendel Jay Paz][mailto:[email protected] @]
  
 
== Related Projects ==
 
== Related Projects ==
Line 47: Line 48:
 
   {| width="200" cellpadding="2"
 
   {| width="200" cellpadding="2"
 
   |-
 
   |-
   | colspan="2" align="center" | [[File:Project_Type_Files_TOOL.jpg|link=https://www.owasp.org/index.php/Category:OWASP_Tool]]
+
   | colspan="2" align="center" | [[File:Project_Type_Files_TOOL.jpg|link=https://www.owasp.org/index.php/Category:OWASP_Tool]]
 
   |-
 
   |-
   | colspan="2" align="center" | [[File:Project_Type_Files_CODE.jpg|link=https://www.owasp.org/index.php/Category:OWASP_Code]]
+
   | colspan="2" align="center" | [[File:Project_Type_Files_CODE.jpg|link=https://www.owasp.org/index.php/Category:OWASP_Code]]
 
   |-
 
   |-
   | align="center" valign="top" width="50%" rowspan="2"| [[File:Owasp-incubator-trans-85.png|link=https://www.owasp.org/index.php/OWASP_Project_Stages#tab=Incubator_Projects|Incubator Project]]
+
   | rowspan="2" align="center" valign="top" width="50%" | [[File:Owasp-incubator-trans-85.png|link=https://www.owasp.org/index.php/OWASP_Project_Stages#tab=Incubator_Projects|Incubator Project]]
   | align="center" valign="top" width="50%"| [[File:Owasp-builders-small.png|link=Builders]]   
+
   | align="center" valign="top" width="50%" | [[File:Owasp-builders-small.png|link=Builders]]   
 
   |-
 
   |-
   | align="center" valign="top" width="50%"| [[File:Owasp-defenders-small.png|link=Defenders]]
+
   | align="center" valign="top" width="50%" | [[File:Owasp-defenders-small.png|link=Defenders]]
 
   |-
 
   |-
 
   |}
 
   |}
  
 
== News and Events ==
 
== News and Events ==
 
+
* [23 July 2018] [https://github.com/OWASP/django-DefectDojo/releases/tag/1.5.1 Version 1.5.1 Released]
 +
* [15 Dec 2017] [https://github.com/OWASP/django-DefectDojo/releases/tag/1.2.1 Version  1.2.1 Released]
 +
* [20 Sep 2017] [https://github.com/OWASP/django-DefectDojo/releases/tag/1.2 Version  1.2.0 Released]
 +
* [19 Dec 2016] [https://github.com/OWASP/django-DefectDojo/releases/tag/1.1.3 Version  1.1.3 Released]
 +
* [12 Nov 2016] [https://github.com/OWASP/django-DefectDojo/releases/tag/1.1.2 Version  1.1.2 Released]
 +
* [13 Oct 2016] [https://github.com/OWASP/django-DefectDojo/releases/tag/1.1.1 Version  1.1.1 Released]
 +
* [1 Oct 2016] [https://github.com/OWASP/django-DefectDojo/releases/tag/1.1.0 Version 1.1.0 Released]
 
* [22 Dec 2015] [https://github.com/rackerlabs/django-DefectDojo/releases/tag/v1.0.5 Version 1.0.5 Released]
 
* [22 Dec 2015] [https://github.com/rackerlabs/django-DefectDojo/releases/tag/v1.0.5 Version 1.0.5 Released]
 
* [08 Sep 2015] [https://github.com/rackerlabs/django-DefectDojo/releases/tag/v1.0.4 Version 1.0.4 Released]
 
* [08 Sep 2015] [https://github.com/rackerlabs/django-DefectDojo/releases/tag/v1.0.4 Version 1.0.4 Released]
Line 80: Line 87:
 
= Acknowledgements =
 
= Acknowledgements =
 
==Contributors==
 
==Contributors==
 +
The project is extremely grateful for all of our contributors both prior to becoming open source and after.
 +
[https://github.com/OWASP/django-DefectDojo/graphs/contributors Contributors since going open source].
  
 
+
==Sponsors==
 
+
[[Image:xing_logo.png|link=https://corporate.xing.com/en/about-xing/security/|www.xing.com]]
* Greg Anderson
 
* Charles Neill
 
* Jay Paz
 
* Michael Dong
 
*Fatimah Zohra
 
  
 
= Road Map and Getting Involved =
 
= Road Map and Getting Involved =
At this time, Dojo is already being used by multiple large enterprises, but there is still many aspects we want to improve. Part of our next steps is to better evangelize our work and encourage others to contribute. However, we do have a set of core contributors that actively work on the project. Feature-wise, we hope to push a proof of concept plugin that will aid in retesting automation.
+
At this time, Dojo is already being used by multiple large enterprises. Part of our next steps is to better evangelize our work and encourage others to contribute. However, we do have a set of core contributors that actively work on the project.
 
 
  
 +
==Roadmap==
 +
'''July 2018 Release 1.5:'''
 +
** Updated UI with a new DefectDojo logo, default colors and CSS.
 +
** Updated Product views with tabs for Product Overview, Metrics, Engagements, Endpoints, Benchmarks (ASVS), and Settings to make it easier to navigate and manage your products.
 +
** New Product Information fields: Regulations, Criticality, Platform, Lifecycle, Origin, User Records, Revenue, External Audience, Internet Accessible
 +
** Languages pie chart on product overview, only supported through the API and Django admin, integrates with cloc analyzer
 +
** New Engagement type of CI/CD to support continual testing
 +
** Engagement shortcuts and ability to import findings and auto-create an engagement
 +
** Engagement labels for overdue, no tests and findings
 +
** New Contextual menus throughout DefectDojo and shortcuts to new findings and critical findings
 +
** Ability to merge a finding into a parent finding and either inactivate or delete the merged findings.
 +
** Report improvements and styling adjustment with the default option of HTML reports
 +
** SLA for remediation of severities based on finding criticality, for example critical findings remediated within 7 days. Configurable in System Settings.
 +
** Engagement Auto-Close Days in System Settings. Automatically close an engagement if open past the end date.
 +
** Ability to apply remediation advice based on CWE. For example XSS can be configured as a template so that it’s consistent across all findings. Enabled in system settings.
 +
** Finding confidence field supported from scanners. First implementation in the Burp importer.
 +
** Goast importer for static analysis of Golang products
 +
** Celery status check on System Settings
 +
** Beta rules framework release for modifying findings on the fly
 +
** DefectDojo 2.0 API with Swagger support
 +
** Created and Modified fields on all major tables
 +
** Various bug fixes reported on Github
  
==Roadmap==
 
 
As of March, 2016, the highest priorities for the next 6 months are:
 
As of March, 2016, the highest priorities for the next 6 months are:
 
<strong>
 
<strong>
Line 121: Line 145:
  
 
===Testing===
 
===Testing===
Do you have a flair for finding bugs in software? We want to product a high quality product, so any help with Quality Assurance would be greatly appreciated. Let us know if you can offer your help.
+
Do you have a flair for finding bugs in software? We want to produce a high quality product, so any help with Quality Assurance would be greatly appreciated. Let us know if you can offer any help.
 +
 
 
===Feedback===
 
===Feedback===
 
Please use the [https://lists.owasp.org/mailman/listinfo/OWASP_Tool_Project_Template DefectDojo project mailing list] for feedback about:
 
Please use the [https://lists.owasp.org/mailman/listinfo/OWASP_Tool_Project_Template DefectDojo project mailing list] for feedback about:
Line 136: Line 161:
 
| project_name =OWASP DefectDojo
 
| project_name =OWASP DefectDojo
 
| project_description =OWASP DefectDojo is an open source vulnerability management tool that streamlines the testing process by offering templating, report generation, metrics, and baseline self-service tools.  
 
| project_description =OWASP DefectDojo is an open source vulnerability management tool that streamlines the testing process by offering templating, report generation, metrics, and baseline self-service tools.  
| project_license = [https://github.com/rackerlabs/django-DefectDojo/blob/master/LICENSE.md BSD Simplified License]
+
| project_license = [https://github.com/OWASP/django-DefectDojo/blob/master/LICENSE.md BSD Simplified License]
 
| leader_name1=Greg Anderson
 
| leader_name1=Greg Anderson
  
 
| leader_username1=devgreg
 
| leader_username1=devgreg
| leader_name2=Charles Neill
+
| leader_name2=Aaron Weaver
| leader_email2=charles.neill@owasp.org
+
| leader_email2=aaron.weaver@owasp.org
 
| leader_username2=N/A
 
| leader_username2=N/A
| leader_name3=Jay Paz
+
| leader_name3=Matt Tesauro
| leader_email3= N/A
+
| leader_email3= [email protected]
| leader_username3=grendel
+
| leader_username3=N/A
 
}}   
 
}}   
  
__NOTOC__ <headertabs />  
+
__NOTOC__ <headertabs></headertabs>  
  
[[Category:OWASP Project]] [[Category:OWASP_Builders]] [[Category:OWASP_Defenders]] [[Category:OWASP_Tool]]
+
[[Category:OWASP Project]]
 +
[[Category:OWASP_Builders]]
 +
[[Category:OWASP_Defenders]]
 +
[[Category:OWASP_Tool]]
 +
[[Category:Projects|DefectDojo]]
 +
[[Category:Incubator Projects|DefectDojo]]
 +
[[Category:OWASP DefectDojo|DefectDojo]]

Latest revision as of 14:45, 2 January 2019

Flagship big.jpg

OWASP DefectDojo Tool Project

An open source vulnerability management tool that streamlines the testing process by offering templating, report generation, metrics, and baseline self-service tools.

DefectDojo is an Application Security Program tool written in Python / Django. DefectDojo was created in 2013 and open-sourced on March 13th, 2015. The project was started to make optimizing vulnerability tracking less painful. The top goal of DefectDojo is to reduce the amount of time security professionals spend logging vulnerabilities. DefectDojo accomplishes this by offering a templating system for vulnerabilities, imports for common vulnerability scanners, report generation, and metrics.

Description

DefectDojo streamlines the testing process through several 'models' that an admin can manipulate with Python code. The core models include: 'engagements', 'tests' and 'findings'. DefectDojo has supplemental models that facilitate metrics, authentication, report generation, and tools. DefectDojo is written in Python and Django.

Testing or installing DefectDojo is easy. If you decide to setup an instance of Dojo for your organization, we have developed a script that handles all dependencies, configures the database, and creates a super user. Complete installation instructions are found here. A complete walk-through can be found here. Documented example workflows can be found [1].

Licensing

DefectDojo is licensed under the BSD Simplified License.

Project Resources

DefectDojo Product Page

Source Code

Getting Started Guide

What's New

Issue Tracker

Project Leaders

Greg Anderson @

Aaron Weaver@

Charles Neill

Jay Paz@

Related Projects

Classifications

Project Type Files TOOL.jpg
Project Type Files CODE.jpg
Incubator Project Owasp-builders-small.png
Owasp-defenders-small.png

News and Events

How can I participate in your project?

All you have to do is make the Project Leaders aware of your available time to contribute to the project. It is also important to let the Leaders know how you would like to contribute and pitch in to help the project meet its goals and milestones. There are many different ways you can contribute to an OWASP Project, but communication with the leads is key. If you are a programmer and wish to contribute code, we regularly review pull requests.

If I am not a programmer can I participate in your project?

Yes, you can certainly participate in the project if you are not a programmer or technical. The project needs different skills and expertise and different times during its development. Currently, we are looking for people to help translate our documentation. See the Road Map and Getting Involved tab for more details.

Contributors

The project is extremely grateful for all of our contributors both prior to becoming open source and after. Contributors since going open source.

Sponsors

www.xing.com

At this time, Dojo is already being used by multiple large enterprises. Part of our next steps is to better evangelize our work and encourage others to contribute. However, we do have a set of core contributors that actively work on the project.

Roadmap

July 2018 Release 1.5:

    • Updated UI with a new DefectDojo logo, default colors and CSS.
    • Updated Product views with tabs for Product Overview, Metrics, Engagements, Endpoints, Benchmarks (ASVS), and Settings to make it easier to navigate and manage your products.
    • New Product Information fields: Regulations, Criticality, Platform, Lifecycle, Origin, User Records, Revenue, External Audience, Internet Accessible
    • Languages pie chart on product overview, only supported through the API and Django admin, integrates with cloc analyzer
    • New Engagement type of CI/CD to support continual testing
    • Engagement shortcuts and ability to import findings and auto-create an engagement
    • Engagement labels for overdue, no tests and findings
    • New Contextual menus throughout DefectDojo and shortcuts to new findings and critical findings
    • Ability to merge a finding into a parent finding and either inactivate or delete the merged findings.
    • Report improvements and styling adjustment with the default option of HTML reports
    • SLA for remediation of severities based on finding criticality, for example critical findings remediated within 7 days. Configurable in System Settings.
    • Engagement Auto-Close Days in System Settings. Automatically close an engagement if open past the end date.
    • Ability to apply remediation advice based on CWE. For example XSS can be configured as a template so that it’s consistent across all findings. Enabled in system settings.
    • Finding confidence field supported from scanners. First implementation in the Burp importer.
    • Goast importer for static analysis of Golang products
    • Celery status check on System Settings
    • Beta rules framework release for modifying findings on the fly
    • DefectDojo 2.0 API with Swagger support
    • Created and Modified fields on all major tables
    • Various bug fixes reported on Github

As of March, 2016, the highest priorities for the next 6 months are:

  • A proof of concept plugin that will aid in retesting automation
  • JIRA Integration
  • Dynamic Application Tagging.

Subsequent Releases will add:

  • CI / CD for pull requests
  • Additional Unit Tests
  • Automated Regression tests

Getting Involved

Involvement in the development and promotion of DefectDojo is actively encouraged! You do not have to be a security expert or a programmer to contribute. Some of the ways you can help are as follows:

Coding

We could implement some of the later items on the roadmap sooner if someone wanted to help out with unit or automated regression tests

Localization

Are you fluent in another language? Can you help translate the text strings in the DefectDojo into that language?

Testing

Do you have a flair for finding bugs in software? We want to produce a high quality product, so any help with Quality Assurance would be greatly appreciated. Let us know if you can offer any help.

Feedback

Please use the DefectDojo project mailing list for feedback about:

  • What do like?
  • What don't you like?
  • What features would you like to see prioritized on the roadmap?
PROJECT INFO
What does this OWASP project offer you?
RELEASE(S) INFO
What releases are available for this project?
what is this project?
Name: OWASP DefectDojo
Purpose: OWASP DefectDojo is an open source vulnerability management tool that streamlines the testing process by offering templating, report generation, metrics, and baseline self-service tools.
License: BSD Simplified License
who is working on this project?
Project Leader(s):
how can you learn more?
Project Pamphlet: Not Yet Created
Project Presentation:
Mailing list: N/A
Project Roadmap: Not Yet Created
Key Contacts
current release
1.5.1
last reviewed release
1.2.1


other releases