Skip to main content
Version: 1.5

Creating a security check

A security check is an entity that combines a scanning tool and a scanning source. It's used to run a security scan and obtain scan results.

note

Before you add security checks, make sure the system has an integration configured 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 sequential number of the security check;
  • Source—the scanning source name;
  • Tool—the security tool name;
  • Run (Manual/Automatic);
  • Quality checks;
  • Check status—the quality check status for an individual check;
info

If a quality check fails, you can find out which metrics caused the failure. To do this, select the Failed status. A window opens with a list of quality check 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);

Creating 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 select 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:

  • Selecting a security tool is required when you configure a security check. You can select only a tool that an administrator previously added in the Integrations section;
  • 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.

Adding a new security check

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

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

  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 when you add the tool or source to the security check (API token, username/password).
  • If you select an authentication method while 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 disappears depending on the type of the new source:
    • If the new source doesn't use branches, the branch field is hidden;
    • If it doesn't use images, the tag field is hidden.