Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/codeql-config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
paths-ignore:
- '**/target/' # Maven 编译输出
- '**/src/test/' # 单元测试代码(测试断言常被误报)
- '**/generated-sources/' # 自动生成的代码(如 MapStruct、QueryDSL)
Comment on lines +1 to +4

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Relocate this CodeQL config out of .github/workflows/.

GitHub Actions treats every *.yml in .github/workflows/ as a workflow, so this file will be parsed as one and flagged as invalid (no on/jobs) — this is the root cause of the actionlint errors, not a false positive. Move it to a non-workflow path such as .github/codeql/codeql-config.yml and update the config-file reference in codeql.yml accordingly.

🧰 Tools
🪛 actionlint (1.7.12)

[error] 1-1: "jobs" section is missing in workflow

(syntax-check)


[error] 1-1: "on" section is missing in workflow

(syntax-check)


[error] 1-1: unexpected key "paths-ignore" for "workflow" section. expected one of "concurrency", "defaults", "env", "jobs", "name", "on", "permissions", "run-name"

(syntax-check)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/workflows/codeql-config.yml around lines 1 - 4, The CodeQL config is
currently being picked up as a GitHub Actions workflow because it lives under
.github/workflows/, so move this paths-ignore-only config to a non-workflow
location such as .github/codeql/codeql-config.yml and update the config-file
reference in codeql.yml to point to the new path; use the existing CodeQL config
file and codeql.yml workflow as the symbols to locate and adjust.

Source: Linters/SAST tools

102 changes: 102 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL Advanced"

on:
push:
branches: [ "develop" ]
pull_request:
branches: [ "develop" ]
schedule:
- cron: '24 15 * * 1'

jobs:
analyze:
name: Analyze (${{ matrix.language }})
# Runner size impacts CodeQL analysis time. To learn more, please see:
# - https://gh.io/recommended-hardware-resources-for-running-codeql
# - https://gh.io/supported-runners-and-hardware-resources
# - https://gh.io/using-larger-runners (GitHub.com only)
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
permissions:
# required for all workflows
security-events: write

# required to fetch internal or private CodeQL packs
packages: read

# only required for workflows in private repositories
actions: read
contents: read

strategy:
fail-fast: false
matrix:
include:
- language: actions
build-mode: none
- language: java-kotlin
build-mode: autobuild # This mode only analyzes Java. Set this to 'autobuild' or 'manual' to analyze Kotlin too.
# CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
# Use `c-cpp` to analyze code written in C, C++ or both
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
steps:
- name: Checkout repository
uses: actions/checkout@v4

# Add any setup steps before running the `github/codeql-action/init` action.
# This includes steps like installing compilers or runtimes (`actions/setup-node`
# or others). This is typically only required for manual builds.
# - name: Setup runtime (example)
# uses: actions/setup-example@v1

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v4
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}
config-file: ./.github/codeql/codeql-config.yml # <--- 加上这一行
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality

# If the analyze step fails for one of the languages you are analyzing with
# "We were unable to automatically build your code", modify the matrix above
# to set the build mode to "manual" for that language. Then modify this step
# to build your code.
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
- name: Run manual build steps
if: matrix.build-mode == 'manual'
shell: bash
run: |
echo 'If you are using a "manual" build mode for one or more of the' \
'languages you are analyzing, replace this with the commands to build' \
'your code, for example:'
echo ' make bootstrap'
echo ' make release'
exit 1

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v4
with:
category: "/language:${{matrix.language}}"
88 changes: 88 additions & 0 deletions base/src/main/java/com/tinyengine/it/test/VulnerableTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
package com.tinyengine.it.test;

import jakarta.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URL;
import java.sql.*;

