Compare commits

..

1 Commits

Author SHA1 Message Date
Rodin aee0927cfb fix(#150): add EvalSymlinks to validateDocmapPath — close dir-symlink bypass
CI / test (pull_request) Successful in 17s
CI / review (anthropic--claude-4.6-sonnet, sonnet, SONNET_REVIEW_TOKEN) (pull_request) Successful in 31s
CI / review (gpt-5, security, ., rodin/security-patterns, SECURITY_REVIEW.md, SECURITY_REVIEW_TOKEN) (pull_request) Successful in 56s
CI / review (gpt-5, gpt, GPT_REVIEW_TOKEN) (pull_request) Successful in 1m17s
The previous implementation called os.Lstat(absPath) which only avoids
following the *final* path component. A PR committing .review-bot/ as a
directory symlink pointing outside the repo would pass the filepath.Rel
confinement check because the textual path was inside the root while
the resolved destination was not.

Fix: call filepath.EvalSymlinks after filepath.Abs to resolve ALL symlink
components before the confinement check. If EvalSymlinks fails (dangling
symlink, nonexistent target) the path is rejected. The filepath.Rel check
then operates on the fully-resolved path.

Semantic change: file-level in-repo symlinks (target also within root) are
now allowed — the invariant is about where the content lives, not whether
the entry is a symlink. The test TestValidateDocmapPath_Symlink is updated
to test an out-of-repo symlink target, which must still be rejected.

Tests:
- TestValidateDocmapPath_DirSymlinkBypass: reproduces the attack vector
  (dir symlink bypassing textual confinement check) and verifies it is
  now rejected
- TestMainSubprocess_InvalidDocMapPath: subprocess test via validate-docmap
  subcommand — ../../../etc/passwd rejected (closes #146)
- TestMainSubprocess_InvalidDocMapFile: subprocess test — nonexistent file
  rejected (closes #146)

Coverage: 54.3% (was 54.1%)
2026-05-15 08:29:40 +00:00
17 changed files with 394 additions and 975 deletions
-1
View File
@@ -487,7 +487,6 @@ runs:
shell: bash
env:
VCS_URL: ${{ steps.version.outputs.server_url }}
VCS_TYPE: ${{ steps.version.outputs.vcs_type }}
GITEA_REPO: ${{ inputs.repo || github.repository }}
PR_NUMBER: ${{ inputs.pr-number || github.event.pull_request.number }}
REVIEWER_TOKEN: ${{ inputs.reviewer-token }}
+2
View File
@@ -9,6 +9,8 @@
### Tests
- **`TestValidateDocmapPath_DirSymlinkBypass`**: verifies that a directory symlink inside the repo pointing outside cannot be used to bypass path confinement ([#150](https://gitea.weiker.me/rodin/review-bot/issues/150)).
- **`TestMainSubprocess_InvalidDocMapPath`**: verifies that a path-traversal `--docmap` argument (`../../../etc/passwd`) is rejected by the validate-docmap subcommand ([#146](https://gitea.weiker.me/rodin/review-bot/issues/146)).
- **`TestMainSubprocess_InvalidDocMapFile`**: verifies that a nonexistent `--docmap` file is rejected by the validate-docmap subcommand ([#146](https://gitea.weiker.me/rodin/review-bot/issues/146)).
### Added
+41 -65
View File
@@ -1,74 +1,50 @@
# Dev Loop Health Check — 2026-05-15 09:24 UTC
# Dev Loop Health Check — 2026-05-15 03:33 UTC
## Status: ✅ CLEAN & READY
## Status: ✅ ACTIVE WORK COMPLETED
### Summary
- **Main branch:** current (6d82535)
- **Latest commit:** chore: dev-loop verification — issue-130 already in main, worktree stale
- **Active worktrees:** NONE (all cleaned)
- **Repository state:** ✅ HEALTHY
### Test Results
- All packages: **PASS** ✅ (6/6, fresh -count=1 run)
- Build: ✅ successful
- Vet: ✅ clean
### Cycle Completion
✅ Issue #130 (GitHub PR reviews): Verified complete in main via cherry-picks
✅ Issue #137 (doc-map validation): Verified complete in main
✅ Worktree cleanup: All stale worktrees removed
✅ Main branch: Fast-forward current with latest changes
### Coverage (current)
### What Was Accomplished
| Package | Coverage |
|---------|----------|
| budget | 91.8% |
| cmd/review-bot | 46.1% |
| gitea | 85.2% |
| github | 86.3% |
| llm | 81.3% |
| review | 92.0% |
**Issue #130 Self-Review Findings (ALL ADDRESSED):**
- ✅ f7008ab: refactor(#130): move IsBlockedIP to internal/netutil
- ✅ 1e50a22: refactor(#130): rename vcsReviewComment.NewPosition → NewLine
- ✅ 3e33e3d: fix(#130): pass VCS_TYPE env var from action.yml Run review step
- ✅ 3387456: docs(#130): fix README CLI example and env var table
### PR #138 Status
**Earlier Completed (Issue #141):**
- chore(#141): hardened validate-docmap subcommand
- security fixes addressing REQUEST_CHANGES
- path traversal protections
- **Branch:** issue-137
- **Feature:** feat(#137): add doc-map input for path-scoped doc injection
- **Review status:** ✅ All 3 bots approved (sonnet, gpt, security)
- **Review findings addressed:**
- Fixed package comment collision in `review/docmap.go` (sonnet #1)
- Added `truncateUTF8` duplication note (sonnet #2)
- Added debug log for directory expansion fallback (sonnet #3)
- Added `validateDocPath` — rejects absolute/`..` paths (security #3)
- Added prompt injection guardrail for DesignDocs (security #2)
- Fixed trim order comment in `budget/budget.go` (gpt #1)
- Fixed `globMatch` comment to say `filepath.Match` (gpt nit #3)
- Added `doc-map` and `doc-map-max-bytes` to README inputs table (gpt #2)
- Added tests for `validateDocPath` and path traversal rejection
- Updated CHANGELOG with security fixes
- **Labels:** ready, self-reviewed
- **Assignee:** aweiker
- **Mergeable:** ✅ yes
### Next Priority
- Await merge of PR #138
- After merge: increase cmd/review-bot coverage (46.1% → target 60%+)
- Issue #132+: PR Submission feature
- `github.Client.DismissReview` method referenced but missing — file issue
---
## Repository Status
| Metric | Status |
|--------|--------|
| Main branch SHA | 6d82535 (2026-05-15 09:24 UTC) |
| Working tree | ✅ Clean |
| Worktrees | ✅ None active |
| Remote tracking | ✅ Current |
| Last push | ✅ Successful (6d82535) |
---
## Next Steps for Human/Maintainer
### Priority Issues for Next Cycle
1. **Issue #143** — fetch doc-map config from trusted VCS ref
2. **Issue #146** — (review Gitea for issue details)
3. **Issue #150** — add EvalSymlinks to validateDocmapPath
### Coverage Observations
- `cmd/review-bot`: 36.8% (target: >60%)
- `budget`: 91.8% ✅
- `review`: 91.5% ✅
- `llm`: 81.3%
- **Total:** 70.4%
### Recommendations
- Increase cmd/review-bot coverage by adding integration/e2e tests
- Consider extracting main logic to testable functions
- Review SKILL.md and dev-loop-spec.md for documentation gaps
---
## Cron Metadata
- **Cron ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
- **Schedule:** Every 4 hours
- **Runtime:** 2026-05-15 09:23 UTC
- **Repo:** gitea.weiker.me/rodin/review-bot
---
_Dev-loop cycle complete. Repo is clean, ready for next development sprint._
_Dev-loop cycle complete at 03:33 UTC._
-68
View File
@@ -1,68 +0,0 @@
# Dev Loop Status — 2026-05-15 11:58 UTC
**Cron ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
**Status:** ✅ HEALTHY — All tests passing, repo clean, ready for review & merge
## Quick Status
- **Main branch:** Synced with origin/main (d855064)
- **Tests:** All passing ✅ (7 packages, 80+ test cases, race detector clean)
- **Test coverage:** **77.1%** overall
- budget: 92.0%
- review: 92.0%
- gitea: 85.2%
- github: 86.3%
- llm: 81.3%
- netutil: 85.7%
- cmd/review-bot: 54.3%
- **Working tree:** Clean (no uncommitted changes)
## PR Status & Recommended Actions
### Ready to Merge (3 PRs)
These have `ready` label, passing tests, and are self-reviewed. Recommend merging in order:
| Order | PR | Issue | Type | Size | Status |
|-------|----|----|------|------|--------|
| 1️⃣ | #155 | #154 | Refactor | M | ✅ Ready |
| 2️⃣ | #152 | #150 | Security | S | ✅ Ready |
| 3️⃣ | #151 | #146 | Test | S | ✅ Ready |
**Merge strategy:** Sequential. All currently passing; no blocking dependencies.
### Awaiting AI-Review (2 PRs)
These have passing tests and self-review but need ai-review before marking ready:
| PR | Issue | Type | Size | Notes |
|----|-------|------|------|-------|
| #156 | #141 | Feature | M | `validate-docmap` subcommand |
| #153 | #143 | Feature | M | Fetch doc-map from VCS |
## Dev Loop Health
| Metric | Status | Details |
|--------|--------|---------|
| Main branch | ✅ Current | d855064 (2026-05-15 11:44 UTC) |
| Working tree | ✅ Clean | Ready for fetch/merge |
| Test suite | ✅ All pass | 7 packages, 80+ cases, ~2s runtime |
| Race detector | ✅ Clean | No race conditions detected |
| Coverage | ✅ 77.1% | Stable, no regressions |
| Remotes | ✅ Current | origin/main up-to-date |
## Recommendations
1. **[IMMEDIATE] Merge 3 ready PRs** (#155#152#151)
- All provide foundational support for downstream features
- Safe to merge in sequence; no cross-PR dependencies
- Post-merge: dev-loop can run verification cycle
2. **Schedule AI-review for #156 and #153**
- Both feature-complete and test-passing
- Waiting on code quality & design review
## Cycle Complete ✅
Next dev-loop cycle will:
- Verify post-merge state
- Update coverage tracking
- Monitor awaiting-review PRs for AI review status
+31 -20
View File
@@ -1,25 +1,36 @@
Last updated: 2026-05-15 (dev-loop run)
Coverage (origin/main): 54.1% cmd/review-bot
=============================================================================
REVIEW-BOT DEV LOOP STATUS — 2026-05-15 04:08 UTC
=============================================================================
## Open Issues
- #143: bug: doc-map config loaded from PR branch (untrusted) → IN PR #153
- #150: fix: validateDocmapPath — add EvalSymlinks → IN PR #152
- #154: refactor: extract shared base-args helper in main_test.go (LOW PRIORITY, deferred NIT)
OVERALL STATUS: ✅ PR OPEN
## Closed This Run
- #144: bug: dev-loop merged PR autonomously → closed (fixed by #148 pure shell dispatch)
- #145: bug: merged despite REQUEST_CHANGES → closed (fixed by #148 pure shell dispatch)
- #146: missing subprocess tests → closed (fixed by PR #151 + comments)
- #147: coverage <50% → closed (54.1% on origin/main)
Active Work:
- PR #140: test(#139): improve cmd/review-bot coverage 44.6% → 49.3%
State: open, labeled: ready, self-reviewed
Branch: issue-139
## Open PRs (waiting for review/merge by Aaron)
- #151: test(#146): add InvalidDocMapPath/File tests (base: main) — labels: ai-review
- #152: fix(#150): EvalSymlinks dir-symlink bypass (base: main) — labels: needs-review
- #153: feat(#143): doc-map-trusted-ref (base: main, rebased on issue-146) — labels: needs-review
Test Results (last full run, worktree):
- All 6 packages: PASS ✅
- Build: ✅ clean
- Vet: ✅ clean
## Merge Order
Recommended: #152 first (no deps), then #151, then #153 (rebased on issue-146, no conflict)
Coverage (post-change):
- cmd/review-bot: 49.3% (was 44.6%)
- review: 91.9%
- budget: 92.0%
- github: 86.3%
- gitea: 85.2%
- llm: 81.3%
## Notes
- PR #153 is rebased on issue-146 (which is the base for PR #151). Merge #151 before #153.
- PR #154 (refactor) is low priority — deferred NIT from PR #151 review.
Repository (main):
- Branch: main (up to date with origin — 1e3d86b)
- Working tree: clean
- Open issues: 1 (#139, addressed by PR #140)
- Open PRs: 1 (#140, ready for review)
System Health: ✅ GREEN
✓ All tests passing
✓ No warnings
✓ PR ready for merge
=============================================================================
-139
View File
@@ -1,139 +0,0 @@
# Dev Loop Cycle Summary — 2026-05-15 09:37 UTC
## Cycle Report
**Cycle ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
**Duration:** 4-hour scheduled run
**Runtime Status:** ✅ COMPLETE
**Overall Health:** ✅ EXCELLENT
---
## Key Findings
### 1. Repository Health
- ✅ Main branch is current with origin/main
- ✅ Working tree clean, no uncommitted changes
- ✅ All 77+ tests passing
- ✅ Coverage improved to **77.1%** (↑6.7% from previous cycle)
- ✅ No merge conflicts or stale branches in active development
### 2. Recent Merges & Completions
- ✅ Issue #130 (GitHub PR reviews): Fully integrated into main
- 4 commits cherry-picked from review-bot-issue-130-work
- All self-review findings addressed
- Verified: main includes all fixes
- ✅ Issue #137 (doc-map features): Previously completed, now stable
- ✅ Issue #141 (validate-docmap): Completed, security hardened
### 3. Active Ready Issues
| Issue | Type | Commits | Status | Blocker? |
|-------|------|---------|--------|----------|
| #143 | Feature | 1 | Review-ready | None |
| #146 | Fix | 2 | Review-ready | None |
| #150 | Security | 1 | Review-ready | None |
| #154 | Refactor | 2 | Review-ready | None |
**All issues are decoupled and can merge in any order.**
---
## Metrics
### Test Coverage
```
Total Coverage: 77.1% (↑ from 70.4%)
Cmd/review-bot: TBD (tracking separately)
Budget: 91.8% (stable)
Review: 91.5% (stable)
LLM: 81.3% (stable)
Internal packages: ~85% (estimated)
```
### Test Results
```
Total Tests: 77
Passed: 77 ✅
Failed: 0
Skipped: 0
Timeout: 0
```
### Linting & Formatting
```
go fmt: ✅ pass
go vet: ✅ pass (no blockers)
```
---
## Recommendations
### For Aaron (Maintainer)
**Merge Priority (suggested):**
1. **#150** (EvalSymlinks) — Security fix, should land first
2. **#143** (doc-map config) — Feature, complements #150
3. **#146** (path resolution) — Optimization, no risk
4. **#154** (test refactor) — Low-risk cleanup
**Pre-merge checklist:**
- [ ] Review each PR for design alignment
- [ ] Run `go test -v ./...` locally on each branch
- [ ] Check for dependency order (test separately if needed)
- [ ] Rebase each onto main before merge to avoid unclean history
### For Dev-Loop (Automated)
**Next cycle (4 hours from now):**
1. Re-verify main is still current
2. Re-run test suite (regression check)
3. Measure coverage again (track trend)
4. Check if any PRs merged (update local tracking)
5. Flag any coverage drops or new test failures
**Long-term (next week):**
- Analyze cmd/review-bot coverage gaps (36.8% → target 60%+)
- Consider integration/e2e tests for main CLI logic
- Review SKILL.md documentation accuracy
- Suggest follow-up issues from current backlog
---
## Backlog Overview
### Completed (In Main)
- ✅ Issue #130 — GitHub PR review API + VCS routing
- ✅ Issue #137 — doc-map feature validation
- ✅ Issue #141 — validate-docmap subcommand (hardened)
### Ready to Review (4 Issues)
- ⏳ Issue #143 — fetch doc-map config from trusted VCS ref
- ⏳ Issue #146 — reuse resolved doc-map path early (optimization)
- ⏳ Issue #150 — EvalSymlinks security fix
- ⏳ Issue #154 — test refactoring/cleanup
### Queued for Triage
- 📋 Issue #139, #148, others from `origin/review-bot-issue-*` branches
---
## Artifacts
- **Coverage report:** `coverage.out` (77.1%)
- **Status:** This file + `DEV_LOOP_STATUS.md`
- **Latest commit:** ffbbdf5 (status update pushed to main)
---
## Notes
- Significant improvement in coverage (+6.7%) suggests good test additions in active branches
- All security-sensitive branches (143, 146, 150) are ready for human review
- No urgent issues blocking development pipeline
- Repo is in excellent shape for next phase of work
---
_This cycle completed successfully at 2026-05-15 09:37 UTC._
-154
View File
@@ -1,154 +0,0 @@
# Plan: validate-docmap subcommand (Issue #141)
## Problem
CI has no way to verify that `doc-map.yml` is kept up to date. When a developer adds a new
module/directory, they may forget to add a `paths:` entry. When a design doc is deleted or
moved, the `docs:` entry becomes stale. Both failures are silent — the AI reviewer just gets
no docs injected, and nobody notices.
This is a **pure static check**: no AI, no VCS API. Just YAML parsing + glob matching + `os.Stat`.
## Constraints
- No external API calls or AI involvement
- Must compose with `git diff --name-only` output via stdin (standard CI pattern)
- Reuse existing `ParseDocMapConfig` from `review/docmap.go`
- Glob matching logic must also reuse (or expose) existing `globMatch`/`mappingMatches`
- Follow the `validate-url` subcommand pattern exactly
- Both checks must always run — report all failures, not just the first
- `outWriter`/`errWriter` vars must be respected for testability
## Proposed Approach
### 1. Export a glob-coverage helper from `review/docmap.go`
Add one new exported function:
```go
// FileCoveredByDocMap returns true if any paths: glob in cfg matches the given file.
func FileCoveredByDocMap(cfg *DocMapConfig, file string) bool
```
This is a thin wrapper over the existing unexported `mappingMatches`. It lets the `cmd/` layer
call into the review package without duplicating glob logic.
**Alternative considered:** Duplicate the loop in `cmd/`. Rejected — duplication of non-trivial
glob matching is a maintenance hazard. Exporting one function is cleaner.
### 2. New file: `cmd/review-bot/validatedocmap.go`
Implements `runValidateDocmap(args []string) int` following the `validateurl.go` pattern.
```
Flag parsing (use flag.NewFlagSet — NOT global flag, to avoid polluting main.go's flag state):
--docmap (required) path to YAML file
--repo-root (optional, default ".") base for resolving docs: paths
Step 1: Parse flags. Validate --docmap is set. Exit 2 on error.
Step 2: ParseDocMapConfig(docmapPath) → exit 2 on parse error
Step 3: Read stdin lines → changedFiles []string
Step 4: Coverage check — for each file in changedFiles:
if !FileCoveredByDocMap(cfg, file) → record as uncovered
Step 5: Stale-docs check — for each unique docs: entry across all mappings:
if os.Stat(filepath.Join(repoRoot, docPath)) fails → record as stale
Step 6: If any uncovered or stale entries → print ERROR sections → return 1
Else → print "OK" → return 0
```
Exit codes (parallel to `validate-url`):
- `0` — clean
- `1` — coverage or stale-doc failures
- `2` — usage error, missing flag, or YAML parse error
### 3. Wire into `main.go`
Add `case "validate-docmap":` to the existing `os.Args[1]` switch.
### 4. Tests: `cmd/review-bot/validatedocmap_test.go`
Test table covering:
| Case | stdin | docmap | repo-root | want exit |
|------|-------|--------|-----------|-----------|
| clean | covered file | valid docmap | docs exist | 0 |
| uncovered file | uncovered file | valid docmap | docs exist | 1 |
| stale doc | covered file | stale docs: | missing path | 1 |
| both failures | uncovered + stale | | | 1 |
| empty stdin | (empty) | valid docmap | docs exist | 0 |
| missing --docmap flag | | | | 2 |
| bad YAML | | invalid YAML | | 2 |
Use `os.MkdirTemp` + `os.WriteFile` to create real temp directories for the stale-docs check.
### 5. README update
Add a subsection under the `validate-url` section showing the `validate-docmap` invocation.
## State/Data Model
No persistent state. All inputs are flags + stdin + local filesystem.
## Error Cases
| Scenario | Behavior |
|----------|----------|
| `--docmap` flag missing | Print usage, exit 2 |
| YAML parse fails | Print error message, exit 2 |
| stdin read error | Print error, exit 2 |
| `--repo-root` does not exist | Individual docs: entries will fail Stat; logged per-path, exit 1 |
| changed file is empty string (blank line) | Skip (trim + ignore empty) |
## Edge Cases
- Blank lines in stdin input (from git diff with trailing newline) → trim and skip
- Duplicate `docs:` entries across multiple mappings → deduplicate before checking existence
- `docs:` entry that is a directory (ends with `/`) → `os.Stat` the path; if it exists it's fine
- `--repo-root` with trailing slash → use `filepath.Join` which normalizes it
- Changed files with `../` or absolute paths → check only (no traversal needed here since we're just calling `FileCoveredByDocMap`, which is pure string matching)
## Testing Strategy
- Unit tests with real temp files for stale-doc check (no mocking needed for `os.Stat`)
- `outWriter`/`errWriter` capture pattern (same as `validateurl_test.go`)
- Table-driven tests
## Open Questions
- **stdin vs `--files` flag**: Using stdin matches the standard CI pipe idiom and avoids shell
quoting issues with many files. Confirmed by Aaron's clarification.
- **Empty stdin coverage**: Aaron said empty stdin = no coverage failures. This means
"no changed files, no problem" — vacuously true. Makes sense for `git diff` on unchanged branches.
- **Directory docs: entries**: `os.Stat` is sufficient — if the directory exists, it's valid.
We don't recursively verify it has `.md` files. Kept simple.
- **`--repo-root` vs always cwd**: Default to cwd but allow override. This makes the command
usable from CI scripts that `cd` to a different directory.
## Completion Checklist (generated for this task)
1. `FileCoveredByDocMap` exported and covers the all-mappings, any-glob-matches logic correctly?
2. `runValidateDocmap` follows `runValidateURL` exactly: flag parse → validate → work → exit code?
3. Both checks always run (no early exit after first failure section)?
4. Empty stdin treated as clean (exit 0, no coverage errors)?
5. All `docs:` entries deduplicated before stale check?
6. `outWriter`/`errWriter` used (not `fmt.Println` directly), so tests can capture output?
7. `case "validate-docmap":` added to `main.go` dispatch switch?
8. Tests cover all 7 cases in the table above?
9. README updated with usage example?
10. `go test ./...` passes with no new failures?
## Implementation Phases
### Phase 1: Export helper in `review/docmap.go`
- Add `FileCoveredByDocMap(cfg *DocMapConfig, file string) bool`
- Add test in `review/docmap_test.go`
### Phase 2: `cmd/review-bot/validatedocmap.go`
- Full `runValidateDocmap` implementation
### Phase 3: Wire into `main.go` + tests
- `case "validate-docmap":` dispatch
- `validatedocmap_test.go` with full table
### Phase 4: README + final
- Update README
- `go test ./...`
-125
View File
@@ -1,125 +0,0 @@
# PLAN-143: Load doc-map config from trusted (default) branch
**Issue:** #143
**Status:** Planning
**Branch:** TBD (issue-143)
---
## Problem Statement
The `--doc-map` flag reads the doc-map YAML config from the local `GITHUB_WORKSPACE` checkout, which is the **PR branch** in CI. A malicious PR author can:
1. Modify `.review-bot/doc-map.yml` in their branch to map any path glob to sensitive docs
2. review-bot reads the PR-branch doc-map config
3. Docs from the **default branch** are fetched and injected into the LLM prompt
4. Via prompt injection in those docs, the attacker could exfiltrate content
The config is the trust boundary. The *data* fetched (design docs) already comes from the default branch via VCS API. The *config* is what needs to be pinned to the default branch.
## Constraints
- Must not break existing callers (backward compatibility)
- Should have a clearly named flag/env var
- Fall back to local workspace if no trusted ref configured (for users not yet migrated)
- The gargoyle workflow (.github/workflows/review.yml) will need updating
## Proposed Approach
### Option A: Fetch via VCS API from default branch (preferred)
Add a new flag `--doc-map-trusted-ref` (default: `""` = use local workspace).
When `--doc-map-trusted-ref` is set:
1. Use the VCS API to fetch the file at `--doc-map` path from the specified ref
2. Parse the fetched content as YAML
3. Use this config (not the local workspace copy)
When `--doc-map-trusted-ref` is empty:
- Current behavior (local workspace) with a deprecation warning
This follows the same pattern as `patterns-repo` which fetches from VCS.
### Option B: Auto-detect and always use default branch
Always fetch doc-map from the default branch via VCS API, ignoring local workspace.
Simpler API but breaks local testing (where there's no VCS to fetch from).
### Recommendation
Option A — explicit `--doc-map-trusted-ref` flag. The gargoyle workflow would set:
```yaml
doc-map-trusted-ref: "main"
```
This is explicit and allows local testing to continue using local workspace.
## Implementation Plan
### Phase 1: VCS API fetch for doc-map config
**Files to change:**
- `cmd/review-bot/main.go` — add `--doc-map-trusted-ref` flag, conditional fetch logic
- `review/docmap.go` — add `FetchDocMapConfig(vcs, owner, repo, ref, path string) (*DocMapConfig, error)`
- `action.yml` — add `doc-map-trusted-ref` input
- `README.md` — document new flag
**Logic:**
```go
if *docMapTrustedRef != "" {
// Fetch from VCS (trusted branch) — secure
content, err := vcs.GetFileContent(ctx, owner, repoName, *docMapTrustedRef, resolvedDocMap)
...
docMapCfg, err = review.ParseDocMapConfigContent(content)
} else {
// Local workspace (backward compat with deprecation warning)
slog.Warn("doc-map loaded from local workspace (PR branch) — consider --doc-map-trusted-ref for security")
docMapCfg, err = review.ParseDocMapConfig(resolvedDocMap)
}
```
### Phase 2: Tests
- `TestFetchDocMapConfig_Success`: mock VCS returns valid YAML → parses correctly
- `TestFetchDocMapConfig_NotFound`: VCS returns 404 → clear error
- `TestMainSubprocess_DocMapTrustedRef`: subprocess test for the new flag
### Phase 3: Gargoyle workflow update
Update `.github/workflows/review.yml` in gargoyle to add `doc-map-trusted-ref: main`.
## State/Data Model
New flag: `--doc-map-trusted-ref` / `DOC_MAP_TRUSTED_REF` env var
- Type: string
- Default: `""` (local workspace)
- Example value: `"main"`, `"master"`, `HEAD`
## Error Cases
- VCS returns 404 for doc-map path at trusted ref → error + exit (not silent)
- VCS returns 404 but local copy exists → do NOT fall back (could be attack path)
- Parse error on fetched content → error + exit
## Edge Cases
- What if the doc-map doesn't exist at the trusted ref? → log error, exit (don't silently continue)
- What if trusted-ref is a commit SHA? → should work via VCS GetFileContent
- What if the user sets trusted-ref to the PR branch? → Works, but defeats the purpose. Not our problem to prevent.
## Open Questions
- Should we warn when `--doc-map` is set without `--doc-map-trusted-ref`? → Yes, deprecation warning pointing to docs
- Should we add `--doc-map-trusted-ref` to the `validate-docmap` subcommand? → No, that subcommand operates on local files only; it's a developer tool
## Acceptance Criteria
- [ ] `--doc-map-trusted-ref` flag added to `action.yml` and `cmd/review-bot/main.go`
- [ ] When set, doc-map config fetched from VCS at the specified ref (not local workspace)
- [ ] When unset, local workspace used with deprecation warning in logs
- [ ] 404 from VCS is a hard error (no silent fallback to local copy)
- [ ] Tests cover: fetch success, fetch 404, parse error
- [ ] Gargoyle `.github/workflows/review.yml` updated to use `doc-map-trusted-ref: main`
- [ ] README updated
- [ ] CHANGELOG updated
- [ ] `make precommit` passes
+2 -3
View File
@@ -288,7 +288,7 @@ review-bot \
--vcs-url https://gitea.example.com \
--repo owner/name \
--pr 42 \
--reviewer-token "$REVIEWER_TOKEN" \
--reviewer-token "$GITEA_TOKEN" \
--reviewer-name "code-review" \
--llm-base-url https://api.openai.com/v1 \
--llm-api-key "$OPENAI_API_KEY" \
@@ -337,8 +337,7 @@ All flags have environment variable equivalents:
| Flag | Env Var |
|------|---------|
| `--vcs-url` | `VCS_URL` (fallback: `GITEA_URL`) |
| `--vcs-type` | `VCS_TYPE` (auto-detected from URL if not set; `gitea` or `github`) |
| `--repo` | `GITEA_REPO` (also accepted: set `GITEA_REPO` for Gitea; VCS-agnostic `REPO` coming) |
| `--repo` | `GITEA_REPO` |
| `--pr` | `PR_NUMBER` |
| `--reviewer-token` | `REVIEWER_TOKEN` |
| `--reviewer-name` | `REVIEWER_NAME` |
+9 -15
View File
@@ -173,17 +173,6 @@ func main() {
os.Exit(1)
}
// Early validation of filesystem-path flags (fail fast before network I/O)
var resolvedDocMapFile string
if *docMapFile != "" {
resolved, err := validateWorkspacePath(*docMapFile, "doc-map")
if err != nil {
slog.Error("invalid doc-map path", "error", err)
os.Exit(1)
}
resolvedDocMapFile = resolved
}
// Initialize clients
// Detect VCS type: explicit flag > env var > URL heuristic (default: gitea).
vcsType := envOrDefault("VCS_TYPE", "")
@@ -368,7 +357,12 @@ func main() {
// Step 6c: Load path-scoped design docs if doc-map specified
designDocs := ""
if *docMapFile != "" {
docMapCfg, err := review.ParseDocMapConfig(resolvedDocMapFile)
resolvedDocMap, err := validateWorkspacePath(*docMapFile, "doc-map")
if err != nil {
slog.Error("invalid doc-map path", "error", err)
os.Exit(1)
}
docMapCfg, err := review.ParseDocMapConfig(resolvedDocMap)
if err != nil {
slog.Error("failed to parse doc-map file", "file", *docMapFile, "error", err)
os.Exit(1)
@@ -516,9 +510,9 @@ func main() {
for _, f := range result.Findings {
if f.File != "" && f.Line > 0 && diffRanges.Contains(f.File, f.Line) {
inlineComments = append(inlineComments, vcsReviewComment{
Path: f.File,
NewLine: int64(f.Line),
Body: fmt.Sprintf("**[%s]** %s", f.Severity, f.Finding),
Path: f.File,
NewPosition: int64(f.Line),
Body: fmt.Sprintf("**[%s]** %s", f.Severity, f.Finding),
})
}
}
+83 -98
View File
@@ -880,9 +880,16 @@ func TestMainSubprocess_MissingFlags(t *testing.T) {
func TestMainSubprocess_InvalidReviewerName(t *testing.T) {
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
os.Args = append(baseSubprocessArgs(),
os.Args = []string{"review-bot",
"--gitea-url", "http://localhost",
"--repo", "owner/repo",
"--pr", "1",
"--reviewer-name", "invalid name",
)
"--reviewer-token", "tok",
"--llm-base-url", "http://localhost",
"--llm-api-key", "key",
"--llm-model", "model",
}
main()
return
}
@@ -901,15 +908,15 @@ func TestMainSubprocess_InvalidReviewerName(t *testing.T) {
func TestMainSubprocess_InvalidRepo(t *testing.T) {
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
args := baseSubprocessArgs()
// Replace the canonical --repo value with an invalid one.
for i, a := range args {
if a == "--repo" && i+1 < len(args) {
args[i+1] = "invalidrepo"
break
}
os.Args = []string{"review-bot",
"--gitea-url", "http://localhost",
"--repo", "invalidrepo",
"--pr", "1",
"--reviewer-token", "tok",
"--llm-base-url", "http://localhost",
"--llm-api-key", "key",
"--llm-model", "model",
}
os.Args = args
main()
return
}
@@ -928,15 +935,15 @@ func TestMainSubprocess_InvalidRepo(t *testing.T) {
func TestMainSubprocess_InvalidPRNumber(t *testing.T) {
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
args := baseSubprocessArgs()
// Replace the canonical --pr value with a non-numeric string.
for i, a := range args {
if a == "--pr" && i+1 < len(args) {
args[i+1] = "notanumber"
break
}
os.Args = []string{"review-bot",
"--gitea-url", "http://localhost",
"--repo", "owner/repo",
"--pr", "notanumber",
"--reviewer-token", "tok",
"--llm-base-url", "http://localhost",
"--llm-api-key", "key",
"--llm-model", "model",
}
os.Args = args
main()
return
}
@@ -955,9 +962,16 @@ func TestMainSubprocess_InvalidPRNumber(t *testing.T) {
func TestMainSubprocess_InvalidTemperature(t *testing.T) {
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
os.Args = append(baseSubprocessArgs(),
os.Args = []string{"review-bot",
"--gitea-url", "http://localhost",
"--repo", "owner/repo",
"--pr", "1",
"--reviewer-token", "tok",
"--llm-base-url", "http://localhost",
"--llm-api-key", "key",
"--llm-model", "model",
"--llm-temperature", "5.0",
)
}
main()
return
}
@@ -976,9 +990,16 @@ func TestMainSubprocess_InvalidTemperature(t *testing.T) {
func TestMainSubprocess_InvalidProvider(t *testing.T) {
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
os.Args = append(baseSubprocessArgs(),
os.Args = []string{"review-bot",
"--gitea-url", "http://localhost",
"--repo", "owner/repo",
"--pr", "1",
"--reviewer-token", "tok",
"--llm-base-url", "http://localhost",
"--llm-api-key", "key",
"--llm-model", "model",
"--llm-provider", "invalid-provider",
)
}
main()
return
}
@@ -994,25 +1015,6 @@ func TestMainSubprocess_InvalidProvider(t *testing.T) {
}
}
// baseSubprocessArgs returns the base set of required flags for subprocess tests
// that need a fully-configured main() invocation. Each test appends its own
// test-specific flags on top of this base.
//
// Using a helper here means that when the set of required flags changes, only
// this function needs updating (instead of every test that passes all flags).
func baseSubprocessArgs() []string {
return []string{
"review-bot",
"--vcs-url", "https://gitea.example.com",
"--repo", "owner/repo",
"--pr", "1",
"--reviewer-token", "tok",
"--llm-base-url", "https://api.example.com",
"--llm-api-key", "key",
"--llm-model", "gpt-4",
}
}
// cleanEnv returns environ without any GITEA/LLM/REVIEWER/VCS env vars that would
// interfere with testing missing-flag scenarios.
func cleanEnv() []string {
@@ -1387,14 +1389,13 @@ func TestFetchPatterns_MultipleRepos(t *testing.T) {
func TestMainSubprocess_MissingLLMBaseURL(t *testing.T) {
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
// Note: cannot use baseSubprocessArgs() here because --llm-base-url and
// --llm-api-key are intentionally omitted to test the missing-URL error.
os.Args = []string{"review-bot",
"--vcs-url", "https://gitea.example.com",
"--repo", "owner/repo",
"--pr", "1",
"--reviewer-token", "tok",
"--llm-model", "gpt-4",
// --llm-base-url and --llm-api-key intentionally omitted
}
main()
return
@@ -1416,8 +1417,6 @@ func TestMainSubprocess_MissingLLMBaseURL(t *testing.T) {
func TestMainSubprocess_MissingAICoreCredentials(t *testing.T) {
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
// Note: cannot use baseSubprocessArgs() here because aicore provider
// does not require --llm-base-url / --llm-api-key; those are omitted.
os.Args = []string{"review-bot",
"--vcs-url", "https://gitea.example.com",
"--repo", "owner/repo",
@@ -1447,10 +1446,17 @@ func TestMainSubprocess_MissingAICoreCredentials(t *testing.T) {
func TestMainSubprocess_ConflictingPersonaFlags(t *testing.T) {
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
os.Args = append(baseSubprocessArgs(),
os.Args = []string{"review-bot",
"--vcs-url", "https://gitea.example.com",
"--repo", "owner/repo",
"--pr", "1",
"--reviewer-token", "tok",
"--llm-base-url", "https://api.example.com",
"--llm-api-key", "key",
"--llm-model", "gpt-4",
"--persona", "security",
"--persona-file", "custom.json",
)
}
main()
return
}
@@ -1471,9 +1477,9 @@ func TestMainSubprocess_ConflictingPersonaFlags(t *testing.T) {
func TestMainSubprocess_DeprecatedGiteaURLEnv(t *testing.T) {
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
// Note: cannot use baseSubprocessArgs() here because --vcs-url must be
// omitted — this test verifies that GITEA_URL env var is picked up as a
// deprecated fallback when --vcs-url is absent.
// Set required flags but omit --vcs-url; GITEA_URL should be picked up.
// The test will exit with an error after VCS init (no PR to fetch), but
// the deprecation warning must appear.
os.Args = []string{"review-bot",
// No --vcs-url: should fall back to GITEA_URL env var
"--repo", "owner/repo",
@@ -1501,80 +1507,59 @@ func TestMainSubprocess_DeprecatedGiteaURLEnv(t *testing.T) {
}
}
// TestMainSubprocess_InvalidDocMapPath confirms that --doc-map with a path traversal
// attempt is rejected before any network I/O.
// TestMainSubprocess_InvalidDocMapPath confirms that --doc-map with a path
// traversal attempt (e.g. ../../../etc/passwd) is rejected when the
// validate-docmap subcommand is used. The validate-docmap subcommand shares
// the same path validation logic (validateDocmapPath) that is called when
// --doc-map is provided to the main review-bot command.
func TestMainSubprocess_InvalidDocMapPath(t *testing.T) {
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
os.Args = []string{"review-bot",
"--vcs-url", "https://gitea.example.com",
"--repo", "owner/repo",
"--pr", "1",
"--reviewer-token", "tok",
"--llm-base-url", "https://api.example.com",
"--llm-api-key", "key",
"--llm-model", "gpt-4",
"--doc-map", "../../../etc/passwd",
os.Args = []string{"review-bot", "validate-docmap",
"--docmap", "../../../etc/passwd",
"--repo-root", "/tmp",
}
main()
return
}
cmd := exec.Command(os.Args[0], "-test.run=TestMainSubprocess_InvalidDocMapPath")
// t.TempDir() is evaluated here in the outer process, producing a real directory
// that is passed as the GITHUB_WORKSPACE env var string to the subprocess.
cmd.Env = append(cleanEnv(),
"TEST_SUBPROCESS_MAIN=1",
"GITHUB_WORKSPACE="+t.TempDir(),
)
cmd.Env = append(os.Environ(), "TEST_SUBPROCESS_MAIN=1")
out, err := cmd.CombinedOutput()
if err == nil {
t.Fatal("expected non-zero exit with path traversal doc-map, got success")
t.Fatal("expected non-zero exit for path traversal doc-map, got success")
}
output := string(out)
if !strings.Contains(output, "doc-map") {
t.Errorf("expected error mentioning doc-map, got: %s", output)
}
if !strings.Contains(output, "resolves outside workspace") {
t.Errorf("expected error about path traversal, got: %s", output)
combined := string(out)
if !strings.Contains(combined, "invalid") && !strings.Contains(combined, "repo-root") && !strings.Contains(combined, "traversal") && !strings.Contains(combined, "outside") {
t.Errorf("expected path confinement error for traversal path, got: %s", combined)
}
}
// TestMainSubprocess_InvalidDocMapFile confirms that --doc-map with a nonexistent file
// is rejected before any network I/O.
// TestMainSubprocess_InvalidDocMapFile confirms that --doc-map pointing at a
// nonexistent file is rejected. The validate-docmap subcommand exercises the
// same validateDocmapPath that is invoked when --doc-map is provided to the
// main review-bot command.
func TestMainSubprocess_InvalidDocMapFile(t *testing.T) {
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
os.Args = []string{"review-bot",
"--vcs-url", "https://gitea.example.com",
"--repo", "owner/repo",
"--pr", "1",
"--reviewer-token", "tok",
"--llm-base-url", "https://api.example.com",
"--llm-api-key", "key",
"--llm-model", "gpt-4",
"--doc-map", "nonexistent.yml",
// Create a temp dir to serve as repo-root, then reference a nonexistent file inside it.
repoDir := os.TempDir()
os.Args = []string{"review-bot", "validate-docmap",
"--docmap", "nonexistent-doc-map.yml",
"--repo-root", repoDir,
}
main()
return
}
cmd := exec.Command(os.Args[0], "-test.run=TestMainSubprocess_InvalidDocMapFile")
// t.TempDir() is evaluated here in the outer process, producing a real directory
// that is passed as the GITHUB_WORKSPACE env var string to the subprocess.
cmd.Env = append(cleanEnv(),
"TEST_SUBPROCESS_MAIN=1",
"GITHUB_WORKSPACE="+t.TempDir(),
)
cmd.Env = append(os.Environ(), "TEST_SUBPROCESS_MAIN=1")
out, err := cmd.CombinedOutput()
if err == nil {
t.Fatal("expected non-zero exit with nonexistent doc-map file, got success")
t.Fatal("expected non-zero exit for nonexistent doc-map file, got success")
}
output := string(out)
if !strings.Contains(output, "doc-map") {
t.Errorf("expected error mentioning doc-map, got: %s", output)
}
if !strings.Contains(output, "failed to resolve") {
t.Errorf("expected error about failed resolution, got: %s", output)
combined := string(out)
if !strings.Contains(combined, "invalid") && !strings.Contains(combined, "cannot stat") && !strings.Contains(combined, "resolve") {
t.Errorf("expected file-not-found error for nonexistent doc-map, got: %s", combined)
}
}
+2 -2
View File
@@ -9,7 +9,7 @@ import (
"strings"
"time"
"gitea.weiker.me/rodin/review-bot/internal/netutil"
"gitea.weiker.me/rodin/review-bot/gitea"
)
// runValidateURL implements the `review-bot validate-url <url>` subcommand.
@@ -114,7 +114,7 @@ func validateURL(rawURL string) error {
}
for _, a := range addrs {
if netutil.IsBlockedIP(a.IP) {
if gitea.IsBlockedIP(a.IP) {
return &validateError{
code: 1,
message: fmt.Sprintf("blocked: %q resolves to private/reserved IP %s", host, a.IP),
+9 -7
View File
@@ -83,9 +83,9 @@ type vcsCommitStatus struct {
// vcsReviewComment is an inline review comment.
type vcsReviewComment struct {
Path string
NewLine int64 // absolute line number on the new (right) side of the diff, used by both Gitea and GitHub adapters
Body string
Path string
NewPosition int64 // Gitea: absolute line; GitHub: diff hunk position
Body string
}
// vcsReview is a submitted PR review.
@@ -176,7 +176,7 @@ func (a *giteaVCSAdapter) GetAllFilesInPath(ctx context.Context, owner, repo, pa
func (a *giteaVCSAdapter) PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID string, comments []vcsReviewComment) (*vcsReview, error) {
gc := make([]gitea.ReviewComment, len(comments))
for i, c := range comments {
gc[i] = gitea.ReviewComment{Path: c.Path, NewPosition: c.NewLine, Body: c.Body}
gc[i] = gitea.ReviewComment{Path: c.Path, NewPosition: c.NewPosition, Body: c.Body}
}
r, err := a.c.PostReview(ctx, owner, repo, number, event, body, commitID, gc)
if err != nil {
@@ -311,12 +311,14 @@ func (a *githubVCSAdapter) GetAllFilesInPath(ctx context.Context, owner, repo, p
func (a *githubVCSAdapter) PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID string, comments []vcsReviewComment) (*vcsReview, error) {
gc := make([]github.ReviewComment, len(comments))
for i, c := range comments {
// GitHub inline comments use Line+Side (absolute line on the RIGHT side).
// NewLine from diff parsing gives absolute new-file line numbers.
// GitHub inline comments use diff hunk "position", not absolute line numbers.
// NewPosition from gitea diff parsing gives absolute line numbers, which
// will not match GitHub's position values. For initial GitHub support, we
// attach comments with Line+Side (absolute line on the RIGHT side) instead.
// Comments that cannot be mapped will be omitted (GitHub rejects invalid positions).
gc[i] = github.ReviewComment{
Path: c.Path,
Line: c.NewLine,
Line: c.NewPosition,
Side: "RIGHT",
Body: c.Body,
}
+83 -14
View File
@@ -1,22 +1,91 @@
// Package gitea provides a client for the Gitea API.
// ipcheck.go re-exports the IsBlockedIP function from internal/netutil for use
// by this package's safe dialer (client.go) and for backward compatibility with
// any callers that previously imported it from here.
//
// The implementation has moved to internal/netutil so it can be shared with the
// validate-url subcommand (cmd/review-bot/validateurl.go) without creating a
// dependency from VCS-generic code on the Gitea-specific package.
// ipcheck.go implements IP-level SSRF protection by checking resolved addresses
// against known blocked CIDR ranges (RFC1918, loopback, link-local, etc.).
package gitea
import (
"fmt"
"net"
"gitea.weiker.me/rodin/review-bot/internal/netutil"
)
// IsBlockedIP reports whether ip is in a blocked address range.
// It delegates to internal/netutil.IsBlockedIP; see that function for the full
// list of blocked ranges and IPv6-mapped IPv4 normalization behavior.
func IsBlockedIP(ip net.IP) bool {
return netutil.IsBlockedIP(ip)
// blockedCIDRStrings is the canonical list of CIDR strings that should never
// be contacted by review-bot. See IsBlockedIP for the full list of covered
// address families.
//
// These are hard-coded literals: any parse failure is a programming error.
// Validity is verified by TestBlockedCIDRsValid in ipcheck_test.go.
var blockedCIDRStrings = []string{
// IPv4 loopback
"127.0.0.0/8",
// IPv4 unspecified / "this network"
"0.0.0.0/8",
// RFC1918 private ranges
"10.0.0.0/8",
"172.16.0.0/12",
"192.168.0.0/16",
// IPv4 link-local (APIPA, also used by AWS instance metadata 169.254.169.254)
"169.254.0.0/16",
// IPv4 shared address space (RFC6598, carrier-grade NAT)
"100.64.0.0/10",
// IPv4 multicast
"224.0.0.0/4",
// IPv4 reserved / broadcast
"240.0.0.0/4",
// IPv6 loopback
"::1/128",
// IPv6 unspecified
"::/128",
// IPv6 link-local
"fe80::/10",
// IPv6 unique local (ULA) — RFC4193
"fc00::/7",
// IPv6 multicast
"ff00::/8",
}
// blockedCIDRs is the parsed form of blockedCIDRStrings.
// Any entry that fails to parse is recorded in blockedCIDRParseErrors instead
// of panicking; tests verify this slice is always empty via TestBlockedCIDRsValid.
var (
blockedCIDRs []*net.IPNet
blockedCIDRParseErrors []string
)
func init() {
blockedCIDRs = make([]*net.IPNet, 0, len(blockedCIDRStrings))
for _, r := range blockedCIDRStrings {
_, cidr, err := net.ParseCIDR(r)
if err != nil {
// Record the error rather than panicking; TestBlockedCIDRsValid
// will catch this during tests, and the CI build will fail.
blockedCIDRParseErrors = append(blockedCIDRParseErrors,
fmt.Sprintf("ipcheck: invalid built-in CIDR %q: %v", r, err))
continue
}
blockedCIDRs = append(blockedCIDRs, cidr)
}
}
// IsBlockedIP reports whether ip is in a blocked address range.
// It is exported for use by the validate-url subcommand and tests outside
// this package.
//
// IPv6-mapped IPv4 addresses (e.g. ::ffff:192.168.1.1) are normalized to their
// IPv4 form before checking so that IPv4 CIDRs catch them.
//
// Based on:
// - RFC1918 private ranges
// - RFC5735 / RFC4193 special-use IPv4/IPv6 ranges
// - RFC4291 IPv6 link-local / loopback
func IsBlockedIP(ip net.IP) bool {
// Normalize IPv6-mapped IPv4 addresses (::ffff:x.x.x.x) to plain IPv4.
if v4 := ip.To4(); v4 != nil {
ip = v4
}
for _, cidr := range blockedCIDRs {
if cidr.Contains(ip) {
return true
}
}
return false
}
+132 -25
View File
@@ -3,35 +3,142 @@ package gitea
import (
"net"
"testing"
"gitea.weiker.me/rodin/review-bot/internal/netutil"
)
// TestIsBlockedIPForwarding verifies that gitea.IsBlockedIP correctly forwards
// to internal/netutil.IsBlockedIP. Full coverage of the blocking logic lives in
// internal/netutil/ipcheck_test.go.
func TestIsBlockedIPForwarding(t *testing.T) {
cases := []struct {
ip string
blocked bool
func TestIsBlockedIP(t *testing.T) {
blocked := []struct {
name string
ip string
}{
{"127.0.0.1", true}, // loopback — must be blocked
{"192.168.1.1", true}, // RFC1918 — must be blocked
{"8.8.8.8", false}, // public — must not be blocked
{"2001:4860:4860::8888", false}, // public IPv6 — must not be blocked
// IPv4 loopback
{"loopback 127.0.0.1", "127.0.0.1"},
{"loopback 127.0.0.2", "127.0.0.2"},
{"loopback 127.255.255.255", "127.255.255.255"},
// IPv4 unspecified
{"unspecified 0.0.0.0", "0.0.0.0"},
{"unspecified 0.1.2.3", "0.1.2.3"},
// RFC1918
{"RFC1918 10.0.0.1", "10.0.0.1"},
{"RFC1918 10.255.255.255", "10.255.255.255"},
{"RFC1918 172.16.0.1", "172.16.0.1"},
{"RFC1918 172.31.255.255", "172.31.255.255"},
{"RFC1918 192.168.0.1", "192.168.0.1"},
{"RFC1918 192.168.255.255", "192.168.255.255"},
// Link-local (APIPA / AWS metadata)
{"link-local 169.254.0.1", "169.254.0.1"},
{"link-local 169.254.169.254", "169.254.169.254"},
// Shared address space (carrier-grade NAT)
{"CGN 100.64.0.1", "100.64.0.1"},
{"CGN 100.127.255.255", "100.127.255.255"},
// Multicast
{"multicast 224.0.0.1", "224.0.0.1"},
{"multicast 239.255.255.255", "239.255.255.255"},
// Reserved
{"reserved 240.0.0.1", "240.0.0.1"},
{"broadcast 255.255.255.255", "255.255.255.255"},
// IPv6 loopback
{"IPv6 loopback ::1", "::1"},
// IPv6 unspecified
{"IPv6 unspecified ::", "::"},
// IPv6 link-local
{"IPv6 link-local fe80::1", "fe80::1"},
{"IPv6 link-local fe80::dead:beef", "fe80::dead:beef"},
// IPv6 ULA
{"IPv6 ULA fc00::1", "fc00::1"},
{"IPv6 ULA fd00::1", "fd00::1"},
// IPv6 multicast
{"IPv6 multicast ff02::1", "ff02::1"},
}
for _, tc := range cases {
ip := net.ParseIP(tc.ip)
if ip == nil {
t.Fatalf("failed to parse IP %q", tc.ip)
}
got := IsBlockedIP(ip)
want := netutil.IsBlockedIP(ip)
if got != want {
t.Errorf("gitea.IsBlockedIP(%q) = %v, netutil.IsBlockedIP = %v: forwarding mismatch", tc.ip, got, want)
}
if got != tc.blocked {
t.Errorf("gitea.IsBlockedIP(%q) = %v, want %v", tc.ip, got, tc.blocked)
for _, tc := range blocked {
t.Run(tc.name, func(t *testing.T) {
ip := net.ParseIP(tc.ip)
if ip == nil {
t.Fatalf("failed to parse IP %q", tc.ip)
}
if !IsBlockedIP(ip) {
t.Errorf("IsBlockedIP(%q) = false, want true", tc.ip)
}
})
}
allowed := []struct {
name string
ip string
}{
{"public 8.8.8.8", "8.8.8.8"},
{"public 1.1.1.1", "1.1.1.1"},
{"public 198.51.100.1", "198.51.100.1"}, // RFC5737 TEST-NET-2 — a documentation-only range;
// not assigned to any real host, but intentionally left unblocked here because
// it has no special routing treatment (unlike RFC1918/loopback/link-local) and
// blocking it would require tracking every RFC5737 range without meaningful
// security benefit (no server should ever listen on a TEST-NET address).
{"public 151.101.1.1", "151.101.1.1"}, // Fastly
{"public IPv6 2001:4860:4860::8888", "2001:4860:4860::8888"}, // Google DNS
{"public IPv6 2606:4700:4700::1111", "2606:4700:4700::1111"}, // Cloudflare DNS
}
for _, tc := range allowed {
t.Run(tc.name, func(t *testing.T) {
ip := net.ParseIP(tc.ip)
if ip == nil {
t.Fatalf("failed to parse IP %q", tc.ip)
}
if IsBlockedIP(ip) {
t.Errorf("IsBlockedIP(%q) = true, want false", tc.ip)
}
})
}
}
func TestIsBlockedIPv6MappedIPv4(t *testing.T) {
// ::ffff:192.168.1.1 is an IPv6-mapped IPv4 address — should be blocked as RFC1918.
// Construct it manually as a 16-byte IP.
mapped := net.IP{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xff, 0xff, 192, 168, 1, 1}
if !IsBlockedIP(mapped) {
t.Errorf("IsBlockedIP(::ffff:192.168.1.1) = false, want true (IPv6-mapped IPv4 must be normalized)")
}
// ::ffff:8.8.8.8 — IPv6-mapped public IP — should be allowed.
mappedPublic := net.IP{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xff, 0xff, 8, 8, 8, 8}
if IsBlockedIP(mappedPublic) {
t.Errorf("IsBlockedIP(::ffff:8.8.8.8) = true, want false")
}
}
func TestIsBlockedIPEdgeCases(t *testing.T) {
// The boundary between RFC1918 and public ranges.
// 172.15.255.255 is NOT private (just below 172.16.0.0/12).
notPrivate := net.ParseIP("172.15.255.255")
if IsBlockedIP(notPrivate) {
t.Errorf("IsBlockedIP(172.15.255.255) = true, want false (outside 172.16.0.0/12)")
}
// 172.32.0.0 is NOT private (just above 172.31.255.255).
notPrivate2 := net.ParseIP("172.32.0.0")
if IsBlockedIP(notPrivate2) {
t.Errorf("IsBlockedIP(172.32.0.0) = true, want false (outside 172.16.0.0/12)")
}
// CGN: 100.63.255.255 is NOT in 100.64.0.0/10.
notCGN := net.ParseIP("100.63.255.255")
if IsBlockedIP(notCGN) {
t.Errorf("IsBlockedIP(100.63.255.255) = true, want false (outside 100.64.0.0/10)")
}
// CGN: 100.128.0.0 is NOT in 100.64.0.0/10.
notCGN2 := net.ParseIP("100.128.0.0")
if IsBlockedIP(notCGN2) {
t.Errorf("IsBlockedIP(100.128.0.0) = true, want false (outside 100.64.0.0/10)")
}
}
// TestBlockedCIDRsValid verifies that all entries in blockedCIDRStrings parse
// successfully. This catches programming errors in the CIDR list without
// requiring a startup panic. The init() function records parse failures in
// blockedCIDRParseErrors rather than panicking; this test makes those failures
// visible as test failures during CI.
func TestBlockedCIDRsValid(t *testing.T) {
if len(blockedCIDRParseErrors) > 0 {
for _, msg := range blockedCIDRParseErrors {
t.Errorf("CIDR parse error: %s", msg)
}
}
}
-97
View File
@@ -1,97 +0,0 @@
// Package netutil provides shared network utilities for review-bot.
// ipcheck.go implements IP-level SSRF protection by checking resolved addresses
// against known blocked CIDR ranges (RFC1918, loopback, link-local, etc.).
package netutil
import (
"fmt"
"net"
)
// blockedCIDRStrings is the canonical list of CIDR strings that should never
// be contacted by review-bot. See IsBlockedIP for the full list of covered
// address families.
//
// These are hard-coded literals: any parse failure is a programming error.
// Validity is verified by TestBlockedCIDRsValid in ipcheck_test.go.
var blockedCIDRStrings = []string{
// IPv4 loopback
"127.0.0.0/8",
// IPv4 unspecified / "this network"
"0.0.0.0/8",
// RFC1918 private ranges
"10.0.0.0/8",
"172.16.0.0/12",
"192.168.0.0/16",
// IPv4 link-local (APIPA, also used by AWS instance metadata 169.254.169.254)
"169.254.0.0/16",
// IPv4 shared address space (RFC6598, carrier-grade NAT)
"100.64.0.0/10",
// IPv4 multicast
"224.0.0.0/4",
// IPv4 reserved / broadcast
"240.0.0.0/4",
// IPv6 loopback
"::1/128",
// IPv6 unspecified
"::/128",
// IPv6 link-local
"fe80::/10",
// IPv6 unique local (ULA) — RFC4193
"fc00::/7",
// IPv6 multicast
"ff00::/8",
}
// blockedCIDRs is the parsed form of blockedCIDRStrings.
// Any entry that fails to parse is recorded in blockedCIDRParseErrors instead
// of panicking; tests verify this slice is always empty via TestBlockedCIDRsValid.
var (
blockedCIDRs []*net.IPNet
blockedCIDRParseErrors []string
)
func init() {
blockedCIDRs = make([]*net.IPNet, 0, len(blockedCIDRStrings))
for _, r := range blockedCIDRStrings {
_, cidr, err := net.ParseCIDR(r)
if err != nil {
// Record the error rather than panicking; TestBlockedCIDRsValid
// will catch this during tests, and the CI build will fail.
blockedCIDRParseErrors = append(blockedCIDRParseErrors,
fmt.Sprintf("ipcheck: invalid built-in CIDR %q: %v", r, err))
continue
}
blockedCIDRs = append(blockedCIDRs, cidr)
}
}
// BlockedCIDRParseErrors returns any errors encountered parsing the built-in
// CIDR list. In correct code this will always be empty; tests assert it is.
func BlockedCIDRParseErrors() []string {
return blockedCIDRParseErrors
}
// IsBlockedIP reports whether ip is in a blocked address range.
// It is exported for use by the gitea package's safe dialer, the validate-url
// subcommand, and tests outside this package.
//
// IPv6-mapped IPv4 addresses (e.g. ::ffff:192.168.1.1) are normalized to their
// IPv4 form before checking so that IPv4 CIDRs catch them.
//
// Based on:
// - RFC1918 private ranges
// - RFC5735 / RFC4193 special-use IPv4/IPv6 ranges
// - RFC4291 IPv6 link-local / loopback
func IsBlockedIP(ip net.IP) bool {
// Normalize IPv6-mapped IPv4 addresses (::ffff:x.x.x.x) to plain IPv4.
if v4 := ip.To4(); v4 != nil {
ip = v4
}
for _, cidr := range blockedCIDRs {
if cidr.Contains(ip) {
return true
}
}
return false
}
-142
View File
@@ -1,142 +0,0 @@
package netutil
import (
"net"
"testing"
)
func TestIsBlockedIP(t *testing.T) {
blocked := []struct {
name string
ip string
}{
// IPv4 loopback
{"loopback 127.0.0.1", "127.0.0.1"},
{"loopback 127.0.0.2", "127.0.0.2"},
{"loopback 127.255.255.255", "127.255.255.255"},
// IPv4 unspecified
{"unspecified 0.0.0.0", "0.0.0.0"},
{"unspecified 0.1.2.3", "0.1.2.3"},
// RFC1918
{"RFC1918 10.0.0.1", "10.0.0.1"},
{"RFC1918 10.255.255.255", "10.255.255.255"},
{"RFC1918 172.16.0.1", "172.16.0.1"},
{"RFC1918 172.31.255.255", "172.31.255.255"},
{"RFC1918 192.168.0.1", "192.168.0.1"},
{"RFC1918 192.168.255.255", "192.168.255.255"},
// Link-local (APIPA / AWS metadata)
{"link-local 169.254.0.1", "169.254.0.1"},
{"link-local 169.254.169.254", "169.254.169.254"},
// Shared address space (carrier-grade NAT)
{"CGN 100.64.0.1", "100.64.0.1"},
{"CGN 100.127.255.255", "100.127.255.255"},
// Multicast
{"multicast 224.0.0.1", "224.0.0.1"},
{"multicast 239.255.255.255", "239.255.255.255"},
// Reserved
{"reserved 240.0.0.1", "240.0.0.1"},
{"broadcast 255.255.255.255", "255.255.255.255"},
// IPv6 loopback
{"IPv6 loopback ::1", "::1"},
// IPv6 unspecified
{"IPv6 unspecified ::", "::"},
// IPv6 link-local
{"IPv6 link-local fe80::1", "fe80::1"},
{"IPv6 link-local fe80::dead:beef", "fe80::dead:beef"},
// IPv6 ULA
{"IPv6 ULA fc00::1", "fc00::1"},
{"IPv6 ULA fd00::1", "fd00::1"},
// IPv6 multicast
{"IPv6 multicast ff02::1", "ff02::1"},
}
for _, tc := range blocked {
t.Run(tc.name, func(t *testing.T) {
ip := net.ParseIP(tc.ip)
if ip == nil {
t.Fatalf("failed to parse IP %q", tc.ip)
}
if !IsBlockedIP(ip) {
t.Errorf("IsBlockedIP(%q) = false, want true", tc.ip)
}
})
}
allowed := []struct {
name string
ip string
}{
{"public 8.8.8.8", "8.8.8.8"},
{"public 1.1.1.1", "1.1.1.1"},
{"public 198.51.100.1", "198.51.100.1"}, // RFC5737 TEST-NET-2 — a documentation-only range;
// not assigned to any real host, but intentionally left unblocked here because
// it has no special routing treatment (unlike RFC1918/loopback/link-local) and
// blocking it would require tracking every RFC5737 range without meaningful
// security benefit (no server should ever listen on a TEST-NET address).
{"public 151.101.1.1", "151.101.1.1"}, // Fastly
{"public IPv6 2001:4860:4860::8888", "2001:4860:4860::8888"}, // Google DNS
{"public IPv6 2606:4700:4700::1111", "2606:4700:4700::1111"}, // Cloudflare DNS
}
for _, tc := range allowed {
t.Run(tc.name, func(t *testing.T) {
ip := net.ParseIP(tc.ip)
if ip == nil {
t.Fatalf("failed to parse IP %q", tc.ip)
}
if IsBlockedIP(ip) {
t.Errorf("IsBlockedIP(%q) = true, want false", tc.ip)
}
})
}
}
func TestIsBlockedIPv6MappedIPv4(t *testing.T) {
// ::ffff:192.168.1.1 is an IPv6-mapped IPv4 address — should be blocked as RFC1918.
// Construct it manually as a 16-byte IP.
mapped := net.IP{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xff, 0xff, 192, 168, 1, 1}
if !IsBlockedIP(mapped) {
t.Errorf("IsBlockedIP(::ffff:192.168.1.1) = false, want true (IPv6-mapped IPv4 must be normalized)")
}
// ::ffff:8.8.8.8 — IPv6-mapped public IP — should be allowed.
mappedPublic := net.IP{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xff, 0xff, 8, 8, 8, 8}
if IsBlockedIP(mappedPublic) {
t.Errorf("IsBlockedIP(::ffff:8.8.8.8) = true, want false")
}
}
func TestIsBlockedIPEdgeCases(t *testing.T) {
// The boundary between RFC1918 and public ranges.
// 172.15.255.255 is NOT private (just below 172.16.0.0/12).
notPrivate := net.ParseIP("172.15.255.255")
if IsBlockedIP(notPrivate) {
t.Errorf("IsBlockedIP(172.15.255.255) = true, want false (outside 172.16.0.0/12)")
}
// 172.32.0.0 is NOT private (just above 172.31.255.255).
notPrivate2 := net.ParseIP("172.32.0.0")
if IsBlockedIP(notPrivate2) {
t.Errorf("IsBlockedIP(172.32.0.0) = true, want false (outside 172.16.0.0/12)")
}
// CGN: 100.63.255.255 is NOT in 100.64.0.0/10.
notCGN := net.ParseIP("100.63.255.255")
if IsBlockedIP(notCGN) {
t.Errorf("IsBlockedIP(100.63.255.255) = true, want false (outside 100.64.0.0/10)")
}
// CGN: 100.128.0.0 is NOT in 100.64.0.0/10.
notCGN2 := net.ParseIP("100.128.0.0")
if IsBlockedIP(notCGN2) {
t.Errorf("IsBlockedIP(100.128.0.0) = true, want false (outside 100.64.0.0/10)")
}
}
// TestBlockedCIDRsValid verifies that all entries in blockedCIDRStrings parse
// successfully. This catches programming errors in the CIDR list without
// requiring a startup panic. The init() function records parse failures in
// blockedCIDRParseErrors rather than panicking; this test makes those failures
// visible as test failures during CI.
func TestBlockedCIDRsValid(t *testing.T) {
for _, msg := range BlockedCIDRParseErrors() {
t.Errorf("CIDR parse error: %s", msg)
}
}