Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .templates/new-scanner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Please include any extra Helm chart configurations that can be useful.
| parser.image.pullPolicy | string | `"IfNotPresent"` | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
| parser.image.repository | string | `"docker.io/securecodebox/parser-new-scanner"` | Parser image repository |
| parser.image.tag | string | defaults to the charts version | Parser image tag |
| parser.resources | object | { requests: { cpu: "200m", memory: "100Mi" }, limits: { cpu: "400m", memory: "200Mi" } } | Optional resources lets you control resource limits and requests for the parser container. See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
| parser.resources | object | `{ requests: { cpu: "200m", memory: "100Mi" }, limits: { cpu: "400m", memory: "200Mi" } }` | Optional resources lets you control resource limits and requests for the parser container. See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
| parser.scopeLimiterAliases | object | `{}` | Optional finding aliases to be used in the scopeLimiter. |
| parser.tolerations | list | `[]` | Optional tolerations settings that control how the parser job is scheduled (see: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) |
| parser.ttlSecondsAfterFinished | string | `nil` | seconds after which the Kubernetes job for the parser will be deleted. Requires the Kubernetes TTLAfterFinished controller: https://kubernetes.io/docs/concepts/workloads/controllers/ttlafterfinished/ |
Expand Down
2 changes: 1 addition & 1 deletion .templates/new-scanner/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ parser:
tolerations: []

# -- Optional resources lets you control resource limits and requests for the parser container. See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
# @default -- { requests: { cpu: "200m", memory: "100Mi" }, limits: { cpu: "400m", memory: "200Mi" } }
# @default -- `{ requests: { cpu: "200m", memory: "100Mi" }, limits: { cpu: "400m", memory: "200Mi" } }`
resources: {}

