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
about: 'Suggest an idea for a new security scanner to integrate in this project.'
labels: 'security scanner'
---
## New Scanner implementation request
**Is your feature request related to a problem? Please describe.**
- _A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_
**Describe the solution you'd like**
- _A clear and concise description of what you want to happen._
**Describe alternatives you've considered**
- _A clear and concise description of any alternative solutions or features you've considered._
**Additional context**
- _Add any other context or screenshots about the feature request here._
## Steps to implement a new scanner
> Hint: A general guide how to implement a new scanner is documented [here]( https://github.com/secureCodeBox/secureCodeBox/blob/master/docs/developer-guide/README.md#developing-own-processes)
### Must have
- [ ] Create a [new public secureCodeBox repository](https://github.com/organizations/secureCodeBox/repositories/new) for the scanner implementation
- [ ] Implement a new scanner microservice an reuse some of the existing stuff, if possible
- [ ] Check if there is a [healthcheck](https://github.com/secureCodeBox/secureCodeBox/blob/master/docs/developer-guide/README.md#healthchecks-for-scanner-microservices) for the microservice implemented
- [ ] Implement a [new basic security process](https://github.com/secureCodeBox/secureCodeBox/blob/master/docs/developer-guide/README.md#developing-a-process-model) for the scanner
- [ ] Update the [docker-compose](https://github.com/secureCodeBox/secureCodeBox/blob/master/docker-compose.yml) files and integrate your new scanner there
- [ ] Update the [user guide](https://github.com/secureCodeBox/secureCodeBox/tree/master/docs/user-guide) and [developer guide](https://github.com/secureCodeBox/secureCodeBox/tree/master/docs/developer-guide)
- [ ] Implement a integration test for the scanner [here](https://github.com/secureCodeBox/secureCodeBox/tree/master/test)
### Should have
- [ ] Update the [CLI examples](https://github.com/secureCodeBox/secureCodeBox/tree/master/cli)
- [ ] Update the [Jenkins Pipeline](https://github.com/secureCodeBox/integration-pipeline-jenkins-examples) examples
- [ ] Update the [OpenShift Container Setup](https://github.com/secureCodeBox/ansible-role-securecodebox-openshift)
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
| `DEFECT_DOJO_USER` | Username of the DefectDojo user responsible for the scan. Defaults to username of the technical user | john_doe | no |
| `SCB_BRANCH` | Tag or branch of the product the engagement tested | develop | no |
| `SCB_BUILD_ID` | Build ID of the product the engagement tested | 1.0 | no |
| `SCB_COMMIT_HASH` | Commit hash from repo | 9a03412 | no |
| `SCB_TRACKER` | Link to epic or ticket system with changes to version | http://your-ticket-system.com | no |
| `SCB_REPO` | Repository | http://your-remote-repository.com | no |
| `SCB_BUILD_SERVER` | Build server responsible for CI/CD test | http://your-build-server.com | no |
| `SCB_SCM_SERVER` | Source code server for CI/CD test | http://your-scm-server.com | no |
| `SCB_ENGAGEMENT_TITLE`| Title for the engagement. Defaults to name of the supported scanner or "Generic Findings Import" | Engagement No.1337 | no |
An example security test with these values set would look like this.
This configuration has only one **mandatory** parameter, which is the **context** of the security scan. This has to be the same as the product name inside DefectDojo related to the scan. Once the scan is finished a new engagment for the product and all findings are getting imported.
Other than the context, there are also a number of optional params, which are used to populate other fields of the DefectDojo engagment.
These can be set by passing them in the `metaData` param of the securityTest.
| Meta Field | Description | Example Value | Mandatory |
| `DEFECT_DOJO_USER` | Username of the DefectDojo user responsible for the scan. Defaults to username of the technical user | john_doe | no |
| `SCB_BRANCH` | Tag or branch of the product the engagement tested | develop | no |
| `SCB_BUILD_ID` | Build ID of the product the engagement tested | 1.0 | no |
| `SCB_COMMIT_HASH` | Commit hash from repo | 9a03412 | no |
| `SCB_TRACKER` | Link to epic or ticket system with changes to version | http://your-ticket-system.com | no |
| `SCB_REPO` | Repository | http://your-remote-repository.com | no |
| `SCB_BUILD_SERVER` | Build server responsible for CI/CD test | http://your-build-server.com | no |
| `SCB_SCM_SERVER` | Source code server for CI/CD test | http://your-scm-server.com | no |
| `SCB_ENGAGEMENT_TITLE` | Title for the engagement. Defaults to name of the supported scanner or "Generic Findings Import" | Engagement No.1337 | no |
An example security test with these values set would look like this:
```json
[
{
"name": "nmap",
"context": "feature-team-1/product-1",
"context": "product-1",
"target": {
"name": "Test Server",
"location": "10.11.11.11",
Expand All
@@ -91,15 +94,15 @@ An example security test with these values set would look like this.
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
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.
Bump axios from 0.18.0 to 0.18.1 in /test #85
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Uh oh!
There was an error while loading. Please reload this page.
Bump axios from 0.18.0 to 0.18.1 in /test #85
Filter by extension
Only manifest files
Viewed files
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Uh oh!
There was an error while loading. Please reload this page.