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 Glue Tool Project"

From OWASP
Jump to: navigation, search
(→‎Project Leader)
(→‎News and Events)
 
(18 intermediate revisions by 3 users not shown)
Line 4: Line 4:
  
 
{| 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 Pipeline Tool Project==
+
==OWASP Glue Tool Project==
  
−
The OWASP Pipeline Tool Project is a tools based project intended to make security automation easier.  It is essentially a ruby gem that co-ordinates the running of different analysis tools and reporting from those tools.
+
The OWASP Glue Tool Project is a tools based project intended to make security automation easier.  It is essentially a ruby gem that co-ordinates the running of different analysis tools and reporting from those tools.
  
 
==Description==
 
==Description==
  
−
The purpose of the project is to make it easy to run static analysis tools, live analysis tools (ZAP) etc. as part of an automated build process and to report the findings to JIRA or other tracking systems.
+
The purpose of the project is to make it easy to integrate security tools (like static or dynamic analysis) into the CI/CD pipeline.  
  
 
==Licensing==
 
==Licensing==
Line 19: Line 19:
 
This program is free software: you can redistribute it and/or modify it under the terms of the [http://www.apache.org/licenses/LICENSE-2.0 link Apache 2.0 License] as published by the Apache Software Foundation.  Any contributions are Copyright © by OWASP 2015.   
 
This program is free software: you can redistribute it and/or modify it under the terms of the [http://www.apache.org/licenses/LICENSE-2.0 link Apache 2.0 License] as published by the Apache Software Foundation.  Any contributions are Copyright © by OWASP 2015.   
  
−
| valign="top" style="padding-left:25px;width:200px;border-right: 1px dotted gray;padding-right:25px;" |
+
| valign="top" style="padding-left:25px;width:200px;border-right: 1px dotted gray;padding-right:25px;" |
  
 
== Project Resources ==
 
== Project Resources ==
  
−
[https://github.com/OWASP/pipeline Source Code]
+
[https://github.com/OWASP/glue Source Code]
−
 
 
−
[https://www.owasp.org/index.php/OWASP_Pipeline_Tool_Project Wiki Home Page]
 
−
 
 
−
[https://owasporg.atlassian.net Issue Tracker]
 
  
 
== Project Leader ==
 
== Project Leader ==
  
 
Matt Konda
 
Matt Konda
 +
 +
Omer Levi Hevroni
  
 
== Related Projects ==
 
== Related Projects ==
Line 41: Line 39:
 
   {| 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]]
 
   |-
 
   |-
−
   | 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]]
−
  |-
 
−
  | colspan="2" align="center"  | [[File:Agplv3-155x51.png|link=http://www.gnu.org/licenses/agpl-3.0.html|Affero General Public License 3.0]]
 
 
   |}
 
   |}
  
−
| valign="top" style="padding-left:25px;width:200px;" |  
+
| valign="top" style="padding-left:25px;width:200px;" |
  
 
== News and Events ==
 
== News and Events ==
−
<span style="color:#ff0000">
+
* [6 Sep 2018] [https://github.com/OWASP/glue/releases/tag/0.10.0 0.10.0]
−
This is where you can provide project updates, links to any events like conference presentations, Project Leader interviews, case studies on successful project implementations, and articles written about your project.  
+
* [2 Jan 2016] 0.8.0
−
</span>
+
* [27 Aug 2015] Initial Release.
−
* [12 Feb 2013] Support for Spanish is now available with this release.
+
* [14 Sep 2016] Renamed to Glue from Pipeline.
−
* [11 Jan 2014] The 1.0 stable version has been released! Thanks everyone for your feedback and code fixes that made this happen!
 
−
* [18 Dec 2013] 1.0 Release Candidate is available for download. This release provides final bug fixes and product stabilization.  Any feedback (good or bad) in the next few weeks would be greatly appreciated.
 
−
* [20 Nov 2013] 1.0 Beta 2 Release is available for download. This release offers several bug fixes, a few performance improvements, and addressed all outstanding issues from a security audit of the code.
 
−
* [30 Sep 2013] 1.0 Beta 1 Release is available for download.  This release offers the first version with all of the functionality for a minimum viable product.   
 
−
 
 
 
|}
 
|}
  
 
=FAQs=
 
=FAQs=
  
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+
==What does Glue do?==
−
<span style="color:#ff0000">
+
The OWASP Glue tool attempts to make it very easy to run different types of security tools at various stages of the software development process and produce unified issues that can be used in other contexts to track or remediate issues.
−
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>
+
==Why would I use Glue?==
 +
To help get security feedback into your developers hands faster.
  
 
==How can I participate in your project?==
 
==How can I participate in your project?==
−
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.  
+
Reach out to [email protected] with any questions or ideas or ideas about how to participate.  We are welcoming input.  We are following standard github workflow so you can fork the code and submit a pull request if you prefer. Alternatively, you can get more deeply involved and talk with us about roadmap and other items. And finally, you are always invited to our Slack channel.
  
 
==If I am not a programmer can I participate in your project?==
 
==If I am not a programmer can I participate in your project?==
Line 81: Line 73:
 
==Contributors==
 
==Contributors==
  
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+
To this point, project contributors include:
−
<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].
+
* [https://www.owasp.org/index.php/User:Matt_Konda Matt Konda]
−
 
+
* Rafael Zambrano
−
The first contributors to the project were:
+
* Alex Lock
−
 
+
* Omer Levi Hevroni
−
* [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 =
 
= Road Map and Getting Involved =
  
−
Deliverable: Pipeline will be a ruby gem (executable binary).
+
Deliverable: Glue is delivered as a ruby gem (executable binary) and in a docker image with required tools already bundled.
−
 
 
−
Pipeline currently pulls from github or a specified location on the file system and runs brakeman, bundler-audit and owasp-dependency-check on the code.  It standardizes the format of results then reports them in text, csv, json or via JIRA's REST API.  It can detect duplicates and won't resport the same thing more than once.
 
−
 
 
−
Future plans include:
 
−
* Closing items in JIRA when fixed.
 
−
* Supporting ZAP scanning.
 
−
* Supporting running additional code analysis tools.
 
−
* Supporting additional live analysis tools.
 
−
* Deploying in a docker container.
 
−
 
 
−
<!-- 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>
 
  
 
==Roadmap==
 
==Roadmap==
−
As of <strong>November, 2013, the highest priorities for the next 6 months</strong> are:
+
Allows extending the tool more without changing code. Currently, it’s possible to integrate new tools without changing code, in the future we would like to add a similar support for reports and filters. Check out the open issues on GitHub. This is what we hope to achieve in future releases.
−
<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==
 
==Getting Involved==
−
Involvement in the development and promotion of <strong>Tool Project Template</strong> is actively encouraged!
+
Involvement in the development and promotion of <strong>Glue</strong> is actively encouraged!
 
You do not have to be a security expert or a programmer to contribute.
 
You do not have to be a security expert or a programmer to contribute.
 
Some of the ways you can help are as follows:
 
Some of the ways you can help are as follows:
  
 
===Coding===
 
===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
+
We could implement some of the later items on the roadmap sooner if someone wanted to help out with a unit or automated regression tests
 
===Localization===
 
===Localization===
 
Are you fluent in another language? Can you help translate the text strings in the <strong>Tool Project Template</strong> into that language?
 
Are you fluent in another language? Can you help translate the text strings in the <strong>Tool Project Template</strong> into that language?
 
===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 your help.
 
===Feedback===
 
===Feedback===
 
Please use the [https://lists.owasp.org/mailman/listinfo/OWASP_Tool_Project_Template Tool Project Template project mailing list] for feedback about:
 
Please use the [https://lists.owasp.org/mailman/listinfo/OWASP_Tool_Project_Template Tool Project Template project mailing list] for feedback about:
Line 149: Line 105:
 
<li>What features would you like to see prioritized on the roadmap?</li>
 
<li>What features would you like to see prioritized on the roadmap?</li>
 
</ul>
 
</ul>
−
 
+
Alternativly, you can also use our Slack channel on OWASP slack.
 
=Minimum Viable Product=
 
=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.
+
== Pipeline needs ==
 +
1.  Pull from github or a specified location on the file system
 +
2.  Run tools like brakeman, bundler-audit and owasp-dependency-check on the code. 
 +
3.  Standardizes the format of results then reports them in text, csv, json or via JIRA's REST API. 
 +
4.  Detect duplicates and won't report the same thing more than once.
  
−
It would also be ideal if the sample text was translated into different languages.
+
It also needs to be easy to set up the security tools and digest results.  Hence a focus on docker.
  
 
=Project About=
 
=Project About=
−
<!-- 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 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}}
+
Detail around this project can be found at: https://github.com/owasp/github
  
 
__NOTOC__ <headertabs />  
 
__NOTOC__ <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]]

Latest revision as of 03:49, 7 December 2018

OWASP Project Header.jpg

OWASP Glue Tool Project

The OWASP Glue Tool Project is a tools based project intended to make security automation easier. It is essentially a ruby gem that co-ordinates the running of different analysis tools and reporting from those tools.

Description

The purpose of the project is to make it easy to integrate security tools (like static or dynamic analysis) into the CI/CD pipeline.

Licensing

Apache 2.0 License

This program is free software: you can redistribute it and/or modify it under the terms of the link Apache 2.0 License as published by the Apache Software Foundation. Any contributions are Copyright © by OWASP 2015.

Project Resources

Source Code

Project Leader

Matt Konda

Omer Levi Hevroni

Related Projects

Classifications

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

News and Events

  • [6 Sep 2018] 0.10.0
  • [2 Jan 2016] 0.8.0
  • [27 Aug 2015] Initial Release.
  • [14 Sep 2016] Renamed to Glue from Pipeline.

What does Glue do?

The OWASP Glue tool attempts to make it very easy to run different types of security tools at various stages of the software development process and produce unified issues that can be used in other contexts to track or remediate issues.

Why would I use Glue?

To help get security feedback into your developers hands faster.

How can I participate in your project?

Reach out to [email protected] with any questions or ideas or ideas about how to participate. We are welcoming input. We are following standard github workflow so you can fork the code and submit a pull request if you prefer. Alternatively, you can get more deeply involved and talk with us about roadmap and other items. And finally, you are always invited to our Slack channel.

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 researchers, writers, graphic designers, and a project administrator. See the Road Map and Getting Involved tab for more details.

Contributors

To this point, project contributors include:

  • Matt Konda
  • Rafael Zambrano
  • Alex Lock
  • Omer Levi Hevroni

Deliverable: Glue is delivered as a ruby gem (executable binary) and in a docker image with required tools already bundled.

Roadmap

Allows extending the tool more without changing code. Currently, it’s possible to integrate new tools without changing code, in the future we would like to add a similar support for reports and filters. Check out the open issues on GitHub. This is what we hope to achieve in future releases.

Getting Involved

Involvement in the development and promotion of Glue 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 a unit or automated regression tests

Localization

Are you fluent in another language? Can you help translate the text strings in the Tool Project Template 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 your help.

Feedback

Please use the Tool Project Template 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?

Alternativly, you can also use our Slack channel on OWASP slack.

Pipeline needs

1. Pull from github or a specified location on the file system 2. Run tools like brakeman, bundler-audit and owasp-dependency-check on the code. 3. Standardizes the format of results then reports them in text, csv, json or via JIRA's REST API. 4. Detect duplicates and won't report the same thing more than once.

It also needs to be easy to set up the security tools and digest results. Hence a focus on docker.

Detail around this project can be found at: https://github.com/owasp/github

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