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

From OWASP
Jump to: navigation, search
(News and Events)
m (Correct grammar, update names and timeline)
 
(19 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
{| 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;" |
 
<span style="color:#ff0000">
 
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.
 
</span>
 
  
 
==Introduction==
 
==Introduction==
Line 14: Line 10:
  
 
==Description==
 
==Description==
The OWASP PenText XML documentation project can help your software security company produce offers, reports, invoices and generic documents by offering a well-structured and easy to maintain documenting system you can modify to your liking. The XML content can be easily adapted by editing the constants provided in each document. Both reports and offers are comprised of smaller snippets, i.e. template texts containing, respectively, offerte text or common vulnerabilities, which can be included where relevant. The XSLT can be customized by anyone versed in XSLT. To get started it is neccessary to install a few Open Source tools. Please visit our [https://github.com/radicallyopensecurity/templates/blob/master/xml/doc/Tools%20manual.md documentation page] on how to set up the environment.
+
The OWASP PenText XML documentation project can help your software security company produce offers, reports, invoices and generic documents by offering a well-structured and easy to maintain documenting system you can modify to your liking. The XML content is multilingual (current languages: English and Dutch) and can be easily adapted - by editing the constants provided in each document - or expanded - by creating new files. Both reports and offers are comprised of smaller snippets, i.e. template texts containing, respectively, offerte text or common vulnerabilities, which can be included where relevant. The XSLT can be customized by anyone versed in XSLT. To get started it is neccessary to install a few Open Source tools. Please visit our [https://github.com/radicallyopensecurity/pentext/blob/master/xml/doc/Tools%20manual.md documentation page] on how to set up the environment.
  
 
==Technical information==
 
==Technical information==
The OWASP PenText project is based on XML. A PenText Report, Offer, Invoice or Generic Document is in fact a (modular) XML document, conforming to an XML Schema. The XML Schema ensures that the documents are structured correctly, so that they can then be transformed into other formats using XSLT and the SAXON XSLT processor.  
+
The OWASP PenText project is based on XML. A PenText Report, Offer, Invoice or Generic Document is in fact a (modular) XML document, conforming to an XML Schema. The XML Schema ensures that the documents are structured correctly, so that they can then be transformed into other formats using XSLT and the [http://saxon.sourceforge.net/#F9.7HE SAXON XSLT processor].  
Currently there is only one target format: PDF. To produce the PDF document, the report, offer, invoice or generic document XML is first transformed into XSL-FO (XSL Formatting Objects), which is then converted to PDF using Apache FOP.
+
Currently there is only one target format: PDF. To produce the PDF document, the report, offer, invoice or generic document XML is first transformed into XSL-FO (XSL Formatting Objects), which is then converted to PDF using [https://xmlgraphics.apache.org/fop/ Apache FOP].
  
 
==Licensing==
 
==Licensing==
Line 25: Line 21:
 
== Project Resources ==
 
== Project Resources ==
  
[https://github.com/radicallyopensecurity/templates Sources]
+
[https://github.com/radicallyopensecurity/pentext sources]
  
[https://github.com/radicallyopensecurity/templates/tree/master/xml/doc Documentation]
+
[https://github.com/radicallyopensecurity/pentext/tree/master/xml/doc]
  
[https://github.com/radicallyopensecurity/templates/issues Issue Tracker]
+
[https://github.com/radicallyopensecurity/pentext/issues Issue Tracker]
  
 
== Project Leader ==
 
== Project Leader ==
This project is managed by Radically Open Security members Deborah, Patricia and Peter. They can be reached at [mailto:[email protected] [email protected]].
+
This project is managed by Radically Open Security members Patricia Piolon and Peter Mosmans. They can be reached at [mailto:[email protected] [email protected]].
  
 
==Classifications==
 
==Classifications==
Line 57: Line 53:
  
 
==If I am not a programmer can I participate in your project?==
 
==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.
+
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 writers and translators. See the Road Map and Getting Involved tab for more details.
  
 
= Acknowledgements =
 
= Acknowledgements =
 
==Contributors==
 
==Contributors==
  
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+
The Pentext XML Documentation Project is developed by a worldwide team working at [https://www.radicallyopensecurity.com Radically Open Security]. A live update of project [https://github.com/radicallyopensecurity/pentext/graphs/contributors contributors can be found here].  
<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:
 
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
+
* XSLT coding and documentation by Patricia Piolon
* [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
+
* ChatOps scripts by Peter Mosmans and John
* '''YOUR NAME BELONGS HERE AND YOU SHOULD REMOVE THE PRIOR 3 NAMES'''
+
* XML content by Peter Mosmans, Christine, Deborah, Marcus Bointon and others.
  
 
= Road Map and Getting Involved =
 
= Road Map and Getting Involved =
  
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+
==Roadmap==
<span style="color:#ff0000">
+
As of '''October 2017, the highest priorities for the next 6 months are''':
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.
+
* Create additional content for Forensics, code audits and such
</span>
+
* Get other people to review the PenText XML documentation project and provide feedback
 +
* Get others to provide translations for the snippet library
  
==Roadmap==
+
Subsequent Releases would preferably contain
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
+
* Templates in a wider variety of languages
<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 the <strong>PenText XML documentation project</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
+
Suggestions on the the XSLT side are welcome!
 
===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 snippets and strings in the <strong>PenText XML documentation project</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 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===
 
===Feedback===
Please use the [https://lists.owasp.org/mailman/listinfo/OWASP_Tool_Project_Template Tool Project Template project mailing list] for feedback about:
+
Please [mailto:[email protected].org mail us] for feedback:
 
<ul>
 
<ul>
<li>What do like?</li>
+
<li>What do you like?</li>
 
<li>What don't you like?</li>
 
<li>What don't you like?</li>
 
<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>
  
=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=
 
<!-- 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}}
 
  
 
__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 23:17, 15 October 2017

OWASP Project Header.jpg

Introduction

The OWASP PenText XML documentation project is a collection of XML templates, XML schemas and XSLT code, which combined provide an easy way to generate IT security documents including test reports (for penetration tests, load tests, code audits, etc), offers (to companies requesting these tests) and invoices.

Description

The OWASP PenText XML documentation project can help your software security company produce offers, reports, invoices and generic documents by offering a well-structured and easy to maintain documenting system you can modify to your liking. The XML content is multilingual (current languages: English and Dutch) and can be easily adapted - by editing the constants provided in each document - or expanded - by creating new files. Both reports and offers are comprised of smaller snippets, i.e. template texts containing, respectively, offerte text or common vulnerabilities, which can be included where relevant. The XSLT can be customized by anyone versed in XSLT. To get started it is neccessary to install a few Open Source tools. Please visit our documentation page on how to set up the environment.

Technical information

The OWASP PenText project is based on XML. A PenText Report, Offer, Invoice or Generic Document is in fact a (modular) XML document, conforming to an XML Schema. The XML Schema ensures that the documents are structured correctly, so that they can then be transformed into other formats using XSLT and the SAXON XSLT processor. Currently there is only one target format: PDF. To produce the PDF document, the report, offer, invoice or generic document XML is first transformed into XSL-FO (XSL Formatting Objects), which is then converted to PDF using Apache FOP.

Licensing

All files distributed with this project are free software: all documents are released under the GNU General Public License v3 (http://www.gnu.org/licenses/gpl.html) which allows you to modify and redistribute the files freely.

Project Resources

sources

[1]

Issue Tracker

Project Leader

This project is managed by Radically Open Security members Patricia Piolon and Peter Mosmans. They can be reached at [email protected].

Classifications

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

News and Events

  • [17 July 2016] Updated the wiki with basic info.
  • [21 July 2016] Expanded the wiki

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.

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 writers and translators. See the Road Map and Getting Involved tab for more details.

Contributors

The Pentext XML Documentation Project is developed by a worldwide team working at Radically Open Security. A live update of project contributors can be found here.

The first contributors to the project were:

  • XSLT coding and documentation by Patricia Piolon
  • ChatOps scripts by Peter Mosmans and John
  • XML content by Peter Mosmans, Christine, Deborah, Marcus Bointon and others.

Roadmap

As of October 2017, the highest priorities for the next 6 months are:

  • Create additional content for Forensics, code audits and such
  • Get other people to review the PenText XML documentation project and provide feedback
  • Get others to provide translations for the snippet library

Subsequent Releases would preferably contain

  • Templates in a wider variety of languages

Getting Involved

Involvement in the development and promotion of the PenText XML documentation project 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

Suggestions on the the XSLT side are welcome!

Localization

Are you fluent in another language? Can you help translate the snippets and strings in the PenText XML documentation project 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 mail us for feedback:

  • What do you like?
  • What don't you like?
  • What features would you like to see prioritized on the roadmap?