Skip to content

Commit e05a180

Browse files
committed
Fix review findings
1 parent 7a98f99 commit e05a180

13 files changed

Lines changed: 173 additions & 40 deletions

File tree

process/folder_templates/features/feature_name/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,3 +185,4 @@ Footnotes
185185
safety_analysis/fmea.rst
186186
safety_analysis/dfa.rst
187187
safety_planning/index.rst
188+
security_planning/index.rst
Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2025 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
.. _feature_security_wp_template:
16+
17+
Feature Security Work Products List
18+
###################################
19+
20+
.. document:: [Your Feature Name] Security WPs
21+
:id: doc__feature_name_security_wp
22+
:status: draft
23+
:safety: ASIL_B
24+
:security: YES
25+
:realizes: wp__platform_security_plan
26+
:tags: template
27+
28+
.. attention::
29+
The above directive must be updated according to your Feature.
30+
31+
- Modify ``Your Feature Name`` to be your Feature Name
32+
- Modify ``id`` to be your Module Name in upper snake case preceded by ``doc__`` and succeeded by ``_security_wp``
33+
- Adjust ``status`` to be ``valid``
34+
- Adjust ``safety`` and ``tags`` according to your needs
35+
36+
Tailoring
37+
=========
38+
39+
Additional to the tailoring in the SW platform project as defined in the project's :need:`wp__platform_security_plan` we define here the additional tailoring on feature level.
40+
41+
- Excluded for this feature are additionally the following work products (and their related requirements):
42+
43+
- <work product/requirement> - <Argumentation why it is not needed or replaced by another work product or activity.>
44+
45+
46+
Security Work products List
47+
===========================
48+
49+
.. list-table:: Feature <feature_name> Work products
50+
:header-rows: 1
51+
52+
* - Work product Id
53+
- Link to process
54+
- Process status
55+
- Link to WP
56+
57+
* - :need:`wp__feat_request`
58+
- :need:`gd_temp__change_feature_request`
59+
- :ndf:`copy('status', need_id='gd_temp__change_feature_request')`
60+
- :need:`doc__feature_name`
61+
62+
* - :need:`wp__requirements_feat`
63+
- :need:`gd_temp__req_feat_req`
64+
- :ndf:`copy('status', need_id='gd_temp__req_feat_req')`
65+
- :need:`doc__feature_name_requirements`
66+
67+
* - :need:`wp__requirements_feat_aou`
68+
- :need:`gd_temp__req_aou_req`
69+
- :ndf:`copy('status', need_id='gd_temp__req_aou_req')`
70+
- :need:`doc__feature_name_requirements`
71+
72+
* - :need:`wp__feature_arch`
73+
- :need:`gd_temp__arch_feature`
74+
- :ndf:`copy('status', need_id='gd_temp__arch_feature')`
75+
- :need:`doc__feature_name_architecture`
76+
77+
* - :need:`wp__requirements_inspect`
78+
- :need:`gd_chklst__req_inspection`
79+
- :ndf:`copy('status', need_id='gd_chklst__req_inspection')`
80+
- :need:`doc__feature_name_req_inspection`
81+
82+
* - :need:`wp__sw_arch_verification`
83+
- :need:`gd_chklst__arch_inspection_checklist`
84+
- :ndf:`copy('status', need_id='gd_chklst__arch_inspection_checklist')`
85+
- :need:`doc__feature_name_arc_inspection`
86+
87+
* - :need:`wp__verification_feat_int_test`
88+
- :need:`gd_guidl__verification_guide`
89+
- :ndf:`copy('status', need_id='gd_guidl__verification_guide')`
90+
- <Link to WP>
91+
92+
.. attention::
93+
The above table must be updated according to your feature security planning.
94+
95+
- Fill the work producs links
96+
97+
Feature Security Package
98+
========================
99+
100+
To create the security package (according to :need:`gd_guidl__security_package`) the following
101+
documents and work products status have to go to "valid" (after the relevant verification were performed).
102+
103+
Feature Documents Status
104+
------------------------
105+
106+
For all the work product documents the status can be seen by following the "Link to WP".
107+
A summary of the status is also documented in the project's documentation management plan.
108+
109+
See <add here the section reference to the documentation management plan>
110+
111+
Feature Requirements Status
112+
---------------------------
113+
114+
.. needtable::
115+
:filter: "feature_name" in docname and "requirements" in docname and docname is not None
116+
:style: table
117+
:types: feat_req
118+
:tags: feature_name
119+
:columns: id;status
120+
:colwidths: 25,25
121+
:sort: title
122+
123+
Feature AoU Status
124+
------------------
125+
126+
.. needtable::
127+
:filter: "feature_name" in docname and "requirements" in docname and docname is not None
128+
:style: table
129+
:types: aou_req
130+
:tags: feature_name
131+
:columns: id;status
132+
:colwidths: 25,25
133+
:sort: title
134+
135+
Feature Architecture Status
136+
---------------------------
137+
138+
.. needtable::
139+
:filter: "feature_name" in docname and "architecture" in docname and docname is not None
140+
:style: table
141+
:types: feat_arc_sta; feat_arc_dyn
142+
:tags: feature_name
143+
:columns: id;status
144+
:colwidths: 25,25
145+
:sort: title

