|
1 |
| -## Step 1: Enable CodeQL |
| 1 | +## Step 1: Enable Code Scanning |
2 | 2 |
|
3 |
| -In this first step, we'll be learning more about [CodeQL](https://codeql.github.com/) and how to use it to secure your source code. |
| 3 | +Let's start by learning a bit about code scanning with [CodeQL](https://codeql.github.com/) and how it helps secure your code. |
4 | 4 |
|
5 | 5 | ### What is GitHub Code Scanning?
|
6 | 6 |
|
7 |
| -[Code scanning](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning) is part of the [GitHub Advanced Security (GHAS)](https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security) product suite. It allows development teams to integrate security testing tools directly into the same process you already use for shipping code. It supports many types such as SAST, container, and infrastructure as code. And the best part is that the results can also live directly in GitHub next to your code. No need for context switching! 🎉 |
| 7 | +[Code scanning](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning) is part of the [GitHub Advanced Security (GHAS)](https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security) product suite. It allows development teams to integrate security testing tools directly into the same process you already use for shipping code. It supports many types such as SAST, container, and infrastructure as code. And, the best part is that the results can also live directly in GitHub next to your code. No need for context switching! 🎉 |
8 | 8 |
|
9 | 9 | > [!TIP]
|
10 |
| -> All of the features of GitHub Advanced Security are 100% free for public repositories. |
| 10 | +> All features of GitHub Advanced Security are free for public repositories. However, private repositories require a compatible [paid account](https://docs.github.com/en/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security). |
11 | 11 |
|
12 | 12 | ### What is CodeQL?
|
13 | 13 |
|
14 | 14 | [CodeQL](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql) is a static analysis testing tool that helps you identify security weaknesses such as SQL injection, cross-site scripting, and code injection issues.
|
15 | 15 |
|
16 |
| -Typically CodeQL patterns are collected into [query suites](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql#about-codeql-queries) of patterns. When combined well, this can be a very powerful! To help with this, teams of security experts have pre-populated suites for many common scenarios and programming languages. |
| 16 | +Typically CodeQL [queries](https://codeql.github.com/docs/writing-codeql-queries/about-codeql-queries/) are collected into [query suites](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql#about-codeql-queries) to cover multiple patterns. When combined well, this can be a very powerful! To help with this, teams of security experts have pre-populated suites for many common scenarios and programming languages. |
17 | 17 |
|
18 | 18 | In many cases, taking advantage of CodeQL is as simple as accepting the default suite, but you can also select the extended suite or customize your own with [GitHub Actions]().
|
19 | 19 |
|
20 | 20 | <img width="200" align="right" alt="codeql default configuration box" src="https://github.com/user-attachments/assets/cf5ba96b-98bb-4db5-b743-bd31bceaabac"/>
|
21 | 21 |
|
22 |
| -Here are some options the default configuration provides: |
| 22 | +Here are some of the options the default configuration provides: |
23 | 23 |
|
24 |
| -- **Languages:** The languages automatically detected in your repository that CodeQL will scan. |
| 24 | +- **Languages:** Supported languages will automatically detected in your repository and scanning will be enabled. |
25 | 25 |
|
26 | 26 | - **Query suites:** A list of the available suites of patterns that will be used. The **Default** or **Extended** are provided automatically.
|
27 | 27 |
|
|
0 commit comments