debian-mirror-gitlab/doc/tutorials/scan_result_policy/index.md

stage	group	info
Govern	Security Policies	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments

Tutorial: Set up a scan result policy (ULTIMATE)

This tutorial shows you how to create and configure a scan result policy. These policies can be set to take action based on scan results. For example, in this tutorial, you'll set up a policy that requires approval from two specified users if a vulnerability is detected in a merge request.

Prerequisites:

The namespace used for this tutorial must:

• Contain a minimum of three users, including your own. If you don't have two other users, you must first create them. For details, see Creating users.

To set up a scan result policy:

1. Create a test project.
2. Add a scan result policy.
3. Test the scan result policy.

Create a test project

1. On the top bar, select Main menu > Projects.
2. Select New project.
3. Select Create blank project.
4. Complete the fields.
   • Project name: sast-scan-result-policy.
   • Select the Enable Static Application Security Testing (SAST) checkbox.
5. Select Create project.

Add a scan result policy

Next, you'll add a scan result policy to your test project:

1. On the top bar, select Main menu > Projects and find the sast-scan-result-policy project.

2. On the left sidebar, go to Security and Compliance > Policies.

3. Select New policy.

4. In Scan result policy, select Select policy.

5. Complete the fields.

   • Name: sast-scan-result-policy
   • Policy status: Enabled

6. Add the following rule:

   IF |Security Scan| from |SAST| find(s) more than |0| |All severity levels| |All vulnerability states| vulnerabilities in an open merge request targeting |All protected branches|
   

7. Set Actions to the following:

   THEN Require approval from | 2 | of the following approvers:
   

8. Select two users.

9. Select Configure with a merge request.

   The application creates a new project to store the policies linked to it, and creates a merge request to define the policy.

10. Select Merge.

11. On the top bar, select Main menu > Projects and select the sast-scan-result-policy project.

12. On the left sidebar, select Security and Compliance > Policies.

    You can see the list of policies added in the previous steps.

Test the scan result policy

Nice work, you've created a scan result policy. To test it, create some vulnerabilities and check the result:

1. On the top bar, select Main menu > Projects and select the sast-scan-result-policy project.

2. On the left sidebar, select Repository > Files.

3. From the Add ({plus}) dropdown list, select New file.

4. In the Filename field enter main.ts.

5. In the file's content, copy the following:

   // Non-literal require - tsr-detect-non-literal-require
   var lib: String = 'fs'
   require(lib)
   
   // Eval with variable - tsr-detect-eval-with-expression
   var myeval: String = 'console.log("Hello.");';
   eval(myeval);
   
   // Unsafe Regexp - tsr-detect-unsafe-regexp
   const regex: RegExp = /(x+x+)+y/;
   
   // Non-literal Regexp - tsr-detect-non-literal-regexp
   var myregexpText: String = "/(x+x+)+y/";
   var myregexp: RegExp = new RegExp(myregexpText);
   myregexp.test("(x+x+)+y");
   
   // Markup escaping disabled - tsr-detect-disable-mustache-escape
   var template: Object = new Object;
   template.escapeMarkup = false;
   
   // Detects HTML injections - tsr-detect-html-injection
   var element: Element =  document.getElementById("mydiv");
   var content: String = "mycontent"
   Element.innerHTML = content;
   
   // Timing attack - tsr-detect-possible-timing-attacks
   var userInput: String = "Jane";
   var auth: String = "Jane";
   if (userInput == auth) {
     console.log(userInput);
   }
   

6. In the Commit message field, enter Add vulnerable file.

7. In the Target Branch field, enter test-branch.

8. Select Commit changes. The New merge request form opens.

9. Select Create merge request.

10. In the new merge request, select Create merge request.

    Wait for the pipeline to complete. This could be a few minutes.

The merge request security widget confirms that security scanning detected one potential vulnerability. As defined in the scan result policy, the merge request is blocked and waiting for approval.

You now know how to set up and use scan result policies to catch vulnerabilities!