Integrate Security Audit with Bamboo

You can integrate API Security Audit in Atlassian Bamboo through the app REST API Static Security Testing.

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

For more details on Bamboo, see Bamboo documentation.

Create an API token for the app

You must add an API token that the Bamboo plan uses to authenticate to Security Audit.

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

   

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

   

Add the API token in global variables

Your Bamboo plan must authenticate to 42Crunch Platform to run Security Audit. You can add the API token you just created as a global variable in Bamboo and use it when you configure your Bamboo plan.

1. Log in to your Bamboo account, and click > Bamboo administration > Global variables.
2. Enter a variable name (such as SECRET_42C_API_TOKEN).
3. Add the API token as the value for the global variable, and click Add.

The API token is now added to your global variables in Bamboo and your Bamboo plan can authenticate to Security Audit.

Configure the Bamboo plan

To integrate Security Audit with Bamboo, you must add the app REST API Static Security Testing to your Bamboo server and add a task in your Bamboo plan.

1. If your Bamboo server does not yet have the app REST API Static Security Testing installed, install it from Atlassian Marketplace. This needs to be done only once for each Bamboo server.
2. Go to the Bamboo project and the plan that you want, and click Actions > Configure plan.
3. Click the job you want to integrate with API Security Audit, and add the task REST API Static Security Testing.

   

4. Set API token to access 42Crunch Platform to the global Bamboo variable you added.

   

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

   The fail-on criteria you set in the CI/CD plugin, such as the minimum score, are independent from the acceptance criteria defined in security quality gates (SQGs). This means that your CI/CD build can fail either because the criteria of the plugin are not met, the criteria of a SQG are not met, or both.

6. 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.
7. Set the level of detail (FATAL, ERROR, WARN, INFO, DEBUG) for the logs that the task produces.
8. 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.

   You cannot share API collections if your account belongs to the free community organization. In this case, make sure this setting is off.

9. Click Save to finish configuring the task. To test the integration, run your Bamboo plan.

The task either succeeds or fails 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.

In either case, 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.

The Bamboo app uses the build variables bamboo.planRepository.repositoryUrl and bamboo.planRepository.branchName to get the details directly from your source control.

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

The summary of the build provides you further details on the issues that the task found. 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.

If the build fails because one or more APIs do not meet the criteria you set, these APIs are shown as failures is the build summary:

These failures are also automatically added to tests in your build job:

As issues found in the audit are fixed in the API definitions so that they pass your criteria, they are moved from failed tests to passed tests in the job. This makes it easy to keep track of progress and spot regressions.

Write summary of the plugin run in a file

If you want, you can set the plugin to write and store a report on the plugin run as a JSON file, so that it is easy, for example, to see and communicate the API UUIDs of the uploaded APIs.

This is not the audit report that provides details on the issues that Security Audit found in your APIs and how to remediate them, but a separate, optional summary providing some basic details on the APIs that the plugin processed. The full audit reports are not included in this summary, but are available in 42Crunch Platform.

1. Go to the CI/CD pipeline you want and open the settings of the integration plugin for editing.
2. In Write json report to, enter the filename or path that you want to use for report file. The report is in JSON format, so ensure that you either specify .json as the file extension (as in test/myReport.json) or omit the extension completely (test/myReport).
   • If you specify only the filename, the plugin creates the file in the root directory that it is pointed to start from.
   • If you specify a path, the path must be under the root directory and all specified directories must exist. The plugin only generates the JSON file, not directories.

   The plugin does not delete or overwrite any summaries from previous runs, so if a file with the same name exists, you see an error. To avoid this, you can create a separate workspace for each pipeline pass, add a task to clear the workspace before starting, or include a variable to the filename (such as the build number or timestamp) to ensure that each filename is unique.

3. Save your changes.

Next time you run the pipeline, the integration writes a summary report as a JSON file in the location you specified. This report shows the details on discovered, such as:

• Filename
• API UUID assigned for the API when it was uploaded to 42Crunch Platform
• Audit score
• Did the pipeline task fail and if yes, why
• Any errors that occurred when processing the API

Fine-tune the plugin configuration

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.

  The fail-on criteria you set in the CI/CD plugin, such as the minimum score, are independent from the acceptance criteria defined in security quality gates (SQGs). This means that your CI/CD build can fail either because the criteria of the plugin are not met, the criteria of a SQG are not met, or both.

• 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.

Add tags to APIs

You do not have to wait till your OpenAPI definitions are in 42Crunch Platform to apply tags to them. If you have some tags that you know your APIs need, you can set those tags directly in the CI/CD plugin. The plugin then applies the tags to all new APIs it discovers. For more details, see Tags.

