Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f79c64cd44 | |||
| 4972adb213 |
@@ -33,6 +33,11 @@ coverage.txt
|
|||||||
*.swo
|
*.swo
|
||||||
*~
|
*~
|
||||||
|
|
||||||
|
# VS Code extension build artifacts
|
||||||
|
editors/vscode/node_modules/
|
||||||
|
editors/vscode/out/
|
||||||
|
editors/vscode/*.vsix
|
||||||
|
|
||||||
# OS
|
# OS
|
||||||
.DS_Store
|
.DS_Store
|
||||||
Thumbs.db
|
Thumbs.db
|
||||||
|
|||||||
@@ -5,6 +5,32 @@ All notable changes to this project will be documented in this file.
|
|||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
|
||||||
This project uses [Semantic Versioning](https://semver.org).
|
This project uses [Semantic Versioning](https://semver.org).
|
||||||
|
|
||||||
|
## [0.2.31] - 2026-06-26
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **Proxy support** — `--proxy <URL>` flag on `glint check`, `glint graph`, and `glint lsp`; also configurable via `proxy:` in `.glint.yml`. When set it takes precedence over `HTTP_PROXY` / `HTTPS_PROXY` env vars; when unset, system proxy settings are honoured automatically. Covers all remote include fetches and GitLab API calls.
|
||||||
|
|
||||||
|
- **GL045: HTTP remote include warning** — new pipeline-level lint rule that warns when `include: remote:` uses a plain `http://` URL. CI templates fetched over unencrypted HTTP are at risk of in-transit tampering; `https://` is always preferred.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **Path traversal in local includes** — `include: local:` paths containing `../` sequences that would escape the repository root (e.g. `../../etc/passwd`) are now rejected with a warning instead of reading arbitrary files from the host.
|
||||||
|
|
||||||
|
- **HTTP timeout on remote fetches** — all HTTP calls in `internal/fetcher` now use a 30-second timeout; previously the client had no timeout and could hang indefinitely on slow or unresponsive servers.
|
||||||
|
|
||||||
|
- **Unbounded response size** — remote include and GitLab API responses are now capped at 10 MiB using `io.LimitReader`; previously an arbitrarily large response could exhaust process memory.
|
||||||
|
|
||||||
|
- **Cache file permissions** — the cache directory is created with mode `0700` (was `0755`) and cache files with `0600` (was `0644`), preventing other local users from reading cached GitLab tokens or pipeline content.
|
||||||
|
|
||||||
|
- **LSP Content-Length DoS** — `glint lsp` now rejects incoming messages whose `Content-Length` header exceeds 64 MiB, preventing memory exhaustion from a malicious or misbehaving LSP client.
|
||||||
|
|
||||||
|
## [0.2.30] - 2026-06-26
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **VS Code extension** (`editors/vscode/`) — TypeScript extension that starts `glint lsp` as a language server and connects to it via `vscode-languageclient`. Activates on YAML files; the `documentSelector` restricts LSP processing to `**/.gitlab-ci.yml` so other YAML files are unaffected. Inline error/warning squiggles appear on every save or edit. The `glint.executablePath` setting controls the binary path (default: `glint` on `PATH`). Build: `task ext-compile`; package as `.vsix`: `task ext-package`.
|
||||||
|
|
||||||
## [0.2.29] - 2026-06-26
|
## [0.2.29] - 2026-06-26
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|||||||
+8
-2
@@ -7,7 +7,7 @@ For planned work see [ROADMAP.md](ROADMAP.md).
|
|||||||
|
|
||||||
## Lint rules
|
## Lint rules
|
||||||
|
|
||||||
Every finding carries a stable rule ID (`GL001` – `GL043`) that can be used to
|
Every finding carries a stable rule ID (`GL001` – `GL045`) that can be used to
|
||||||
suppress, filter, or look up the check. Run `glint explain <ID>` for a
|
suppress, filter, or look up the check. Run `glint explain <ID>` for a
|
||||||
description, bad-YAML example, and fix.
|
description, bad-YAML example, and fix.
|
||||||
|
|
||||||
@@ -19,6 +19,7 @@ description, bad-YAML example, and fix.
|
|||||||
| GL002 | ERR | `workflow.rules[*].when` must be `always` or `never` |
|
| GL002 | ERR | `workflow.rules[*].when` must be `always` or `never` |
|
||||||
| GL036 | ERR | `default.timeout` is not a valid GitLab CI duration string |
|
| GL036 | ERR | `default.timeout` is not a valid GitLab CI duration string |
|
||||||
| GL040 | WARN | A stage name appears more than once in `stages:` |
|
| GL040 | WARN | A stage name appears more than once in `stages:` |
|
||||||
|
| GL045 | WARN | `include: remote:` uses plain `http://` — CI templates fetched unencrypted; prefer `https://` |
|
||||||
|
|
||||||
### Job structure
|
### Job structure
|
||||||
|
|
||||||
@@ -243,9 +244,14 @@ url: https://gitlab.example.com
|
|||||||
|
|
||||||
# Default cache directory.
|
# Default cache directory.
|
||||||
cache_dir: ~/.cache/glint
|
cache_dir: ~/.cache/glint
|
||||||
|
|
||||||
|
# HTTP proxy for remote includes and GitLab API calls.
|
||||||
|
# Overrides HTTP_PROXY / HTTPS_PROXY env vars when set.
|
||||||
|
# Leave empty to use system proxy settings.
|
||||||
|
proxy: http://proxy.example.com:8080
|
||||||
```
|
```
|
||||||
|
|
||||||
**Priority chain:** `--token`/`--gitlab-url` flags > `.glint.yml` > environment variables.
|
**Priority chain:** `--token`/`--gitlab-url`/`--proxy` flags > `.glint.yml` > environment variables.
|
||||||
|
|
||||||
### Inline suppression (`# glint: ignore`)
|
### Inline suppression (`# glint: ignore`)
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="License"></a>
|
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="License"></a>
|
||||||
<a href="CHANGELOG.md"><img src="https://img.shields.io/badge/release-v0.2.29-blue.svg" alt="Release"></a>
|
<a href="CHANGELOG.md"><img src="https://img.shields.io/badge/release-v0.2.31-blue.svg" alt="Release"></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
> **Disclaimer:** This tool was built through iterative AI-assisted development with [Claude](https://claude.ai). It is experimental, incomplete, and not intended for production use. Coverage of GitLab CI keywords is best-effort and may lag behind GitLab's evolving spec. Use it at your own discretion — no correctness guarantees are made. Contributions and bug reports are welcome.
|
> **Disclaimer:** This tool was built through iterative AI-assisted development with [Claude](https://claude.ai). It is experimental, incomplete, and not intended for production use. Coverage of GitLab CI keywords is best-effort and may lag behind GitLab's evolving spec. Use it at your own discretion — no correctness guarantees are made. Contributions and bug reports are welcome.
|
||||||
@@ -15,13 +15,14 @@ A local tool to validate and lint `.gitlab-ci.yml` pipelines without needing a G
|
|||||||
|
|
||||||
## What it does
|
## What it does
|
||||||
|
|
||||||
- **Lints** — 43 rules covering pipeline structure, keyword constraints, `needs:`/`dependencies:` graphs, expression reachability, and deprecations (GL001–GL043); run `glint explain <ID>` for any rule
|
- **Lints** — 45 rules covering pipeline structure, keyword constraints, `needs:`/`dependencies:` graphs, expression reachability, and deprecations (GL001–GL045); run `glint explain <ID>` for any rule
|
||||||
- **Resolves includes** — local files, HTTPS URLs, GitLab project templates, and CI/CD Catalog components, with offline cache support
|
- **Resolves includes** — local files, HTTPS URLs, GitLab project templates, and CI/CD Catalog components, with offline cache support and HTTP proxy support (`--proxy` flag or `proxy:` in `.glint.yml`)
|
||||||
- **Simulates context** — `--branch`, `--tag`, `--source` flags evaluate `rules:if:` and `only`/`except` to show which jobs would be active, manual, or skipped; `--context branch=main --context branch=develop` prints a multi-column comparison table across multiple contexts in one run
|
- **Simulates context** — `--branch`, `--tag`, `--source` flags evaluate `rules:if:` and `only`/`except` to show which jobs would be active, manual, or skipped; `--context branch=main --context branch=develop` prints a multi-column comparison table across multiple contexts in one run
|
||||||
- **Multiple output formats** — `--format text` (default, ruff-style), `json`, `sarif` (GitHub Code Scanning / GitLab SAST), `junit`, `github` (PR annotations)
|
- **Multiple output formats** — `--format text` (default, ruff-style), `json`, `sarif` (GitHub Code Scanning / GitLab SAST), `junit`, `github` (PR annotations)
|
||||||
- **Project config** — `.glint.yml` for rule suppression, severity overrides, token/URL defaults; `# glint: ignore RULE` for per-job inline suppression
|
- **Project config** — `.glint.yml` for rule suppression, severity overrides, token/URL/proxy defaults; `# glint: ignore RULE` for per-job inline suppression
|
||||||
- **Graph visualization** — `glint graph` prints a terminal job tree; `glint graph pipeline` renders a GitLab CI-style SVG/PNG; `--format mermaid` emits a Mermaid flowchart; `--format html` produces a self-contained HTML file with pan/zoom and a job-detail sidebar; context flags grey out skipped jobs
|
- **Graph visualization** — `glint graph` prints a terminal job tree; `glint graph pipeline` renders a GitLab CI-style SVG/PNG; `--format mermaid` emits a Mermaid flowchart; `--format html` produces a self-contained HTML file with pan/zoom and a job-detail sidebar; context flags grey out skipped jobs
|
||||||
- **LSP server** — `glint lsp` starts a Language Server Protocol server over stdin/stdout; connect with any LSP client to get inline diagnostics (rule ID as code, error/warning severity) in VS Code, Neovim, Emacs, JetBrains, etc.
|
- **LSP server** — `glint lsp` starts a Language Server Protocol server over stdin/stdout; connect with any LSP client to get inline diagnostics (rule ID as code, error/warning severity) in VS Code, Neovim, Emacs, JetBrains, etc.
|
||||||
|
- **VS Code extension** — `editors/vscode/` wraps the LSP server; inline squiggles for every glint rule directly in the editor
|
||||||
|
|
||||||
See [FEATURES.md](FEATURES.md) for the complete feature reference and lint rules table, and [ROADMAP.md](ROADMAP.md) for planned improvements.
|
See [FEATURES.md](FEATURES.md) for the complete feature reference and lint rules table, and [ROADMAP.md](ROADMAP.md) for planned improvements.
|
||||||
|
|
||||||
@@ -108,6 +109,27 @@ Copy [`action.yml`](action.yml) from this repository, or mirror this repo to Git
|
|||||||
|
|
||||||
The action downloads the glint Linux binary into `$RUNNER_TEMP` and runs `glint check`. Only Linux runners are supported (matches the available release binary).
|
The action downloads the glint Linux binary into `$RUNNER_TEMP` and runs `glint check`. Only Linux runners are supported (matches the available release binary).
|
||||||
|
|
||||||
|
### VS Code extension
|
||||||
|
|
||||||
|
Clone this repository and load the extension from `editors/vscode/`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd editors/vscode
|
||||||
|
npm install # install dependencies (once)
|
||||||
|
npm run compile # compile TypeScript → out/
|
||||||
|
```
|
||||||
|
|
||||||
|
Then in VS Code: **Run → Start Debugging** (F5) — this opens an Extension Development Host with glint diagnostics active for any `.gitlab-ci.yml` you open.
|
||||||
|
|
||||||
|
Make sure `glint` is on your `PATH`, or set `glint.executablePath` in VS Code settings to the full path of the binary.
|
||||||
|
|
||||||
|
To package a `.vsix` for local installation:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
task ext-package # produces glint-X.Y.Z.vsix
|
||||||
|
code --install-extension glint-X.Y.Z.vsix
|
||||||
|
```
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
This project uses [Task](https://taskfile.dev) as a task runner.
|
This project uses [Task](https://taskfile.dev) as a task runner.
|
||||||
@@ -122,6 +144,9 @@ task ci # full check: vet → test → build → validate
|
|||||||
task fuzz # run fuzz tests for the YAML parser (Ctrl-C to stop; FUZZ_TIME=60s to set duration)
|
task fuzz # run fuzz tests for the YAML parser (Ctrl-C to stop; FUZZ_TIME=60s to set duration)
|
||||||
task changelog # regenerate CHANGELOG.md from git history via git-cliff
|
task changelog # regenerate CHANGELOG.md from git history via git-cliff
|
||||||
task changelog-next # preview unreleased section (dry-run, no file written)
|
task changelog-next # preview unreleased section (dry-run, no file written)
|
||||||
|
task ext-install # install VS Code extension npm dependencies
|
||||||
|
task ext-compile # compile the VS Code extension TypeScript source
|
||||||
|
task ext-package # package the VS Code extension as a .vsix
|
||||||
task build-windows # cross-compile for Windows x64 (requires a tagged commit → glint-<tag>.exe)
|
task build-windows # cross-compile for Windows x64 (requires a tagged commit → glint-<tag>.exe)
|
||||||
task build-linux # cross-compile for Linux x64 (requires a tagged commit → glint-<tag>-linux-amd64)
|
task build-linux # cross-compile for Linux x64 (requires a tagged commit → glint-<tag>-linux-amd64)
|
||||||
task clean # remove build artifacts
|
task clean # remove build artifacts
|
||||||
|
|||||||
+13
-1
@@ -98,7 +98,7 @@ The SVG renderer and terminal tree cover the basic layout. These would bring it
|
|||||||
- [x] **GitHub Actions action** — shipped v0.2.28; `action.yml` composite action downloads the glint Linux binary and runs `glint check`; mirror to GitHub as `k3nny/glint` to reference as `uses: k3nny/glint@v0.2.28`
|
- [x] **GitHub Actions action** — shipped v0.2.28; `action.yml` composite action downloads the glint Linux binary and runs `glint check`; mirror to GitHub as `k3nny/glint` to reference as `uses: k3nny/glint@v0.2.28`
|
||||||
- [x] **Pre-commit hook** — shipped v0.2.28; `.pre-commit-hooks.yaml` defines `language: golang` hook; pre-commit builds glint from source on first run and re-runs on staged `.gitlab-ci.yml` changes
|
- [x] **Pre-commit hook** — shipped v0.2.28; `.pre-commit-hooks.yaml` defines `language: golang` hook; pre-commit builds glint from source on first run and re-runs on staged `.gitlab-ci.yml` changes
|
||||||
- [x] **LSP server** — shipped v0.2.29; `glint lsp` runs a JSON-RPC 2.0 LSP server over stdin/stdout; `textDocument/didOpen`, `didChange`, `didSave`, `didClose` all publish diagnostics; rule IDs appear as the diagnostic `code`; include resolution is best-effort using env-var token and default cache dir
|
- [x] **LSP server** — shipped v0.2.29; `glint lsp` runs a JSON-RPC 2.0 LSP server over stdin/stdout; `textDocument/didOpen`, `didChange`, `didSave`, `didClose` all publish diagnostics; rule IDs appear as the diagnostic `code`; include resolution is best-effort using env-var token and default cache dir
|
||||||
- [ ] **VS Code extension** — thin wrapper around the LSP server with syntax highlighting for `.gitlab-ci.yml`
|
- [x] **VS Code extension** — shipped v0.2.30; `editors/vscode/` TypeScript extension wraps `glint lsp` via `vscode-languageclient`; activates on YAML files and restricts LSP processing to `**/.gitlab-ci.yml`; configurable binary path via `glint.executablePath`; build with `task ext-compile`, package with `task ext-package`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -106,6 +106,18 @@ The SVG renderer and terminal tree cover the basic layout. These would bring it
|
|||||||
|
|
||||||
- [x] **`.glint.yml` config file** — shipped v0.2.19; `ignore:`, `severity:`, `stages:`, `token:`, `url:`, `cache_dir:`; searched from the pipeline directory up to the git root
|
- [x] **`.glint.yml` config file** — shipped v0.2.19; `ignore:`, `severity:`, `stages:`, `token:`, `url:`, `cache_dir:`; searched from the pipeline directory up to the git root
|
||||||
- [x] **Inline suppression comments** — shipped v0.2.19; `# glint: ignore GL007` before a job definition; comma/space-separated rules; `# glint: ignore all` wildcard
|
- [x] **Inline suppression comments** — shipped v0.2.19; `# glint: ignore GL007` before a job definition; comma/space-separated rules; `# glint: ignore all` wildcard
|
||||||
|
- [x] **Proxy support** — shipped v0.2.31; `--proxy` flag on `check`, `graph`, and `lsp` subcommands; also configurable via `proxy:` in `.glint.yml`; overrides `HTTP_PROXY` / `HTTPS_PROXY` env vars when set
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Security & hardening
|
||||||
|
|
||||||
|
- [x] **Path traversal guard for local includes** — shipped v0.2.31; `include: local:` paths containing `../../` or similar sequences are rejected instead of reading files outside the repository root
|
||||||
|
- [x] **HTTP timeout on remote fetches** — shipped v0.2.31; all HTTP calls via the fetcher use a 30-second timeout to prevent indefinite hangs on slow or unresponsive servers
|
||||||
|
- [x] **Unbounded response size cap** — shipped v0.2.31; remote include and GitLab API responses are capped at 10 MiB; responses exceeding the limit are rejected to prevent memory exhaustion
|
||||||
|
- [x] **Cache file permissions** — shipped v0.2.31; cache directories are created with mode `0700` and cache files with mode `0600`; previously used world-readable `0755`/`0644`
|
||||||
|
- [x] **GL045: HTTP remote include warning** — shipped v0.2.31; warns when `include: remote:` uses a plain `http://` URL; CI templates fetched unencrypted are at risk of tampering
|
||||||
|
- [x] **LSP Content-Length DoS cap** — shipped v0.2.31; `glint lsp` rejects messages with `Content-Length` exceeding 64 MiB to prevent memory exhaustion from a malicious client
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -123,6 +123,8 @@ tasks:
|
|||||||
ignore_error: false
|
ignore_error: false
|
||||||
- cmd: ./{{.BINARY}} explain GL044
|
- cmd: ./{{.BINARY}} explain GL044
|
||||||
ignore_error: false
|
ignore_error: false
|
||||||
|
- cmd: ./{{.BINARY}} check testdata/insecure_remote_include.yml
|
||||||
|
ignore_error: false
|
||||||
- cmd: ./{{.BINARY}} explain
|
- cmd: ./{{.BINARY}} explain
|
||||||
ignore_error: false
|
ignore_error: false
|
||||||
|
|
||||||
@@ -192,6 +194,22 @@ tasks:
|
|||||||
desc: "Preview unreleased changelog entries without writing (requires git-cliff)"
|
desc: "Preview unreleased changelog entries without writing (requires git-cliff)"
|
||||||
cmd: git cliff --config cliff.toml --unreleased
|
cmd: git cliff --config cliff.toml --unreleased
|
||||||
|
|
||||||
|
ext-install:
|
||||||
|
desc: Install VS Code extension npm dependencies (run once after checkout)
|
||||||
|
dir: editors/vscode
|
||||||
|
cmd: npm install
|
||||||
|
|
||||||
|
ext-compile:
|
||||||
|
desc: Compile the VS Code extension TypeScript source
|
||||||
|
dir: editors/vscode
|
||||||
|
cmd: npm run compile
|
||||||
|
|
||||||
|
ext-package:
|
||||||
|
desc: Package the VS Code extension into a .vsix file
|
||||||
|
dir: editors/vscode
|
||||||
|
deps: [ext-compile]
|
||||||
|
cmd: npm run package
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
desc: Remove build artifacts
|
desc: Remove build artifacts
|
||||||
cmd: rm -f {{.BINARY}} {{.BINARY}}-*.exe {{.BINARY}}-*-linux-amd64
|
cmd: rm -f {{.BINARY}} {{.BINARY}}-*.exe {{.BINARY}}-*-linux-amd64
|
||||||
|
|||||||
+32
-3
@@ -5,6 +5,7 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
|
|
||||||
|
"git.k3nny.fr/glint/internal/config"
|
||||||
"git.k3nny.fr/glint/internal/fetcher"
|
"git.k3nny.fr/glint/internal/fetcher"
|
||||||
"git.k3nny.fr/glint/internal/lsp"
|
"git.k3nny.fr/glint/internal/lsp"
|
||||||
)
|
)
|
||||||
@@ -15,6 +16,7 @@ func cmdLSP(args []string) {
|
|||||||
gitlabURL := fs.String("gitlab-url", "", "GitLab instance URL (overrides CI_SERVER_URL / GITLAB_URL)")
|
gitlabURL := fs.String("gitlab-url", "", "GitLab instance URL (overrides CI_SERVER_URL / GITLAB_URL)")
|
||||||
cacheDir := fs.String("cache-dir", "", "directory for caching fetched remote includes")
|
cacheDir := fs.String("cache-dir", "", "directory for caching fetched remote includes")
|
||||||
offline := fs.Bool("offline", false, "skip all network calls; serve only from --cache-dir")
|
offline := fs.Bool("offline", false, "skip all network calls; serve only from --cache-dir")
|
||||||
|
proxy := fs.String("proxy", "", "HTTP proxy URL for remote includes and GitLab API calls (e.g. http://proxy:8080); overrides system proxy env vars")
|
||||||
fs.Usage = func() {
|
fs.Usage = func() {
|
||||||
fmt.Fprintf(os.Stderr, "glint %s\n\n", version)
|
fmt.Fprintf(os.Stderr, "glint %s\n\n", version)
|
||||||
fmt.Fprint(os.Stderr, `Start a Language Server Protocol server for .gitlab-ci.yml files.
|
fmt.Fprint(os.Stderr, `Start a Language Server Protocol server for .gitlab-ci.yml files.
|
||||||
@@ -42,6 +44,12 @@ Options:
|
|||||||
Do not make any network calls; resolve only local includes.
|
Do not make any network calls; resolve only local includes.
|
||||||
Implies --cache-dir default (~/.cache/glint) when not set.
|
Implies --cache-dir default (~/.cache/glint) when not set.
|
||||||
|
|
||||||
|
--proxy <URL>
|
||||||
|
HTTP proxy URL for remote includes and GitLab API calls
|
||||||
|
(e.g. http://proxy:8080). Overrides system proxy env vars
|
||||||
|
(HTTP_PROXY / HTTPS_PROXY). Also configurable via proxy: in
|
||||||
|
.glint.yml.
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
Print help
|
Print help
|
||||||
|
|
||||||
@@ -49,19 +57,40 @@ Examples:
|
|||||||
glint lsp
|
glint lsp
|
||||||
glint lsp --token glpat-xxxx --cache-dir ~/.cache/glint
|
glint lsp --token glpat-xxxx --cache-dir ~/.cache/glint
|
||||||
glint lsp --offline
|
glint lsp --offline
|
||||||
|
glint lsp --proxy http://proxy.example.com:8080
|
||||||
`)
|
`)
|
||||||
}
|
}
|
||||||
_ = fs.Parse(args)
|
_ = fs.Parse(args)
|
||||||
|
|
||||||
|
// Load project config from the working directory (the project root from
|
||||||
|
// which the LSP server is launched). CLI flags take priority.
|
||||||
|
wd, _ := os.Getwd()
|
||||||
|
glintCfg, cfgErr := config.Load(wd)
|
||||||
|
if cfgErr != nil {
|
||||||
|
fmt.Fprintf(os.Stderr, "glint lsp: [warning] %s: %v\n", config.Filename, cfgErr)
|
||||||
|
}
|
||||||
|
|
||||||
|
fetcherToken := *token
|
||||||
|
if fetcherToken == "" {
|
||||||
|
fetcherToken = glintCfg.Token
|
||||||
|
}
|
||||||
|
fetcherURL := *gitlabURL
|
||||||
|
if fetcherURL == "" {
|
||||||
|
fetcherURL = glintCfg.URL
|
||||||
|
}
|
||||||
resolvedCacheDir := *cacheDir
|
resolvedCacheDir := *cacheDir
|
||||||
|
if resolvedCacheDir == "" {
|
||||||
|
resolvedCacheDir = glintCfg.CacheDir
|
||||||
|
}
|
||||||
if resolvedCacheDir == "" {
|
if resolvedCacheDir == "" {
|
||||||
resolvedCacheDir = defaultCacheDir()
|
resolvedCacheDir = defaultCacheDir()
|
||||||
}
|
}
|
||||||
if *offline && resolvedCacheDir == "" {
|
resolvedProxy := *proxy
|
||||||
resolvedCacheDir = defaultCacheDir()
|
if resolvedProxy == "" {
|
||||||
|
resolvedProxy = glintCfg.Proxy
|
||||||
}
|
}
|
||||||
|
|
||||||
cfg := fetcher.AutoConfig().WithOverrides(*gitlabURL, *token, resolvedCacheDir, *offline)
|
cfg := fetcher.AutoConfig().WithOverrides(fetcherURL, fetcherToken, resolvedCacheDir, *offline).WithProxy(resolvedProxy)
|
||||||
|
|
||||||
srv := lsp.New(os.Stdin, os.Stdout, cfg, version)
|
srv := lsp.New(os.Stdin, os.Stdout, cfg, version)
|
||||||
if err := srv.Run(); err != nil {
|
if err := srv.Run(); err != nil {
|
||||||
|
|||||||
+29
-3
@@ -119,6 +119,7 @@ func cmdCheck(args []string) {
|
|||||||
gitlabURL := fs.String("gitlab-url", "", "GitLab instance URL (overrides CI_SERVER_URL / GITLAB_URL)")
|
gitlabURL := fs.String("gitlab-url", "", "GitLab instance URL (overrides CI_SERVER_URL / GITLAB_URL)")
|
||||||
cacheDir := fs.String("cache-dir", "", "directory to cache fetched remote includes (created if needed)")
|
cacheDir := fs.String("cache-dir", "", "directory to cache fetched remote includes (created if needed)")
|
||||||
offline := fs.Bool("offline", false, "skip all network calls; serve only from --cache-dir")
|
offline := fs.Bool("offline", false, "skip all network calls; serve only from --cache-dir")
|
||||||
|
proxy := fs.String("proxy", "", "HTTP proxy URL for remote includes and GitLab API calls (e.g. http://proxy:8080); overrides system proxy env vars")
|
||||||
format := fs.String("format", "text", "output format: text, json, sarif, junit, github")
|
format := fs.String("format", "text", "output format: text, json, sarif, junit, github")
|
||||||
branch := fs.String("branch", "", "simulate a branch push (sets CI_COMMIT_BRANCH, …)")
|
branch := fs.String("branch", "", "simulate a branch push (sets CI_COMMIT_BRANCH, …)")
|
||||||
tag := fs.String("tag", "", "simulate a tag push (sets CI_COMMIT_TAG, …)")
|
tag := fs.String("tag", "", "simulate a tag push (sets CI_COMMIT_TAG, …)")
|
||||||
@@ -286,8 +287,12 @@ Examples:
|
|||||||
if *offline && resolvedCacheDir == "" {
|
if *offline && resolvedCacheDir == "" {
|
||||||
resolvedCacheDir = defaultCacheDir()
|
resolvedCacheDir = defaultCacheDir()
|
||||||
}
|
}
|
||||||
|
resolvedProxy := *proxy
|
||||||
|
if resolvedProxy == "" {
|
||||||
|
resolvedProxy = glintCfg.Proxy
|
||||||
|
}
|
||||||
|
|
||||||
cfg := fetcher.AutoConfig().WithOverrides(fetcherURL, fetcherToken, resolvedCacheDir, *offline)
|
cfg := fetcher.AutoConfig().WithOverrides(fetcherURL, fetcherToken, resolvedCacheDir, *offline).WithProxy(resolvedProxy)
|
||||||
|
|
||||||
p, err := model.Parse(path)
|
p, err := model.Parse(path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -448,6 +453,7 @@ func cmdGraph(args []string) {
|
|||||||
gitlabURL := fs.String("gitlab-url", "", "GitLab instance URL (overrides CI_SERVER_URL / GITLAB_URL)")
|
gitlabURL := fs.String("gitlab-url", "", "GitLab instance URL (overrides CI_SERVER_URL / GITLAB_URL)")
|
||||||
cacheDir := fs.String("cache-dir", "", "directory to cache fetched remote includes (created if needed)")
|
cacheDir := fs.String("cache-dir", "", "directory to cache fetched remote includes (created if needed)")
|
||||||
offline := fs.Bool("offline", false, "skip all network calls; serve only from --cache-dir")
|
offline := fs.Bool("offline", false, "skip all network calls; serve only from --cache-dir")
|
||||||
|
proxy := fs.String("proxy", "", "HTTP proxy URL for remote includes and GitLab API calls (e.g. http://proxy:8080)")
|
||||||
out := fs.String("out", "glint-out", "output directory for rendered graph files (pipeline mode)")
|
out := fs.String("out", "glint-out", "output directory for rendered graph files (pipeline mode)")
|
||||||
format := fs.String("format", "svg", "pipeline output format: svg, mermaid, or html")
|
format := fs.String("format", "svg", "pipeline output format: svg, mermaid, or html")
|
||||||
fs.Usage = func() {
|
fs.Usage = func() {
|
||||||
@@ -559,13 +565,34 @@ Examples:
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
path := fs.Arg(0)
|
path := fs.Arg(0)
|
||||||
|
rootDir := filepath.Dir(filepath.Clean(path))
|
||||||
|
|
||||||
|
glintCfg, cfgErr := config.Load(rootDir)
|
||||||
|
if cfgErr != nil {
|
||||||
|
fmt.Fprintf(os.Stderr, "%s: [warning] %s: %v\n", path, config.Filename, cfgErr)
|
||||||
|
}
|
||||||
|
|
||||||
|
fetcherToken := *token
|
||||||
|
if fetcherToken == "" {
|
||||||
|
fetcherToken = glintCfg.Token
|
||||||
|
}
|
||||||
|
fetcherURL := *gitlabURL
|
||||||
|
if fetcherURL == "" {
|
||||||
|
fetcherURL = glintCfg.URL
|
||||||
|
}
|
||||||
resolvedCacheDir := *cacheDir
|
resolvedCacheDir := *cacheDir
|
||||||
|
if resolvedCacheDir == "" {
|
||||||
|
resolvedCacheDir = glintCfg.CacheDir
|
||||||
|
}
|
||||||
if *offline && resolvedCacheDir == "" {
|
if *offline && resolvedCacheDir == "" {
|
||||||
resolvedCacheDir = defaultCacheDir()
|
resolvedCacheDir = defaultCacheDir()
|
||||||
}
|
}
|
||||||
|
resolvedProxy := *proxy
|
||||||
|
if resolvedProxy == "" {
|
||||||
|
resolvedProxy = glintCfg.Proxy
|
||||||
|
}
|
||||||
|
|
||||||
cfg := fetcher.AutoConfig().WithOverrides(*gitlabURL, *token, resolvedCacheDir, *offline)
|
cfg := fetcher.AutoConfig().WithOverrides(fetcherURL, fetcherToken, resolvedCacheDir, *offline).WithProxy(resolvedProxy)
|
||||||
|
|
||||||
p, err := model.Parse(path)
|
p, err := model.Parse(path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -574,7 +601,6 @@ Examples:
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
rootDir := filepath.Dir(filepath.Clean(path))
|
|
||||||
resolver.ResolveIncludes(p, cfg, rootDir) //nolint:errcheck
|
resolver.ResolveIncludes(p, cfg, rootDir) //nolint:errcheck
|
||||||
resolver.Resolve(p) //nolint:errcheck
|
resolver.Resolve(p) //nolint:errcheck
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,3 @@
|
|||||||
|
node_modules/
|
||||||
|
out/
|
||||||
|
*.vsix
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
src/**
|
||||||
|
tsconfig.json
|
||||||
|
.gitignore
|
||||||
|
node_modules/**
|
||||||
|
!node_modules/vscode-languageclient/**
|
||||||
|
!node_modules/vscode-languageserver-protocol/**
|
||||||
|
!node_modules/vscode-languageserver-types/**
|
||||||
|
!node_modules/vscode-jsonrpc/**
|
||||||
Generated
+2532
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,56 @@
|
|||||||
|
{
|
||||||
|
"name": "glint",
|
||||||
|
"displayName": "glint — GitLab CI Linter",
|
||||||
|
"description": "Inline diagnostics for .gitlab-ci.yml pipelines powered by the glint language server",
|
||||||
|
"version": "0.2.29",
|
||||||
|
"publisher": "k3nny",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://git.k3nny.fr/k3nny/glint"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"vscode": "^1.82.0"
|
||||||
|
},
|
||||||
|
"categories": [
|
||||||
|
"Linters"
|
||||||
|
],
|
||||||
|
"keywords": [
|
||||||
|
"gitlab",
|
||||||
|
"ci",
|
||||||
|
"yaml",
|
||||||
|
"lint",
|
||||||
|
"pipeline"
|
||||||
|
],
|
||||||
|
"activationEvents": [
|
||||||
|
"onLanguage:yaml"
|
||||||
|
],
|
||||||
|
"main": "./out/extension.js",
|
||||||
|
"contributes": {
|
||||||
|
"configuration": {
|
||||||
|
"type": "object",
|
||||||
|
"title": "glint",
|
||||||
|
"properties": {
|
||||||
|
"glint.executablePath": {
|
||||||
|
"type": "string",
|
||||||
|
"default": "glint",
|
||||||
|
"markdownDescription": "Path to the `glint` binary. Leave as `glint` if it is on your `PATH`, or set an absolute path (e.g. `/usr/local/bin/glint`)."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"compile": "tsc -p ./",
|
||||||
|
"watch": "tsc --watch -p ./",
|
||||||
|
"package": "vsce package"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"vscode-languageclient": "^9.0.1"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/node": "^20",
|
||||||
|
"@types/vscode": "^1.82.0",
|
||||||
|
"@vscode/vsce": "^2.22.0",
|
||||||
|
"typescript": "^5.3.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
import * as vscode from 'vscode';
|
||||||
|
import {
|
||||||
|
LanguageClient,
|
||||||
|
LanguageClientOptions,
|
||||||
|
ServerOptions,
|
||||||
|
TransportKind,
|
||||||
|
} from 'vscode-languageclient/node';
|
||||||
|
|
||||||
|
let client: LanguageClient | undefined;
|
||||||
|
|
||||||
|
export function activate(context: vscode.ExtensionContext): void {
|
||||||
|
const cfg = vscode.workspace.getConfiguration('glint');
|
||||||
|
const glintPath = cfg.get<string>('executablePath') || 'glint';
|
||||||
|
|
||||||
|
const serverOptions: ServerOptions = {
|
||||||
|
command: glintPath,
|
||||||
|
args: ['lsp'],
|
||||||
|
transport: TransportKind.stdio,
|
||||||
|
};
|
||||||
|
|
||||||
|
const clientOptions: LanguageClientOptions = {
|
||||||
|
// Only process .gitlab-ci.yml files, not all YAML.
|
||||||
|
documentSelector: [
|
||||||
|
{ scheme: 'file', language: 'yaml', pattern: '**/.gitlab-ci.yml' },
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
client = new LanguageClient(
|
||||||
|
'glint',
|
||||||
|
'glint — GitLab CI Linter',
|
||||||
|
serverOptions,
|
||||||
|
clientOptions,
|
||||||
|
);
|
||||||
|
|
||||||
|
client.start();
|
||||||
|
context.subscriptions.push(client);
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function deactivate(): Promise<void> {
|
||||||
|
await client?.stop();
|
||||||
|
}
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"module": "commonjs",
|
||||||
|
"target": "ES2020",
|
||||||
|
"lib": ["ES2020"],
|
||||||
|
"outDir": "out",
|
||||||
|
"rootDir": "src",
|
||||||
|
"strict": true,
|
||||||
|
"sourceMap": true,
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"skipLibCheck": true
|
||||||
|
},
|
||||||
|
"include": ["src"],
|
||||||
|
"exclude": ["node_modules", "out"]
|
||||||
|
}
|
||||||
@@ -38,6 +38,12 @@ type Config struct {
|
|||||||
// CacheDir is the default directory for caching fetched remote includes.
|
// CacheDir is the default directory for caching fetched remote includes.
|
||||||
// Overridden by the --cache-dir flag.
|
// Overridden by the --cache-dir flag.
|
||||||
CacheDir string `yaml:"cache_dir"`
|
CacheDir string `yaml:"cache_dir"`
|
||||||
|
|
||||||
|
// Proxy is the HTTP proxy URL for fetching remote includes and GitLab API
|
||||||
|
// calls (e.g. "http://proxy.example.com:8080"). Overridden by the --proxy
|
||||||
|
// flag. When empty, system proxy settings (HTTP_PROXY / HTTPS_PROXY /
|
||||||
|
// NO_PROXY env vars) are used automatically.
|
||||||
|
Proxy string `yaml:"proxy"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Load searches for a .glint.yml file starting from dir and walking up toward
|
// Load searches for a .glint.yml file starting from dir and walking up toward
|
||||||
|
|||||||
@@ -26,10 +26,10 @@ func cacheWrite(dir, key string, data []byte) {
|
|||||||
if dir == "" {
|
if dir == "" {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if err := os.MkdirAll(dir, 0o755); err != nil {
|
if err := os.MkdirAll(dir, 0o700); err != nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
_ = os.WriteFile(cachePath(dir, key), data, 0o644)
|
_ = os.WriteFile(cachePath(dir, key), data, 0o600)
|
||||||
}
|
}
|
||||||
|
|
||||||
// cachePath returns the filesystem path for a cache entry.
|
// cachePath returns the filesystem path for a cache entry.
|
||||||
|
|||||||
@@ -71,3 +71,28 @@ func TestCacheWrite_MkdirAll(t *testing.T) {
|
|||||||
t.Errorf("directory not created: %v", err)
|
t.Errorf("directory not created: %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestCacheWrite_FilePermissions(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
cacheWrite(dir, "seckey", []byte("secret"))
|
||||||
|
info, err := os.Stat(cachePath(dir, "seckey"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("stat cache file: %v", err)
|
||||||
|
}
|
||||||
|
if mode := info.Mode().Perm(); mode != 0o600 {
|
||||||
|
t.Errorf("cache file mode = %04o; want 0600", mode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCacheWrite_DirPermissions(t *testing.T) {
|
||||||
|
parent := t.TempDir()
|
||||||
|
dir := filepath.Join(parent, "glint-cache")
|
||||||
|
cacheWrite(dir, "k", []byte("v"))
|
||||||
|
info, err := os.Stat(dir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("stat cache dir: %v", err)
|
||||||
|
}
|
||||||
|
if mode := info.Mode().Perm(); mode != 0o700 {
|
||||||
|
t.Errorf("cache dir mode = %04o; want 0700", mode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -8,8 +8,18 @@ import (
|
|||||||
"net/url"
|
"net/url"
|
||||||
"os"
|
"os"
|
||||||
"strings"
|
"strings"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// httpClient is the shared HTTP client for all fetcher requests.
|
||||||
|
// Timeout guards against hung remote servers. Transport is intentionally nil
|
||||||
|
// so http.DefaultTransport is used dynamically — allowing tests to swap it.
|
||||||
|
var httpClient = &http.Client{Timeout: 30 * time.Second}
|
||||||
|
|
||||||
|
// maxResponseBytes is the per-response size cap. Responses larger than this
|
||||||
|
// are rejected to prevent memory exhaustion from pathological servers.
|
||||||
|
const maxResponseBytes int64 = 10 << 20 // 10 MiB
|
||||||
|
|
||||||
// TokenSource describes where a token was found, which determines the correct
|
// TokenSource describes where a token was found, which determines the correct
|
||||||
// authentication header to use with the GitLab API.
|
// authentication header to use with the GitLab API.
|
||||||
type TokenSource int
|
type TokenSource int
|
||||||
@@ -27,6 +37,10 @@ type GitLabConfig struct {
|
|||||||
Source TokenSource
|
Source TokenSource
|
||||||
CacheDir string // local cache directory; empty = caching disabled
|
CacheDir string // local cache directory; empty = caching disabled
|
||||||
Offline bool // when true, return an error instead of making network calls
|
Offline bool // when true, return an error instead of making network calls
|
||||||
|
// ProxyURL overrides the HTTP proxy for all requests made with this config.
|
||||||
|
// Empty string means use system proxy settings (HTTP_PROXY / HTTPS_PROXY /
|
||||||
|
// NO_PROXY env vars honoured automatically by http.DefaultTransport).
|
||||||
|
ProxyURL string
|
||||||
}
|
}
|
||||||
|
|
||||||
// AutoConfig builds a GitLabConfig from environment variables.
|
// AutoConfig builds a GitLabConfig from environment variables.
|
||||||
@@ -56,6 +70,33 @@ func AutoConfig() GitLabConfig {
|
|||||||
return cfg
|
return cfg
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// WithProxy returns a copy of cfg with ProxyURL set.
|
||||||
|
func (cfg GitLabConfig) WithProxy(proxyURL string) GitLabConfig {
|
||||||
|
cfg.ProxyURL = proxyURL
|
||||||
|
return cfg
|
||||||
|
}
|
||||||
|
|
||||||
|
// client returns an HTTP client for this config.
|
||||||
|
// When ProxyURL is set it takes precedence over system proxy env vars;
|
||||||
|
// otherwise http.DefaultTransport's built-in ProxyFromEnvironment is used.
|
||||||
|
func (cfg GitLabConfig) client() *http.Client {
|
||||||
|
if cfg.ProxyURL == "" {
|
||||||
|
return httpClient
|
||||||
|
}
|
||||||
|
proxyURL, err := url.Parse(cfg.ProxyURL)
|
||||||
|
if err != nil {
|
||||||
|
return httpClient
|
||||||
|
}
|
||||||
|
// Clone the default transport so all TLS/dial settings are preserved.
|
||||||
|
t, ok := http.DefaultTransport.(*http.Transport)
|
||||||
|
if !ok {
|
||||||
|
return httpClient
|
||||||
|
}
|
||||||
|
transport := t.Clone()
|
||||||
|
transport.Proxy = http.ProxyURL(proxyURL)
|
||||||
|
return &http.Client{Timeout: httpClient.Timeout, Transport: transport}
|
||||||
|
}
|
||||||
|
|
||||||
// WithOverrides returns a copy of cfg with the provided overrides applied.
|
// WithOverrides returns a copy of cfg with the provided overrides applied.
|
||||||
// Non-empty strings overwrite the corresponding field; booleans are always
|
// Non-empty strings overwrite the corresponding field; booleans are always
|
||||||
// applied (so offline: false explicitly clears offline mode).
|
// applied (so offline: false explicitly clears offline mode).
|
||||||
@@ -128,16 +169,19 @@ func (cfg GitLabConfig) FetchFile(project, filePath, ref string) ([]byte, error)
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
resp, err := http.DefaultClient.Do(req)
|
resp, err := cfg.client().Do(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("GET %s: %w", apiURL, err)
|
return nil, fmt.Errorf("GET %s: %w", apiURL, err)
|
||||||
}
|
}
|
||||||
defer resp.Body.Close()
|
defer resp.Body.Close()
|
||||||
|
|
||||||
body, err := io.ReadAll(resp.Body)
|
body, err := io.ReadAll(io.LimitReader(resp.Body, maxResponseBytes+1))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("reading response body: %w", err)
|
return nil, fmt.Errorf("reading response body: %w", err)
|
||||||
}
|
}
|
||||||
|
if int64(len(body)) > maxResponseBytes {
|
||||||
|
return nil, fmt.Errorf("response body exceeds maximum size (%d MiB)", maxResponseBytes>>20)
|
||||||
|
}
|
||||||
|
|
||||||
if resp.StatusCode != http.StatusOK {
|
if resp.StatusCode != http.StatusOK {
|
||||||
msg := strings.TrimSpace(string(body))
|
msg := strings.TrimSpace(string(body))
|
||||||
@@ -169,15 +213,18 @@ func (cfg GitLabConfig) FetchURL(rawURL string) ([]byte, error) {
|
|||||||
return nil, fmt.Errorf("offline mode: %s is not in the local cache (run without --offline first to populate the cache)", rawURL)
|
return nil, fmt.Errorf("offline mode: %s is not in the local cache (run without --offline first to populate the cache)", rawURL)
|
||||||
}
|
}
|
||||||
|
|
||||||
resp, err := http.Get(rawURL) //nolint:noctx
|
resp, err := cfg.client().Get(rawURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("GET %s: %w", rawURL, err)
|
return nil, fmt.Errorf("GET %s: %w", rawURL, err)
|
||||||
}
|
}
|
||||||
defer resp.Body.Close()
|
defer resp.Body.Close()
|
||||||
body, err := io.ReadAll(resp.Body)
|
body, err := io.ReadAll(io.LimitReader(resp.Body, maxResponseBytes+1))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("reading body: %w", err)
|
return nil, fmt.Errorf("reading body: %w", err)
|
||||||
}
|
}
|
||||||
|
if int64(len(body)) > maxResponseBytes {
|
||||||
|
return nil, fmt.Errorf("response body exceeds maximum size (%d MiB)", maxResponseBytes>>20)
|
||||||
|
}
|
||||||
if resp.StatusCode != http.StatusOK {
|
if resp.StatusCode != http.StatusOK {
|
||||||
return nil, fmt.Errorf("GET %s: status %d", rawURL, resp.StatusCode)
|
return nil, fmt.Errorf("GET %s: status %d", rawURL, resp.StatusCode)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import (
|
|||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"os"
|
"os"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -339,3 +340,46 @@ func TestFetchURL_NotOK(t *testing.T) {
|
|||||||
_, err := cfg.FetchURL(srv.URL)
|
_, err := cfg.FetchURL(srv.URL)
|
||||||
if err == nil { t.Fatal("expected error for non-200 status") }
|
if err == nil { t.Fatal("expected error for non-200 status") }
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestFetchFile_ResponseTooLarge(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
// Write maxResponseBytes+1 bytes to exceed the cap.
|
||||||
|
chunk := make([]byte, 4096)
|
||||||
|
written := int64(0)
|
||||||
|
for written <= maxResponseBytes {
|
||||||
|
n, _ := w.Write(chunk)
|
||||||
|
written += int64(n)
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
cfg := GitLabConfig{BaseURL: srv.URL}
|
||||||
|
_, err := cfg.FetchFile("group/project", "/ci.yml", "main")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for oversized response")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "exceeds maximum size") {
|
||||||
|
t.Errorf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFetchURL_ResponseTooLarge(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
chunk := make([]byte, 4096)
|
||||||
|
written := int64(0)
|
||||||
|
for written <= maxResponseBytes {
|
||||||
|
n, _ := w.Write(chunk)
|
||||||
|
written += int64(n)
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
cfg := GitLabConfig{}
|
||||||
|
_, err := cfg.FetchURL(srv.URL)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for oversized response")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "exceeds maximum size") {
|
||||||
|
t.Errorf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -853,4 +853,18 @@ test:
|
|||||||
- if: $CI_COMMIT_BRANCH == "main"
|
- if: $CI_COMMIT_BRANCH == "main"
|
||||||
needs: [build, lint]`,
|
needs: [build, lint]`,
|
||||||
},
|
},
|
||||||
|
|
||||||
|
RuleInsecureRemoteInclude: {
|
||||||
|
Title: "remote include uses plain HTTP",
|
||||||
|
Severity: Warning,
|
||||||
|
Description: "An include: remote: entry uses an http:// URL instead of https://. " +
|
||||||
|
"CI templates fetched over plain HTTP are transmitted in cleartext; an " +
|
||||||
|
"attacker with network access could intercept or modify the template " +
|
||||||
|
"before it is parsed. Use https:// so the connection is encrypted and " +
|
||||||
|
"the server's identity is verified.",
|
||||||
|
Example: `include:
|
||||||
|
- remote: http://ci-templates.example.com/build.yml`,
|
||||||
|
Fix: `include:
|
||||||
|
- remote: https://ci-templates.example.com/build.yml`,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,31 @@
|
|||||||
|
package linter
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"git.k3nny.fr/glint/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
// checkInsecureRemoteInclude warns when an include: remote: entry uses plain
|
||||||
|
// HTTP (GL045). The file is still fetched and linted; the finding is a warning
|
||||||
|
// so pipelines that use HTTP for internal infra are not blocked.
|
||||||
|
func checkInsecureRemoteInclude(p *model.Pipeline) []Finding {
|
||||||
|
var findings []Finding
|
||||||
|
for _, inc := range p.Include {
|
||||||
|
m, ok := inc.(map[string]any)
|
||||||
|
if !ok {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
remote, _ := m["remote"].(string)
|
||||||
|
if strings.HasPrefix(remote, "http://") {
|
||||||
|
findings = append(findings, Finding{
|
||||||
|
Severity: Warning,
|
||||||
|
Rule: RuleInsecureRemoteInclude,
|
||||||
|
File: p.SourceFile,
|
||||||
|
Message: fmt.Sprintf("remote include %q uses plain HTTP; CI templates are fetched unencrypted — prefer HTTPS", remote),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return findings
|
||||||
|
}
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
package linter
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.k3nny.fr/glint/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestCheckInsecureRemoteInclude(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
include []any
|
||||||
|
wantGL string // expected rule ID, empty = no findings
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "http URL triggers GL045",
|
||||||
|
include: []any{map[string]any{"remote": "http://example.com/ci.yml"}},
|
||||||
|
wantGL: RuleInsecureRemoteInclude,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "https URL is clean",
|
||||||
|
include: []any{map[string]any{"remote": "https://example.com/ci.yml"}},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "local include ignored",
|
||||||
|
include: []any{map[string]any{"local": "/templates/ci.yml"}},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "string include ignored",
|
||||||
|
include: []any{"/templates/ci.yml"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "no includes",
|
||||||
|
include: nil,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "mixed: http fires, https does not",
|
||||||
|
include: []any{
|
||||||
|
map[string]any{"remote": "https://ok.example.com/ci.yml"},
|
||||||
|
map[string]any{"remote": "http://bad.example.com/ci.yml"},
|
||||||
|
},
|
||||||
|
wantGL: RuleInsecureRemoteInclude,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range tests {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
p := &model.Pipeline{
|
||||||
|
Include: tc.include,
|
||||||
|
Jobs: map[string]model.Job{},
|
||||||
|
}
|
||||||
|
findings := checkInsecureRemoteInclude(p)
|
||||||
|
if tc.wantGL == "" {
|
||||||
|
if len(findings) != 0 {
|
||||||
|
t.Errorf("expected no findings, got: %v", findings)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
found := false
|
||||||
|
for _, f := range findings {
|
||||||
|
if f.Rule == tc.wantGL {
|
||||||
|
found = true
|
||||||
|
if f.Severity != Warning {
|
||||||
|
t.Errorf("severity = %v; want Warning", f.Severity)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !found {
|
||||||
|
t.Errorf("expected finding %s, got: %v", tc.wantGL, findings)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -67,6 +67,7 @@ func Lint(p *model.Pipeline, skipped map[string]bool) []Finding {
|
|||||||
findings = append(findings, checkVariableRefs(p)...)
|
findings = append(findings, checkVariableRefs(p)...)
|
||||||
findings = append(findings, checkRulesIfReachability(p)...)
|
findings = append(findings, checkRulesIfReachability(p)...)
|
||||||
findings = append(findings, checkInheritCompleteness(p)...)
|
findings = append(findings, checkInheritCompleteness(p)...)
|
||||||
|
findings = append(findings, checkInsecureRemoteInclude(p)...)
|
||||||
slices.SortStableFunc(findings, func(a, b Finding) int {
|
slices.SortStableFunc(findings, func(a, b Finding) int {
|
||||||
if c := cmp.Compare(a.File, b.File); c != 0 {
|
if c := cmp.Compare(a.File, b.File); c != 0 {
|
||||||
return c
|
return c
|
||||||
|
|||||||
@@ -158,4 +158,9 @@ const (
|
|||||||
// GL044: a rules:needs: entry references a job that does not exist in the pipeline.
|
// GL044: a rules:needs: entry references a job that does not exist in the pipeline.
|
||||||
// rules:needs: overrides the top-level needs: when a specific rule matches (GitLab CI 16.4+).
|
// rules:needs: overrides the top-level needs: when a specific rule matches (GitLab CI 16.4+).
|
||||||
RuleRulesNeedsUnknown = "GL044"
|
RuleRulesNeedsUnknown = "GL044"
|
||||||
|
|
||||||
|
// GL045: an include: remote: entry uses plain HTTP instead of HTTPS.
|
||||||
|
// CI templates fetched over HTTP are transmitted in cleartext and can be
|
||||||
|
// intercepted or modified in transit.
|
||||||
|
RuleInsecureRemoteInclude = "GL045"
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -66,6 +66,11 @@ func (s *Server) Run() error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// maxLSPMessageBytes caps the body size accepted from an LSP client.
|
||||||
|
// A legitimate editor message is never this large; enforcing the cap prevents
|
||||||
|
// a crafted Content-Length from triggering a multi-gigabyte allocation.
|
||||||
|
const maxLSPMessageBytes = 64 << 20 // 64 MiB
|
||||||
|
|
||||||
// readMessage reads one Content-Length–framed JSON-RPC message from the stream.
|
// readMessage reads one Content-Length–framed JSON-RPC message from the stream.
|
||||||
func (s *Server) readMessage() (*Message, error) {
|
func (s *Server) readMessage() (*Message, error) {
|
||||||
var contentLength int
|
var contentLength int
|
||||||
@@ -92,6 +97,9 @@ func (s *Server) readMessage() (*Message, error) {
|
|||||||
if contentLength == 0 {
|
if contentLength == 0 {
|
||||||
return nil, fmt.Errorf("missing or zero Content-Length header")
|
return nil, fmt.Errorf("missing or zero Content-Length header")
|
||||||
}
|
}
|
||||||
|
if contentLength > maxLSPMessageBytes {
|
||||||
|
return nil, fmt.Errorf("Content-Length %d exceeds maximum %d", contentLength, maxLSPMessageBytes)
|
||||||
|
}
|
||||||
|
|
||||||
body := make([]byte, contentLength)
|
body := make([]byte, contentLength)
|
||||||
if _, err := io.ReadFull(s.in, body); err != nil {
|
if _, err := io.ReadFull(s.in, body); err != nil {
|
||||||
|
|||||||
@@ -364,6 +364,20 @@ func TestServer_DidClose_ClearsdiAgnostics(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestServer_ContentLengthTooLarge(t *testing.T) {
|
||||||
|
// Craft a header with a content-length that exceeds the cap.
|
||||||
|
// The server must reject it before allocating a giant buffer.
|
||||||
|
header := fmt.Sprintf("Content-Length: %d\r\n\r\n", maxLSPMessageBytes+1)
|
||||||
|
srv, _, _ := newTestServer([]byte(header))
|
||||||
|
err := srv.Run()
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for oversized Content-Length, got nil")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "exceeds maximum") {
|
||||||
|
t.Errorf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestServer_UriToPath(t *testing.T) {
|
func TestServer_UriToPath(t *testing.T) {
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
uri string
|
uri string
|
||||||
|
|||||||
@@ -133,6 +133,12 @@ func resolveLocalInclude(p *model.Pipeline, rawPath string, cfg fetcher.GitLabCo
|
|||||||
absPath := filepath.Join(rootDir, relPath)
|
absPath := filepath.Join(rootDir, relPath)
|
||||||
label := "local " + rawPath
|
label := "local " + rawPath
|
||||||
|
|
||||||
|
// Guard against path traversal: reject any path that escapes rootDir.
|
||||||
|
rel, err := filepath.Rel(rootDir, absPath)
|
||||||
|
if err != nil || strings.HasPrefix(rel, "..") {
|
||||||
|
return []IncludeWarning{{Label: label, Err: fmt.Errorf("path escapes repository root: %s", rawPath)}}, nil
|
||||||
|
}
|
||||||
|
|
||||||
if visited[absPath] {
|
if visited[absPath] {
|
||||||
return nil, nil
|
return nil, nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import (
|
|||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"git.k3nny.fr/glint/internal/fetcher"
|
"git.k3nny.fr/glint/internal/fetcher"
|
||||||
@@ -332,6 +333,32 @@ func TestResolveLocalInclude_WithNestedIncludes(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestResolveLocalInclude_PathTraversal(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
p := &model.Pipeline{Jobs: map[string]model.Job{}, RawJobs: map[string]map[string]any{}}
|
||||||
|
// A path that escapes the repository root via "../.." must produce a warning,
|
||||||
|
// not silently read an arbitrary file.
|
||||||
|
warnings, _ := resolveLocalInclude(p, "../../etc/passwd", fetcher.GitLabConfig{}, dir, map[string]bool{}, 0)
|
||||||
|
if len(warnings) == 0 {
|
||||||
|
t.Fatal("expected warning for path traversal, got none")
|
||||||
|
}
|
||||||
|
if !strings.Contains(warnings[0].Err.Error(), "path escapes") {
|
||||||
|
t.Errorf("unexpected warning: %v", warnings[0])
|
||||||
|
}
|
||||||
|
if len(p.Jobs) != 0 {
|
||||||
|
t.Error("no jobs should be merged when path escapes root")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestResolveLocalInclude_PathTraversalWithLeadingSlash(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
p := &model.Pipeline{Jobs: map[string]model.Job{}, RawJobs: map[string]map[string]any{}}
|
||||||
|
warnings, _ := resolveLocalInclude(p, "/../../etc/shadow", fetcher.GitLabConfig{}, dir, map[string]bool{}, 0)
|
||||||
|
if len(warnings) == 0 {
|
||||||
|
t.Fatal("expected warning for path traversal via leading slash, got none")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// ── resolveRemoteInclude ──────────────────────────────────────────────────────
|
// ── resolveRemoteInclude ──────────────────────────────────────────────────────
|
||||||
|
|
||||||
func TestResolveRemoteInclude_Success(t *testing.T) {
|
func TestResolveRemoteInclude_Success(t *testing.T) {
|
||||||
|
|||||||
Vendored
+8
@@ -0,0 +1,8 @@
|
|||||||
|
stages: [build]
|
||||||
|
|
||||||
|
include:
|
||||||
|
- remote: http://ci-templates.example.invalid/template.yml
|
||||||
|
|
||||||
|
build-job:
|
||||||
|
stage: build
|
||||||
|
script: echo hello
|
||||||
Reference in New Issue
Block a user