Skip to content

Commit 20bf7cf

Browse files
committed
Merge branch 'defectdojo_generic_parser_integration' of https://github.com/secureCodeBox/secureCodeBox into defectdojo_generic_parser_integration
2 parents 82a6538 + 464021b commit 20bf7cf

173 files changed

Lines changed: 28388 additions & 9038 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.eslintignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
hooks/declarative-subsequent-scans/hook.js
44
hooks/declarative-subsequent-scans/scan-helpers.js
55
hooks/declarative-subsequent-scans/kubernetes-label-selector.js
6+
**/build/reports/*

‎.eslintrc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"es6": true
77
},
88
"parserOptions": {
9-
"ecmaVersion": 2018
9+
"ecmaVersion": 2020
1010
},
1111
"extends": ["eslint:recommended", "plugin:security/recommended"],
1212
"plugins": ["prettier", "security"],

‎.github/workflows/helm-docs.yaml‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ jobs:
1212
with:
1313
ref: ${{ github.head_ref }}
1414

15+
- name: Import GPG key
16+
uses: crazy-max/ghaction-import-gpg@v3
17+
with:
18+
gpg-private-key: ${{ secrets.GPG_COMMITS_PRIVATE_KEY }}
19+
passphrase: ${{ secrets.GPG_COMMITS_PASSPHRASE }}
20+
git-user-signingkey: true
21+
git-commit-gpgsign: true
22+
1523
- name: Download Helm Docs
1624
run: |
1725
mkdir helm-docs
@@ -25,8 +33,9 @@ jobs:
2533
- name: Generate Helm Docs
2634
run: |
2735
./helm-docs/helm-docs
28-
# Remove helm-docs download to ensure they dont get commited back
36+
# Remove helm-docs download to ensure they don't get commited back
2937
rm -rf helm-docs
30-
- uses: stefanzweifel/git-auto-commit-action@v4.5.1
38+
- uses: stefanzweifel/git-auto-commit-action@v4.11.0
3139
with:
3240
commit_message: Updating Helm Docs
41+
commit_user_email: securecodebox@iteratec.com

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,12 @@ TL;DR
3838
5. merge only after pull request review
3939
6. deploy immediately after review
4040

41+
**_Please make sure to sign all your commits (See: [git-scm](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work))._**
42+
4143
## Working with Forks and Pull Requests
4244

45+
**_Please make sure to sign all your commits (See: [git-scm](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work))._**
46+
4347
If you want to contribute you will need to fork the project.
4448
To enable the use of our CI Pipeline you will need to add these GitHub secrets:
4549

@@ -55,7 +59,7 @@ When you are done, you can convert it to a standard *Pull Request* (or create on
5559

5660
Generally the _secureCodeBox_ project follows the standard [GitHub Pull request process](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
5761

58-
Please make sure to sign all your commits (See: [git-scm](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work)).
62+
**_Please make sure to sign all your commits (See: [git-scm](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work))._**
5963

6064
## Bugfixing and Security Fixing Released Features
6165

‎demo-apps/old-wordpress/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![Version: latest](https://img.shields.io/badge/Version-latest-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 4.0](https://img.shields.io/badge/AppVersion-4.0-informational?style=flat-square)
44

5-
Insecure & Outdated Wordpress Instance: Never expose it to the internet!
5+
Insecure & Outdated WordPress Instance: Never expose it to the internet!
66

77
**Homepage:** <https://wordpress.org>
88

‎demo-apps/old-wordpress/README.md.gotmpl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![Version: latest](https://img.shields.io/badge/Version-latest-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 4.0](https://img.shields.io/badge/AppVersion-4.0-informational?style=flat-square)
44

5-
Insecure & Outdated Wordpress Instance: Never expose it to the internet!
5+
Insecure & Outdated WordPress Instance: Never expose it to the internet!
66

77
**Homepage:** <https://wordpress.org>
88

‎docs/adr/adr_0000.adoc‎

Lines changed: 0 additions & 31 deletions
This file was deleted.

‎docs/adr/adr_0000.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# ADR-0000: Short present tense imperative phrase, less than 50 characters, like a email subject
2+
3+
<!--
4+
Use one of the ADR status parameter based on status
5+
Please add a cross reference link to the new ADR on 'superseded' ADR.
6+
e.g.: {adr_suposed_by} <<ADR-0000>>
7+
-->
8+
| <!-- --> | <!-- --> |
9+
|----------------|----------|
10+
| **Status**: | PROPOSED or ACCEPTED or REJECTED or DEPRECATED or SUPERSEDES [ADR-0000](ADR-0000.md) |
11+
| **Date**: | YYYY-MM-DD |
12+
| **Author(s)**: | John Doe <john.doe@snafu.com>, jane Doe <jane.doe@snafu.com> |
13+
14+
## Context
15+
16+
What is the issue that we’re seeing that is motivating this decision
17+
or change.
18+
19+
## Decision
20+
21+
What is the change that we’re actually proposing or doing.
22+
23+
## Consequences
24+
25+
What becomes easier or more difficult to do because of this
26+
change.

‎docs/adr/adr_0001.adoc‎

Lines changed: 0 additions & 77 deletions
This file was deleted.

‎docs/adr/adr_0001.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# ADR-0001: Choosing the framework for the new secureCodeBox Website
2+
3+
| <!-- --> | <!-- --> |
4+
|----------------|----------|
5+
| **Status**: | ACCEPTED |
6+
| **Date**: | 2019-08-21 |
7+
| **Author(s)**: | Daniel Patanin <daniel.patanin@iteratec.com>, Jannick Hollenbach <jannick.hollenbach@iteratec.com> |
8+
9+
## Context
10+
11+
There are tons of different frameworks for building websites out there. We must choose the most fitting one for our use, fulfilling our mandatory requirements:
12+
13+
• Common programming language, if applicable easy to learn • Overall easy to use and start-up, also locally • Tutorials, examples and a good documentation • Bonus points for great and many easy to use templates and plugins • Needs continuous support and contribution • Must be able to be deployed as GitHub pages
14+
15+
We will choose from the following popular/trending:
16+
17+
- [Gridsome](https://gridsome.org/)
18+
- [Gatsby](https://www.gatsbyjs.org/)
19+
- [Hugo](https://gohugo.io/)
20+
- [Jekyll](https://jekyllrb.com/)
21+
22+
### Research
23+
24+
These frameworks do all fulfill the requirements to the extent that I estimate them as wellsuited. First, I researched the listed features on the respective sites or quickly googled after it specifically and found instantly the requested feature. I followed up with a general overview of how old the frameworks, how popular they are and for example pages build with them. Afterwards I searched for comparison blogs and posts, mostly to examine their comments. Most of these „pro-cons “-posts are inaccurate and very superficial, but luckily because of that the comment sections hold interesting discussions and comparisons from overall features and usability to specific issues and problems of each framework and which framework fits what use-cases in general. After this research I’ve come to a majority of similar experience sharing and discussions. These described the distribution of these frameworks as follows (roughly summarized):
25+
26+
Gridsome is like Gatsby just for VueJS. Gatsby is blazing fast after building the pages but requires a little bit more understanding of JavaScript and React and may not be as easy to get behind if you’ve never built a site with a static site generator before. Hugo is fast in building and based on Golang. But as a newbie to that language you’ll find yourself using the documentation very much, unless you learn this language to a curtain depth. Jekyll is simple in templating and very good for quickly starting a small blog site but based on ruby and therefore requires ruby dependencies.
27+
28+
## Decision
29+
30+
So, it seems that Hugo is a pretty good choice for sites with many, many…. like many pages. Jekyll seems to fit for a quick build. Gatsby and Gridsome require a bit more time to learn but have their advantages in speed and growth of the site. And whether you choose Gridsome over Gatsby relies on whether you want to use VueJS or not.
31+
32+
Finally we’ve decided to use Gatsby. Some of the main reasons is it’s fast performance, the extensive documentation and tutorials and also the language, since Hugo (the other framework we considered mainly) is based on Golang, and as for my part as a developer I feel completely comfortable and prefer working with JSX. Overall it comes down to preferences mostly, since we’re not going to build a giant Website, nor are we planning on implementing “crazy” Features.
33+
34+
## Consequences
35+
36+
For the integration of our multi-repository documentation we’ll use Antora if working this out with Gatsby is going to be more difficult than integrating Antora. We’re aware that using Gatsby requires a bit more maintenance and has the drawback, that if anybody else will maintain or work on the website, this person will need to at least understand the basics of React and GraphQL.

0 commit comments

Comments
 (0)