@wiz-sec/backstage-plugin-wiz-backend v1.0.1

Wiz Backend Plugin for Backstage

This plugin provides backend functionality for integrating Wiz security information into your Backstage instance.

Features

• Fetch and display Wiz issues
• Access vulnerability findings
• Query issue statistics and severity counts
• Support for cloud resources and version control repositories
• Built-in authentication and error handling for Wiz API

Installation

Add the Backend Plugin

# From your Backstage root directory
yarn add --cwd packages/backend @wiz-sec/backstage-plugin-wiz-backend

Configuration

Add the following to your packages/backend/src/index.ts:

...
import { createBackend } from '@backstage/backend-defaults';
const backend = createBackend();

backend.add(import ('@wiz-sec/backstage-plugin-wiz-backend'));
...

Add the following to your app-config.yaml:

wiz:
  clientId: ${WIZ_CLIENT_ID}
  clientSecret: ${WIZ_CLIENT_SECRET}
  authUrl: ${WIZ_AUTH_URL}
  apiEndpointUrl: ${WIZ_API_URL}

Required environment variables:

• WIZ_CLIENT_ID: Your Wiz service account client ID
• WIZ_CLIENT_SECRET: Your Wiz service account client secret
• WIZ_AUTH_URL: Authentication URL for Wiz API (typically 'https://auth.app.wiz.io/oauth/token')
• WIZ_API_URL: Wiz API endpoint URL

API Endpoints

The plugin exposes the following endpoints:

GET /wiz-issues

Fetches issues based on provided filters.

Query parameters:

• project: Filter by project ID
• relatedEntity: Filter by related entity information
• search: Search term for filtering issues

GET /wiz-vulnerabilities

Fetches vulnerability findings.

Query parameters:

• projectId: Filter by project ID
• assetId: Filter by asset ID
• vulnerabilityExternalId: Filter by external vulnerability ID

GET /wiz-issues-stats

Fetches issue statistics including severity counts and grouped counts.

Query parameters:

• Same as /wiz-issues

Error Handling

The plugin implements comprehensive error handling with the following error types:

• MISSING_CONFIG: Configuration error
• UNAUTHORIZED: Authentication error
• FORBIDDEN: Permission error
• API_ERROR: General API error
• INVALID_REQUEST: Invalid request error