From 60dc0ce13ec88294598a5a7f2c60d4924b36e3a8 Mon Sep 17 00:00:00 2001 From: Robert Seedorff Date: Tue, 30 Mar 2021 22:48:54 +0200 Subject: [PATCH 1/2] Adding missing meta data infos to some helmCharts. --- README.md | 17 ++- hooks/declarative-subsequent-scans/Chart.yaml | 13 ++ .../helm2.Chart.yaml | 12 ++ hooks/finding-post-processing/Chart.yaml | 12 ++ .../finding-post-processing/helm2.Chart.yaml | 12 ++ hooks/generic-webhook/Chart.yaml | 12 ++ hooks/generic-webhook/helm2.Chart.yaml | 12 ++ hooks/persistence-defectdojo/Chart.yaml | 14 ++ hooks/persistence-elastic/Chart.yaml | 13 ++ hooks/persistence-elastic/helm2.Chart.yaml | 14 ++ hooks/teams-webhook/Chart.yaml | 13 ++ hooks/teams-webhook/helm2.Chart.yaml | 13 ++ operator/Chart.yaml | 136 ++++++++++++++++++ 13 files changed, 286 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ff5a065ed2..dd71dc53fa 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ License Apache-2.0 GitHub release (latest SemVer) OWASP Incubator Project + Artifact HUB Twitter Follower

