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 |
ASIL_B |
YES |
draft |
|
Crypto DFA |
ASIL_B |
YES |
draft |
|
Crypto Feature AoU |
ASIL_B |
YES |
draft |
|
Crypto feature Architecture Inspection Checklist |
ASIL_B |
YES |
draft |
|
Crypto Feature Security AoU |
ASIL_B |
YES |
draft |
|
Crypto FMEA |
ASIL_B |
YES |
draft |
|
Crypto Safety WPs |
ASIL_B |
YES |
draft |
|
Crypto Security WPs |
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 |
ASIL_B |
YES |
draft |
|
[Your Module Name] Safety Analysis Checklist |
ASIL_B |
YES |
draft |
|
[Your Module Name] Safety Manual |
ASIL_B |
YES |
draft |
|
[Your Module Name] Safety Package Formal Review |
ASIL_B |
YES |
draft |
|
[Your Module Name] Safety Plan |
ASIL_B |
YES |
draft |
|
[Your Module Name] Safety Plan Formal Review |
ASIL_B |
YES |
draft |
|
[Your Module Name] Security Manual |
ASIL_B |
YES |
draft |
|
[Your Module Name] Security Package Formal Review |
ASIL_B |
YES |
draft |
|
[Your Module Name] Security Plan |
ASIL_B |
YES |
draft |
|
[Your Module Name] Security Plan Formal Review |
ASIL_B |
YES |
draft |
|
User Manual <module name> |
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 |
QM |
YES |
draft |
|
Crypto Architecture Inspection Checklist |
ASIL_B |
YES |
draft |
|
Crypto Component |
ASIL_B |
YES |
draft |
|
Crypto Component AoU |
ASIL_B |
YES |
draft |
|
Crypto Component AoU |
ASIL_B |
YES |
draft |
|
Crypto Component Architecture |
ASIL_B |
YES |
draft |
|
Crypto Component Classification |
ASIL_B |
YES |
draft |
|
Crypto Daemon Component Architecture |
QM |
YES |
draft |
|
Crypto Detailed Design |
ASIL_B |
YES |
draft |
|
Crypto DFA |
ASIL_B |
YES |
draft |
|
Crypto FMEA |
ASIL_B |
YES |
draft |
|
Crypto Implementation Inspection Checklist |
ASIL_B |
YES |
draft |
|
Crypto Requirements |
QM |
YES |
draft |
|
Crypto Requirements Inspection Checklist |
ASIL_B |
YES |
draft |
|
Cryptoki Component |
QM |
YES |
draft |
|
PQC Provider Architecture |
QM |
YES |
draft |
|
PQC Provider Architecture Inspection Checklist |
QM |
YES |
draft |
|
PQC Provider Component |
QM |
YES |
draft |
|
PQC Provider Component Classification |
QM |
YES |
draft |
|
PQC Provider Detailed Design |
QM |
YES |
draft |
|
PQC Provider DFA |
QM |
YES |
draft |
|
PQC Provider FMEA |
QM |
YES |
draft |
|
PQC Provider Implementation Inspection Checklist |
QM |
YES |
draft |
|
PQC Provider Requirements |
QM |
YES |
draft |
|
PQC Provider Requirements Inspection Checklist |
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-tidyare used; for Rust code,clippyis usedSafety level: The ASIL level affects safety-related build settings and validation
Source code languages: The build system optimizes for the configured languages