OWASP Threat Dragon

=Main=



{| style="padding: 0;margin:0;margin-top:10px;text-align:left;" |-
 * valign="top" style="border-right: 1px dotted gray;padding-right:25px;" |

Instructions are in RED text and should be removed from your document by deleting the text with the span tags. This document is intended to serve as an example of what is required of an OWASP project wiki page. The text in red serves as instructions, while the text in black serves as an example. Text in black is expected to be replaced entirely with information specific to your OWASP project.

OWASP Threat Dragon Project
An online threat modelling web application including system diagramming and a rule engine to auto-generate threats/mitigations. The focus will be on great UX a powerful rule engine and alignment with other development lifecycle tools.

Description
This is where you need to add your more robust project description. A project description should outline the purpose of the project, how it is used, and the value it provides to application security. Ideally, project descriptions should be written in such a way that there is no question what value the project provides to the software security community. This section will be seen and used in various places within the Projects Portal. Poorly written project descriptions therefore detract from a project’s visibility, so project leaders should ensure that the description is meaningful.

Licensing
This program is free software: you can redistribute it and/or modify it under the terms of the Apache 2.0 License
 * valign="top" style="padding-left:25px;width:200px;border-right: 1px dotted gray;padding-right:25px;" |

Project Resources
This is where you can link to the key locations for project files, including setup programs, the source code repository, online documentation, a Wiki Home Page, threaded discussions about the project, and Issue Tracking system, etc.

Project Leader
[mailto:mike.goodwin@owasp.org Mike Goodwin]

Classifications

 * valign="top" style="padding-left:25px;width:200px;" |

News and Events

 * }

=FAQs=

= Acknowledgements =

Contributors
[mailto:mike.goodwin@owasp.org Mike Goodwin]

= Road Map and Getting Involved =

Roadmap
Vision for the project:

=
===

The overall vision for the project is to implement a tool that removes as many barriers as possible for organisations wanting to embed threat modelling into their development lifecycle. Barriers I have seen are:

- Lack of cross platform tooling: Tool needs to be x-platform - Poor UX in existing tools, productivity is poor: Great UX is a must - Steep learning curve for adopting teams: Tool to build in expert knowledge to help the team get started - Models are ignored: Integration with other lifecycle tools is key

Initial high level plan:

=
===

Milestone 1: Alpha release - Basic threat modelling experience

- Architecture review of the existing prototype with refinement/change where required - Secure design review and implementation of findings - Development of tests (unit and manual) - Draft end user documentation - "Publicity drive" to sign up alpha/beta users and generate feedback

Milestone 2: Beta release - Threat/mitigation rule engine

- Refinement of UX based on feedback from the alpha release - (Some) feature enhancements based on feedback from the alpha release - Implementation of a rule engine for generation of threats/mitigations - Updated tests and end-user documentation

Milestone 3: Release 1 ---

- Key refinements, bug fixes and new features based on feedback from the beta release - Complete end user documentation - Penetration test

Milestone 4 - Dev lifecycle integration ---

- Detailed scope to be defined, but in general the vision is to support hooks into issue tracking and requirements management tool so that threats/mitigations can be tracked through to implementation and test

Timeframes ---

This is hard to estimate as it could change a lot if there were other developers involved. Based on my current velocity with just me, I would say release 1 could be complete in 1 year (optimistically).

Technology

=
The technical architecture is javascript from top to bottom. In the client the key libraries are Angular for the MVC architecture and JointJS for the diagraming. JointJS has a log of great features, but is not a perfect fit for Angular. This needs a review. In the prototype, all storage is done on the client using browser local storage.

There is nothing on the server side at the moment in the prototype. Areas where this might become necessary are

- If the threat rule engine requires too much power to run feasibly on the client - Supporting hooks in to other dev lifecycle tools

If needed I plan to use node.js on the server so that the rule engine can be flexible enough to run either client or server side.

Server-side storage has not been needed yet. If it becomes necessary, then a review of options will be needed to find a way to do this that is sustainable and consistent with the open source approach for the project.

Challenges

=
- Getting enough usage of the alpha and beta to get the UX and rule engine right - Finding a sustainable way to host it, especially if it needs any kind of server side storage or processing - the prototype today just serves static content and all the logic is on the client side

Coding
=Minimum Viable Product=

1) Application source code for a threat modeling tool

2) End user documentation for the tool

3) An online hosted version of the tool