Documentation
OSS Tool Images
Project-Agent-trust-merge / arxsec-api/docker/oss-tools/README.md
Docker images that wrap community / open-source security tools so ARX can invoke them through the community-oss sandbox profile.
Each tool gets its own subdirectory with a pinned Dockerfile. The connector Python module references the published image tag via a DEFAULT_<TOOL>_IMAGE constant; production deployments should pin by SHA digest at deploy time.
Adding a new tool
- Create
<tool>/Dockerfilehere. Use a non-root user (arx, uid 10001),
make /work writable, install the tool at a pinned version, and set the tool binary as ENTRYPOINT.
- Add a connector module under
arxsec-api/app/connectors/<tool>.py
following the garak / promptfoo pattern.
- Add the connector to
CONNECTOR_REGISTRYandCONNECTOR_METADATAin
arxsec-api/app/connectors/__init__.py.
- Add a credential schema entry in
arxsec-api/app/connectors/schemas.py (use LLM_PROVIDER_CREDS for AI-targeting tools).
- Add unit tests under
arxsec-api/tests/test_oss_<tool>.py.
Images are intended to be built and published to ghcr.io/arxsec/oss-tools/<tool> on each merge to main via a future GitHub Actions workflow.