@@ -25,13 +26,15 @@ -- [Purpose of this Project](#purpose-of-this-project) -- [Quickstart](#quickstart) -- [Architecture Overview](#architecture-overview) -- [License](#license) -- [Community](#community) -- [Contributing](#contributing) -- [Author Information](#author-information) +- [OWASP secureCodeBox](#owasp-securecodebox) + - [Overview](#overview) + - [Purpose of this Project](#purpose-of-this-project) + - [Quickstart](#quickstart) + - [Architecture Overview](#architecture-overview) + - [License](#license) + - [Community](#community) + - [Contributing](#contributing) + - [Author Information](#author-information) For additional documentation aspects please have a look at our [documentation website](https://docs.securecodebox.io): diff --git a/hooks/declarative-subsequent-scans/Chart.yaml b/hooks/declarative-subsequent-scans/Chart.yaml index 1c53f6d290..c2fe71fbaa 100644 --- a/hooks/declarative-subsequent-scans/Chart.yaml +++ b/hooks/declarative-subsequent-scans/Chart.yaml @@ -8,4 +8,17 @@ type: application version: v2.6.0-alpha1 kubeVersion: ">=v1.11.0-0" +keywords: + - security + - secureCodeBox + - hook +home: https://docs.securecodebox.io/docs/hooks/cascading-scans +icon: https://docs.securecodebox.io/img/integrationIcons/Cascading Scans.svg +sources: + - https://github.com/secureCodeBox/secureCodeBox +maintainers: + - name: iteratec GmbH + email: secureCodeBox@iteratec.com + dependencies: [] + diff --git a/hooks/declarative-subsequent-scans/helm2.Chart.yaml b/hooks/declarative-subsequent-scans/helm2.Chart.yaml index 04afd326c9..f568c2a3a4 100644 --- a/hooks/declarative-subsequent-scans/helm2.Chart.yaml +++ b/hooks/declarative-subsequent-scans/helm2.Chart.yaml @@ -7,3 +7,15 @@ type: application # version - gets automatically set to the secureCodeBox release version when the helm charts gets published version: v2.6.0-alpha1 kubeVersion: ">=v1.11.0-0" + +keywords: + - security + - secureCodeBox + - hook +home: https://docs.securecodebox.io/docs/hooks/cascading-scans +icon: https://docs.securecodebox.io/img/integrationIcons/Cascading Scans.svg +sources: + - https://github.com/secureCodeBox/secureCodeBox +maintainers: + - name: iteratec GmbH + email: secureCodeBox@iteratec.com diff --git a/hooks/finding-post-processing/Chart.yaml b/hooks/finding-post-processing/Chart.yaml index 7c0c4d7d43..6d95de63a8 100644 --- a/hooks/finding-post-processing/Chart.yaml +++ b/hooks/finding-post-processing/Chart.yaml @@ -22,4 +22,16 @@ type: application version: v2.6.0-alpha1 kubeVersion: ">=v1.11.0-0" +keywords: + - security + - secureCodeBox + - hook +home: https://docs.securecodebox.io/docs/hooks/finding-post-processing +icon: https://docs.securecodebox.io/img/integrationIcons/Default.svg +sources: + - https://github.com/secureCodeBox/secureCodeBox +maintainers: + - name: iteratec GmbH + email: secureCodeBox@iteratec.com + dependencies: [] diff --git a/hooks/finding-post-processing/helm2.Chart.yaml b/hooks/finding-post-processing/helm2.Chart.yaml index 73256fedc2..96895f67f3 100644 --- a/hooks/finding-post-processing/helm2.Chart.yaml +++ b/hooks/finding-post-processing/helm2.Chart.yaml @@ -21,3 +21,15 @@ type: application # version - gets automatically set to the secureCodeBox release version when the helm charts gets published version: v2.6.0-alpha1 kubeVersion: ">=v1.11.0-0" + +keywords: + - security + - secureCodeBox + - hook +home: https://docs.securecodebox.io/docs/hooks/finding-post-processing +icon: https://docs.securecodebox.io/img/integrationIcons/Default.svg +sources: + - https://github.com/secureCodeBox/secureCodeBox +maintainers: + - name: iteratec GmbH + email: secureCodeBox@iteratec.com diff --git a/hooks/generic-webhook/Chart.yaml b/hooks/generic-webhook/Chart.yaml index d9b62c8779..0d0966e9bd 100644 --- a/hooks/generic-webhook/Chart.yaml +++ b/hooks/generic-webhook/Chart.yaml @@ -8,4 +8,16 @@ type: application version: v2.6.0-alpha1 kubeVersion: ">=v1.11.0-0" +keywords: + - security + - secureCodeBox + - hook +home: https://docs.securecodebox.io/docs/hooks/generic-webhook +icon: https://docs.securecodebox.io/img/integrationIcons/Generic WebHook.svg +sources: + - https://github.com/secureCodeBox/secureCodeBox +maintainers: + - name: iteratec GmbH + email: secureCodeBox@iteratec.com + dependencies: [] diff --git a/hooks/generic-webhook/helm2.Chart.yaml b/hooks/generic-webhook/helm2.Chart.yaml index 93a4cc4fb6..5e85c3527c 100644 --- a/hooks/generic-webhook/helm2.Chart.yaml +++ b/hooks/generic-webhook/helm2.Chart.yaml @@ -7,3 +7,15 @@ type: application # version - gets automatically set to the secureCodeBox release version when the helm charts gets published version: v2.6.0-alpha1 kubeVersion: ">=v1.11.0-0" + +keywords: + - security + - secureCodeBox + - hook +home: https://docs.securecodebox.io/docs/hooks/generic-webhook +icon: https://docs.securecodebox.io/img/integrationIcons/Generic WebHook.svg +sources: + - https://github.com/secureCodeBox/secureCodeBox +maintainers: + - name: iteratec GmbH + email: secureCodeBox@iteratec.com diff --git a/hooks/persistence-defectdojo/Chart.yaml b/hooks/persistence-defectdojo/Chart.yaml index fcb2f6e269..1cfd760a58 100644 --- a/hooks/persistence-defectdojo/Chart.yaml +++ b/hooks/persistence-defectdojo/Chart.yaml @@ -10,4 +10,18 @@ version: v2.6.0-alpha1 appVersion: 1.12.0 kubeVersion: ">=v1.11.0-0" +keywords: + - security + - secureCodeBox + - hook + - defectdojo + - owasp +home: https://docs.securecodebox.io/docs/hooks/defectdojo +icon: https://docs.securecodebox.io/img/integrationIcons/DefectDojo.svg +sources: + - https://github.com/secureCodeBox/secureCodeBox +maintainers: + - name: iteratec GmbH + email: secureCodeBox@iteratec.com + dependencies: [] diff --git a/hooks/persistence-elastic/Chart.yaml b/hooks/persistence-elastic/Chart.yaml index f249ff279b..87d837c74a 100644 --- a/hooks/persistence-elastic/Chart.yaml +++ b/hooks/persistence-elastic/Chart.yaml @@ -10,6 +10,19 @@ version: v2.6.0-alpha1 appVersion: 7.9.2 kubeVersion: ">=v1.11.0-0" +keywords: + - security + - secureCodeBox + - hook + - elasticsearch +home: https://docs.securecodebox.io/docs/hooks/elasticsearch +icon: https://docs.securecodebox.io/img/integrationIcons/Elasticsearch.svg +sources: + - https://github.com/secureCodeBox/secureCodeBox +maintainers: + - name: iteratec GmbH + email: secureCodeBox@iteratec.com + dependencies: - name: elasticsearch version: 7.9.2 diff --git a/hooks/persistence-elastic/helm2.Chart.yaml b/hooks/persistence-elastic/helm2.Chart.yaml index 3ae1af463b..5b05fa7b53 100644 --- a/hooks/persistence-elastic/helm2.Chart.yaml +++ b/hooks/persistence-elastic/helm2.Chart.yaml @@ -6,5 +6,19 @@ type: application # version - gets automatically set to the secureCodeBox release version when the helm charts gets published version: v2.6.0-alpha1 + appVersion: 7.6.1 kubeVersion: ">=v1.11.0-0" + +keywords: + - security + - secureCodeBox + - hook + - elasticsearch +home: https://docs.securecodebox.io/docs/hooks/elasticsearch +icon: https://docs.securecodebox.io/img/integrationIcons/Elasticsearch.svg +sources: + - https://github.com/secureCodeBox/secureCodeBox +maintainers: + - name: iteratec GmbH + email: secureCodeBox@iteratec.com diff --git a/hooks/teams-webhook/Chart.yaml b/hooks/teams-webhook/Chart.yaml index 5227151b96..338d54be7d 100644 --- a/hooks/teams-webhook/Chart.yaml +++ b/hooks/teams-webhook/Chart.yaml @@ -22,4 +22,17 @@ type: application version: v2.6.0-alpha1 kubeVersion: ">=v1.11.0-0" +keywords: + - security + - secureCodeBox + - hook + - teams +home: https://docs.securecodebox.io/docs/hooks/ms-teams-webhook +icon: https://docs.securecodebox.io/img/integrationIcons/MS Teams WebHook.svg +sources: + - https://github.com/secureCodeBox/secureCodeBox +maintainers: + - name: iteratec GmbH + email: secureCodeBox@iteratec.com + dependencies: [] diff --git a/hooks/teams-webhook/helm2.Chart.yaml b/hooks/teams-webhook/helm2.Chart.yaml index 394ca15f32..208ab19163 100644 --- a/hooks/teams-webhook/helm2.Chart.yaml +++ b/hooks/teams-webhook/helm2.Chart.yaml @@ -21,3 +21,16 @@ type: application # version - gets automatically set to the secureCodeBox release version when the helm charts gets published version: v2.6.0-alpha1 kubeVersion: ">=v1.11.0-0" + +keywords: + - security + - secureCodeBox + - hook + - teams +home: https://docs.securecodebox.io/docs/hooks/ms-teams-webhook +icon: https://docs.securecodebox.io/img/integrationIcons/MS Teams WebHook.svg +sources: + - https://github.com/secureCodeBox/secureCodeBox +maintainers: + - name: iteratec GmbH + email: secureCodeBox@iteratec.com diff --git a/operator/Chart.yaml b/operator/Chart.yaml index 8960d4b43f..eaae4bd529 100644 --- a/operator/Chart.yaml +++ b/operator/Chart.yaml @@ -25,3 +25,139 @@ dependencies: version: 7.1.2 repository: https://helm.min.io/ condition: minio.enabled + +# Artifacthub.io specific annotations +# https://artifacthub.io/docs/topics/annotations/helm/ +annotations: + # artifacthub.io/changes: | + # - Added cool feature + # - Fixed minor bug + artifacthub.io/containsSecurityUpdates: "true" + artifacthub.io/images: | + - name: securecodebox-operator + image: docker.io/securecodebox/operator:v2.6.0-alpha1 + - name: securecodebox-lurcher + image: docker.io/securecodebox/lurcher:v2.6.0-alpha1 + artifacthub.io/crds: | + - kind: Scan + version: v1 + name: Scan + displayName: secureCodeBox Scan + description: | + The Scan Custom Resource Definition (CRD) lets you define how a specific security scan should be configured. + More details about this CRD are documented here: https://docs.securecodebox.io/docs/api/crds/scan + - kind: ScheduledScan + version: v1 + name: ScheduledScan + displayName: secureCodeBox Scheduled Scan + description: | + The ScheduledScan Custom Resource Definition (CRD) lets you define a Scan which gets repeated in a specific time interval, + e.g. every 24 hours or every 7 days. More details about this CRD are documented here: https://docs.securecodebox.io/docs/api/crds/scheduled-scan + - kind: CascadingRule + version: v1 + name: Scan + displayName: secureCodeBox Cascading Rule + description: | + CascadingRules are Custom Resource Definitions (CRD's) used to define how scans can be started automatically based on the results of previous scans. + This lets you run large exploratory scans and automatically start more in depth scans on the targets found by the initial scans. + More details about this CRD are documented here: https://docs.securecodebox.io/docs/api/crds/cascading-rule + - kind: ScanType + version: v1 + name: Scan + displayName: secureCodeBox ScanType + description: | + The ScanType Custom Resource Definition (CRD) is used to define to the secureCodeBox how a specific scanner can be executed in Kubernetes. + The main part of the ScanType is the JobTemplate, which contains a Kubernetes Job definition which will be used to construct the scans Job. + More details about this CRD are documented here: https://docs.securecodebox.io/docs/api/crds/scan-type + - kind: ParseDefinition + version: v1 + name: Scan + displayName: secureCodeBox ParseDefinition + description: | + ParseDefinitions are Custom Resource Definitions (CRD's) used to describe to the secureCodeBox + how it can convert a raw finding report (e.g. XML report from nmap) into the generic secureCodeBox finding format. + More details about this CRD are documented here: https://docs.securecodebox.io/docs/api/crds/parse-definition + - kind: ScanCompletionHook + version: v1 + name: ScanCompletionHook + displayName: secureCodeBox Scan Completion Hook + description: | + ScanCompletionHooks are Custom Resource Definitions (CRD's) used to define custom behavior which should be run after a scan has been completed. + More details about this CRD are documented here: https://docs.securecodebox.io/docs/api/crds/parse-definition + artifacthub.io/crdsExamples: | + - apiVersion: "execution.securecodebox.io/v1" + kind: Scan + metadata: + name: "nmap-scanme.nmap.org" + spec: + scanType: "nmap" + parameters: + # Use nmap's service detection feature + - "-sV" + - scanme.nmap.org + env: + - name: TEST_ENV + valueFrom: + secretKeyRef: + key: secret-name + name: zap-customer-credentials + - name: GREETING + value: "Hello from the secureCodeBox :D" + cascades: + matchLabels: + securecodebox.io/intensive: light + matchExpression: + key: "securecodebox.io/invasive" + operator: In + values: [non-invasive, invasive] + - apiVersion: "execution.securecodebox.io/v1" + kind: ScheduledScan + metadata: + name: "nmap-scanme.nmap.org-daily" + spec: + interval: 24h + scanSpec: + scanType: "nmap" + parameters: + # Use nmaps service detection feature + - "-sV" + - scanme.nmap.org + successfulJobsHistoryLimit: 3 + failedJobsHistoryLimit: 5 + - apiVersion: "cascading.securecodebox.io/v1" + kind: CascadingRule + metadata: + name: "zap-http" + labels: + securecodebox.io/invasive: non-invasive + securecodebox.io/intensive: medium + spec: + matches: + anyOf: + - category: "Open Port" + attributes: + service: http + state: open + - category: "Open Port" + attributes: + service: https + state: open + scanSpec: + scanType: "zap-baseline" + parameters: ["-t", "{{attributes.service}}://{{$.hostOrIP}}"] + artifacthub.io/license: Apache-2.0 + artifacthub.io/links: | + - name: Documentation + url: https://docs.securecodebox.io/docs/getting-started/installation + - name: Homepage + url: https://www.securecodebox.io + - name: iteratec GmbH + url: https://www.iteratec.com + artifacthub.io/operator: "true" + artifacthub.io/operatorCapabilities: Seamless Upgrades + artifacthub.io/prerelease: "false" + artifacthub.io/recommendations: | + - url: https://artifacthub.io/packages/helm/seccurecodebox/auto-discovery + - url: https://artifacthub.io/packages/helm/seccurecodebox/zap + - url: https://artifacthub.io/packages/helm/seccurecodebox/amass + - url: https://artifacthub.io/packages/helm/seccurecodebox/nmap From 8edf48cff0eb36fb298a580bd041576500ab39f1 Mon Sep 17 00:00:00 2001 From: Robert Seedorff Date: Thu, 1 Apr 2021 00:06:11 +0200 Subject: [PATCH 2/2] Updated operator chart with remarks about next steps. --- operator/Chart.yaml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/operator/Chart.yaml b/operator/Chart.yaml index eaae4bd529..6e91565d4f 100644 --- a/operator/Chart.yaml +++ b/operator/Chart.yaml @@ -29,15 +29,17 @@ dependencies: # Artifacthub.io specific annotations # https://artifacthub.io/docs/topics/annotations/helm/ annotations: + # TODO: should be replaced during release process with the release body # artifacthub.io/changes: | # - Added cool feature # - Fixed minor bug artifacthub.io/containsSecurityUpdates: "true" - artifacthub.io/images: | - - name: securecodebox-operator - image: docker.io/securecodebox/operator:v2.6.0-alpha1 - - name: securecodebox-lurcher - image: docker.io/securecodebox/lurcher:v2.6.0-alpha1 + # TODO: docker tags should be replaced during release process with the release version + # artifacthub.io/images: | + # - name: securecodebox-operator + # image: docker.io/securecodebox/operator:v2.6.0-alpha1 + # - name: securecodebox-lurcher + # image: docker.io/securecodebox/lurcher:v2.6.0-alpha1 artifacthub.io/crds: | - kind: Scan version: v1