backstage-plugin-defectdojo

Welcome to the backstage-plugin-defectdojo plugin!

Getting started

Overview Page - defectdojo Vulnerability Chart

Service Entiry Page - defectdojo Vulnerability Table List

The following sections will help you get the defectdojo plugin setup and running

defectdojo Backend

You need to setup the defectdojo backend plugin before you move forward with any of these steps if you haven't already

Installation

This plugin needs to be added to an existing backstage instance.

# From your Backstage root directory
yarn add --cwd packages/app @geislor/backstage-plugin-defectdojo

Note: You have 2 Options, you can setup both too

Option 1

Add defectdojo Vulnerability chart in to Overview page

Import the plugin to packages/app/src/components/catalog/EntityPage.tsx.

EntityPage.tsx

// ...
import { DefectDojoCard } from '@geislor/backstage-plugin-defectdojo';
// ...
const overviewContent = (
    <Grid container spacing={3} alignItems="stretch">
    {entityWarningContent}
    <Grid item md={6}>
      <EntityAboutCard variant="gridItem" />
    </Grid>
    //...
    <Grid item md={4} xs={12}>
      <DefectDojoCard />
    </Grid>
    <Grid item md={8} xs={12}>
      <EntityHasSubcomponentsCard variant="gridItem" />
    </Grid>    
  </Grid>
);

Option 2

Add defectdojo Vulnerability Table List in to Service Entity

Import the plugin to packages/app/src/components/catalog/EntityPage.tsx and add the following.

EntityPage.tsx

// ...
import { DefectDojoPage } from '@geislor/backstage-plugin-defectdojo';
// ...
const serviceEntityPage = (
    <EntityLayout>
    <EntityLayout.Route path="/" title="Overview">
      {overviewContent}
    </EntityLayout.Route>

    <EntityLayout.Route path="/ci-cd" title="CI/CD">
      {cicdContent}
    </EntityLayout.Route>
    //...
    <EntityLayout.Route path="/defectdojo" title="Security">      
        <DefectDojoPage />    
    </EntityLayout.Route>
    // ...    
  </EntityLayout>
);

Note: If you dont want to display the Service page if no annotation specified in catalog.

//...
import { DefectDojoPage, isdefectdojoAvailable } from '@geislor/backstage-plugin-defectdojo';
//...
<EntityLayout.Route if={isdefectdojoAvailable} path="/defectdojo" title="Security">      
    <DefectDojoPage />    
</EntityLayout.Route>
// ...    

Configuration

Add the following into your app-config.yaml

Config

defectdojo:
  host: https://defectdojo.yourcompany.com/api
  token: YOUR_API_TOKEN

Add the following into your catalog

Catalog

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: backstage
  annotations:
    defectdojo/project: YOUR_PROJECT_NAME/YOUR_PROJECT_VERSION