Skip to content

Commit 97ee53a

Browse files
dbkinderAnas Nashif
authored andcommitted
doc: fix doc headings in security.rst
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1 parent accc8eb commit 97ee53a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/contribute/security.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Much of this document comes from the `CII best practices`_ document.
2222
.. _CII best practices: https://github.com/linuxfoundation/cii-best-practices-badge
2323

2424
Introduction and Scope
25-
======================
25+
**********************
2626

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

5454
Secure Coding Guidelines
55-
========================
55+
************************
5656

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

133133
Secure development knowledge
134-
============================
134+
****************************
135135

136136
Secure designer
137-
---------------
137+
===============
138138

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

188188
Vulnerability Knowledge
189-
-----------------------
189+
=======================
190190

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

220220
Security Subcommittee
221-
---------------------
221+
=====================
222222

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

229229
Code Review
230-
===========
230+
***********
231231

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

242242
Issues and Bug Tracking
243-
=======================
243+
***********************
244244

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

272272
Modifications to This Document
273-
==============================
273+
******************************
274274

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

0 commit comments

Comments
 (0)