Mixeway / MixewayScanner

Mixeway Scanner is Spring Boot application which aggregate integration with number of OpenSource Vulnerability scanners - both SAST and DAST types
https://mixeway.io
MIT License
21 stars 2 forks source link
java rest-api secutiry spring-boot vulnerability-detection vulnerability-scanners

Mixeway Scanner Aggregator

Mixeway Scanner Aggregator is Spring Boot application which aggregate and integrate the most popular OpenSurce Vulnrability scanners avaliable.

Supported Scanners:

Scope of integration

MixewayScanner can be run as REST API or standalone. In REST mode it listen for scan request which contains GIT URL for repository to be scanned. Next it clone repo, create DTrack project and send SBOM. In next phase SAST scanner is executed. Detected vulnerabilities are pushed into console or to Mixeway if integration is configured.

Requirements

Running options

All options and descriptions

Option Required Default Value Description
-e OSS_USERNAME=\<user> No null Sonatype OSS username - required to perform dependency check on projects other then NPM -to generate- https://ossindex.sonatype.org/
-e OSS_KEY=\<key> No null Sonatype OSS API Key - required to perform dependency check on projects other then NPM -to generate- https://ossindex.sonatype.org/
-e MODE=\<REST or STANDALONE> No REST Mode of Scanner to run, in REST Mode API is started on :8443 port, in STANDALONE mode, full scan is performed in mounted directory
-e MIXEWAY_URL=\<url> No https://hub.mixeway.io URL to Mixeway to push results if no Mixeway data is passed results of scan will be print to console
-e MIXEWAY_KEY=\<key> No null CICD API Key - to generate in user profile of Mixeway
-e MIXEWAY_PROJECT_ID=\<id> No null ID of project in mixeway to which detected vulnerailities will be set. Required if You want enable Mixeway integration
-e MIXEWAY_PROJECT_NAME=\<name> No null Name of project. Required for Mixeway integration with STANDALONE scans.
-v \<project_diretory>:/opt/sources Yes (STANDALONE version) null Passing files to scan to docker

Optimization

TLS support for REST API

By default Mixeway Scanner use self-signed TLS certifiate generated during docker build action. If You want to use Your own certificate mount it as certificate.p12 to /opt/pki location (e.g. -v /etc/pki:/opt/pki) and then during docker run pass -e PKCS12_PASSWORD=<password to pkcs12> with PKCS12 password.

Supported Languages

Scanner version Languages
v0.9.0 JAVA-MAVEN
v0.9.1 JAVA-MAVEN, Python3
v0.9.2 JAVA-MAVEN, Python3, PHP