Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/reference/components/dependency-track.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
sidebar_custom_props:
icon: "/img/components/dependency-track.svg"
title: 'Dependency Track'
description: 'Reporter that pushes SBOMs to Dependency Track.'
---

# Dependency Track

Reporter component that uploads CycloneDX SBOMs to
[Dependency-Track](https://dependencytrack.org/)
and transforms the found vulnerabilities to OCSF.

## How to use

### Open-Source

This component is only available in the Smithy SaaS

### SaaS

1. In the Smithy UI, open the page to create a new workflow.
2. Configure any workflow that produces vulnerabilities (e.g. sast, sca,
container scanner etc)
3. Find the Dependency Track component in the reporters dropdown.
4. Fill the form on the right

## Options

You can configure this component with the following options:

| Option Name | Description | Default | Type |
|---------------------------|------------------------------------------------------------------|---------|--------|
| dependencytrack_base_url | URL of your DependencyTrack instance | "" | String |
| dependencytrack_api_token | API token for your DependencyTrack instance | "" | String |
| project_name | Project name on Dependency Track | "" | String |
| project_version | Project version on Dependency Track | "" | String |
| sbom_file_path | filepath of the SBOM that you want to upload to Dependency Track | "" | String |
44 changes: 22 additions & 22 deletions docs/reference/components/elasticsearch.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_custom_props:
icon: "/img/components/elasticsearch.svg"
icon: "/img/components/elasticsearch.svg"
title: 'ElasticSearch'
description: 'Reporter that pushes findings to an ElasticSearch instance.'
sidebar_position: 14
Expand All @@ -9,7 +9,7 @@ sidebar_position: 14
# ElasticSearch

Reporter component that pushes findings to an ElasticSearch instance. Read more
about ElasticSearch [here](https://kagi.com/search?q=elasticsearch).
about ElasticSearch [here](https://www.elastic.co/elasticsearch).

## How to use

Expand All @@ -22,11 +22,11 @@ about ElasticSearch [here](https://kagi.com/search?q=elasticsearch).
description: Workflow reporting to elasticsearch
name: elasticsearch
components:
- component: ghcr.io/smithy-security/smithy/manifests/components/targets/git-clone:v1.3.2
- component: ghcr.io/smithy-security/smithy/manifests/components/scanners/gosec:v1.2.3
- component: ghcr.io/smithy-security/smithy/manifests/components/scanners/nancy:v1.2.2
- component: ghcr.io/smithy-security/smithy/manifests/components/enrichers/custom-annotation:v0.1.2
- component: ghcr.io/smithy-security/smithy/manifests/components/reporters/elasticsearch:v1.0.1
- component: ghcr.io/smithy-security/smithy/manifests/components/targets/git-clone:v1.3.2
- component: ghcr.io/smithy-security/smithy/manifests/components/scanners/gosec:v1.2.3
- component: ghcr.io/smithy-security/smithy/manifests/components/scanners/nancy:v1.2.2
- component: ghcr.io/smithy-security/smithy/manifests/components/enrichers/custom-annotation:v0.1.2
- component: ghcr.io/smithy-security/smithy/manifests/components/reporters/elasticsearch:v1.0.1

```

Expand All @@ -36,22 +36,22 @@ components:
```yaml
# file: ./my-workflow/overrides.yaml
git-clone:
- name: "repo_url"
type: "string"
value: "https://github.com/sqreen/go-dvwa"
- name: "reference"
type: "string"
value: "master"
- name: "repo_url"
type: "string"
value: "https://github.com/sqreen/go-dvwa"
- name: "reference"
type: "string"
value: "master"
elasticsearch:
- name: "elasticsearch_url"
type: "string"
value: "Your ES URL here"
- name: "elasticsearch_index"
type: "string"
value: "Any Index"
- name: "elasticsearch_api_key"
type: "string"
value: "An API Key with the rights to read cluster and write indexes"
- name: "elasticsearch_url"
type: "string"
value: "Your ES URL here"
- name: "elasticsearch_index"
type: "string"
value: "Any Index"
- name: "elasticsearch_api_key"
type: "string"
value: "An API Key with the rights to read cluster and write indexes"
```

*Warning*: You need to configure secrets and other parameters for elasticsearch
Expand Down