Skip to main content
Version: 1.6.1

Create a security check

A security check combines a scanning tool and a scanning source. Use it to run a security scan and get scan results.

note

Before you add security checks, make sure the system has an integration with the required scanning sources (see Integrations → Security sources).

If you have system permissions to manage scanning sources, you can add the required sources. For more information, see Scanning sources.

Security check parameters​

Security checks within a layer contain the following data:

  • #—the security check's sequence number;
  • Source—the scanning source name;
  • Tool—the security tool name;
  • Run (Manual/Automatic);
  • Quality controls;
  • Check status—the quality control status for an individual check;
info

If a quality control fails, you can find out which metrics failed. Select the Failed status to open a window with the list of quality control metrics.

  • Scan results for an individual check;
  • Security issues for an individual check;
  • Additional actions for the check:
    • Start a new scan;
    • Edit check;
    • Import results;
    • Import SBOM;
    • Delete check;
    • Add security issues manually (available for tools of the Manual type);

Create a new security check​

To add a security check, follow these steps:

  1. Go to Projects → Project name → Security layers → Project layer.
  2. Select Add (if no checks have been added) or Add security check.
  3. Enter the data in the security check creation form.
info

Keep the following in mind when you fill out the form:

  • when you configure a security check, selecting a security tool is required. You can select only a tool that an administrator previously added in Integrations;
  • the form fields depend on the selected Source and Tool fields;
  • you can add multiple source branches/tags when you create a check;
  • for some security tools, you can select the scan run type (manual or automatic), the run frequency, and the scan run time for automatic runs;
  • when you select the Appscreener SAST tool, you can generate and download an API request.

Add a new security check

  1. Verify the connection to the tool by selecting Verify connection.
info

You can verify the connection only if you entered the security tool's authentication data correctly. If the data is correct, the connection verification succeeds. If the connection fails, check the data and try again.

info

You can also verify the connection to the security tool in Integrations → Security tools. Select the additional actions button (Additional actions) next to the integration, and select Verify connection.

  1. Select Create.
caution

Keep the following in mind when you create a security check:

  • If the system administrator didn't specify an authentication method when creating the integration with the security tool or scanning source, you must enter authentication data (API token, username/password) when adding the tool or source to the security check.
  • If you select an authentication method when creating the security check, you must enter authentication data.
  • When you edit the scanning source in an existing security check, the Source branches/tags field appears or is hidden depending on the new source type:
    • If the new source doesn't use branches, the branch field is hidden;
    • If it doesn't use images, the tag field is hidden.