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 SecurityRAT Project"

From OWASP
Jump to: navigation, search
m (added new version)
 
(24 intermediate revisions by 2 users not shown)
Line 7: Line 7:
 
==OWASP SecurityRAT==
 
==OWASP SecurityRAT==
  
−
Tool mission: Simplify security requirement management during the SSDLC.
+
Tool mission: Simplify security requirement management during the SSDLC using automation approaches.
  
 
==Description==
 
==Description==
 
The core functionality of SecurityRAT ("Requirement Automation Tool") can be described in the following steps:  
 
The core functionality of SecurityRAT ("Requirement Automation Tool") can be described in the following steps:  
−
# You tell SecurityRAT what kind of a software artifact you're going to develop.
+
# You tell SecurityRAT what kind of a software artifact you're going to develop / are running
 
# SecurityRAT tells you which requirements you should fulfill.  
 
# SecurityRAT tells you which requirements you should fulfill.  
 
# You decide how you want to handle the desired requirements.
 
# You decide how you want to handle the desired requirements.
 
# You persist the the artifact state in an issue tracker and create tickets for the requirements where an explicit action is necessary
 
# You persist the the artifact state in an issue tracker and create tickets for the requirements where an explicit action is necessary
 +
# Throughout the continuous development of the particular artifact, you respect the rules defined in SecurityRAT and document relevant changes in requirement compliance whenever appropriate.
 +
 +
Focus of SecurityRAT is currently put on automation of procedures rather then quality of requirements. There is a set of requirements provided which you can start with, nevertheless it is recommended to create your own set of requirements which fits your company risk profile.
 +
 +
==Current version==
 +
Current version is 1.7.9 released in June 2019: https://github.com/SecurityRAT/SecurityRAT/releases/latest
 +
 +
Changelog:
 +
 +
