This repository was archived by the owner on Sep 6, 2023. It is now read-only.
Repository navigation
Architecture Documentation #211
Merged
Weltraumschaf
merged 10 commits into
secureCodeBox:main
from
Stijn-FE:architecture_documentation
Mar 16, 2022
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
f0f2cc6
initial commit
Stijn-FE b59fdfe
Update docs/architecture/introduction.md
Weltraumschaf 64861a2
Update docs/architecture/functional/crosscutting-concepts.md
Weltraumschaf d7980c1
Update docs/architecture/functional/quality-requirements.md
Weltraumschaf 7c85220
Update docs/architecture/functional/risks-and-technical-debt.md
Weltraumschaf 0e7ac27
Update docs/architecture/introduction.md
Weltraumschaf 14865e1
Update docs/architecture/technical/building-block-view.md
Weltraumschaf 5438923
Update docs/architecture/technical/runtime-view.md
Weltraumschaf 50baedf
Update docs/architecture/technical/deployment-view.md
Weltraumschaf a0a94c4
Update docs/architecture/technical/building-block-view.md
Weltraumschaf 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| # SPDX-FileCopyrightText: the secureCodeBox authors | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| title: "Architecture Cross-Cutting Concepts" | ||
| sidebar_label: "Cross-Cutting Concepts" | ||
| --- |
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,38 @@ | ||
| --- | ||
| # SPDX-FileCopyrightText: the secureCodeBox authors | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| title: "Architecture Quality Requirements" | ||
| sidebar_label: "Quality Requirements" | ||
| --- | ||
|
|
||
| Below, qualities are described that this project strives for. The qualities are categorized using the [ISO 25010](https://iso25000.com/index.php/en/iso-25000-standards/iso-25010) standard. | ||
|
|
||
| ## Quality Tree | ||
|
|
||
| | **Category** | **Quality** | **Description** | **Scenario** | | ||
| |------------------------|----------------------|----------------------------------------------------------------------|--------------| | ||
| | Functional Suitability | | | | | ||
| | Performance Efficiency | Resource Efficient | SCB should scale to the available resources | SC3 | | ||
| | | Time Efficient | Tasks should run parallel to optimize the use of resources | | | ||
| | Compatibility | | | | | ||
| | Usability | Ease of Integration | The definition and implementation of a scan process should be easy | SC4 | | ||
| | Reliability | | | | | ||
| | Security | | | | | ||
| | Maintainability | Modular | All components should be loosely coupled to easily swap them | | | ||
| | | Ease of integration | It should be possible to easily integrate new scanners | | | ||
| | | Ease of Contributing | SCB should be well documented | | | ||
| | | Ease of updating | Third-party software should be carefully chosen, for maintainability | SC1 | | ||
| | Portability | Adaptable | SCB Should run everywhere (local, VMs, Cloud, etc.) | SC2 | | ||
|
|
||
|
|
||
|
|
||
| ## Quality Scenarios | ||
|
|
||
| | **Id** | **Scenario** | | ||
| |--------|-------------------------------------------------------------------------------------------------------| | ||
| | SC1 | A third-party updates their software with a breaking change. Effort to support this update is minimal | | ||
| | SC2 | A company is running SCB in the cloud, due to limited resources on premise | | ||
| | SC3 | SCB is out of resources and a new scan is initiated. The scan is queued until resources are available | | ||
| | SC4 | A scan is easily created and started by writing and loading a config file | |
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,20 @@ | ||
| --- | ||
| # SPDX-FileCopyrightText: the secureCodeBox authors | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| title: "Architecture Risks and Technical Debts" | ||
| sidebar_label: "Risks and Technical Debts" | ||
| --- | ||
|
|
||
| ## Technical risks | ||
|
|
||
| | **Risk** | **Description** | | ||
| |----------|-----------------| | ||
| | | ||
|
|
||
| ## Business or domain risks | ||
|
|
||
| | **Risk** | **Description** | | ||
| |----------|-----------------| | ||
| | |
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 |
|---|---|---|
| @@ -1,10 +1,105 @@ | ||
| --- | ||
| # SPDX-FileCopyrightText: 2021 iteratec GmbH | ||
| # SPDX-FileCopyrightText: the secureCodeBox authors | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| title: "Architecture Introduction" | ||
| sidebar_label: "Introduction" | ||
| --- | ||
|
|
||
| > 🔧 Documentation Coming Soon | ||
| This document describes the secureCodeBox Project (SCB) and is based on the [arc42](https://arc42.org/overview/) architecture documentation template. SecureCodeBox is a Kubernetes based, modularized toolchain for continuous security scans of your software project. Its goal is to orchestrate and easily automate a bunch of security-testing tools out of the box. With secureCodeBox we provide a toolchain for continuous scanning of applications to find the low-hanging fruit issues early in the development process and free the resources of the penetration tester to concentrate on the major security issues. | ||
|
|
||
| Initially, the goal of secureCodeBox was to provide a tool for easy integrating security test tools into your CI/CD pipeline to run against your web project. Some years ago we asked ourselves: Why only scan a single project? So a great idea was born: Consider the whole company as a project. Additionally, secureCodeBox can aid penetration testers in the recon and discovery phase of a security assessment. The purpose of secureCodeBox is not to replace the penetration testers or make them obsolete. We strongly recommend to run extensive tests by experienced penetration testers on all your applications. | ||
|
|
||
| The following goals have been established for this project: | ||
|
|
||
| | **Priority** | | | ||
| |--------------|-------------------------------------------------------------------------------------------------------------------| | ||
| | 1 | The project shall be enhanced by features that are suitable to keep. | | ||
| | 2 | The project is scalable and resource efficient (FaaS). | | ||
| | 3 | The project implements additional scanners that are a useful addition for the current suite, limiting redundancy. | | ||
| | 4 | The findings are displayed in a navigable way with least amount of duplication. | | ||
| | 5 | SecureCodeBox starts new relevant scans in an agile way, based on previous findings. | | ||
|
|
||
| ## Requirements | ||
|
|
||
|  | ||
|
|
||
| | **Id** | **Requirement** | **Explanation** | | ||
| |--------|-----------------------------|--------------------------------------------------------------------| | ||
| | UC1 | Initiate scans | Initiating scans in parallel and orchestrating them. | | ||
| | UC1.1 | Initiating subsequent scans | Initiate scans based on pervious results, through cascading rules. | | ||
| | UC2 | Parse findings | Parse findings in a human readable and friendly way. | | ||
|
|
||
| ## Quality Goals | ||
| Below, the most important qualities are described that this project strives for. The qualities are categorized using the [ISO 25010](https://iso25000.com/index.php/en/iso-25000-standards/iso-25010) standard. Most of these qualities are derived from [this](https://docs.securecodebox.io/blog/2021/07/20/the-architecture-of-securecodebox-v2) blog post. For the entire list of quality-goals see [Quality Requirements](./functional/quality-requirements) | ||
|
|
||
| | **Category** | **Quality** | **Description** | **Scenario** | | ||
| |------------------------|----------------------|----------------------------------------------------------------------|--------------| | ||
| | Maintainability | Modular | All components should be loosely coupled to easily swap them | | | ||
| | | Ease of integration | It should be possible to easily integrate new scanners | | | ||
| | | Ease of Contributing | SCB should be well documented | | | ||
| | | Ease of updating | Third-party software should be carefully chosen, for maintainability | SC1 | | ||
| | Portability | Adaptable | SCB Should run everywhere (local, VMs, Cloud, etc.) | SC2 | | ||
| | Performance Efficiency | Resource Efficient | SCB should scale to the available resources | SC3 | | ||
| | | Time Efficient | Tasks should run parallel to optimize the use of resources | | | ||
| | Usability | Ease of Integration | The definition and implementation of a scan process should be easy | SC4 | | ||
|
|
||
| ### Scenarios | ||
|
|
||
| | **Id** | **Scenario** | | ||
| |--------|-------------------------------------------------------------------------------------------------------| | ||
| | SC1 | A third-party updates their software with a breaking change. Effort to support this update is minimal | | ||
| | SC2 | A company is running SCB in the cloud, due to limited resources on premise | | ||
| | SC3 | SCB is out of resources and a new scan is initiated. The scan is queued until resources are available | | ||
| | SC4 | A scan is easily created and started by writing and loading a config file | | ||
|
|
||
| ## Stakeholders | ||
|
|
||
| | **Company** | **Name** | **Role** | **GitHub Account** | **Expectations** | | ||
| | ----------- | ----------------- | ------------------------ | -------------------------------------------------- | ---------------- | | ||
| | iteratec | Robert Seedorff | Product Owner | [@rseerdorff](https://github.com/rseedorff) | | | ||
| | | Sven Strittmatter | Scrum Master & Developer | [@Weltraumschaf](https://github.com/Weltraumschaf) | | | ||
| | | Jannik Hollenbach | Core Developer | [@J12934](https://github.com/J12934) | | | ||
| | | Max Maass | Core Developer | [@malexmave](https://github.com/malexmave) | | | ||
| | | Ilyes Ben Dlala | Core Developer | [@Ilyesbdlala](https://github.com/Ilyesbdlala) | | | ||
| | | Rami Souai | Core Developer | [@RamiSouai](https://github.com/RamiSouai) | | | ||
| | Secura | Ralph Moonen | | N/A | | | ||
| | | Sander Maijers | | [@sanmai-NL](https://github.com/sanmai-NL) | | | ||
| | | Jop Zitman | | [@EndPositive](https://github.com/EndPositive) | | | ||
| | | Stijn van Es | Developer | [@Stijn-FE](https://github.com/Stijn-FE) | Contributes | | ||
|
|
||
|
|
||
| ## Architecture constraints | ||
|
|
||
| | **Constraint** | **Description** | | ||
| |----------------|-----------------| | ||
| | | | | ||
|
|
||
| > Following... | ||
|
|
||
| # Context & Scope | ||
|
|
||
| SCB is an orchestration platform managing scan jobs and parsing results. The aim of this project is to make automated vulnerability scanning easy and efficient. The diagrams below, illustrate the external factors and the context in which SCB is used. | ||
|
|
||
| SCB only manages the scan tasks. The scanning functionality itself is considered out of scope and for this, third-party software is used. | ||
|
|
||
| ## Business | ||
|
|
||
|  | ||
|
|
||
| ## Technical | ||
|
|
||
|  | ||
|
|
||
| # Solution Strategy | ||
|
|
||
| | **Goal/Requirement** | **Architectural Approach** | **Details** | | ||
| |----------------------|----------------------------|-------------| | ||
| | | ||
|
|
||
| > Following... | ||
|
|
||
| ## Road Map | ||
|
|
||
| > Following... | ||
|
Weltraumschaf marked this conversation as resolved.
Resolved
|
||
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,20 @@ | ||
| --- | ||
| # SPDX-FileCopyrightText: the secureCodeBox authors | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| title: "Architecture Building Block View" | ||
| sidebar_label: "Building Block View" | ||
| --- | ||
|
|
||
| Below, an overview is given of the global design/architecture of secureCodeBox. This document is inspired by the [C4](https://c4model.com/) model for visualizing software architecture. Conform this model, this document is split in 4 parts (i.e. levels). First, a `context` level overview, displaying the context in which the application is used. The second level, `containers`, broadly describes the different data streams. The third level consists of a `components` overview, describing the different components and the interactions between them. The fourth and final level contains a `code` overview. Which will consist of class- and database-diagrams. | ||
|
|
||
| ## System Context diagram | ||
|
|
||
|  | ||
|
|
||
| ## Container Diagram | ||
|
|
||
| ## Component Diagram | ||
|
|
||
| ## Code |
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,8 @@ | ||
| --- | ||
| # SPDX-FileCopyrightText: the secureCodeBox authors | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| title: "Architecture Deployment View" | ||
| sidebar_label: "Deployment View" | ||
| --- |
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,8 @@ | ||
| --- | ||
| # SPDX-FileCopyrightText: the secureCodeBox authors | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| title: "Architecture Runtime View" | ||
| sidebar_label: "Runtime View" | ||
| --- |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.