Configuration

The Javelin RedTeam configuration system provides comprehensive control over scan parameters, target applications, vulnerability categories, and attack engines.

Configuration Structure

The main configuration consists of several key sections:

# Application under test
app_config:
  name: "MyApplication"
  description: "Application description for context"
  endpoint: "https://api.example.com/chat"

# Scan parameters
scan_config:
  parameters:
    maxScenarios: 10
    timeout: 5
    concurrency: 2
    reportFormat: "markdown"
    categories: ["data_privacy", "security"]

# Framework-level settings (optional)
framework:
  database_url: "postgresql://..."
  redis_url: "redis://..."
  max_concurrent_scans: 2

Application Configuration

Basic Application Settings

Field
Type
Description
Default

name

string

Application name for reporting

Required

description

string

Detailed description of target app for context generation

Required

endpoint

string

Target HTTP endpoint URL

Required

headers

object

HTTP headers to include

payload_template

object

Request payload template with {{query}} placeholder

Required

Scan Configuration

Parameter
Type
Permissible Values
Description

maxScenarios

integer

1-1000

Test cases generated per category

timeout

integer

1-300

Maximum scan duration in minutes

concurrency

integer

1-10

Parallel test execution count

reportFormat

string

Markdown, JSON, PDF, HTML

Output format

categories

list

15 vulnerability categories

List of vulnerability categories to test (e.g., data_privacy, security, responsible_ai, prompt_injection)

Category Selection

Configuration Validation

Javelin RedTeam validates configuration before execution:

Best Practices

  1. Start Simple: Begin with basic categories and low test counts

  2. Environment Separation: Use different configs for dev/staging/prod

  3. Incremental Testing: Gradually increase scope and complexity

  4. Resource Management: Monitor concurrency and timeouts

  5. Documentation: Document custom configurations and rationale

Troubleshooting

Common configuration issues:

  • Invalid Categories: Ensure category names match supported options

  • Authentication Failures: Verify API keys and permissions

  • Timeout Issues: Adjust timeout and concurrency settings

  • Resource Limits: Check framework limits for your deployment

  • Model Availability: Ensure specified models are accessible

Last updated