/checkmarx-cxflow-orb

CircleCI orb for running CxFlow

MIT LicenseMIT

Checkmarx CxFlow Orb CircleCI Build Status CircleCI Orb Version GitHub License CircleCI Community

A CircleCI Orb to simplify Checkmarx Scanning of source code along with Result consumption leveraging Checkmarx CxFlow solution.

For full usage guidelines, see the orb registry listing

Usage

Example use-cases are provided on the orb registry page. Source for these examples can be found within the src/examples directory.

There are 3 required environment variables for CircleCI projects to leverage this Orb.

- CHECKMARX_URL: High level dns entry for the Checkmarx Instance including protocol/port (i.e. https://cxsast.example.com)
- CHECKMARX_USERNAME: Service Account within Checkmarx that will be used for triggering scans and retrieving results
- CHECKMARX_PASSWORD: Password of the Service Account.

Resources

CircleCI Orb Registry Page - The official registry page of this orb for all versions, executors, commands, and jobs described.
CircleCI Orb Docs - Docs for using and creating CircleCI Orbs.

How To Contribute

We welcome issues to and pull requests against this repository!

For further questions/comments about this or other orbs, visit the Orb Category of CircleCI Discuss.