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"
(→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;" | | ||
| − | |||
| − | |||
| − | |||
| − | |||
==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/ | + | 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/ | + | [https://github.com/radicallyopensecurity/pentext sources] |
| − | [https://github.com/radicallyopensecurity/ | + | [https://github.com/radicallyopensecurity/pentext/tree/master/xml/doc] |
| − | [https://github.com/radicallyopensecurity/ | + | [https://github.com/radicallyopensecurity/pentext/issues Issue Tracker] |
== Project Leader == | == Project Leader == | ||
| − | This project is managed by Radically Open Security members | + | 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 | + | 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== | ||
| − | + | 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]. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | The | ||
The first contributors to the project were: | 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. |
= Road Map and Getting Involved = | = Road Map and Getting Involved = | ||
| − | + | ==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== | ==Getting Involved== | ||
| − | Involvement in the development and promotion of <strong> | + | 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=== | ||
| − | + | Suggestions on the the XSLT side are welcome! | |
===Localization=== | ===Localization=== | ||
| − | Are you fluent in another language? Can you help translate the | + | 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 | + | Please [mailto:info@pentext.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> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
__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
IntroductionThe 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. DescriptionThe 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 informationThe 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. LicensingAll 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 ResourcesProject LeaderThis project is managed by Radically Open Security members Patricia Piolon and Peter Mosmans. They can be reached at [email protected]. Classifications
News and Events
|
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?
