Integrate Security Audit with Azure Pipelines

You can integrate API Security Audit in Microsoft Azure Pipelines through a custom build task in the extension REST API Static Security Testing.

You must have an account in 42Crunch Platform that the build task in Azure Pipelines can use to access Security Audit. If you do not yet have an account, click here to sign up.

For more details on Azure Pipelines, see Azure Pipelines documentation.

Create an API token for the build task

You must add an API token that the build task uses to authenticate to Security Audit.

  1. Log in to 42Crunch Platform, and click next to your username.
  2. Select API tokens, and click Create new token.
  3. Enter a unique and descriptive name for the token, such as Security Audit token.
  4. In token access rights, select API Security Audit, List resources, and Delete resources.

    A screenshot of Create API Token Wizard with the required access rights marked as selected.

  5. Click Generate token.
  6. Copy the token value, you will need it when you configure REST API Static Security Testing.

    Create API Token Wizard showing the generated token and the buttons for showing the token value and copying it.

Add the build task to your Azure pipeline

To run the build task, you must add it to your Azure pipeline.

  1. Log in to your Azure DevOps account.
  2. If your organization in Azure DevOps does not yet have the extension REST API Static Security Testing installed, install it from Visual Studio Marketplace. This needs to be done only once for each organization: once the task is installed, it is available for the whole organization.
  3. Go to the pipeline where you want to add the build task, and click Edit. The file azure-pipelines.yml opens.
  4. Click the cursor under steps where you want to add the build task, and then find and click on the task called 42Crunch API Security Audit.
  5. Click Variables > New variable, and create the variable 42C_API_TOKEN where the value is the API token you created for the build task, and mark it as a secret, then click OK. The token is stored in the secrets of your Azure pipeline.

    Screenshot of creating a new variable in Azure Pipelines. The name of the created variable is 42C_API_TOKEN, the value is hidden, and the option to keep the value secret has been selected.

  6. Enter the minimum API score that the audited OpenAPI definitions must get from the audit for the build task to succeed. If any API definitions scores lower than the minimum score you set, the build task fails. The default is 75.

    Screenshot of adding the build task to the pipeline.

  7. If you are an enterprise customer not accessing 42Crunch Platform at https://platform.42crunch.com, enter your platform URL. This step is optional and most users do not have to do this. If you are not sure what your platform URL is, contact our support.
  8. Set the level of detail (FATAL, ERROR, WARN, INFO, DEBUG) for the logs that the task produces.
  9. Select if you want to automatically share any new API collections that the build task creates with other users in your organization (off by default). You can also change the sharing of the API collections later in 42Crunch Platform.
  10. Click Add. The build task is added to your pipeline and you can see its definition under steps in azure-pipelines.yml.
  11. Click Save to save your changes to the pipeline. To test the build task, run your Azure pipeline.

The build task will either succeed or fail depending on the minimum score. The plugin also automatically checks the status of all SQGs applied to the APIs it found in the repository. If any of the SQGs fails, the build automatically fails too. The summary of the run in the pipeline jobs provides you further details on how the job went.

The task uploads all discovered OpenAPI definitions to an API collection in 42Crunch Platform. By default when running on branch, the plugin uses the naming convention <shortened-source-control-uri> Branch:<branch-name> for the created API collection, for example, 42Crunch/sample Branch:sample.

An example screenshot showing the collection the build task created in 42Crunch Platform.

The build task uses the build variables Build.Repository.Uri and Build.SourceBranch to get the details directly from your source control.

The API definitions in the collection show the filepaths they have in the repository:

The example screenshot shows the Petstore API imported to 42Crunch Platform from CI/CD, showing the filepath the API definition file has in the repository.

The logs of the run include the URL of each discovered API in the platform. You can copy the URL and paste it to your browser to view the detailed audit report of the corresponding API.

A screenshot of a job log for the audit phase of the build task. The log shows the URLs to the audit reports of five APIs that the build task discovered and audited.

You can further fine-tune how the integration works by adding a configuration file called 42c-conf.yaml to the root directory of your source code repository where the CI/CD pipeline connects to. You can, for example:

  • Map OpenAPI files in your repository to API UUIDS of APIs in the platform.
  • Specify fail_on conditions to define what the plugin reports as failures.
  • Control what happens in the discovery phase.

You can specify different configurations for different branches, tags, or even pull requests. For more details, see the configuration examples in our Resources repository in GitHub.

Configurations for branches and tags is matched based on the name of the branch or tag. Configurations for pull requests is matched based on the target branch.

Change the default collection name

By default when running on branch, the plugin uses the naming convention <shortened-source-control-uri> Branch:<branch-name> for the created API collection, for example, 42Crunch/sample Branch:sample. However, you can specify a different syntax for the new collections that the plugin uses by default.

  1. Go to the pipeline you want and open the settings of the integration plugin for editing.
  2. In Default collection name, enter the syntax for the default collection name you want to use. You can use text (like foo), reference to variables (${repository}), or a combination of the two (foo ${repository}). You can use the following variables that are populated from your repository details:
    • repository: The full repository URL.
    • repo_short_path: A shortened path of the repository URL (the leading / and the trailing .git are omitted).
    • repo_hostname: The hostname from the repository URL.
    • branch_info:The syntax Branch:<branch name>, or an empty string if this information is not available.
    • tag_info: The syntax Tag:<tag name>, or an empty string if this information is not available.
    • pr_info: The syntax PR:<pr id>, or an empty string if this information is not available.
  3. When ready, save your changes.

Next time you run the pipeline, the integration plugin uses the syntax you defined and creates new API collections in 42Crunch Platform (if collections with the same names do not yet exist) where it loads the discovered APIs.

You can also define collection names for specific branches, tags, and pull requests using the property collection_name in the configuration file 42c-conf.yaml.

Set the root directory for the plugin

By default, the integration plugin uses the root directory of your repository as its starting point. However, you can also set a specific directory that the plugin will use as its root.

If you have configured 42c-conf.yaml for your plugin, make sure it is located in the root directory that you want the plugin to use. Otherwise, the configuration file is ignored.

  1. Go to the CI/CD pipeline you want and open the settings of the integration plugin for editing.
  2. In Root directory, enter the path of the directory you want to use as the root directory.
  3. Save your changes.

Next time you run the pipeline, the integration plugin will start the discovery phase from the directory path you defined and check that directory and any subdirectories under it for OpenAPI files.