Difference between revisions of "OWASP Documentation Project Template"

Latest revision as of 17:25, 15 May 2019

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.

Project About

PROJECT INFO
What does this OWASP project offer you?

RELEASE(S) INFO
What releases are available for this project?

what	is this project?
Name: N/A
Purpose: N/A
License: N/A
who	is working on this project?
Project Leader(s): N/A
how	can you learn more?
Project Pamphlet: Not Yet Created
Project Presentation:
Mailing list: N/A
Project Roadmap: Not Yet Created
Key Contacts
Contact the GPC to contribute to this project Contact the GPC to review or sponsor this project

current release

pending
last reviewed release
pending

other releases

OWASP Documentation Project Template

This section should include an overview of what the project is, why the project was started, and what security issue is being addressed by the project deliverable. Some readers may be discouraged from looking further at the project if they do not understand the significance of the security concern that is being addressed, so provide enough context so the average reader will continue on with reading the description. You shouldn't assume the reader will understand the objective by providing security terminology, e.g. this project builds cryptographic algorithms, but should also endeavor to explain what they are used for.

The OWASP Documentation Template Project is a template designed to help Project Leaders create suitable project pages for OWASP Projects. By following the instructional text in red (and then deleting it) it should be easier to understand what information OWASP and the project users are looking for. And it's easy to get started by simply creating a new project from the appropriate project template.

Description

This is where you need to add your more robust project description. A project description should outline the purpose of the project, how it is used, and the value it provides to application security. Ideally, project descriptions should be written in such a way that there is no question what value the project provides to the software security community. This section will be seen and used in various places within the Projects Portal. Poorly written project descriptions therefore detract from a project’s visibility, so project leaders should ensure that the description is meaningful.

The Documentation Project Template is simply a sample project that was developed for instructional purposes that can be used to create default project pages for a Documentation project. After copying this template to your new project, all you have to do is follow the instructions in red, replace the sample text with text suited for your project, and then delete the sections in red. Doing so should make it clearer to both consumers of this project, as well as OWASP reviewers who are trying to determine if the project can be promoted to the next category. The information requested is also intended to help Project Leaders think about the roadmap and feature priorities, and give guidance to the reviews as a result of that effort.

Creating a new set of project pages from scratch can be a challenging task. By providing a sample layout, with instructional text and examples, the OWASP Documentation Project Template makes it easier for Project Leaders to create effective security projects and hence helps promote security.

Contextual custom dictionary builder with character substitution and word variations for pen-testers

Licensing

A project must be licensed under a community friendly or open source license. For more information on OWASP recommended licenses, please see OWASP Licenses. While OWASP does not promote any particular license over another, the vast majority of projects have chosen a Creative Commons license variant for documentation projects, or a GNU General Public License variant for tools and code projects. This example assumes that you want to use the AGPL 3.0 license.

This program is free software: you can redistribute it and/or modify it under the terms of the link GNU Affero General Public License 3.0 as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. OWASP XXX and any contributions are Copyright © by {the Project Leader(s) or OWASP} {Year(s)}.

Roadmap

As of November, 2013, the highest priorities for the next 6 months are:

Complete the first draft of the Documentation Project Template

Get other people to review the Documentation Project Template and provide feedback

Incorporate feedback into changes in the Documentation Project Template

Finalize the Documentation 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 Documentation 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:

Project Resources

This is where you can link to the key locations for project files, including setup programs, the source code repository, online documentation, a Wiki Home Page, threaded discussions about the project, and Issue Tracking system, etc.

Installation Package

Source Code

What's New (Revision History)

Project Leader

A project leader is the individual who decides to lead the project throughout its lifecycle. The project leader is responsible for communicating the project’s progress to the OWASP Foundation, and he/she is ultimately responsible for the project’s deliverables. The project leader must provide OWASP with his/her real name and contact e-mail address for his/her project application to be accepted, as OWASP prides itself on the openness of its products, operations, and members.

Leader's Name

Related Projects

This is where you can link to other OWASP Projects that are similar to yours.

Classifications

Difference between revisions of "OWASP Documentation Project Template"

Latest revision as of 17:25, 15 May 2019

Project About

OWASP Documentation Project Template

Description

Licensing

Roadmap

Getting Involved

Project Resources

Project Leader

Related Projects

Classifications

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Reference

Tools

@@ Line 1: / Line 1: @@
-=Main=
-<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE -->
 <div style="width:100%;height:160px;border:0,margin:0;overflow: hidden;">[[File:OWASP_Project_Header.jpg|link=]]</div>
