Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix doc headings in security.rst #34

Merged
merged 1 commit into from
May 2, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions doc/contribute/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Much of this document comes from the `CII best practices`_ document.
.. _CII best practices: https://github.com/linuxfoundation/cii-best-practices-badge

Introduction and Scope
======================
**********************

This document covers guidelines for the `Zephyr Project`_, from a
security perspective. Many of the ideas contained herein are captured
Expand Down Expand Up @@ -52,7 +52,7 @@ Finally, the document covers how changes are to be made to this
document.

Secure Coding Guidelines
========================
************************

Designing an open software system such as Zephyr to be secure requires
adhering to a defined set of design standards. In [SALT75]_, the following,
Expand Down Expand Up @@ -131,10 +131,10 @@ specific to the development of a secure RTOS:
shall be denied.

Secure development knowledge
============================
****************************

Secure designer
---------------
===============

The Zephyr project must have at least one primary developer who knows
how to design secure software.
Expand Down Expand Up @@ -186,7 +186,7 @@ including the 8 principles from `Saltzer and Schroeder`_:
values), not blacklists (which attempt to list known-bad values)).

Vulnerability Knowledge
-----------------------
=======================

A "primary developer" in a project is anyone who is familiar with the
project's code base, is comfortable making changes to it, and is
Expand Down Expand Up @@ -218,7 +218,7 @@ scripting, missing authentication, and missing authorization. See the
.. _OWASP Top 10: https://www.owasp.org/index.php/Category:OWASP_Top_Ten_Project

Security Subcommittee
---------------------
=====================

There shall be a “security subcommittee”, responsible for
enforcing this guideline, monitoring reviews, and improving these
Expand All @@ -227,7 +227,7 @@ guidelines.
This team will be established according to the Zephyr Project charter.

Code Review
===========
***********

The Zephyr project shall use a code review system that all changes are
required to go through. Each change shall be reviewed by at least one
Expand All @@ -240,7 +240,7 @@ shall have the ability to block the change from being merged into the
mainline code until the security issues have been addressed.

Issues and Bug Tracking
=======================
***********************

The Zephyr project shall have an issue tracking system (such as JIRA_)
that can be used to record and track defects that are found in the
Expand Down Expand Up @@ -270,7 +270,7 @@ the review team should avoid unnecessary delay in lifting issues that
have been resolved.

Modifications to This Document
==============================
******************************

Changes to this document shall be reviewed by the security committee,
and approved by consensus.
Expand Down