README
¶
Dracon
Security pipelines on Kubernetes. The purpose of this project is to provide a scalable and flexible tool to execute arbitrary tools on arbitrary code while processing the results in a flexible way.
Getting Started
The Getting started in Minikube tutorial explains how to install, configure, and run Dracon.
Other tutorials are also available:
| Name | Description |
|---|---|
| Getting started in Minikube | Beginner guide on how to get started with Dracon |
| Running our demo pipeline | End to end demo of running an example pipeline |
| Example of using a public git repo | Example of running Dracon against a public git repository |
| Example of using a private git repo | Example of running Dracon against a private git repository |
| Creating your own pipeline | WIP: How to create your own custom dracon pipeline |
| Creating your own producer | WIP: Extending Dracon by creating your own custom producer |
| Creating your own consumer | WIP: Extending Dracon by creating your own custom consumer |
Installing
We have compiled binaries for dracon in under GitHub releases. dracon can quickly be installed into your home directory by executing:
bash <(curl -s https://raw.githubusercontent.com/thought-machine/dracon/master/scripts/install.sh)
Announcements
Dracon was announced at OWASP Appsec Amsterdam in 2019. Check out the slides from the presentation.
Support
If you have questions, reach out to us by opening a new issue on Github.
Development & Contributing
Contributions are welcome, see the developing and releasing guides on how to get started.
License
Dracon is under the Apache 2.0 license. See the LICENSE file for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
common
|
|
|
Package consumers provides helper functions for working with Dracon compatible outputs as a Consumer.
|
Package consumers provides helper functions for working with Dracon compatible outputs as a Consumer. |
|
pkg
|
|
|
Package producers provides helper functions for writing Dracon compatible producers that parse tool outputs.
|
Package producers provides helper functions for writing Dracon compatible producers that parse tool outputs. |
|
mobsf
Package main implements a Dracon producer for MobSF, a mobile security framework (https://github.com/MobSF/Mobile-Security-Framework-MobSF).
|
Package main implements a Dracon producer for MobSF, a mobile security framework (https://github.com/MobSF/Mobile-Security-Framework-MobSF). |
|
mobsf/report
Package report provides common types for scan report formats.
|
Package report provides common types for scan report formats. |
|
mobsf/report/android
Package android provides types and functions for working with Android project scan reports from MobSF.
|
Package android provides types and functions for working with Android project scan reports from MobSF. |
|
mobsf/report/ios
Package ios provides types and functions for working with iOS project scan reports from MobSF.
|
Package ios provides types and functions for working with iOS project scan reports from MobSF. |
|
npm_audit/types
Package types provides common types for audit report formats.
|
Package types provides common types for audit report formats. |
|
npm_audit/types/npmfullaudit
Package npmfullaudit provides types and functions for working with audit reports from npm's "Full Audit" endpoint (/-/npm/v1/security/audits) and transforming them into data structures understood by the Dracon enricher.
|
Package npmfullaudit provides types and functions for working with audit reports from npm's "Full Audit" endpoint (/-/npm/v1/security/audits) and transforming them into data structures understood by the Dracon enricher. |
|
npm_audit/types/npmquickaudit
Package npmquickaudit provides types and functions for working with audit reports from npm's "Quick Audit" endpoint (/-/npm/v1/security/audits/quick) and transforming them into data structures understood by the Dracon enricher.
|
Package npmquickaudit provides types and functions for working with audit reports from npm's "Quick Audit" endpoint (/-/npm/v1/security/audits/quick) and transforming them into data structures understood by the Dracon enricher. |
Click to show internal directories.
Click to hide internal directories.