-<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE -->
 {| style="padding: 0;margin:0;margin-top:10px;text-align:left;" |-
 | valign="top"  style="border-right: 1px dotted gray;padding-right:25px;" |
-<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 <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.
+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>
+==Project About==
+<span style="color:#ff0000">
+{{:Template:Project About
+   |project_name=
+   |leader_name1=
+   |leader_email1=
+}}
-==The OWASP Security Principles==
-<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+==OWASP Documentation Project Template==
 <span style="color:#ff0000">
-	This is where you need to add your more robust project description. A project description should outline the purpose of the project, and the value it provides to application security. Ideally, project descriptions should be written in such a way that there is no question what value the project provides to the software security community. This section will be seen and used in various places within the Projects Portal. Poorly written project descriptions therefore detract from a project’s visibility, and project leaders should ensure that the description is meaningful.
+	This section should include an overview of what the project is, why the project was started, and what security issue is being addressed by the project deliverable. Some readers may be discouraged from looking further at the project if they do not understand the significance of the security concern that is being addressed, so provide enough context so the average reader will continue on with reading the description. You shouldn't assume the reader will understand the objective by providing security terminology, e.g. this project builds cryptographic algorithms, but should also endeavor to explain what they are used for.
 </span>
-Inevitably applications are designed with security principles architects knew about, security folks included. However, as this project demonstrates there are far more than just a 'few' principles, most of which never make it into the design.
+The OWASP Documentation Template Project is a template designed to help Project Leaders create suitable project pages for OWASP Projects.  By following the instructional text in red (and then deleting it) it should be easier to understand what information OWASP and the project users are looking for.  And it's easy to get started by simply creating a new project from the appropriate project template.
-For example, security design happens with perhaps a handful of principles:
-* Least Privilege
-* Perimeter Security
-* Defence in Depth
-However, we regularly see designs without '''separation of privilege'''!
-Think about that, most web applications today have all their eggs in a single basket. The business logic, the identities, passwords, products, policy enforcement, security rules are all found in the same application database that makes up the typical website! It is little wonder then, that attacks on the database have been so completely devastating, since there is no separation of privilege!
-The aim of this project, is to identify and describe a minimum functional set of principles that must be present in a secure design.
 ==Description==
-<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 <span style="color:#ff0000">
-	This section must include a shorter description of what the project is, why the project was started, and what security issue is being helped by the project deliverable. This description will be used to promote the project so make sure the description represents your project in the best way possible.
+	This is where you need to add your more robust project description. A project description should outline the purpose of the project, how it is used, and the value it provides to application security. Ideally, project descriptions should be written in such a way that there is no question what value the project provides to the software security community. This section will be seen and used in various places within the Projects Portal. Poorly written project descriptions therefore detract from a project’s visibility, so project leaders should ensure that the description is meaningful.
 </span>
-'''Although this is a sample template, the project is real! [http://owasp.github.io/Security-Principles Please contribute to this project.]
+The Documentation Project Template is simply a sample project that was developed for instructional purposes that can be used to create default project pages for a Documentation project.  After copying this template to your new project, all you have to do is follow the instructions in red, replace the sample text with text suited for your project, and then delete the sections in red.  Doing so should make it clearer to both consumers of this project, as well as OWASP reviewers who are trying to determine if the project can be promoted to the next category.  The information requested is also intended to help Project Leaders think about the roadmap and feature priorities, and give guidance to the reviews as a result of that effort.
-'''
-Over the course of my career, I have come across and collected a number of security ''aphorisms.'' These aphorisms constitute the fundamental principles of information security.
-None of the ideas or truths are mine, and unfortunately, I did not collect the citations. Initially, I would like to identify the correct citations for each aphorism.
+Creating a new set of project pages from scratch can be a challenging task.  By providing a sample layout, with instructional text and examples, the OWASP Documentation Project Template makes it easier for Project Leaders to create effective security projects and hence helps promote security.
-Additionally, many are re-statements of the same idea; thus, the 'collection of ideas' defines a fundamental principle. As such, I would also like to reverse engineer the principles from the aphorisms where appropriate, as well.
+Contextual custom dictionary builder with character substitution and word variations for pen-testers
 ==Licensing==
-<!-- 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 must be licensed under a community friendly or open source license.  For more information on OWASP recommended licenses, please see [https://www.owasp.org/index.php/OWASP_Licenses OWASP Licenses]. While OWASP does not promote any particular license over another, the vast majority of projects have chosen a Creative Commons license variant for documentation projects, or a GNU General Public License variant for tools and code projects.
+A project must be licensed under a community friendly or open source license.  For more information on OWASP recommended licenses, please see [https://www.owasp.org/index.php/OWASP_Licenses OWASP Licenses]. While OWASP does not promote any particular license over another, the vast majority of projects have chosen a Creative Commons license variant for documentation projects, or a GNU General Public License variant for tools and code projects.  This example assumes that you want to use the AGPL 3.0 license.
 </span>
-'''The OWASP Security Principles are free to use. In fact it is encouraged!!!
+This program is free software: you can redistribute it and/or modify it under the terms of the [http://www.gnu.org/licenses/agpl-3.0.html link GNU Affero General Public License 3.0] as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.  OWASP XXX and any contributions are Copyright &copy; by {the Project Leader(s) or OWASP} {Year(s)}.
-'' Additionally, I also encourage you to contribute back to the project. I have no monopoly on this knowledge; however, we all have pieces of this knowledge from our experience. Let's begin by putting our individual pieces together to make something great. Great things happen when people work together.
-The OWASP Security Principles are licensed under the http://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-ShareAlike 3.0 license], so you can copy, distribute and transmit the work, and you can adapt it, and use it commercially, but all provided that you attribute the work and if you alter, transform, or build upon this work, you may distribute the resulting work only under the same or similar license to this one.
-<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE -->
+==Roadmap==
-| valign="top"  style="padding-left:25px;width:200px;border-right: 1px dotted gray;padding-right:25px;" |
-== What is OWASP Security Principles Project? ==
-<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 <span style="color:#ff0000">
-	Here you should add a short description of what your project actually does. What is the primary goal of your project, and why is it important?
+As of <strong>November, 2013, the highest priorities for the next 6 months</strong> are:
-</span>
+<strong>
+* Complete the first draft of the Documentation Project Template
+* Get other people to review the Documentation Project Template and provide feedback
+* Incorporate feedback into changes in the Documentation Project Template
+* Finalize the Documentation Project template and have it reviewed to be promoted from an Incubator Project to a Lab Project
+</strong>
-The end goal is to identify, cite, and document the fundamental principles of information security. Once this is well organised, I think it would be great to publish this through the [http://scriptogr.am/dennis-groves/post/owasp-press OWASP Press]. Of course, it will always remain freely available, and any money collected will go directly into the project to absorb costs with any remaining funds going to the OWASP Foundation.
+Subsequent Releases will add
+<strong>
+* Internationalization Support
+* Additional Unit Tests
+* Automated Regression tests
+</strong>
-This document should serve as a guide to technical architects and designers outlining the fundamental principles of security.
+==Getting Involved==
-== Presentation ==
-<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 <span style="color:#ff0000">
-	This is where you can link to slide presentations related to your project.
+Involvement in the development and promotion of <strong>Documentation Project Template</strong> is actively encouraged!
-</span>
+You do not have to be a security expert or a programmer to contribute.
+Some of the ways you can help are as follows:
+| valign="top"  style="padding-left:25px;width:200px;border-right: 1px dotted gray;padding-right:25px;" |
-AppSec USA 2013 [https://github.com/OWASP/Security-Principles/tree/master/Presentations/AppSec%20NYC%202013]
+== Project Resources ==
-== Project Leader ==
-<!-- 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 leader is the individual who decides to lead the project throughout its lifecycle. The project leader is responsible for communicating the project’s progress to the OWASP Foundation, and he/she is ultimately responsible for the project’s deliverables. The project leader must provide OWASP with his/her real name and contact e-mail address for his/her project application to be accepted, as OWASP prides itself on the openness of its products, operations, and members.
+	This is where you can link to the key locations for project files, including setup programs, the source code repository, online documentation, a Wiki Home Page, threaded discussions about the project, and Issue Tracking system, etc.
 </span>
-* [https://www.owasp.org/index.php/User:Dennis_Groves Dennis Groves]
+[https://github.com/SamanthaGroves Installation Package]
-== Related Projects ==
-<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
-<span style="color:#ff0000">
-	This is where you can link to other OWASP Projects that are similar to yours.
-</span>
-* [[OWASP_CISO_Survey]]
+[https://github.com/SamanthaGroves Source Code]
-<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE -->
+[https://github.com/SamanthaGroves What's New (Revision History)]
-| valign="top"  style="padding-left:25px;width:200px;" |
-== Quick Download ==
+[https://github.com/SamanthaGroves Documentation]
-<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+[https://github.com/SamanthaGroves Wiki Home Page]
-<span style="color:#ff0000">
-	This is where you can link to your repository.
-</span>
-The home of the OWASP Security Principles is on [https://github.com/OWASP/Security-Principles GitHub.] You are encourged to fork, edit and push your changes back to the project through git or edit the project directly on github.
+[https://github.com/SamanthaGroves Issue Tracker]
-However, if you like you may also download the master repository from the following links:
+[https://github.com/SamanthaGroves Slide Presentation]
-* [https://github.com/OWASP/Security-Principles/zipball/master .zip file.]
-* [https://github.com/OWASP/Security-Principles/tarball/master .tgz file.]
-== News and Events ==
+[https://github.com/SamanthaGroves Video]
-<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+== Project Leader ==
 <span style="color:#ff0000">
-	This is where you can link to press your project has been a part of. Appropriate press includes: Project Leader interviews, articles written about your project, and videos about your project.
+	A project leader is the individual who decides to lead the project throughout its lifecycle. The project leader is responsible for communicating the project’s progress to the OWASP Foundation, and he/she is ultimately responsible for the project’s deliverables. The project leader must provide OWASP with his/her real name and contact e-mail address for his/her project application to be accepted, as OWASP prides itself on the openness of its products, operations, and members.
 </span>
-* [20 Nov 2013] News 2
+[mailto://[email protected] Leader's Name]
-* [30 Sep 2013] News 1
-== In Print ==
+== Related Projects ==
-<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 <span style="color:#ff0000">
-	This is where you place links to where your project product can be downloaded or purchased, in the case of a book.
+	This is where you can link to other OWASP Projects that are similar to yours.
 </span>
+* [[OWASP_Code_Project_Template]]
-This project can be purchased as a print on demand book from Lulu.com
+* [[OWASP_Tool_Project_Template]]
 ==Classifications==
-<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
-<span style="color:#ff0000">
-	Here is where you can let the community know what project stage your project is currently in, whether the project is a builder, breaker, or defender project, and what type of project you are running.
-</span>
     {| width="200" cellpadding="2"
     |-
-    | 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]]
+    | colspan="2" align="center"  | [[File:Project_Type_Files_DOC.jpg|link=https://www.owasp.org/index.php/Category:OWASP_Document]]
-   | align="center" valign="top" width="50%"| [[File:Owasp-builders-small.png|link=]]
     |-
-    | align="center" valign="top" width="50%"| [[File:Owasp-defenders-small.png|link=]]
+   | 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]]
+    | align="center" valign="top" width="50%"| [[File:Owasp-builders-small.png|link=Builders]]
     |-
-    | colspan="2" align="center"  | [[File:Cc-button-y-sa-small.png|link=http://creativecommons.org/licenses/by-sa/3.0/]]
+    | align="center" valign="top" width="50%"| [[File:Owasp-defenders-small.png|link=Defenders]]
     |-
-    | colspan="2" align="center"  | [[File:Project_Type_Files_DOC.jpg|link=]]
+    | colspan="2" align="center"  | [[Image:Creative%20Commons.png| 90px | link=https://creativecommons.org/licenses/by-sa/3.0/| Creative Commons Attribution ShareAlike 3.0 License]]
     |}
 |}
-=FAQs=
-<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
-<span style="color:#ff0000">
-	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?==
-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.
-= Acknowledgements =
-==Contributors==
-<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
-<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 Security Principles project 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:Dennis_Groves Dennis Groves]
-* [https://github.com/sublimino Andrew Martin]
-* [https://github.com/Lambdanaut Josh Thomas]
-* [https://github.com/SamanthaGroves Samantha Groves]
-* '''YOUR NAME BELONGS HERE'''
-= 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. 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.
-</span>
-<span style="color:#ff0000">
-	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>
-As of October 2013, the priorities are:
-* Finish the referencing for each principle.
-* Update the Project Template.
-* Use the OWASP Press to develop a book.
-* Finish and publish the book on Lulu.
-Involvement in the development and promotion of the OWASP Security Principles Project is actively encouraged!
-You do not have to be a security expert in order to contribute.
-Some of the ways you can help:
-* Helping find references to some of the principles.
-* Project administration support.
-* Wiki editing support.
-* Writing support for the book.
-=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}}
-<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE -->
 __NOTOC__ <headertabs />
-[[Category:OWASP Project]]  [[Category:OWASP_Builders]] [[Category:OWASP_Defenders]]  [[Category:OWASP_Document]]
+[[Category:OWASP Project]] [[Category:OWASP_Document]]