Crypto Documentation#

This repository provides the cryptographic services of the Eclipse S-CORE feat__security_crypto. The Crypto module offers applications a common interface for key management, symmetric and asymmetric cryptography, hashing, digital signatures, certificate handling, and post-quantum cryptography, with support for software and hardware-backed cryptographic providers. Its scope is cryptographic services, rather than all use cases covered by Security & Crypto.

Feature Documentation#

The feature documentation describes Crypto’s architecture, safety and security planning, and analyses.

Title

ID

Safety

Security

Status

Crypto Architecture

doc__crypto_feat_architecture

ASIL_B

YES

draft

Crypto DFA

doc__crypto_feat_dfa

ASIL_B

YES

draft

Crypto Feature AoU

doc__crypto_feat_aou

ASIL_B

YES

draft

Crypto feature Architecture Inspection Checklist

doc__crypto_feat_arc_inspection

ASIL_B

YES

draft

Crypto Feature Security AoU

doc__crypto_sec_feat_aou

ASIL_B

YES

draft

Crypto FMEA

doc__crypto_feat_fmea

ASIL_B

YES

draft

Crypto Safety WPs

doc__crypto_safety_wp

ASIL_B

YES

draft

Crypto Security WPs

doc__feature_example_security_planning_wp

ASIL_B

YES

draft

Module Documentation#

The module documentation covers the implementation overview, manuals, safety and security management, and verification report.

Title

ID

Safety

Security

Status

[Your Module Name] Release Note

doc__mod_temp_module_name_release_note

ASIL_B

YES

draft

[Your Module Name] Safety Analysis Checklist

doc__mod_temp_module_name_safety_analysis_fdr

ASIL_B

YES

draft

[Your Module Name] Safety Manual

doc__mod_temp_module_name_safety_manual

ASIL_B

YES

draft

[Your Module Name] Safety Package Formal Review

doc__mod_temp_module_name_safety_package_fdr

ASIL_B

YES

draft

[Your Module Name] Safety Plan

doc__mod_temp_module_name_safety_plan

ASIL_B

YES

draft

[Your Module Name] Safety Plan Formal Review

doc__mod_temp_module_name_safety_plan_fdr

ASIL_B

YES

draft

[Your Module Name] Security Manual

doc__mod_temp_module_name_security_manual

ASIL_B

YES

draft

[Your Module Name] Security Package Formal Review

doc__mod_temp_module_name_sec_pkg_fdr

ASIL_B

YES

draft

[Your Module Name] Security Plan

doc__mod_temp_module_name_security_plan

ASIL_B

YES

draft

[Your Module Name] Security Plan Formal Review

doc__mod_temp_module_name_security_plan_fdr

ASIL_B

YES

draft

User Manual <module name>

doc__user_manual

QM

YES

draft

Component Documentation#

The component documentation provides requirements, architecture, detailed design, and analyses for the individual components of the Crypto module.

Title

ID

Safety

Security

Status

Crypto Architecture

doc__crypto_architecture

QM

YES

draft

Crypto Architecture Inspection Checklist

doc__crypto_arc_inspection

ASIL_B

YES

draft

Crypto Component

doc__crypto

ASIL_B

YES

draft

Crypto Component AoU

doc__crypto_comp_aou

ASIL_B

YES

draft

Crypto Component AoU

doc__crypto_sec_comp_aou

ASIL_B

YES

draft

Crypto Component Architecture

doc__crypto_comp_architecture

ASIL_B

YES

draft

Crypto Component Classification

doc__crypto_comp_class

ASIL_B

YES

draft

Crypto Daemon Component Architecture

doc__crypto_daemon_architecture

QM

YES

draft

Crypto Detailed Design

doc__crypto_detailed_design

ASIL_B

YES

draft

Crypto DFA

doc__crypto_dfa

ASIL_B

YES

draft

Crypto FMEA

doc__crypto_fmea

ASIL_B

YES

draft

Crypto Implementation Inspection Checklist

doc__crypto_impl_inspection

ASIL_B

YES

draft

Crypto Requirements

doc__crypto_requirements

QM

YES

draft

Crypto Requirements Inspection Checklist

doc__crypto_req_inspection

ASIL_B

YES

draft

Cryptoki Component

doc__cryptoki

QM

YES

draft

PQC Provider Architecture

doc__pqc_provider_architecture

QM

YES

draft

PQC Provider Architecture Inspection Checklist

doc__pqc_provider_arc_inspection

QM

YES

draft

PQC Provider Component

doc__pqc_provider

QM

YES

draft

PQC Provider Component Classification

doc__pqc_provider_comp_class

QM

YES

draft

PQC Provider Detailed Design

doc__pqc_provider_detailed_design

QM

YES

draft

PQC Provider DFA

doc__pqc_provider_dfa

QM

YES

draft

PQC Provider FMEA

doc__pqc_provider_fmea

QM

YES

draft

PQC Provider Implementation Inspection Checklist

doc__pqc_provider_impl_inspection

QM

YES

draft

PQC Provider Requirements

doc__pqc_provider_requirements

QM

YES

draft

PQC Provider Requirements Inspection Checklist

doc__pqc_provider_req_inspection

QM

YES

draft

Quick Start - Building and Testing#

To build the entire module:

bazel build //score/...

To run all tests:

bazel test //score/...

Module Build Configuration#

The project_config.bzl file at the root of the module defines metadata used by Bazel macros. This file controls build behavior and project-specific settings. It should follow the S-CORE definition. See S-CORE user guide for project_config.bzl for details.

The configuration enables conditional build behavior:

  • Language-specific tools: For C++ code, tools like clang-tidy are used; for Rust code, clippy is used

  • Safety level: The ASIL level affects safety-related build settings and validation

  • Source code languages: The build system optimizes for the configured languages