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"
(→Main) |
(→Description) |
||
| Line 10: | 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/templates/blob/master/xml/doc/Tools%20manual.md documentation page] on how to set up the environment. |
==Technical information== | ==Technical information== | ||
Revision as of 10:19, 21 July 2016
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 Deborah, Patricia and Peter. 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 researchers, writers, graphic designers, and a project administrator. See the Road Map and Getting Involved tab for more details.
Contributors
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.
The OWASP Tool Project Template is developed by a worldwide team of volunteers. A live update of project contributors is found here.
The first contributors to the project were:
- Colin Watson who created the OWASP Cornucopia project that the template was derived from
- 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
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.
Roadmap
As of November, 2013, the highest priorities for the next 6 months are:
- 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
Subsequent Releases will add
- Internationalization Support
- Additional Unit Tests
- Automated Regression tests
Getting Involved
Involvement in the development and promotion of Tool Project Template 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 Tool Project Template 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 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?
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.
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.
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
| PROJECT INFO What does this OWASP project offer you? |
RELEASE(S) INFO What releases are available for this project? | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| |||||||||||||||||||||||||||||||||||||||
