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 Documentation Project Template"

From OWASP
Jump to: navigation, search
(major updates / added instructions in red.)
 
(53 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
=Main=
 
−
 
 
<div style="width:100%;height:160px;border:0,margin:0;overflow: hidden;">[[File:OWASP_Project_Header.jpg|link=]]</div>
 
<div style="width:100%;height:160px;border:0,margin:0;overflow: hidden;">[[File:OWASP_Project_Header.jpg|link=]]</div>
  
Line 6: Line 4:
 
| valign="top"  style="border-right: 1px dotted gray;padding-right:25px;" |
 
| 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">
−
<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>
+
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 Securuty Principles==
 
  
−
<span style="color:#ff0000">A project name may include the OWASP name. If a project chooses to use the OWASP name, any project artifacts must clearly state the project’s current lifecycle designation. For example, this notice can be on the cover page (documentation), in an ‘About’ dialog (tools), in comment header blocks (code), or some other prominent location.
+
==OWASP Documentation Project Template==
 +
<span style="color:#ff0000">
 +
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>
 
</span>
  
−
'''Although this is a sample template, the project is real! [http://owasp.github.io/Security-Principles Please contribute to this project.]
+
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.
−
'''
 
  
−
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.
+
==Description==
 +
<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, 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>
  
−
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.
+
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.
  
−
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.
+
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.
  
−
==Introduction==
+
Contextual custom dictionary builder with character substitution and word variations for pen-testers
  
−
 
+
==Licensing==
−
 
+
<span style="color:#ff0000">
−
==Description==
+
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.
−
 
 
−
<!-- 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 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 the start of the description can be used as a teaser or an excerpt (as commonly done for news articles and blog postings). This teaser 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 teaser is concise and meaningful.
 
 
</span>
 
</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.
+
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)}.
  
−
For example, security design happens with perhaps a handful of principles:
+
==Roadmap==
 +
<span style="color:#ff0000">
 +
As of <strong>November, 2013, the highest priorities for the next 6 months</strong> are:
 +
<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>
  
−
* Least Privilege
+
Subsequent Releases will add
−
* Perimeter Security
+
<strong>
−
* Defence in Depth
+
* Internationalization Support
 +
* Additional Unit Tests
 +
* Automated Regression tests
 +
</strong>
  
−
However, we regularly see designs without '''separation of privilege'''!
+
==Getting Involved==
 +
<span style="color:#ff0000">
 +
Involvement in the development and promotion of <strong>Documentation Project Template</strong> 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:
  
−
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!
+
| valign="top"  style="padding-left:25px;width:200px;border-right: 1px dotted gray;padding-right:25px;" |
  
−
The aim of this project, is to identify and describe a minimum functional set of principles that must be present in a secure design.
+
== Project Resources ==
−
 
+
<span style="color:#ff0000">
−
==Licensing==
+
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>
−
The OWASP Security Principles are free to use. In fact it is encouraged!!!
 
−
 
 
−
I also strongly encourage you to participate and contribute. I have no monopoly on this knowledge; however, we all have pieces of this knowledge from our experience. Let's begin with putting our individual pieces together and make something great. Great things happen when people work together. :-)
 
  
−
Therefore 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.
+
[https://github.com/SamanthaGroves Installation Package]
  
−
| valign="top"  style="padding-left:25px;width:200px;border-right: 1px dotted gray;padding-right:25px;" |
+
[https://github.com/SamanthaGroves Source Code]
  
−
== What is OWASP Security Principles Project? ==
+
[https://github.com/SamanthaGroves What's New (Revision History)]
  
−
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 via 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.
+
[https://github.com/SamanthaGroves Documentation]
  
−
This document should serve as a guide to technical architects and designers outlining the fundamental principles of security.
+
[https://github.com/SamanthaGroves Wiki Home Page]
  
−
== Presentation ==
+
[https://github.com/SamanthaGroves Issue Tracker]
  
−
Link to presentation
+
[https://github.com/SamanthaGroves Slide Presentation]
  
 +
[https://github.com/SamanthaGroves Video]
  
 
== Project Leader ==
 
== 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">
 
<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.
+
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>
 
</span>
  
−
* [https://www.owasp.org/index.php/User:Dennis_Groves Dennis Groves]
+
[mailto://leader@owasp.org Leader's Name]
−
 
 
  
 
== Related Projects ==
 
== Related Projects ==
−
 
+
<span style="color:#ff0000">
−
* [[OWASP_CISO_Survey]]
+
This is where you can link to other OWASP Projects that are similar to yours.  
−
 
+
</span>
−
 
+
* [[OWASP_Code_Project_Template]]
−
 
+
* [[OWASP_Tool_Project_Template]]
−
| valign="top"  style="padding-left:25px;width:200px;" |
 
−
 
 
−
== Quick Download ==
 
−
 
 
−
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.
 
−
 
 
−
However, if you like you may also download the master repository from the following links:
 
−
* [https://github.com/OWASP/Security-Principles/zipball/master .zip file.]
 
−
* [https://github.com/OWASP/Security-Principles/tarball/master .tgz file.]
 
−
 
 
−
 
 
−
 
 
−
== News and Events ==
 
−
* [20 Nov 2013] News 2
 
−
* [30 Sep 2013] News 1
 
−
 
 
−
 
 
−
== In Print ==
 
−
This project can be purchased as a print on demand book from Lulu.com
 
−
 
 
  
 
==Classifications==
 
==Classifications==
Line 109: Line 105:
 
   {| width="200" cellpadding="2"
 
   {| 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%" 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]]   
 
   | 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:Cc-button-y-sa-small.png|link=http://creativecommons.org/licenses/by-sa/3.0/]]
+
   | 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]]
−
  |-
 
−
  | colspan="2" align="center"  | [[File:Project_Type_Files_DOC.jpg|link=]]  
 
 
   |}
 
   |}
−
 
 
|}
 
|}
−
 
+
   
−
=FAQs=
 
−
 
 
−
; Q1
 
−
: A1
 
−
 
 
−
; Q2
 
−
: A2
 
−
 
 
−
= Acknowledgements =
 
−
==Contributors==
 
−
 
 
−
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 have been:
 
−
 
 
−
* [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'''
 
−
 
 
−
==Others==
 
−
* xxx
 
−
* xxx
 
−
 
 
−
= 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.
 
−
</span>
 
−
 
 
−
As of XXX, the priorities are:
 
−
* xxx
 
−
* xxx
 
−
* xxx
 
−
 
 
−
Involvement in the development and promotion of XXX is actively encouraged!
 
−
You do not have to be a security expert in order to contribute.
 
−
Some of the ways you can help:
 
−
* xxx
 
−
* xxx
 
−
 
 
−
 
 
−
 
 
−
=Project About=
 
−
{{:Projects/OWASP_Example_Project_About_Page}}
 
−
 
 
 
__NOTOC__ <headertabs />  
 
__NOTOC__ <headertabs />  
  
−
[[Category:OWASP Project]] [[Category:OWASP_Builders]] [[Category:OWASP_Defenders]]  [[Category:OWASP_Document]]
+
[[Category:OWASP Project]] [[Category:OWASP_Document]]

Latest revision as of 17:25, 15 May 2019

OWASP Project Header.jpg

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)

Documentation

Wiki Home Page

Issue Tracker

Slide Presentation

Video

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

Project Type Files DOC.jpg
Incubator Project Owasp-builders-small.png
Owasp-defenders-small.png
Creative Commons Attribution ShareAlike 3.0 License

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