-
Notifications
You must be signed in to change notification settings - Fork 76
OS module requirements and AoU #2515
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
Open
aschemmel-tech
wants to merge
3
commits into
main
Choose a base branch
from
aschemmel-tech-add-os-integration
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2026 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 | ||
| # ******************************************************************************* | ||
|
|
||
| Assumptions of Use | ||
| ################## | ||
|
|
||
| .. document:: Operating System Assumptions of Use | ||
| :id: doc__os_aou | ||
| :status: draft | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :realizes: wp__requirements_comp | ||
|
|
||
| .. aou_req:: No Root Privileges | ||
| :id: aou_req__os__nonroot | ||
| :reqtype: Functional | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: valid | ||
|
|
||
| No process running on the SW-platform shall request root privileges. | ||
|
|
||
| Note: The root privilege is dangerous for security and safety as it destroys process isolation. | ||
|
|
||
| .. aou_req:: Safe OS Function Use | ||
| :id: aou_req__os__safe_fctn_use | ||
| :reqtype: Functional | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: valid | ||
|
|
||
| If an application or SW-platform component is safety relevant and uses OS functions, it shall only use the safe functions. | ||
|
|
||
| Note: For checking the "to be expected" safe functions the developer can consider the safe function list | ||
| published by the OS supplier. For QNX this can be found for example in `appendices here <https://fs-products.tuvasi.com/certificates?keywords=Blackberry&productcategory_id=1#prodid_9842>`_ (for one version). | ||
|
|
||
| .. aou_req:: OS Public API Use | ||
| :id: aou_req__os__public_api | ||
| :reqtype: Functional | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: valid | ||
|
|
||
| All components shall only use the public API of the OS components. | ||
|
|
||
| .. aou_req:: C++ Library Preference | ||
| :id: aou_req__os__cxx_preference | ||
| :reqtype: Functional | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: valid | ||
|
|
||
| All components should prefer the use of C++ standard lib over the C lib to call a functionality. | ||
| If C lib must be used, it shall not be mixed with C++ lib for the same functionality. | ||
|
|
||
| .. aou_req:: Minimal Process Privileges | ||
| :id: aou_req__os__minimal_privileges | ||
| :reqtype: Functional | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: valid | ||
|
|
||
| All components shall only use the privileges that are indispensable for their function. | ||
|
|
||
| Note1: OS safety manuals provide lists of allowed and not allowed privileges. | ||
|
|
||
| Note2: One example is the "channel connect" - only IPC connections are allowed which are specified in the architecture. | ||
|
|
||
| Note3: Another example is mmap_peer which would allow accessing other processes memory if wrongly used. | ||
|
|
||
| .. needextend:: "__os_" in id | ||
| :+tags: operating_system |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2026 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 | ||
| # ******************************************************************************* | ||
|
|
||
|
|
||
|
|
||
| Requirements | ||
| ############ | ||
|
|
||
| .. document:: Operating System Requirements | ||
| :id: doc__os_requirements | ||
| :status: draft | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :realizes: wp__requirements_comp | ||
|
|
||
| Generally the OS (as an external SW element) is expected by the S-CORE project to fulfill the following requirements, | ||
| defined in the SW-platform assumptions (and partly even in the Stakeholder requirements). | ||
|
|
||
| The system integrator integrating S-CORE with the OS to provide a safe product has to make sure | ||
|
|
||
| - the functional requirements below are matching the OS used - see also :need:`aou_req__platform__safety_matching` | ||
| - the non-functional (integration) requirements below are fulfilled by the OS supplier - see also :ref:`integration_assumptions` | ||
|
|
||
| Integration Requirements | ||
| ======================== | ||
|
|
||
| Community Level | ||
| --------------- | ||
|
|
||
| - :need:`aou_req__platform__integration_assistance` | ||
| - :need:`aou_req__platform__os_integration_manual` | ||
| - :need:`aou_req__platform__bug_interface` | ||
|
|
||
| Functional Level | ||
| ---------------- | ||
|
|
||
| - :need:`aou_req__platform__bazel_tooling` | ||
| - :need:`aou_req__platform__bug_fixing` | ||
|
|
||
| Certifiable Level | ||
| ----------------- | ||
|
|
||
| - :need:`aou_req__platform__levels` | ||
| - :need:`aou_req__platform__safety_aou` | ||
| - :need:`aou_req__platform__safety_functions` | ||
| - :need:`aou_req__platform__safety_anomaly` | ||
|
|
||
|
|
||
| OS Specific Functional Requirements | ||
| =================================== | ||
|
|
||
| - :need:`aou_req__platform__process_isolation` | ||
| - :need:`aou_req__platform__os_safety_functions` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2026 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 | ||
| # ******************************************************************************* | ||
|
|
||
| libcpp Component Architecture | ||
| ***************************** | ||
|
|
||
| .. comp:: libcpp | ||
| :id: comp__os_libcpp | ||
| :status: valid | ||
| :safety: ASIL_B | ||
| :implements: logic_arc_int__os__libcpp | ||
| :security: NO | ||
|
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. here security no |
||
|
|
||
| .. comp_arc_sta:: C++ Std Library | ||
| :id: comp_arc_sta__os__libcpp | ||
| :security: YES | ||
|
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. but interface is security relevant? |
||
| :safety: ASIL_B | ||
| :status: valid | ||
| :satisfies: | ||
|
|
||
| .. needarch:: | ||
| :scale: 50 | ||
| :align: center | ||
|
|
||
| {{ draw_component(need(), needs) }} | ||
|
|
||
| .. logic_arc_int:: Library headers (C++17) | ||
| :id: logic_arc_int__os__libcpp | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: valid | ||
|
|
||
| .. needarch:: | ||
| :scale: 50 | ||
| :align: center | ||
|
|
||
| {{ draw_interface(need(), needs) }} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2026 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 | ||
| # ******************************************************************************* | ||
| .. _comp_doc_libcpp: | ||
|
|
||
| libcpp | ||
| ###### | ||
|
|
||
| Component Documents | ||
| =================== | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :titlesonly: | ||
|
|
||
| architecture/index |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.