process/process_areas/process_management/process_management_concept.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,13 @@ Stakeholders for the Process Management
6262

6363
* Supports all activities
6464

65-
#. :need:`External Auditor <rl__external_auditor>`
65+
#. :need:`Safety External Auditor <rl__safety_external_auditor>`
6666

67-
* Supports all activities, especially during iterative audits
67+
* Supports all safety activities, especially during iterative audits
68+
69+
#. :need:`Security External Auditor <rl__security_external_auditor>`
70+
71+
* Supports all security activities, especially during iterative audits
6872

6973
Standard Requirements
7074
=====================
@@ -121,7 +125,7 @@ using standard pull requests.
121125

122126
Process Description are approved by the :need:`rl__process_community`.
123127

124-
Regular audits supported by :need:`rl__external_auditor` ensure compliance with
128+
Regular audits supported by :need:`rl__safety_external_auditor` and :need:`rl__security_external_auditor` ensure compliance with
125129
existing standards.
126130

127131
.. _pm_mc_process:

process/process_areas/process_management/process_management_roles.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ Contributing Roles:
2121

2222
* :need:`Contributor <rl__contributor>`
2323
* :need:`Process Community <rl__process_community>`
24-
* :need:`External Auditor <rl__external_auditor>`
24+
* :need:`Safety External Auditor <rl__safety_external_auditor>`
25+
* :need:`Security External Auditor <rl__security_external_auditor>`
2526
* :need:`Project Lead <rl__project_lead>`
2627

2728
A detailed overview of the responsibility for the steps of the requirement process is listed here:

process/process_areas/process_management/process_management_workflow.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ For a detailed explanation of workflows and their role within the process model,
2424
:status: valid
2525
:responsible: rl__contributor
2626
:approved_by: rl__process_community
27-
:supported_by: rl__external_auditor, rl__project_lead
27+
:supported_by: rl__safety_external_auditor, rl__security_external_auditor, rl__project_lead
2828
:input: wp__policies, wp__issue_track_system
2929
:output: wp__process_strategy, wp__policies
3030
:contains: gd_guidl__process_management, gd_temp__process_workflow
@@ -38,7 +38,7 @@ For a detailed explanation of workflows and their role within the process model,
3838
:status: valid
3939
:responsible: rl__contributor
4040
:approved_by: rl__process_community
41-
:supported_by: rl__external_auditor, rl__project_lead
41+
:supported_by: rl__safety_external_auditor, rl__security_external_auditor, rl__project_lead
4242
:input: wp__process_strategy, wp__issue_track_system
4343
:output: wp__process_description, wp__tailoring_work_products
4444
:contains: gd_guidl__process_management, gd_temp__process_workflow
@@ -51,7 +51,7 @@ For a detailed explanation of workflows and their role within the process model,
5151
:status: valid
5252
:responsible: rl__contributor
5353
:approved_by: rl__process_community
54-
:supported_by: rl__external_auditor, rl__project_lead
54+
:supported_by: rl__safety_external_auditor, rl__security_external_auditor, rl__project_lead
5555
:input: wp__process_description
5656
:output: wp__process_impr_report, wp__issue_track_system
5757
:contains: gd_guidl__process_management, gd_temp__process_workflow

process/process_areas/safety_management/safety_management_concept.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Stakeholders
7676

7777
* Supports activities
7878

79-
#. :need:`External Auditor <rl__external_auditor>`
79+
#. :need:`Safety External Auditor <rl__safety_external_auditor>`
8080

8181
* Perform Safety Audit as independent safety audits
8282
* Verifies compliance with defined safety processes and standards.

process/process_areas/safety_management/safety_management_roles.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ Roles
6969
* Refusing the approval of work products as defined in the workflows
7070
* Refusing the approval of his team's role nomination (i.e. requesting that the role will be withdrawn)
7171

72-
.. role:: External Auditor
73-
:id: rl__external_auditor
72+
.. role:: Safety External Auditor
73+
:id: rl__safety_external_auditor
7474
:status: valid
7575

7676
Required skills, Knowledge of standards, Experience

process/process_areas/safety_management/safety_management_workflow.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Safety Management Workflows
6262
.. workflow:: Perform Safety Audit
6363
:id: wf__p_fs_audit
6464
:status: valid
65-
:responsible: rl__external_auditor
65+
:responsible: rl__safety_external_auditor
6666
:approved_by: rl__safety_manager
6767
:input: wp__module_safety_plan, wp__platform_safety_plan, wp__module_safety_package, wp__platform_safety_package
6868
:output: wp__audit_report

process/process_areas/security_management/guidance/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ Guidance
2121
security_management_guideline
2222
security_plan_templates
2323
security_manual_templates
24-
security_management_feature_security_wp_template
2524
checklist_security_package
2625
checklist_security_plan
2726
security_management_process_reqs

process/process_areas/security_management/guidance/security_management_feature_security_wp_template.rst

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)