Skip to content

Remove API Security branding from analyzer output

Problem

The API Security analyzer operates in two modes, DAST API, and API Fuzzing. The console output should reflect this and match our documentation layout. API Security is becoming a category with multiple features in it, and should not be the public facing name of the analyzer.

Proposal

Replace API Security in output with the feature names DAST API and API Fuzzing depending on which mode of operation the analyzer is operating in.

The implementation should define a constant in each component allowing the names to be updated easily in the future.

Current output sample:

02:31:14 [INF] API Security: Gitlab API Security
02:31:14 [INF] API Security: -------------------
02:31:14 [INF] API Security: 
02:31:14 [INF] API Security: version: 0.0.0

Proposed change for DAST API:

02:31:14 [INF] DAST API: Gitlab DAST API
02:31:14 [INF] DAST API: ---------------
02:31:14 [INF] DAST API: 
02:31:14 [INF] DAST API: version: 0.0.0

Proposed change for API Fuzzing:

02:31:14 [INF] API Fuzzing: Gitlab API Fuzzing
02:31:14 [INF] API Fuzzing: ------------------
02:31:14 [INF] API Fuzzing: 
02:31:14 [INF] API Fuzzing: version: 0.0.0

Tasks:

  1. Implement changes to worker-entry
  2. Implement changes to PeachWeb
  3. Add tests to detect API Security string in logs and console output
  4. Update output examples in documentation
  5. Publish new image, then let tech reviewer it can be safely merged Remove API Security branding from documentation... (!102783 - merged)
Edited by Herber Madrigal