scanner:
Expand Down
8 changes: 4 additions & 4 deletions documentation/docs/10-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ is roughly every two weeks (we will usually make a new release after each review
| ------- | ------------------ | ------------------ |
| 4.x.x | :white_check_mark: | :white_check_mark: |
| 3.15.x | :white_check_mark: | :white_check_mark: |
| <= 2.9.x | :x: | :x: |
| < 2.0 | :x: | :x: |
| \<= 2.9.x | :x: | :x: |
| \< 2.0 | :x: | :x: |

### Major Release (Semver)
_Upcoming major updates_ will come with a time window in which both _major versions_ (starting with v2.x.x)
Expand All @@ -34,11 +34,11 @@ as early as possible.

## Extended (Enterprise) Support
If you are interested in extended support for older versions with security updates of our project
please get in touch with the project team via Slack or email <secureCodeBox@iteratec.com>.
please get in touch with the project team via Slack or email [secureCodeBox@iteratec.com](mailto:secureCodeBox@iteratec.com).

## Reporting a Vulnerability
You have found a vulnerability in the project that shouldn't be disclosed as public issue before it's fixed?
Please get in touch with the project team via Slack or email <secureCodeBox@iteratec.com>.
Please get in touch with the project team via Slack or email [secureCodeBox@iteratec.com](mailto:secureCodeBox@iteratec.com).

You can expect a fast reaction within the next days.
We will keep you updated about the next steps and inform you if the vulnerability is accepted and when its fixed or if its ordeclined somehow.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ sidebar_label: "ADR-0000"
|----------------|--------------------------------------------------------------------------------------|
| **Status**: | PROPOSED or ACCEPTED or REJECTED or DEPRECATED or SUPERSEDES [ADR-0000](ADR-0000.md) |
| **Date**: | YYYY-MM-DD |
| **Author(s)**: | John Doe <john.doe@snafu.com>, jane Doe <jane.doe@snafu.com> |
| **Author(s)**: | John Doe [john.doe@snafu.com](mailto:john.doe@snafu.com), jane Doe [john.doe@snafu.com](mailto:john.doe@snafu.com) |

## Context

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0001"
|----------------|----------|
| **Status**: | ACCEPTED |
| **Date**: | 2019-08-21 |
| **Author(s)**: | Daniel Patanin <daniel.patanin@iteratec.com>, Jannick Hollenbach <jannick.hollenbach@iteratec.com> |
| **Author(s)**: | Daniel Patanin [daniel.patanin@iteratec.com](mailto:daniel.patanin@iteratec.com), Jannick Hollenbach [jannick.hollenbach@iteratec.com](mailto:jannick.hollenbach@iteratec.com) |

## Context

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0002"
|----------------|----------|
| **Status**: | ACCEPTED |
| **Date**: | 2020-05-20 |
| **Author(s)**: | Jannik Hollenbach <Jannik.Hollenbach@iteratec.com>, Jorge Estigarribia <Jorge.Estigarribia@iteratec.com>, Robert Seedorff <Robert.Seedorff@iteratec.com>, Sven Strittmatter <Sven.Strittmatter@iteratec.com> |
| **Author(s)**: | Jannik Hollenbach [jannick.hollenbach@iteratec.com](mailto:jannick.hollenbach@iteratec.com), Jorge Estigarribia [jorge.estigarribia@iteratec.com](mailto:jorge.estigarribia@iteratec.com), Robert Seedorff [Robert.Seedorff@iteratec.com](mailto:Robert.Seedorff@iteratec.com), Sven Strittmatter [sven.strittmatter@iteratec.com](mailto:Sven.Strittmatter@iteratec.com) |
Comment thread
Ilyesbdlala marked this conversation as resolved.
Resolved

## Context

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0003"
|----------------|----------|
| **Status**: | ACCEPTED |
| **Date**: | 2020-05-20 |
| **Author(s)**: | Jannik Hollenbach <Jannik.Hollenbach@iteratec.com>, Robert Seedorff <Robert.Seedorff@iteratec.com>, Sven Strittmatter <Sven.Strittmatter@iteratec.com> |
| **Author(s)**: | Jannik Hollenbach [jannick.hollenbach@iteratec.com](mailto:jannick.hollenbach@iteratec.com), Robert Seedorff [Robert.Seedorff@iteratec.com](mailto:Robert.Seedorff@iteratec.com), Sven Strittmatter [sven.strittmatter@iteratec.com](mailto:Sven.Strittmatter@iteratec.com) |
Comment thread
Ilyesbdlala marked this conversation as resolved.
Resolved

## Context

Expand Down Expand Up @@ -62,7 +62,7 @@ It was decided to implement these rules as Custom Resource Definitions (CRDs) in

### Defining CascadingRule

The so called "CascadingRules" consist of a "matches" section which contains one or multiple rules which are compared against findings. When a finding matches a rule the "scanSpec" section will then be used to create a new scan. To customize the scan to match the finding, the \[mustache\](<https://github.com/janl/mustache.js>) templating language
The so called "CascadingRules" consist of a "matches" section which contains one or multiple rules which are compared against findings. When a finding matches a rule the "scanSpec" section will then be used to create a new scan. To customize the scan to match the finding, the [mustache](https://github.com/janl/mustache.js) templating language
can be used to reference fields of the finding.

```yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0004"
|----------------|----------|
| **Status**: | ACCEPTED (SUPERSEDES [ADR-0001](./adr_0001.md)) |
| **Date**: | 2020-09-29 |
| **Author(s)**: | Daniel Patanin daniel.patanin@iteratec.com |
| **Author(s)**: | Daniel Patanin [daniel.patanin@iteratec.com](mailto:daniel.patanin@iteratec.com) |

## Context

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0005"
|----------------|-----------------------------------------------------------------------------------------------|
| **Status**: | DEPRECATED |
| **Date**: | 2020-09-29 |
| **Author(s)**: | Daniel Patanin daniel.patanin@iteratec.com, Sven Strittmatter sven.strittmatter@iteratec.com> |
| **Author(s)**: | Daniel Patanin [daniel.patanin@iteratec.com](mailto:daniel.patanin@iteratec.com), Sven Strittmatter [Sven.Strittmatter@iteratec.com](mailto:Sven.Strittmatter@iteratec.com) |
Comment thread
Ilyesbdlala marked this conversation as resolved.
Resolved

:::info
Deprecated since we did some optimizations by marketing specialists some months ago.
Expand All @@ -33,9 +33,9 @@ As our requirements about our homepage changed we no longer just want to give a

Since there is no arguable reason to build such a one-pager ourselves, we should buy a ready to go solution for us. We are not aiming to invest extensive time neither in building such a page, nor in gaining the desired design and marketing expertise, and also not hiring experts on this field (all this would actually be more expensive and time consuming than buying a site). Some stores for such pages are:

- <https://www.templatemonster.com/>
- <https://onepagelove.com/templates>
- <https://themeforest.net/tags/onepage>
- [https://www.templatemonster.com](https://www.templatemonster.com)
- [https://onepagelove.com/templates](https://onepagelove.com/templates)
- [https://themeforest.net/tags/onepage](https://themeforest.net/tags/onepage)

## Consequences

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0006"
|----------------|----------------------------------------------------------------------------------------------------------|
| **Status**: | REJECTED |
| **Date**: | 2020-10-12 |
| **Author(s)**: | Yannik Fuhrmeister <yannik.fuhrmeister@iteratec.com>, Sven Strittmatter <sven.strittmatter@iteratec.com> |
| **Author(s)**: | Yannik Fuhrmeister [yannik.fuhrmeister@iteratec.com](mailto:yannik.fuhrmeister@iteratec.com), Sven Strittmatter [sven.strittmatter@iteratec.com](mailto:Sven.Strittmatter@iteratec.com) |
Comment thread
Ilyesbdlala marked this conversation as resolved.
Resolved

:::info
Since nearly two years no one cared about versioned documentation, so we reject this proposal.
Expand All @@ -26,7 +26,7 @@ We will need to specify how many versions of the documentation we want to mainta

## Decision

- We introduce a new documentation version for every minor version (<https://semver.org/>) to ensure that the documentation is up-to-date.
- We introduce a new documentation version for every minor version ([https://semver.org](https://semver.org)) to ensure that the documentation is up-to-date.
- We maintain the latest 3 major versions (previous, current, next).
- We maintain the latest minor version for each major version.
- We **do not** maintain patch versions nor multiple minor versions for each major version!
Expand All @@ -37,4 +37,4 @@ We will need to specify how many versions of the documentation we want to mainta

- We need to update the documentation version everytime we increment minor or major versions of the _secureCodeBox_ (manually or with action).
- Maintaining the documentation could be more difficult due to now increased number of documentation files.
- Documentation has to be maintained in two repositories because when creating a new version Docusaurus creates a copy of all files in this repository (see <https://v2.docusaurus.io/docs/versioning/#directory-structure>)
- Documentation has to be maintained in two repositories because when creating a new version Docusaurus creates a copy of all files in this repository (see [https://v2.docusaurus.io/docs/versioning/#directory-structure](https://v2.docusaurus.io/docs/versioning/#directory-structure))
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0007"
|----------------|----------------------------------------------------|
| **Status**: | DRAFT |
| **Date**: | 2020-11-25 |
| **Author(s)**: | Sven Strittmatter <Sven.Strittmatter@iteratec.com> |
| **Author(s)**: | Sven Strittmatter [sven.strittmatter@iteratec.com](mailto:Sven.Strittmatter@iteratec.com) |
Comment thread
Ilyesbdlala marked this conversation as resolved.
Resolved

**NOTE**: The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0008"
|----------------|----------|
| **Status**: | ACCEPTED (will SUPERSEDES [ADR-0006](adr_0006.md)) |
| **Date**: | 2021-07-15 |
| **Author(s)**: | Sven Strittmatter <sven.strittmatter@iteratec.com> |
| **Author(s)**: | Sven Strittmatter [sven.strittmatter@iteratec.com](mailto:Sven.Strittmatter@iteratec.com) |
Comment thread
Ilyesbdlala marked this conversation as resolved.
Resolved

## Context

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0009"
|----------------|----------|
| **Status**: | ACCEPTED |
| **Date**: | 2021-10-07 |
| **Author(s)**: | Max Maass <max.maass@iteratec.com>, Jannik Hollenbach <Jannik.Hollenbach@iteratec.com> |
| **Author(s)**: | Max Maass [max.maass@iteratec.com](mailto:max.maass@iteratec.com), Jannik Hollenbach [jannick.hollenbach@iteratec.com](mailto:jannick.hollenbach@iteratec.com) |

## Context

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0010"
|----------------|----------|
| **Status**: | ACCEPTED |
| **Date**: | 2021-11-22 |
| **Author(s)**: | Max Maass <max.maass@iteratec.com> |
| **Author(s)**: | Max Maass [max.maass@iteratec.com](mailto:max.maass@iteratec.com) |

## Context

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0011"
|----------------|----------|
| **Status**: | ACCEPTED |
| **Date**: | 2022-03-08 |
| **Author(s)**: | Max Maass <max.maass@iteratec.com> |
| **Author(s)**: | Max Maass [max.maass@iteratec.com](mailto:max.maass@iteratec.com) |

## Context
Software version numbers should serve as an indicator of compatibility between different versions, both during operation and while updating to a newer release.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidebar_label: "ADR-0012"
| -------------- | -------------------------------------------------------------------------------------- |
| **Status**: | OPEN |
| **Date**: | 2022-06-17 |
| **Author(s)**: | Jannik Hollenbach <jannik.hollenbach@iteratec.com>, Max Maass <max.maass@iteratec.com> |
| **Author(s)**: | Jannik Hollenbach [jannick.hollenbach@iteratec.com](mailto:jannick.hollenbach@iteratec.com), Max Maass [max.maass@iteratec.com](mailto:max.maass@iteratec.com) |

## Context

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0013"
|----------------|----------|
| **Status**: | DRAFT |
| **Date**: | 2022-09-01 |
| **Author(s)**: | Max Maass <max.maass@iteratec.com> |
| **Author(s)**: | Max Maass [max.maass@iteratec.com](mailto:max.maass@iteratec.com) |

## Context

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0014"
|----------------|----------|
| **Status**: | DRAFT |
| **Date**: | 2022-09-01 |
| **Author(s)**: | Max Maass <max.maass@iteratec.com> |
| **Author(s)**: | Max Maass [max.maass@iteratec.com](mailto:max.maass@iteratec.com) |

## Context

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidebar_label: "ADR-0015"
| -------------- | ------------------------------------------------------------------------------------------------------ |
| **Status**: | ACCEPTED |
| **Date**: | 2022-09-13 |
| **Author(s)**: | Jannik Hollenbach <jannik.hollenbach@iteratec.com>, Sven Strittmatter <sven.strittmatter@iteratec.com> |
| **Author(s)**: | Jannik Hollenbach [jannick.hollenbach@iteratec.com](mailto:jannick.hollenbach@iteratec.com), Sven Strittmatter [sven.strittmatter@iteratec.com](mailto:Sven.Strittmatter@iteratec.com) |
Comment thread
Ilyesbdlala marked this conversation as resolved.
Resolved

:::info
This ADR should have been written prior to implementation. But we started documenting ADR later. This ADR has therefore been written retrospectively to record the decision made at that time.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidebar_label: "ADR-0016"
| -------------- | ------------------------------------------------------------------------------------------------------ |
| **Status**: | ACCEPTED |
| **Date**: | 2022-09-13 |
| **Author(s)**: | Jannik Hollenbach <jannik.hollenbach@iteratec.com>, Sven Strittmatter <sven.strittmatter@iteratec.com> |
| **Author(s)**: | Jannik Hollenbach [jannick.hollenbach@iteratec.com](mailto:jannick.hollenbach@iteratec.com), Sven Strittmatter [sven.strittmatter@iteratec.com](mailto:Sven.Strittmatter@iteratec.com) |
Comment thread
Ilyesbdlala marked this conversation as resolved.
Resolved

:::info
This ADR should have been written prior to implementation. But we started documenting ADR later. This ADR has therefore been written retrospectively to record the decision made at that time.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidebar_label: "ADR-0017"
|----------------|---------------------------------------------------|
| **Status**: | DRAFT |
| **Date**: | 2022-09-13 |
| **Author(s)**: | Simon Hülkenberg <simon.huelkenberg@iteratec.com> |
| **Author(s)**: | Simon Hülkenberg [simon.huelkenberg@iteratec.com](mailto:simon.huelkenberg@iteratec.com) |

## Context

Expand Down Expand Up @@ -45,7 +45,8 @@ Cons:
* Logic split up over multiple containers, solution a bit hacky
* Edge Case: Changing the host platform of the container (example: AWS -> GCP) would break the scan because the required environment variables for Trivy must change (as described above). The parameters of the scheduled scan must be changed but the existing autodiscovery operator would lack the logic to do this (no read permissions on secrets so it would notice the difference).

<details><summary> Proof of concept</summary>
<details>
<summary> Proof of concept</summary>
This simplified example will do the following: The `initContainer` will created a secret that is mounted by the main container `imagine-this-is-Trivy`. The main container will print the value of the secret and then sleep for 10 seconds. When the main container completes the `sidecar` will delete the secret.
The real implementation wouldn't use kubectl directly nor the shared volume. This is just a simplification.

Expand All @@ -54,7 +55,6 @@ kind: ServiceAccount
metadata:
name: internal-kubectl
---
apiVersion: v1
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
Expand Down Expand Up @@ -129,8 +129,7 @@ spec:
- name: shared-volume
mountPath: /shared-volume
```
</details>
</details>
#### Using an initContainer and use ownerReferences for the created secretes
Using the same initContainer logic described above but setting the ownerReference of the created secrets to the job/pod of the scan would result in similar behavior without the need of a sidecar.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0018"
|----------------|----------------------------------------------------|
| **Status**: | ACCEPTED |
| **Date**: | 2022-09-20 |
| **Author(s)**: | Sven Strittmatter <sven.strittmatter@iteratec.com> |
| **Author(s)**: | Sven Strittmatter [sven.strittmatter@iteratec.com](mailto:Sven.Strittmatter@iteratec.com) |
Comment thread
Ilyesbdlala marked this conversation as resolved.
Resolved

## Context

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_label: "ADR-0019"
|----------------|----------------------------------------------------------------------------------------------|
| **Status**: | ACCEPTED |
| **Date**: | 2023-09-14 |
| **Author(s)**: | Heiko Kiesel <heiko.kiesel@iteratec.com>, Sven Strittmatter <sven.strittmatter@iteratec.com> |
| **Author(s)**: | Heiko Kiesel [heiko.kiesel@iteratec.com](mailto:heiko.kiesel@iteratec.com), Sven Strittmatter [sven.strittmatter@iteratec.com](mailto:Sven.Strittmatter@iteratec.com) |
Comment thread
Ilyesbdlala marked this conversation as resolved.
Resolved

## Context

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/community-features/windows-scanners.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ in our main repository. Feel free to use it as a starting point.

## General architecture of the solution

Docker <- Ubuntu <- VirtualBox <- Windows VM <- PingCastle
Docker \<- Ubuntu \<- VirtualBox \<- Windows VM \<- PingCastle

That means that we run PingCastle in our Windows VM that runs in a virtualbox inside an ubuntu container.

Expand Down
Loading