Skip to main content
Version: 1.6

Create a security check

Security check is an entity that combines a scanning tool and a scanning source. You use it to run security scans and get scan results.

note

Before you add security checks, make sure the system has an integration configured with the required scanning sources. For more information, 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 security layer contain the following data:

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

If a quality check fails, you can see which metrics caused the failure. Select the Failed status to open the 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 the Manual tool 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 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:

  • You must select a security tool when you configure a security check. 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. Check the connection to the tool by selecting Check connection.
info

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

info

You can also check the connection to the security tool in Integrations → Security tools. Select the additional actions button (Additional actions) next to the integration, and select Check 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 they created the integration with the security tool or scanning source, you must enter authentication information when you add the tool or source to a security check (API token, username, or Password).
  • If you select an authentication method when you create a security check, you must enter authentication information.
  • When you edit a scanning source in an existing security check, the Source branches/tags field appears or disappears based 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.