Skip to content

v0.4.7

Choose a tag to compare

@github-actions github-actions released this 02 Nov 21:05
· 582 commits to main since this release

brainproxy 0.4.7

A guided scan for APIs, four new active rules, and a choice of proxy port in the desktop app.

Guided API scan

  • The desktop app's new wizard takes an OpenAPI, Swagger or Postman definition (or a GraphQL schema or endpoint). It shows every operation before anything is sent, then runs one job that sends each ticked operation once and attacks it.
  • On the command line:
    • import api detects the format, and --dry-run previews the import.
    • scan active --api imports and scans in one job.
    • Both take --server, --only, --expect-sha256 and --include-methods.
  • PUT, PATCH, DELETE and GraphQL mutations stay off unless you tick them or pass --include-methods. This holds in later scans too, however the request was recorded.
  • Credentials a document declares are reported by name, never sent or stored. Postman environment files (--environment) are handled the same way.
  • Authentication is optional:
    • API keys in a header or the query (auth add --header-env, --query-key).
    • OAuth 2.0: client credentials, password, refresh token, and browser sign-in with PKCE (auth oauth authorize). Tokens are renewed before they expire and on a 401. auth oauth discover reads an OpenID Connect discovery document.
    • Request signing: AWS SigV4, private-key signatures, and JWTs.
    • A collection's pre-request script can be used as a signer (auth sign add --script), but only after you have read and chosen it. Each script runs in its own process with no file, network or process access, and is stopped after 5 seconds.
  • A refresh token is saved in the project only with --oauth-store-secrets.
  • Through MCP, a tool call can't add a script signer or open a browser. Environment variables it names must start with BRAINPROXY_SECRET_.

Active rules

Four rules ported from ZAP's ascanrulesBeta:

  • CORS misconfiguration (40040)
  • Server Side Request Forgery (40046, uses oob start)
  • NoSQL injection for MongoDB (40033)
  • NoSQL injection for MongoDB, time-based (90039)

scan active now runs 52 rules.

Desktop app

  • Settings › Proxy lets you choose the port the proxy listens on. A running proxy can be moved there, and goes back to the old port if the new one can't be opened.
  • Closing a project stops only a proxy the app started itself, not one started from a shell or an agent.

Known limitations

  • Script signers have a memory limit only on Linux (#65).
  • In the guided API scan, changing the server drops a saved query key without saying so (#66).