Integrate Security Audit with GitLab Pipelines

You can integrate API Security Audit in GitLab Pipelines through a custom job REST API Static Security Testing.

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

For more details on GitLab Pipelines, see GitLab CI/CD documentation.

Create an API token for the job

You must add an API token that the job 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 a protected CI/CD variable for the API token

Before you add the job to your GitLab pipeline, you must add the API token you created as a protected environment variable in your GitLab project. You must be a project maintainer to be able to create project variables.

  1. Log in to GitLab, go to the project you want, and click Settings > CI/CD.
  2. Under Variables, click Add variable.
  3. Set the following:
    • Name: X42C_API_TOKEN (the job expects to find a token with this precise name)
    • Value: The value of the API token you created

    An example screenshot of adding the protected environment variable in Gitlab.

  4. Make sure the type is Variable and choose the environments where the you want to use it.
  5. Make sure that Protect variable and Mask variable are both selected to avoid any risk for the token leaking, and click Add variable.

You have now created a protected CI/CD variable that the pipeline job can use to authenticate to Security Audit. You can use the same variable in mutiple projects. For more details, see GitLab CI/CD variables.

Add the job to your GitLab pipeline

To run the job, you must add it to your GitLab pipeline.

  1. In GitLab, go to the project you want, and click CI/CD > Editor to open Pipeline Editor.
  2. Add the latest image version of REST API Static Security Testing and the shell script the Runner in GitLab executes:
    audit:
      stage: test
      image:
        name: 42crunch/gitlab-api-security-audit:v3
      script: /audit/audit.sh

    Note that the bit denoting the version (here v3) changes with each major version of the plugin.

  3. If you want, add the minimum audit score that the audited OpenAPI definitions must get from the audit for the action to succeed. If any API definitions score lower than the minimum score you set for X42C_MIN_SCORE, the job fails. The default is 75:
    audit:
      stage: test
      image:
        name: 42crunch/gitlab-api-security-audit:v3
      variables:
        X42C_MIN_SCORE: 51
      script: /audit/audit.sh
  4. If you are an enterprise customer not accessing 42Crunch Platform at https://platform.42crunch.com, add X42C_PLATFORM_URL and 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.
    audit:
      stage: test
      image:
        name: 42crunch/gitlab-api-security-audit:v3
      variables:
        X42C_MIN_SCORE: 51
        X42C_PLATFORM_URL: <your platform URL here>
      script: /audit/audit.sh
  5. By default, the level of detail in the logs that the job produces is INFO. If you want more or less detail, you can use X42C_LOG_LEVEL to specify the level of detail. The possible values are FATAL, ERROR, WARN, INFO, DEBUG):
    audit:
      stage: test
      image:
        name: 42crunch/gitlab-api-security-audit:v3
      variables:
        X42C_MIN_SCORE: 51
        X42C_LOG_LEVEL: DEBUG
      script: /audit/audit.sh
  6. If you want to automatically share any new API collections that the job creates with other users in your organization, add the variable X42C_SHARE_EVERYONE. The variable has two possible values:
    • READ_ONLY: Other users have read-only access
    • READ_WRITE: Other users have also write access

    If you do not define X42C_SHARE_EVERYONE at all, the API collections are not shared and remain private to you.

    audit:
      stage: test
      image:
        name: 42crunch/gitlab-api-security-audit:v3
      variables:
        X42C_MIN_SCORE: 51
        X42C_LOG_LEVEL: DEBUG
        X42C_SHARE_EVERYONE: READ_ONLY
      script: /audit/audit.sh

    You can also change the sharing of the API collections later. For more details, see Sharing APIs and access level.

  7. Click Commit changes to save your changes to the pipeline. To test the job, run your pipeline.

The job will either succeed or fail depending on the minimum score. The summary of the run in the pipeline reports provides you further details on how the job went.

The job uploads all discovered OpenAPI definitions to the specified API collection in 42Crunch PlatformBy 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 GitLab job uses the build variables CI_PROJECT_URL and CI_COMMIT_REF_NAME 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 report of the run includes a link to each discovered API. You can click on the link to view the detailed audit report of the corresponding API in 42Crunch Platform.

A screenshot of a report from the job. The report shows the links to the audit reports of APIs that the job 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.

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 project you want, and open the Pipeline Editor.
  2. Add the variable X42C_DEFAULT_COLLECTION_NAME to the audit stage, and 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 project you want, and open the Pipeline Editor.
  2. Add the variable X42C_ROOT_DIRECTORY to the to the audit stage, and 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.