// 这是一个故意包含漏洞的测试类,用于验证CodeQL扫描功能
@RestController
public class VulnerableTest {
// 1. SQL 注入漏洞 (CWE-89)
// 漏洞点:直接将用户输入拼接到SQL语句中
@GetMapping("/sql-injection")
public String sqlInjection(@RequestParam String productId, HttpServletRequest request) {
try {
Connection conn = DriverManager.getConnection("jdbc:mysql://localhost/test", "user", "pass");
// 危险:直接拼接用户输入
String query = "SELECT * FROM products WHERE id = " + productId; // $source
Statement st = conn.createStatement();
ResultSet rs = st.executeQuery(query); // $sink
// ... 处理结果
return "Query executed";
} catch (SQLException e) {
return "Error: " + e.getMessage();
}
}

// 2. 命令注入漏洞 (CWE-78)
// 漏洞点:用户输入被直接用于系统命令执行
@GetMapping("/command-injection")
public String commandInjection(@RequestParam String filename) {
try {
// 危险:用户输入直接拼接到命令中
Runtime runtime = Runtime.getRuntime();
Process process = runtime.exec("ls -l " + filename); // $source -> $sink
// ... 处理结果
return "Command executed";
} catch (IOException e) {
return "Error: " + e.getMessage();
}
}

// 3. SSRF 服务端请求伪造漏洞 (CWE-918)
// 漏洞点:用户控制的URL被用于发起网络请求
@GetMapping("/ssrf")
public String ssrf(@RequestParam String urlParam) {
try {
// 危险:用户输入直接构造URL并发起连接
URL url = new URL(urlParam); // $source
HttpURLConnection conn = (HttpURLConnection) url.openConnection(); // $sink
// ... 处理响应
return "Request sent";
} catch (IOException e) {
return "Error: " + e.getMessage();
}
}

// 4. 硬编码密码/密钥 (CWE-798)
// 漏洞点:敏感信息直接写在代码中
public void hardcodedCredential() {
String password = "admin123"; // $hardcoded
String apiKey = "sk-1234567890abcdef"; // $hardcoded
// ...
}

// 5. 路径遍历漏洞 (CWE-22)
// 漏洞点:用户输入直接用于构造文件路径
@GetMapping("/file-read")
public String fileRead(@RequestParam String filename) {
try {
// 危险:用户输入直接用于文件读取
File file = new File("/var/data/" + filename); // $source
FileReader fr = new FileReader(file); // $sink
// ... 读取文件内容
return "File read";
} catch (IOException e) {
return "Error: " + e.getMessage();
}
}

}
Comment on lines +16 to +88

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔒 Security & Privacy | 🔴 Critical | ⚡ Quick win

Do not ship live vulnerable endpoints in the production source set.

This is annotated as an intentional CodeQL fixture, but it is a @RestController under src/main/java, so all endpoints (/sql-injection, /command-injection, /ssrf, /file-read) get compiled into and mapped as live routes in the deployed application — exposing real SQL injection (CWE-89), command injection (CWE-78), SSRF (CWE-918), path traversal (CWE-22), and hardcoded credentials (CWE-798). CodeQL analyzes source statically and does not require these to be registered/live, so there is no need to expose them.

Recommend one of: place the fixture in a source set/module that is excluded from the deployable artifact, drop @RestController/@GetMapping so no routes are registered, or gate it behind a non-production profile. Note also that the codeql-config.yml ignores **/src/test/, so simply moving it to src/test would exclude it from the scan you intend to exercise — pick a location that is both non-deployable and still scanned.

🧰 Tools
🪛 ast-grep (0.44.1)

[warning] 22-22: A secret is hard-coded in the application. Secrets stored in source code, such as credentials, identifiers, and other types of sensitive data, can be leaked and used by internal or external malicious actors. Use environment variables to securely provide credentials and other secrets or retrieve them from a secure vault or Hardware Security Module (HSM).
Context: DriverManager.getConnection("jdbc:mysql://localhost/test", "user", "pass")
Note: [CWE-798] Use of Hard-coded Credentials.

(drivermanager-hardcoded-secret-java)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@base/src/main/java/com/tinyengine/it/test/VulnerableTest.java` around lines
16 - 88, The VulnerableTest fixture is currently a live `@RestController` under
the production source set, so its endpoints are being deployed and mapped as
real routes. Move VulnerableTest out of the deployable application path or
remove the `@RestController/`@GetMapping annotations so no endpoints are
registered; alternatively gate it behind a non-production profile. Keep the
CodeQL fixture in a location that remains scanned but is excluded from the
runtime artifact, using the VulnerableTest class and its /sql-injection,
/command-injection, /ssrf, and /file-read handlers as the symbols to update.

Loading