Tags consist of category:tag value pairs, and each tag always has a category it belongs to. Before you start, the categories you want to use must already exist in 42Crunch Platform.

If a tag category allows users to create tags in it, you do not necessarily have to go and create the tags beforehand — in this case, the CI/CD plugin can create any missing tags for you. However, if a tag category does not allow user-created tags, all tags you want to apply must exist before you run your pipeline, otherwise the build task fails. For more details, see Category settings.

1. Go to the CI/CD pipeline you want and open the settings of the integration plugin for editing.
2. In Set tags for newly created APIs, list the tags that you want the plugin to apply to APIs it discovers. If applying multiple tags, separate each key-value pair with a space. For example, if you would want to apply a tag called foo from category1 and a tag called bar from category2, you would enter category1:foo category2:bar.

   Category settings may restrict how you can use the tags from a category, such as how many tags from it you can apply to a single API. The CI/CD plugin cannot apply tags from a category that only allows organization administrators to apply tags.

3. Save your changes.

Next time you run the pipeline, the integration plugin will apply the tags you listed to all new APIs that it discovers in your repository before the APIs are audited. Only newly discovered APIs are tagged: the plugin does not apply tags to APIs it has already uploaded to 42Crunch Platform, nor to any APIs you might have mapped in your 42c-conf.yaml file.

If the CI/CD plugin cannot apply one or more of the tags you have listed, either because the category does not exist or the category settings prevent the plugin from applying using it or creating any missing tags, the plugin fails the build task. If this happens, you can:

• Remove the tags that cause the failure from the plugin configuration.
• Ask you organization administrators to change the settings of the tag categories that are causing the problem.
• Ask your organization administrators to create any missing tags that you need.

Tags created through the CI/CD plugin do not have descriptions, but organization administrators can update the tags to add one.

Use SQG criteria instead of plugin configuration

By default, the integration plugin configuration defines when the CI/CD task passes or fails, and there are some default values that the plugin uses if nothing else is specified. However, if you are using security quality gates (SQGs) in 42Crunch Platform for quality control, you might prefer SQGs to determine when the CI/CD task passes or fails. In this case, you can set the plugin to skip the locally defined fail-on conditions (such as minimum score, format validity, or forbidden issues) and only use those defined in the SQGs.

1. Go to the CI/CD pipeline you want and open the settings of the integration plugin for editing.
2. Select Skip local checks, and save your changes.

Next time you run the pipeline, the plugin will only check the status of all SQGs applied to the APIs it found in the repository when deciding if the build passes or fails, and ignore any fail-on conditions defined in the plugin itself, including the default plugin configuration.

Stop the plugin from failing a pipeline

Sometimes you might want the CI/CD plugin just to report the found issues, not block the pipeline from continuing. For example, your repository might have plenty of APIs in early stages of their lifecycle, or you have just introduced the CI/CD plugin to the pipeline and need time to adjust to the set quality criteria. In this case, you can temporarily switch off all fail-on conditions that the CI/CD plugin would impose on a CI/CD job. The plugin keeps reporting on the discovered APIs but does not block the pipeline from proceeding to subsequent stages.

Switching off the fail-on conditions in the CI/CD plugin means that the plugin will cease to work as a quality control as it will never prevent potential problems in your APIs. We recommend that you use this option only after a careful consideration and only for a limited time. Remember to remove this setting from the plugin as soon as possible.

1. Go to the CI/CD pipeline you want and open the settings of the integration plugin for editing.
2. Select Ignore all failures, and save your changes.

Next time you run the pipeline, the integration plugin runs normally, uploading each discovered API definition and its audit report to 42Crunch Platform, but does not fail the CI/CD job because of the audit results or SQG status. However, the plugin still produces logs as per usual, so you can check them to see the status of the discovered APIs.

Ignore network errors

If you are worried that issues in connectivity — such as in the rare case of the CI/CD plugin not being able to communicate to 42Crunch Platform — could unduly hinder an important CI/CD pipeline by causing it to fail, you can set the plugin to ignore connectivity issues.

Setting the CI/CD plugin to ignore network errors lessens the plugin's effectivity as a quality control, because the task does not stop the CI/CD pipeline even though it could not complete successfully due to a connectivity issue. This means that APIs that have quality or security issues in their OpenAPI definitions could slip through upon a successful CI/CD job. We recommend that you use this option only after a careful consideration.

1. Go to the CI/CD pipeline you want and open the settings of the integration plugin for editing.
2. Select Ignore network failures, and save your changes.

Next time you run the pipeline, if the integration plugin encounters a connectivity issue, it does not fail the CI/CD job and the pipeline proceed to subsequent steps. Errors that cannot be definitively deemed to be connectivity issues will still cause the plugin to fail the job. You can check the logs that the plugin produces to see if any errors occurred.