-
Notifications
You must be signed in to change notification settings - Fork 16
Update Security Management process #542
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,3 +19,4 @@ Manuals | |
| :titlesonly: | ||
|
|
||
| safety_manual | ||
| security_manual | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2025 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| Security Management | ||
| ################### | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| module_security_plan | ||
| module_security_plan_fdr | ||
| module_security_package_fdr |
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Topic, 8, Off-the-Shelf, compare Safety, there a Component Classification etc. exists, if we have these question here, we need to adapt the component classification and qualification also for security, it is currently not reflected in the security plan, either remove it here, tailor out or wee to consider that in the other documents and provide guidance how to do it |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2025 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
|
|
||
| Security Analysis Checklist | ||
| =========================== | ||
|
|
||
| .. document:: [Your Platform Name] Security Analysis Checklist | ||
| :id: doc__platform_name_security_analysis_fdr | ||
| :status: draft | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :realizes: wp__fdr_reports | ||
| :tags: template | ||
|
|
||
| .. attention:: | ||
| The above directive must be updated according to your Platform. | ||
|
|
||
| - Modify ``Your Platform Name`` to be your Platform Name | ||
| - Modify ``id`` to be your Platform Name in lower snake case preceded by ``doc__`` and followed by ``_security_analysis_fdr`` | ||
| - Adjust ``status`` to be ``valid`` | ||
| - Adjust ``safety``, ``security`` and ``tags`` according to your needs | ||
|
|
||
|
|
||
| **Purpose** | ||
| The purpose of this Security Analysis checklist template is to collect the topics to be checked during verification of the Security Analysis. | ||
|
|
||
| **Checklist** | ||
|
|
||
| To be filled as part of https://github.com/eclipse-score/process_description/issues/452. |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,92 @@ | ||||||
| .. | ||||||
| # ******************************************************************************* | ||||||
| # Copyright (c) 2025 Contributors to the Eclipse Foundation | ||||||
| # | ||||||
| # See the NOTICE file(s) distributed with this work for additional | ||||||
| # information regarding copyright ownership. | ||||||
| # | ||||||
| # This program and the accompanying materials are made available under the | ||||||
| # terms of the Apache License Version 2.0 which is available at | ||||||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||||||
| # | ||||||
| # SPDX-License-Identifier: Apache-2.0 | ||||||
| # ******************************************************************************* | ||||||
|
|
||||||
| Platform Security Manual | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nothing on platform, remove |
||||||
| ======================== | ||||||
|
|
||||||
| .. note:: Document header | ||||||
|
|
||||||
| .. document:: Platform Security Manual | ||||||
| :id: doc__platform_security_manual | ||||||
| :status: draft | ||||||
| :safety: ASIL_B | ||||||
| :security: YES | ||||||
| :realizes: wp__platform_security_manual | ||||||
| :tags: template | ||||||
|
|
||||||
| Introduction/Scope | ||||||
| ------------------ | ||||||
| .. note:: The platform Security Manual is only performed once at platform level to analyse the dependencies between the features of the platform. | ||||||
| The results shall be used as an input for the safety analysis so that general safety mechanisms are only defined once and not in every single safety analysis. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| Assumed Platform Security Requirements | ||||||
| -------------------------------------- | ||||||
| | For the <Project platform> the following security related stakeholder requirements are assumed to define the top level functionality (purpose) of the <Project platform / module name>. i.e. from these all the feature and component requirements implemented are derived. | ||||||
| | <List here all the stakeholder requirements, with security relevance, the module's components requirements are derived from.> | ||||||
|
|
||||||
| Assumptions of Use | ||||||
| ------------------ | ||||||
|
|
||||||
| Assumptions on the Environment | ||||||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||||||
| | Generally the assumption of the Project platform OoC is that it is integrated in a secure system, i.e. the POSIX OS it runs on is qualified and also the HW related failures are taken into account by the system integrator, if not otherwise stated in the module's security concept. | ||||||
| | <List here all the OS calls the Project platform expects to be secure.> | ||||||
|
|
||||||
| List of AoUs expected from the environment the platform / module runs on: | ||||||
|
|
||||||
| .. needtable:: | ||||||
| :style: table | ||||||
| :columns: title;id;status | ||||||
| :colwidths: 25,25,25 | ||||||
| :sort: title | ||||||
|
|
||||||
| results = [] | ||||||
|
|
||||||
| for need in needs.filter_types(["aou_req"]): | ||||||
| if need and "environment" in need["tags"]: | ||||||
| results.append(need) | ||||||
|
|
||||||
| Assumptions on the User | ||||||
| ^^^^^^^^^^^^^^^^^^^^^^^ | ||||||
| | As there is no assumption on which specific OS and HW is used, the integration testing of the stakeholder and feature requirements is expected to be performed by the user of the platform EooC. Tests covering all stakeholder and feature requirements performed on a reference platform (tbd link to reference platform specification), reviewed and passed are included in the platform EooC security package. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You used EooC and OoC in the documents. It might be easier to use only one expression and also give a hint in brackets what is meant with this abbreviation. |
||||||
| | Additionally the components of the platform may have additional specific assumptions how they are used. These are part of every module documentation: <link to add>. Assumptions from components to their users can be fulfilled in two ways: | ||||||
| | 1. There are assumption which need to be fulfilled by all SW components, e.g. "every user of an IPC mechanism needs to make sure that he provides correct data (e.g. including appropriate security (access) control)" - in this case the AoU is marked as "platform". | ||||||
| | 2. There are assumption which can be fulfilled by a security control realized by some other Project platform component and are therefore not relevant for an user who uses the whole platform. But those are relevant if you chose to use the module EooC stand-alone - in this case the AoU is marked as "module". An example would be the "JSON read" which requires "The user shall provide a string as input which is not corrupted due to HW or QM SW errors." - which is covered when using together with safe <Project> platform persistency feature. | ||||||
|
|
||||||
| List of AoUs on the user of the platform features or the module of this security manual: | ||||||
|
|
||||||
| .. needtable:: | ||||||
| :style: table | ||||||
| :columns: title;id;status | ||||||
| :colwidths: 25,25,25 | ||||||
| :sort: title | ||||||
|
|
||||||
| results = [] | ||||||
|
|
||||||
| for need in needs.filter_types(["aou_req"]): | ||||||
| if need and "environment" not in need["tags"]: | ||||||
| results.append(need) | ||||||
|
|
||||||
| Security concept of the OoC | ||||||
| ---------------------------- | ||||||
| | <Describe here the security concept incl. which attack paths are taken care of, reactions of the implemented functions under threatened operating conditions ... if this is not already documented sufficiently in the feature documentation "security impact" section of all the features the module is used in.> | ||||||
|
|
||||||
| Security Weaknesses, Vulnerabilities | ||||||
| ------------------------------------ | ||||||
| | Weaknesses, Vulnerabilities (bugs in security relevant SW, detected by testing or by users, which could not be fixed) known before release are documented in the platform/module release notes <add link to release note>. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| References | ||||||
| ---------- | ||||||
| | <link to the user manual> | ||||||
| | <other links> | ||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2025 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
|
|
||
| Platform Security Package Checklist | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. noting on platform for safety, remove |
||
| =================================== | ||
|
|
||
| .. document:: [Your Platform Name] Security Package Checklist | ||
| :id: doc__platform_name_security_package_fdr | ||
| :status: draft | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :realizes: wp__fdr_reports | ||
| :tags: template | ||
|
|
||
| .. attention:: | ||
| The above directive must be updated according to your Platform. | ||
|
|
||
| - Modify ``Your Platform Name`` to be your Platform Name | ||
| - Modify ``id`` to be your Platform Name in lower snake case preceded by ``doc__`` and followed by ``_security_package_fdr`` | ||
| - Adjust ``status`` to be ``valid`` | ||
| - Adjust ``safety``, ``security`` and ``tags`` according to your needs | ||
|
|
||
|
|
||
| **Purpose** | ||
| The purpose of this Platform Security package checklist template is to collect the topics to be checked during verification of the Platform Security package. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. General remark: You have (as most of us) a mixture of capital letters used. Like "Platform Security" and "Platform security". If you have time it could be helpful to use one style due to your documents. |
||
|
|
||
| **Checklist** | ||
| .. Question: Create a task for this. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can create a task for it and link it here as you did in the other documents. At the end of the day the developer shall recognize if there are open points. And we shall ensure that these will be done. Best way is the task. It's also possible to create sub-tasks |
||
|
|
||
| To be filled. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove Module, otherwise it is not consistent with Safety, which is just called Safety Manual in the folder structure or we need to be consistent for all documents, Safety and Security have same either using Module or not. I see also for Safety, sometimes used, sometimes not.