* Issue where Option columns disappear in the requirement editor view after some minutes ( #111 )
 +
* Bug where change settings will change Implementation Type to first value and can't be changed anymore ( #121 )
  
 
==Licensing==
 
==Licensing==
Line 25: Line 36:
 
[https://github.com/SecurityRAT/SecurityRAT/ GitHub Repository]
 
[https://github.com/SecurityRAT/SecurityRAT/ GitHub Repository]
  
−
[https://hub.docker.com/r/securityrat/all_in_one/ Docker Image]
+
[https://github.com/SecurityRAT/SecurityRAT-dockercompose Docker Image]
  
 
[https://securityrat.github.io/ Documentation]
 
[https://securityrat.github.io/ Documentation]
 +
 +
[https://owasp.slack.com/messages/C76U4TNFJ/details/ Slack Channel]
  
 
== Project Leaders ==
 
== Project Leaders ==
−
* Daniel Kefer
+
* [https://www.owasp.org/index.php/User:Dkefer Daniel Kefer]
−
* René Reuter
+
* [https://www.owasp.org/index.php/User:Ares René Reuter]
  
 
== Related Projects ==
 
== Related Projects ==
Line 38: Line 51:
 
==Classifications==
 
==Classifications==
  
−
   {| cellpadding="2" width="200"
+
   {| 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]]
 
   |-
 
   |-
−
   | rowspan="2" valign="top" width="50%" align="center" | [[File:Owasp-incubator-trans-85.png|link=https://www.owasp.org/index.php/OWASP_Project_Stages#tab=Incubator_Projects|Incubator Project]]
+
   | rowspan="2" width="50%" valign="top" align="center" | [[File:Owasp-incubator-trans-85.png|link=https://www.owasp.org/index.php/OWASP_Project_Stages#tab=Incubator_Projects|Incubator Project]]
−
   | valign="top" width="50%" align="center" | [[File:Owasp-builders-small.png|link=Builders]]   
+
   | width="50%" valign="top" align="center" | [[File:Owasp-builders-small.png|link=Builders]]   
 
   |-
 
   |-
−
   | valign="top" width="50%" align="center" | [[File:Owasp-defenders-small.png|link=Defenders]]
+
   | width="50%" valign="top" align="center" | [[File:Owasp-defenders-small.png|link=Defenders]]
 
   |-
 
   |-
 
   | colspan="2" align="center" | [[File:Agplv3-155x51.png|link=http://www.gnu.org/licenses/agpl-3.0.html|Affero General Public License 3.0]]
 
   | colspan="2" align="center" | [[File:Agplv3-155x51.png|link=http://www.gnu.org/licenses/agpl-3.0.html|Affero General Public License 3.0]]
Line 55: Line 68:
  
 
== SecurityRAT on Tour ==
 
== SecurityRAT on Tour ==
 +
* [01 Feb 2018] [https://www.meetup.com/de-DE/OWASP-Bucharest/events/246846435/ OWASP Chapter Meeting Bucharest]
 +
* [09 Oct 2017] [https://www.meetup.com/de-DE/owasp-karlsruhe/events/243958635/ OWASP Stammtisch Karlsruhe]
 +
* [22 Sep 2017] [https://2017.appsecusa.org/schedule/ OWASP AppSec US]
 
* [22 May 2017] [https://entwicklertag.de/karlsruhe/2017/security-requirements-im Karlsruher Entwicklertag].
 
* [22 May 2017] [https://entwicklertag.de/karlsruhe/2017/security-requirements-im Karlsruher Entwicklertag].
 
* [21 Mar 2017] OWASP [https://github.com/SecurityRAT/SecurityRAT/releases Stammtisch München].
 
* [21 Mar 2017] OWASP [https://github.com/SecurityRAT/SecurityRAT/releases Stammtisch München].
Line 60: Line 76:
 
* [25 Nov 2016] [[BeNeLux OWASP Day 2016-2]]
 
* [25 Nov 2016] [[BeNeLux OWASP Day 2016-2]]
 
* [22 Sep 2016] [[Netherlands September 22nd, 2016|Netherlands Chapter Meeting]]
 
* [22 Sep 2016] [[Netherlands September 22nd, 2016|Netherlands Chapter Meeting]]
−
* [30 Jun 2016] [https://2016.appsec.eu/?page_id=914 OWASP AppSec EU]    
+
* [30 Jun 2016] [https://2016.appsec.eu/?page_id=914 OWASP AppSec EU]  
 +
* [13 Jun 2016] OWASP Stammtisch Karlsruhe
  
 
|}
 
|}
  
−
=FAQs=
+
=Get Involved=
 +
We're looking for volunteers helping us with the project. These are the possibilities to get involved:
  
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+
==Test SecurityRAT and open issues==
−
<span style="color:#ff0000">
+
You don't have to be a developer in order to help! Simply e.g. download our [https://github.com/SecurityRAT/SecurityRAT-dockercompose docker image] play around and open a [https://github.com/SecurityRAT/SecurityRAT/issues GitHub issue] for anything what doesn't work according to your expectations!
−
Many projects have "Frequently Asked Questions" documents or pages. However, the point of such a document is not the questions. ''The point of a document like this are the '''answers'''''. The document contains the answers that people would otherwise find themselves giving over and over again. The idea is that rather than laboriously compose and post the same answers repeatedly, people can refer to this page with pre-prepared answers. Use this space to communicate your projects 'Frequent Answers.'
 
−
</span>
 
  
−
==How can I participate in your project?==
+
==Create alternative requirement sets==
−
All you have to do is make the Project Leader's aware of your available time to contribute to the project. It is also important to let the Leader's know how you would like to contribute and pitch in to help the project meet it's goals and milestones. There are many different ways you can contribute to an OWASP Project, but communication with the leads is key.  
+
Current default requirement set is very basic and targeted on web development only.  
  
−
==If I am not a programmer can I participate in your project?==
+
If you want to improve that, you can create your own security requirement set in your own instance of SecurityRAT and provide it in a form of an SQL dump accordingly to the [https://github.com/SecurityRAT/Security-Requirements default one].
−
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 researchers, writers, graphic designers, and a project administrator.  See the Road Map and Getting Involved tab for more details.
+
 
 +
==Join the development team==
 +
If you like our idea and want to make it better, know some coding (JavaScript/Angular & JAVA/Spring Boot) and have some spare time, we will be happy to receive you in the team and provide any starting support necessary!
  
 
= Acknowledgements =
 
= Acknowledgements =
 
==Contributors==
 
==Contributors==
  
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+
The following volunteers take care of pushing development of SecurityRAT forwards:
−
<span style="color:#ff0000">
 
−
The success of OWASP is due to a community of enthusiasts and contributors that work to make our projects great. This is also true for the success of your project.
 
−
Be sure to give credit where credit is due, no matter how small! This should be a brief list of the most amazing people involved in your project.
 
−
Be sure to provide a link to a complete list of all the amazing people in your project's community as well.
 
−
</span>
 
−
 
 
−
The OWASP Tool Project Template is developed by a worldwide team of volunteers. A live update of project  [https://github.com/OWASP/Security-Principles/graphs/contributors contributors is found here].
 
−
 
 
−
The first contributors to the project were:
 
−
 
 
−
* [https://www.owasp.org/index.php/User:Clerkendweller Colin Watson] who created the OWASP Cornucopia project that the template was derived from
 
−
* [https://www.owasp.org/index.php/User:Chuck_Cooper Chuck Cooper] who edited the template to convert it from a documentation project to a Tool Project Template
 
−
* '''YOUR NAME BELONGS HERE AND YOU SHOULD REMOVE THE PRIOR 3 NAMES'''
 
−
 
 
−
= Road Map and Getting Involved =
 
−
 
 
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 
−
<span style="color:#ff0000">
 
−
A project roadmap is the envisioned plan for the project. The purpose of the roadmap is to help others understand where the project is going as well as areas that volunteers may contribute. It gives the community a chance to understand the context and the vision for the goal of the project. Additionally, if a project becomes inactive, or if the project is abandoned, a roadmap can help ensure a project can be adopted and continued under new leadership.
 
−
Roadmaps vary in detail from a broad outline to a fully detailed project charter. Generally speaking, projects with detailed roadmaps have tended to develop into successful projects. Some details that leaders may consider placing in the roadmap include: envisioned milestones, planned feature enhancements, essential conditions, project assumptions, development timelines, etc. You are required to have at least 4 milestones for every year the project is active.
 
−
</span>
 
−
 
 
−
Current version: 1.0.2
 
−
 
 
−
Work in progress (targeted to speed up first steps with the tool):
 
−
 
 
−
- Docker image
 
−
 
 
−
- own user management
 
−
 
 
−
- extensive development and operational documentation
 
−
 
 
−
Next steps:
 
−
 
 
−
- Integration with different Issue Trackers (currently only JIRA is supported) and other systems (e.g. wikis, testing tools)
 
−
 
 
−
- works on provided default requirement sheet (code patterns, best practises, further parametrization of requirements)
 
−
 
 
−
- other features with the goal of further speeding up handling of requirements throughout SDLC
 
−
 
 
−
==Roadmap==
 
−
As of <strong>November, 2013, the highest priorities for the next 6 months</strong> are:
 
−
<strong>
 
−
* Complete the first draft of the Tool Project Template
 
−
* Get other people to review the Tool Project Template and provide feedback
 
−
* Incorporate feedback into changes in the Tool Project Template
 
−
* Finalize the Tool Project template and have it reviewed to be promoted from an Incubator Project to a Lab Project
 
−
</strong>
 
−
 
 
−
Subsequent Releases will add
 
−
<strong>
 
−
* Internationalization Support
 
−
* Additional Unit Tests
 
−
* Automated Regression tests
 
−
</strong>
 
−
 
 
−
==Getting Involved==
 
−
Involvement in the development and promotion of <strong>Tool Project Template</strong> 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 <strong>Tool Project Template</strong> into that language?
 
−
===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.
 
−
===Feedback===
 
−
Please use the [https://lists.owasp.org/mailman/listinfo/OWASP_Tool_Project_Template Tool Project Template project mailing list] for feedback about:
 
−
<ul>
 
−
<li>What do like?</li>
 
−
<li>What don't you like?</li>
 
−
<li>What features would you like to see prioritized on the roadmap?</li>
 
−
</ul>
 
−
 
 
−
=Minimum Viable Product=
 
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 
−
<span style="color:#ff0000">
 
−
This page is where you should indicate what is the minimum set of functionality that is required to make this a useful product that addresses your core security concern.
 
−
Defining this information helps the project leader to think about what is the critical functionality that a user needs for this project to be useful, thereby helping determine what the priorities should be on the roadmap.  And it also helps reviewers who are evaluating the project to determine if the functionality sufficiently provides the critical functionality to determine if the project should be promoted to the next project category. 
 
−
</span>
 
−
 
 
−
The Tool Project Template must specify the minimum set of tabs a project should have, provide some an example layout on each tab, provide instructional text on how a project leader should modify the tab, and give some example text that illustrates how to create an actual project.
 
−
 
 
−
It would also be ideal if the sample text was translated into different languages.
 
−
 
 
−
=Project About=
 
−
Addtional Instructions for making changes:
 
  
−
The About 'tab' on that page is done with a MediaWiki template.  If you log into the wiki page for your project and click the "Edit" button/link/tab in the top-right between 'Read' and 'View History', you'll see the edit page for the main body of your project page.
+
* Jay Mbolda Yamdjeu
 +
* Philipp Zschumme
  
−
If you scroll down below the form to edit that page (below the "Save page", "Show preview", "Show changes" buttons, you'll see some text with a triangle in front of it reading "Templates used on this page:"  A list will expand if you click on the triangle/text to show the templates that make up this page.  The one you want is the "Projects/OWASP Example Project About Page" - click the (edit) next to this to edit that template.  The direct link is: https://www.owasp.org/index.php?title=Projects/OWASP_Example_Project_About_Page&action=edit
+
= Road Map =
  
−
The template takes 'input' that are key/value pairs where you'll need to edit the stuff after the equals (=) like:
+
==Version in planning==
−
project_name =Place your project name here.
 
  
−
You'd edit the bold bit.
+
For the moment, we don't anticipate development of further big features in version 1, we're putting it into maintenance mode and have started collecting ideas for v2.0.
  
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+
Please see the current list of ideas for version 2.0 and contribute your ideas on this [https://github.com/SecurityRAT/SecurityRAT/wiki/Version-2.0-Brainstorming GitHub Wiki Page]
−
<span style="color:#ff0000">
 
−
This page is where you need to place your legacy project template page if your project was created before October 2013. To edit this page you will need to edit your project information template. You can typically find this page by following this address and substituting your project name where it says "OWASP_Example_Project". When in doubt, ask the OWASP Projects Manager.
 
−
Example template page: https://www.owasp.org/index.php/Projects/OWASP_Example_Project
 
−
</span>
 
  
−
{{:Projects/OWASP_Example_Project_About_Page}}
 
  
 
__NOTOC__ <headertabs></headertabs>  
 
__NOTOC__ <headertabs></headertabs>  

Latest revision as of 12:39, 9 July 2019

OWASP Project Header.jpg

OWASP SecurityRAT

Tool mission: Simplify security requirement management during the SSDLC using automation approaches.

Description

The core functionality of SecurityRAT ("Requirement Automation Tool") can be described in the following steps:

  1. You tell SecurityRAT what kind of a software artifact you're going to develop / are running
  2. SecurityRAT tells you which requirements you should fulfill.
  3. You decide how you want to handle the desired requirements.
  4. You persist the the artifact state in an issue tracker and create tickets for the requirements where an explicit action is necessary
  5. Throughout the continuous development of the particular artifact, you respect the rules defined in SecurityRAT and document relevant changes in requirement compliance whenever appropriate.

Focus of SecurityRAT is currently put on automation of procedures rather then quality of requirements. There is a set of requirements provided which you can start with, nevertheless it is recommended to create your own set of requirements which fits your company risk profile.

Current version

Current version is 1.7.9 released in June 2019: https://github.com/SecurityRAT/SecurityRAT/releases/latest

Changelog:

  • Issue where Option columns disappear in the requirement editor view after some minutes ( #111 )
  • Bug where change settings will change Implementation Type to first value and can't be changed anymore ( #121 )

Licensing

This program is licensed under the Apache 2.0 license.

Project Resources

GitHub Repository

Docker Image

Documentation

Slack Channel

Project Leaders

Related Projects

Classifications

Project Type Files TOOL.jpg
Incubator Project Owasp-builders-small.png
Owasp-defenders-small.png
Affero General Public License 3.0

Releases

Please see our GitHub Releases page for the information about the most current release!

SecurityRAT on Tour

We're looking for volunteers helping us with the project. These are the possibilities to get involved:

Test SecurityRAT and open issues

You don't have to be a developer in order to help! Simply e.g. download our docker image play around and open a GitHub issue for anything what doesn't work according to your expectations!

Create alternative requirement sets

Current default requirement set is very basic and targeted on web development only.

If you want to improve that, you can create your own security requirement set in your own instance of SecurityRAT and provide it in a form of an SQL dump accordingly to the default one.

Join the development team

If you like our idea and want to make it better, know some coding (JavaScript/Angular & JAVA/Spring Boot) and have some spare time, we will be happy to receive you in the team and provide any starting support necessary!

Contributors

The following volunteers take care of pushing development of SecurityRAT forwards:

  • Jay Mbolda Yamdjeu
  • Philipp Zschumme

Version in planning

For the moment, we don't anticipate development of further big features in version 1, we're putting it into maintenance mode and have started collecting ideas for v2.0.

Please see the current list of ideas for version 2.0 and contribute your ideas on this GitHub Wiki Page


Retrieved from "https://wiki.owasp.org/index.php?title=OWASP_SecurityRAT_Project&oldid=252914"