Compare commits
77 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
eb6cf7f380 | ||
|
|
4331c798d9 | ||
|
|
c55932c41a | ||
|
|
eb16452d8b | ||
|
|
7ab2ce2617 | ||
|
|
34dc485387 | ||
|
|
43b8f75380 | ||
|
|
257c9504e7 | ||
|
|
249779f09d | ||
|
|
ade66af7da | ||
|
|
5b54b6582c | ||
|
|
14b1f7e9bc | ||
|
|
0196385345 | ||
|
|
8c24016b39 | ||
|
|
3a73acfe6f | ||
|
|
70275b068d | ||
|
|
343819a0d8 | ||
|
|
5f07e4a21a | ||
|
|
cc9e4a6c28 | ||
|
|
09266a281f | ||
|
|
018942e121 | ||
|
|
9e8674e0d7 | ||
|
|
bfb064cde5 | ||
|
|
0783ce3f57 | ||
|
|
4b49ec5f2b | ||
|
|
7da24a2ffb | ||
|
|
9ad3afbd22 | ||
|
|
b47541e493 | ||
|
|
f53119116f | ||
|
|
5bc387b1dc | ||
|
|
9088a38b05 | ||
|
|
a54bcb1151 | ||
|
|
4093e76fcf | ||
|
|
b8c0163a3c | ||
|
|
0c847b8d8e | ||
|
|
25082778c9 | ||
|
|
0003b6ac7f | ||
|
|
4e9d6825a6 | ||
|
|
ba8380ee3a | ||
|
|
8752173a95 | ||
|
|
8abe689e74 | ||
|
|
33efc29d9b | ||
|
|
7dd0d94169 | ||
|
|
474207bdce | ||
|
|
bfa9367505 | ||
|
|
a731d2f665 | ||
|
|
d9571e421e | ||
|
|
effed44ce8 | ||
|
|
8e09efe548 | ||
|
|
1beac7b87e | ||
|
|
67f2f27cf8 | ||
|
|
7ca5a11572 | ||
|
|
a753211528 | ||
|
|
7a0fb23a46 | ||
|
|
03dadf6dcd | ||
|
|
5d81e44ba1 | ||
|
|
8cdd29b047 | ||
|
|
644f3fa564 | ||
|
|
77fe3cdf02 | ||
|
|
79eeaebdd8 | ||
|
|
956d0d44c3 | ||
|
|
8294d6ee49 | ||
|
|
65d837a13f | ||
|
|
b4dd1efe3c | ||
|
|
462e40629a | ||
|
|
34a8fbd97a | ||
|
|
8687a05ec0 | ||
|
|
97c2ef9b71 | ||
|
|
28ad90d962 | ||
|
|
cf912f15eb | ||
|
|
e299aa6b52 | ||
|
|
f92e85804f | ||
|
|
85ccec65b4 | ||
|
|
580ea96228 | ||
|
|
f84b77a2a7 | ||
|
|
5d49bac2b0 | ||
|
|
ca4cfc4e65 |
@@ -5,6 +5,7 @@ trigger: always_on
|
||||
# Charon Instructions
|
||||
|
||||
## Code Quality Guidelines
|
||||
|
||||
Every session should improve the codebase, not just add to it. Actively refactor code you encounter, even outside of your immediate task scope. Think about long-term maintainability and consistency. Make a detailed plan before writing code. Always create unit tests for new code coverage.
|
||||
|
||||
- **DRY**: Consolidate duplicate patterns into reusable functions, types, or components after the second occurrence.
|
||||
@@ -14,11 +15,13 @@ Every session should improve the codebase, not just add to it. Actively refactor
|
||||
- **CONVENTIONAL COMMITS**: Write commit messages using `feat:`, `fix:`, `chore:`, `refactor:`, or `docs:` prefixes.
|
||||
|
||||
## 🚨 CRITICAL ARCHITECTURE RULES 🚨
|
||||
|
||||
- **Single Frontend Source**: All frontend code MUST reside in `frontend/`. NEVER create `backend/frontend/` or any other nested frontend directory.
|
||||
- **Single Backend Source**: All backend code MUST reside in `backend/`.
|
||||
- **No Python**: This is a Go (Backend) + React/TypeScript (Frontend) project. Do not introduce Python scripts or requirements.
|
||||
|
||||
## Big Picture
|
||||
|
||||
- Charon is a self-hosted web app for managing reverse proxy host configurations with the novice user in mind. Everything should prioritize simplicity, usability, reliability, and security, all rolled into one simple binary + static assets deployment. No external dependencies.
|
||||
- Users should feel like they have enterprise-level security and features with zero effort.
|
||||
- `backend/cmd/api` loads config, opens SQLite, then hands off to `internal/server`.
|
||||
@@ -27,6 +30,7 @@ Every session should improve the codebase, not just add to it. Actively refactor
|
||||
- Persistent types live in `internal/models`; GORM auto-migrates them.
|
||||
|
||||
## Backend Workflow
|
||||
|
||||
- **Run**: `cd backend && go run ./cmd/api`.
|
||||
- **Test**: `go test ./...`.
|
||||
- **API Response**: Handlers return structured errors using `gin.H{"error": "message"}`.
|
||||
@@ -36,6 +40,7 @@ Every session should improve the codebase, not just add to it. Actively refactor
|
||||
- **Graceful Shutdown**: Long-running work must respect `server.Run(ctx)`.
|
||||
|
||||
## Frontend Workflow
|
||||
|
||||
- **Location**: Always work within `frontend/`.
|
||||
- **Stack**: React 18 + Vite + TypeScript + TanStack Query (React Query).
|
||||
- **State Management**: Use `src/hooks/use*.ts` wrapping React Query.
|
||||
@@ -43,6 +48,7 @@ Every session should improve the codebase, not just add to it. Actively refactor
|
||||
- **Forms**: Use local `useState` for form fields, submit via `useMutation`, then `invalidateQueries` on success.
|
||||
|
||||
## Cross-Cutting Notes
|
||||
|
||||
- **VS Code Integration**: If you introduce new repetitive CLI actions (e.g., scans, builds, scripts), register them in .vscode/tasks.json to allow for easy manual verification.
|
||||
- **Sync**: React Query expects the exact JSON produced by GORM tags (snake_case). Keep API and UI field names aligned.
|
||||
- **Migrations**: When adding models, update `internal/models` AND `internal/api/routes/routes.go` (AutoMigrate).
|
||||
@@ -50,18 +56,22 @@ Every session should improve the codebase, not just add to it. Actively refactor
|
||||
- **Ignore Files**: Always check `.gitignore`, `.dockerignore`, and `.codecov.yml` when adding new file or folders.
|
||||
|
||||
## Documentation
|
||||
|
||||
- **Features**: Update `docs/features.md` when adding capabilities.
|
||||
- **Links**: Use GitHub Pages URLs (`https://wikid82.github.io/charon/`) for docs and GitHub blob links for repo files.
|
||||
|
||||
## CI/CD & Commit Conventions
|
||||
|
||||
- **Triggers**: Use `feat:`, `fix:`, or `perf:` to trigger Docker builds. `chore:` skips builds.
|
||||
- **Beta**: `feature/beta-release` always builds.
|
||||
|
||||
## ✅ Task Completion Protocol (Definition of Done)
|
||||
|
||||
Before marking an implementation task as complete, perform the following:
|
||||
1. **Pre-Commit Triage**: Run `pre-commit run --all-files`.
|
||||
- If errors occur, **fix them immediately**.
|
||||
- If logic errors occur, analyze and propose a fix.
|
||||
- Do not output code that violates pre-commit standards.
|
||||
2. **Verify Build**: Ensure the backend compiles and the frontend builds without errors.
|
||||
3. **Clean Up**: Ensure no debug print statements or commented-out blocks remain.
|
||||
|
||||
1. **Pre-Commit Triage**: Run `pre-commit run --all-files`.
|
||||
- If errors occur, **fix them immediately**.
|
||||
- If logic errors occur, analyze and propose a fix.
|
||||
- Do not output code that violates pre-commit standards.
|
||||
2. **Verify Build**: Ensure the backend compiles and the frontend builds without errors.
|
||||
3. **Clean Up**: Ensure no debug print statements or commented-out blocks remain.
|
||||
|
||||
@@ -55,7 +55,6 @@ ignore:
|
||||
|
||||
# Backend non-source files
|
||||
- "backend/cmd/seed/**"
|
||||
- "backend/cmd/api/**"
|
||||
- "backend/data/**"
|
||||
- "backend/coverage/**"
|
||||
- "backend/bin/**"
|
||||
@@ -89,3 +88,6 @@ ignore:
|
||||
- "import/**"
|
||||
- "data/**"
|
||||
- ".cache/**"
|
||||
|
||||
# CrowdSec config files (no logic to test)
|
||||
- "configs/crowdsec/**"
|
||||
|
||||
@@ -39,6 +39,9 @@ frontend/node_modules/
|
||||
frontend/coverage/
|
||||
frontend/test-results/
|
||||
frontend/dist/
|
||||
frontend/.cache
|
||||
frontend/.eslintcache
|
||||
data/geoip
|
||||
frontend/.vite/
|
||||
frontend/*.tsbuildinfo
|
||||
frontend/frontend/
|
||||
|
||||
22
.github/FUNDING.yml
vendored
22
.github/FUNDING.yml
vendored
@@ -1,14 +1,14 @@
|
||||
# These are supported funding model platforms
|
||||
github: Wikid82
|
||||
patreon: # Replace with a single Patreon username
|
||||
open_collective: # Replace with a single Open Collective username
|
||||
ko_fi: # Replace with a single Ko-fi username
|
||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||
liberapay: # Replace with a single Liberapay username
|
||||
issuehunt: # Replace with a single IssueHunt username
|
||||
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
|
||||
polar: # Replace with a single Polar username
|
||||
# patreon: # Replace with a single Patreon username
|
||||
# open_collective: # Replace with a single Open Collective username
|
||||
# ko_fi: # Replace with a single Ko-fi username
|
||||
# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||
# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||
# liberapay: # Replace with a single Liberapay username
|
||||
# issuehunt: # Replace with a single IssueHunt username
|
||||
# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
|
||||
# polar: # Replace with a single Polar username
|
||||
buy_me_a_coffee: Wikid82
|
||||
thanks_dev: # Replace with a single thanks.dev username
|
||||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
||||
# thanks_dev: # Replace with a single thanks.dev username
|
||||
# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
||||
|
||||
17
.github/ISSUE_TEMPLATE/bug_report.md
vendored
17
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -12,6 +12,7 @@ A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
@@ -24,15 +25,17 @@ A clear and concise description of what you expected to happen.
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
<!-- PR: History Rewrite & Large-file Removal -->
|
||||
|
||||
## Summary
|
||||
|
||||
- Provide a short summary of why the history rewrite is needed.
|
||||
|
||||
## Checklist - required for history rewrite PRs
|
||||
|
||||
- [ ] I have created a **local** backup branch: `backup/history-YYYYMMDD-HHMMSS` and verified it contains all refs.
|
||||
- [ ] I have pushed the backup branch to the remote origin and it is visible to reviewers.
|
||||
- [ ] I have run a dry-run locally: `scripts/history-rewrite/preview_removals.sh --paths 'backend/codeql-db,codeql-db,codeql-db-js,codeql-db-go' --strip-size 50` and attached the output or paste it below.
|
||||
@@ -17,11 +19,14 @@
|
||||
**Note for maintainers**: `validate_after_rewrite.sh` will check that the `backups` and `backup_branch` are present and will fail if they are not. Provide `--backup-branch "backup/history-YYYYMMDD-HHMMSS"` when running the scripts or set the `BACKUP_BRANCH` environment variable so automated validation can find the backup branch.
|
||||
|
||||
## Attachments
|
||||
|
||||
Attach the `preview_removals` output and `data/backups/history_cleanup-*.log` content and any `data/backups` tarball created for this PR.
|
||||
|
||||
## Approach
|
||||
|
||||
Describe the paths to be removed, strip size, and whether additional blob stripping is required.
|
||||
|
||||
# Notes for maintainers
|
||||
|
||||
- The workflow `.github/workflows/dry-run-history-rewrite.yml` will run automatically on PR updates.
|
||||
- Please follow the checklist and only approve after offline confirmation.
|
||||
|
||||
40
.github/agents/Backend_Dev.agent.md
vendored
40
.github/agents/Backend_Dev.agent.md
vendored
@@ -1,7 +1,9 @@
|
||||
name: Backend Dev
|
||||
description: Senior Go Engineer focused on high-performance, secure backend implementation.
|
||||
argument-hint: The specific backend task from the Plan (e.g., "Implement ProxyHost CRUD endpoints")
|
||||
|
||||
# ADDED 'list_dir' below so Step 1 works
|
||||
|
||||
tools: ['search', 'runSubagent', 'read_file', 'write_file', 'run_terminal_command', 'usages', 'changes', 'list_dir']
|
||||
|
||||
---
|
||||
@@ -22,26 +24,26 @@ Your priority is writing code that is clean, tested, and secure by default.
|
||||
- **CRITICAL**: If found, treat that JSON as the **Immutable Truth**. Do not rename fields.
|
||||
- **Targeted Reading**: List `internal/models` and `internal/api/routes`, but **only read the specific files** relevant to this task. Do not read the entire directory.
|
||||
|
||||
2. **Implementation (TDD - Strict Red/Green)**:
|
||||
- **Step 1 (The Contract Test)**:
|
||||
- Create the file `internal/api/handlers/your_handler_test.go` FIRST.
|
||||
- Write a test case that asserts the **Handoff Contract** (JSON structure).
|
||||
- **Run the test**: It MUST fail (compilation error or logic fail). Output "Test Failed as Expected".
|
||||
- **Step 2 (The Interface)**:
|
||||
- Define the structs in `internal/models` to fix compilation errors.
|
||||
- **Step 3 (The Logic)**:
|
||||
- Implement the handler in `internal/api/handlers`.
|
||||
- **Step 4 (The Green Light)**:
|
||||
- Run `go test ./...`.
|
||||
- **CRITICAL**: If it fails, fix the *Code*, NOT the *Test* (unless the test was wrong about the contract).
|
||||
2. **Implementation (TDD - Strict Red/Green)**:
|
||||
- **Step 1 (The Contract Test)**:
|
||||
- Create the file `internal/api/handlers/your_handler_test.go` FIRST.
|
||||
- Write a test case that asserts the **Handoff Contract** (JSON structure).
|
||||
- **Run the test**: It MUST fail (compilation error or logic fail). Output "Test Failed as Expected".
|
||||
- **Step 2 (The Interface)**:
|
||||
- Define the structs in `internal/models` to fix compilation errors.
|
||||
- **Step 3 (The Logic)**:
|
||||
- Implement the handler in `internal/api/handlers`.
|
||||
- **Step 4 (The Green Light)**:
|
||||
- Run `go test ./...`.
|
||||
- **CRITICAL**: If it fails, fix the *Code*, NOT the *Test* (unless the test was wrong about the contract).
|
||||
|
||||
3. **Verification (Definition of Done)**:
|
||||
- Run `go mod tidy`.
|
||||
- Run `go fmt ./...`.
|
||||
- Run `go test ./...` to ensure no regressions.
|
||||
- **Coverage**: Run the coverage script.
|
||||
- *Note*: If you are in the `backend/` directory, the script is likely at `/projects/Charon/scripts/go-test-coverage.sh`. Verify location before running.
|
||||
- Ensure coverage goals are met as well as all tests pass. Just because Tests pass does not mean you are done. Goal Coverage Needs to be met even if the tests to get us there are outside the scope of your task. At this point, your task is to maintain coverage goal and all tests pass because we cannot commit changes if they fail.
|
||||
3. **Verification (Definition of Done)**:
|
||||
- Run `go mod tidy`.
|
||||
- Run `go fmt ./...`.
|
||||
- Run `go test ./...` to ensure no regressions.
|
||||
- **Coverage**: Run the coverage script.
|
||||
- *Note*: If you are in the `backend/` directory, the script is likely at `/projects/Charon/scripts/go-test-coverage.sh`. Verify location before running.
|
||||
- Ensure coverage goals are met as well as all tests pass. Just because Tests pass does not mean you are done. Goal Coverage Needs to be met even if the tests to get us there are outside the scope of your task. At this point, your task is to maintain coverage goal and all tests pass because we cannot commit changes if they fail.
|
||||
</workflow>
|
||||
|
||||
<constraints>
|
||||
|
||||
29
.github/agents/DevOps.agent.md
vendored
29
.github/agents/DevOps.agent.md
vendored
@@ -20,31 +20,34 @@ You do not guess why a build failed. You interrogate the server to find the exac
|
||||
- **Fetch Failure Logs**: Run `gh run view <run-id> --log-failed`.
|
||||
- **Locate Artifact**: If the log mentions a specific file (e.g., `backend/handlers/proxy.go:45`), note it down.
|
||||
|
||||
2. **Triage Decision Matrix (CRITICAL)**:
|
||||
- **Check File Extension**: Look at the file causing the error.
|
||||
- Is it `.yml`, `.yaml`, `.Dockerfile`, `.sh`? -> **Case A (Infrastructure)**.
|
||||
- Is it `.go`, `.ts`, `.tsx`, `.js`, `.json`? -> **Case B (Application)**.
|
||||
2. **Triage Decision Matrix (CRITICAL)**:
|
||||
- **Check File Extension**: Look at the file causing the error.
|
||||
- Is it `.yml`, `.yaml`, `.Dockerfile`, `.sh`? -> **Case A (Infrastructure)**.
|
||||
- Is it `.go`, `.ts`, `.tsx`, `.js`, `.json`? -> **Case B (Application)**.
|
||||
|
||||
- **Case A: Infrastructure Failure**:
|
||||
- **Action**: YOU fix this. Edit the workflow or Dockerfile directly.
|
||||
- **Verify**: Commit, push, and watch the run.
|
||||
- **Case A: Infrastructure Failure**:
|
||||
- **Action**: YOU fix this. Edit the workflow or Dockerfile directly.
|
||||
- **Verify**: Commit, push, and watch the run.
|
||||
|
||||
- **Case B: Application Failure**:
|
||||
- **Action**: STOP. You are strictly forbidden from editing application code.
|
||||
- **Output**: Generate a **Bug Report** using the format below.
|
||||
- **Case B: Application Failure**:
|
||||
- **Action**: STOP. You are strictly forbidden from editing application code.
|
||||
- **Output**: Generate a **Bug Report** using the format below.
|
||||
|
||||
3. **Remediation (If Case A)**:
|
||||
- Edit the `.github/workflows/*.yml` or `Dockerfile`.
|
||||
- Commit and push.
|
||||
3. **Remediation (If Case A)**:
|
||||
- Edit the `.github/workflows/*.yml` or `Dockerfile`.
|
||||
- Commit and push.
|
||||
|
||||
</workflow>
|
||||
|
||||
<output_format>
|
||||
(Only use this if handing off to a Developer Agent)
|
||||
|
||||
## 🐛 CI Failure Report
|
||||
|
||||
**Offending File**: `{path/to/file}`
|
||||
**Job Name**: `{name of failing job}`
|
||||
**Error Log**:
|
||||
|
||||
```text
|
||||
{paste the specific error lines here}
|
||||
```
|
||||
|
||||
18
.github/agents/Doc_Writer.agent.md
vendored
18
.github/agents/Doc_Writer.agent.md
vendored
@@ -14,13 +14,15 @@ Your goal is to translate "Engineer Speak" into simple, actionable instructions.
|
||||
</context>
|
||||
|
||||
<style_guide>
|
||||
|
||||
- **The "Magic Button" Rule**: The user does not care *how* the code works; they only care *what* it does for them.
|
||||
- *Bad*: "The backend establishes a WebSocket connection to stream logs asynchronously."
|
||||
- *Good*: "Click the 'Connect' button to see your logs appear instantly."
|
||||
- *Bad*: "The backend establishes a WebSocket connection to stream logs asynchronously."
|
||||
- *Good*: "Click the 'Connect' button to see your logs appear instantly."
|
||||
- **ELI5 (Explain Like I'm 5)**: Use simple words. If you must use a technical term, explain it immediately using a real-world analogy.
|
||||
- **Banish Jargon**: Avoid words like "latency," "payload," "handshake," or "schema" unless you explain them.
|
||||
- **Focus on Action**: Structure text as: "Do this -> Get that result."
|
||||
- **Pull Requests**: When opening PRs, the title needs to follow the naming convention outlined in `auto-versioning.md` to make sure new versions are generated correctly upon merge.
|
||||
- **History-Rewrite PRs**: If a PR touches files in `scripts/history-rewrite/` or `docs/plans/history_rewrite.md`, include the checklist from `.github/PULL_REQUEST_TEMPLATE/history-rewrite.md` in the PR description.
|
||||
</style_guide>
|
||||
|
||||
<workflow>
|
||||
@@ -28,13 +30,13 @@ Your goal is to translate "Engineer Speak" into simple, actionable instructions.
|
||||
- **Read the Plan**: Read `docs/plans/current_spec.md` to understand the feature.
|
||||
- **Ignore the Code**: Do not read the `.go` or `.tsx` files. They contain "How it works" details that will pollute your simple explanation.
|
||||
|
||||
2. **Drafting**:
|
||||
- **Update Feature List**: Add the new capability to `docs/features.md`.
|
||||
- **Tone Check**: Read your draft. Is it boring? Is it too long? If a non-technical relative couldn't understand it, rewrite it.
|
||||
2. **Drafting**:
|
||||
- **Update Feature List**: Add the new capability to `docs/features.md`.
|
||||
- **Tone Check**: Read your draft. Is it boring? Is it too long? If a non-technical relative couldn't understand it, rewrite it.
|
||||
|
||||
3. **Review**:
|
||||
- Ensure consistent capitalization of "Charon".
|
||||
- Check that links are valid.
|
||||
3. **Review**:
|
||||
- Ensure consistent capitalization of "Charon".
|
||||
- Check that links are valid.
|
||||
</workflow>
|
||||
|
||||
<constraints>
|
||||
|
||||
48
.github/agents/Frontend_Dev.agent.md
vendored
48
.github/agents/Frontend_Dev.agent.md
vendored
@@ -1,7 +1,9 @@
|
||||
name: Frontend Dev
|
||||
description: Senior React/UX Engineer focused on seamless user experiences and clean component architecture.
|
||||
argument-hint: The specific frontend task from the Plan (e.g., "Create Proxy Host Form")
|
||||
|
||||
# ADDED 'list_dir' below so Step 1 works
|
||||
|
||||
tools: ['search', 'runSubagent', 'read_file', 'write_file', 'run_terminal_command', 'usages', 'list_dir']
|
||||
|
||||
---
|
||||
@@ -24,30 +26,30 @@ You do not just "make it work"; you make it **feel** professional, responsive, a
|
||||
- Review `src/api/client.ts` to see available backend endpoints.
|
||||
- Review `src/components` to identify reusable UI patterns (Buttons, Cards, Modals) to maintain consistency (DRY).
|
||||
|
||||
2. **UX Design & Implementation (TDD)**:
|
||||
- **Step 1 (The Spec)**:
|
||||
- Create `src/components/YourComponent.test.tsx` FIRST.
|
||||
- Write tests for the "Happy Path" (User sees data) and "Sad Path" (User sees error).
|
||||
- *Note*: Use `screen.getByText` to assert what the user *should* see.
|
||||
- **Step 2 (The Hook)**:
|
||||
- Create the `useQuery` hook to fetch the data.
|
||||
- **Step 3 (The UI)**:
|
||||
- Build the component to satisfy the test.
|
||||
- Run `npm run test:ci`.
|
||||
- **Step 4 (Refine)**:
|
||||
- Style with Tailwind. Ensure tests still pass.
|
||||
2. **UX Design & Implementation (TDD)**:
|
||||
- **Step 1 (The Spec)**:
|
||||
- Create `src/components/YourComponent.test.tsx` FIRST.
|
||||
- Write tests for the "Happy Path" (User sees data) and "Sad Path" (User sees error).
|
||||
- *Note*: Use `screen.getByText` to assert what the user *should* see.
|
||||
- **Step 2 (The Hook)**:
|
||||
- Create the `useQuery` hook to fetch the data.
|
||||
- **Step 3 (The UI)**:
|
||||
- Build the component to satisfy the test.
|
||||
- Run `npm run test:ci`.
|
||||
- **Step 4 (Refine)**:
|
||||
- Style with Tailwind. Ensure tests still pass.
|
||||
|
||||
3. **Verification (Quality Gates)**:
|
||||
- **Gate 1: Static Analysis (CRITICAL)**:
|
||||
- Run `npm run type-check`.
|
||||
- Run `npm run lint`.
|
||||
- **STOP**: If *any* errors appear in these two commands, you **MUST** fix them immediately. Do not say "I'll leave this for later." **Fix the type errors, then re-run the check.**
|
||||
- **Gate 2: Logic**:
|
||||
- Run `npm run test:ci`.
|
||||
- **Gate 3: Coverage**:
|
||||
- Run `npm run check-coverage`.
|
||||
- Ensure the script executes successfully and coverage goals are met.
|
||||
- Ensure coverage goals are met as well as all tests pass. Just because Tests pass does not mean you are done. Goal Coverage Needs to be met even if the tests to get us there are outside the scope of your task. At this point, your task is to maintain coverage goal and all tests pass because we cannot commit changes if they fail.
|
||||
3. **Verification (Quality Gates)**:
|
||||
- **Gate 1: Static Analysis (CRITICAL)**:
|
||||
- Run `npm run type-check`.
|
||||
- Run `npm run lint`.
|
||||
- **STOP**: If *any* errors appear in these two commands, you **MUST** fix them immediately. Do not say "I'll leave this for later." **Fix the type errors, then re-run the check.**
|
||||
- **Gate 2: Logic**:
|
||||
- Run `npm run test:ci`.
|
||||
- **Gate 3: Coverage**:
|
||||
- Run `npm run check-coverage`.
|
||||
- Ensure the script executes successfully and coverage goals are met.
|
||||
- Ensure coverage goals are met as well as all tests pass. Just because Tests pass does not mean you are done. Goal Coverage Needs to be met even if the tests to get us there are outside the scope of your task. At this point, your task is to maintain coverage goal and all tests pass because we cannot commit changes if they fail.
|
||||
</workflow>
|
||||
|
||||
<constraints>
|
||||
|
||||
36
.github/agents/Manegment.agent.md
vendored
36
.github/agents/Manegment.agent.md
vendored
@@ -9,14 +9,15 @@ You are the ENGINEERING DIRECTOR.
|
||||
You are "lazy" in the smartest way possible. You never do what a subordinate can do.
|
||||
|
||||
<global_context>
|
||||
1. **Initialize**: ALWAYS read `.github/copilot-instructions.md` first to load global project rules.
|
||||
2. **Team Roster**:
|
||||
- `Planning`: The Architect. (Delegate research & planning here).
|
||||
- `Backend_Dev`: The Engineer. (Delegate Go implementation here).
|
||||
- `Frontend_Dev`: The Designer. (Delegate React implementation here).
|
||||
- `QA_Security`: The Auditor. (Delegate verification and testing here).
|
||||
- `Docs_Writer`: The Scribe. (Delegate docs here).
|
||||
- `DevOps`: The Packager. (Delegate CI/CD and infrastructure here).
|
||||
|
||||
1. **Initialize**: ALWAYS read `.github/copilot-instructions.md` first to load global project rules.
|
||||
2. **Team Roster**:
|
||||
- `Planning`: The Architect. (Delegate research & planning here).
|
||||
- `Backend_Dev`: The Engineer. (Delegate Go implementation here).
|
||||
- `Frontend_Dev`: The Designer. (Delegate React implementation here).
|
||||
- `QA_Security`: The Auditor. (Delegate verification and testing here).
|
||||
- `Docs_Writer`: The Scribe. (Delegate docs here).
|
||||
- `DevOps`: The Packager. (Delegate CI/CD and infrastructure here).
|
||||
</global_context>
|
||||
|
||||
<workflow>
|
||||
@@ -33,19 +34,20 @@ You are "lazy" in the smartest way possible. You never do what a subordinate can
|
||||
- **Present**: Summarize the plan to the user.
|
||||
- **Ask**: "Plan created. Shall I authorize the construction?"
|
||||
|
||||
3. **Phase 3: Execution (Waterfall)**:
|
||||
- **Backend**: Call `Backend_Dev` with the plan file.
|
||||
- **Frontend**: Call `Frontend_Dev` with the plan file.
|
||||
3. **Phase 3: Execution (Waterfall)**:
|
||||
- **Backend**: Call `Backend_Dev` with the plan file.
|
||||
- **Frontend**: Call `Frontend_Dev` with the plan file.
|
||||
|
||||
4. **Phase 4: Audit**:
|
||||
- **QA**: Call `QA_Security` to meticulously test current implementation as well as regression test. Run all linting, security tasks, and manual pre-commit checks. Write a report to `docs/reports/qa_report.md`. Start back at Phase 1 if issues are found.
|
||||
5. **Phase 5: Closure**:
|
||||
- **Docs**: Call `Docs_Writer`.
|
||||
- **Final Report**: Summarize the successful subagent runs.
|
||||
4. **Phase 4: Audit**:
|
||||
- **QA**: Call `QA_Security` to meticulously test current implementation as well as regression test. Run all linting, security tasks, and manual pre-commit checks. Write a report to `docs/reports/qa_report.md`. Start back at Phase 1 if issues are found.
|
||||
5. **Phase 5: Closure**:
|
||||
- **Docs**: Call `Docs_Writer`.
|
||||
- **Final Report**: Summarize the successful subagent runs.
|
||||
</workflow>
|
||||
|
||||
## DEFENITION OF DONE ##
|
||||
- The Task is not complete until pre-commit, frontend coverage tests, all linting, and security scans pass with zero issues. Leaving this unfinished prevents commit and push. All issues must be fixed regardless if they are unrelated to the original task and severity. This rule must never be skipped. It is non-negotiable anytime any bit of code is added or changed.
|
||||
|
||||
- The Task is not complete until pre-commit, frontend coverage tests, all linting, CodeQL, and Trivy pass with zero issues. Leaving this unfinished prevents commit, push, and leaves users open to security concerns. All issues must be fixed regardless if they are unrelated to the original task and severity. This rule must never be skipped. It is non-negotiable anytime any bit of code is added or changed.
|
||||
|
||||
<constraints>
|
||||
- **SOURCE CODE BAN**: You are FORBIDDEN from reading `.go`, `.tsx`, `.ts`, or `.css` files. You may ONLY read `.md` (Markdown) files.
|
||||
|
||||
38
.github/agents/Planning.agent.md
vendored
38
.github/agents/Planning.agent.md
vendored
@@ -14,29 +14,33 @@ Your goal is to design the **User Experience** first, then engineer the **Backen
|
||||
- **Smart Research**: Run `list_dir` on `internal/models` and `src/api`. ONLY read the specific files relevant to the request. Do not read the entire directory.
|
||||
- **Path Verification**: Verify file existence before referencing them.
|
||||
|
||||
2. **UX-First Gap Analysis**:
|
||||
- **Step 1**: Visualize the user interaction. What data does the user need to see?
|
||||
- **Step 2**: Determine the API requirements (JSON Contract) to support that exact interaction.
|
||||
- **Step 3**: Identify necessary Backend changes.
|
||||
2. **UX-First Gap Analysis**:
|
||||
- **Step 1**: Visualize the user interaction. What data does the user need to see?
|
||||
- **Step 2**: Determine the API requirements (JSON Contract) to support that exact interaction.
|
||||
- **Step 3**: Identify necessary Backend changes.
|
||||
|
||||
3. **Draft & Persist**:
|
||||
- Create a structured plan following the <output_format>.
|
||||
- **Define the Handoff**: You MUST write out the JSON payload structure with **Example Data**.
|
||||
- **SAVE THE PLAN**: Write the final plan to `docs/plans/current_spec.md` (Create the directory if needed). This allows Dev agents to read it later.
|
||||
3. **Draft & Persist**:
|
||||
- Create a structured plan following the <output_format>.
|
||||
- **Define the Handoff**: You MUST write out the JSON payload structure with **Example Data**.
|
||||
- **SAVE THE PLAN**: Write the final plan to `docs/plans/current_spec.md` (Create the directory if needed). This allows Dev agents to read it later.
|
||||
|
||||
4. **Review**:
|
||||
- Ask the user for confirmation.
|
||||
4. **Review**:
|
||||
- Ask the user for confirmation.
|
||||
|
||||
</workflow>
|
||||
|
||||
<output_format>
|
||||
|
||||
## 📋 Plan: {Title}
|
||||
|
||||
### 🧐 UX & Context Analysis
|
||||
|
||||
{Describe the desired user flow. e.g., "User clicks 'Scan', sees a spinner, then a live list of results."}
|
||||
|
||||
### 🤝 Handoff Contract (The Truth)
|
||||
|
||||
*The Backend MUST implement this, and Frontend MUST consume this.*
|
||||
|
||||
```json
|
||||
// POST /api/v1/resource
|
||||
{
|
||||
@@ -47,30 +51,36 @@ Your goal is to design the **User Experience** first, then engineer the **Backen
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 🏗️ Phase 1: Backend Implementation (Go)
|
||||
|
||||
1. Models: {Changes to internal/models}
|
||||
2. API: {Routes in internal/api/routes}
|
||||
3. Logic: {Handlers in internal/api/handlers}
|
||||
|
||||
### 🎨 Phase 2: Frontend Implementation (React)
|
||||
|
||||
1. Client: {Update src/api/client.ts}
|
||||
2. UI: {Components in src/components}
|
||||
3. Tests: {Unit tests to verify UX states}
|
||||
|
||||
### 🕵️ Phase 3: QA & Security
|
||||
|
||||
1. Edge Cases: {List specific scenarios to test}
|
||||
2. Security: Run CodeQL and Trivy scans. Triage and fix any new errors or warnings.
|
||||
|
||||
### 📚 Phase 4: Documentation
|
||||
|
||||
1. Files: Update docs/features.md.
|
||||
|
||||
</output_format>
|
||||
|
||||
<constraints>
|
||||
|
||||
- NO HALLUCINATIONS: Do not guess file paths. Verify them.
|
||||
- NO HALLUCINATIONS: Do not guess file paths. Verify them.
|
||||
|
||||
- UX FIRST: Design the API based on what the Frontend needs, not what the Database has.
|
||||
- UX FIRST: Design the API based on what the Frontend needs, not what the Database has.
|
||||
|
||||
- NO FLUFF: Be detailed in technical specs, but do not offer "friendly" conversational filler. Get straight to the plan.
|
||||
- NO FLUFF: Be detailed in technical specs, but do not offer "friendly" conversational filler. Get straight to the plan.
|
||||
|
||||
- JSON EXAMPLES: The Handoff Contract must include valid JSON examples, not just type definitions. </constraints>
|
||||
- JSON EXAMPLES: The Handoff Contract must include valid JSON examples, not just type definitions. </constraints>
|
||||
|
||||
54
.github/agents/QA_Security.agent.md
vendored
54
.github/agents/QA_Security.agent.md
vendored
@@ -19,47 +19,53 @@ Your job is to act as an ADVERSARY. The Developer says "it works"; your job is t
|
||||
- **Load The Spec**: Read `docs/plans/current_spec.md` (if it exists) to understand the intended behavior and JSON Contract.
|
||||
- **Target Identification**: Run `list_dir` to find the new code. Read ONLY the specific files involved (Backend Handlers or Frontend Components). Do not read the entire codebase.
|
||||
|
||||
2. **Attack Plan (Verification)**:
|
||||
- **Input Validation**: Check for empty strings, huge payloads, SQL injection attempts, and path traversal.
|
||||
- **Error States**: What happens if the DB is down? What if the network fails?
|
||||
- **Contract Enforcement**: Does the code actually match the JSON Contract defined in the Spec?
|
||||
2. **Attack Plan (Verification)**:
|
||||
- **Input Validation**: Check for empty strings, huge payloads, SQL injection attempts, and path traversal.
|
||||
- **Error States**: What happens if the DB is down? What if the network fails?
|
||||
- **Contract Enforcement**: Does the code actually match the JSON Contract defined in the Spec?
|
||||
|
||||
3. **Execute**:
|
||||
- **Path Verification**: Run `list_dir internal/api` to verify where tests should go.
|
||||
- **Creation**: Write a new test file (e.g., `internal/api/tests/audit_test.go`) to test the *flow*.
|
||||
- **Run**: Execute `go test ./internal/api/tests/...` (or specific path). Run local CodeQL and Trivy scans (they are built as VS Code Tasks so they just need to be triggered to run), pre-commit all files, and triage any findings.
|
||||
3. **Execute**:
|
||||
- **Path Verification**: Run `list_dir internal/api` to verify where tests should go.
|
||||
- **Creation**: Write a new test file (e.g., `internal/api/tests/audit_test.go`) to test the *flow*.
|
||||
- **Run**: Execute `go test ./internal/api/tests/...` (or specific path). Run local CodeQL and Trivy scans (they are built as VS Code Tasks so they just need to be triggered to run), pre-commit all files, and triage any findings.
|
||||
- When running golangci-lint, always run it in docker to ensure consistent linting.
|
||||
- When creating tests, if there are folders that don't require testing make sure to update `codecove.yml` to exclude them from coverage reports or this throws off the difference betwoeen local and CI coverage.
|
||||
- **Cleanup**: If the test was temporary, delete it. If it's valuable, keep it.
|
||||
- **Cleanup**: If the test was temporary, delete it. If it's valuable, keep it.
|
||||
</workflow>
|
||||
|
||||
<trivy-cve-remediation>
|
||||
When Trivy reports CVEs in container dependencies (especially Caddy transitive deps):
|
||||
|
||||
1. **Triage**: Determine if CVE is in OUR code or a DEPENDENCY.
|
||||
- If ours: Fix immediately.
|
||||
- If dependency (e.g., Caddy's transitive deps): Patch in Dockerfile.
|
||||
1. **Triage**: Determine if CVE is in OUR code or a DEPENDENCY.
|
||||
- If ours: Fix immediately.
|
||||
- If dependency (e.g., Caddy's transitive deps): Patch in Dockerfile.
|
||||
|
||||
2. **Patch Caddy Dependencies**:
|
||||
- Open `Dockerfile`, find the `caddy-builder` stage.
|
||||
- Add a Renovate-trackable comment + `go get` line:
|
||||
|
||||
2. **Patch Caddy Dependencies**:
|
||||
- Open `Dockerfile`, find the `caddy-builder` stage.
|
||||
- Add a Renovate-trackable comment + `go get` line:
|
||||
```dockerfile
|
||||
# renovate: datasource=go depName=github.com/OWNER/REPO
|
||||
go get github.com/OWNER/REPO@vX.Y.Z || true; \
|
||||
```
|
||||
- Run `go mod tidy` after all patches.
|
||||
- The `XCADDY_SKIP_CLEANUP=1` pattern preserves the build env for patching.
|
||||
|
||||
3. **Verify**:
|
||||
- Rebuild: `docker build --no-cache -t charon:local-patched .`
|
||||
- Re-scan: `docker run --rm -v /var/run/docker.sock:/var/run/docker.sock aquasec/trivy:latest image --severity CRITICAL,HIGH charon:local-patched`
|
||||
- Expect 0 vulnerabilities for patched libs.
|
||||
- Run `go mod tidy` after all patches.
|
||||
- The `XCADDY_SKIP_CLEANUP=1` pattern preserves the build env for patching.
|
||||
|
||||
4. **Renovate Tracking**:
|
||||
- Ensure `.github/renovate.json` has a `customManagers` regex for `# renovate:` comments in Dockerfile.
|
||||
- Renovate will auto-PR when newer versions release.
|
||||
3. **Verify**:
|
||||
- Rebuild: `docker build --no-cache -t charon:local-patched .`
|
||||
- Re-scan: `docker run --rm -v /var/run/docker.sock:/var/run/docker.sock aquasec/trivy:latest image --severity CRITICAL,HIGH charon:local-patched`
|
||||
- Expect 0 vulnerabilities for patched libs.
|
||||
|
||||
4. **Renovate Tracking**:
|
||||
- Ensure `.github/renovate.json` has a `customManagers` regex for `# renovate:` comments in Dockerfile.
|
||||
- Renovate will auto-PR when newer versions release.
|
||||
</trivy-cve-remediation>
|
||||
|
||||
## DEFENITION OF DONE ##
|
||||
|
||||
- The Task is not complete until pre-commit, frontend coverage tests, all linting, CodeQL, and Trivy pass with zero issues. Leaving this unfinished prevents commit, push, and leaves users open to security concerns. All issues must be fixed regardless if they are unrelated to the original task and severity. This rule must never be skipped. It is non-negotiable anytime any bit of code is added or changed.
|
||||
|
||||
<constraints>
|
||||
- **TERSE OUTPUT**: Do not explain the code. Output ONLY the code blocks or command results.
|
||||
- **NO CONVERSATION**: If the task is done, output "DONE".
|
||||
|
||||
5
.github/agents/SubagentUsage.md
vendored
5
.github/agents/SubagentUsage.md
vendored
@@ -3,6 +3,7 @@
|
||||
This helper provides the Management agent with templates to create robust and repeatable `runSubagent` calls.
|
||||
|
||||
1) Basic runSubagent Template
|
||||
|
||||
```
|
||||
runSubagent({
|
||||
prompt: "<Clear, short instruction for the subagent>",
|
||||
@@ -19,6 +20,7 @@ runSubagent({
|
||||
```
|
||||
|
||||
2) Orchestration Checklist (Management)
|
||||
|
||||
- Validate: `plan_file` exists and contains a `Handoff Contract` JSON.
|
||||
- Kickoff: call `Planning` to create the plan if not present.
|
||||
- Run: execute `Backend Dev` then `Frontend Dev` sequentially.
|
||||
@@ -26,6 +28,7 @@ runSubagent({
|
||||
- Return: a JSON summary with `subagent_results`, `overall_status`, and aggregated artifacts.
|
||||
|
||||
3) Return Contract that all subagents must return
|
||||
|
||||
```
|
||||
{
|
||||
"changed_files": ["path/to/file1", "path/to/file2"],
|
||||
@@ -37,10 +40,12 @@ runSubagent({
|
||||
```
|
||||
|
||||
4) Error Handling
|
||||
|
||||
- On a subagent failure, the Management agent must capture `tests.output` and decide to retry (1 retry maximum), or request a revert/rollback.
|
||||
- Clearly mark the `status` as `failed`, and include `errors` and `failing_tests` in the `summary`.
|
||||
|
||||
5) Example: Run a full Feature Implementation
|
||||
|
||||
```
|
||||
// 1. Planning
|
||||
runSubagent({ description: "Planning", prompt: "<generate plan>", metadata: { plan_file: "docs/plans/current_spec.md" } })
|
||||
|
||||
23
.github/copilot-instructions.md
vendored
23
.github/copilot-instructions.md
vendored
@@ -1,6 +1,7 @@
|
||||
# Charon Copilot Instructions
|
||||
|
||||
## Code Quality Guidelines
|
||||
|
||||
Every session should improve the codebase, not just add to it. Actively refactor code you encounter, even outside of your immediate task scope. Think about long-term maintainability and consistency. Make a detailed plan before writing code. Always create unit tests for new code coverage.
|
||||
|
||||
- **DRY**: Consolidate duplicate patterns into reusable functions, types, or components after the second occurrence.
|
||||
@@ -10,11 +11,13 @@ Every session should improve the codebase, not just add to it. Actively refactor
|
||||
- **CONVENTIONAL COMMITS**: Write commit messages using `feat:`, `fix:`, `chore:`, `refactor:`, or `docs:` prefixes.
|
||||
|
||||
## 🚨 CRITICAL ARCHITECTURE RULES 🚨
|
||||
|
||||
- **Single Frontend Source**: All frontend code MUST reside in `frontend/`. NEVER create `backend/frontend/` or any other nested frontend directory.
|
||||
- **Single Backend Source**: All backend code MUST reside in `backend/`.
|
||||
- **No Python**: This is a Go (Backend) + React/TypeScript (Frontend) project. Do not introduce Python scripts or requirements.
|
||||
|
||||
## Big Picture
|
||||
|
||||
- Charon is a self-hosted web app for managing reverse proxy host configurations with the novice user in mind. Everything should prioritize simplicity, usability, reliability, and security, all rolled into one simple binary + static assets deployment. No external dependencies.
|
||||
- Users should feel like they have enterprise-level security and features with zero effort.
|
||||
- `backend/cmd/api` loads config, opens SQLite, then hands off to `internal/server`.
|
||||
@@ -23,6 +26,7 @@ Every session should improve the codebase, not just add to it. Actively refactor
|
||||
- Persistent types live in `internal/models`; GORM auto-migrates them.
|
||||
|
||||
## Backend Workflow
|
||||
|
||||
- **Run**: `cd backend && go run ./cmd/api`.
|
||||
- **Test**: `go test ./...`.
|
||||
- **API Response**: Handlers return structured errors using `gin.H{"error": "message"}`.
|
||||
@@ -32,6 +36,7 @@ Every session should improve the codebase, not just add to it. Actively refactor
|
||||
- **Graceful Shutdown**: Long-running work must respect `server.Run(ctx)`.
|
||||
|
||||
## Frontend Workflow
|
||||
|
||||
- **Location**: Always work within `frontend/`.
|
||||
- **Stack**: React 18 + Vite + TypeScript + TanStack Query (React Query).
|
||||
- **State Management**: Use `src/hooks/use*.ts` wrapping React Query.
|
||||
@@ -39,6 +44,7 @@ Every session should improve the codebase, not just add to it. Actively refactor
|
||||
- **Forms**: Use local `useState` for form fields, submit via `useMutation`, then `invalidateQueries` on success.
|
||||
|
||||
## Cross-Cutting Notes
|
||||
|
||||
- **VS Code Integration**: If you introduce new repetitive CLI actions (e.g., scans, builds, scripts), register them in .vscode/tasks.json to allow for easy manual verification.
|
||||
- **Sync**: React Query expects the exact JSON produced by GORM tags (snake_case). Keep API and UI field names aligned.
|
||||
- **Migrations**: When adding models, update `internal/models` AND `internal/api/routes/routes.go` (AutoMigrate).
|
||||
@@ -46,18 +52,23 @@ Every session should improve the codebase, not just add to it. Actively refactor
|
||||
- **Ignore Files**: Always check `.gitignore`, `.dockerignore`, and `.codecov.yml` when adding new file or folders.
|
||||
|
||||
## Documentation
|
||||
|
||||
- **Features**: Update `docs/features.md` when adding capabilities.
|
||||
- **Links**: Use GitHub Pages URLs (`https://wikid82.github.io/charon/`) for docs and GitHub blob links for repo files.
|
||||
|
||||
## CI/CD & Commit Conventions
|
||||
|
||||
- **Triggers**: Use `feat:`, `fix:`, or `perf:` to trigger Docker builds. `chore:` skips builds.
|
||||
- **Beta**: `feature/beta-release` always builds.
|
||||
- **History-Rewrite PRs**: If a PR touches files in `scripts/history-rewrite/` or `docs/plans/history_rewrite.md`, the PR description MUST include the history-rewrite checklist from `.github/PULL_REQUEST_TEMPLATE/history-rewrite.md`. This is enforced by CI.
|
||||
|
||||
## ✅ Task Completion Protocol (Definition of Done)
|
||||
|
||||
Before marking an implementation task as complete, perform the following:
|
||||
1. **Pre-Commit Triage**: Run `pre-commit run --all-files`.
|
||||
- If errors occur, **fix them immediately**.
|
||||
- If logic errors occur, analyze and propose a fix.
|
||||
- Do not output code that violates pre-commit standards.
|
||||
2. **Verify Build**: Ensure the backend compiles and the frontend builds without errors.
|
||||
3. **Clean Up**: Ensure no debug print statements or commented-out blocks remain.
|
||||
|
||||
1. **Pre-Commit Triage**: Run `pre-commit run --all-files`.
|
||||
- If errors occur, **fix them immediately**.
|
||||
- If logic errors occur, analyze and propose a fix.
|
||||
- Do not output code that violates pre-commit standards.
|
||||
2. **Verify Build**: Ensure the backend compiles and the frontend builds without errors.
|
||||
3. **Clean Up**: Ensure no debug print statements or commented-out blocks remain.
|
||||
|
||||
2
.github/workflows/auto-changelog.yml
vendored
2
.github/workflows/auto-changelog.yml
vendored
@@ -14,4 +14,4 @@ jobs:
|
||||
- name: Draft Release
|
||||
uses: release-drafter/release-drafter@b1476f6e6eb133afa41ed8589daba6dc69b4d3f5 # v6
|
||||
env:
|
||||
CHARON_TOKEN: ${{ secrets.CHARON_TOKEN }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
16
.github/workflows/auto-versioning.yml
vendored
16
.github/workflows/auto-versioning.yml
vendored
@@ -23,10 +23,12 @@ jobs:
|
||||
with:
|
||||
# The prefix to use to create tags
|
||||
tag_prefix: "v"
|
||||
# A string which, if present in the git log, indicates that a major version increase is required
|
||||
major_pattern: "(MAJOR)"
|
||||
# A string which, if present in the git log, indicates that a minor version increase is required
|
||||
minor_pattern: "(feat)"
|
||||
# Regex pattern for major version bump (breaking changes)
|
||||
# Matches: "feat!:", "fix!:", "BREAKING CHANGE:" in commit messages
|
||||
major_pattern: "/!:|BREAKING CHANGE:/"
|
||||
# Regex pattern for minor version bump (new features)
|
||||
# Matches: "feat:" prefix in commit messages (Conventional Commits)
|
||||
minor_pattern: "/feat:/"
|
||||
# Pattern to determine formatting
|
||||
version_format: "${major}.${minor}.${patch}"
|
||||
# If no tags are found, this version is used
|
||||
@@ -66,7 +68,7 @@ jobs:
|
||||
# Export the tag for downstream steps
|
||||
echo "tag=${TAG}" >> $GITHUB_OUTPUT
|
||||
env:
|
||||
CHARON_TOKEN: ${{ secrets.CHARON_TOKEN }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Determine tag
|
||||
id: determine_tag
|
||||
@@ -87,14 +89,14 @@ jobs:
|
||||
run: |
|
||||
TAG=${{ steps.determine_tag.outputs.tag }}
|
||||
echo "Checking for release for tag: ${TAG}"
|
||||
STATUS=$(curl -s -o /dev/null -w "%{http_code}" -H "Authorization: token ${CHARON_TOKEN}" -H "Accept: application/vnd.github+json" "https://api.github.com/repos/${GITHUB_REPOSITORY}/releases/tags/${TAG}") || true
|
||||
STATUS=$(curl -s -o /dev/null -w "%{http_code}" -H "Authorization: token ${GITHUB_TOKEN}" -H "Accept: application/vnd.github+json" "https://api.github.com/repos/${GITHUB_REPOSITORY}/releases/tags/${TAG}") || true
|
||||
if [ "${STATUS}" = "200" ]; then
|
||||
echo "exists=true" >> $GITHUB_OUTPUT
|
||||
else
|
||||
echo "exists=false" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
env:
|
||||
CHARON_TOKEN: ${{ secrets.CHARON_TOKEN }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Create GitHub Release (tag-only, no workspace changes)
|
||||
if: ${{ steps.semver.outputs.changed == 'true' && steps.check_release.outputs.exists == 'false' }}
|
||||
|
||||
10
.github/workflows/benchmark.yml
vendored
10
.github/workflows/benchmark.yml
vendored
@@ -37,18 +37,22 @@ jobs:
|
||||
run: go test -bench=. -benchmem -run='^$' ./... | tee output.txt
|
||||
|
||||
- name: Store Benchmark Result
|
||||
# Only store results on pushes to main - PRs just run benchmarks without storage
|
||||
# This avoids gh-pages branch errors and permission issues on fork PRs
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||
uses: benchmark-action/github-action-benchmark@v1
|
||||
with:
|
||||
name: Go Benchmark
|
||||
tool: 'go'
|
||||
output-file-path: backend/output.txt
|
||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
auto-push: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
|
||||
auto-push: true
|
||||
# Show alert with commit comment on detection of performance regression
|
||||
alert-threshold: '150%'
|
||||
# Threshold increased to 175% to account for CI variability
|
||||
alert-threshold: '175%'
|
||||
comment-on-alert: true
|
||||
fail-on-alert: false
|
||||
# Enable Job Summary for PRs
|
||||
# Enable Job Summary
|
||||
summary-always: true
|
||||
|
||||
- name: Run Perf Asserts
|
||||
|
||||
6
.github/workflows/codecov-upload.yml
vendored
6
.github/workflows/codecov-upload.yml
vendored
@@ -35,7 +35,7 @@ jobs:
|
||||
exit ${PIPESTATUS[0]}
|
||||
|
||||
- name: Upload backend coverage to Codecov
|
||||
uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5
|
||||
uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5
|
||||
with:
|
||||
token: ${{ secrets.CODECOV_TOKEN }}
|
||||
files: ./backend/coverage.txt
|
||||
@@ -54,7 +54,7 @@ jobs:
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6
|
||||
with:
|
||||
node-version: '24.11.1'
|
||||
node-version: '24.12.0'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: frontend/package-lock.json
|
||||
|
||||
@@ -69,7 +69,7 @@ jobs:
|
||||
exit ${PIPESTATUS[0]}
|
||||
|
||||
- name: Upload frontend coverage to Codecov
|
||||
uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5
|
||||
uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5
|
||||
with:
|
||||
token: ${{ secrets.CODECOV_TOKEN }}
|
||||
directory: ./frontend/coverage
|
||||
|
||||
6
.github/workflows/codeql.yml
vendored
6
.github/workflows/codeql.yml
vendored
@@ -34,7 +34,7 @@ jobs:
|
||||
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
|
||||
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@cf1bb45a277cb3c205638b2cd5c984db1c46a412 # v4
|
||||
uses: github/codeql-action/init@1b168cd39490f61582a9beae412bb7057a6b2c4e # v4
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
|
||||
@@ -45,9 +45,9 @@ jobs:
|
||||
go-version: '1.25.5'
|
||||
|
||||
- name: Autobuild
|
||||
uses: github/codeql-action/autobuild@cf1bb45a277cb3c205638b2cd5c984db1c46a412 # v4
|
||||
uses: github/codeql-action/autobuild@1b168cd39490f61582a9beae412bb7057a6b2c4e # v4
|
||||
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@cf1bb45a277cb3c205638b2cd5c984db1c46a412 # v4
|
||||
uses: github/codeql-action/analyze@1b168cd39490f61582a9beae412bb7057a6b2c4e # v4
|
||||
with:
|
||||
category: "/language:${{ matrix.language }}"
|
||||
|
||||
2
.github/workflows/docker-build.yml
vendored
2
.github/workflows/docker-build.yml
vendored
@@ -151,7 +151,7 @@ jobs:
|
||||
|
||||
- name: Upload Trivy results
|
||||
if: github.event_name != 'pull_request' && steps.skip.outputs.skip_build != 'true' && steps.trivy-check.outputs.exists == 'true'
|
||||
uses: github/codeql-action/upload-sarif@cf1bb45a277cb3c205638b2cd5c984db1c46a412 # v4.31.7
|
||||
uses: github/codeql-action/upload-sarif@1b168cd39490f61582a9beae412bb7057a6b2c4e # v4.31.8
|
||||
with:
|
||||
sarif_file: 'trivy-results.sarif'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
2
.github/workflows/docker-publish.yml
vendored
2
.github/workflows/docker-publish.yml
vendored
@@ -155,7 +155,7 @@ jobs:
|
||||
|
||||
- name: Upload Trivy results
|
||||
if: github.event_name != 'pull_request' && steps.skip.outputs.skip_build != 'true' && steps.trivy-check.outputs.exists == 'true'
|
||||
uses: github/codeql-action/upload-sarif@cf1bb45a277cb3c205638b2cd5c984db1c46a412 # v4.31.7
|
||||
uses: github/codeql-action/upload-sarif@1b168cd39490f61582a9beae412bb7057a6b2c4e # v4.31.8
|
||||
with:
|
||||
sarif_file: 'trivy-results.sarif'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
369
.github/workflows/docs-to-issues.yml
vendored
Normal file
369
.github/workflows/docs-to-issues.yml
vendored
Normal file
@@ -0,0 +1,369 @@
|
||||
name: Convert Docs to Issues
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- development
|
||||
paths:
|
||||
- 'docs/issues/**/*.md'
|
||||
- '!docs/issues/created/**'
|
||||
- '!docs/issues/_TEMPLATE.md'
|
||||
- '!docs/issues/README.md'
|
||||
|
||||
# Allow manual trigger
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
dry_run:
|
||||
description: 'Dry run (no issues created)'
|
||||
required: false
|
||||
default: 'false'
|
||||
type: boolean
|
||||
file_path:
|
||||
description: 'Specific file to process (optional)'
|
||||
required: false
|
||||
type: string
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
issues: write
|
||||
pull-requests: write
|
||||
|
||||
jobs:
|
||||
convert-docs:
|
||||
name: Convert Markdown to Issues
|
||||
runs-on: ubuntu-latest
|
||||
if: github.actor != 'github-actions[bot]'
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
|
||||
with:
|
||||
fetch-depth: 2
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
|
||||
with:
|
||||
node-version: '20'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm install gray-matter
|
||||
|
||||
- name: Detect changed files
|
||||
id: changes
|
||||
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7
|
||||
with:
|
||||
script: |
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
|
||||
// Manual file specification
|
||||
const manualFile = '${{ github.event.inputs.file_path }}';
|
||||
if (manualFile) {
|
||||
if (fs.existsSync(manualFile)) {
|
||||
core.setOutput('files', JSON.stringify([manualFile]));
|
||||
return;
|
||||
} else {
|
||||
core.setFailed(`File not found: ${manualFile}`);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// Get changed files from commit
|
||||
const { data: commit } = await github.rest.repos.getCommit({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
ref: context.sha
|
||||
});
|
||||
|
||||
const changedFiles = (commit.files || [])
|
||||
.filter(f => f.filename.startsWith('docs/issues/'))
|
||||
.filter(f => !f.filename.startsWith('docs/issues/created/'))
|
||||
.filter(f => !f.filename.includes('_TEMPLATE'))
|
||||
.filter(f => !f.filename.includes('README'))
|
||||
.filter(f => f.filename.endsWith('.md'))
|
||||
.filter(f => f.status !== 'removed')
|
||||
.map(f => f.filename);
|
||||
|
||||
console.log('Changed issue files:', changedFiles);
|
||||
core.setOutput('files', JSON.stringify(changedFiles));
|
||||
|
||||
- name: Process issue files
|
||||
id: process
|
||||
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7
|
||||
env:
|
||||
DRY_RUN: ${{ github.event.inputs.dry_run || 'false' }}
|
||||
with:
|
||||
script: |
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const matter = require('gray-matter');
|
||||
|
||||
const files = JSON.parse('${{ steps.changes.outputs.files }}');
|
||||
const isDryRun = process.env.DRY_RUN === 'true';
|
||||
const createdIssues = [];
|
||||
const errors = [];
|
||||
|
||||
if (files.length === 0) {
|
||||
console.log('No issue files to process');
|
||||
core.setOutput('created_count', 0);
|
||||
core.setOutput('created_issues', '[]');
|
||||
core.setOutput('errors', '[]');
|
||||
return;
|
||||
}
|
||||
|
||||
// Label color map
|
||||
const labelColors = {
|
||||
testing: 'BFD4F2',
|
||||
feature: 'A2EEEF',
|
||||
enhancement: '84B6EB',
|
||||
bug: 'D73A4A',
|
||||
documentation: '0075CA',
|
||||
backend: '1D76DB',
|
||||
frontend: '5EBEFF',
|
||||
security: 'EE0701',
|
||||
ui: '7057FF',
|
||||
caddy: '1F6FEB',
|
||||
'needs-triage': 'FBCA04',
|
||||
acl: 'C5DEF5',
|
||||
regression: 'D93F0B',
|
||||
'manual-testing': 'BFD4F2',
|
||||
'bulk-acl': '006B75',
|
||||
'error-handling': 'D93F0B',
|
||||
'ui-ux': '7057FF',
|
||||
integration: '0E8A16',
|
||||
performance: 'EDEDED',
|
||||
'cross-browser': '5319E7',
|
||||
plus: 'FFD700',
|
||||
beta: '0052CC',
|
||||
alpha: '5319E7',
|
||||
high: 'D93F0B',
|
||||
medium: 'FBCA04',
|
||||
low: '0E8A16',
|
||||
critical: 'B60205',
|
||||
architecture: '006B75',
|
||||
database: '006B75',
|
||||
'post-beta': '006B75'
|
||||
};
|
||||
|
||||
// Helper: Ensure label exists
|
||||
async function ensureLabel(name) {
|
||||
try {
|
||||
await github.rest.issues.getLabel({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
name: name
|
||||
});
|
||||
} catch (e) {
|
||||
if (e.status === 404) {
|
||||
await github.rest.issues.createLabel({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
name: name,
|
||||
color: labelColors[name.toLowerCase()] || '666666'
|
||||
});
|
||||
console.log(`Created label: ${name}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Helper: Parse markdown file
|
||||
function parseIssueFile(filePath) {
|
||||
const content = fs.readFileSync(filePath, 'utf8');
|
||||
const { data: frontmatter, content: body } = matter(content);
|
||||
|
||||
// Extract title: frontmatter > first H1 > filename
|
||||
let title = frontmatter.title;
|
||||
if (!title) {
|
||||
const h1Match = body.match(/^#\s+(.+)$/m);
|
||||
title = h1Match ? h1Match[1] : path.basename(filePath, '.md').replace(/-/g, ' ');
|
||||
}
|
||||
|
||||
// Build labels array
|
||||
const labels = [...(frontmatter.labels || [])];
|
||||
if (frontmatter.priority) labels.push(frontmatter.priority);
|
||||
if (frontmatter.type) labels.push(frontmatter.type);
|
||||
|
||||
return {
|
||||
title,
|
||||
body: body.trim(),
|
||||
labels: [...new Set(labels)],
|
||||
assignees: frontmatter.assignees || [],
|
||||
milestone: frontmatter.milestone,
|
||||
parent_issue: frontmatter.parent_issue,
|
||||
create_sub_issues: frontmatter.create_sub_issues || false
|
||||
};
|
||||
}
|
||||
|
||||
// Helper: Extract sub-issues from H2 sections
|
||||
function extractSubIssues(body, parentLabels) {
|
||||
const sections = [];
|
||||
const lines = body.split('\n');
|
||||
let currentSection = null;
|
||||
let currentBody = [];
|
||||
|
||||
for (const line of lines) {
|
||||
const h2Match = line.match(/^##\s+(?:Sub-Issue\s*#?\d*:?\s*)?(.+)$/);
|
||||
if (h2Match) {
|
||||
if (currentSection) {
|
||||
sections.push({
|
||||
title: currentSection,
|
||||
body: currentBody.join('\n').trim(),
|
||||
labels: [...parentLabels]
|
||||
});
|
||||
}
|
||||
currentSection = h2Match[1].trim();
|
||||
currentBody = [];
|
||||
} else if (currentSection) {
|
||||
currentBody.push(line);
|
||||
}
|
||||
}
|
||||
|
||||
if (currentSection) {
|
||||
sections.push({
|
||||
title: currentSection,
|
||||
body: currentBody.join('\n').trim(),
|
||||
labels: [...parentLabels]
|
||||
});
|
||||
}
|
||||
|
||||
return sections;
|
||||
}
|
||||
|
||||
// Process each file
|
||||
for (const filePath of files) {
|
||||
console.log(`\nProcessing: ${filePath}`);
|
||||
|
||||
try {
|
||||
const parsed = parseIssueFile(filePath);
|
||||
console.log(` Title: ${parsed.title}`);
|
||||
console.log(` Labels: ${parsed.labels.join(', ')}`);
|
||||
|
||||
if (isDryRun) {
|
||||
console.log(' [DRY RUN] Would create issue');
|
||||
createdIssues.push({ file: filePath, title: parsed.title, dryRun: true });
|
||||
continue;
|
||||
}
|
||||
|
||||
// Ensure labels exist
|
||||
for (const label of parsed.labels) {
|
||||
await ensureLabel(label);
|
||||
}
|
||||
|
||||
// Create the main issue
|
||||
const issueBody = parsed.body +
|
||||
`\n\n---\n*Auto-created from [${path.basename(filePath)}](https://github.com/${context.repo.owner}/${context.repo.repo}/blob/${context.sha}/${filePath})*`;
|
||||
|
||||
const issueResponse = await github.rest.issues.create({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
title: parsed.title,
|
||||
body: issueBody,
|
||||
labels: parsed.labels,
|
||||
assignees: parsed.assignees
|
||||
});
|
||||
|
||||
const issueNumber = issueResponse.data.number;
|
||||
console.log(` Created issue #${issueNumber}`);
|
||||
|
||||
// Handle sub-issues
|
||||
if (parsed.create_sub_issues) {
|
||||
const subIssues = extractSubIssues(parsed.body, parsed.labels);
|
||||
for (const sub of subIssues) {
|
||||
for (const label of sub.labels) {
|
||||
await ensureLabel(label);
|
||||
}
|
||||
const subResponse = await github.rest.issues.create({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
title: `[${parsed.title}] ${sub.title}`,
|
||||
body: sub.body + `\n\n---\n*Sub-issue of #${issueNumber}*`,
|
||||
labels: sub.labels,
|
||||
assignees: parsed.assignees
|
||||
});
|
||||
console.log(` Created sub-issue #${subResponse.data.number}: ${sub.title}`);
|
||||
}
|
||||
}
|
||||
|
||||
// Link to parent issue if specified
|
||||
if (parsed.parent_issue) {
|
||||
await github.rest.issues.createComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: parsed.parent_issue,
|
||||
body: `Sub-issue created: #${issueNumber}`
|
||||
});
|
||||
}
|
||||
|
||||
createdIssues.push({
|
||||
file: filePath,
|
||||
title: parsed.title,
|
||||
issueNumber
|
||||
});
|
||||
|
||||
} catch (error) {
|
||||
console.error(` Error processing ${filePath}: ${error.message}`);
|
||||
errors.push({ file: filePath, error: error.message });
|
||||
}
|
||||
}
|
||||
|
||||
core.setOutput('created_count', createdIssues.length);
|
||||
core.setOutput('created_issues', JSON.stringify(createdIssues));
|
||||
core.setOutput('errors', JSON.stringify(errors));
|
||||
|
||||
if (errors.length > 0) {
|
||||
core.warning(`${errors.length} file(s) had errors`);
|
||||
}
|
||||
|
||||
- name: Move processed files
|
||||
if: steps.process.outputs.created_count != '0' && github.event.inputs.dry_run != 'true'
|
||||
run: |
|
||||
mkdir -p docs/issues/created
|
||||
CREATED_ISSUES='${{ steps.process.outputs.created_issues }}'
|
||||
echo "$CREATED_ISSUES" | jq -r '.[].file' | while read file; do
|
||||
if [ -f "$file" ] && [ ! -z "$file" ]; then
|
||||
filename=$(basename "$file")
|
||||
timestamp=$(date +%Y%m%d)
|
||||
mv "$file" "docs/issues/created/${timestamp}-${filename}"
|
||||
echo "Moved: $file -> docs/issues/created/${timestamp}-${filename}"
|
||||
fi
|
||||
done
|
||||
|
||||
- name: Commit moved files
|
||||
if: steps.process.outputs.created_count != '0' && github.event.inputs.dry_run != 'true'
|
||||
run: |
|
||||
git config --local user.email "github-actions[bot]@users.noreply.github.com"
|
||||
git config --local user.name "github-actions[bot]"
|
||||
git add docs/issues/
|
||||
git diff --staged --quiet || git commit -m "chore: move processed issue files to created/ [skip ci]"
|
||||
git push
|
||||
|
||||
- name: Summary
|
||||
if: always()
|
||||
run: |
|
||||
echo "## Docs to Issues Summary" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
CREATED='${{ steps.process.outputs.created_issues }}'
|
||||
ERRORS='${{ steps.process.outputs.errors }}'
|
||||
DRY_RUN='${{ github.event.inputs.dry_run }}'
|
||||
|
||||
if [ "$DRY_RUN" = "true" ]; then
|
||||
echo "🔍 **Dry Run Mode** - No issues were actually created" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
fi
|
||||
|
||||
echo "### Created Issues" >> $GITHUB_STEP_SUMMARY
|
||||
if [ -n "$CREATED" ] && [ "$CREATED" != "[]" ] && [ "$CREATED" != "null" ]; then
|
||||
echo "$CREATED" | jq -r '.[] | "- \(.title) (#\(.issueNumber // "dry-run"))"' >> $GITHUB_STEP_SUMMARY || echo "_Parse error_" >> $GITHUB_STEP_SUMMARY
|
||||
else
|
||||
echo "_No issues created_" >> $GITHUB_STEP_SUMMARY
|
||||
fi
|
||||
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "### Errors" >> $GITHUB_STEP_SUMMARY
|
||||
if [ -n "$ERRORS" ] && [ "$ERRORS" != "[]" ] && [ "$ERRORS" != "null" ]; then
|
||||
echo "$ERRORS" | jq -r '.[] | "- ❌ \(.file): \(.error)"' >> $GITHUB_STEP_SUMMARY || echo "_Parse error_" >> $GITHUB_STEP_SUMMARY
|
||||
else
|
||||
echo "_No errors_" >> $GITHUB_STEP_SUMMARY
|
||||
fi
|
||||
2
.github/workflows/docs.yml
vendored
2
.github/workflows/docs.yml
vendored
@@ -35,7 +35,7 @@ jobs:
|
||||
- name: 🔧 Set up Node.js
|
||||
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6
|
||||
with:
|
||||
node-version: '24.11.1'
|
||||
node-version: '24.12.0'
|
||||
|
||||
# Step 3: Create a beautiful docs site structure
|
||||
- name: 📝 Build documentation site
|
||||
|
||||
8
.github/workflows/pr-checklist.yml
vendored
8
.github/workflows/pr-checklist.yml
vendored
@@ -23,9 +23,15 @@ jobs:
|
||||
const body = (pr.data && pr.data.body) || '';
|
||||
|
||||
// Determine if this PR modifies history-rewrite related files
|
||||
// Exclude the template file itself - it shouldn't trigger its own validation
|
||||
const filesResp = await github.rest.pulls.listFiles({ owner, repo, pull_number: prNumber });
|
||||
const files = filesResp.data.map(f => f.filename.toLowerCase());
|
||||
const relevant = files.some(fn => fn.startsWith('scripts/history-rewrite/') || fn.startsWith('docs/plans/history_rewrite.md') || fn.includes('history-rewrite'));
|
||||
const relevant = files.some(fn => {
|
||||
// Skip the PR template itself
|
||||
if (fn === '.github/pull_request_template/history-rewrite.md') return false;
|
||||
// Check for actual history-rewrite implementation files
|
||||
return fn.startsWith('scripts/history-rewrite/') || fn === 'docs/plans/history_rewrite.md';
|
||||
});
|
||||
if (!relevant) {
|
||||
core.info('No history-rewrite related files changed; skipping checklist validation.');
|
||||
return;
|
||||
|
||||
4
.github/workflows/propagate-changes.yml
vendored
4
.github/workflows/propagate-changes.yml
vendored
@@ -20,7 +20,7 @@ jobs:
|
||||
- name: Set up Node (for github-script)
|
||||
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6
|
||||
with:
|
||||
node-version: '24.11.1'
|
||||
node-version: '24.12.0'
|
||||
|
||||
- name: Propagate Changes
|
||||
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
|
||||
@@ -157,5 +157,5 @@ jobs:
|
||||
}
|
||||
}
|
||||
env:
|
||||
CHARON_TOKEN: ${{ secrets.CHARON_TOKEN }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
CPMP_TOKEN: ${{ secrets.CPMP_TOKEN }}
|
||||
|
||||
2
.github/workflows/quality-checks.yml
vendored
2
.github/workflows/quality-checks.yml
vendored
@@ -89,7 +89,7 @@ jobs:
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
|
||||
with:
|
||||
node-version: '24.11.1'
|
||||
node-version: '24.12.0'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: frontend/package-lock.json
|
||||
|
||||
|
||||
14
.github/workflows/release-goreleaser.yml
vendored
14
.github/workflows/release-goreleaser.yml
vendored
@@ -13,10 +13,10 @@ jobs:
|
||||
goreleaser:
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
# Use the built-in CHARON_TOKEN by default for GitHub API operations.
|
||||
# If you need to provide a PAT with elevated permissions, add a CHARON_TOKEN secret
|
||||
# Use the built-in GITHUB_TOKEN by default for GitHub API operations.
|
||||
# If you need to provide a PAT with elevated permissions, add a GITHUB_TOKEN secret
|
||||
# at the repo or organization level and update the env here accordingly.
|
||||
CHARON_TOKEN: ${{ secrets.CHARON_TOKEN }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
|
||||
@@ -26,12 +26,12 @@ jobs:
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@4dc6199c7b1a012772edbd06daecab0f50c9053c # v6
|
||||
with:
|
||||
go-version: '1.25.5'
|
||||
go-version: '1.23.x'
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6
|
||||
with:
|
||||
node-version: '24.11.1'
|
||||
node-version: '20.x'
|
||||
|
||||
- name: Build Frontend
|
||||
working-directory: frontend
|
||||
@@ -47,7 +47,7 @@ jobs:
|
||||
with:
|
||||
version: 0.13.0
|
||||
|
||||
# CHARON_TOKEN is set from CHARON_TOKEN or CPMP_TOKEN (fallback), defaulting to GITHUB_TOKEN
|
||||
# GITHUB_TOKEN is set from GITHUB_TOKEN or CPMP_TOKEN (fallback), defaulting to GITHUB_TOKEN
|
||||
|
||||
|
||||
- name: Run GoReleaser
|
||||
@@ -56,4 +56,6 @@ jobs:
|
||||
distribution: goreleaser
|
||||
version: latest
|
||||
args: release --clean
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
# CGO settings are handled in .goreleaser.yaml via Zig
|
||||
|
||||
26
.github/workflows/renovate.yml
vendored
26
.github/workflows/renovate.yml
vendored
@@ -2,7 +2,7 @@ name: Renovate
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 5 * * *' # daily 05:00 EST
|
||||
- cron: '0 5 * * *' # daily 05:00 UTC
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
@@ -18,31 +18,11 @@ jobs:
|
||||
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
|
||||
with:
|
||||
fetch-depth: 1
|
||||
- name: Choose Renovate Token
|
||||
run: |
|
||||
# Prefer explicit tokens (CHARON_TOKEN > CPMP_TOKEN) if provided; otherwise use the default GITHUB_TOKEN
|
||||
if [ -n "${{ secrets.CHARON_TOKEN }}" ]; then
|
||||
echo "Using CHARON_TOKEN" >&2
|
||||
echo "GITHUB_TOKEN=${{ secrets.CHARON_TOKEN }}" >> $GITHUB_ENV
|
||||
elif [ -n "${{ secrets.CPMP_TOKEN }}" ]; then
|
||||
echo "Using CPMP_TOKEN fallback" >&2
|
||||
echo "GITHUB_TOKEN=${{ secrets.CPMP_TOKEN }}" >> $GITHUB_ENV
|
||||
else
|
||||
echo "Using default GITHUB_TOKEN from Actions" >&2
|
||||
echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_ENV
|
||||
fi
|
||||
|
||||
- name: Fail-fast if token not set
|
||||
run: |
|
||||
if [ -z "${{ env.GITHUB_TOKEN }}" ]; then
|
||||
echo "ERROR: No Renovate token provided. Set CHARON_TOKEN, CPMP_TOKEN, or rely on default GITHUB_TOKEN." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Run Renovate
|
||||
uses: renovatebot/github-action@5712c6a41dea6cdf32c72d92a763bd417e6606aa # v44.0.5
|
||||
uses: renovatebot/github-action@502904f1cefdd70cba026cb1cbd8c53a1443e91b # v44.1.0
|
||||
with:
|
||||
configurationFile: .github/renovate.json
|
||||
token: ${{ env.GITHUB_TOKEN }}
|
||||
token: ${{ secrets.RENOVATE_TOKEN }}
|
||||
env:
|
||||
LOG_LEVEL: info
|
||||
|
||||
10
.github/workflows/renovate_prune.yml
vendored
10
.github/workflows/renovate_prune.yml
vendored
@@ -24,17 +24,17 @@ jobs:
|
||||
steps:
|
||||
- name: Choose GitHub Token
|
||||
run: |
|
||||
if [ -n "${{ secrets.CHARON_TOKEN }}" ]; then
|
||||
echo "Using CHARON_TOKEN" >&2
|
||||
echo "CHARON_TOKEN=${{ secrets.CHARON_TOKEN }}" >> $GITHUB_ENV
|
||||
if [ -n "${{ secrets.GITHUB_TOKEN }}" ]; then
|
||||
echo "Using GITHUB_TOKEN" >&2
|
||||
echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_ENV
|
||||
else
|
||||
echo "Using CPMP_TOKEN fallback" >&2
|
||||
echo "CHARON_TOKEN=${{ secrets.CPMP_TOKEN }}" >> $GITHUB_ENV
|
||||
echo "GITHUB_TOKEN=${{ secrets.CPMP_TOKEN }}" >> $GITHUB_ENV
|
||||
fi
|
||||
- name: Prune renovate branches
|
||||
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
|
||||
with:
|
||||
github-token: ${{ env.CHARON_TOKEN }}
|
||||
github-token: ${{ env.GITHUB_TOKEN }}
|
||||
script: |
|
||||
const owner = context.repo.owner;
|
||||
const repo = context.repo.repo;
|
||||
|
||||
2
.github/workflows/repo-health.yml
vendored
2
.github/workflows/repo-health.yml
vendored
@@ -32,7 +32,7 @@ jobs:
|
||||
|
||||
- name: Upload health output
|
||||
if: always()
|
||||
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5
|
||||
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
|
||||
with:
|
||||
name: repo-health-output
|
||||
path: |
|
||||
|
||||
16
.gitignore
vendored
16
.gitignore
vendored
@@ -31,6 +31,10 @@ frontend/coverage/
|
||||
frontend/test-results/
|
||||
frontend/.vite/
|
||||
frontend/*.tsbuildinfo
|
||||
/frontend/.cache/
|
||||
/frontend/.eslintcache
|
||||
/backend/.vscode/
|
||||
/data/geoip/
|
||||
/frontend/frontend/
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
@@ -77,9 +81,7 @@ charon.db
|
||||
*~
|
||||
.DS_Store
|
||||
*.xcf
|
||||
.vscode/
|
||||
.vscode/launch.json
|
||||
.vscode.backup*/
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# Logs & Temp Files
|
||||
@@ -91,6 +93,9 @@ npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
nohup.out
|
||||
hub_index.json
|
||||
temp_index.json
|
||||
backend/temp_index.json
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# Environment Files
|
||||
@@ -111,6 +116,11 @@ backend/data/caddy/
|
||||
/data/
|
||||
/data/backups/
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# CrowdSec Runtime Data
|
||||
# -----------------------------------------------------------------------------
|
||||
*.key
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# Docker Overrides
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
19
.markdownlint.json
Normal file
19
.markdownlint.json
Normal file
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"default": true,
|
||||
"MD013": {
|
||||
"line_length": 120,
|
||||
"heading_line_length": 120,
|
||||
"code_block_line_length": 150,
|
||||
"tables": false
|
||||
},
|
||||
"MD024": {
|
||||
"siblings_only": true
|
||||
},
|
||||
"MD033": {
|
||||
"allowed_elements": ["details", "summary", "br", "sup", "sub", "kbd", "img"]
|
||||
},
|
||||
"MD041": false,
|
||||
"MD046": {
|
||||
"style": "fenced"
|
||||
}
|
||||
}
|
||||
@@ -114,3 +114,11 @@ repos:
|
||||
pass_filenames: false
|
||||
verbose: true
|
||||
stages: [manual] # Only runs when explicitly called
|
||||
|
||||
- repo: https://github.com/igorshubovych/markdownlint-cli
|
||||
rev: v0.43.0
|
||||
hooks:
|
||||
- id: markdownlint
|
||||
args: ["--fix"]
|
||||
exclude: '^(node_modules|\.venv|test-results|codeql-db|codeql-agent-results)/'
|
||||
stages: [manual]
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"githubPullRequests.ignoredPullRequestBranches": [
|
||||
"main"
|
||||
]
|
||||
}
|
||||
22
.vscode/launch.json
vendored
Normal file
22
.vscode/launch.json
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "Attach to Backend (Docker)",
|
||||
"type": "go",
|
||||
"request": "attach",
|
||||
"mode": "remote",
|
||||
"substitutePath": [
|
||||
{
|
||||
"from": "${workspaceFolder}",
|
||||
"to": "/app"
|
||||
}
|
||||
],
|
||||
"port": 2345,
|
||||
"host": "127.0.0.1",
|
||||
"showLog": true,
|
||||
"trace": "log",
|
||||
"logOutput": "rpc"
|
||||
}
|
||||
]
|
||||
}
|
||||
36
.vscode/settings.json
vendored
36
.vscode/settings.json
vendored
@@ -1,36 +0,0 @@
|
||||
{
|
||||
"gopls": {
|
||||
"staticcheck": true,
|
||||
"analyses": {
|
||||
"unusedparams": true,
|
||||
"nilness": true
|
||||
},
|
||||
"completeUnimported": true,
|
||||
"matcher": "Fuzzy",
|
||||
"verboseOutput": true
|
||||
},
|
||||
"go.useLanguageServer": true,
|
||||
"go.toolsEnvVars": {
|
||||
"GOMODCACHE": "${workspaceFolder}/.cache/go/pkg/mod"
|
||||
},
|
||||
"go.buildOnSave": "workspace",
|
||||
"go.lintOnSave": "package",
|
||||
"go.formatTool": "gofmt",
|
||||
"files.watcherExclude": {
|
||||
"**/pkg/mod/**": true,
|
||||
"**/go/pkg/mod/**": true,
|
||||
"**/root/go/pkg/mod/**": true,
|
||||
"**/backend/data/**": true,
|
||||
"**/frontend/dist/**": true
|
||||
},
|
||||
"search.exclude": {
|
||||
"**/pkg/mod/**": true,
|
||||
"**/go/pkg/mod/**": true,
|
||||
"**/root/go/pkg/mod/**": true
|
||||
},
|
||||
"githubPullRequests.ignoredPullRequestBranches": [
|
||||
"main"
|
||||
],
|
||||
// Toggle workspace-specific keybindings (used by .vscode/keybindings.json)
|
||||
"charon.workspaceKeybindingsEnabled": true
|
||||
}
|
||||
569
.vscode/tasks.json
vendored
569
.vscode/tasks.json
vendored
@@ -1,319 +1,252 @@
|
||||
{
|
||||
"version": "2.0.0",
|
||||
"tasks": [
|
||||
{
|
||||
"label": "Coraza: Run Integration Script",
|
||||
"type": "shell",
|
||||
"command": "bash",
|
||||
"args": ["./scripts/coraza_integration.sh"],
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Coraza: Run Integration Go Test",
|
||||
"type": "shell",
|
||||
"command": "sh",
|
||||
"args": ["-c", "cd backend && go test -tags=integration ./integration -run TestCorazaIntegration -v"],
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Go: Build Backend",
|
||||
"type": "shell",
|
||||
"command": "bash",
|
||||
"args": ["-lc", "cd backend && go build ./..."],
|
||||
"group": { "kind": "build", "isDefault": true },
|
||||
"presentation": { "reveal": "always", "panel": "shared" },
|
||||
"problemMatcher": ["$go"]
|
||||
},
|
||||
{
|
||||
"label": "Go: Test Backend",
|
||||
"type": "shell",
|
||||
"command": "bash",
|
||||
"args": ["-lc", "cd backend && go test ./... -v"],
|
||||
"group": "test",
|
||||
"presentation": { "reveal": "always", "panel": "shared" }
|
||||
},
|
||||
{
|
||||
"label": "Go: Mod Tidy (Backend)",
|
||||
"type": "shell",
|
||||
"command": "bash",
|
||||
"args": ["-lc", "cd backend && go mod tidy"],
|
||||
"presentation": { "reveal": "silent", "panel": "shared" }
|
||||
},
|
||||
{
|
||||
"label": "Gather gopls logs",
|
||||
"type": "shell",
|
||||
"command": "bash",
|
||||
"args": ["-lc", "./scripts/gopls_collect.sh"],
|
||||
"presentation": { "reveal": "always", "panel": "new" }
|
||||
},
|
||||
{
|
||||
"label": "Git Remove Cached",
|
||||
"type": "shell",
|
||||
"command": "git rm -r --cached .",
|
||||
"group": "test"
|
||||
},
|
||||
{
|
||||
"label": "Run Pre-commit (Staged Files)",
|
||||
"type": "shell",
|
||||
"command": "${workspaceFolder}/.venv/bin/pre-commit run",
|
||||
"group": "test"
|
||||
},
|
||||
// === MANUAL LINT/SCAN TASKS ===
|
||||
// These are the slow hooks removed from automatic pre-commit
|
||||
{
|
||||
"label": "Lint: GolangCI-Lint",
|
||||
"type": "shell",
|
||||
"command": "cd backend && docker run --rm -v $(pwd):/app:ro -w /app golangci/golangci-lint:latest golangci-lint run -v",
|
||||
"group": "test",
|
||||
"problemMatcher": ["$go"],
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "new"
|
||||
}
|
||||
},
|
||||
{
|
||||
"label": "Lint: Go Race Detector",
|
||||
"type": "shell",
|
||||
"command": "cd backend && go test -race ./...",
|
||||
"group": "test",
|
||||
"problemMatcher": ["$go"],
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "new"
|
||||
}
|
||||
},
|
||||
{
|
||||
"label": "Lint: Hadolint (Dockerfile)",
|
||||
"type": "shell",
|
||||
"command": "docker run --rm -i hadolint/hadolint < Dockerfile",
|
||||
"group": "test",
|
||||
"problemMatcher": [],
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "new"
|
||||
}
|
||||
},
|
||||
{
|
||||
"label": "Lint: Run All Manual Checks",
|
||||
"type": "shell",
|
||||
"command": "${workspaceFolder}/.venv/bin/pre-commit run --all-files --hook-stage manual",
|
||||
"group": "test",
|
||||
"problemMatcher": [],
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "new"
|
||||
}
|
||||
},
|
||||
// === BUILD & RUN TASKS ===
|
||||
{
|
||||
"label": "Build & Run Local Docker",
|
||||
"type": "shell",
|
||||
"command": "docker build --build-arg VCS_REF=$(git rev-parse HEAD) -t charon:local . && docker compose -f docker-compose.local.yml up -d",
|
||||
"group": "test"
|
||||
},
|
||||
{
|
||||
"label": "Run Local Docker (debug)",
|
||||
"type": "shell",
|
||||
"command": "docker run --rm -it --name charon-debug --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -p 8080:8080 -p 2345:2345 -e CHARON_ENV=development -e CHARON_DEBUG=1 charon:local",
|
||||
"group": "test"
|
||||
},
|
||||
{
|
||||
"label": "Run Trivy Scan (Local)",
|
||||
"type": "shell",
|
||||
"command": "docker",
|
||||
"args": [
|
||||
"run",
|
||||
"--rm",
|
||||
"-v",
|
||||
"/var/run/docker.sock:/var/run/docker.sock",
|
||||
"-v",
|
||||
"${userHome}/.cache/trivy:/root/.cache/trivy",
|
||||
"-v",
|
||||
"${workspaceFolder}/.trivy_logs:/logs",
|
||||
"aquasec/trivy:latest",
|
||||
"image",
|
||||
"--severity",
|
||||
"CRITICAL,HIGH",
|
||||
"--output",
|
||||
"/logs/trivy-report.txt",
|
||||
"charon:local"
|
||||
],
|
||||
"isBackground": false,
|
||||
"group": "test"
|
||||
},
|
||||
{
|
||||
"label": "Run CodeQL Scan (Local)",
|
||||
"type": "shell",
|
||||
"command": "${workspaceFolder}/tools/codeql_scan.sh",
|
||||
"group": "test"
|
||||
},
|
||||
{
|
||||
"label": "Run Security Scan (govulncheck)",
|
||||
"type": "shell",
|
||||
"command": "${workspaceFolder}/scripts/security-scan.sh",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Docker: Restart Local (No Rebuild)",
|
||||
"type": "shell",
|
||||
"command": "docker compose -f docker-compose.local.yml down && docker compose -f docker-compose.local.yml up -d",
|
||||
"group": "test",
|
||||
"isBackground": false,
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Docker: Stop Local",
|
||||
"type": "shell",
|
||||
"command": "docker compose -f docker-compose.local.yml down",
|
||||
"group": "test",
|
||||
"isBackground": false,
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Docker: Start Local (Already Built)",
|
||||
"type": "shell",
|
||||
"command": "docker compose -f docker-compose.local.yml up -d",
|
||||
"group": "test",
|
||||
"isBackground": false,
|
||||
"problemMatcher": []
|
||||
}
|
||||
,
|
||||
{
|
||||
"label": "Frontend: Type Check",
|
||||
"type": "shell",
|
||||
"command": "cd frontend && npm run type-check",
|
||||
"group": "test",
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "shared"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Backend: Go Test Coverage",
|
||||
"type": "shell",
|
||||
"command": "bash -c 'scripts/go-test-coverage.sh'",
|
||||
"group": "test",
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "shared"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Frontend: Test Coverage",
|
||||
"type": "shell",
|
||||
"command": "bash -c 'scripts/frontend-test-coverage.sh'",
|
||||
"group": "test",
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "shared"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Backend: Run Benchmarks",
|
||||
"type": "shell",
|
||||
"command": "cd backend && go test -bench=. -benchmem -benchtime=1s ./internal/api/handlers/... -run=^$",
|
||||
"group": "test",
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "new"
|
||||
},
|
||||
"problemMatcher": ["$go"]
|
||||
},
|
||||
{
|
||||
"label": "Backend: Run Benchmarks (Quick)",
|
||||
"type": "shell",
|
||||
"command": "cd backend && go test -bench=GetStatus -benchmem -benchtime=500ms ./internal/api/handlers/... -run=^$",
|
||||
"group": "test",
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "new"
|
||||
},
|
||||
"problemMatcher": ["$go"]
|
||||
},
|
||||
{
|
||||
"label": "Backend: Run Perf Asserts",
|
||||
"type": "shell",
|
||||
"command": "cd backend && go test -run TestPerf -v ./internal/api/handlers -count=1",
|
||||
"group": "test",
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "new"
|
||||
},
|
||||
"problemMatcher": ["$go"]
|
||||
}
|
||||
,
|
||||
{
|
||||
"label": "Frontend: Lint Fix",
|
||||
"type": "shell",
|
||||
"command": "cd frontend && npm run lint -- --fix",
|
||||
"group": "test",
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "shared"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Lint: GolangCI-Lint Fix",
|
||||
"type": "shell",
|
||||
"command": "cd backend && docker run --rm -v $(pwd):/app:rw -w /app golangci/golangci-lint:latest golangci-lint run --fix -v",
|
||||
"group": "test",
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "new"
|
||||
},
|
||||
"problemMatcher": ["$go"]
|
||||
},
|
||||
{
|
||||
"label": "Frontend: Run All Tests & Scans",
|
||||
"dependsOn": [
|
||||
"Frontend: Type Check",
|
||||
"Frontend: Test Coverage",
|
||||
"Run CodeQL Scan (Local)"
|
||||
],
|
||||
"dependsOrder": "sequence",
|
||||
"group": "test",
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "shared"
|
||||
}
|
||||
},
|
||||
{
|
||||
"label": "Backend: Run All Tests & Scans",
|
||||
"dependsOn": [
|
||||
"Backend: Go Test Coverage",
|
||||
"Backend: Run Benchmarks (Quick)",
|
||||
"Run Security Scan (govulncheck)",
|
||||
"Lint: GolangCI-Lint",
|
||||
"Lint: Go Race Detector"
|
||||
],
|
||||
"dependsOrder": "sequence",
|
||||
"group": "test",
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "new"
|
||||
}
|
||||
},
|
||||
{
|
||||
"label": "Lint: Apply Fixes",
|
||||
"dependsOn": [
|
||||
"Frontend: Lint Fix",
|
||||
"Lint: GolangCI-Lint Fix",
|
||||
"Lint: Hadolint (Dockerfile)",
|
||||
"Run Pre-commit (Staged Files)"
|
||||
],
|
||||
"dependsOrder": "sequence",
|
||||
"group": "test",
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "new"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
"version": "2.0.0",
|
||||
"tasks": [
|
||||
{
|
||||
"label": "Build: Local Docker Image",
|
||||
"type": "shell",
|
||||
"command": "docker build -t charon:local .",
|
||||
"group": "build",
|
||||
"problemMatcher": [],
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "new"
|
||||
}
|
||||
},
|
||||
{
|
||||
"label": "Build: Backend",
|
||||
"type": "shell",
|
||||
"command": "cd backend && go build ./...",
|
||||
"group": "build",
|
||||
"problemMatcher": ["$go"]
|
||||
},
|
||||
{
|
||||
"label": "Build: Frontend",
|
||||
"type": "shell",
|
||||
"command": "cd frontend && npm run build",
|
||||
"group": "build",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Build: All",
|
||||
"type": "shell",
|
||||
"dependsOn": ["Build: Backend", "Build: Frontend"],
|
||||
"group": {
|
||||
"kind": "build",
|
||||
"isDefault": true
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Test: Backend Unit Tests",
|
||||
"type": "shell",
|
||||
"command": "cd backend && go test ./...",
|
||||
"group": "test",
|
||||
"problemMatcher": ["$go"]
|
||||
},
|
||||
{
|
||||
"label": "Test: Backend with Coverage",
|
||||
"type": "shell",
|
||||
"command": "scripts/go-test-coverage.sh",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Test: Frontend",
|
||||
"type": "shell",
|
||||
"command": "cd frontend && npm run test",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Test: Frontend with Coverage",
|
||||
"type": "shell",
|
||||
"command": "scripts/frontend-test-coverage.sh",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Lint: Pre-commit (All Files)",
|
||||
"type": "shell",
|
||||
"command": "source .venv/bin/activate && pre-commit run --all-files",
|
||||
"group": "test",
|
||||
"problemMatcher": [],
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "shared"
|
||||
}
|
||||
},
|
||||
{
|
||||
"label": "Lint: Go Vet",
|
||||
"type": "shell",
|
||||
"command": "cd backend && go vet ./...",
|
||||
"group": "test",
|
||||
"problemMatcher": ["$go"]
|
||||
},
|
||||
{
|
||||
"label": "Lint: GolangCI-Lint (Docker)",
|
||||
"type": "shell",
|
||||
"command": "cd backend && docker run --rm -v $(pwd):/app:ro -w /app golangci/golangci-lint:latest golangci-lint run -v",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Lint: Frontend",
|
||||
"type": "shell",
|
||||
"command": "cd frontend && npm run lint",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Lint: Frontend (Fix)",
|
||||
"type": "shell",
|
||||
"command": "cd frontend && npm run lint -- --fix",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Lint: TypeScript Check",
|
||||
"type": "shell",
|
||||
"command": "cd frontend && npm run type-check",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Lint: Markdownlint",
|
||||
"type": "shell",
|
||||
"command": "npx markdownlint '**/*.md' --ignore node_modules --ignore .venv --ignore test-results --ignore codeql-db --ignore codeql-agent-results",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Lint: Markdownlint (Fix)",
|
||||
"type": "shell",
|
||||
"command": "npx markdownlint '**/*.md' --fix --ignore node_modules --ignore .venv --ignore test-results --ignore codeql-db --ignore codeql-agent-results",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Lint: Hadolint Dockerfile",
|
||||
"type": "shell",
|
||||
"command": "docker run --rm -i hadolint/hadolint < Dockerfile",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Security: Trivy Scan",
|
||||
"type": "shell",
|
||||
"command": "docker run --rm -v $(pwd):/app aquasec/trivy:latest fs --scanners vuln,secret,misconfig /app",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Security: Go Vulnerability Check",
|
||||
"type": "shell",
|
||||
"command": "cd backend && go run golang.org/x/vuln/cmd/govulncheck@latest ./...",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Docker: Start Dev Environment",
|
||||
"type": "shell",
|
||||
"command": "docker compose -f docker-compose.dev.yml up -d",
|
||||
"group": "none",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Docker: Stop Dev Environment",
|
||||
"type": "shell",
|
||||
"command": "docker compose -f docker-compose.dev.yml down",
|
||||
"group": "none",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Docker: Start Local Environment",
|
||||
"type": "shell",
|
||||
"command": "docker compose -f docker-compose.local.yml up -d",
|
||||
"group": "none",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Docker: Stop Local Environment",
|
||||
"type": "shell",
|
||||
"command": "docker compose -f docker-compose.local.yml down",
|
||||
"group": "none",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Docker: View Logs",
|
||||
"type": "shell",
|
||||
"command": "docker compose logs -f",
|
||||
"group": "none",
|
||||
"problemMatcher": [],
|
||||
"isBackground": true
|
||||
},
|
||||
{
|
||||
"label": "Docker: Prune Unused Resources",
|
||||
"type": "shell",
|
||||
"command": "docker system prune -f",
|
||||
"group": "none",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Integration: Run All",
|
||||
"type": "shell",
|
||||
"command": "scripts/integration-test.sh",
|
||||
"group": "test",
|
||||
"problemMatcher": [],
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "new"
|
||||
}
|
||||
},
|
||||
{
|
||||
"label": "Integration: Coraza WAF",
|
||||
"type": "shell",
|
||||
"command": "scripts/coraza_integration.sh",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Integration: CrowdSec",
|
||||
"type": "shell",
|
||||
"command": "scripts/crowdsec_integration.sh",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Integration: CrowdSec Decisions",
|
||||
"type": "shell",
|
||||
"command": "scripts/crowdsec_decision_integration.sh",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Integration: CrowdSec Startup",
|
||||
"type": "shell",
|
||||
"command": "scripts/crowdsec_startup_test.sh",
|
||||
"group": "test",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Utility: Check Version Match Tag",
|
||||
"type": "shell",
|
||||
"command": "scripts/check-version-match-tag.sh",
|
||||
"group": "none",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Utility: Clear Go Cache",
|
||||
"type": "shell",
|
||||
"command": "scripts/clear-go-cache.sh",
|
||||
"group": "none",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Utility: Bump Beta Version",
|
||||
"type": "shell",
|
||||
"command": "scripts/bump_beta.sh",
|
||||
"group": "none",
|
||||
"problemMatcher": []
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,95 +0,0 @@
|
||||
# ACME Staging Implementation Summary
|
||||
|
||||
## What Was Added
|
||||
|
||||
Added support for Let's Encrypt staging environment to prevent rate limiting during development and testing.
|
||||
|
||||
## Changes Made
|
||||
|
||||
### 1. Configuration (`backend/internal/config/config.go`)
|
||||
- Added `ACMEStaging bool` field to `Config` struct
|
||||
- Reads from `CHARON_ACME_STAGING` environment variable (legacy `CPM_ACME_STAGING` still supported)
|
||||
|
||||
### 2. Caddy Manager (`backend/internal/caddy/manager.go`)
|
||||
- Added `acmeStaging bool` field to `Manager` struct
|
||||
- Updated `NewManager()` to accept `acmeStaging` parameter
|
||||
- Passes `acmeStaging` to `GenerateConfig()`
|
||||
|
||||
### 3. Config Generation (`backend/internal/caddy/config.go`)
|
||||
- Updated `GenerateConfig()` signature to accept `acmeStaging bool`
|
||||
- When `acmeStaging=true`:
|
||||
- Sets `ca` field to `https://acme-staging-v02.api.letsencrypt.org/directory`
|
||||
- Applies to both "letsencrypt" and "both" SSL provider modes
|
||||
|
||||
### 4. Route Registration (`backend/internal/api/routes/routes.go`)
|
||||
- Passes `cfg.ACMEStaging` to `caddy.NewManager()`
|
||||
|
||||
### 5. Docker Compose (`docker-compose.local.yml`)
|
||||
- Added `CHARON_ACME_STAGING=true` environment variable for local development (legacy `CPM_ACME_STAGING` still supported)
|
||||
|
||||
### 6. Tests
|
||||
- Updated all test files to pass new `acmeStaging` parameter
|
||||
- Added `TestGenerateConfig_ACMEStaging()` to verify behavior
|
||||
- All tests pass ✅
|
||||
|
||||
### 7. Documentation
|
||||
- Created `/docs/acme-staging.md` - comprehensive guide
|
||||
- Updated `/docs/getting-started.md` - added environment variables section
|
||||
- Explained rate limits, staging vs production, and troubleshooting
|
||||
|
||||
## Usage
|
||||
|
||||
### Development (Avoid Rate Limits)
|
||||
```bash
|
||||
docker run -d \
|
||||
-e CHARON_ACME_STAGING=true \
|
||||
-p 8080:8080 \
|
||||
ghcr.io/wikid82/charon:latest
|
||||
```
|
||||
|
||||
### Production (Real Certificates)
|
||||
```bash
|
||||
docker run -d \
|
||||
-p 8080:8080 \
|
||||
ghcr.io/wikid82/charon:latest
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
Container logs confirm staging is active:
|
||||
```
|
||||
"ca":"https://acme-staging-v02.api.letsencrypt.org/directory"
|
||||
```
|
||||
|
||||
## Benefits
|
||||
|
||||
1. **No Rate Limits**: Test certificate issuance without hitting Let's Encrypt limits
|
||||
2. **Safe Testing**: Won't affect production certificate quotas
|
||||
3. **Easy Toggle**: Single environment variable to switch modes
|
||||
4. **Default Production**: Staging must be explicitly enabled
|
||||
5. **Well Documented**: Clear guides for users and developers
|
||||
|
||||
## Test Results
|
||||
|
||||
- ✅ All backend tests pass (`go test ./...`)
|
||||
- ✅ Config generation tests verify staging CA is set
|
||||
- ✅ Manager tests updated and passing
|
||||
- ✅ Handler tests updated and passing
|
||||
- ✅ Integration verified in running container
|
||||
|
||||
## Files Modified
|
||||
|
||||
- `backend/internal/config/config.go`
|
||||
- `backend/internal/caddy/config.go`
|
||||
- `backend/internal/caddy/manager.go`
|
||||
- `backend/internal/api/routes/routes.go`
|
||||
- `backend/internal/caddy/config_test.go`
|
||||
- `backend/internal/caddy/manager_test.go`
|
||||
- `backend/internal/caddy/client_test.go`
|
||||
- `backend/internal/api/handlers/proxy_host_handler_test.go`
|
||||
- `docker-compose.local.yml`
|
||||
|
||||
## Files Created
|
||||
|
||||
- `docs/acme-staging.md` - User guide
|
||||
- `ACME_STAGING_IMPLEMENTATION.md` - This summary
|
||||
@@ -1,16 +1,19 @@
|
||||
# Bulk ACL Application Feature
|
||||
|
||||
## Overview
|
||||
|
||||
Implemented a bulk ACL (Access Control List) application feature that allows users to quickly apply or remove access lists from multiple proxy hosts at once, eliminating the need to edit each host individually.
|
||||
|
||||
## User Workflow Improvements
|
||||
|
||||
### Previous Workflow (Manual)
|
||||
|
||||
1. Create proxy hosts
|
||||
2. Create access list
|
||||
3. **Edit each host individually** to apply the ACL (tedious for many hosts)
|
||||
|
||||
### New Workflow (Bulk)
|
||||
|
||||
1. Create proxy hosts
|
||||
2. Create access list
|
||||
3. **Select multiple hosts** → Bulk Actions → Apply/Remove ACL (one operation)
|
||||
@@ -22,6 +25,7 @@ Implemented a bulk ACL (Access Control List) application feature that allows use
|
||||
**New Endpoint**: `PUT /api/v1/proxy-hosts/bulk-update-acl`
|
||||
|
||||
**Request Body**:
|
||||
|
||||
```json
|
||||
{
|
||||
"host_uuids": ["uuid-1", "uuid-2", "uuid-3"],
|
||||
@@ -30,6 +34,7 @@ Implemented a bulk ACL (Access Control List) application feature that allows use
|
||||
```
|
||||
|
||||
**Response**:
|
||||
|
||||
```json
|
||||
{
|
||||
"updated": 2,
|
||||
@@ -40,6 +45,7 @@ Implemented a bulk ACL (Access Control List) application feature that allows use
|
||||
```
|
||||
|
||||
**Features**:
|
||||
|
||||
- Updates multiple hosts in a single database transaction
|
||||
- Applies Caddy config once for all updates (efficient)
|
||||
- Partial failure handling (returns both successes and errors)
|
||||
@@ -49,6 +55,7 @@ Implemented a bulk ACL (Access Control List) application feature that allows use
|
||||
### Frontend
|
||||
|
||||
#### API Client (`frontend/src/api/proxyHosts.ts`)
|
||||
|
||||
```typescript
|
||||
export const bulkUpdateACL = async (
|
||||
hostUUIDs: string[],
|
||||
@@ -57,6 +64,7 @@ export const bulkUpdateACL = async (
|
||||
```
|
||||
|
||||
#### React Query Hook (`frontend/src/hooks/useProxyHosts.ts`)
|
||||
|
||||
```typescript
|
||||
const { bulkUpdateACL, isBulkUpdating } = useProxyHosts()
|
||||
|
||||
@@ -68,16 +76,19 @@ await bulkUpdateACL(['uuid-1', 'uuid-2'], null) // Remove ACL
|
||||
#### UI Components (`frontend/src/pages/ProxyHosts.tsx`)
|
||||
|
||||
**Multi-Select Checkboxes**:
|
||||
|
||||
- Checkbox column added to proxy hosts table
|
||||
- "Select All" checkbox in table header
|
||||
- Individual checkboxes per row
|
||||
|
||||
**Bulk Actions UI**:
|
||||
|
||||
- "Bulk Actions" button appears when hosts are selected
|
||||
- Shows count of selected hosts
|
||||
- Opens modal with ACL selection dropdown
|
||||
|
||||
**Modal Features**:
|
||||
|
||||
- Lists all enabled access lists
|
||||
- "Remove Access List" option (sets null)
|
||||
- Real-time feedback on success/failure
|
||||
@@ -86,6 +97,7 @@ await bulkUpdateACL(['uuid-1', 'uuid-2'], null) // Remove ACL
|
||||
## Testing
|
||||
|
||||
### Backend Tests (`proxy_host_handler_test.go`)
|
||||
|
||||
- ✅ `TestProxyHostHandler_BulkUpdateACL_Success` - Apply ACL to multiple hosts
|
||||
- ✅ `TestProxyHostHandler_BulkUpdateACL_RemoveACL` - Remove ACL (null value)
|
||||
- ✅ `TestProxyHostHandler_BulkUpdateACL_PartialFailure` - Mixed success/failure
|
||||
@@ -93,7 +105,9 @@ await bulkUpdateACL(['uuid-1', 'uuid-2'], null) // Remove ACL
|
||||
- ✅ `TestProxyHostHandler_BulkUpdateACL_InvalidJSON` - Malformed request
|
||||
|
||||
### Frontend Tests
|
||||
|
||||
**API Tests** (`proxyHosts-bulk.test.ts`):
|
||||
|
||||
- ✅ Apply ACL to multiple hosts
|
||||
- ✅ Remove ACL with null value
|
||||
- ✅ Handle partial failures
|
||||
@@ -101,6 +115,7 @@ await bulkUpdateACL(['uuid-1', 'uuid-2'], null) // Remove ACL
|
||||
- ✅ Propagate API errors
|
||||
|
||||
**Hook Tests** (`useProxyHosts-bulk.test.tsx`):
|
||||
|
||||
- ✅ Apply ACL via mutation
|
||||
- ✅ Remove ACL via mutation
|
||||
- ✅ Query invalidation after success
|
||||
@@ -108,12 +123,14 @@ await bulkUpdateACL(['uuid-1', 'uuid-2'], null) // Remove ACL
|
||||
- ✅ Loading state tracking
|
||||
|
||||
**Test Results**:
|
||||
|
||||
- Backend: All tests passing (106+ tests)
|
||||
- Frontend: All tests passing (132 tests)
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Example 1: Apply ACL to Multiple Hosts
|
||||
|
||||
```typescript
|
||||
// Select hosts in UI
|
||||
setSelectedHosts(new Set(['host-1-uuid', 'host-2-uuid', 'host-3-uuid']))
|
||||
@@ -125,6 +142,7 @@ await bulkUpdateACL(['host-1-uuid', 'host-2-uuid', 'host-3-uuid'], 5)
|
||||
```
|
||||
|
||||
### Example 2: Remove ACL from Hosts
|
||||
|
||||
```typescript
|
||||
// User selects "Remove Access List" from dropdown
|
||||
await bulkUpdateACL(['host-1-uuid', 'host-2-uuid'], null)
|
||||
@@ -133,6 +151,7 @@ await bulkUpdateACL(['host-1-uuid', 'host-2-uuid'], null)
|
||||
```
|
||||
|
||||
### Example 3: Partial Failure Handling
|
||||
|
||||
```typescript
|
||||
const result = await bulkUpdateACL(['valid-uuid', 'invalid-uuid'], 10)
|
||||
|
||||
@@ -164,10 +183,12 @@ const result = await bulkUpdateACL(['valid-uuid', 'invalid-uuid'], 10)
|
||||
## Related Files Modified
|
||||
|
||||
### Backend
|
||||
|
||||
- `backend/internal/api/handlers/proxy_host_handler.go` (+73 lines)
|
||||
- `backend/internal/api/handlers/proxy_host_handler_test.go` (+140 lines)
|
||||
|
||||
### Frontend
|
||||
|
||||
- `frontend/src/api/proxyHosts.ts` (+19 lines)
|
||||
- `frontend/src/hooks/useProxyHosts.ts` (+11 lines)
|
||||
- `frontend/src/pages/ProxyHosts.tsx` (+95 lines)
|
||||
|
||||
@@ -35,12 +35,14 @@ This project follows a Code of Conduct that all contributors are expected to adh
|
||||
|
||||
1. Fork the repository on GitHub
|
||||
2. Clone your fork locally:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/YOUR_USERNAME/charon.git
|
||||
cd charon
|
||||
```
|
||||
|
||||
3. Add the upstream remote:
|
||||
|
||||
```bash
|
||||
git remote add upstream https://github.com/Wikid82/charon.git
|
||||
```
|
||||
@@ -48,6 +50,7 @@ git remote add upstream https://github.com/Wikid82/charon.git
|
||||
### Set Up Development Environment
|
||||
|
||||
**Backend:**
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
go mod download
|
||||
@@ -56,6 +59,7 @@ go run ./cmd/api/main.go # Start backend
|
||||
```
|
||||
|
||||
**Frontend:**
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
@@ -95,6 +99,7 @@ Follow the [Conventional Commits](https://www.conventionalcommits.org/) specific
|
||||
```
|
||||
|
||||
**Types:**
|
||||
|
||||
- `feat`: New feature
|
||||
- `fix`: Bug fix
|
||||
- `docs`: Documentation only
|
||||
@@ -104,6 +109,7 @@ Follow the [Conventional Commits](https://www.conventionalcommits.org/) specific
|
||||
- `chore`: Maintenance tasks
|
||||
|
||||
**Examples:**
|
||||
|
||||
```
|
||||
feat(proxy-hosts): add SSL certificate upload
|
||||
|
||||
@@ -143,6 +149,7 @@ git push origin development
|
||||
- Handle errors explicitly
|
||||
|
||||
**Example:**
|
||||
|
||||
```go
|
||||
// GetProxyHost retrieves a proxy host by UUID.
|
||||
// Returns an error if the host is not found.
|
||||
@@ -164,6 +171,7 @@ func GetProxyHost(uuid string) (*models.ProxyHost, error) {
|
||||
- Extract reusable logic into custom hooks
|
||||
|
||||
**Example:**
|
||||
|
||||
```typescript
|
||||
interface ProxyHostFormProps {
|
||||
host?: ProxyHost
|
||||
@@ -206,6 +214,7 @@ func TestGetProxyHost(t *testing.T) {
|
||||
```
|
||||
|
||||
**Run tests:**
|
||||
|
||||
```bash
|
||||
go test ./... -v
|
||||
go test -cover ./...
|
||||
@@ -230,6 +239,7 @@ describe('ProxyHostForm', () => {
|
||||
```
|
||||
|
||||
**Run tests:**
|
||||
|
||||
```bash
|
||||
npm test # Watch mode
|
||||
npm run test:coverage # Coverage report
|
||||
@@ -246,6 +256,7 @@ npm run test:coverage # Coverage report
|
||||
### Before Submitting
|
||||
|
||||
1. **Ensure tests pass:**
|
||||
|
||||
```bash
|
||||
# Backend
|
||||
go test ./...
|
||||
@@ -255,6 +266,7 @@ npm test -- --run
|
||||
```
|
||||
|
||||
2. **Check code quality:**
|
||||
|
||||
```bash
|
||||
# Go formatting
|
||||
go fmt ./...
|
||||
@@ -270,6 +282,7 @@ npm run lint
|
||||
### Submitting a Pull Request
|
||||
|
||||
1. Push your branch to your fork:
|
||||
|
||||
```bash
|
||||
git push origin feature/your-feature-name
|
||||
```
|
||||
|
||||
70
DOCKER.md
70
DOCKER.md
@@ -19,9 +19,10 @@ open http://localhost:8080
|
||||
## Architecture
|
||||
|
||||
Charon runs as a **single container** that includes:
|
||||
1. **Caddy Server**: The reverse proxy engine (ports 80/443).
|
||||
2. **Charon Backend**: The Go API that manages Caddy via its API (binary: `charon`, `cpmp` symlink preserved).
|
||||
3. **Charon Frontend**: The React web interface (port 8080).
|
||||
|
||||
1. **Caddy Server**: The reverse proxy engine (ports 80/443).
|
||||
2. **Charon Backend**: The Go API that manages Caddy via its API (binary: `charon`, `cpmp` symlink preserved).
|
||||
3. **Charon Frontend**: The React web interface (port 8080).
|
||||
|
||||
This unified architecture simplifies deployment, updates, and data management.
|
||||
|
||||
@@ -67,35 +68,35 @@ Configure the application via `docker-compose.yml`:
|
||||
|
||||
### Synology (Container Manager / Docker)
|
||||
|
||||
1. **Prepare Folders**: Create a folder `docker/charon` (or `docker/cpmp` for backward compatibility) and subfolders `data`, `caddy_data`, and `caddy_config`.
|
||||
2. **Download Image**: Search for `ghcr.io/wikid82/charon` in the Registry and download the `latest` tag.
|
||||
3. **Launch Container**:
|
||||
* **Network**: Use `Host` mode (recommended for Caddy to see real client IPs) OR bridge mode mapping ports `80:80`, `443:443`, and `8080:8080`.
|
||||
* **Volume Settings**:
|
||||
* `/docker/charon/data` -> `/app/data` (or `/docker/cpmp/data` -> `/app/data` for backward compatibility)
|
||||
* `/docker/charon/caddy_data` -> `/data` (or `/docker/cpmp/caddy_data` -> `/data` for backward compatibility)
|
||||
* `/docker/charon/caddy_config` -> `/config` (or `/docker/cpmp/caddy_config` -> `/config` for backward compatibility)
|
||||
* **Environment**: Add `CHARON_ENV=production` (or `CPM_ENV=production` for backward compatibility).
|
||||
4. **Finish**: Start the container and access `http://YOUR_NAS_IP:8080`.
|
||||
1. **Prepare Folders**: Create a folder `docker/charon` (or `docker/cpmp` for backward compatibility) and subfolders `data`, `caddy_data`, and `caddy_config`.
|
||||
2. **Download Image**: Search for `ghcr.io/wikid82/charon` in the Registry and download the `latest` tag.
|
||||
3. **Launch Container**:
|
||||
* **Network**: Use `Host` mode (recommended for Caddy to see real client IPs) OR bridge mode mapping ports `80:80`, `443:443`, and `8080:8080`.
|
||||
* **Volume Settings**:
|
||||
* `/docker/charon/data` -> `/app/data` (or `/docker/cpmp/data` -> `/app/data` for backward compatibility)
|
||||
* `/docker/charon/caddy_data` -> `/data` (or `/docker/cpmp/caddy_data` -> `/data` for backward compatibility)
|
||||
* `/docker/charon/caddy_config` -> `/config` (or `/docker/cpmp/caddy_config` -> `/config` for backward compatibility)
|
||||
* **Environment**: Add `CHARON_ENV=production` (or `CPM_ENV=production` for backward compatibility).
|
||||
4. **Finish**: Start the container and access `http://YOUR_NAS_IP:8080`.
|
||||
|
||||
### Unraid
|
||||
|
||||
1. **Community Apps**: (Coming Soon) Search for "charon".
|
||||
2. **Manual Install**:
|
||||
* Click **Add Container**.
|
||||
* **Name**: Charon
|
||||
* **Repository**: `ghcr.io/wikid82/charon:latest`
|
||||
* **Network Type**: Bridge
|
||||
* **WebUI**: `http://[IP]:[PORT:8080]`
|
||||
* **Port mappings**:
|
||||
* Container Port: `80` -> Host Port: `80`
|
||||
* Container Port: `443` -> Host Port: `443`
|
||||
* Container Port: `8080` -> Host Port: `8080`
|
||||
* **Paths**:
|
||||
* `/mnt/user/appdata/charon/data` -> `/app/data` (or `/mnt/user/appdata/cpmp/data` -> `/app/data` for backward compatibility)
|
||||
* `/mnt/user/appdata/charon/caddy_data` -> `/data` (or `/mnt/user/appdata/cpmp/caddy_data` -> `/data` for backward compatibility)
|
||||
* `/mnt/user/appdata/charon/caddy_config` -> `/config` (or `/mnt/user/appdata/cpmp/caddy_config` -> `/config` for backward compatibility)
|
||||
3. **Apply**: Click Done to pull and start.
|
||||
1. **Community Apps**: (Coming Soon) Search for "charon".
|
||||
2. **Manual Install**:
|
||||
* Click **Add Container**.
|
||||
* **Name**: Charon
|
||||
* **Repository**: `ghcr.io/wikid82/charon:latest`
|
||||
* **Network Type**: Bridge
|
||||
* **WebUI**: `http://[IP]:[PORT:8080]`
|
||||
* **Port mappings**:
|
||||
* Container Port: `80` -> Host Port: `80`
|
||||
* Container Port: `443` -> Host Port: `443`
|
||||
* Container Port: `8080` -> Host Port: `8080`
|
||||
* **Paths**:
|
||||
* `/mnt/user/appdata/charon/data` -> `/app/data` (or `/mnt/user/appdata/cpmp/data` -> `/app/data` for backward compatibility)
|
||||
* `/mnt/user/appdata/charon/caddy_data` -> `/data` (or `/mnt/user/appdata/cpmp/caddy_data` -> `/data` for backward compatibility)
|
||||
* `/mnt/user/appdata/charon/caddy_config` -> `/config` (or `/mnt/user/appdata/cpmp/caddy_config` -> `/config` for backward compatibility)
|
||||
3. **Apply**: Click Done to pull and start.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
@@ -104,6 +105,7 @@ Configure the application via `docker-compose.yml`:
|
||||
**Symptom**: "Caddy unreachable" errors in logs
|
||||
|
||||
**Solution**: Since both run in the same container, this usually means Caddy failed to start. Check logs:
|
||||
|
||||
```bash
|
||||
docker-compose logs app
|
||||
```
|
||||
@@ -113,6 +115,7 @@ docker-compose logs app
|
||||
**Symptom**: HTTP works but HTTPS fails
|
||||
|
||||
**Check**:
|
||||
|
||||
1. Port 80/443 are accessible from the internet
|
||||
2. DNS points to your server
|
||||
3. Caddy logs: `docker-compose logs app | grep -i acme`
|
||||
@@ -122,6 +125,7 @@ docker-compose logs app
|
||||
**Symptom**: Changes in UI don't affect routing
|
||||
|
||||
**Debug**:
|
||||
|
||||
```bash
|
||||
# View current Caddy config
|
||||
curl http://localhost:2019/config/ | jq
|
||||
@@ -197,7 +201,7 @@ services:
|
||||
|
||||
## Next Steps
|
||||
|
||||
- Configure your first proxy host via UI
|
||||
- Enable automatic HTTPS (happens automatically)
|
||||
- Add authentication (Issue #7)
|
||||
- Integrate CrowdSec (Issue #15)
|
||||
* Configure your first proxy host via UI
|
||||
* Enable automatic HTTPS (happens automatically)
|
||||
* Add authentication (Issue #7)
|
||||
* Integrate CrowdSec (Issue #15)
|
||||
|
||||
@@ -1,76 +0,0 @@
|
||||
# Docker Development Tasks
|
||||
|
||||
Quick reference for Docker container management during development.
|
||||
|
||||
## Available VS Code Tasks
|
||||
|
||||
### Build & Run Local Docker
|
||||
**Command:** `Build & Run Local Docker`
|
||||
- Builds the Docker image from scratch with current code
|
||||
- Tags as `charon:local`
|
||||
- Starts container with docker-compose.local.yml
|
||||
- **Use when:** You've made backend code changes that need recompiling
|
||||
|
||||
### Docker: Restart Local (No Rebuild) ⚡
|
||||
**Command:** `Docker: Restart Local (No Rebuild)`
|
||||
- Stops the running container
|
||||
- Starts it back up using existing image
|
||||
- **Use when:** You've changed volume mounts, environment variables, or want to clear runtime state
|
||||
- **Fastest option** for testing volume mount changes
|
||||
|
||||
### Docker: Stop Local
|
||||
**Command:** `Docker: Stop Local`
|
||||
- Stops and removes the running container
|
||||
- Preserves volumes and image
|
||||
- **Use when:** You need to stop the container temporarily
|
||||
|
||||
### Docker: Start Local (Already Built)
|
||||
**Command:** `Docker: Start Local (Already Built)`
|
||||
- Starts container from existing image
|
||||
- **Use when:** Container is stopped but image is built
|
||||
|
||||
## Manual Commands
|
||||
|
||||
```bash
|
||||
# Build and run (full rebuild)
|
||||
docker build --build-arg VCS_REF=$(git rev-parse HEAD) -t charon:local . && \
|
||||
docker compose -f docker-compose.local.yml up -d
|
||||
|
||||
# Quick restart (no rebuild) - FASTEST for volume mount testing
|
||||
docker compose -f docker-compose.local.yml down && \
|
||||
docker compose -f docker-compose.local.yml up -d
|
||||
|
||||
# View logs
|
||||
docker logs -f charon-debug
|
||||
|
||||
# Stop container
|
||||
docker compose -f docker-compose.local.yml down
|
||||
|
||||
# Start existing container
|
||||
docker compose -f docker-compose.local.yml up -d
|
||||
```
|
||||
|
||||
## Testing Import Feature
|
||||
|
||||
The import feature uses a mounted Caddyfile at `/import/Caddyfile` inside the container.
|
||||
|
||||
**Volume mount in docker-compose.local.yml:**
|
||||
```yaml
|
||||
- /root/docker/containers/caddy/Caddyfile:/import/Caddyfile:ro
|
||||
- /root/docker/containers/caddy/sites:/import/sites:ro
|
||||
```
|
||||
|
||||
**To test import with different Caddyfiles:**
|
||||
1. Edit `/root/docker/containers/caddy/Caddyfile` on the host
|
||||
2. Run task: `Docker: Restart Local (No Rebuild)` ⚡
|
||||
3. Check GUI - import should detect the mounted Caddyfile
|
||||
4. No rebuild needed!
|
||||
|
||||
## Coverage Requirement
|
||||
|
||||
All code changes must maintain **≥80% test coverage**.
|
||||
|
||||
Run coverage check:
|
||||
```bash
|
||||
cd backend && bash ../scripts/go-test-coverage.sh
|
||||
```
|
||||
89
Dockerfile
89
Dockerfile
@@ -25,7 +25,7 @@ FROM --platform=$BUILDPLATFORM tonistiigi/xx:1.9.0 AS xx
|
||||
|
||||
# ---- Frontend Builder ----
|
||||
# Build the frontend using the BUILDPLATFORM to avoid arm64 musl Rollup native issues
|
||||
FROM --platform=$BUILDPLATFORM node:24.11.1-alpine AS frontend-builder
|
||||
FROM --platform=$BUILDPLATFORM node:24.12.0-alpine AS frontend-builder
|
||||
WORKDIR /app/frontend
|
||||
|
||||
# Copy frontend package files
|
||||
@@ -158,13 +158,56 @@ RUN --mount=type=cache,target=/root/.cache/go-build \
|
||||
rm -rf /tmp/buildenv_* /tmp/caddy-temp; \
|
||||
/usr/bin/caddy version'
|
||||
|
||||
# ---- CrowdSec Installer ----
|
||||
# CrowdSec requires CGO (mattn/go-sqlite3), so we cannot build from source
|
||||
# with CGO_ENABLED=0. Instead, we download prebuilt static binaries for amd64
|
||||
# or install from packages. For other architectures, CrowdSec is skipped.
|
||||
FROM alpine:3.23 AS crowdsec-installer
|
||||
|
||||
WORKDIR /tmp/crowdsec
|
||||
|
||||
ARG TARGETARCH
|
||||
# CrowdSec version - Renovate can update this
|
||||
# renovate: datasource=github-releases depName=crowdsecurity/crowdsec
|
||||
ARG CROWDSEC_VERSION=1.7.4
|
||||
|
||||
# hadolint ignore=DL3018
|
||||
RUN apk add --no-cache curl tar
|
||||
|
||||
# Download static binaries (only available for amd64)
|
||||
# For other architectures, create empty placeholder files so COPY doesn't fail
|
||||
# hadolint ignore=DL3059,SC2015
|
||||
RUN set -eux; \
|
||||
mkdir -p /crowdsec-out/bin /crowdsec-out/config; \
|
||||
if [ "$TARGETARCH" = "amd64" ]; then \
|
||||
echo "Downloading CrowdSec binaries for amd64..."; \
|
||||
curl -fSL "https://github.com/crowdsecurity/crowdsec/releases/download/v${CROWDSEC_VERSION}/crowdsec-release.tgz" \
|
||||
-o /tmp/crowdsec.tar.gz && \
|
||||
tar -xzf /tmp/crowdsec.tar.gz -C /tmp && \
|
||||
# Binaries are in cmd/crowdsec-cli/cscli and cmd/crowdsec/crowdsec
|
||||
cp "/tmp/crowdsec-v${CROWDSEC_VERSION}/cmd/crowdsec-cli/cscli" /crowdsec-out/bin/ && \
|
||||
cp "/tmp/crowdsec-v${CROWDSEC_VERSION}/cmd/crowdsec/crowdsec" /crowdsec-out/bin/ && \
|
||||
chmod +x /crowdsec-out/bin/* && \
|
||||
# Copy config files from the release tarball
|
||||
if [ -d "/tmp/crowdsec-v${CROWDSEC_VERSION}/config" ]; then \
|
||||
cp -r "/tmp/crowdsec-v${CROWDSEC_VERSION}/config/"* /crowdsec-out/config/; \
|
||||
fi && \
|
||||
echo "CrowdSec binaries installed successfully"; \
|
||||
else \
|
||||
echo "CrowdSec binaries not available for $TARGETARCH - skipping"; \
|
||||
# Create empty placeholder so COPY doesn't fail
|
||||
touch /crowdsec-out/bin/.placeholder /crowdsec-out/config/.placeholder; \
|
||||
fi; \
|
||||
# Show what we have
|
||||
ls -la /crowdsec-out/bin/ /crowdsec-out/config/ || true
|
||||
|
||||
# ---- Final Runtime with Caddy ----
|
||||
FROM ${CADDY_IMAGE}
|
||||
WORKDIR /app
|
||||
|
||||
# Install runtime dependencies for Charon (no bash needed)
|
||||
# hadolint ignore=DL3018
|
||||
RUN apk --no-cache add ca-certificates sqlite-libs tzdata curl \
|
||||
RUN apk --no-cache add ca-certificates sqlite-libs tzdata curl gettext \
|
||||
&& apk --no-cache upgrade
|
||||
|
||||
# Download MaxMind GeoLite2 Country database
|
||||
@@ -177,22 +220,32 @@ RUN mkdir -p /app/data/geoip && \
|
||||
# Copy Caddy binary from caddy-builder (overwriting the one from base image)
|
||||
COPY --from=caddy-builder /usr/bin/caddy /usr/bin/caddy
|
||||
|
||||
# Install CrowdSec binary and CLI (default version can be overridden at build time)
|
||||
ARG CROWDSEC_VERSION=1.7.4
|
||||
# hadolint ignore=DL3018
|
||||
RUN apk add --no-cache curl tar gzip && \
|
||||
set -eux; \
|
||||
URL="https://github.com/crowdsecurity/crowdsec/releases/download/v${CROWDSEC_VERSION}/crowdsec-release.tgz"; \
|
||||
curl -fSL "$URL" -o /tmp/crowdsec.tar.gz && \
|
||||
mkdir -p /tmp/crowdsec && tar -xzf /tmp/crowdsec.tar.gz -C /tmp/crowdsec || true; \
|
||||
if [ -f /tmp/crowdsec/crowdsec-v${CROWDSEC_VERSION}/cmd/crowdsec/crowdsec ]; then \
|
||||
mv /tmp/crowdsec/crowdsec-v${CROWDSEC_VERSION}/cmd/crowdsec/crowdsec /usr/local/bin/crowdsec && chmod +x /usr/local/bin/crowdsec; \
|
||||
fi && \
|
||||
if [ -f /tmp/crowdsec/crowdsec-v${CROWDSEC_VERSION}/cmd/crowdsec-cli/cscli ]; then \
|
||||
mv /tmp/crowdsec/crowdsec-v${CROWDSEC_VERSION}/cmd/crowdsec-cli/cscli /usr/local/bin/cscli && chmod +x /usr/local/bin/cscli; \
|
||||
fi && \
|
||||
rm -rf /tmp/crowdsec /tmp/crowdsec.tar.gz && \
|
||||
cscli version
|
||||
# Copy CrowdSec binaries from the crowdsec-installer stage (optional - only amd64)
|
||||
# The installer creates placeholders for non-amd64 architectures
|
||||
COPY --from=crowdsec-installer /crowdsec-out/bin/* /usr/local/bin/
|
||||
COPY --from=crowdsec-installer /crowdsec-out/config /etc/crowdsec.dist
|
||||
|
||||
# Clean up placeholder files and verify CrowdSec (if available)
|
||||
RUN rm -f /usr/local/bin/.placeholder /etc/crowdsec.dist/.placeholder 2>/dev/null || true; \
|
||||
if [ -x /usr/local/bin/cscli ]; then \
|
||||
echo "CrowdSec installed:"; \
|
||||
cscli version || echo "CrowdSec version check failed"; \
|
||||
else \
|
||||
echo "CrowdSec not available for this architecture - skipping verification"; \
|
||||
fi
|
||||
|
||||
# Create required CrowdSec directories in runtime image
|
||||
RUN mkdir -p /etc/crowdsec /etc/crowdsec/acquis.d /etc/crowdsec/bouncers \
|
||||
/etc/crowdsec/hub /etc/crowdsec/notifications \
|
||||
/var/lib/crowdsec/data /var/log/crowdsec /var/log/caddy
|
||||
|
||||
# Copy CrowdSec configuration templates from source
|
||||
COPY configs/crowdsec/acquis.yaml /etc/crowdsec.dist/acquis.yaml
|
||||
COPY configs/crowdsec/install_hub_items.sh /usr/local/bin/install_hub_items.sh
|
||||
COPY configs/crowdsec/register_bouncer.sh /usr/local/bin/register_bouncer.sh
|
||||
|
||||
# Make CrowdSec scripts executable
|
||||
RUN chmod +x /usr/local/bin/install_hub_items.sh /usr/local/bin/register_bouncer.sh
|
||||
|
||||
# Copy Go binary from backend builder
|
||||
COPY --from=backend-builder /app/backend/charon /app/charon
|
||||
|
||||
@@ -1,331 +0,0 @@
|
||||
# Built-in OAuth/OIDC Server Implementation Summary
|
||||
|
||||
## Overview
|
||||
Implemented Phase 1 (Backend Core) and Phase 2 (Caddy Integration) for Issue #14: Built-in OAuth/OIDC Server (SSO - Plus Feature).
|
||||
|
||||
## Phase 1: Backend Core
|
||||
|
||||
### 1. Docker Configuration
|
||||
**File: `/projects/Charon/Dockerfile`**
|
||||
- Updated `xcaddy build` command to include `github.com/greenpau/caddy-security` plugin
|
||||
- This enables caddy-security functionality in the Caddy binary
|
||||
|
||||
### 2. Database Models
|
||||
Created three new models in `/projects/Charon/backend/internal/models/`:
|
||||
|
||||
#### `auth_user.go` - AuthUser Model
|
||||
- Local user accounts for SSO
|
||||
- Fields: UUID, Username, Email, Name, PasswordHash, Enabled, Roles, MFAEnabled, MFASecret, LastLoginAt
|
||||
- Methods:
|
||||
- `SetPassword()` - Bcrypt password hashing
|
||||
- `CheckPassword()` - Password verification
|
||||
- `HasRole()` - Role checking
|
||||
|
||||
#### `auth_provider.go` - AuthProvider Model
|
||||
- External OAuth/OIDC provider configurations
|
||||
- Fields: UUID, Name, Type (google, github, oidc, saml), ClientID, ClientSecret, IssuerURL, AuthURL, TokenURL, UserInfoURL, Scopes, RoleMapping, IconURL, DisplayName
|
||||
- Supports generic OIDC providers and specific ones (Google, GitHub, etc.)
|
||||
|
||||
#### `auth_policy.go` - AuthPolicy Model
|
||||
- Access control policies for proxy hosts
|
||||
- Fields: UUID, Name, Description, AllowedRoles, AllowedUsers, AllowedDomains, RequireMFA, SessionTimeout
|
||||
- Method: `IsPublic()` - checks if policy allows unrestricted access
|
||||
|
||||
### 3. ProxyHost Model Enhancement
|
||||
**File: `/projects/Charon/backend/internal/models/proxy_host.go`**
|
||||
- Added `AuthPolicyID` field (nullable foreign key)
|
||||
- Added `AuthPolicy` relationship
|
||||
- Enables linking proxy hosts to authentication policies
|
||||
|
||||
### 4. API Handlers
|
||||
**File: `/projects/Charon/backend/internal/api/handlers/auth_handlers.go`**
|
||||
|
||||
Created three handler structs with full CRUD operations:
|
||||
|
||||
#### AuthUserHandler
|
||||
- `List()` - Get all auth users
|
||||
- `Get()` - Get user by UUID
|
||||
- `Create()` - Create new user (with password validation)
|
||||
- `Update()` - Update user (supports partial updates)
|
||||
- `Delete()` - Delete user (prevents deletion of last admin)
|
||||
- `Stats()` - Get user statistics (total, enabled, with MFA)
|
||||
|
||||
#### AuthProviderHandler
|
||||
- `List()` - Get all OAuth providers
|
||||
- `Get()` - Get provider by UUID
|
||||
- `Create()` - Register new OAuth provider
|
||||
- `Update()` - Update provider configuration
|
||||
- `Delete()` - Remove OAuth provider
|
||||
|
||||
#### AuthPolicyHandler
|
||||
- `List()` - Get all access policies
|
||||
- `Get()` - Get policy by UUID
|
||||
- `Create()` - Create new policy
|
||||
- `Update()` - Update policy rules
|
||||
- `Delete()` - Remove policy (prevents deletion if in use)
|
||||
|
||||
### 5. API Routes
|
||||
**File: `/projects/Charon/backend/internal/api/routes/routes.go`**
|
||||
|
||||
Registered new endpoints under `/api/v1/security/`:
|
||||
```
|
||||
GET /security/users
|
||||
GET /security/users/stats
|
||||
GET /security/users/:uuid
|
||||
POST /security/users
|
||||
PUT /security/users/:uuid
|
||||
DELETE /security/users/:uuid
|
||||
|
||||
GET /security/providers
|
||||
GET /security/providers/:uuid
|
||||
POST /security/providers
|
||||
PUT /security/providers/:uuid
|
||||
DELETE /security/providers/:uuid
|
||||
|
||||
GET /security/policies
|
||||
GET /security/policies/:uuid
|
||||
POST /security/policies
|
||||
PUT /security/policies/:uuid
|
||||
DELETE /security/policies/:uuid
|
||||
```
|
||||
|
||||
Added new models to AutoMigrate:
|
||||
- `models.AuthUser`
|
||||
- `models.AuthProvider`
|
||||
- `models.AuthPolicy`
|
||||
|
||||
## Phase 2: Caddy Integration
|
||||
|
||||
### 1. Caddy Configuration Types
|
||||
**File: `/projects/Charon/backend/internal/caddy/types.go`**
|
||||
|
||||
Added new types for caddy-security integration:
|
||||
|
||||
#### SecurityApp
|
||||
- Top-level security app configuration
|
||||
- Contains Authentication and Authorization configs
|
||||
|
||||
#### AuthenticationConfig & AuthPortal
|
||||
- Portal configuration for authentication
|
||||
- Supports multiple backends (local, OAuth, SAML)
|
||||
- Cookie and token management settings
|
||||
|
||||
#### AuthBackend
|
||||
- Configuration for individual auth backends
|
||||
- Supports local users and OAuth providers
|
||||
|
||||
#### AuthorizationConfig & AuthzPolicy
|
||||
- Policy definitions for access control
|
||||
- Role-based and user-based restrictions
|
||||
- MFA requirements
|
||||
|
||||
#### New Handler Functions
|
||||
- `SecurityAuthHandler()` - Authentication middleware
|
||||
- `SecurityAuthzHandler()` - Authorization middleware
|
||||
|
||||
### 2. Config Generation
|
||||
**File: `/projects/Charon/backend/internal/caddy/config.go`**
|
||||
|
||||
#### Updated `GenerateConfig()` Signature
|
||||
Added new parameters:
|
||||
- `authUsers []models.AuthUser`
|
||||
- `authProviders []models.AuthProvider`
|
||||
- `authPolicies []models.AuthPolicy`
|
||||
|
||||
#### New Function: `generateSecurityApp()`
|
||||
Generates the caddy-security app configuration:
|
||||
- Creates authentication portal "charon_portal"
|
||||
- Configures local backend with user credentials
|
||||
- Adds OAuth providers dynamically
|
||||
- Generates authorization policies from database
|
||||
|
||||
#### New Function: `convertAuthUsersToConfig()`
|
||||
Converts AuthUser models to caddy-security user config format:
|
||||
- Maps username, email, password hash
|
||||
- Converts comma-separated roles to arrays
|
||||
- Filters disabled users
|
||||
|
||||
#### Route Handler Integration
|
||||
When generating routes for proxy hosts:
|
||||
- Checks if host has an `AuthPolicyID`
|
||||
- Injects `SecurityAuthHandler("charon_portal")` before other handlers
|
||||
- Injects `SecurityAuthzHandler(policy.Name)` for policy enforcement
|
||||
- Maintains compatibility with legacy Forward Auth
|
||||
|
||||
### 3. Manager Updates
|
||||
**File: `/projects/Charon/backend/internal/caddy/manager.go`**
|
||||
|
||||
Updated `ApplyConfig()` to:
|
||||
- Fetch enabled auth users from database
|
||||
- Fetch enabled auth providers from database
|
||||
- Fetch enabled auth policies from database
|
||||
- Preload AuthPolicy relationships for proxy hosts
|
||||
- Pass auth data to `GenerateConfig()`
|
||||
|
||||
### 4. Test Updates
|
||||
Updated all test files to pass empty slices for new auth parameters:
|
||||
- `client_test.go`
|
||||
- `config_test.go`
|
||||
- `validator_test.go`
|
||||
- `manager_test.go`
|
||||
|
||||
## Architecture Flow
|
||||
|
||||
```
|
||||
1. User Management UI → API → Database (AuthUser, AuthProvider, AuthPolicy)
|
||||
2. ApplyConfig() → Fetch auth data → GenerateConfig()
|
||||
3. GenerateConfig() → Create SecurityApp config
|
||||
4. For each ProxyHost with AuthPolicyID:
|
||||
- Inject SecurityAuthHandler (authentication)
|
||||
- Inject SecurityAuthzHandler (authorization)
|
||||
5. Caddy receives full config with security app
|
||||
6. Incoming requests → Caddy → Security handlers → Backend services
|
||||
```
|
||||
|
||||
## Database Schema
|
||||
|
||||
### auth_users
|
||||
- id, uuid, created_at, updated_at
|
||||
- username, email, name
|
||||
- password_hash
|
||||
- enabled, roles
|
||||
- mfa_enabled, mfa_secret
|
||||
- last_login_at
|
||||
|
||||
### auth_providers
|
||||
- id, uuid, created_at, updated_at
|
||||
- name, type, enabled
|
||||
- client_id, client_secret
|
||||
- issuer_url, auth_url, token_url, user_info_url
|
||||
- scopes, role_mapping
|
||||
- icon_url, display_name
|
||||
|
||||
### auth_policies
|
||||
- id, uuid, created_at, updated_at
|
||||
- name, description, enabled
|
||||
- allowed_roles, allowed_users, allowed_domains
|
||||
- require_mfa, session_timeout
|
||||
|
||||
### proxy_hosts (updated)
|
||||
- Added: auth_policy_id (nullable FK)
|
||||
|
||||
## Configuration Example
|
||||
|
||||
When a proxy host has `auth_policy_id = 1` (pointing to "Admins Only" policy):
|
||||
|
||||
```json
|
||||
{
|
||||
"apps": {
|
||||
"security": {
|
||||
"authentication": {
|
||||
"portals": {
|
||||
"charon_portal": {
|
||||
"backends": [
|
||||
{
|
||||
"name": "local",
|
||||
"method": "local",
|
||||
"config": {
|
||||
"users": [
|
||||
{
|
||||
"username": "admin",
|
||||
"email": "admin@example.com",
|
||||
"password": "$2a$10$...",
|
||||
"roles": ["admin"]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"authorization": {
|
||||
"policies": {
|
||||
"Admins Only": {
|
||||
"allowed_roles": ["admin"],
|
||||
"require_mfa": false
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"http": {
|
||||
"servers": {
|
||||
"charon_server": {
|
||||
"routes": [
|
||||
{
|
||||
"match": [{"host": ["app.example.com"]}],
|
||||
"handle": [
|
||||
{"handler": "authentication", "portal": "charon_portal"},
|
||||
{"handler": "authorization", "policy": "Admins Only"},
|
||||
{"handler": "reverse_proxy", "upstreams": [{"dial": "backend:8080"}]}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Security Considerations
|
||||
|
||||
1. **Password Storage**: Uses bcrypt for secure password hashing
|
||||
2. **Secrets**: ClientSecret and MFASecret fields are never exposed in JSON responses
|
||||
3. **Admin Protection**: Cannot delete the last admin user
|
||||
4. **Policy Enforcement**: Cannot delete policies that are in use
|
||||
5. **MFA Support**: Framework ready for TOTP implementation
|
||||
|
||||
## Next Steps (Phase 3 & 4)
|
||||
|
||||
### Phase 3: Frontend Management UI
|
||||
- Create `/src/pages/Security/` directory
|
||||
- Implement Users management page
|
||||
- Implement Providers management page
|
||||
- Implement Policies management page
|
||||
- Add SSO dashboard with session overview
|
||||
|
||||
### Phase 4: Proxy Host Integration
|
||||
- Update ProxyHostForm with "Access Control" tab
|
||||
- Add policy selector dropdown
|
||||
- Display active policy on host list
|
||||
- Show authentication status indicators
|
||||
|
||||
## Testing
|
||||
|
||||
All backend tests pass:
|
||||
```
|
||||
✓ internal/api/handlers
|
||||
✓ internal/api/middleware
|
||||
✓ internal/api/routes
|
||||
✓ internal/caddy (all tests updated)
|
||||
✓ internal/config
|
||||
✓ internal/database
|
||||
✓ internal/models
|
||||
✓ internal/server
|
||||
✓ internal/services
|
||||
✓ internal/version
|
||||
```
|
||||
|
||||
Backend compiles successfully without errors.
|
||||
|
||||
## Acceptance Criteria Status
|
||||
|
||||
- ✅ Can create local users for authentication (AuthUser model + API)
|
||||
- ✅ Can protect services with built-in SSO (AuthPolicy + route integration)
|
||||
- ⏳ 2FA works correctly (framework ready, needs frontend implementation)
|
||||
- ✅ External OIDC providers can be configured (AuthProvider model + API)
|
||||
|
||||
## Reserved Routes
|
||||
|
||||
- `/auth/*` - Reserved for caddy-security authentication portal
|
||||
- Portal URL: `https://yourdomain.com/auth/login`
|
||||
- Logout URL: `https://yourdomain.com/auth/logout`
|
||||
|
||||
## Notes
|
||||
|
||||
1. The implementation uses SQLite as the source of truth
|
||||
2. Configuration is "compiled" from database to Caddy JSON on each ApplyConfig
|
||||
3. No direct database sharing with caddy-security (config-based integration)
|
||||
4. Compatible with existing Forward Auth feature (both can coexist)
|
||||
5. MFA secret storage is ready but TOTP setup flow needs frontend work
|
||||
@@ -1,5 +1,7 @@
|
||||
# QA Security Audit Report: Loading Overlays
|
||||
|
||||
## Date: 2025-12-04
|
||||
|
||||
## Feature: Thematic Loading Overlays (Charon, Coin, Cerberus)
|
||||
|
||||
---
|
||||
@@ -15,6 +17,7 @@ The loading overlay implementation has been thoroughly audited and tested. The f
|
||||
## 🔍 AUDIT SCOPE
|
||||
|
||||
### Components Tested
|
||||
|
||||
1. **LoadingStates.tsx** - Core animation components
|
||||
- `CharonLoader` (blue boat theme)
|
||||
- `CharonCoinLoader` (gold coin theme)
|
||||
@@ -22,6 +25,7 @@ The loading overlay implementation has been thoroughly audited and tested. The f
|
||||
- `ConfigReloadOverlay` (wrapper with theme support)
|
||||
|
||||
### Pages Audited
|
||||
|
||||
1. **Login.tsx** - Coin theme (authentication)
|
||||
2. **ProxyHosts.tsx** - Charon theme (proxy operations)
|
||||
3. **WafConfig.tsx** - Cerberus theme (security operations)
|
||||
@@ -33,23 +37,27 @@ The loading overlay implementation has been thoroughly audited and tested. The f
|
||||
## 🛡️ SECURITY FINDINGS
|
||||
|
||||
### ✅ PASSED: XSS Protection
|
||||
|
||||
- **Test**: Injected `<script>alert("XSS")</script>` in message prop
|
||||
- **Result**: React automatically escapes all HTML - no XSS vulnerability
|
||||
- **Evidence**: DOM inspection shows literal text, no script execution
|
||||
|
||||
### ✅ PASSED: Input Validation
|
||||
|
||||
- **Test**: Extremely long strings (10,000 characters)
|
||||
- **Result**: Renders without crashing, no performance degradation
|
||||
- **Test**: Special characters and unicode
|
||||
- **Result**: Handles all character sets correctly
|
||||
|
||||
### ✅ PASSED: Type Safety
|
||||
|
||||
- **Test**: Invalid type prop injection
|
||||
- **Result**: Defaults gracefully to 'charon' theme
|
||||
- **Test**: Null/undefined props
|
||||
- **Result**: Handles edge cases without errors (minor: null renders empty, not "null")
|
||||
|
||||
### ✅ PASSED: Race Conditions
|
||||
|
||||
- **Test**: Rapid-fire button clicks during overlay
|
||||
- **Result**: Form inputs disabled during mutation, prevents duplicate requests
|
||||
- **Implementation**: Checked Login.tsx, ProxyHosts.tsx - all inputs disabled when `isApplyingConfig` is true
|
||||
@@ -59,6 +67,7 @@ The loading overlay implementation has been thoroughly audited and tested. The f
|
||||
## 🎨 THEME IMPLEMENTATION
|
||||
|
||||
### ✅ Charon Theme (Proxy Operations)
|
||||
|
||||
- **Color**: Blue (`bg-blue-950/90`, `border-blue-900/50`)
|
||||
- **Animation**: `animate-bob-boat` (boat bobbing on waves)
|
||||
- **Pages**: ProxyHosts, Certificates
|
||||
@@ -69,6 +78,7 @@ The loading overlay implementation has been thoroughly audited and tested. The f
|
||||
- Bulk: "Ferrying {count} souls..." / "Bulk operation crossing the river"
|
||||
|
||||
### ✅ Coin Theme (Authentication)
|
||||
|
||||
- **Color**: Gold/Amber (`bg-amber-950/90`, `border-amber-900/50`)
|
||||
- **Animation**: `animate-spin-y` (3D spinning obol coin)
|
||||
- **Pages**: Login
|
||||
@@ -76,6 +86,7 @@ The loading overlay implementation has been thoroughly audited and tested. The f
|
||||
- Login: "Paying the ferryman..." / "Your obol grants passage"
|
||||
|
||||
### ✅ Cerberus Theme (Security Operations)
|
||||
|
||||
- **Color**: Red (`bg-red-950/90`, `border-red-900/50`)
|
||||
- **Animation**: `animate-rotate-head` (three heads moving)
|
||||
- **Pages**: WafConfig, Security, CrowdSecConfig, AccessLists
|
||||
@@ -91,6 +102,7 @@ The loading overlay implementation has been thoroughly audited and tested. The f
|
||||
## 🧪 TEST RESULTS
|
||||
|
||||
### Component Tests (LoadingStates.security.test.tsx)
|
||||
|
||||
```
|
||||
Total: 41 tests
|
||||
Passed: 40 ✅
|
||||
@@ -98,12 +110,14 @@ Failed: 1 ⚠️ (minor edge case, not a bug)
|
||||
```
|
||||
|
||||
**Failed Test Analysis**:
|
||||
|
||||
- **Test**: `handles null message`
|
||||
- **Issue**: React doesn't render `null` as the string "null", it renders nothing
|
||||
- **Impact**: NONE - Production code never passes null (TypeScript prevents it)
|
||||
- **Action**: Test expectation incorrect, not component bug
|
||||
|
||||
### Integration Coverage
|
||||
|
||||
- ✅ Login.tsx: Coin overlay on authentication
|
||||
- ✅ ProxyHosts.tsx: Charon overlay on CRUD operations
|
||||
- ✅ WafConfig.tsx: Cerberus overlay on ruleset operations
|
||||
@@ -111,6 +125,7 @@ Failed: 1 ⚠️ (minor edge case, not a bug)
|
||||
- ✅ CrowdSecConfig.tsx: Cerberus overlay on config operations
|
||||
|
||||
### Existing Test Suite
|
||||
|
||||
```
|
||||
ProxyHosts tests: 51 tests PASSING ✅
|
||||
ProxyHostForm tests: 22 tests PASSING ✅
|
||||
@@ -122,6 +137,7 @@ Total frontend suite: 100+ tests PASSING ✅
|
||||
## 🎯 CSS ANIMATIONS
|
||||
|
||||
### ✅ All Keyframes Defined (index.css)
|
||||
|
||||
```css
|
||||
@keyframes bob-boat { ... } // Charon boat bobbing
|
||||
@keyframes pulse-glow { ... } // Sail pulsing
|
||||
@@ -130,6 +146,7 @@ Total frontend suite: 100+ tests PASSING ✅
|
||||
```
|
||||
|
||||
### Performance
|
||||
|
||||
- **Render Time**: All loaders < 100ms (tested)
|
||||
- **Animation Frame Rate**: Smooth 60fps (CSS-based, GPU accelerated)
|
||||
- **Bundle Impact**: +2KB minified (SVG components)
|
||||
@@ -153,6 +170,7 @@ z-50: Config reload overlay ✅ (blocks everything)
|
||||
## ♿ ACCESSIBILITY
|
||||
|
||||
### ✅ PASSED: ARIA Labels
|
||||
|
||||
- All loaders have `role="status"`
|
||||
- Specific aria-labels:
|
||||
- CharonLoader: `aria-label="Loading"`
|
||||
@@ -160,6 +178,7 @@ z-50: Config reload overlay ✅ (blocks everything)
|
||||
- CerberusLoader: `aria-label="Security Loading"`
|
||||
|
||||
### ✅ PASSED: Keyboard Navigation
|
||||
|
||||
- Overlay blocks all interactions (intentional)
|
||||
- No keyboard traps (overlay clears on completion)
|
||||
- Screen readers announce status changes
|
||||
@@ -177,17 +196,20 @@ The only "failure" was a test that expected React to render `null` as the string
|
||||
## 🚀 PERFORMANCE TESTING
|
||||
|
||||
### Load Time Tests
|
||||
|
||||
- CharonLoader: 2-4ms ✅
|
||||
- CharonCoinLoader: 2-3ms ✅
|
||||
- CerberusLoader: 2-3ms ✅
|
||||
- ConfigReloadOverlay: 3-4ms ✅
|
||||
|
||||
### Memory Impact
|
||||
|
||||
- No memory leaks detected
|
||||
- Overlay properly unmounts on completion
|
||||
- React Query handles cleanup automatically
|
||||
|
||||
### Network Resilience
|
||||
|
||||
- ✅ Timeout handling: Overlay clears on error
|
||||
- ✅ Network failure: Error toast shows, overlay clears
|
||||
- ✅ Caddy restart: Waits for completion, then clears
|
||||
@@ -220,18 +242,23 @@ From current_spec.md:
|
||||
## 🔧 RECOMMENDED FIXES
|
||||
|
||||
### 1. Minor Test Fix (Optional)
|
||||
|
||||
**File**: `frontend/src/components/__tests__/LoadingStates.security.test.tsx`
|
||||
**Line**: 245
|
||||
**Current**:
|
||||
|
||||
```tsx
|
||||
expect(screen.getByText('null')).toBeInTheDocument()
|
||||
```
|
||||
|
||||
**Fix**:
|
||||
|
||||
```tsx
|
||||
// Verify message is empty when null is passed (React doesn't render null as "null")
|
||||
const messages = container.querySelectorAll('.text-slate-100')
|
||||
expect(messages[0].textContent).toBe('')
|
||||
```
|
||||
|
||||
**Priority**: LOW (test only, doesn't affect production)
|
||||
|
||||
---
|
||||
@@ -239,16 +266,19 @@ expect(messages[0].textContent).toBe('')
|
||||
## 📊 CODE QUALITY METRICS
|
||||
|
||||
### TypeScript Coverage
|
||||
|
||||
- ✅ All components strongly typed
|
||||
- ✅ Props use explicit interfaces
|
||||
- ✅ No `any` types used
|
||||
|
||||
### Code Duplication
|
||||
|
||||
- ✅ Single source of truth: `LoadingStates.tsx`
|
||||
- ✅ Shared `getMessage()` pattern across pages
|
||||
- ✅ Consistent theme configuration
|
||||
|
||||
### Maintainability
|
||||
|
||||
- ✅ Well-documented JSDoc comments
|
||||
- ✅ Clear separation of concerns
|
||||
- ✅ Easy to add new themes (extend type union)
|
||||
@@ -258,6 +288,7 @@ expect(messages[0].textContent).toBe('')
|
||||
## 🎓 DEVELOPER NOTES
|
||||
|
||||
### How It Works
|
||||
|
||||
1. User submits form (e.g., create proxy host)
|
||||
2. React Query mutation starts (`isCreating = true`)
|
||||
3. Page computes `isApplyingConfig = isCreating || isUpdating || ...`
|
||||
@@ -268,6 +299,7 @@ expect(messages[0].textContent).toBe('')
|
||||
8. Overlay unmounts automatically
|
||||
|
||||
### Adding New Pages
|
||||
|
||||
```tsx
|
||||
import { ConfigReloadOverlay } from '../components/LoadingStates'
|
||||
|
||||
@@ -299,6 +331,7 @@ return (
|
||||
### **GREEN LIGHT FOR PRODUCTION** ✅
|
||||
|
||||
**Reasoning**:
|
||||
|
||||
1. ✅ No security vulnerabilities found
|
||||
2. ✅ No race conditions or state bugs
|
||||
3. ✅ Performance is excellent (<100ms, 60fps)
|
||||
@@ -309,6 +342,7 @@ return (
|
||||
8. ⚠️ Only 1 minor test expectation issue (not a bug)
|
||||
|
||||
### Remaining Pre-Merge Steps
|
||||
|
||||
1. ✅ Security audit complete (this document)
|
||||
2. ⏳ Run `pre-commit run --all-files` (recommended before PR)
|
||||
3. ⏳ Manual QA in dev environment (5 min smoke test)
|
||||
|
||||
@@ -99,7 +99,7 @@ docker run -d \
|
||||
2. The web interface opened on port 8080
|
||||
3. Your websites will use ports 80 (HTTP) and 443 (HTTPS)
|
||||
|
||||
**Open http://localhost:8080** and start adding your websites!
|
||||
**Open <http://localhost:8080>** and start adding your websites!
|
||||
|
||||
---
|
||||
|
||||
@@ -138,8 +138,6 @@ Want to help make Charon better? Check out [CONTRIBUTING.md](CONTRIBUTING.md)
|
||||
|
||||
## ✨ Top Features
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
|
||||
194
SECURITY_CONFIG_PRIORITY.md
Normal file
194
SECURITY_CONFIG_PRIORITY.md
Normal file
@@ -0,0 +1,194 @@
|
||||
# Security Configuration Priority System
|
||||
|
||||
## Overview
|
||||
|
||||
The Charon security configuration system uses a three-tier priority chain to determine the effective security settings. This allows for flexible configuration management across different deployment scenarios.
|
||||
|
||||
## Priority Chain
|
||||
|
||||
1. **Settings Table** (Highest Priority)
|
||||
- Runtime overrides stored in the `settings` database table
|
||||
- Used for feature flags and quick toggles
|
||||
- Can enable/disable individual security modules without full config changes
|
||||
- Takes precedence over all other sources
|
||||
|
||||
2. **SecurityConfig Database Record** (Middle Priority)
|
||||
- Persistent configuration stored in the `security_configs` table
|
||||
- Contains comprehensive security settings including admin whitelists, rate limits, etc.
|
||||
- Overrides static configuration file settings
|
||||
- Used for user-managed security configuration
|
||||
|
||||
3. **Static Configuration File** (Lowest Priority)
|
||||
- Default values from `config/config.yaml` or environment variables
|
||||
- Fallback when no database overrides exist
|
||||
- Used for initial setup and defaults
|
||||
|
||||
## How It Works
|
||||
|
||||
When the `/api/v1/security/status` endpoint is called, the system:
|
||||
|
||||
1. Starts with static config values
|
||||
2. Checks for SecurityConfig DB record and overrides static values if present
|
||||
3. Checks for Settings table entries and overrides both static and DB values if present
|
||||
4. Computes effective enabled state based on final values
|
||||
|
||||
## Supported Settings Table Keys
|
||||
|
||||
### Cerberus (Master Switch)
|
||||
- `feature.cerberus.enabled` - "true"/"false" - Enables/disables all security features
|
||||
|
||||
### WAF (Web Application Firewall)
|
||||
- `security.waf.enabled` - "true"/"false" - Overrides WAF mode
|
||||
|
||||
### Rate Limiting
|
||||
- `security.rate_limit.enabled` - "true"/"false" - Overrides rate limit mode
|
||||
|
||||
### CrowdSec
|
||||
- `security.crowdsec.enabled` - "true"/"false" - Sets CrowdSec to local/disabled
|
||||
- `security.crowdsec.mode` - "local"/"disabled" - Direct mode override
|
||||
|
||||
### ACL (Access Control Lists)
|
||||
- `security.acl.enabled` - "true"/"false" - Overrides ACL mode
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1: Settings Override SecurityConfig
|
||||
|
||||
```go
|
||||
// Static Config
|
||||
config.SecurityConfig{
|
||||
CerberusEnabled: true,
|
||||
WAFMode: "disabled",
|
||||
}
|
||||
|
||||
// SecurityConfig DB
|
||||
SecurityConfig{
|
||||
Name: "default",
|
||||
Enabled: true,
|
||||
WAFMode: "enabled", // Tries to enable WAF
|
||||
}
|
||||
|
||||
// Settings Table
|
||||
Setting{Key: "security.waf.enabled", Value: "false"}
|
||||
|
||||
// Result: WAF is DISABLED (Settings table wins)
|
||||
```
|
||||
|
||||
### Example 2: SecurityConfig Override Static
|
||||
|
||||
```go
|
||||
// Static Config
|
||||
config.SecurityConfig{
|
||||
CerberusEnabled: true,
|
||||
RateLimitMode: "disabled",
|
||||
}
|
||||
|
||||
// SecurityConfig DB
|
||||
SecurityConfig{
|
||||
Name: "default",
|
||||
Enabled: true,
|
||||
RateLimitMode: "enabled", // Overrides static
|
||||
}
|
||||
|
||||
// Settings Table
|
||||
// (no settings for rate_limit)
|
||||
|
||||
// Result: Rate Limit is ENABLED (SecurityConfig DB wins)
|
||||
```
|
||||
|
||||
### Example 3: Static Config Fallback
|
||||
|
||||
```go
|
||||
// Static Config
|
||||
config.SecurityConfig{
|
||||
CerberusEnabled: true,
|
||||
CrowdSecMode: "local",
|
||||
}
|
||||
|
||||
// SecurityConfig DB
|
||||
// (no record found)
|
||||
|
||||
// Settings Table
|
||||
// (no settings)
|
||||
|
||||
// Result: CrowdSec is LOCAL (Static config wins)
|
||||
```
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Cerberus Master Switch**: All security features require Cerberus to be enabled. If Cerberus is disabled at any priority level, all features are disabled regardless of their individual settings.
|
||||
|
||||
2. **Mode Mapping**: Invalid CrowdSec modes are mapped to "disabled" for safety.
|
||||
|
||||
3. **Database Priority**: SecurityConfig DB record must have `name = "default"` to be recognized.
|
||||
|
||||
4. **Backward Compatibility**: The system maintains backward compatibility with the older `RateLimitEnable` boolean field by mapping it to `RateLimitMode`.
|
||||
|
||||
## Testing
|
||||
|
||||
Comprehensive unit tests verify the priority chain:
|
||||
- `TestSecurityHandler_Priority_SettingsOverSecurityConfig` - Tests all three priority levels
|
||||
- `TestSecurityHandler_Priority_AllModules` - Tests all security modules together
|
||||
- `TestSecurityHandler_GetStatus_RespectsSettingsTable` - Tests Settings table overrides
|
||||
- `TestSecurityHandler_ACL_DBOverride` - Tests ACL specific overrides
|
||||
- `TestSecurityHandler_CrowdSec_Mode_DBOverride` - Tests CrowdSec mode overrides
|
||||
|
||||
## Implementation Details
|
||||
|
||||
The priority logic is implemented in [security_handler.go](backend/internal/api/handlers/security_handler.go#L55-L170):
|
||||
|
||||
```go
|
||||
// GetStatus returns the current status of all security services.
|
||||
// Priority chain:
|
||||
// 1. Settings table (highest - runtime overrides)
|
||||
// 2. SecurityConfig DB record (middle - user configuration)
|
||||
// 3. Static config (lowest - defaults)
|
||||
func (h *SecurityHandler) GetStatus(c *gin.Context) {
|
||||
// Start with static config defaults
|
||||
enabled := h.cfg.CerberusEnabled
|
||||
wafMode := h.cfg.WAFMode
|
||||
// ... other fields
|
||||
|
||||
// Override with database SecurityConfig if present (priority 2)
|
||||
if h.db != nil {
|
||||
var sc models.SecurityConfig
|
||||
if err := h.db.Where("name = ?", "default").First(&sc).Error; err == nil {
|
||||
enabled = sc.Enabled
|
||||
if sc.WAFMode != "" {
|
||||
wafMode = sc.WAFMode
|
||||
}
|
||||
// ... other overrides
|
||||
}
|
||||
|
||||
// Check runtime setting overrides from settings table (priority 1 - highest)
|
||||
var setting struct{ Value string }
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", "security.waf.enabled").Scan(&setting).Error; err == nil && setting.Value != "" {
|
||||
if strings.EqualFold(setting.Value, "true") {
|
||||
wafMode = "enabled"
|
||||
} else {
|
||||
wafMode = "disabled"
|
||||
}
|
||||
}
|
||||
// ... other setting checks
|
||||
}
|
||||
// ... compute effective state and return
|
||||
}
|
||||
```
|
||||
|
||||
## QA Verification
|
||||
|
||||
All previously failing tests now pass:
|
||||
- ✅ `TestCertificateHandler_Delete_NotificationRateLimiting`
|
||||
- ✅ `TestSecurityHandler_ACL_DBOverride`
|
||||
- ✅ `TestSecurityHandler_CrowdSec_Mode_DBOverride`
|
||||
- ✅ `TestSecurityHandler_GetStatus_RespectsSettingsTable` (all 6 subtests)
|
||||
- ✅ `TestSecurityHandler_GetStatus_WAFModeFromSettings`
|
||||
- ✅ `TestSecurityHandler_GetStatus_RateLimitModeFromSettings`
|
||||
|
||||
## Migration Notes
|
||||
|
||||
For existing deployments:
|
||||
1. No database migration required - Settings table already exists
|
||||
2. SecurityConfig records work as before
|
||||
3. New Settings table overrides are optional
|
||||
4. System remains backward compatible with all existing configurations
|
||||
@@ -1,19 +1,22 @@
|
||||
# Security Services Implementation Plan
|
||||
|
||||
## Overview
|
||||
|
||||
This document outlines the plan to implement a modular Security Dashboard in Charon (previously 'CPM+'). The goal is to provide optional, high-value security integrations (CrowdSec, WAF, ACLs, Rate Limiting) while keeping the core Docker image lightweight.
|
||||
|
||||
## Core Philosophy
|
||||
1. **Optionality**: All security services are disabled by default.
|
||||
2. **Environment Driven**: Activation is controlled via `CHARON_SECURITY_*` environment variables (legacy `CPM_SECURITY_*` names supported for backward compatibility).
|
||||
3. **Minimal Footprint**:
|
||||
* Lightweight Caddy modules (WAF, Bouncers) are compiled into the binary (negligible size impact).
|
||||
* Heavy standalone agents (e.g., CrowdSec Agent) are only installed at runtime if explicitly enabled in "Local" mode.
|
||||
4. **Unified Dashboard**: A single pane of glass in the UI to view status and configuration.
|
||||
|
||||
1. **Optionality**: All security services are disabled by default.
|
||||
2. **Environment Driven**: Activation is controlled via `CHARON_SECURITY_*` environment variables (legacy `CPM_SECURITY_*` names supported for backward compatibility).
|
||||
3. **Minimal Footprint**:
|
||||
* Lightweight Caddy modules (WAF, Bouncers) are compiled into the binary (negligible size impact).
|
||||
* Heavy standalone agents (e.g., CrowdSec Agent) are only installed at runtime if explicitly enabled in "Local" mode.
|
||||
4. **Unified Dashboard**: A single pane of glass in the UI to view status and configuration.
|
||||
|
||||
---
|
||||
|
||||
## 1. Environment Variables
|
||||
|
||||
We will introduce a new set of environment variables to control these services.
|
||||
|
||||
| Variable | Values | Description |
|
||||
@@ -30,84 +33,98 @@ We will introduce a new set of environment variables to control these services.
|
||||
## 2. Backend Implementation
|
||||
|
||||
### A. Dockerfile Updates
|
||||
|
||||
We need to compile the necessary Caddy modules into our binary. This adds minimal size overhead but enables the features natively.
|
||||
* **Action**: Update `Dockerfile` `caddy-builder` stage to include:
|
||||
* `github.com/corazawaf/coraza-caddy/v2` (WAF)
|
||||
* `github.com/hslatman/caddy-crowdsec-bouncer` (CrowdSec Bouncer)
|
||||
|
||||
* **Action**: Update `Dockerfile` `caddy-builder` stage to include:
|
||||
* `github.com/corazawaf/coraza-caddy/v2` (WAF)
|
||||
* `github.com/hslatman/caddy-crowdsec-bouncer` (CrowdSec Bouncer)
|
||||
|
||||
### B. Configuration Management (`internal/config`)
|
||||
* **Action**: Update `Config` struct to parse `CHARON_SECURITY_*` variables while still accepting `CPM_SECURITY_*` as legacy fallbacks.
|
||||
* **Action**: Create `SecurityConfig` struct to hold these values.
|
||||
|
||||
* **Action**: Update `Config` struct to parse `CHARON_SECURITY_*` variables while still accepting `CPM_SECURITY_*` as legacy fallbacks.
|
||||
* **Action**: Create `SecurityConfig` struct to hold these values.
|
||||
|
||||
### C. Runtime Installation (`docker-entrypoint.sh`)
|
||||
|
||||
To satisfy the "install locally" requirement for CrowdSec without bloating the image:
|
||||
* **Action**: Modify `docker-entrypoint.sh` to check `CHARON_SECURITY_CROWDSEC_MODE` (and fallback to `CPM_SECURITY_CROWDSEC_MODE`).
|
||||
* **Logic**: If `local`, execute `apk add --no-cache crowdsec` (and dependencies) before starting the app. This keeps the base image small for users who don't use it.
|
||||
|
||||
* **Action**: Modify `docker-entrypoint.sh` to check `CHARON_SECURITY_CROWDSEC_MODE` (and fallback to `CPM_SECURITY_CROWDSEC_MODE`).
|
||||
* **Logic**: If `local`, execute `apk add --no-cache crowdsec` (and dependencies) before starting the app. This keeps the base image small for users who don't use it.
|
||||
|
||||
### D. API Endpoints (`internal/api`)
|
||||
* **New Endpoint**: `GET /api/v1/security/status`
|
||||
* Returns the enabled/disabled state of each service.
|
||||
* Returns basic metrics if available (e.g., "WAF: Active", "CrowdSec: Connected").
|
||||
|
||||
* **New Endpoint**: `GET /api/v1/security/status`
|
||||
* Returns the enabled/disabled state of each service.
|
||||
* Returns basic metrics if available (e.g., "WAF: Active", "CrowdSec: Connected").
|
||||
|
||||
---
|
||||
|
||||
## 3. Frontend Implementation
|
||||
|
||||
### A. Navigation
|
||||
* **Action**: Add "Security" item to the Sidebar in `Layout.tsx`.
|
||||
|
||||
* **Action**: Add "Security" item to the Sidebar in `Layout.tsx`.
|
||||
|
||||
### B. Security Dashboard (`src/pages/Security.tsx`)
|
||||
* **Layout**: Grid of cards representing each service.
|
||||
* **Empty State**: If all services are disabled, show a clean "Security Not Enabled" state with a link to the GitHub Pages documentation on how to enable them.
|
||||
|
||||
* **Layout**: Grid of cards representing each service.
|
||||
* **Empty State**: If all services are disabled, show a clean "Security Not Enabled" state with a link to the GitHub Pages documentation on how to enable them.
|
||||
|
||||
### C. Service Cards
|
||||
1. **CrowdSec Card**:
|
||||
* **Status**: Active (Local/External) / Disabled.
|
||||
* **Content**: If Local, show basic stats (last push, alerts). If External, show connection status.
|
||||
* **Action**: Link to CrowdSec Console or Dashboard.
|
||||
2. **WAF Card**:
|
||||
* **Status**: Active / Disabled.
|
||||
* **Content**: "OWASP CRS Loaded".
|
||||
3. **Access Control Lists (ACL)**:
|
||||
* **Status**: Active / Disabled.
|
||||
* **Action**: "Manage Blocklists" (opens modal/page to edit IP lists).
|
||||
4. **Rate Limiting**:
|
||||
* **Status**: Active / Disabled.
|
||||
* **Action**: "Configure Limits" (opens modal to set global requests/second).
|
||||
|
||||
1. **CrowdSec Card**:
|
||||
* **Status**: Active (Local/External) / Disabled.
|
||||
* **Content**: If Local, show basic stats (last push, alerts). If External, show connection status.
|
||||
* **Action**: Link to CrowdSec Console or Dashboard.
|
||||
2. **WAF Card**:
|
||||
* **Status**: Active / Disabled.
|
||||
* **Content**: "OWASP CRS Loaded".
|
||||
3. **Access Control Lists (ACL)**:
|
||||
* **Status**: Active / Disabled.
|
||||
* **Action**: "Manage Blocklists" (opens modal/page to edit IP lists).
|
||||
4. **Rate Limiting**:
|
||||
* **Status**: Active / Disabled.
|
||||
* **Action**: "Configure Limits" (opens modal to set global requests/second).
|
||||
|
||||
---
|
||||
|
||||
## 4. Service-Specific Logic
|
||||
|
||||
### CrowdSec
|
||||
* **Local**:
|
||||
* Installs CrowdSec agent via `apk`.
|
||||
* Generates `acquis.yaml` to read Caddy logs.
|
||||
* Configures Caddy bouncer to talk to `localhost:8080`.
|
||||
* **External**:
|
||||
* Configures Caddy bouncer to talk to `CPM_SECURITY_CROWDSEC_API_URL`.
|
||||
|
||||
* **Local**:
|
||||
* Installs CrowdSec agent via `apk`.
|
||||
* Generates `acquis.yaml` to read Caddy logs.
|
||||
* Configures Caddy bouncer to talk to `localhost:8080`.
|
||||
* **External**:
|
||||
* Configures Caddy bouncer to talk to `CPM_SECURITY_CROWDSEC_API_URL`.
|
||||
|
||||
### WAF (Coraza)
|
||||
* **Implementation**:
|
||||
* When enabled, inject `coraza_waf` directive into the global Caddyfile or per-host.
|
||||
* Use default OWASP Core Rule Set (CRS).
|
||||
|
||||
* **Implementation**:
|
||||
* When enabled, inject `coraza_waf` directive into the global Caddyfile or per-host.
|
||||
* Use default OWASP Core Rule Set (CRS).
|
||||
|
||||
### IP ACLs
|
||||
* **Implementation**:
|
||||
* Create a snippet `(ip_filter)` in Caddyfile.
|
||||
* Use `@matcher` with `remote_ip` to block/allow IPs.
|
||||
* UI allows adding CIDR ranges to this list.
|
||||
|
||||
* **Implementation**:
|
||||
* Create a snippet `(ip_filter)` in Caddyfile.
|
||||
* Use `@matcher` with `remote_ip` to block/allow IPs.
|
||||
* UI allows adding CIDR ranges to this list.
|
||||
|
||||
### Rate Limiting
|
||||
* **Implementation**:
|
||||
* Use `rate_limit` directive.
|
||||
* Allow user to define "zones" (e.g., API, Static) in the UI.
|
||||
|
||||
* **Implementation**:
|
||||
* Use `rate_limit` directive.
|
||||
* Allow user to define "zones" (e.g., API, Static) in the UI.
|
||||
|
||||
---
|
||||
|
||||
## 5. Documentation
|
||||
* **New Doc**: `docs/security.md`
|
||||
* **Content**:
|
||||
* Explanation of each service.
|
||||
* How to configure Env Vars.
|
||||
* Trade-offs of "Local" CrowdSec (startup time vs convenience).
|
||||
|
||||
* **New Doc**: `docs/security.md`
|
||||
* **Content**:
|
||||
* Explanation of each service.
|
||||
* How to configure Env Vars.
|
||||
* Trade-offs of "Local" CrowdSec (startup time vs convenience).
|
||||
|
||||
10
VERSION.md
10
VERSION.md
@@ -10,6 +10,7 @@ Charon follows [Semantic Versioning 2.0.0](https://semver.org/):
|
||||
- **PATCH**: Bug fixes (backward compatible)
|
||||
|
||||
### Pre-release Identifiers
|
||||
|
||||
- `alpha`: Early development, unstable
|
||||
- `beta`: Feature complete, testing phase
|
||||
- `rc` (release candidate): Final testing before release
|
||||
@@ -21,17 +22,20 @@ Example: `0.1.0-alpha`, `1.0.0-beta.1`, `2.0.0-rc.2`
|
||||
### Automated Release Process
|
||||
|
||||
1. **Update version** in `.version` file:
|
||||
|
||||
```bash
|
||||
echo "1.0.0" > .version
|
||||
```
|
||||
|
||||
2. **Commit version bump**:
|
||||
|
||||
```bash
|
||||
git add .version
|
||||
git commit -m "chore: bump version to 1.0.0"
|
||||
```
|
||||
|
||||
3. **Create and push tag**:
|
||||
|
||||
```bash
|
||||
git tag -a v1.0.0 -m "Release v1.0.0"
|
||||
git push origin v1.0.0
|
||||
@@ -83,6 +87,7 @@ curl http://localhost:8080/api/v1/health
|
||||
```
|
||||
|
||||
Response includes:
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
@@ -96,12 +101,14 @@ Response includes:
|
||||
### Container Image Labels
|
||||
|
||||
View version metadata:
|
||||
|
||||
```bash
|
||||
docker inspect ghcr.io/wikid82/charon:latest \
|
||||
--format='{{json .Config.Labels}}' | jq
|
||||
```
|
||||
|
||||
Returns OCI-compliant labels:
|
||||
|
||||
- `org.opencontainers.image.version`
|
||||
- `org.opencontainers.image.created`
|
||||
- `org.opencontainers.image.revision`
|
||||
@@ -110,11 +117,13 @@ Returns OCI-compliant labels:
|
||||
## Development Builds
|
||||
|
||||
Local builds default to `version=dev`:
|
||||
|
||||
```bash
|
||||
docker build -t charon:dev .
|
||||
```
|
||||
|
||||
Build with custom version:
|
||||
|
||||
```bash
|
||||
docker build \
|
||||
--build-arg VERSION=1.2.3 \
|
||||
@@ -136,6 +145,7 @@ The release workflow automatically generates changelogs from commit messages. Us
|
||||
- `ci:` CI/CD changes
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
git commit -m "feat: add TLS certificate management"
|
||||
git commit -m "fix: correct proxy timeout handling"
|
||||
|
||||
131
WEBSOCKET_FIX_SUMMARY.md
Normal file
131
WEBSOCKET_FIX_SUMMARY.md
Normal file
@@ -0,0 +1,131 @@
|
||||
# WebSocket Live Log Viewer Fix
|
||||
|
||||
## Problem
|
||||
|
||||
The live log viewer in the Cerberus Dashboard was always showing "Disconnected" status even when it should connect to the WebSocket endpoint.
|
||||
|
||||
## Root Cause
|
||||
|
||||
The `LiveLogViewer` component was setting `isConnected=true` immediately when the component mounted, before the WebSocket actually established a connection. This premature status update masked the real connection state and made it impossible to see whether the WebSocket was actually connecting.
|
||||
|
||||
## Solution
|
||||
|
||||
Modified the WebSocket connection flow to properly track connection lifecycle:
|
||||
|
||||
### Frontend Changes
|
||||
|
||||
#### 1. API Layer (`frontend/src/api/logs.ts`)
|
||||
|
||||
- Added `onOpen?: () => void` callback parameter to `connectLiveLogs()`
|
||||
- Added `ws.onopen` event handler that calls the callback when connection opens
|
||||
- Enhanced logging for debugging:
|
||||
- Log WebSocket URL on connection attempt
|
||||
- Log when connection establishes
|
||||
- Log close event details (code, reason, wasClean)
|
||||
|
||||
#### 2. Component (`frontend/src/components/LiveLogViewer.tsx`)
|
||||
|
||||
- Updated to use the new `onOpen` callback
|
||||
- Initial state is now "Disconnected"
|
||||
- Only set `isConnected=true` when `onOpen` callback fires
|
||||
- Added console logging for connection state changes
|
||||
- Properly cleanup and set disconnected state on unmount
|
||||
|
||||
#### 3. Tests (`frontend/src/components/__tests__/LiveLogViewer.test.tsx`)
|
||||
|
||||
- Updated mock implementation to include `onOpen` callback
|
||||
- Fixed test expectations to match new behavior (initially Disconnected)
|
||||
- Added proper simulation of WebSocket opening
|
||||
|
||||
### Backend Changes (for debugging)
|
||||
|
||||
#### 1. Auth Middleware (`backend/internal/api/middleware/auth.go`)
|
||||
|
||||
- Added `fmt` import for logging
|
||||
- Detect WebSocket upgrade requests (`Upgrade: websocket` header)
|
||||
- Log auth method used for WebSocket (cookie vs query param)
|
||||
- Log auth failures with context
|
||||
|
||||
#### 2. WebSocket Handler (`backend/internal/api/handlers/logs_ws.go`)
|
||||
|
||||
- Added log on connection attempt received
|
||||
- Added log when connection successfully established with subscriber ID
|
||||
|
||||
## How Authentication Works
|
||||
|
||||
The WebSocket endpoint (`/api/v1/logs/live`) is protected by the auth middleware, which supports three authentication methods (in order):
|
||||
|
||||
1. **Authorization header**: `Authorization: Bearer <token>`
|
||||
2. **HttpOnly cookie**: `auth_token=<token>` (automatically sent by browser)
|
||||
3. **Query parameter**: `?token=<token>`
|
||||
|
||||
For same-origin WebSocket connections from a browser, **cookies are sent automatically**, so the existing cookie-based auth should work. The middleware has been enhanced with logging to debug any auth issues.
|
||||
|
||||
## Testing
|
||||
|
||||
To test the fix:
|
||||
|
||||
1. **Build and Deploy**:
|
||||
|
||||
```bash
|
||||
# Build Docker image
|
||||
docker build -t charon:local .
|
||||
|
||||
# Restart containers
|
||||
docker-compose -f docker-compose.local.yml down
|
||||
docker-compose -f docker-compose.local.yml up -d
|
||||
```
|
||||
|
||||
2. **Access the Application**:
|
||||
- Navigate to the Security page
|
||||
- Enable Cerberus if not already enabled
|
||||
- The LiveLogViewer should appear at the bottom
|
||||
|
||||
3. **Check Connection Status**:
|
||||
- Should initially show "Disconnected" (red badge)
|
||||
- Should change to "Connected" (green badge) within 1-2 seconds
|
||||
- Look for console logs:
|
||||
- "Connecting to WebSocket: ws://..."
|
||||
- "WebSocket connection established"
|
||||
- "Live log viewer connected"
|
||||
|
||||
4. **Verify WebSocket in DevTools**:
|
||||
- Open Browser DevTools → Network tab
|
||||
- Filter by "WS" (WebSocket)
|
||||
- Should see connection to `/api/v1/logs/live`
|
||||
- Status should be "101 Switching Protocols"
|
||||
- Messages tab should show incoming log entries
|
||||
|
||||
5. **Check Backend Logs**:
|
||||
|
||||
```bash
|
||||
docker logs <charon-container> 2>&1 | grep -i websocket
|
||||
```
|
||||
|
||||
Should see:
|
||||
- "WebSocket connection attempt received"
|
||||
- "WebSocket connection established successfully"
|
||||
|
||||
## Expected Behavior
|
||||
|
||||
- **Initial State**: "Disconnected" (red badge)
|
||||
- **After Connection**: "Connected" (green badge)
|
||||
- **Log Streaming**: Real-time security logs appear as they happen
|
||||
- **On Error**: Badge turns red, shows "Disconnected"
|
||||
- **Reconnection**: Not currently implemented (would require retry logic)
|
||||
|
||||
## Files Modified
|
||||
|
||||
- `frontend/src/api/logs.ts`
|
||||
- `frontend/src/components/LiveLogViewer.tsx`
|
||||
- `frontend/src/components/__tests__/LiveLogViewer.test.tsx`
|
||||
- `backend/internal/api/middleware/auth.go`
|
||||
- `backend/internal/api/handlers/logs_ws.go`
|
||||
|
||||
## Notes
|
||||
|
||||
- The fix properly implements the WebSocket lifecycle tracking
|
||||
- All frontend tests pass
|
||||
- Pre-commit checks pass (except coverage which is expected)
|
||||
- The backend logging is temporary for debugging and can be removed once verified working
|
||||
- SameSite=Strict cookie policy should work for same-origin WebSocket connections
|
||||
@@ -3,9 +3,11 @@
|
||||
This folder contains the Go API for CaddyProxyManager+.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Go 1.24+
|
||||
|
||||
## Getting started
|
||||
|
||||
```bash
|
||||
cp .env.example .env # optional
|
||||
cd backend
|
||||
@@ -13,6 +15,7 @@ go run ./cmd/api
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
go test ./...
|
||||
|
||||
BIN
backend/bin/api
BIN
backend/bin/api
Binary file not shown.
2120
backend/caddy.html
2120
backend/caddy.html
File diff suppressed because it is too large
Load Diff
@@ -1,3 +1,4 @@
|
||||
// Package main is the entry point for the Charon backend API.
|
||||
package main
|
||||
|
||||
import (
|
||||
|
||||
59
backend/cmd/api/main_test.go
Normal file
59
backend/cmd/api/main_test.go
Normal file
@@ -0,0 +1,59 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/database"
|
||||
"github.com/Wikid82/charon/backend/internal/models"
|
||||
)
|
||||
|
||||
func TestResetPasswordCommand_Succeeds(t *testing.T) {
|
||||
if os.Getenv("CHARON_TEST_RUN_MAIN") == "1" {
|
||||
// Child process: emulate CLI args and run main().
|
||||
email := os.Getenv("CHARON_TEST_EMAIL")
|
||||
newPassword := os.Getenv("CHARON_TEST_NEW_PASSWORD")
|
||||
os.Args = []string{"charon", "reset-password", email, newPassword}
|
||||
main()
|
||||
return
|
||||
}
|
||||
|
||||
tmp := t.TempDir()
|
||||
dbPath := filepath.Join(tmp, "data", "test.db")
|
||||
if err := os.MkdirAll(filepath.Dir(dbPath), 0o755); err != nil {
|
||||
t.Fatalf("mkdir db dir: %v", err)
|
||||
}
|
||||
|
||||
db, err := database.Connect(dbPath)
|
||||
if err != nil {
|
||||
t.Fatalf("connect db: %v", err)
|
||||
}
|
||||
if err := db.AutoMigrate(&models.User{}); err != nil {
|
||||
t.Fatalf("automigrate: %v", err)
|
||||
}
|
||||
|
||||
email := "user@example.com"
|
||||
user := models.User{UUID: "u-1", Email: email, Name: "User", Role: "admin", Enabled: true}
|
||||
user.PasswordHash = "$2a$10$example_hashed_password"
|
||||
if err := db.Create(&user).Error; err != nil {
|
||||
t.Fatalf("seed user: %v", err)
|
||||
}
|
||||
|
||||
cmd := exec.Command(os.Args[0], "-test.run=TestResetPasswordCommand_Succeeds")
|
||||
cmd.Dir = tmp
|
||||
cmd.Env = append(os.Environ(),
|
||||
"CHARON_TEST_RUN_MAIN=1",
|
||||
"CHARON_TEST_EMAIL="+email,
|
||||
"CHARON_TEST_NEW_PASSWORD=new-password",
|
||||
"CHARON_DB_PATH="+dbPath,
|
||||
"CHARON_CADDY_CONFIG_DIR="+filepath.Join(tmp, "caddy"),
|
||||
"CHARON_IMPORT_DIR="+filepath.Join(tmp, "imports"),
|
||||
)
|
||||
|
||||
out, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
t.Fatalf("expected exit 0; err=%v; output=%s", err, string(out))
|
||||
}
|
||||
}
|
||||
85
backend/cmd/seed/main_test.go
Normal file
85
backend/cmd/seed/main_test.go
Normal file
@@ -0,0 +1,85 @@
|
||||
//go:build ignore
|
||||
// +build ignore
|
||||
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestSeedMain_CreatesDatabaseFile(t *testing.T) {
|
||||
wd, err := os.Getwd()
|
||||
if err != nil {
|
||||
t.Fatalf("getwd: %v", err)
|
||||
}
|
||||
|
||||
tmp := t.TempDir()
|
||||
if err := os.Chdir(tmp); err != nil {
|
||||
t.Fatalf("chdir: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _ = os.Chdir(wd) })
|
||||
|
||||
if err := os.MkdirAll("data", 0o755); err != nil {
|
||||
t.Fatalf("mkdir data: %v", err)
|
||||
}
|
||||
|
||||
main()
|
||||
|
||||
dbPath := filepath.Join("data", "charon.db")
|
||||
info, err := os.Stat(dbPath)
|
||||
if err != nil {
|
||||
t.Fatalf("expected db file to exist at %s: %v", dbPath, err)
|
||||
}
|
||||
if info.Size() == 0 {
|
||||
t.Fatalf("expected db file to be non-empty")
|
||||
}
|
||||
}
|
||||
package main
|
||||
package main
|
||||
|
||||
import (
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
} } t.Fatalf("expected db file to be non-empty") if info.Size() == 0 { } t.Fatalf("expected db file to exist at %s: %v", dbPath, err) if err != nil { info, err := os.Stat(dbPath) dbPath := filepath.Join("data", "charon.db") main() } t.Fatalf("mkdir data: %v", err) if err := os.MkdirAll("data", 0o755); err != nil { t.Cleanup(func() { _ = os.Chdir(wd) }) } t.Fatalf("chdir: %v", err) if err := os.Chdir(tmp); err != nil { tmp := t.TempDir() } t.Fatalf("getwd: %v", err) if err != nil { wd, err := os.Getwd() t.Parallel()func TestSeedMain_CreatesDatabaseFile(t *testing.T) {) "testing" "path/filepath" "os"
|
||||
31
backend/cmd/seed/seed_smoke_test.go
Normal file
31
backend/cmd/seed/seed_smoke_test.go
Normal file
@@ -0,0 +1,31 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestSeedMain_Smoke(t *testing.T) {
|
||||
wd, err := os.Getwd()
|
||||
if err != nil {
|
||||
t.Fatalf("getwd: %v", err)
|
||||
}
|
||||
|
||||
tmp := t.TempDir()
|
||||
if err := os.Chdir(tmp); err != nil {
|
||||
t.Fatalf("chdir: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _ = os.Chdir(wd) })
|
||||
|
||||
if err := os.MkdirAll("data", 0o755); err != nil {
|
||||
t.Fatalf("mkdir data: %v", err)
|
||||
}
|
||||
|
||||
main()
|
||||
|
||||
p := filepath.Join("data", "charon.db")
|
||||
if _, err := os.Stat(p); err != nil {
|
||||
t.Fatalf("expected db file to exist: %v", err)
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -9,6 +9,8 @@ require (
|
||||
github.com/gin-gonic/gin v1.11.0
|
||||
github.com/golang-jwt/jwt/v5 v5.3.0
|
||||
github.com/google/uuid v1.6.0
|
||||
github.com/gorilla/websocket v1.5.3
|
||||
github.com/oschwald/geoip2-golang v1.13.0
|
||||
github.com/prometheus/client_golang v1.23.2
|
||||
github.com/robfig/cron/v3 v3.0.1
|
||||
github.com/sirupsen/logrus v1.9.3
|
||||
@@ -63,6 +65,7 @@ require (
|
||||
github.com/onsi/ginkgo/v2 v2.9.5 // indirect
|
||||
github.com/opencontainers/go-digest v1.0.0 // indirect
|
||||
github.com/opencontainers/image-spec v1.1.1 // indirect
|
||||
github.com/oschwald/maxminddb-golang v1.13.0 // indirect
|
||||
github.com/pelletier/go-toml/v2 v2.2.4 // indirect
|
||||
github.com/pkg/errors v0.9.1 // indirect
|
||||
github.com/pmezard/go-difflib v1.0.0 // indirect
|
||||
|
||||
@@ -77,6 +77,8 @@ github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38 h1:yAJXTCF9TqKcTiHJAE
|
||||
github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE=
|
||||
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
||||
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||
github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
|
||||
github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
|
||||
github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.2 h1:8Tjv8EJ+pM1xP8mK6egEbD1OgnVTyacbefKhmbLhIhU=
|
||||
github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.2/go.mod h1:pkJQ2tZHJ0aFOVEEot6oZmaVEZcRme73eIFmhiVuRWs=
|
||||
github.com/jarcoal/httpmock v1.3.0 h1:2RJ8GP0IIaWwcC9Fp2BmVi8Kog3v2Hn7VXM3fTd+nuc=
|
||||
@@ -131,6 +133,10 @@ github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8
|
||||
github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM=
|
||||
github.com/opencontainers/image-spec v1.1.1 h1:y0fUlFfIZhPF1W537XOLg0/fcx6zcHCJwooC2xJA040=
|
||||
github.com/opencontainers/image-spec v1.1.1/go.mod h1:qpqAh3Dmcf36wStyyWU+kCeDgrGnAve2nCC8+7h8Q0M=
|
||||
github.com/oschwald/geoip2-golang v1.13.0 h1:Q44/Ldc703pasJeP5V9+aFSZFmBN7DKHbNsSFzQATJI=
|
||||
github.com/oschwald/geoip2-golang v1.13.0/go.mod h1:P9zG+54KPEFOliZ29i7SeYZ/GM6tfEL+rgSn03hYuUo=
|
||||
github.com/oschwald/maxminddb-golang v1.13.0 h1:R8xBorY71s84yO06NgTmQvqvTvlS/bnYZrrWX1MElnU=
|
||||
github.com/oschwald/maxminddb-golang v1.13.0/go.mod h1:BU0z8BfFVhi1LQaonTwwGQlsHUEu9pWNdMfmq4ztm0o=
|
||||
github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4=
|
||||
github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
|
||||
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
|
||||
@@ -197,8 +203,6 @@ go.yaml.in/yaml/v2 v2.4.2 h1:DzmwEr2rDGHl7lsFgAHxmNz/1NlQ7xLIrlN2h5d1eGI=
|
||||
go.yaml.in/yaml/v2 v2.4.2/go.mod h1:081UH+NErpNdqlCXm3TtEran0rJZGxAYx9hb/ELlsPU=
|
||||
golang.org/x/arch v0.22.0 h1:c/Zle32i5ttqRXjdLyyHZESLD/bB90DCU1g9l/0YBDI=
|
||||
golang.org/x/arch v0.22.0/go.mod h1:dNHoOeKiyja7GTvF9NJS1l3Z2yntpQNzgrjh1cU103A=
|
||||
golang.org/x/crypto v0.45.0 h1:jMBrvKuj23MTlT0bQEOBcAE0mjg8mK9RXFhRH6nyF3Q=
|
||||
golang.org/x/crypto v0.45.0/go.mod h1:XTGrrkGJve7CYK7J8PEww4aY7gM3qMCElcJQ8n8JdX4=
|
||||
golang.org/x/crypto v0.46.0 h1:cKRW/pmt1pKAfetfu+RCEvjvZkA9RimPbh7bhFjGVBU=
|
||||
golang.org/x/crypto v0.46.0/go.mod h1:Evb/oLKmMraqjZ2iQTwDwvCtJkczlDuTmdJXoZVzqU0=
|
||||
golang.org/x/net v0.47.0 h1:Mx+4dIFzqraBXUugkia1OOvlD6LemFo1ALMHjrXDOhY=
|
||||
@@ -206,18 +210,14 @@ golang.org/x/net v0.47.0/go.mod h1:/jNxtkgq5yWUGYkaZGqo27cfGZ1c5Nen03aYrrKpVRU=
|
||||
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.38.0 h1:3yZWxaJjBmCWXqhN1qh02AkOnCQ1poK6oF+a7xWL6Gc=
|
||||
golang.org/x/sys v0.38.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
||||
golang.org/x/sys v0.39.0 h1:CvCKL8MeisomCi6qNZ+wbb0DN9E5AATixKsvNtMoMFk=
|
||||
golang.org/x/sys v0.39.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
||||
golang.org/x/text v0.31.0 h1:aC8ghyu4JhP8VojJ2lEHBnochRno1sgL6nEi9WGFGMM=
|
||||
golang.org/x/text v0.31.0/go.mod h1:tKRAlv61yKIjGGHX/4tP1LTbc13YSec1pxVEWXzfoeM=
|
||||
golang.org/x/text v0.32.0 h1:ZD01bjUt1FQ9WJ0ClOL5vxgxOI/sVCNgX1YtKwcY0mU=
|
||||
golang.org/x/text v0.32.0/go.mod h1:o/rUWzghvpD5TXrTIBuJU77MTaN0ljMWE47kxGJQ7jY=
|
||||
golang.org/x/time v0.14.0 h1:MRx4UaLrDotUKUdCIqzPC48t1Y9hANFKIRpNx+Te8PI=
|
||||
golang.org/x/time v0.14.0/go.mod h1:eL/Oa2bBBK0TkX57Fyni+NgnyQQN4LitPmob2Hjnqw4=
|
||||
golang.org/x/tools v0.38.0 h1:Hx2Xv8hISq8Lm16jvBZ2VQf+RLmbd7wVUsALibYI/IQ=
|
||||
golang.org/x/tools v0.38.0/go.mod h1:yEsQ/d/YK8cjh0L6rZlY8tgtlKiBNTL14pGDJPJpYQs=
|
||||
golang.org/x/tools v0.39.0 h1:ik4ho21kwuQln40uelmciQPp9SipgNDdrafrYA4TmQQ=
|
||||
golang.org/x/tools v0.39.0/go.mod h1:JnefbkDPyD8UU2kI5fuf8ZX4/yUeh9W877ZeBONxUqQ=
|
||||
google.golang.org/genproto/googleapis/api v0.0.0-20250825161204-c5933d9347a5 h1:BIRfGDEjiHRrk0QKZe3Xv2ieMhtgRGeLcZQ0mIVn4EY=
|
||||
google.golang.org/genproto/googleapis/api v0.0.0-20250825161204-c5933d9347a5/go.mod h1:j3QtIyytwqGr1JUDtYXwtMXWPKsEa5LtzIFN1Wn5WvE=
|
||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20250825161204-c5933d9347a5 h1:eaY8u2EuxbRv7c3NiGK0/NedzVsCcV6hDuU5qPX5EGE=
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
# github.com/Wikid82/charon/backend/internal/api/handlers
|
||||
internal/api/handlers/proxy_host_handler.go:255:26: uuid.New undefined (type string has no field or method New)
|
||||
FAIL github.com/Wikid82/charon/backend/cmd/api [build failed]
|
||||
? github.com/Wikid82/charon/backend/cmd/seed [no test files]
|
||||
FAIL github.com/Wikid82/charon/backend/internal/api/handlers [build failed]
|
||||
testing: warning: no tests to run
|
||||
PASS
|
||||
ok github.com/Wikid82/charon/backend/internal/api/middleware 0.016s [no tests to run]
|
||||
FAIL github.com/Wikid82/charon/backend/internal/api/routes [build failed]
|
||||
FAIL github.com/Wikid82/charon/backend/internal/api/tests [build failed]
|
||||
testing: warning: no tests to run
|
||||
PASS
|
||||
ok github.com/Wikid82/charon/backend/internal/caddy 0.007s [no tests to run]
|
||||
testing: warning: no tests to run
|
||||
PASS
|
||||
ok github.com/Wikid82/charon/backend/internal/cerberus 0.012s [no tests to run]
|
||||
testing: warning: no tests to run
|
||||
PASS
|
||||
ok github.com/Wikid82/charon/backend/internal/config 0.004s [no tests to run]
|
||||
testing: warning: no tests to run
|
||||
PASS
|
||||
ok github.com/Wikid82/charon/backend/internal/database 0.007s [no tests to run]
|
||||
? github.com/Wikid82/charon/backend/internal/logger [no test files]
|
||||
? github.com/Wikid82/charon/backend/internal/metrics [no test files]
|
||||
testing: warning: no tests to run
|
||||
PASS
|
||||
ok github.com/Wikid82/charon/backend/internal/models 0.006s [no tests to run]
|
||||
testing: warning: no tests to run
|
||||
PASS
|
||||
ok github.com/Wikid82/charon/backend/internal/server 0.007s [no tests to run]
|
||||
testing: warning: no tests to run
|
||||
PASS
|
||||
ok github.com/Wikid82/charon/backend/internal/services 0.008s [no tests to run]
|
||||
? github.com/Wikid82/charon/backend/internal/trace [no test files]
|
||||
? github.com/Wikid82/charon/backend/internal/util [no test files]
|
||||
testing: warning: no tests to run
|
||||
PASS
|
||||
ok github.com/Wikid82/charon/backend/internal/version 0.004s [no tests to run]
|
||||
FAIL
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
35
backend/integration/cerberus_integration_test.go
Normal file
35
backend/integration/cerberus_integration_test.go
Normal file
@@ -0,0 +1,35 @@
|
||||
//go:build integration
|
||||
// +build integration
|
||||
|
||||
package integration
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os/exec"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// TestCerberusIntegration runs the scripts/cerberus_integration.sh
|
||||
// to verify all security features work together without conflicts.
|
||||
func TestCerberusIntegration(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Minute)
|
||||
defer cancel()
|
||||
|
||||
cmd := exec.CommandContext(ctx, "bash", "./scripts/cerberus_integration.sh")
|
||||
cmd.Dir = "../.."
|
||||
|
||||
out, err := cmd.CombinedOutput()
|
||||
t.Logf("cerberus_integration script output:\n%s", string(out))
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("cerberus integration failed: %v", err)
|
||||
}
|
||||
|
||||
if !strings.Contains(string(out), "ALL CERBERUS INTEGRATION TESTS PASSED") {
|
||||
t.Fatalf("unexpected script output, expected pass assertion not found")
|
||||
}
|
||||
}
|
||||
@@ -4,31 +4,31 @@
|
||||
package integration
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os/exec"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
"context"
|
||||
"os/exec"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// TestCorazaIntegration runs the scripts/coraza_integration.sh and ensures it completes successfully.
|
||||
// This test requires Docker and docker compose access locally; it is gated behind build tag `integration`.
|
||||
func TestCorazaIntegration(t *testing.T) {
|
||||
t.Parallel()
|
||||
t.Parallel()
|
||||
|
||||
// Ensure the script exists
|
||||
cmd := exec.CommandContext(context.Background(), "bash", "./scripts/coraza_integration.sh")
|
||||
// set a timeout in case something hangs
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Minute)
|
||||
defer cancel()
|
||||
cmd = exec.CommandContext(ctx, "bash", "./scripts/coraza_integration.sh")
|
||||
// Ensure the script exists
|
||||
cmd := exec.CommandContext(context.Background(), "bash", "./scripts/coraza_integration.sh")
|
||||
// set a timeout in case something hangs
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Minute)
|
||||
defer cancel()
|
||||
cmd = exec.CommandContext(ctx, "bash", "./scripts/coraza_integration.sh")
|
||||
|
||||
out, err := cmd.CombinedOutput()
|
||||
t.Logf("coraza_integration script output:\n%s", string(out))
|
||||
if err != nil {
|
||||
t.Fatalf("coraza integration failed: %v", err)
|
||||
}
|
||||
if !strings.Contains(string(out), "Coraza WAF blocked payload as expected") {
|
||||
t.Fatalf("unexpected script output, expected blocking assertion not found")
|
||||
}
|
||||
out, err := cmd.CombinedOutput()
|
||||
t.Logf("coraza_integration script output:\n%s", string(out))
|
||||
if err != nil {
|
||||
t.Fatalf("coraza integration failed: %v", err)
|
||||
}
|
||||
if !strings.Contains(string(out), "Coraza WAF blocked payload as expected") {
|
||||
t.Fatalf("unexpected script output, expected blocking assertion not found")
|
||||
}
|
||||
}
|
||||
|
||||
98
backend/integration/crowdsec_decisions_integration_test.go
Normal file
98
backend/integration/crowdsec_decisions_integration_test.go
Normal file
@@ -0,0 +1,98 @@
|
||||
//go:build integration
|
||||
// +build integration
|
||||
|
||||
package integration
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os/exec"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// TestCrowdsecStartup runs the scripts/crowdsec_startup_test.sh and ensures
|
||||
// CrowdSec can start successfully without the fatal "no datasource enabled" error.
|
||||
// This is a focused test for verifying basic CrowdSec initialization.
|
||||
//
|
||||
// The test verifies:
|
||||
// - No "no datasource enabled" fatal error
|
||||
// - LAPI health endpoint responds (if CrowdSec is installed)
|
||||
// - Acquisition config exists with datasource definition
|
||||
// - Parsers and scenarios are installed (if cscli is available)
|
||||
//
|
||||
// This test requires Docker access and is gated behind build tag `integration`.
|
||||
func TestCrowdsecStartup(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// Set a timeout for the entire test
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
|
||||
defer cancel()
|
||||
|
||||
// Run the startup test script from the repo root
|
||||
cmd := exec.CommandContext(ctx, "bash", "../scripts/crowdsec_startup_test.sh")
|
||||
cmd.Dir = ".." // Run from repo root
|
||||
|
||||
out, err := cmd.CombinedOutput()
|
||||
t.Logf("crowdsec_startup_test script output:\n%s", string(out))
|
||||
|
||||
// Check for the specific fatal error that indicates CrowdSec is broken
|
||||
if strings.Contains(string(out), "no datasource enabled") {
|
||||
t.Fatal("CRITICAL: CrowdSec failed with 'no datasource enabled' - acquis.yaml is missing or empty")
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("crowdsec startup test failed: %v", err)
|
||||
}
|
||||
|
||||
// Verify success message is present
|
||||
if !strings.Contains(string(out), "ALL CROWDSEC STARTUP TESTS PASSED") {
|
||||
t.Fatalf("unexpected script output: final success message not found")
|
||||
}
|
||||
}
|
||||
|
||||
// TestCrowdsecDecisionsIntegration runs the scripts/crowdsec_decision_integration.sh and ensures it completes successfully.
|
||||
// This test requires Docker access locally; it is gated behind build tag `integration`.
|
||||
//
|
||||
// The test verifies:
|
||||
// - CrowdSec status endpoint works correctly
|
||||
// - Decisions list endpoint returns valid response
|
||||
// - Ban IP operation works (or gracefully handles missing cscli)
|
||||
// - Unban IP operation works (or gracefully handles missing cscli)
|
||||
// - Export endpoint returns valid response
|
||||
// - LAPI health endpoint returns valid response
|
||||
//
|
||||
// Note: CrowdSec binary may not be available in the test container.
|
||||
// Tests gracefully handle this scenario and skip operations requiring cscli.
|
||||
func TestCrowdsecDecisionsIntegration(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// Set a timeout for the entire test
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Minute)
|
||||
defer cancel()
|
||||
|
||||
// Run the integration script from the repo root
|
||||
cmd := exec.CommandContext(ctx, "bash", "../scripts/crowdsec_decision_integration.sh")
|
||||
cmd.Dir = ".." // Run from repo root
|
||||
|
||||
out, err := cmd.CombinedOutput()
|
||||
t.Logf("crowdsec_decision_integration script output:\n%s", string(out))
|
||||
|
||||
// Check for the specific fatal error that indicates CrowdSec is broken
|
||||
if strings.Contains(string(out), "no datasource enabled") {
|
||||
t.Fatal("CRITICAL: CrowdSec failed with 'no datasource enabled' - acquis.yaml is missing or empty")
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("crowdsec decision integration failed: %v", err)
|
||||
}
|
||||
|
||||
// Verify key assertions are present in output
|
||||
if !strings.Contains(string(out), "Passed:") {
|
||||
t.Fatalf("unexpected script output: pass count not found")
|
||||
}
|
||||
|
||||
if !strings.Contains(string(out), "ALL CROWDSEC DECISION TESTS PASSED") {
|
||||
t.Fatalf("unexpected script output: final success message not found")
|
||||
}
|
||||
}
|
||||
@@ -13,22 +13,22 @@ import (
|
||||
|
||||
// TestCrowdsecIntegration runs scripts/crowdsec_integration.sh and ensures it completes successfully.
|
||||
func TestCrowdsecIntegration(t *testing.T) {
|
||||
t.Parallel()
|
||||
t.Parallel()
|
||||
|
||||
cmd := exec.CommandContext(context.Background(), "bash", "./scripts/crowdsec_integration.sh")
|
||||
// Ensure script runs from repo root so relative paths in scripts work reliably
|
||||
cmd.Dir = "../../"
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Minute)
|
||||
defer cancel()
|
||||
cmd = exec.CommandContext(ctx, "bash", "./scripts/crowdsec_integration.sh")
|
||||
cmd.Dir = "../../"
|
||||
cmd := exec.CommandContext(context.Background(), "bash", "./scripts/crowdsec_integration.sh")
|
||||
// Ensure script runs from repo root so relative paths in scripts work reliably
|
||||
cmd.Dir = "../../"
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Minute)
|
||||
defer cancel()
|
||||
cmd = exec.CommandContext(ctx, "bash", "./scripts/crowdsec_integration.sh")
|
||||
cmd.Dir = "../../"
|
||||
|
||||
out, err := cmd.CombinedOutput()
|
||||
t.Logf("crowdsec_integration script output:\n%s", string(out))
|
||||
if err != nil {
|
||||
t.Fatalf("crowdsec integration failed: %v", err)
|
||||
}
|
||||
if !strings.Contains(string(out), "Apply response: ") {
|
||||
t.Fatalf("unexpected script output, expected Apply response in output")
|
||||
}
|
||||
out, err := cmd.CombinedOutput()
|
||||
t.Logf("crowdsec_integration script output:\n%s", string(out))
|
||||
if err != nil {
|
||||
t.Fatalf("crowdsec integration failed: %v", err)
|
||||
}
|
||||
if !strings.Contains(string(out), "Apply response: ") {
|
||||
t.Fatalf("unexpected script output, expected Apply response in output")
|
||||
}
|
||||
}
|
||||
|
||||
5
backend/integration/doc.go
Normal file
5
backend/integration/doc.go
Normal file
@@ -0,0 +1,5 @@
|
||||
// Package integration contains end-to-end integration tests.
|
||||
//
|
||||
// These tests are gated behind the "integration" build tag and require
|
||||
// a full environment (Docker, etc.) to run.
|
||||
package integration
|
||||
48
backend/integration/rate_limit_integration_test.go
Normal file
48
backend/integration/rate_limit_integration_test.go
Normal file
@@ -0,0 +1,48 @@
|
||||
//go:build integration
|
||||
// +build integration
|
||||
|
||||
package integration
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os/exec"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// TestRateLimitIntegration runs the scripts/rate_limit_integration.sh and ensures it completes successfully.
|
||||
// This test requires Docker and docker compose access locally; it is gated behind build tag `integration`.
|
||||
//
|
||||
// The test verifies:
|
||||
// - Rate limiting is correctly applied to proxy hosts
|
||||
// - Requests within the limit return HTTP 200
|
||||
// - Requests exceeding the limit return HTTP 429
|
||||
// - Rate limit window resets correctly
|
||||
func TestRateLimitIntegration(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// Set a timeout for the entire test (rate limit tests need time for window resets)
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Minute)
|
||||
defer cancel()
|
||||
|
||||
// Run the integration script from the repo root
|
||||
cmd := exec.CommandContext(ctx, "bash", "../scripts/rate_limit_integration.sh")
|
||||
cmd.Dir = ".." // Run from repo root
|
||||
|
||||
out, err := cmd.CombinedOutput()
|
||||
t.Logf("rate_limit_integration script output:\n%s", string(out))
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("rate limit integration failed: %v", err)
|
||||
}
|
||||
|
||||
// Verify key assertions are present in output
|
||||
if !strings.Contains(string(out), "Rate limit enforcement succeeded") {
|
||||
t.Fatalf("unexpected script output: rate limit enforcement assertion not found")
|
||||
}
|
||||
|
||||
if !strings.Contains(string(out), "ALL RATE LIMIT TESTS PASSED") {
|
||||
t.Fatalf("unexpected script output: final success message not found")
|
||||
}
|
||||
}
|
||||
34
backend/integration/waf_integration_test.go
Normal file
34
backend/integration/waf_integration_test.go
Normal file
@@ -0,0 +1,34 @@
|
||||
//go:build integration
|
||||
// +build integration
|
||||
|
||||
package integration
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os/exec"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// TestWAFIntegration runs the scripts/waf_integration.sh and ensures it completes successfully.
|
||||
func TestWAFIntegration(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Minute)
|
||||
defer cancel()
|
||||
|
||||
cmd := exec.CommandContext(ctx, "bash", "./scripts/waf_integration.sh")
|
||||
cmd.Dir = "../.."
|
||||
|
||||
out, err := cmd.CombinedOutput()
|
||||
t.Logf("waf_integration script output:\n%s", string(out))
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("waf integration failed: %v", err)
|
||||
}
|
||||
|
||||
if !strings.Contains(string(out), "ALL WAF TESTS PASSED") {
|
||||
t.Fatalf("unexpected script output, expected pass assertion not found")
|
||||
}
|
||||
}
|
||||
@@ -10,16 +10,23 @@ import (
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
|
||||
// AccessListHandler handles access list API requests.
|
||||
type AccessListHandler struct {
|
||||
service *services.AccessListService
|
||||
}
|
||||
|
||||
// NewAccessListHandler creates a new AccessListHandler.
|
||||
func NewAccessListHandler(db *gorm.DB) *AccessListHandler {
|
||||
return &AccessListHandler{
|
||||
service: services.NewAccessListService(db),
|
||||
}
|
||||
}
|
||||
|
||||
// SetGeoIPService sets the GeoIP service for geo-based ACL lookups.
|
||||
func (h *AccessListHandler) SetGeoIPService(geoipSvc *services.GeoIPService) {
|
||||
h.service.SetGeoIPService(geoipSvc)
|
||||
}
|
||||
|
||||
// Create handles POST /api/v1/access-lists
|
||||
func (h *AccessListHandler) Create(c *gin.Context) {
|
||||
var acl models.AccessList
|
||||
|
||||
@@ -7,12 +7,37 @@ import (
|
||||
"testing"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/models"
|
||||
"github.com/Wikid82/charon/backend/internal/services"
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"gorm.io/driver/sqlite"
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
|
||||
func TestAccessListHandler_SetGeoIPService(t *testing.T) {
|
||||
db, _ := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
|
||||
db.AutoMigrate(&models.AccessList{})
|
||||
|
||||
handler := NewAccessListHandler(db)
|
||||
|
||||
// Test setting GeoIP service
|
||||
geoipSvc := &services.GeoIPService{}
|
||||
handler.SetGeoIPService(geoipSvc)
|
||||
|
||||
// No error or panic means success - the function is a simple setter
|
||||
// We can't easily verify the internal state, but we can verify it doesn't panic
|
||||
}
|
||||
|
||||
func TestAccessListHandler_SetGeoIPService_Nil(t *testing.T) {
|
||||
db, _ := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
|
||||
db.AutoMigrate(&models.AccessList{})
|
||||
|
||||
handler := NewAccessListHandler(db)
|
||||
|
||||
// Test setting nil GeoIP service (should not panic)
|
||||
handler.SetGeoIPService(nil)
|
||||
}
|
||||
|
||||
func TestAccessListHandler_Get_InvalidID(t *testing.T) {
|
||||
router, _ := setupAccessListTestRouter(t)
|
||||
|
||||
@@ -250,3 +275,24 @@ func TestAccessListHandler_TestIP_LocalNetworkOnly(t *testing.T) {
|
||||
|
||||
assert.Equal(t, http.StatusOK, w.Code)
|
||||
}
|
||||
|
||||
func TestAccessListHandler_TestIP_InternalError(t *testing.T) {
|
||||
// Create DB without migrating AccessList to cause internal error
|
||||
db, _ := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
|
||||
// Don't migrate - this causes a "no such table" error which is an internal error
|
||||
|
||||
gin.SetMode(gin.TestMode)
|
||||
router := gin.New()
|
||||
|
||||
handler := NewAccessListHandler(db)
|
||||
router.POST("/access-lists/:id/test", handler.TestIP)
|
||||
|
||||
body := []byte(`{"ip_address":"192.168.1.1"}`)
|
||||
req := httptest.NewRequest(http.MethodPost, "/access-lists/1/test", bytes.NewReader(body))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
w := httptest.NewRecorder()
|
||||
router.ServeHTTP(w, req)
|
||||
|
||||
// Should return 500 since table doesn't exist (internal error, not ErrAccessListNotFound)
|
||||
assert.Equal(t, http.StatusInternalServerError, w.Code)
|
||||
}
|
||||
|
||||
@@ -32,13 +32,32 @@ func isProduction() bool {
|
||||
return env == "production" || env == "prod"
|
||||
}
|
||||
|
||||
func requestScheme(c *gin.Context) string {
|
||||
if proto := c.GetHeader("X-Forwarded-Proto"); proto != "" {
|
||||
// Honor first entry in a comma-separated header
|
||||
parts := strings.Split(proto, ",")
|
||||
return strings.ToLower(strings.TrimSpace(parts[0]))
|
||||
}
|
||||
if c.Request != nil && c.Request.TLS != nil {
|
||||
return "https"
|
||||
}
|
||||
if c.Request != nil && c.Request.URL != nil && c.Request.URL.Scheme != "" {
|
||||
return strings.ToLower(c.Request.URL.Scheme)
|
||||
}
|
||||
return "http"
|
||||
}
|
||||
|
||||
// setSecureCookie sets an auth cookie with security best practices
|
||||
// - HttpOnly: prevents JavaScript access (XSS protection)
|
||||
// - Secure: only sent over HTTPS (in production)
|
||||
// - SameSite=Strict: prevents CSRF attacks
|
||||
// - Secure: derived from request scheme to allow HTTP/IP logins when needed
|
||||
// - SameSite: Strict for HTTPS, Lax for HTTP/IP to allow forward-auth redirects
|
||||
func setSecureCookie(c *gin.Context, name, value string, maxAge int) {
|
||||
secure := isProduction()
|
||||
scheme := requestScheme(c)
|
||||
secure := isProduction() && scheme == "https"
|
||||
sameSite := http.SameSiteStrictMode
|
||||
if scheme != "https" {
|
||||
sameSite = http.SameSiteLaxMode
|
||||
}
|
||||
|
||||
// Use the host without port for domain
|
||||
domain := ""
|
||||
@@ -78,7 +97,7 @@ func (h *AuthHandler) Login(c *gin.Context) {
|
||||
return
|
||||
}
|
||||
|
||||
// Set secure cookie (HttpOnly, Secure in prod, SameSite=Strict)
|
||||
// Set secure cookie (scheme-aware) and return token for header fallback
|
||||
setSecureCookie(c, "auth_token", token, 3600*24)
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{"token": token})
|
||||
|
||||
@@ -5,6 +5,7 @@ import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/config"
|
||||
@@ -60,6 +61,39 @@ func TestAuthHandler_Login(t *testing.T) {
|
||||
assert.Contains(t, w.Body.String(), "token")
|
||||
}
|
||||
|
||||
func TestSetSecureCookie_HTTPS_Strict(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
os.Setenv("CHARON_ENV", "production")
|
||||
defer os.Unsetenv("CHARON_ENV")
|
||||
recorder := httptest.NewRecorder()
|
||||
ctx, _ := gin.CreateTestContext(recorder)
|
||||
req := httptest.NewRequest("POST", "https://example.com/login", http.NoBody)
|
||||
ctx.Request = req
|
||||
|
||||
setSecureCookie(ctx, "auth_token", "abc", 60)
|
||||
cookies := recorder.Result().Cookies()
|
||||
require.Len(t, cookies, 1)
|
||||
c := cookies[0]
|
||||
assert.True(t, c.Secure)
|
||||
assert.Equal(t, http.SameSiteStrictMode, c.SameSite)
|
||||
}
|
||||
|
||||
func TestSetSecureCookie_HTTP_Lax(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
recorder := httptest.NewRecorder()
|
||||
ctx, _ := gin.CreateTestContext(recorder)
|
||||
req := httptest.NewRequest("POST", "http://192.0.2.10/login", http.NoBody)
|
||||
req.Header.Set("X-Forwarded-Proto", "http")
|
||||
ctx.Request = req
|
||||
|
||||
setSecureCookie(ctx, "auth_token", "abc", 60)
|
||||
cookies := recorder.Result().Cookies()
|
||||
require.Len(t, cookies, 1)
|
||||
c := cookies[0]
|
||||
assert.False(t, c.Secure)
|
||||
assert.Equal(t, http.SameSiteLaxMode, c.SameSite)
|
||||
}
|
||||
|
||||
func TestAuthHandler_Login_Errors(t *testing.T) {
|
||||
handler, _ := setupAuthHandler(t)
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
@@ -50,7 +50,7 @@ func BenchmarkSecurityHandler_GetStatus(b *testing.B) {
|
||||
|
||||
// Seed settings
|
||||
settings := []models.Setting{
|
||||
{Key: "security.cerberus.enabled", Value: "true", Category: "security"},
|
||||
{Key: "feature.cerberus.enabled", Value: "true", Category: "feature"},
|
||||
{Key: "security.waf.enabled", Value: "true", Category: "security"},
|
||||
{Key: "security.rate_limit.enabled", Value: "true", Category: "security"},
|
||||
{Key: "security.crowdsec.enabled", Value: "true", Category: "security"},
|
||||
@@ -305,7 +305,7 @@ func BenchmarkSecurityHandler_GetStatus_Parallel(b *testing.B) {
|
||||
db := setupBenchmarkDB(b)
|
||||
|
||||
settings := []models.Setting{
|
||||
{Key: "security.cerberus.enabled", Value: "true", Category: "security"},
|
||||
{Key: "feature.cerberus.enabled", Value: "true", Category: "feature"},
|
||||
{Key: "security.waf.enabled", Value: "true", Category: "security"},
|
||||
}
|
||||
for _, s := range settings {
|
||||
@@ -431,7 +431,7 @@ func BenchmarkSecurityHandler_ManySettingsLookups(b *testing.B) {
|
||||
}
|
||||
// Security settings
|
||||
settings := []models.Setting{
|
||||
{Key: "security.cerberus.enabled", Value: "true", Category: "security"},
|
||||
{Key: "feature.cerberus.enabled", Value: "true", Category: "feature"},
|
||||
{Key: "security.waf.enabled", Value: "true", Category: "security"},
|
||||
{Key: "security.rate_limit.enabled", Value: "true", Category: "security"},
|
||||
{Key: "security.crowdsec.enabled", Value: "true", Category: "security"},
|
||||
|
||||
133
backend/internal/api/handlers/cerberus_logs_ws.go
Normal file
133
backend/internal/api/handlers/cerberus_logs_ws.go
Normal file
@@ -0,0 +1,133 @@
|
||||
// Package handlers provides HTTP request handlers for the API.
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/google/uuid"
|
||||
"github.com/gorilla/websocket"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/logger"
|
||||
"github.com/Wikid82/charon/backend/internal/services"
|
||||
)
|
||||
|
||||
// CerberusLogsHandler handles WebSocket connections for streaming security logs.
|
||||
type CerberusLogsHandler struct {
|
||||
watcher *services.LogWatcher
|
||||
}
|
||||
|
||||
// NewCerberusLogsHandler creates a new handler for Cerberus security log streaming.
|
||||
func NewCerberusLogsHandler(watcher *services.LogWatcher) *CerberusLogsHandler {
|
||||
return &CerberusLogsHandler{watcher: watcher}
|
||||
}
|
||||
|
||||
// LiveLogs handles WebSocket connections for Cerberus security log streaming.
|
||||
// It upgrades the HTTP connection to WebSocket, subscribes to the LogWatcher,
|
||||
// and streams SecurityLogEntry as JSON to connected clients.
|
||||
//
|
||||
// Query parameters for filtering:
|
||||
// - source: filter by source (waf, crowdsec, ratelimit, acl, normal)
|
||||
// - blocked_only: only show blocked requests (true/false)
|
||||
// - level: filter by log level (info, warn, error)
|
||||
// - ip: filter by client IP (partial match)
|
||||
// - host: filter by host (partial match)
|
||||
func (h *CerberusLogsHandler) LiveLogs(c *gin.Context) {
|
||||
logger.Log().Info("Cerberus logs WebSocket connection attempt")
|
||||
|
||||
// Upgrade HTTP connection to WebSocket
|
||||
conn, err := upgrader.Upgrade(c.Writer, c.Request, nil)
|
||||
if err != nil {
|
||||
logger.Log().WithError(err).Error("Failed to upgrade Cerberus logs WebSocket")
|
||||
return
|
||||
}
|
||||
defer func() {
|
||||
if err := conn.Close(); err != nil {
|
||||
logger.Log().WithError(err).Debug("Failed to close Cerberus logs WebSocket connection")
|
||||
}
|
||||
}()
|
||||
|
||||
// Generate unique subscriber ID for logging
|
||||
subscriberID := uuid.New().String()
|
||||
logger.Log().WithField("subscriber_id", subscriberID).Info("Cerberus logs WebSocket connected")
|
||||
|
||||
// Parse query filters
|
||||
sourceFilter := strings.ToLower(c.Query("source")) // waf, crowdsec, ratelimit, acl, normal
|
||||
levelFilter := strings.ToLower(c.Query("level")) // info, warn, error
|
||||
ipFilter := c.Query("ip") // Partial match on client IP
|
||||
hostFilter := strings.ToLower(c.Query("host")) // Partial match on host
|
||||
blockedOnly := c.Query("blocked_only") == "true" // Only show blocked requests
|
||||
|
||||
// Subscribe to log watcher
|
||||
logChan := h.watcher.Subscribe()
|
||||
defer h.watcher.Unsubscribe(logChan)
|
||||
|
||||
// Channel to detect client disconnect
|
||||
done := make(chan struct{})
|
||||
go func() {
|
||||
defer close(done)
|
||||
for {
|
||||
if _, _, err := conn.ReadMessage(); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
}()
|
||||
|
||||
// Keep-alive ticker
|
||||
ticker := time.NewTicker(30 * time.Second)
|
||||
defer ticker.Stop()
|
||||
|
||||
for {
|
||||
select {
|
||||
case entry, ok := <-logChan:
|
||||
if !ok {
|
||||
// Channel closed, log watcher stopped
|
||||
return
|
||||
}
|
||||
|
||||
// Apply source filter
|
||||
if sourceFilter != "" && !strings.EqualFold(entry.Source, sourceFilter) {
|
||||
continue
|
||||
}
|
||||
|
||||
// Apply level filter
|
||||
if levelFilter != "" && !strings.EqualFold(entry.Level, levelFilter) {
|
||||
continue
|
||||
}
|
||||
|
||||
// Apply IP filter (partial match)
|
||||
if ipFilter != "" && !strings.Contains(entry.ClientIP, ipFilter) {
|
||||
continue
|
||||
}
|
||||
|
||||
// Apply host filter (partial match, case-insensitive)
|
||||
if hostFilter != "" && !strings.Contains(strings.ToLower(entry.Host), hostFilter) {
|
||||
continue
|
||||
}
|
||||
|
||||
// Apply blocked_only filter
|
||||
if blockedOnly && !entry.Blocked {
|
||||
continue
|
||||
}
|
||||
|
||||
// Send to WebSocket client
|
||||
if err := conn.WriteJSON(entry); err != nil {
|
||||
logger.Log().WithError(err).WithField("subscriber_id", subscriberID).Debug("Failed to write Cerberus log to WebSocket")
|
||||
return
|
||||
}
|
||||
|
||||
case <-ticker.C:
|
||||
// Send ping to keep connection alive
|
||||
if err := conn.WriteMessage(websocket.PingMessage, []byte{}); err != nil {
|
||||
logger.Log().WithError(err).WithField("subscriber_id", subscriberID).Debug("Failed to send ping to Cerberus logs WebSocket")
|
||||
return
|
||||
}
|
||||
|
||||
case <-done:
|
||||
// Client disconnected
|
||||
logger.Log().WithField("subscriber_id", subscriberID).Info("Cerberus logs WebSocket client disconnected")
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
501
backend/internal/api/handlers/cerberus_logs_ws_test.go
Normal file
501
backend/internal/api/handlers/cerberus_logs_ws_test.go
Normal file
@@ -0,0 +1,501 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/gorilla/websocket"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/models"
|
||||
"github.com/Wikid82/charon/backend/internal/services"
|
||||
)
|
||||
|
||||
func init() {
|
||||
gin.SetMode(gin.TestMode)
|
||||
}
|
||||
|
||||
// TestCerberusLogsHandler_NewHandler verifies handler creation.
|
||||
func TestCerberusLogsHandler_NewHandler(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
watcher := services.NewLogWatcher("/tmp/test.log")
|
||||
handler := NewCerberusLogsHandler(watcher)
|
||||
|
||||
assert.NotNil(t, handler)
|
||||
assert.Equal(t, watcher, handler.watcher)
|
||||
}
|
||||
|
||||
// TestCerberusLogsHandler_SuccessfulConnection verifies WebSocket upgrade.
|
||||
func TestCerberusLogsHandler_SuccessfulConnection(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tmpDir := t.TempDir()
|
||||
logPath := filepath.Join(tmpDir, "access.log")
|
||||
|
||||
// Create the log file
|
||||
_, err := os.Create(logPath)
|
||||
require.NoError(t, err)
|
||||
|
||||
watcher := services.NewLogWatcher(logPath)
|
||||
err = watcher.Start(context.Background())
|
||||
require.NoError(t, err)
|
||||
defer watcher.Stop()
|
||||
|
||||
handler := NewCerberusLogsHandler(watcher)
|
||||
|
||||
// Create test server
|
||||
router := gin.New()
|
||||
router.GET("/ws", handler.LiveLogs)
|
||||
server := httptest.NewServer(router)
|
||||
defer server.Close()
|
||||
|
||||
// Convert HTTP URL to WebSocket URL
|
||||
wsURL := "ws" + strings.TrimPrefix(server.URL, "http") + "/ws"
|
||||
|
||||
// Connect WebSocket
|
||||
conn, resp, err := websocket.DefaultDialer.Dial(wsURL, nil)
|
||||
require.NoError(t, err)
|
||||
defer resp.Body.Close()
|
||||
defer conn.Close()
|
||||
|
||||
assert.Equal(t, http.StatusSwitchingProtocols, resp.StatusCode)
|
||||
}
|
||||
|
||||
// TestCerberusLogsHandler_ReceiveLogEntries verifies log streaming.
|
||||
func TestCerberusLogsHandler_ReceiveLogEntries(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tmpDir := t.TempDir()
|
||||
logPath := filepath.Join(tmpDir, "access.log")
|
||||
|
||||
// Create the log file
|
||||
file, err := os.Create(logPath)
|
||||
require.NoError(t, err)
|
||||
defer file.Close()
|
||||
|
||||
watcher := services.NewLogWatcher(logPath)
|
||||
err = watcher.Start(context.Background())
|
||||
require.NoError(t, err)
|
||||
defer watcher.Stop()
|
||||
|
||||
handler := NewCerberusLogsHandler(watcher)
|
||||
|
||||
// Create test server
|
||||
router := gin.New()
|
||||
router.GET("/ws", handler.LiveLogs)
|
||||
server := httptest.NewServer(router)
|
||||
defer server.Close()
|
||||
|
||||
// Connect WebSocket
|
||||
wsURL := "ws" + strings.TrimPrefix(server.URL, "http") + "/ws"
|
||||
conn, _, err := websocket.DefaultDialer.Dial(wsURL, nil) //nolint:bodyclose // WebSocket Dial response body is consumed by the dial
|
||||
require.NoError(t, err)
|
||||
defer conn.Close()
|
||||
|
||||
// Give the subscription time to register and watcher to seek to end
|
||||
time.Sleep(300 * time.Millisecond)
|
||||
|
||||
// Write a log entry
|
||||
caddyLog := models.CaddyAccessLog{
|
||||
Level: "info",
|
||||
Ts: float64(time.Now().Unix()),
|
||||
Logger: "http.log.access",
|
||||
Msg: "handled request",
|
||||
Status: 200,
|
||||
}
|
||||
caddyLog.Request.RemoteIP = "10.0.0.1"
|
||||
caddyLog.Request.Method = "GET"
|
||||
caddyLog.Request.URI = "/test"
|
||||
caddyLog.Request.Host = "example.com"
|
||||
|
||||
logJSON, err := json.Marshal(caddyLog)
|
||||
require.NoError(t, err)
|
||||
_, err = file.WriteString(string(logJSON) + "\n")
|
||||
require.NoError(t, err)
|
||||
file.Sync()
|
||||
|
||||
// Read the entry from WebSocket
|
||||
conn.SetReadDeadline(time.Now().Add(2 * time.Second))
|
||||
_, msg, err := conn.ReadMessage()
|
||||
require.NoError(t, err)
|
||||
|
||||
var entry models.SecurityLogEntry
|
||||
err = json.Unmarshal(msg, &entry)
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Equal(t, "10.0.0.1", entry.ClientIP)
|
||||
assert.Equal(t, "GET", entry.Method)
|
||||
assert.Equal(t, "/test", entry.URI)
|
||||
assert.Equal(t, 200, entry.Status)
|
||||
assert.Equal(t, "normal", entry.Source)
|
||||
assert.False(t, entry.Blocked)
|
||||
}
|
||||
|
||||
// TestCerberusLogsHandler_SourceFilter verifies source filtering.
|
||||
func TestCerberusLogsHandler_SourceFilter(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tmpDir := t.TempDir()
|
||||
logPath := filepath.Join(tmpDir, "access.log")
|
||||
|
||||
file, err := os.Create(logPath)
|
||||
require.NoError(t, err)
|
||||
defer file.Close()
|
||||
|
||||
watcher := services.NewLogWatcher(logPath)
|
||||
err = watcher.Start(context.Background())
|
||||
require.NoError(t, err)
|
||||
defer watcher.Stop()
|
||||
|
||||
handler := NewCerberusLogsHandler(watcher)
|
||||
|
||||
router := gin.New()
|
||||
router.GET("/ws", handler.LiveLogs)
|
||||
server := httptest.NewServer(router)
|
||||
defer server.Close()
|
||||
|
||||
// Connect with WAF source filter
|
||||
wsURL := "ws" + strings.TrimPrefix(server.URL, "http") + "/ws?source=waf"
|
||||
conn, _, err := websocket.DefaultDialer.Dial(wsURL, nil) //nolint:bodyclose // WebSocket Dial response body is consumed by the dial
|
||||
require.NoError(t, err)
|
||||
defer conn.Close()
|
||||
|
||||
time.Sleep(300 * time.Millisecond)
|
||||
|
||||
// Write a normal request (should be filtered out)
|
||||
normalLog := models.CaddyAccessLog{
|
||||
Level: "info",
|
||||
Ts: float64(time.Now().Unix()),
|
||||
Logger: "http.log.access",
|
||||
Msg: "handled request",
|
||||
Status: 200,
|
||||
}
|
||||
normalLog.Request.RemoteIP = "10.0.0.1"
|
||||
normalLog.Request.Method = "GET"
|
||||
normalLog.Request.URI = "/normal"
|
||||
normalLog.Request.Host = "example.com"
|
||||
|
||||
normalJSON, _ := json.Marshal(normalLog)
|
||||
file.WriteString(string(normalJSON) + "\n")
|
||||
|
||||
// Write a WAF blocked request (should pass filter)
|
||||
wafLog := models.CaddyAccessLog{
|
||||
Level: "info",
|
||||
Ts: float64(time.Now().Unix()),
|
||||
Logger: "http.handlers.waf",
|
||||
Msg: "request blocked",
|
||||
Status: 403,
|
||||
RespHeaders: map[string][]string{"X-Coraza-Id": {"942100"}},
|
||||
}
|
||||
wafLog.Request.RemoteIP = "10.0.0.2"
|
||||
wafLog.Request.Method = "POST"
|
||||
wafLog.Request.URI = "/admin"
|
||||
wafLog.Request.Host = "example.com"
|
||||
|
||||
wafJSON, _ := json.Marshal(wafLog)
|
||||
file.WriteString(string(wafJSON) + "\n")
|
||||
file.Sync()
|
||||
|
||||
// Read from WebSocket - should only get WAF entry
|
||||
conn.SetReadDeadline(time.Now().Add(2 * time.Second))
|
||||
_, msg, err := conn.ReadMessage()
|
||||
require.NoError(t, err)
|
||||
|
||||
var entry models.SecurityLogEntry
|
||||
err = json.Unmarshal(msg, &entry)
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Equal(t, "waf", entry.Source)
|
||||
assert.Equal(t, "10.0.0.2", entry.ClientIP)
|
||||
assert.True(t, entry.Blocked)
|
||||
}
|
||||
|
||||
// TestCerberusLogsHandler_BlockedOnlyFilter verifies blocked_only filtering.
|
||||
func TestCerberusLogsHandler_BlockedOnlyFilter(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tmpDir := t.TempDir()
|
||||
logPath := filepath.Join(tmpDir, "access.log")
|
||||
|
||||
file, err := os.Create(logPath)
|
||||
require.NoError(t, err)
|
||||
defer file.Close()
|
||||
|
||||
watcher := services.NewLogWatcher(logPath)
|
||||
err = watcher.Start(context.Background())
|
||||
require.NoError(t, err)
|
||||
defer watcher.Stop()
|
||||
|
||||
handler := NewCerberusLogsHandler(watcher)
|
||||
|
||||
router := gin.New()
|
||||
router.GET("/ws", handler.LiveLogs)
|
||||
server := httptest.NewServer(router)
|
||||
defer server.Close()
|
||||
|
||||
// Connect with blocked_only filter
|
||||
wsURL := "ws" + strings.TrimPrefix(server.URL, "http") + "/ws?blocked_only=true"
|
||||
conn, _, err := websocket.DefaultDialer.Dial(wsURL, nil) //nolint:bodyclose // WebSocket Dial response body is consumed by the dial
|
||||
require.NoError(t, err)
|
||||
defer conn.Close()
|
||||
|
||||
time.Sleep(300 * time.Millisecond)
|
||||
|
||||
// Write a normal 200 request (should be filtered out)
|
||||
normalLog := models.CaddyAccessLog{
|
||||
Level: "info",
|
||||
Ts: float64(time.Now().Unix()),
|
||||
Logger: "http.log.access",
|
||||
Msg: "handled request",
|
||||
Status: 200,
|
||||
}
|
||||
normalLog.Request.RemoteIP = "10.0.0.1"
|
||||
normalLog.Request.Method = "GET"
|
||||
normalLog.Request.URI = "/ok"
|
||||
normalLog.Request.Host = "example.com"
|
||||
|
||||
normalJSON, _ := json.Marshal(normalLog)
|
||||
file.WriteString(string(normalJSON) + "\n")
|
||||
|
||||
// Write a rate limited request (should pass filter)
|
||||
blockedLog := models.CaddyAccessLog{
|
||||
Level: "info",
|
||||
Ts: float64(time.Now().Unix()),
|
||||
Logger: "http.log.access",
|
||||
Msg: "handled request",
|
||||
Status: 429,
|
||||
}
|
||||
blockedLog.Request.RemoteIP = "10.0.0.2"
|
||||
blockedLog.Request.Method = "GET"
|
||||
blockedLog.Request.URI = "/limited"
|
||||
blockedLog.Request.Host = "example.com"
|
||||
|
||||
blockedJSON, _ := json.Marshal(blockedLog)
|
||||
file.WriteString(string(blockedJSON) + "\n")
|
||||
file.Sync()
|
||||
|
||||
// Read from WebSocket - should only get blocked entry
|
||||
conn.SetReadDeadline(time.Now().Add(2 * time.Second))
|
||||
_, msg, err := conn.ReadMessage()
|
||||
require.NoError(t, err)
|
||||
|
||||
var entry models.SecurityLogEntry
|
||||
err = json.Unmarshal(msg, &entry)
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.True(t, entry.Blocked)
|
||||
assert.Equal(t, "ratelimit", entry.Source)
|
||||
}
|
||||
|
||||
// TestCerberusLogsHandler_IPFilter verifies IP filtering.
|
||||
func TestCerberusLogsHandler_IPFilter(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tmpDir := t.TempDir()
|
||||
logPath := filepath.Join(tmpDir, "access.log")
|
||||
|
||||
file, err := os.Create(logPath)
|
||||
require.NoError(t, err)
|
||||
defer file.Close()
|
||||
|
||||
watcher := services.NewLogWatcher(logPath)
|
||||
err = watcher.Start(context.Background())
|
||||
require.NoError(t, err)
|
||||
defer watcher.Stop()
|
||||
|
||||
handler := NewCerberusLogsHandler(watcher)
|
||||
|
||||
router := gin.New()
|
||||
router.GET("/ws", handler.LiveLogs)
|
||||
server := httptest.NewServer(router)
|
||||
defer server.Close()
|
||||
|
||||
// Connect with IP filter
|
||||
wsURL := "ws" + strings.TrimPrefix(server.URL, "http") + "/ws?ip=192.168"
|
||||
conn, _, err := websocket.DefaultDialer.Dial(wsURL, nil) //nolint:bodyclose // WebSocket Dial response body is consumed by the dial
|
||||
require.NoError(t, err)
|
||||
defer conn.Close()
|
||||
|
||||
time.Sleep(300 * time.Millisecond)
|
||||
|
||||
// Write request from non-matching IP
|
||||
log1 := models.CaddyAccessLog{
|
||||
Level: "info",
|
||||
Ts: float64(time.Now().Unix()),
|
||||
Logger: "http.log.access",
|
||||
Msg: "handled request",
|
||||
Status: 200,
|
||||
}
|
||||
log1.Request.RemoteIP = "10.0.0.1"
|
||||
log1.Request.Method = "GET"
|
||||
log1.Request.URI = "/test1"
|
||||
log1.Request.Host = "example.com"
|
||||
|
||||
json1, _ := json.Marshal(log1)
|
||||
file.WriteString(string(json1) + "\n")
|
||||
|
||||
// Write request from matching IP
|
||||
log2 := models.CaddyAccessLog{
|
||||
Level: "info",
|
||||
Ts: float64(time.Now().Unix()),
|
||||
Logger: "http.log.access",
|
||||
Msg: "handled request",
|
||||
Status: 200,
|
||||
}
|
||||
log2.Request.RemoteIP = "192.168.1.100"
|
||||
log2.Request.Method = "POST"
|
||||
log2.Request.URI = "/test2"
|
||||
log2.Request.Host = "example.com"
|
||||
|
||||
json2, _ := json.Marshal(log2)
|
||||
file.WriteString(string(json2) + "\n")
|
||||
file.Sync()
|
||||
|
||||
// Read from WebSocket - should only get matching IP entry
|
||||
conn.SetReadDeadline(time.Now().Add(2 * time.Second))
|
||||
_, msg, err := conn.ReadMessage()
|
||||
require.NoError(t, err)
|
||||
|
||||
var entry models.SecurityLogEntry
|
||||
err = json.Unmarshal(msg, &entry)
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Equal(t, "192.168.1.100", entry.ClientIP)
|
||||
}
|
||||
|
||||
// TestCerberusLogsHandler_ClientDisconnect verifies cleanup on disconnect.
|
||||
func TestCerberusLogsHandler_ClientDisconnect(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tmpDir := t.TempDir()
|
||||
logPath := filepath.Join(tmpDir, "access.log")
|
||||
|
||||
_, err := os.Create(logPath)
|
||||
require.NoError(t, err)
|
||||
|
||||
watcher := services.NewLogWatcher(logPath)
|
||||
err = watcher.Start(context.Background())
|
||||
require.NoError(t, err)
|
||||
defer watcher.Stop()
|
||||
|
||||
handler := NewCerberusLogsHandler(watcher)
|
||||
|
||||
router := gin.New()
|
||||
router.GET("/ws", handler.LiveLogs)
|
||||
server := httptest.NewServer(router)
|
||||
defer server.Close()
|
||||
|
||||
wsURL := "ws" + strings.TrimPrefix(server.URL, "http") + "/ws"
|
||||
conn, _, err := websocket.DefaultDialer.Dial(wsURL, nil) //nolint:bodyclose // WebSocket Dial response body is consumed by the dial
|
||||
require.NoError(t, err)
|
||||
|
||||
// Close the connection
|
||||
conn.Close()
|
||||
|
||||
// Give time for cleanup
|
||||
time.Sleep(100 * time.Millisecond)
|
||||
|
||||
// Should not panic or leave dangling goroutines
|
||||
}
|
||||
|
||||
// TestCerberusLogsHandler_MultipleClients verifies multiple concurrent clients.
|
||||
func TestCerberusLogsHandler_MultipleClients(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tmpDir := t.TempDir()
|
||||
logPath := filepath.Join(tmpDir, "access.log")
|
||||
|
||||
file, err := os.Create(logPath)
|
||||
require.NoError(t, err)
|
||||
defer file.Close()
|
||||
|
||||
watcher := services.NewLogWatcher(logPath)
|
||||
err = watcher.Start(context.Background())
|
||||
require.NoError(t, err)
|
||||
defer watcher.Stop()
|
||||
|
||||
handler := NewCerberusLogsHandler(watcher)
|
||||
|
||||
router := gin.New()
|
||||
router.GET("/ws", handler.LiveLogs)
|
||||
server := httptest.NewServer(router)
|
||||
defer server.Close()
|
||||
|
||||
wsURL := "ws" + strings.TrimPrefix(server.URL, "http") + "/ws"
|
||||
|
||||
// Connect multiple clients
|
||||
conns := make([]*websocket.Conn, 3)
|
||||
defer func() {
|
||||
// Close all connections after test
|
||||
for _, conn := range conns {
|
||||
if conn != nil {
|
||||
conn.Close()
|
||||
}
|
||||
}
|
||||
}()
|
||||
for i := 0; i < 3; i++ {
|
||||
conn, _, err := websocket.DefaultDialer.Dial(wsURL, nil) //nolint:bodyclose // WebSocket Dial response body is consumed by the dial
|
||||
require.NoError(t, err)
|
||||
conns[i] = conn
|
||||
}
|
||||
|
||||
time.Sleep(300 * time.Millisecond)
|
||||
|
||||
// Write a log entry
|
||||
logEntry := models.CaddyAccessLog{
|
||||
Level: "info",
|
||||
Ts: float64(time.Now().Unix()),
|
||||
Logger: "http.log.access",
|
||||
Msg: "handled request",
|
||||
Status: 200,
|
||||
}
|
||||
logEntry.Request.RemoteIP = "10.0.0.1"
|
||||
logEntry.Request.Method = "GET"
|
||||
logEntry.Request.URI = "/multi"
|
||||
logEntry.Request.Host = "example.com"
|
||||
|
||||
logJSON, _ := json.Marshal(logEntry)
|
||||
file.WriteString(string(logJSON) + "\n")
|
||||
file.Sync()
|
||||
|
||||
// All clients should receive the entry
|
||||
for i, conn := range conns {
|
||||
conn.SetReadDeadline(time.Now().Add(2 * time.Second))
|
||||
_, msg, err := conn.ReadMessage()
|
||||
require.NoError(t, err, "Client %d should receive message", i)
|
||||
|
||||
var entry models.SecurityLogEntry
|
||||
err = json.Unmarshal(msg, &entry)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "/multi", entry.URI)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCerberusLogsHandler_UpgradeFailure verifies non-WebSocket request handling.
|
||||
func TestCerberusLogsHandler_UpgradeFailure(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
watcher := services.NewLogWatcher("/tmp/test.log")
|
||||
handler := NewCerberusLogsHandler(watcher)
|
||||
|
||||
router := gin.New()
|
||||
router.GET("/ws", handler.LiveLogs)
|
||||
|
||||
// Make a regular HTTP request (not WebSocket)
|
||||
req := httptest.NewRequest(http.MethodGet, "/ws", http.NoBody)
|
||||
w := httptest.NewRecorder()
|
||||
router.ServeHTTP(w, req)
|
||||
|
||||
// Should fail upgrade (400 Bad Request)
|
||||
assert.Equal(t, http.StatusBadRequest, w.Code)
|
||||
}
|
||||
@@ -0,0 +1,92 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/crowdsec"
|
||||
)
|
||||
|
||||
// TestListPresetsShowsCachedStatus verifies the /presets endpoint marks cached presets.
|
||||
func TestListPresetsShowsCachedStatus(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
cacheDir := t.TempDir()
|
||||
dataDir := t.TempDir()
|
||||
|
||||
cache, err := crowdsec.NewHubCache(cacheDir, time.Hour)
|
||||
require.NoError(t, err)
|
||||
|
||||
// Cache a preset
|
||||
ctx := context.Background()
|
||||
archive := []byte("archive")
|
||||
_, err = cache.Store(ctx, "test/cached", "etag", "hub", "preview", archive)
|
||||
require.NoError(t, err)
|
||||
|
||||
// Setup handler
|
||||
hub := crowdsec.NewHubService(nil, cache, dataDir)
|
||||
db := OpenTestDB(t)
|
||||
handler := NewCrowdsecHandler(db, &fakeExec{}, "/bin/false", dataDir)
|
||||
handler.Hub = hub
|
||||
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
handler.RegisterRoutes(g)
|
||||
|
||||
// List presets
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/v1/admin/crowdsec/presets", http.NoBody)
|
||||
resp := httptest.NewRecorder()
|
||||
r.ServeHTTP(resp, req)
|
||||
|
||||
require.Equal(t, http.StatusOK, resp.Code)
|
||||
|
||||
var result map[string]interface{}
|
||||
err = json.Unmarshal(resp.Body.Bytes(), &result)
|
||||
require.NoError(t, err)
|
||||
|
||||
presets := result["presets"].([]interface{})
|
||||
require.NotEmpty(t, presets, "Should have at least one preset")
|
||||
|
||||
// Find our cached preset
|
||||
found := false
|
||||
for _, p := range presets {
|
||||
preset := p.(map[string]interface{})
|
||||
if preset["slug"] == "test/cached" {
|
||||
found = true
|
||||
require.True(t, preset["cached"].(bool), "Preset should be marked as cached")
|
||||
require.NotEmpty(t, preset["cache_key"], "Should have cache_key")
|
||||
}
|
||||
}
|
||||
require.True(t, found, "Cached preset should appear in list")
|
||||
}
|
||||
|
||||
// TestCacheKeyPersistence verifies cache keys are consistent and retrievable.
|
||||
func TestCacheKeyPersistence(t *testing.T) {
|
||||
cacheDir := t.TempDir()
|
||||
|
||||
cache, err := crowdsec.NewHubCache(cacheDir, time.Hour)
|
||||
require.NoError(t, err)
|
||||
|
||||
// Store a preset
|
||||
ctx := context.Background()
|
||||
archive := []byte("test archive")
|
||||
meta, err := cache.Store(ctx, "test/preset", "etag123", "hub", "preview text", archive)
|
||||
require.NoError(t, err)
|
||||
|
||||
originalCacheKey := meta.CacheKey
|
||||
require.NotEmpty(t, originalCacheKey, "Cache key should be generated")
|
||||
|
||||
// Load it back
|
||||
loaded, err := cache.Load(ctx, "test/preset")
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, originalCacheKey, loaded.CacheKey, "Cache key should persist")
|
||||
require.Equal(t, "test/preset", loaded.Slug)
|
||||
require.Equal(t, "etag123", loaded.Etag)
|
||||
}
|
||||
@@ -19,6 +19,8 @@ import (
|
||||
"github.com/Wikid82/charon/backend/internal/crowdsec"
|
||||
"github.com/Wikid82/charon/backend/internal/logger"
|
||||
"github.com/Wikid82/charon/backend/internal/models"
|
||||
"github.com/Wikid82/charon/backend/internal/services"
|
||||
"github.com/Wikid82/charon/backend/internal/util"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"gorm.io/gorm"
|
||||
@@ -53,6 +55,21 @@ type CrowdsecHandler struct {
|
||||
BinPath string
|
||||
DataDir string
|
||||
Hub *crowdsec.HubService
|
||||
Console *crowdsec.ConsoleEnrollmentService
|
||||
Security *services.SecurityService
|
||||
}
|
||||
|
||||
func ttlRemainingSeconds(now, retrievedAt time.Time, ttl time.Duration) *int64 {
|
||||
if retrievedAt.IsZero() || ttl <= 0 {
|
||||
return nil
|
||||
}
|
||||
remaining := retrievedAt.Add(ttl).Sub(now)
|
||||
if remaining < 0 {
|
||||
var zero int64
|
||||
return &zero
|
||||
}
|
||||
secs := int64(remaining.Seconds())
|
||||
return &secs
|
||||
}
|
||||
|
||||
func mapCrowdsecStatus(err error, defaultCode int) int {
|
||||
@@ -69,6 +86,16 @@ func NewCrowdsecHandler(db *gorm.DB, executor CrowdsecExecutor, binPath, dataDir
|
||||
logger.Log().WithError(err).Warn("failed to init crowdsec hub cache")
|
||||
}
|
||||
hubSvc := crowdsec.NewHubService(&RealCommandExecutor{}, cache, dataDir)
|
||||
consoleSecret := os.Getenv("CHARON_CONSOLE_ENCRYPTION_KEY")
|
||||
if consoleSecret == "" {
|
||||
consoleSecret = os.Getenv("CHARON_JWT_SECRET")
|
||||
}
|
||||
var securitySvc *services.SecurityService
|
||||
var consoleSvc *crowdsec.ConsoleEnrollmentService
|
||||
if db != nil {
|
||||
securitySvc = services.NewSecurityService(db)
|
||||
consoleSvc = crowdsec.NewConsoleEnrollmentService(db, &crowdsec.SecureCommandExecutor{}, dataDir, consoleSecret)
|
||||
}
|
||||
return &CrowdsecHandler{
|
||||
DB: db,
|
||||
Executor: executor,
|
||||
@@ -76,6 +103,8 @@ func NewCrowdsecHandler(db *gorm.DB, executor CrowdsecExecutor, binPath, dataDir
|
||||
BinPath: binPath,
|
||||
DataDir: dataDir,
|
||||
Hub: hubSvc,
|
||||
Console: consoleSvc,
|
||||
Security: securitySvc,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -106,6 +135,52 @@ func (h *CrowdsecHandler) isCerberusEnabled() bool {
|
||||
return true
|
||||
}
|
||||
|
||||
// isConsoleEnrollmentEnabled toggles console enrollment via DB or env flag.
|
||||
func (h *CrowdsecHandler) isConsoleEnrollmentEnabled() bool {
|
||||
const key = "feature.crowdsec.console_enrollment"
|
||||
if h.DB != nil && h.DB.Migrator().HasTable(&models.Setting{}) {
|
||||
var s models.Setting
|
||||
if err := h.DB.Where("key = ?", key).First(&s).Error; err == nil {
|
||||
v := strings.ToLower(strings.TrimSpace(s.Value))
|
||||
return v == "true" || v == "1" || v == "yes"
|
||||
}
|
||||
}
|
||||
|
||||
if envVal, ok := os.LookupEnv("FEATURE_CROWDSEC_CONSOLE_ENROLLMENT"); ok {
|
||||
if b, err := strconv.ParseBool(envVal); err == nil {
|
||||
return b
|
||||
}
|
||||
return envVal == "1"
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
func actorFromContext(c *gin.Context) string {
|
||||
if id, ok := c.Get("userID"); ok {
|
||||
return fmt.Sprintf("user:%v", id)
|
||||
}
|
||||
return "unknown"
|
||||
}
|
||||
|
||||
func (h *CrowdsecHandler) hubEndpoints() []string {
|
||||
if h.Hub == nil {
|
||||
return nil
|
||||
}
|
||||
set := make(map[string]struct{})
|
||||
for _, e := range []string{h.Hub.HubBaseURL, h.Hub.MirrorBaseURL} {
|
||||
if e == "" {
|
||||
continue
|
||||
}
|
||||
set[e] = struct{}{}
|
||||
}
|
||||
out := make([]string, 0, len(set))
|
||||
for k := range set {
|
||||
out = append(out, k)
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
// Start starts the CrowdSec process.
|
||||
func (h *CrowdsecHandler) Start(c *gin.Context) {
|
||||
ctx := c.Request.Context()
|
||||
@@ -253,7 +328,7 @@ func (h *CrowdsecHandler) ExportConfig(c *gin.Context) {
|
||||
}
|
||||
defer func() {
|
||||
if err := f.Close(); err != nil {
|
||||
logger.Log().WithError(err).Warn("failed to close file while archiving", "path", path)
|
||||
logger.Log().WithError(err).Warn("failed to close file while archiving", "path", util.SanitizeForLog(path))
|
||||
}
|
||||
}()
|
||||
|
||||
@@ -381,11 +456,12 @@ func (h *CrowdsecHandler) ListPresets(c *gin.Context) {
|
||||
|
||||
type presetInfo struct {
|
||||
crowdsec.Preset
|
||||
Available bool `json:"available"`
|
||||
Cached bool `json:"cached"`
|
||||
CacheKey string `json:"cache_key,omitempty"`
|
||||
Etag string `json:"etag,omitempty"`
|
||||
RetrievedAt *time.Time `json:"retrieved_at,omitempty"`
|
||||
Available bool `json:"available"`
|
||||
Cached bool `json:"cached"`
|
||||
CacheKey string `json:"cache_key,omitempty"`
|
||||
Etag string `json:"etag,omitempty"`
|
||||
RetrievedAt *time.Time `json:"retrieved_at,omitempty"`
|
||||
TTLRemainingSeconds *int64 `json:"ttl_remaining_seconds,omitempty"`
|
||||
}
|
||||
|
||||
result := map[string]*presetInfo{}
|
||||
@@ -425,6 +501,8 @@ func (h *CrowdsecHandler) ListPresets(c *gin.Context) {
|
||||
if h.Hub != nil && h.Hub.Cache != nil {
|
||||
ctx := c.Request.Context()
|
||||
if cached, err := h.Hub.Cache.List(ctx); err == nil {
|
||||
cacheTTL := h.Hub.Cache.TTL()
|
||||
now := time.Now().UTC()
|
||||
for _, entry := range cached {
|
||||
if _, ok := result[entry.Slug]; !ok {
|
||||
result[entry.Slug] = &presetInfo{Preset: crowdsec.Preset{Slug: entry.Slug, Title: entry.Slug, Summary: "cached preset", Source: "hub", RequiresHub: true}}
|
||||
@@ -436,6 +514,7 @@ func (h *CrowdsecHandler) ListPresets(c *gin.Context) {
|
||||
val := entry.RetrievedAt
|
||||
result[entry.Slug].RetrievedAt = &val
|
||||
}
|
||||
result[entry.Slug].TTLRemainingSeconds = ttlRemainingSeconds(now, entry.RetrievedAt, cacheTTL)
|
||||
}
|
||||
} else {
|
||||
logger.Log().WithError(err).Warn("crowdsec hub cache list failed")
|
||||
@@ -474,15 +553,51 @@ func (h *CrowdsecHandler) PullPreset(c *gin.Context) {
|
||||
return
|
||||
}
|
||||
|
||||
// Check for curated preset that doesn't require hub
|
||||
if preset, ok := crowdsec.FindPreset(slug); ok && !preset.RequiresHub {
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"status": "pulled",
|
||||
"slug": preset.Slug,
|
||||
"preview": "# Curated preset: " + preset.Title + "\n# " + preset.Summary,
|
||||
"cache_key": "curated-" + preset.Slug,
|
||||
"etag": "curated",
|
||||
"retrieved_at": time.Now(),
|
||||
"source": "charon-curated",
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
ctx := c.Request.Context()
|
||||
// Log cache directory before pull
|
||||
if h.Hub != nil && h.Hub.Cache != nil {
|
||||
cacheDir := filepath.Join(h.DataDir, "hub_cache")
|
||||
logger.Log().WithField("cache_dir", util.SanitizeForLog(cacheDir)).WithField("slug", util.SanitizeForLog(slug)).Info("attempting to pull preset")
|
||||
if stat, err := os.Stat(cacheDir); err == nil {
|
||||
logger.Log().WithField("cache_dir_mode", stat.Mode()).WithField("cache_dir_writable", stat.Mode().Perm()&0o200 != 0).Debug("cache directory exists")
|
||||
} else {
|
||||
logger.Log().WithError(err).Warn("cache directory stat failed")
|
||||
}
|
||||
}
|
||||
|
||||
res, err := h.Hub.Pull(ctx, slug)
|
||||
if err != nil {
|
||||
status := mapCrowdsecStatus(err, http.StatusBadGateway)
|
||||
logger.Log().WithError(err).WithField("slug", slug).WithField("hub_base_url", h.Hub.HubBaseURL).Warn("crowdsec preset pull failed")
|
||||
c.JSON(status, gin.H{"error": err.Error()})
|
||||
logger.Log().WithError(err).WithField("slug", util.SanitizeForLog(slug)).WithField("hub_base_url", h.Hub.HubBaseURL).Warn("crowdsec preset pull failed")
|
||||
c.JSON(status, gin.H{"error": err.Error(), "hub_endpoints": h.hubEndpoints()})
|
||||
return
|
||||
}
|
||||
|
||||
// Verify cache was actually stored
|
||||
logger.Log().WithField("slug", res.Meta.Slug).WithField("cache_key", res.Meta.CacheKey).WithField("archive_path", res.Meta.ArchivePath).WithField("preview_path", res.Meta.PreviewPath).Info("preset pulled and cached successfully")
|
||||
|
||||
// Verify files exist on disk
|
||||
if _, err := os.Stat(res.Meta.ArchivePath); err != nil {
|
||||
logger.Log().WithError(err).WithField("archive_path", res.Meta.ArchivePath).Error("cached archive file not found after pull")
|
||||
}
|
||||
if _, err := os.Stat(res.Meta.PreviewPath); err != nil {
|
||||
logger.Log().WithError(err).WithField("preview_path", res.Meta.PreviewPath).Error("cached preview file not found after pull")
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"status": "pulled",
|
||||
"slug": res.Meta.Slug,
|
||||
@@ -519,15 +634,82 @@ func (h *CrowdsecHandler) ApplyPreset(c *gin.Context) {
|
||||
return
|
||||
}
|
||||
|
||||
// Check for curated preset that doesn't require hub
|
||||
if preset, ok := crowdsec.FindPreset(slug); ok && !preset.RequiresHub {
|
||||
if h.DB != nil {
|
||||
_ = h.DB.Create(&models.CrowdsecPresetEvent{
|
||||
Slug: slug,
|
||||
Action: "apply",
|
||||
Status: "applied",
|
||||
CacheKey: "curated-" + slug,
|
||||
BackupPath: "",
|
||||
}).Error
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"status": "applied",
|
||||
"backup": "",
|
||||
"reload_hint": true,
|
||||
"used_cscli": false,
|
||||
"cache_key": "curated-" + slug,
|
||||
"slug": slug,
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
ctx := c.Request.Context()
|
||||
|
||||
// Log cache status before apply
|
||||
if h.Hub != nil && h.Hub.Cache != nil {
|
||||
cacheDir := filepath.Join(h.DataDir, "hub_cache")
|
||||
logger.Log().WithField("cache_dir", util.SanitizeForLog(cacheDir)).WithField("slug", util.SanitizeForLog(slug)).Info("attempting to apply preset")
|
||||
|
||||
// Check if cached
|
||||
if cached, err := h.Hub.Cache.Load(ctx, slug); err == nil {
|
||||
logger.Log().WithField("slug", util.SanitizeForLog(slug)).WithField("cache_key", cached.CacheKey).WithField("archive_path", cached.ArchivePath).WithField("preview_path", cached.PreviewPath).Info("preset found in cache")
|
||||
// Verify files still exist
|
||||
if _, err := os.Stat(cached.ArchivePath); err != nil {
|
||||
logger.Log().WithError(err).WithField("archive_path", cached.ArchivePath).Error("cached archive file missing")
|
||||
}
|
||||
if _, err := os.Stat(cached.PreviewPath); err != nil {
|
||||
logger.Log().WithError(err).WithField("preview_path", cached.PreviewPath).Error("cached preview file missing")
|
||||
}
|
||||
} else {
|
||||
logger.Log().WithError(err).WithField("slug", util.SanitizeForLog(slug)).Warn("preset not found in cache before apply")
|
||||
// List what's actually in the cache
|
||||
if entries, listErr := h.Hub.Cache.List(ctx); listErr == nil {
|
||||
slugs := make([]string, len(entries))
|
||||
for i, e := range entries {
|
||||
slugs[i] = e.Slug
|
||||
}
|
||||
logger.Log().WithField("cached_slugs", slugs).Info("current cache contents")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
res, err := h.Hub.Apply(ctx, slug)
|
||||
if err != nil {
|
||||
status := mapCrowdsecStatus(err, http.StatusInternalServerError)
|
||||
logger.Log().WithError(err).WithField("slug", slug).WithField("hub_base_url", h.Hub.HubBaseURL).Warn("crowdsec preset apply failed")
|
||||
logger.Log().WithError(err).WithField("slug", util.SanitizeForLog(slug)).WithField("hub_base_url", h.Hub.HubBaseURL).WithField("backup_path", res.BackupPath).WithField("cache_key", res.CacheKey).Warn("crowdsec preset apply failed")
|
||||
if h.DB != nil {
|
||||
_ = h.DB.Create(&models.CrowdsecPresetEvent{Slug: slug, Action: "apply", Status: "failed", CacheKey: res.CacheKey, BackupPath: res.BackupPath, Error: err.Error()}).Error
|
||||
}
|
||||
c.JSON(status, gin.H{"error": err.Error(), "backup": res.BackupPath})
|
||||
// Build detailed error response
|
||||
errorMsg := err.Error()
|
||||
// Add actionable guidance based on error type
|
||||
if errors.Is(err, crowdsec.ErrCacheMiss) || strings.Contains(errorMsg, "cache miss") {
|
||||
errorMsg = "Preset cache missing or expired. Pull the preset again, then retry apply."
|
||||
} else if strings.Contains(errorMsg, "cscli unavailable") && strings.Contains(errorMsg, "no cached preset") {
|
||||
errorMsg = "CrowdSec preset not cached. Pull the preset first by clicking 'Pull Preview', then try applying again."
|
||||
}
|
||||
errorResponse := gin.H{"error": errorMsg, "hub_endpoints": h.hubEndpoints()}
|
||||
if res.BackupPath != "" {
|
||||
errorResponse["backup"] = res.BackupPath
|
||||
}
|
||||
if res.CacheKey != "" {
|
||||
errorResponse["cache_key"] = res.CacheKey
|
||||
}
|
||||
c.JSON(status, errorResponse)
|
||||
return
|
||||
}
|
||||
|
||||
@@ -553,6 +735,82 @@ func (h *CrowdsecHandler) ApplyPreset(c *gin.Context) {
|
||||
})
|
||||
}
|
||||
|
||||
// ConsoleEnroll enrolls the local engine with CrowdSec console.
|
||||
func (h *CrowdsecHandler) ConsoleEnroll(c *gin.Context) {
|
||||
if !h.isConsoleEnrollmentEnabled() {
|
||||
c.JSON(http.StatusNotFound, gin.H{"error": "console enrollment disabled"})
|
||||
return
|
||||
}
|
||||
if h.Console == nil {
|
||||
c.JSON(http.StatusServiceUnavailable, gin.H{"error": "console enrollment unavailable"})
|
||||
return
|
||||
}
|
||||
|
||||
var payload struct {
|
||||
EnrollmentKey string `json:"enrollment_key"`
|
||||
Tenant string `json:"tenant"`
|
||||
AgentName string `json:"agent_name"`
|
||||
Force bool `json:"force"`
|
||||
}
|
||||
if err := c.ShouldBindJSON(&payload); err != nil {
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": "invalid payload"})
|
||||
return
|
||||
}
|
||||
|
||||
ctx := c.Request.Context()
|
||||
status, err := h.Console.Enroll(ctx, crowdsec.ConsoleEnrollRequest{
|
||||
EnrollmentKey: payload.EnrollmentKey,
|
||||
Tenant: payload.Tenant,
|
||||
AgentName: payload.AgentName,
|
||||
Force: payload.Force,
|
||||
})
|
||||
|
||||
if err != nil {
|
||||
httpStatus := mapCrowdsecStatus(err, http.StatusBadGateway)
|
||||
if strings.Contains(strings.ToLower(err.Error()), "progress") {
|
||||
httpStatus = http.StatusConflict
|
||||
} else if strings.Contains(strings.ToLower(err.Error()), "required") {
|
||||
httpStatus = http.StatusBadRequest
|
||||
}
|
||||
logger.Log().WithError(err).WithField("tenant", util.SanitizeForLog(payload.Tenant)).WithField("agent", util.SanitizeForLog(payload.AgentName)).WithField("correlation_id", status.CorrelationID).Warn("crowdsec console enrollment failed")
|
||||
if h.Security != nil {
|
||||
_ = h.Security.LogAudit(&models.SecurityAudit{Actor: actorFromContext(c), Action: "crowdsec_console_enroll_failed", Details: fmt.Sprintf("status=%s tenant=%s agent=%s correlation_id=%s", status.Status, payload.Tenant, payload.AgentName, status.CorrelationID)})
|
||||
}
|
||||
resp := gin.H{"error": err.Error(), "status": status.Status}
|
||||
if status.CorrelationID != "" {
|
||||
resp["correlation_id"] = status.CorrelationID
|
||||
}
|
||||
c.JSON(httpStatus, resp)
|
||||
return
|
||||
}
|
||||
|
||||
if h.Security != nil {
|
||||
_ = h.Security.LogAudit(&models.SecurityAudit{Actor: actorFromContext(c), Action: "crowdsec_console_enroll_succeeded", Details: fmt.Sprintf("status=%s tenant=%s agent=%s correlation_id=%s", status.Status, status.Tenant, status.AgentName, status.CorrelationID)})
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, status)
|
||||
}
|
||||
|
||||
// ConsoleStatus returns the current console enrollment status without secrets.
|
||||
func (h *CrowdsecHandler) ConsoleStatus(c *gin.Context) {
|
||||
if !h.isConsoleEnrollmentEnabled() {
|
||||
c.JSON(http.StatusNotFound, gin.H{"error": "console enrollment disabled"})
|
||||
return
|
||||
}
|
||||
if h.Console == nil {
|
||||
c.JSON(http.StatusServiceUnavailable, gin.H{"error": "console enrollment unavailable"})
|
||||
return
|
||||
}
|
||||
|
||||
status, err := h.Console.Status(c.Request.Context())
|
||||
if err != nil {
|
||||
logger.Log().WithError(err).Warn("failed to read console enrollment status")
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to read enrollment status"})
|
||||
return
|
||||
}
|
||||
c.JSON(http.StatusOK, status)
|
||||
}
|
||||
|
||||
// GetCachedPreset returns cached preview for a slug when available.
|
||||
func (h *CrowdsecHandler) GetCachedPreset(c *gin.Context) {
|
||||
if !h.isCerberusEnabled() {
|
||||
@@ -578,8 +836,20 @@ func (h *CrowdsecHandler) GetCachedPreset(c *gin.Context) {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
|
||||
return
|
||||
}
|
||||
meta, _ := h.Hub.Cache.Load(ctx, slug)
|
||||
c.JSON(http.StatusOK, gin.H{"preview": preview, "cache_key": meta.CacheKey, "etag": meta.Etag})
|
||||
meta, metaErr := h.Hub.Cache.Load(ctx, slug)
|
||||
if metaErr != nil && !errors.Is(metaErr, crowdsec.ErrCacheMiss) && !errors.Is(metaErr, crowdsec.ErrCacheExpired) {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": metaErr.Error()})
|
||||
return
|
||||
}
|
||||
cacheTTL := h.Hub.Cache.TTL()
|
||||
now := time.Now().UTC()
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"preview": preview,
|
||||
"cache_key": meta.CacheKey,
|
||||
"etag": meta.Etag,
|
||||
"retrieved_at": meta.RetrievedAt,
|
||||
"ttl_remaining_seconds": ttlRemainingSeconds(now, meta.RetrievedAt, cacheTTL),
|
||||
})
|
||||
}
|
||||
|
||||
// CrowdSecDecision represents a ban decision from CrowdSec
|
||||
@@ -608,10 +878,224 @@ type cscliDecision struct {
|
||||
Until string `json:"until"`
|
||||
}
|
||||
|
||||
// lapiDecision represents the JSON structure from CrowdSec LAPI /v1/decisions
|
||||
type lapiDecision struct {
|
||||
ID int64 `json:"id"`
|
||||
Origin string `json:"origin"`
|
||||
Type string `json:"type"`
|
||||
Scope string `json:"scope"`
|
||||
Value string `json:"value"`
|
||||
Duration string `json:"duration"`
|
||||
Scenario string `json:"scenario"`
|
||||
CreatedAt string `json:"created_at,omitempty"`
|
||||
Until string `json:"until,omitempty"`
|
||||
}
|
||||
|
||||
// GetLAPIDecisions queries CrowdSec LAPI directly for current decisions.
|
||||
// This is an alternative to ListDecisions which uses cscli.
|
||||
// Query params:
|
||||
// - ip: filter by specific IP address
|
||||
// - scope: filter by scope (e.g., "ip", "range")
|
||||
// - type: filter by decision type (e.g., "ban", "captcha")
|
||||
func (h *CrowdsecHandler) GetLAPIDecisions(c *gin.Context) {
|
||||
// Get LAPI URL from security config or use default
|
||||
// Default port is 8085 to avoid conflict with Charon management API on port 8080
|
||||
lapiURL := "http://127.0.0.1:8085"
|
||||
if h.Security != nil {
|
||||
cfg, err := h.Security.Get()
|
||||
if err == nil && cfg != nil && cfg.CrowdSecAPIURL != "" {
|
||||
lapiURL = cfg.CrowdSecAPIURL
|
||||
}
|
||||
}
|
||||
|
||||
// Build query string
|
||||
queryParams := make([]string, 0)
|
||||
if ip := c.Query("ip"); ip != "" {
|
||||
queryParams = append(queryParams, "ip="+ip)
|
||||
}
|
||||
if scope := c.Query("scope"); scope != "" {
|
||||
queryParams = append(queryParams, "scope="+scope)
|
||||
}
|
||||
if decisionType := c.Query("type"); decisionType != "" {
|
||||
queryParams = append(queryParams, "type="+decisionType)
|
||||
}
|
||||
|
||||
// Build request URL
|
||||
reqURL := strings.TrimRight(lapiURL, "/") + "/v1/decisions"
|
||||
if len(queryParams) > 0 {
|
||||
reqURL += "?" + strings.Join(queryParams, "&")
|
||||
}
|
||||
|
||||
// Get API key
|
||||
apiKey := getLAPIKey()
|
||||
|
||||
// Create HTTP request with timeout
|
||||
ctx, cancel := context.WithTimeout(c.Request.Context(), 10*time.Second)
|
||||
defer cancel()
|
||||
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, reqURL, http.NoBody)
|
||||
if err != nil {
|
||||
logger.Log().WithError(err).Warn("Failed to create LAPI decisions request")
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to create request"})
|
||||
return
|
||||
}
|
||||
|
||||
// Add authentication header if API key is available
|
||||
if apiKey != "" {
|
||||
req.Header.Set("X-Api-Key", apiKey)
|
||||
}
|
||||
req.Header.Set("Accept", "application/json")
|
||||
|
||||
// Execute request
|
||||
client := &http.Client{Timeout: 10 * time.Second}
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
logger.Log().WithError(err).WithField("lapi_url", lapiURL).Warn("Failed to query LAPI decisions")
|
||||
// Fallback to cscli-based method
|
||||
h.ListDecisions(c)
|
||||
return
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
// Handle non-200 responses
|
||||
if resp.StatusCode == http.StatusUnauthorized {
|
||||
c.JSON(http.StatusUnauthorized, gin.H{"error": "LAPI authentication failed - check API key configuration"})
|
||||
return
|
||||
}
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
logger.Log().WithField("status", resp.StatusCode).WithField("lapi_url", lapiURL).Warn("LAPI returned non-OK status")
|
||||
// Fallback to cscli-based method
|
||||
h.ListDecisions(c)
|
||||
return
|
||||
}
|
||||
|
||||
// Check content-type to ensure we're getting JSON (not HTML from a proxy/frontend)
|
||||
contentType := resp.Header.Get("Content-Type")
|
||||
if contentType != "" && !strings.Contains(contentType, "application/json") {
|
||||
logger.Log().WithField("content_type", contentType).WithField("lapi_url", lapiURL).Warn("LAPI returned non-JSON content-type, falling back to cscli")
|
||||
// Fallback to cscli-based method
|
||||
h.ListDecisions(c)
|
||||
return
|
||||
}
|
||||
|
||||
// Parse response body
|
||||
body, err := io.ReadAll(io.LimitReader(resp.Body, 10*1024*1024)) // 10MB limit
|
||||
if err != nil {
|
||||
logger.Log().WithError(err).Warn("Failed to read LAPI response")
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to read response"})
|
||||
return
|
||||
}
|
||||
|
||||
// Handle null/empty responses
|
||||
if len(body) == 0 || string(body) == "null" || string(body) == "null\n" {
|
||||
c.JSON(http.StatusOK, gin.H{"decisions": []CrowdSecDecision{}, "total": 0, "source": "lapi"})
|
||||
return
|
||||
}
|
||||
|
||||
// Parse JSON
|
||||
var lapiDecisions []lapiDecision
|
||||
if err := json.Unmarshal(body, &lapiDecisions); err != nil {
|
||||
logger.Log().WithError(err).WithField("body", string(body)).Warn("Failed to parse LAPI decisions")
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to parse LAPI response"})
|
||||
return
|
||||
}
|
||||
|
||||
// Convert to our format
|
||||
decisions := make([]CrowdSecDecision, 0, len(lapiDecisions))
|
||||
for _, d := range lapiDecisions {
|
||||
var createdAt time.Time
|
||||
if d.CreatedAt != "" {
|
||||
createdAt, _ = time.Parse(time.RFC3339, d.CreatedAt)
|
||||
}
|
||||
decisions = append(decisions, CrowdSecDecision{
|
||||
ID: d.ID,
|
||||
Origin: d.Origin,
|
||||
Type: d.Type,
|
||||
Scope: d.Scope,
|
||||
Value: d.Value,
|
||||
Duration: d.Duration,
|
||||
Scenario: d.Scenario,
|
||||
CreatedAt: createdAt,
|
||||
Until: d.Until,
|
||||
})
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{"decisions": decisions, "total": len(decisions), "source": "lapi"})
|
||||
}
|
||||
|
||||
// getLAPIKey retrieves the LAPI API key from environment variables.
|
||||
func getLAPIKey() string {
|
||||
envVars := []string{
|
||||
"CROWDSEC_API_KEY",
|
||||
"CROWDSEC_BOUNCER_API_KEY",
|
||||
"CERBERUS_SECURITY_CROWDSEC_API_KEY",
|
||||
"CHARON_SECURITY_CROWDSEC_API_KEY",
|
||||
"CPM_SECURITY_CROWDSEC_API_KEY",
|
||||
}
|
||||
for _, key := range envVars {
|
||||
if val := os.Getenv(key); val != "" {
|
||||
return val
|
||||
}
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// CheckLAPIHealth verifies that CrowdSec LAPI is responding.
|
||||
func (h *CrowdsecHandler) CheckLAPIHealth(c *gin.Context) {
|
||||
// Get LAPI URL from security config or use default
|
||||
// Default port is 8085 to avoid conflict with Charon management API on port 8080
|
||||
lapiURL := "http://127.0.0.1:8085"
|
||||
if h.Security != nil {
|
||||
cfg, err := h.Security.Get()
|
||||
if err == nil && cfg != nil && cfg.CrowdSecAPIURL != "" {
|
||||
lapiURL = cfg.CrowdSecAPIURL
|
||||
}
|
||||
}
|
||||
|
||||
// Create health check request
|
||||
ctx, cancel := context.WithTimeout(c.Request.Context(), 5*time.Second)
|
||||
defer cancel()
|
||||
|
||||
healthURL := strings.TrimRight(lapiURL, "/") + "/health"
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, healthURL, http.NoBody)
|
||||
if err != nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"healthy": false, "error": "failed to create request"})
|
||||
return
|
||||
}
|
||||
|
||||
client := &http.Client{Timeout: 5 * time.Second}
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
// Try decisions endpoint as fallback health check
|
||||
decisionsURL := strings.TrimRight(lapiURL, "/") + "/v1/decisions"
|
||||
req2, _ := http.NewRequestWithContext(ctx, http.MethodHead, decisionsURL, http.NoBody)
|
||||
resp2, err2 := client.Do(req2)
|
||||
if err2 != nil {
|
||||
c.JSON(http.StatusOK, gin.H{"healthy": false, "error": "LAPI unreachable", "lapi_url": lapiURL})
|
||||
return
|
||||
}
|
||||
defer resp2.Body.Close()
|
||||
// 401 is expected without auth but indicates LAPI is running
|
||||
if resp2.StatusCode == http.StatusOK || resp2.StatusCode == http.StatusUnauthorized {
|
||||
c.JSON(http.StatusOK, gin.H{"healthy": true, "lapi_url": lapiURL, "note": "health endpoint unavailable, verified via decisions endpoint"})
|
||||
return
|
||||
}
|
||||
c.JSON(http.StatusOK, gin.H{"healthy": false, "error": "unexpected status", "status": resp2.StatusCode, "lapi_url": lapiURL})
|
||||
return
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{"healthy": resp.StatusCode == http.StatusOK, "lapi_url": lapiURL, "status": resp.StatusCode})
|
||||
}
|
||||
|
||||
// ListDecisions calls cscli to get current decisions (banned IPs)
|
||||
func (h *CrowdsecHandler) ListDecisions(c *gin.Context) {
|
||||
ctx := c.Request.Context()
|
||||
output, err := h.CmdExec.Execute(ctx, "cscli", "decisions", "list", "-o", "json")
|
||||
args := []string{"decisions", "list", "-o", "json"}
|
||||
if _, err := os.Stat(filepath.Join(h.DataDir, "config.yaml")); err == nil {
|
||||
args = append([]string{"-c", filepath.Join(h.DataDir, "config.yaml")}, args...)
|
||||
}
|
||||
output, err := h.CmdExec.Execute(ctx, "cscli", args...)
|
||||
if err != nil {
|
||||
// If cscli is not available or returns error, return empty list with warning
|
||||
logger.Log().WithError(err).Warn("Failed to execute cscli decisions list")
|
||||
@@ -692,9 +1176,12 @@ func (h *CrowdsecHandler) BanIP(c *gin.Context) {
|
||||
|
||||
ctx := c.Request.Context()
|
||||
args := []string{"decisions", "add", "-i", ip, "-d", duration, "-R", reason, "-t", "ban"}
|
||||
if _, err := os.Stat(filepath.Join(h.DataDir, "config.yaml")); err == nil {
|
||||
args = append([]string{"-c", filepath.Join(h.DataDir, "config.yaml")}, args...)
|
||||
}
|
||||
_, err := h.CmdExec.Execute(ctx, "cscli", args...)
|
||||
if err != nil {
|
||||
logger.Log().WithError(err).WithField("ip", ip).Warn("Failed to execute cscli decisions add")
|
||||
logger.Log().WithError(err).WithField("ip", util.SanitizeForLog(ip)).Warn("Failed to execute cscli decisions add")
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to ban IP"})
|
||||
return
|
||||
}
|
||||
@@ -715,9 +1202,12 @@ func (h *CrowdsecHandler) UnbanIP(c *gin.Context) {
|
||||
|
||||
ctx := c.Request.Context()
|
||||
args := []string{"decisions", "delete", "-i", ip}
|
||||
if _, err := os.Stat(filepath.Join(h.DataDir, "config.yaml")); err == nil {
|
||||
args = append([]string{"-c", filepath.Join(h.DataDir, "config.yaml")}, args...)
|
||||
}
|
||||
_, err := h.CmdExec.Execute(ctx, "cscli", args...)
|
||||
if err != nil {
|
||||
logger.Log().WithError(err).WithField("ip", ip).Warn("Failed to execute cscli decisions delete")
|
||||
logger.Log().WithError(err).WithField("ip", util.SanitizeForLog(ip)).Warn("Failed to execute cscli decisions delete")
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to unban IP"})
|
||||
return
|
||||
}
|
||||
@@ -725,6 +1215,123 @@ func (h *CrowdsecHandler) UnbanIP(c *gin.Context) {
|
||||
c.JSON(http.StatusOK, gin.H{"status": "unbanned", "ip": ip})
|
||||
}
|
||||
|
||||
// RegisterBouncer registers a new bouncer or returns existing bouncer status.
|
||||
// POST /api/v1/admin/crowdsec/bouncer/register
|
||||
func (h *CrowdsecHandler) RegisterBouncer(c *gin.Context) {
|
||||
ctx := c.Request.Context()
|
||||
|
||||
// Check if register_bouncer.sh script exists
|
||||
scriptPath := "/usr/local/bin/register_bouncer.sh"
|
||||
if _, err := os.Stat(scriptPath); os.IsNotExist(err) {
|
||||
c.JSON(http.StatusNotFound, gin.H{"error": "bouncer registration script not found"})
|
||||
return
|
||||
}
|
||||
|
||||
// Run the registration script
|
||||
output, err := h.CmdExec.Execute(ctx, "bash", scriptPath)
|
||||
if err != nil {
|
||||
logger.Log().WithError(err).WithField("output", string(output)).Warn("Failed to register bouncer")
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to register bouncer", "details": string(output)})
|
||||
return
|
||||
}
|
||||
|
||||
// Parse output for API key (last line typically contains the key)
|
||||
lines := strings.Split(strings.TrimSpace(string(output)), "\n")
|
||||
var apiKeyPreview string
|
||||
for _, line := range lines {
|
||||
// Look for lines that appear to be an API key (long alphanumeric string)
|
||||
line = strings.TrimSpace(line)
|
||||
if len(line) >= 32 && !strings.Contains(line, " ") && !strings.Contains(line, ":") {
|
||||
// Found what looks like an API key, show preview
|
||||
if len(line) > 8 {
|
||||
apiKeyPreview = line[:8] + "..."
|
||||
} else {
|
||||
apiKeyPreview = line + "..."
|
||||
}
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
// Check if bouncer is actually registered by querying cscli
|
||||
checkOutput, checkErr := h.CmdExec.Execute(ctx, "cscli", "bouncers", "list", "-o", "json")
|
||||
registered := false
|
||||
if checkErr == nil && len(checkOutput) > 0 && string(checkOutput) != "null" {
|
||||
if strings.Contains(string(checkOutput), "caddy-bouncer") {
|
||||
registered = true
|
||||
}
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"status": "registered",
|
||||
"bouncer_name": "caddy-bouncer",
|
||||
"api_key_preview": apiKeyPreview,
|
||||
"registered": registered,
|
||||
})
|
||||
}
|
||||
|
||||
// GetAcquisitionConfig returns the current CrowdSec acquisition configuration.
|
||||
// GET /api/v1/admin/crowdsec/acquisition
|
||||
func (h *CrowdsecHandler) GetAcquisitionConfig(c *gin.Context) {
|
||||
acquisPath := "/etc/crowdsec/acquis.yaml"
|
||||
|
||||
content, err := os.ReadFile(acquisPath)
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
c.JSON(http.StatusNotFound, gin.H{"error": "acquisition config not found", "path": acquisPath})
|
||||
return
|
||||
}
|
||||
logger.Log().WithError(err).WithField("path", acquisPath).Warn("Failed to read acquisition config")
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to read acquisition config"})
|
||||
return
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"content": string(content),
|
||||
"path": acquisPath,
|
||||
})
|
||||
}
|
||||
|
||||
// UpdateAcquisitionConfig updates the CrowdSec acquisition configuration.
|
||||
// PUT /api/v1/admin/crowdsec/acquisition
|
||||
func (h *CrowdsecHandler) UpdateAcquisitionConfig(c *gin.Context) {
|
||||
var payload struct {
|
||||
Content string `json:"content" binding:"required"`
|
||||
}
|
||||
if err := c.ShouldBindJSON(&payload); err != nil {
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": "content is required"})
|
||||
return
|
||||
}
|
||||
|
||||
acquisPath := "/etc/crowdsec/acquis.yaml"
|
||||
|
||||
// Create backup of existing config if it exists
|
||||
var backupPath string
|
||||
if _, err := os.Stat(acquisPath); err == nil {
|
||||
backupPath = fmt.Sprintf("%s.backup.%s", acquisPath, time.Now().Format("20060102-150405"))
|
||||
if err := os.Rename(acquisPath, backupPath); err != nil {
|
||||
logger.Log().WithError(err).WithField("path", acquisPath).Warn("Failed to backup acquisition config")
|
||||
// Continue anyway - we'll try to write the new config
|
||||
}
|
||||
}
|
||||
|
||||
// Write new config
|
||||
if err := os.WriteFile(acquisPath, []byte(payload.Content), 0o644); err != nil {
|
||||
logger.Log().WithError(err).WithField("path", acquisPath).Warn("Failed to write acquisition config")
|
||||
// Try to restore backup if it exists
|
||||
if backupPath != "" {
|
||||
_ = os.Rename(backupPath, acquisPath)
|
||||
}
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to write acquisition config"})
|
||||
return
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"status": "updated",
|
||||
"backup": backupPath,
|
||||
"reload_hint": true,
|
||||
})
|
||||
}
|
||||
|
||||
// RegisterRoutes registers crowdsec admin routes under protected group
|
||||
func (h *CrowdsecHandler) RegisterRoutes(rg *gin.RouterGroup) {
|
||||
rg.POST("/admin/crowdsec/start", h.Start)
|
||||
@@ -739,8 +1346,17 @@ func (h *CrowdsecHandler) RegisterRoutes(rg *gin.RouterGroup) {
|
||||
rg.POST("/admin/crowdsec/presets/pull", h.PullPreset)
|
||||
rg.POST("/admin/crowdsec/presets/apply", h.ApplyPreset)
|
||||
rg.GET("/admin/crowdsec/presets/cache/:slug", h.GetCachedPreset)
|
||||
rg.POST("/admin/crowdsec/console/enroll", h.ConsoleEnroll)
|
||||
rg.GET("/admin/crowdsec/console/status", h.ConsoleStatus)
|
||||
// Decision management endpoints (Banned IP Dashboard)
|
||||
rg.GET("/admin/crowdsec/decisions", h.ListDecisions)
|
||||
rg.GET("/admin/crowdsec/decisions/lapi", h.GetLAPIDecisions)
|
||||
rg.GET("/admin/crowdsec/lapi/health", h.CheckLAPIHealth)
|
||||
rg.POST("/admin/crowdsec/ban", h.BanIP)
|
||||
rg.DELETE("/admin/crowdsec/ban/:ip", h.UnbanIP)
|
||||
// Bouncer registration endpoint
|
||||
rg.POST("/admin/crowdsec/bouncer/register", h.RegisterBouncer)
|
||||
// Acquisition configuration endpoints
|
||||
rg.GET("/admin/crowdsec/acquisition", h.GetAcquisitionConfig)
|
||||
rg.PUT("/admin/crowdsec/acquisition", h.UpdateAcquisitionConfig)
|
||||
}
|
||||
|
||||
@@ -15,7 +15,9 @@ import (
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/crowdsec"
|
||||
"github.com/Wikid82/charon/backend/internal/models"
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/stretchr/testify/require"
|
||||
@@ -519,3 +521,742 @@ func TestIsCerberusEnabledLegacyEnv(t *testing.T) {
|
||||
t.Fatalf("expected cerberus to be disabled for legacy env flag")
|
||||
}
|
||||
}
|
||||
|
||||
// ============================================
|
||||
// Console Enrollment Tests
|
||||
// ============================================
|
||||
|
||||
type mockEnvExecutor struct {
|
||||
responses []struct {
|
||||
out []byte
|
||||
err error
|
||||
}
|
||||
defaultResponse struct {
|
||||
out []byte
|
||||
err error
|
||||
}
|
||||
calls []struct {
|
||||
name string
|
||||
args []string
|
||||
}
|
||||
}
|
||||
|
||||
func (m *mockEnvExecutor) ExecuteWithEnv(ctx context.Context, name string, args []string, env map[string]string) ([]byte, error) {
|
||||
m.calls = append(m.calls, struct {
|
||||
name string
|
||||
args []string
|
||||
}{name, args})
|
||||
|
||||
if len(m.calls) <= len(m.responses) {
|
||||
resp := m.responses[len(m.calls)-1]
|
||||
return resp.out, resp.err
|
||||
}
|
||||
return m.defaultResponse.out, m.defaultResponse.err
|
||||
}
|
||||
|
||||
func setupTestConsoleEnrollment(t *testing.T) (*CrowdsecHandler, *mockEnvExecutor) {
|
||||
t.Helper()
|
||||
gin.SetMode(gin.TestMode)
|
||||
db := OpenTestDB(t)
|
||||
require.NoError(t, db.AutoMigrate(&models.CrowdsecConsoleEnrollment{}))
|
||||
|
||||
exec := &mockEnvExecutor{}
|
||||
dataDir := t.TempDir()
|
||||
|
||||
h := NewCrowdsecHandler(db, &fakeExec{}, "/bin/false", dataDir)
|
||||
// Replace the Console service with one that uses our mock executor
|
||||
h.Console = crowdsec.NewConsoleEnrollmentService(db, exec, dataDir, "test-secret")
|
||||
|
||||
return h, exec
|
||||
}
|
||||
|
||||
func TestConsoleEnrollDisabled(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CROWDSEC_CONSOLE_ENROLLMENT", "false")
|
||||
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", t.TempDir())
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
body := `{"enrollment_key": "abc123456789", "agent_name": "test-agent"}`
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/console/enroll", strings.NewReader(body))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusNotFound, w.Code)
|
||||
require.Contains(t, w.Body.String(), "disabled")
|
||||
}
|
||||
|
||||
func TestConsoleEnrollServiceUnavailable(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CROWDSEC_CONSOLE_ENROLLMENT", "true")
|
||||
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", t.TempDir())
|
||||
// Set Console to nil to simulate unavailable
|
||||
h.Console = nil
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
body := `{"enrollment_key": "abc123456789", "agent_name": "test-agent"}`
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/console/enroll", strings.NewReader(body))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusServiceUnavailable, w.Code)
|
||||
require.Contains(t, w.Body.String(), "unavailable")
|
||||
}
|
||||
|
||||
func TestConsoleEnrollInvalidPayload(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CROWDSEC_CONSOLE_ENROLLMENT", "true")
|
||||
|
||||
h, _ := setupTestConsoleEnrollment(t)
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/console/enroll", strings.NewReader("not-json"))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusBadRequest, w.Code)
|
||||
require.Contains(t, w.Body.String(), "invalid payload")
|
||||
}
|
||||
|
||||
func TestConsoleEnrollSuccess(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CROWDSEC_CONSOLE_ENROLLMENT", "true")
|
||||
|
||||
h, _ := setupTestConsoleEnrollment(t)
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
body := `{"enrollment_key": "abc123456789", "agent_name": "test-agent", "tenant": "my-tenant"}`
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/console/enroll", strings.NewReader(body))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusOK, w.Code)
|
||||
|
||||
var resp map[string]interface{}
|
||||
require.NoError(t, json.Unmarshal(w.Body.Bytes(), &resp))
|
||||
require.Equal(t, "enrolled", resp["status"])
|
||||
}
|
||||
|
||||
func TestConsoleEnrollMissingAgentName(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CROWDSEC_CONSOLE_ENROLLMENT", "true")
|
||||
|
||||
h, _ := setupTestConsoleEnrollment(t)
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
body := `{"enrollment_key": "abc123456789", "agent_name": ""}`
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/console/enroll", strings.NewReader(body))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusBadRequest, w.Code)
|
||||
require.Contains(t, w.Body.String(), "required")
|
||||
}
|
||||
|
||||
func TestConsoleStatusDisabled(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CROWDSEC_CONSOLE_ENROLLMENT", "false")
|
||||
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", t.TempDir())
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/v1/admin/crowdsec/console/status", http.NoBody)
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusNotFound, w.Code)
|
||||
require.Contains(t, w.Body.String(), "disabled")
|
||||
}
|
||||
|
||||
func TestConsoleStatusServiceUnavailable(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CROWDSEC_CONSOLE_ENROLLMENT", "true")
|
||||
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", t.TempDir())
|
||||
// Set Console to nil to simulate unavailable
|
||||
h.Console = nil
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/v1/admin/crowdsec/console/status", http.NoBody)
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusServiceUnavailable, w.Code)
|
||||
require.Contains(t, w.Body.String(), "unavailable")
|
||||
}
|
||||
|
||||
func TestConsoleStatusSuccess(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CROWDSEC_CONSOLE_ENROLLMENT", "true")
|
||||
|
||||
h, _ := setupTestConsoleEnrollment(t)
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
// Get status when not enrolled yet
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/v1/admin/crowdsec/console/status", http.NoBody)
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusOK, w.Code)
|
||||
|
||||
var resp map[string]interface{}
|
||||
require.NoError(t, json.Unmarshal(w.Body.Bytes(), &resp))
|
||||
require.Equal(t, "not_enrolled", resp["status"])
|
||||
}
|
||||
|
||||
func TestConsoleStatusAfterEnroll(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CROWDSEC_CONSOLE_ENROLLMENT", "true")
|
||||
|
||||
h, _ := setupTestConsoleEnrollment(t)
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
// First enroll
|
||||
body := `{"enrollment_key": "abc123456789", "agent_name": "test-agent"}`
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/console/enroll", strings.NewReader(body))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
require.Equal(t, http.StatusOK, w.Code)
|
||||
|
||||
// Then check status
|
||||
w2 := httptest.NewRecorder()
|
||||
req2 := httptest.NewRequest(http.MethodGet, "/api/v1/admin/crowdsec/console/status", http.NoBody)
|
||||
r.ServeHTTP(w2, req2)
|
||||
|
||||
require.Equal(t, http.StatusOK, w2.Code)
|
||||
|
||||
var resp map[string]interface{}
|
||||
require.NoError(t, json.Unmarshal(w2.Body.Bytes(), &resp))
|
||||
require.Equal(t, "enrolled", resp["status"])
|
||||
require.Equal(t, "test-agent", resp["agent_name"])
|
||||
}
|
||||
|
||||
// ============================================
|
||||
// isConsoleEnrollmentEnabled Tests
|
||||
// ============================================
|
||||
|
||||
func TestIsConsoleEnrollmentEnabledFromDB(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
db := OpenTestDB(t)
|
||||
require.NoError(t, db.AutoMigrate(&models.Setting{}))
|
||||
require.NoError(t, db.Create(&models.Setting{Key: "feature.crowdsec.console_enrollment", Value: "true"}).Error)
|
||||
|
||||
h := NewCrowdsecHandler(db, &fakeExec{}, "/bin/false", t.TempDir())
|
||||
require.True(t, h.isConsoleEnrollmentEnabled())
|
||||
}
|
||||
|
||||
func TestIsConsoleEnrollmentDisabledFromDB(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
db := OpenTestDB(t)
|
||||
require.NoError(t, db.AutoMigrate(&models.Setting{}))
|
||||
require.NoError(t, db.Create(&models.Setting{Key: "feature.crowdsec.console_enrollment", Value: "false"}).Error)
|
||||
|
||||
h := NewCrowdsecHandler(db, &fakeExec{}, "/bin/false", t.TempDir())
|
||||
require.False(t, h.isConsoleEnrollmentEnabled())
|
||||
}
|
||||
|
||||
func TestIsConsoleEnrollmentEnabledFromEnv(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CROWDSEC_CONSOLE_ENROLLMENT", "true")
|
||||
|
||||
h := NewCrowdsecHandler(nil, &fakeExec{}, "/bin/false", t.TempDir())
|
||||
require.True(t, h.isConsoleEnrollmentEnabled())
|
||||
}
|
||||
|
||||
func TestIsConsoleEnrollmentDisabledFromEnv(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CROWDSEC_CONSOLE_ENROLLMENT", "0")
|
||||
|
||||
h := NewCrowdsecHandler(nil, &fakeExec{}, "/bin/false", t.TempDir())
|
||||
require.False(t, h.isConsoleEnrollmentEnabled())
|
||||
}
|
||||
|
||||
func TestIsConsoleEnrollmentInvalidEnv(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CROWDSEC_CONSOLE_ENROLLMENT", "invalid")
|
||||
|
||||
h := NewCrowdsecHandler(nil, &fakeExec{}, "/bin/false", t.TempDir())
|
||||
require.False(t, h.isConsoleEnrollmentEnabled())
|
||||
}
|
||||
|
||||
func TestIsConsoleEnrollmentDefaultDisabled(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
h := NewCrowdsecHandler(nil, &fakeExec{}, "/bin/false", t.TempDir())
|
||||
require.False(t, h.isConsoleEnrollmentEnabled())
|
||||
}
|
||||
|
||||
func TestIsConsoleEnrollmentDBTrueVariants(t *testing.T) {
|
||||
tests := []struct {
|
||||
value string
|
||||
expected bool
|
||||
}{
|
||||
{"true", true},
|
||||
{"TRUE", true},
|
||||
{"True", true},
|
||||
{"1", true},
|
||||
{"yes", true},
|
||||
{"YES", true},
|
||||
{"false", false},
|
||||
{"FALSE", false},
|
||||
{"0", false},
|
||||
{"no", false},
|
||||
}
|
||||
|
||||
for _, tc := range tests {
|
||||
t.Run(tc.value, func(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
db := OpenTestDB(t)
|
||||
require.NoError(t, db.AutoMigrate(&models.Setting{}))
|
||||
require.NoError(t, db.Create(&models.Setting{Key: "feature.crowdsec.console_enrollment", Value: tc.value}).Error)
|
||||
|
||||
h := NewCrowdsecHandler(db, &fakeExec{}, "/bin/false", t.TempDir())
|
||||
require.Equal(t, tc.expected, h.isConsoleEnrollmentEnabled(), "value %q", tc.value)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// ============================================
|
||||
// Bouncer Registration Tests
|
||||
// ============================================
|
||||
|
||||
type mockCmdExecutor struct {
|
||||
output []byte
|
||||
err error
|
||||
calls []struct {
|
||||
name string
|
||||
args []string
|
||||
}
|
||||
}
|
||||
|
||||
func (m *mockCmdExecutor) Execute(ctx context.Context, name string, args ...string) ([]byte, error) {
|
||||
m.calls = append(m.calls, struct {
|
||||
name string
|
||||
args []string
|
||||
}{name, args})
|
||||
return m.output, m.err
|
||||
}
|
||||
|
||||
func TestRegisterBouncerScriptNotFound(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", t.TempDir())
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/bouncer/register", http.NoBody)
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
// Script doesn't exist, should return 404
|
||||
require.Equal(t, http.StatusNotFound, w.Code)
|
||||
require.Contains(t, w.Body.String(), "script not found")
|
||||
}
|
||||
|
||||
func TestRegisterBouncerSuccess(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
// Create a temp script that mimics successful bouncer registration
|
||||
tmpDir := t.TempDir()
|
||||
|
||||
// Skip if we can't create the script in the expected location
|
||||
if _, err := os.Stat("/usr/local/bin"); os.IsNotExist(err) {
|
||||
t.Skip("Skipping test: /usr/local/bin does not exist")
|
||||
}
|
||||
|
||||
// Create a mock command executor that simulates successful registration
|
||||
mockExec := &mockCmdExecutor{
|
||||
output: []byte("Bouncer registered successfully\nAPI Key: abc123456789abcdef0123456789abcdef\n"),
|
||||
err: nil,
|
||||
}
|
||||
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", tmpDir)
|
||||
h.CmdExec = mockExec
|
||||
|
||||
// We need the script to exist for the test to work
|
||||
// Create a dummy script in tmpDir and modify the handler to check there
|
||||
// For this test, we'll just verify the mock executor is called correctly
|
||||
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
// This will fail because script doesn't exist at /usr/local/bin/register_bouncer.sh
|
||||
// The test verifies the handler's script-not-found behavior
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/bouncer/register", http.NoBody)
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusNotFound, w.Code)
|
||||
}
|
||||
|
||||
func TestRegisterBouncerExecutionError(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
// Create a mock command executor that simulates execution error
|
||||
mockExec := &mockCmdExecutor{
|
||||
output: []byte("Error: failed to execute cscli"),
|
||||
err: errors.New("exit status 1"),
|
||||
}
|
||||
|
||||
tmpDir := t.TempDir()
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", tmpDir)
|
||||
h.CmdExec = mockExec
|
||||
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
// Script doesn't exist, so it will return 404 first
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/bouncer/register", http.NoBody)
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusNotFound, w.Code)
|
||||
}
|
||||
|
||||
// ============================================
|
||||
// Acquisition Config Tests
|
||||
// ============================================
|
||||
|
||||
func TestGetAcquisitionConfigNotFound(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", t.TempDir())
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/v1/admin/crowdsec/acquisition", http.NoBody)
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
// Test behavior depends on whether /etc/crowdsec/acquis.yaml exists in test environment
|
||||
// If file exists: 200 with content
|
||||
// If file doesn't exist: 404
|
||||
require.True(t, w.Code == http.StatusOK || w.Code == http.StatusNotFound,
|
||||
"expected 200 or 404, got %d", w.Code)
|
||||
|
||||
if w.Code == http.StatusNotFound {
|
||||
require.Contains(t, w.Body.String(), "not found")
|
||||
} else {
|
||||
var resp map[string]interface{}
|
||||
require.NoError(t, json.Unmarshal(w.Body.Bytes(), &resp))
|
||||
require.Contains(t, resp, "content")
|
||||
require.Equal(t, "/etc/crowdsec/acquis.yaml", resp["path"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetAcquisitionConfigSuccess(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
// Create a temp acquis.yaml to test with
|
||||
tmpDir := t.TempDir()
|
||||
acquisDir := filepath.Join(tmpDir, "crowdsec")
|
||||
require.NoError(t, os.MkdirAll(acquisDir, 0o755))
|
||||
|
||||
acquisContent := `# Test acquisition config
|
||||
source: file
|
||||
filenames:
|
||||
- /var/log/caddy/access.log
|
||||
labels:
|
||||
type: caddy
|
||||
`
|
||||
acquisPath := filepath.Join(acquisDir, "acquis.yaml")
|
||||
require.NoError(t, os.WriteFile(acquisPath, []byte(acquisContent), 0o644))
|
||||
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", tmpDir)
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/v1/admin/crowdsec/acquisition", http.NoBody)
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
// The handler uses a hardcoded path /etc/crowdsec/acquis.yaml
|
||||
// In test environments where this file exists, it returns 200
|
||||
// Otherwise, it returns 404
|
||||
require.True(t, w.Code == http.StatusOK || w.Code == http.StatusNotFound,
|
||||
"expected 200 or 404, got %d", w.Code)
|
||||
}
|
||||
|
||||
func TestUpdateAcquisitionConfigMissingContent(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", t.TempDir())
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
// Empty JSON body
|
||||
body, _ := json.Marshal(map[string]string{})
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPut, "/api/v1/admin/crowdsec/acquisition", bytes.NewReader(body))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusBadRequest, w.Code)
|
||||
require.Contains(t, w.Body.String(), "required")
|
||||
}
|
||||
|
||||
func TestUpdateAcquisitionConfigInvalidJSON(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", t.TempDir())
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPut, "/api/v1/admin/crowdsec/acquisition", bytes.NewBufferString("not-json"))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusBadRequest, w.Code)
|
||||
}
|
||||
|
||||
func TestUpdateAcquisitionConfigWriteError(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", t.TempDir())
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
// Valid content - test behavior depends on whether /etc/crowdsec is writable
|
||||
body, _ := json.Marshal(map[string]string{
|
||||
"content": "source: file\nfilenames:\n - /var/log/test.log\nlabels:\n type: test\n",
|
||||
})
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPut, "/api/v1/admin/crowdsec/acquisition", bytes.NewReader(body))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
// If /etc/crowdsec exists and is writable, this will succeed (200)
|
||||
// If not writable, it will fail (500)
|
||||
// We accept either outcome based on the test environment
|
||||
require.True(t, w.Code == http.StatusOK || w.Code == http.StatusInternalServerError,
|
||||
"expected 200 or 500, got %d", w.Code)
|
||||
|
||||
if w.Code == http.StatusOK {
|
||||
var resp map[string]interface{}
|
||||
require.NoError(t, json.Unmarshal(w.Body.Bytes(), &resp))
|
||||
require.Equal(t, "updated", resp["status"])
|
||||
require.True(t, resp["reload_hint"].(bool))
|
||||
}
|
||||
}
|
||||
|
||||
// TestAcquisitionConfigRoundTrip tests creating, reading, and updating acquisition config
|
||||
// when the path is writable (integration-style test)
|
||||
func TestAcquisitionConfigRoundTrip(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
// This test requires /etc/crowdsec to be writable, which isn't typical in test environments
|
||||
// Skip if the directory isn't writable
|
||||
testDir := "/etc/crowdsec"
|
||||
if _, err := os.Stat(testDir); os.IsNotExist(err) {
|
||||
t.Skip("Skipping integration test: /etc/crowdsec does not exist")
|
||||
}
|
||||
|
||||
// Check if writable by trying to create a temp file
|
||||
testFile := filepath.Join(testDir, ".write-test")
|
||||
if err := os.WriteFile(testFile, []byte("test"), 0o644); err != nil {
|
||||
t.Skip("Skipping integration test: /etc/crowdsec is not writable")
|
||||
}
|
||||
os.Remove(testFile)
|
||||
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", t.TempDir())
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
// Write new config
|
||||
newContent := `# Test config
|
||||
source: file
|
||||
filenames:
|
||||
- /var/log/test.log
|
||||
labels:
|
||||
type: test
|
||||
`
|
||||
body, _ := json.Marshal(map[string]string{"content": newContent})
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPut, "/api/v1/admin/crowdsec/acquisition", bytes.NewReader(body))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusOK, w.Code)
|
||||
|
||||
var resp map[string]interface{}
|
||||
require.NoError(t, json.Unmarshal(w.Body.Bytes(), &resp))
|
||||
require.Equal(t, "updated", resp["status"])
|
||||
require.True(t, resp["reload_hint"].(bool))
|
||||
|
||||
// Read back
|
||||
w2 := httptest.NewRecorder()
|
||||
req2 := httptest.NewRequest(http.MethodGet, "/api/v1/admin/crowdsec/acquisition", http.NoBody)
|
||||
r.ServeHTTP(w2, req2)
|
||||
|
||||
require.Equal(t, http.StatusOK, w2.Code)
|
||||
|
||||
var readResp map[string]interface{}
|
||||
require.NoError(t, json.Unmarshal(w2.Body.Bytes(), &readResp))
|
||||
require.Equal(t, newContent, readResp["content"])
|
||||
require.Equal(t, "/etc/crowdsec/acquis.yaml", readResp["path"])
|
||||
}
|
||||
|
||||
// ============================================
|
||||
// actorFromContext Tests
|
||||
// ============================================
|
||||
|
||||
func TestActorFromContextWithUserID(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
c, _ := gin.CreateTestContext(w)
|
||||
c.Set("userID", "user-123")
|
||||
|
||||
actor := actorFromContext(c)
|
||||
require.Equal(t, "user:user-123", actor)
|
||||
}
|
||||
|
||||
func TestActorFromContextWithNumericUserID(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
c, _ := gin.CreateTestContext(w)
|
||||
c.Set("userID", 456)
|
||||
|
||||
actor := actorFromContext(c)
|
||||
require.Equal(t, "user:456", actor)
|
||||
}
|
||||
|
||||
func TestActorFromContextNoUser(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
c, _ := gin.CreateTestContext(w)
|
||||
|
||||
actor := actorFromContext(c)
|
||||
require.Equal(t, "unknown", actor)
|
||||
}
|
||||
|
||||
// ============================================
|
||||
// ttlRemainingSeconds Tests
|
||||
// ============================================
|
||||
|
||||
func TestTTLRemainingSeconds(t *testing.T) {
|
||||
now := time.Date(2024, 1, 1, 12, 0, 0, 0, time.UTC)
|
||||
retrieved := time.Date(2024, 1, 1, 11, 0, 0, 0, time.UTC) // 1 hour ago
|
||||
cacheTTL := 2 * time.Hour
|
||||
|
||||
// Should have 1 hour remaining
|
||||
remaining := ttlRemainingSeconds(now, retrieved, cacheTTL)
|
||||
require.NotNil(t, remaining)
|
||||
require.Equal(t, int64(3600), *remaining) // 1 hour in seconds
|
||||
}
|
||||
|
||||
func TestTTLRemainingSecondsExpired(t *testing.T) {
|
||||
now := time.Date(2024, 1, 1, 14, 0, 0, 0, time.UTC)
|
||||
retrieved := time.Date(2024, 1, 1, 11, 0, 0, 0, time.UTC) // 3 hours ago
|
||||
cacheTTL := 2 * time.Hour
|
||||
|
||||
// Should be expired (negative or zero)
|
||||
remaining := ttlRemainingSeconds(now, retrieved, cacheTTL)
|
||||
require.NotNil(t, remaining)
|
||||
require.Equal(t, int64(0), *remaining)
|
||||
}
|
||||
|
||||
func TestTTLRemainingSecondsZeroTime(t *testing.T) {
|
||||
now := time.Date(2024, 1, 1, 12, 0, 0, 0, time.UTC)
|
||||
var retrieved time.Time // zero time
|
||||
cacheTTL := 2 * time.Hour
|
||||
|
||||
// With zero time, should return nil
|
||||
remaining := ttlRemainingSeconds(now, retrieved, cacheTTL)
|
||||
require.Nil(t, remaining)
|
||||
}
|
||||
|
||||
func TestTTLRemainingSecondsZeroTTL(t *testing.T) {
|
||||
now := time.Date(2024, 1, 1, 12, 0, 0, 0, time.UTC)
|
||||
retrieved := time.Date(2024, 1, 1, 11, 0, 0, 0, time.UTC)
|
||||
cacheTTL := time.Duration(0)
|
||||
|
||||
remaining := ttlRemainingSeconds(now, retrieved, cacheTTL)
|
||||
require.Nil(t, remaining)
|
||||
}
|
||||
|
||||
// ============================================
|
||||
// hubEndpoints Tests
|
||||
// ============================================
|
||||
|
||||
func TestHubEndpointsNil(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
h := NewCrowdsecHandler(nil, &fakeExec{}, "/bin/false", t.TempDir())
|
||||
h.Hub = nil
|
||||
|
||||
endpoints := h.hubEndpoints()
|
||||
require.Nil(t, endpoints)
|
||||
}
|
||||
|
||||
func TestHubEndpointsDeduplicates(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
h := NewCrowdsecHandler(nil, &fakeExec{}, "/bin/false", t.TempDir())
|
||||
// Hub is created by NewCrowdsecHandler, modify its fields
|
||||
if h.Hub != nil {
|
||||
h.Hub.HubBaseURL = "https://hub.crowdsec.net"
|
||||
h.Hub.MirrorBaseURL = "https://hub.crowdsec.net" // Same URL
|
||||
}
|
||||
|
||||
endpoints := h.hubEndpoints()
|
||||
require.Len(t, endpoints, 1)
|
||||
require.Equal(t, "https://hub.crowdsec.net", endpoints[0])
|
||||
}
|
||||
|
||||
func TestHubEndpointsMultiple(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
h := NewCrowdsecHandler(nil, &fakeExec{}, "/bin/false", t.TempDir())
|
||||
if h.Hub != nil {
|
||||
h.Hub.HubBaseURL = "https://hub.crowdsec.net"
|
||||
h.Hub.MirrorBaseURL = "https://mirror.example.com"
|
||||
}
|
||||
|
||||
endpoints := h.hubEndpoints()
|
||||
require.Len(t, endpoints, 2)
|
||||
require.Contains(t, endpoints, "https://hub.crowdsec.net")
|
||||
require.Contains(t, endpoints, "https://mirror.example.com")
|
||||
}
|
||||
|
||||
func TestHubEndpointsSkipsEmpty(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
h := NewCrowdsecHandler(nil, &fakeExec{}, "/bin/false", t.TempDir())
|
||||
if h.Hub != nil {
|
||||
h.Hub.HubBaseURL = "https://hub.crowdsec.net"
|
||||
h.Hub.MirrorBaseURL = "" // Empty
|
||||
}
|
||||
|
||||
endpoints := h.hubEndpoints()
|
||||
require.Len(t, endpoints, 1)
|
||||
require.Equal(t, "https://hub.crowdsec.net", endpoints[0])
|
||||
}
|
||||
|
||||
142
backend/internal/api/handlers/crowdsec_lapi_test.go
Normal file
142
backend/internal/api/handlers/crowdsec_lapi_test.go
Normal file
@@ -0,0 +1,142 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestGetLAPIDecisions_FallbackToCscli(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
router := gin.New()
|
||||
|
||||
// Create handler with mock executor
|
||||
handler := &CrowdsecHandler{
|
||||
CmdExec: &mockCommandExecutor{output: []byte(`[]`), err: nil},
|
||||
DataDir: t.TempDir(),
|
||||
}
|
||||
|
||||
router.GET("/admin/crowdsec/decisions/lapi", handler.GetLAPIDecisions)
|
||||
|
||||
// This test will fallback to cscli since localhost:8080 LAPI is not running
|
||||
req := httptest.NewRequest(http.MethodGet, "/admin/crowdsec/decisions/lapi", http.NoBody)
|
||||
w := httptest.NewRecorder()
|
||||
router.ServeHTTP(w, req)
|
||||
|
||||
// Should return success (from cscli fallback)
|
||||
assert.Equal(t, http.StatusOK, w.Code)
|
||||
|
||||
var response map[string]interface{}
|
||||
err := json.Unmarshal(w.Body.Bytes(), &response)
|
||||
assert.NoError(t, err)
|
||||
// Should have decisions array (empty from mock)
|
||||
_, hasDecisions := response["decisions"]
|
||||
assert.True(t, hasDecisions)
|
||||
}
|
||||
|
||||
func TestGetLAPIDecisions_EmptyResponse(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
router := gin.New()
|
||||
|
||||
// Create handler with mock executor that returns empty array
|
||||
handler := &CrowdsecHandler{
|
||||
CmdExec: &mockCommandExecutor{output: []byte(`[]`), err: nil},
|
||||
DataDir: t.TempDir(),
|
||||
}
|
||||
|
||||
router.GET("/admin/crowdsec/decisions/lapi", handler.GetLAPIDecisions)
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/admin/crowdsec/decisions/lapi", http.NoBody)
|
||||
w := httptest.NewRecorder()
|
||||
router.ServeHTTP(w, req)
|
||||
|
||||
// Will fallback to cscli which returns empty
|
||||
assert.Equal(t, http.StatusOK, w.Code)
|
||||
|
||||
var response map[string]interface{}
|
||||
err := json.Unmarshal(w.Body.Bytes(), &response)
|
||||
assert.NoError(t, err)
|
||||
// Should have decisions array (may be empty)
|
||||
_, hasDecisions := response["decisions"]
|
||||
assert.True(t, hasDecisions)
|
||||
}
|
||||
|
||||
func TestCheckLAPIHealth_Handler(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
router := gin.New()
|
||||
|
||||
handler := &CrowdsecHandler{
|
||||
CmdExec: &mockCommandExecutor{output: []byte(`[]`), err: nil},
|
||||
DataDir: t.TempDir(),
|
||||
}
|
||||
|
||||
router.GET("/admin/crowdsec/lapi/health", handler.CheckLAPIHealth)
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/admin/crowdsec/lapi/health", http.NoBody)
|
||||
w := httptest.NewRecorder()
|
||||
router.ServeHTTP(w, req)
|
||||
|
||||
assert.Equal(t, http.StatusOK, w.Code)
|
||||
|
||||
var response map[string]interface{}
|
||||
err := json.Unmarshal(w.Body.Bytes(), &response)
|
||||
assert.NoError(t, err)
|
||||
|
||||
// Should have healthy field
|
||||
_, hasHealthy := response["healthy"]
|
||||
assert.True(t, hasHealthy)
|
||||
|
||||
// Should have lapi_url field
|
||||
_, hasURL := response["lapi_url"]
|
||||
assert.True(t, hasURL)
|
||||
}
|
||||
|
||||
func TestGetLAPIKey_FromEnv(t *testing.T) {
|
||||
// Save and restore original env
|
||||
original := os.Getenv("CROWDSEC_API_KEY")
|
||||
defer func() {
|
||||
if original != "" {
|
||||
_ = os.Setenv("CROWDSEC_API_KEY", original)
|
||||
} else {
|
||||
_ = os.Unsetenv("CROWDSEC_API_KEY")
|
||||
}
|
||||
}()
|
||||
|
||||
// Set test value
|
||||
_ = os.Setenv("CROWDSEC_API_KEY", "test-key-123")
|
||||
|
||||
key := getLAPIKey()
|
||||
assert.Equal(t, "test-key-123", key)
|
||||
}
|
||||
|
||||
func TestGetLAPIKey_Empty(t *testing.T) {
|
||||
// Save and restore original env vars
|
||||
envVars := []string{
|
||||
"CROWDSEC_API_KEY",
|
||||
"CROWDSEC_BOUNCER_API_KEY",
|
||||
"CERBERUS_SECURITY_CROWDSEC_API_KEY",
|
||||
"CHARON_SECURITY_CROWDSEC_API_KEY",
|
||||
"CPM_SECURITY_CROWDSEC_API_KEY",
|
||||
}
|
||||
|
||||
originals := make(map[string]string)
|
||||
for _, key := range envVars {
|
||||
originals[key] = os.Getenv(key)
|
||||
_ = os.Unsetenv(key)
|
||||
}
|
||||
defer func() {
|
||||
for key, val := range originals {
|
||||
if val != "" {
|
||||
_ = os.Setenv(key, val)
|
||||
}
|
||||
}
|
||||
}()
|
||||
|
||||
key := getLAPIKey()
|
||||
assert.Empty(t, key)
|
||||
}
|
||||
@@ -301,13 +301,23 @@ func TestApplyPresetHandlerBackupFailure(t *testing.T) {
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusInternalServerError, w.Code)
|
||||
require.Contains(t, w.Body.String(), "cscli unavailable")
|
||||
|
||||
// Verify response includes backup path for traceability
|
||||
var response map[string]interface{}
|
||||
require.NoError(t, json.Unmarshal(w.Body.Bytes(), &response))
|
||||
_, hasBackup := response["backup"]
|
||||
require.True(t, hasBackup, "Response should include 'backup' field for diagnostics")
|
||||
|
||||
// Verify error message is present
|
||||
errorMsg, ok := response["error"].(string)
|
||||
require.True(t, ok, "error field should be a string")
|
||||
require.Contains(t, errorMsg, "cache", "error should indicate cache is unavailable")
|
||||
|
||||
var events []models.CrowdsecPresetEvent
|
||||
require.NoError(t, db.Find(&events).Error)
|
||||
require.Len(t, events, 1)
|
||||
require.Equal(t, "failed", events[0].Status)
|
||||
require.Empty(t, events[0].BackupPath)
|
||||
require.NotEmpty(t, events[0].BackupPath)
|
||||
|
||||
content, readErr := os.ReadFile(filepath.Join(dataDir, "keep.txt"))
|
||||
require.NoError(t, readErr)
|
||||
@@ -439,3 +449,87 @@ func TestGetCachedPresetPreviewError(t *testing.T) {
|
||||
require.Equal(t, http.StatusInternalServerError, w.Code)
|
||||
require.Contains(t, w.Body.String(), "no such file")
|
||||
}
|
||||
|
||||
func TestPullCuratedPresetSkipsHub(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CERBERUS_ENABLED", "true")
|
||||
|
||||
// Setup handler with a hub service that would fail if called
|
||||
cache, err := crowdsec.NewHubCache(t.TempDir(), time.Hour)
|
||||
require.NoError(t, err)
|
||||
|
||||
// We don't set HTTPClient, so any network call would panic or fail if not handled
|
||||
hub := crowdsec.NewHubService(nil, cache, t.TempDir())
|
||||
|
||||
h := NewCrowdsecHandler(OpenTestDB(t), &fakeExec{}, "/bin/false", t.TempDir())
|
||||
h.Hub = hub
|
||||
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
// Use a known curated preset that doesn't require hub
|
||||
slug := "honeypot-friendly-defaults"
|
||||
|
||||
body, _ := json.Marshal(map[string]string{"slug": slug})
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/presets/pull", bytes.NewReader(body))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusOK, w.Code)
|
||||
|
||||
var resp map[string]interface{}
|
||||
require.NoError(t, json.Unmarshal(w.Body.Bytes(), &resp))
|
||||
|
||||
require.Equal(t, "pulled", resp["status"])
|
||||
require.Equal(t, slug, resp["slug"])
|
||||
require.Equal(t, "charon-curated", resp["source"])
|
||||
require.Contains(t, resp["preview"], "Curated preset")
|
||||
}
|
||||
|
||||
func TestApplyCuratedPresetSkipsHub(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
t.Setenv("FEATURE_CERBERUS_ENABLED", "true")
|
||||
|
||||
db := OpenTestDB(t)
|
||||
require.NoError(t, db.AutoMigrate(&models.CrowdsecPresetEvent{}))
|
||||
|
||||
// Setup handler with a hub service that would fail if called
|
||||
// We intentionally don't put anything in cache to prove we don't check it
|
||||
cache, err := crowdsec.NewHubCache(t.TempDir(), time.Hour)
|
||||
require.NoError(t, err)
|
||||
|
||||
hub := crowdsec.NewHubService(nil, cache, t.TempDir())
|
||||
|
||||
h := NewCrowdsecHandler(db, &fakeExec{}, "/bin/false", t.TempDir())
|
||||
h.Hub = hub
|
||||
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
h.RegisterRoutes(g)
|
||||
|
||||
// Use a known curated preset that doesn't require hub
|
||||
slug := "honeypot-friendly-defaults"
|
||||
|
||||
body, _ := json.Marshal(map[string]string{"slug": slug})
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/presets/apply", bytes.NewReader(body))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusOK, w.Code)
|
||||
|
||||
var resp map[string]interface{}
|
||||
require.NoError(t, json.Unmarshal(w.Body.Bytes(), &resp))
|
||||
|
||||
require.Equal(t, "applied", resp["status"])
|
||||
require.Equal(t, slug, resp["slug"])
|
||||
|
||||
// Verify event was logged
|
||||
var events []models.CrowdsecPresetEvent
|
||||
require.NoError(t, db.Find(&events).Error)
|
||||
require.Len(t, events, 1)
|
||||
require.Equal(t, slug, events[0].Slug)
|
||||
require.Equal(t, "applied", events[0].Status)
|
||||
}
|
||||
|
||||
@@ -0,0 +1,226 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"archive/tar"
|
||||
"bytes"
|
||||
"compress/gzip"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/crowdsec"
|
||||
)
|
||||
|
||||
// TestPullThenApplyIntegration tests the complete pull→apply workflow from the user's perspective.
|
||||
// This reproduces the scenario where a user pulls a preset and then tries to apply it.
|
||||
func TestPullThenApplyIntegration(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
// Setup
|
||||
cacheDir := t.TempDir()
|
||||
dataDir := t.TempDir()
|
||||
|
||||
cache, err := crowdsec.NewHubCache(cacheDir, time.Hour)
|
||||
require.NoError(t, err)
|
||||
|
||||
archive := makePresetTarGz(t, map[string]string{
|
||||
"config.yaml": "test: config\nversion: 1",
|
||||
})
|
||||
|
||||
hub := crowdsec.NewHubService(nil, cache, dataDir)
|
||||
hub.HubBaseURL = "http://test.hub"
|
||||
hub.HTTPClient = &http.Client{
|
||||
Transport: testRoundTripper(func(req *http.Request) (*http.Response, error) {
|
||||
switch req.URL.String() {
|
||||
case "http://test.hub/api/index.json":
|
||||
body := `{"items":[{"name":"test/preset","title":"Test","description":"Test preset","etag":"abc123","download_url":"http://test.hub/test.tgz","preview_url":"http://test.hub/test.yaml"}]}`
|
||||
return &http.Response{StatusCode: 200, Body: io.NopCloser(strings.NewReader(body)), Header: make(http.Header)}, nil
|
||||
case "http://test.hub/test.yaml":
|
||||
return &http.Response{StatusCode: 200, Body: io.NopCloser(strings.NewReader("preview content")), Header: make(http.Header)}, nil
|
||||
case "http://test.hub/test.tgz":
|
||||
return &http.Response{StatusCode: 200, Body: io.NopCloser(bytes.NewReader(archive)), Header: make(http.Header)}, nil
|
||||
default:
|
||||
return &http.Response{StatusCode: 404, Body: io.NopCloser(strings.NewReader("")), Header: make(http.Header)}, nil
|
||||
}
|
||||
}),
|
||||
}
|
||||
|
||||
db := OpenTestDB(t)
|
||||
handler := NewCrowdsecHandler(db, &fakeExec{}, "/bin/false", dataDir)
|
||||
handler.Hub = hub
|
||||
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
handler.RegisterRoutes(g)
|
||||
|
||||
// Step 1: Pull the preset
|
||||
t.Log("User pulls preset")
|
||||
pullPayload, _ := json.Marshal(map[string]string{"slug": "test/preset"})
|
||||
pullReq := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/presets/pull", bytes.NewReader(pullPayload))
|
||||
pullReq.Header.Set("Content-Type", "application/json")
|
||||
pullResp := httptest.NewRecorder()
|
||||
r.ServeHTTP(pullResp, pullReq)
|
||||
|
||||
require.Equal(t, http.StatusOK, pullResp.Code, "Pull should succeed")
|
||||
|
||||
var pullResult map[string]interface{}
|
||||
err = json.Unmarshal(pullResp.Body.Bytes(), &pullResult)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "pulled", pullResult["status"])
|
||||
require.NotEmpty(t, pullResult["cache_key"], "Pull should return cache_key")
|
||||
require.NotEmpty(t, pullResult["preview"], "Pull should return preview")
|
||||
|
||||
t.Log("Pull succeeded, cache_key:", pullResult["cache_key"])
|
||||
|
||||
// Verify cache was populated
|
||||
ctx := context.Background()
|
||||
cached, err := cache.Load(ctx, "test/preset")
|
||||
require.NoError(t, err, "Preset should be cached after pull")
|
||||
require.Equal(t, "test/preset", cached.Slug)
|
||||
t.Log("Cache verified, slug:", cached.Slug)
|
||||
|
||||
// Step 2: Apply the preset (this should use the cached data)
|
||||
t.Log("User applies preset")
|
||||
applyPayload, _ := json.Marshal(map[string]string{"slug": "test/preset"})
|
||||
applyReq := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/presets/apply", bytes.NewReader(applyPayload))
|
||||
applyReq.Header.Set("Content-Type", "application/json")
|
||||
applyResp := httptest.NewRecorder()
|
||||
r.ServeHTTP(applyResp, applyReq)
|
||||
|
||||
// This should NOT return "preset not cached" error
|
||||
require.Equal(t, http.StatusOK, applyResp.Code, "Apply should succeed after pull. Response: %s", applyResp.Body.String())
|
||||
|
||||
var applyResult map[string]interface{}
|
||||
err = json.Unmarshal(applyResp.Body.Bytes(), &applyResult)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "applied", applyResult["status"], "Apply status should be 'applied'")
|
||||
require.NotEmpty(t, applyResult["backup"], "Apply should return backup path")
|
||||
|
||||
t.Log("Apply succeeded, backup:", applyResult["backup"])
|
||||
}
|
||||
|
||||
// TestApplyWithoutPullReturnsProperError verifies the error message when applying without pulling first.
|
||||
func TestApplyWithoutPullReturnsProperError(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
cacheDir := t.TempDir()
|
||||
dataDir := t.TempDir()
|
||||
|
||||
cache, err := crowdsec.NewHubCache(cacheDir, time.Hour)
|
||||
require.NoError(t, err)
|
||||
|
||||
// Empty cache, no cscli
|
||||
hub := crowdsec.NewHubService(nil, cache, dataDir)
|
||||
hub.HubBaseURL = "http://test.hub"
|
||||
hub.HTTPClient = &http.Client{Transport: testRoundTripper(func(req *http.Request) (*http.Response, error) {
|
||||
return &http.Response{StatusCode: http.StatusInternalServerError, Body: io.NopCloser(strings.NewReader("")), Header: make(http.Header)}, nil
|
||||
})}
|
||||
|
||||
db := OpenTestDB(t)
|
||||
handler := NewCrowdsecHandler(db, &fakeExec{}, "/bin/false", dataDir)
|
||||
handler.Hub = hub
|
||||
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
handler.RegisterRoutes(g)
|
||||
|
||||
// Try to apply without pulling first
|
||||
t.Log("User tries to apply preset without pulling first")
|
||||
applyPayload, _ := json.Marshal(map[string]string{"slug": "test/preset"})
|
||||
applyReq := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/presets/apply", bytes.NewReader(applyPayload))
|
||||
applyReq.Header.Set("Content-Type", "application/json")
|
||||
applyResp := httptest.NewRecorder()
|
||||
r.ServeHTTP(applyResp, applyReq)
|
||||
|
||||
require.Equal(t, http.StatusInternalServerError, applyResp.Code, "Apply should fail without cache")
|
||||
|
||||
var errorResult map[string]interface{}
|
||||
err = json.Unmarshal(applyResp.Body.Bytes(), &errorResult)
|
||||
require.NoError(t, err)
|
||||
|
||||
errorMsg := errorResult["error"].(string)
|
||||
require.Contains(t, errorMsg, "Preset cache missing", "Error should mention preset not cached")
|
||||
require.Contains(t, errorMsg, "Pull the preset", "Error should guide user to pull first")
|
||||
t.Log("Proper error message returned:", errorMsg)
|
||||
}
|
||||
|
||||
func TestApplyRollbackWhenCacheMissingAndRepullFails(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
cacheDir := t.TempDir()
|
||||
dataRoot := t.TempDir()
|
||||
dataDir := filepath.Join(dataRoot, "crowdsec")
|
||||
require.NoError(t, os.MkdirAll(dataDir, 0o755))
|
||||
originalFile := filepath.Join(dataDir, "config.yaml")
|
||||
require.NoError(t, os.WriteFile(originalFile, []byte("original"), 0o644))
|
||||
|
||||
cache, err := crowdsec.NewHubCache(cacheDir, time.Hour)
|
||||
require.NoError(t, err)
|
||||
|
||||
hub := crowdsec.NewHubService(nil, cache, dataDir)
|
||||
hub.HubBaseURL = "http://test.hub"
|
||||
hub.HTTPClient = &http.Client{Transport: testRoundTripper(func(req *http.Request) (*http.Response, error) {
|
||||
// Force repull failure
|
||||
return &http.Response{StatusCode: 500, Body: io.NopCloser(strings.NewReader("")), Header: make(http.Header)}, nil
|
||||
})}
|
||||
|
||||
db := OpenTestDB(t)
|
||||
handler := NewCrowdsecHandler(db, &fakeExec{}, "/bin/false", dataDir)
|
||||
handler.Hub = hub
|
||||
|
||||
r := gin.New()
|
||||
g := r.Group("/api/v1")
|
||||
handler.RegisterRoutes(g)
|
||||
|
||||
applyPayload, _ := json.Marshal(map[string]string{"slug": "missing/preset"})
|
||||
applyReq := httptest.NewRequest(http.MethodPost, "/api/v1/admin/crowdsec/presets/apply", bytes.NewReader(applyPayload))
|
||||
applyReq.Header.Set("Content-Type", "application/json")
|
||||
applyResp := httptest.NewRecorder()
|
||||
r.ServeHTTP(applyResp, applyReq)
|
||||
|
||||
require.Equal(t, http.StatusInternalServerError, applyResp.Code)
|
||||
|
||||
var body map[string]any
|
||||
require.NoError(t, json.Unmarshal(applyResp.Body.Bytes(), &body))
|
||||
require.NotEmpty(t, body["backup"], "backup path should be returned for rollback traceability")
|
||||
require.Contains(t, body["error"], "Preset cache missing", "error should guide user to repull")
|
||||
|
||||
// Original file should remain after rollback
|
||||
data, readErr := os.ReadFile(originalFile)
|
||||
require.NoError(t, readErr)
|
||||
require.Equal(t, "original", string(data))
|
||||
}
|
||||
|
||||
func makePresetTarGz(t *testing.T, files map[string]string) []byte {
|
||||
t.Helper()
|
||||
buf := &bytes.Buffer{}
|
||||
gw := gzip.NewWriter(buf)
|
||||
tw := tar.NewWriter(gw)
|
||||
|
||||
for name, content := range files {
|
||||
hdr := &tar.Header{Name: name, Mode: 0o644, Size: int64(len(content))}
|
||||
require.NoError(t, tw.WriteHeader(hdr))
|
||||
_, err := tw.Write([]byte(content))
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
require.NoError(t, tw.Close())
|
||||
require.NoError(t, gw.Close())
|
||||
return buf.Bytes()
|
||||
}
|
||||
|
||||
type testRoundTripper func(*http.Request) (*http.Response, error)
|
||||
|
||||
func (t testRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||
return t(req)
|
||||
}
|
||||
@@ -25,6 +25,12 @@ func NewFeatureFlagsHandler(db *gorm.DB) *FeatureFlagsHandler {
|
||||
var defaultFlags = []string{
|
||||
"feature.cerberus.enabled",
|
||||
"feature.uptime.enabled",
|
||||
"feature.crowdsec.console_enrollment",
|
||||
}
|
||||
|
||||
var defaultFlagValues = map[string]bool{
|
||||
"feature.cerberus.enabled": false, // Cerberus OFF by default
|
||||
"feature.crowdsec.console_enrollment": false,
|
||||
}
|
||||
|
||||
// GetFlags returns a map of feature flag -> bool. DB setting takes precedence
|
||||
@@ -33,6 +39,10 @@ func (h *FeatureFlagsHandler) GetFlags(c *gin.Context) {
|
||||
result := make(map[string]bool)
|
||||
|
||||
for _, key := range defaultFlags {
|
||||
defaultVal := true
|
||||
if v, ok := defaultFlagValues[key]; ok {
|
||||
defaultVal = v
|
||||
}
|
||||
// Try DB
|
||||
var s models.Setting
|
||||
if err := h.DB.Where("key = ?", key).First(&s).Error; err == nil {
|
||||
@@ -67,8 +77,8 @@ func (h *FeatureFlagsHandler) GetFlags(c *gin.Context) {
|
||||
}
|
||||
}
|
||||
|
||||
// Default true for core optional features
|
||||
result[key] = true
|
||||
// Default based on declared flag value
|
||||
result[key] = defaultVal
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, result)
|
||||
|
||||
@@ -126,7 +126,7 @@ func TestFeatureFlagsHandler_GetFlags_DefaultTrue(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
db := setupFlagsDB(t)
|
||||
|
||||
// No DB value, no env var - should default to true
|
||||
// No DB value, no env var - check defaults
|
||||
h := NewFeatureFlagsHandler(db)
|
||||
r := gin.New()
|
||||
r.GET("/api/v1/feature-flags", h.GetFlags)
|
||||
@@ -141,8 +141,9 @@ func TestFeatureFlagsHandler_GetFlags_DefaultTrue(t *testing.T) {
|
||||
err := json.Unmarshal(w.Body.Bytes(), &flags)
|
||||
require.NoError(t, err)
|
||||
|
||||
// All flags should default to true
|
||||
assert.True(t, flags["feature.cerberus.enabled"])
|
||||
// Cerberus defaults to false (OFF by default per diagnostic fix)
|
||||
assert.False(t, flags["feature.cerberus.enabled"])
|
||||
// Uptime defaults to true (no explicit default set)
|
||||
assert.True(t, flags["feature.uptime.enabled"])
|
||||
}
|
||||
|
||||
|
||||
@@ -17,6 +17,8 @@ type LogsHandler struct {
|
||||
service *services.LogService
|
||||
}
|
||||
|
||||
var createTempFile = os.CreateTemp
|
||||
|
||||
func NewLogsHandler(service *services.LogService) *LogsHandler {
|
||||
return &LogsHandler{service: service}
|
||||
}
|
||||
@@ -80,7 +82,7 @@ func (h *LogsHandler) Download(c *gin.Context) {
|
||||
|
||||
// Create a temporary file to serve a consistent snapshot
|
||||
// This prevents Content-Length mismatches if the live log file grows during download
|
||||
tmpFile, err := os.CreateTemp("", "charon-log-*.log")
|
||||
tmpFile, err := createTempFile("", "charon-log-*.log")
|
||||
if err != nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "Failed to create temp file"})
|
||||
return
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
@@ -9,6 +10,7 @@ import (
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/config"
|
||||
"github.com/Wikid82/charon/backend/internal/services"
|
||||
@@ -193,3 +195,37 @@ func TestLogsHandler_List_DirectoryIsFile(t *testing.T) {
|
||||
// Service may handle this gracefully or error
|
||||
assert.Contains(t, []int{200, 500}, w.Code)
|
||||
}
|
||||
|
||||
func TestLogsHandler_Download_TempFileError(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
tmpDir := t.TempDir()
|
||||
dataDir := filepath.Join(tmpDir, "data")
|
||||
logsDir := filepath.Join(dataDir, "logs")
|
||||
require.NoError(t, os.MkdirAll(logsDir, 0o755))
|
||||
|
||||
dbPath := filepath.Join(dataDir, "charon.db")
|
||||
logPath := filepath.Join(logsDir, "access.log")
|
||||
require.NoError(t, os.WriteFile(logPath, []byte("log line"), 0o644))
|
||||
|
||||
cfg := &config.Config{DatabasePath: dbPath}
|
||||
svc := services.NewLogService(cfg)
|
||||
h := NewLogsHandler(svc)
|
||||
|
||||
originalCreateTemp := createTempFile
|
||||
createTempFile = func(dir, pattern string) (*os.File, error) {
|
||||
return nil, fmt.Errorf("boom")
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
createTempFile = originalCreateTemp
|
||||
})
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
c, _ := gin.CreateTestContext(w)
|
||||
c.Params = gin.Params{{Key: "filename", Value: "access.log"}}
|
||||
c.Request = httptest.NewRequest("GET", "/logs/access.log", http.NoBody)
|
||||
|
||||
h.Download(c)
|
||||
|
||||
assert.Equal(t, http.StatusInternalServerError, w.Code)
|
||||
}
|
||||
|
||||
129
backend/internal/api/handlers/logs_ws.go
Normal file
129
backend/internal/api/handlers/logs_ws.go
Normal file
@@ -0,0 +1,129 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/google/uuid"
|
||||
"github.com/gorilla/websocket"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/logger"
|
||||
)
|
||||
|
||||
var upgrader = websocket.Upgrader{
|
||||
CheckOrigin: func(r *http.Request) bool {
|
||||
// Allow all origins for development. In production, this should check
|
||||
// against a whitelist of allowed origins.
|
||||
return true
|
||||
},
|
||||
ReadBufferSize: 1024,
|
||||
WriteBufferSize: 1024,
|
||||
}
|
||||
|
||||
// LogEntry represents a structured log entry sent over WebSocket.
|
||||
type LogEntry struct {
|
||||
Level string `json:"level"`
|
||||
Message string `json:"message"`
|
||||
Timestamp string `json:"timestamp"`
|
||||
Source string `json:"source"`
|
||||
Fields map[string]interface{} `json:"fields"`
|
||||
}
|
||||
|
||||
// LogsWebSocketHandler handles WebSocket connections for live log streaming.
|
||||
func LogsWebSocketHandler(c *gin.Context) {
|
||||
logger.Log().Info("WebSocket connection attempt received")
|
||||
|
||||
// Upgrade HTTP connection to WebSocket
|
||||
conn, err := upgrader.Upgrade(c.Writer, c.Request, nil)
|
||||
if err != nil {
|
||||
logger.Log().WithError(err).Error("Failed to upgrade WebSocket connection")
|
||||
return
|
||||
}
|
||||
defer func() {
|
||||
if err := conn.Close(); err != nil {
|
||||
logger.Log().WithError(err).Error("Failed to close WebSocket connection")
|
||||
}
|
||||
}()
|
||||
|
||||
// Generate unique subscriber ID
|
||||
subscriberID := uuid.New().String()
|
||||
|
||||
logger.Log().WithField("subscriber_id", subscriberID).Info("WebSocket connection established successfully")
|
||||
|
||||
// Parse query parameters for filtering
|
||||
levelFilter := strings.ToLower(c.Query("level"))
|
||||
sourceFilter := strings.ToLower(c.Query("source"))
|
||||
|
||||
// Subscribe to log broadcasts
|
||||
hook := logger.GetBroadcastHook()
|
||||
logChan := hook.Subscribe(subscriberID)
|
||||
defer hook.Unsubscribe(subscriberID)
|
||||
|
||||
// Channel to signal when client disconnects
|
||||
done := make(chan struct{})
|
||||
|
||||
// Goroutine to read from WebSocket (detect client disconnect)
|
||||
go func() {
|
||||
defer close(done)
|
||||
for {
|
||||
if _, _, err := conn.ReadMessage(); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
}()
|
||||
|
||||
// Main loop: stream logs to client
|
||||
ticker := time.NewTicker(30 * time.Second)
|
||||
defer ticker.Stop()
|
||||
|
||||
for {
|
||||
select {
|
||||
case entry, ok := <-logChan:
|
||||
if !ok {
|
||||
// Channel closed
|
||||
return
|
||||
}
|
||||
|
||||
// Apply filters
|
||||
if levelFilter != "" && !strings.EqualFold(entry.Level.String(), levelFilter) {
|
||||
continue
|
||||
}
|
||||
|
||||
source := ""
|
||||
if s, ok := entry.Data["source"]; ok {
|
||||
source = s.(string)
|
||||
}
|
||||
|
||||
if sourceFilter != "" && !strings.Contains(strings.ToLower(source), sourceFilter) {
|
||||
continue
|
||||
}
|
||||
|
||||
// Convert logrus entry to LogEntry
|
||||
logEntry := LogEntry{
|
||||
Level: entry.Level.String(),
|
||||
Message: entry.Message,
|
||||
Timestamp: entry.Time.Format(time.RFC3339),
|
||||
Source: source,
|
||||
Fields: entry.Data,
|
||||
}
|
||||
|
||||
// Send to WebSocket client
|
||||
if err := conn.WriteJSON(logEntry); err != nil {
|
||||
logger.Log().WithError(err).Debug("Failed to write to WebSocket")
|
||||
return
|
||||
}
|
||||
|
||||
case <-ticker.C:
|
||||
// Send ping to keep connection alive
|
||||
if err := conn.WriteMessage(websocket.PingMessage, []byte{}); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
case <-done:
|
||||
// Client disconnected
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
215
backend/internal/api/handlers/logs_ws_test.go
Normal file
215
backend/internal/api/handlers/logs_ws_test.go
Normal file
@@ -0,0 +1,215 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/gorilla/websocket"
|
||||
"github.com/sirupsen/logrus"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/logger"
|
||||
)
|
||||
|
||||
func TestLogsWebSocketHandler_SuccessfulConnection(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
|
||||
conn := server.dial(t, "/logs/live")
|
||||
|
||||
waitForListenerCount(t, server.hook, 1)
|
||||
require.NoError(t, conn.WriteMessage(websocket.TextMessage, []byte("hello")))
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_ReceiveLogEntries(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
conn := server.dial(t, "/logs/live")
|
||||
|
||||
server.sendEntry(t, logrus.InfoLevel, "hello", logrus.Fields{"source": "api", "user": "alice"})
|
||||
|
||||
received := readLogEntry(t, conn)
|
||||
assert.Equal(t, "info", received.Level)
|
||||
assert.Equal(t, "hello", received.Message)
|
||||
assert.Equal(t, "api", received.Source)
|
||||
assert.Equal(t, "alice", received.Fields["user"])
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_LevelFilter(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
conn := server.dial(t, "/logs/live?level=error")
|
||||
|
||||
server.sendEntry(t, logrus.InfoLevel, "info", logrus.Fields{"source": "api"})
|
||||
server.sendEntry(t, logrus.ErrorLevel, "error", logrus.Fields{"source": "api"})
|
||||
|
||||
received := readLogEntry(t, conn)
|
||||
assert.Equal(t, "error", received.Level)
|
||||
|
||||
// Ensure no additional messages arrive
|
||||
require.NoError(t, conn.SetReadDeadline(time.Now().Add(150*time.Millisecond)))
|
||||
_, _, err := conn.ReadMessage()
|
||||
assert.Error(t, err)
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_SourceFilter(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
conn := server.dial(t, "/logs/live?source=api")
|
||||
|
||||
server.sendEntry(t, logrus.InfoLevel, "backend", logrus.Fields{"source": "backend"})
|
||||
server.sendEntry(t, logrus.InfoLevel, "api", logrus.Fields{"source": "api"})
|
||||
|
||||
received := readLogEntry(t, conn)
|
||||
assert.Equal(t, "api", received.Source)
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_CombinedFilters(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
conn := server.dial(t, "/logs/live?level=error&source=api")
|
||||
|
||||
server.sendEntry(t, logrus.WarnLevel, "warn api", logrus.Fields{"source": "api"})
|
||||
server.sendEntry(t, logrus.ErrorLevel, "error api", logrus.Fields{"source": "api"})
|
||||
server.sendEntry(t, logrus.ErrorLevel, "error ui", logrus.Fields{"source": "ui"})
|
||||
|
||||
received := readLogEntry(t, conn)
|
||||
assert.Equal(t, "error api", received.Message)
|
||||
assert.Equal(t, "api", received.Source)
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_CaseInsensitiveFilters(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
conn := server.dial(t, "/logs/live?level=ERROR&source=API")
|
||||
|
||||
server.sendEntry(t, logrus.ErrorLevel, "error api", logrus.Fields{"source": "api"})
|
||||
received := readLogEntry(t, conn)
|
||||
assert.Equal(t, "error api", received.Message)
|
||||
assert.Equal(t, "error", received.Level)
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_UpgradeFailure(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
router := gin.New()
|
||||
router.GET("/logs/live", LogsWebSocketHandler)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest("GET", "/logs/live", http.NoBody)
|
||||
router.ServeHTTP(w, req)
|
||||
|
||||
assert.Equal(t, http.StatusBadRequest, w.Code)
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_ClientDisconnect(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
conn := server.dial(t, "/logs/live")
|
||||
|
||||
waitForListenerCount(t, server.hook, 1)
|
||||
require.NoError(t, conn.Close())
|
||||
waitForListenerCount(t, server.hook, 0)
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_ChannelClosed(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
_ = server.dial(t, "/logs/live")
|
||||
|
||||
ids := server.subscriberIDs(t)
|
||||
require.Len(t, ids, 1)
|
||||
|
||||
server.hook.Unsubscribe(ids[0])
|
||||
waitForListenerCount(t, server.hook, 0)
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_MultipleConnections(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
const connCount = 5
|
||||
|
||||
conns := make([]*websocket.Conn, 0, connCount)
|
||||
for i := 0; i < connCount; i++ {
|
||||
conns = append(conns, server.dial(t, "/logs/live"))
|
||||
}
|
||||
|
||||
waitForListenerCount(t, server.hook, connCount)
|
||||
|
||||
done := make(chan struct{})
|
||||
for _, conn := range conns {
|
||||
go func(c *websocket.Conn) {
|
||||
defer func() { done <- struct{}{} }()
|
||||
for {
|
||||
entry := readLogEntry(t, c)
|
||||
if entry.Message == "broadcast" {
|
||||
assert.Equal(t, "broadcast", entry.Message)
|
||||
return
|
||||
}
|
||||
}
|
||||
}(conn)
|
||||
}
|
||||
|
||||
server.sendEntry(t, logrus.InfoLevel, "broadcast", logrus.Fields{"source": "api"})
|
||||
|
||||
for i := 0; i < connCount; i++ {
|
||||
<-done
|
||||
}
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_HighVolumeLogging(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
conn := server.dial(t, "/logs/live")
|
||||
|
||||
for i := 0; i < 200; i++ {
|
||||
server.sendEntry(t, logrus.InfoLevel, fmt.Sprintf("msg-%d", i), logrus.Fields{"source": "api"})
|
||||
received := readLogEntry(t, conn)
|
||||
assert.Equal(t, fmt.Sprintf("msg-%d", i), received.Message)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_EmptyLogFields(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
conn := server.dial(t, "/logs/live")
|
||||
|
||||
server.sendEntry(t, logrus.InfoLevel, "no fields", nil)
|
||||
first := readLogEntry(t, conn)
|
||||
assert.Equal(t, "", first.Source)
|
||||
|
||||
server.sendEntry(t, logrus.InfoLevel, "empty map", logrus.Fields{})
|
||||
second := readLogEntry(t, conn)
|
||||
assert.Equal(t, "", second.Source)
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_SubscriberIDUniqueness(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
_ = server.dial(t, "/logs/live")
|
||||
_ = server.dial(t, "/logs/live")
|
||||
|
||||
waitForListenerCount(t, server.hook, 2)
|
||||
ids := server.subscriberIDs(t)
|
||||
require.Len(t, ids, 2)
|
||||
assert.NotEqual(t, ids[0], ids[1])
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_WithRealLogger(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
conn := server.dial(t, "/logs/live")
|
||||
|
||||
loggerEntry := logger.Log().WithField("source", "api")
|
||||
loggerEntry.Info("from logger")
|
||||
|
||||
received := readLogEntry(t, conn)
|
||||
assert.Equal(t, "from logger", received.Message)
|
||||
assert.Equal(t, "api", received.Source)
|
||||
}
|
||||
|
||||
func TestLogsWebSocketHandler_ConnectionLifecycle(t *testing.T) {
|
||||
server := newWebSocketTestServer(t)
|
||||
conn := server.dial(t, "/logs/live")
|
||||
|
||||
server.sendEntry(t, logrus.InfoLevel, "first", logrus.Fields{"source": "api"})
|
||||
first := readLogEntry(t, conn)
|
||||
assert.Equal(t, "first", first.Message)
|
||||
|
||||
require.NoError(t, conn.Close())
|
||||
waitForListenerCount(t, server.hook, 0)
|
||||
|
||||
// Ensure no panic when sending after disconnect
|
||||
server.sendEntry(t, logrus.InfoLevel, "after-close", logrus.Fields{"source": "api"})
|
||||
}
|
||||
100
backend/internal/api/handlers/logs_ws_test_utils.go
Normal file
100
backend/internal/api/handlers/logs_ws_test_utils.go
Normal file
@@ -0,0 +1,100 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/gorilla/websocket"
|
||||
"github.com/sirupsen/logrus"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/logger"
|
||||
)
|
||||
|
||||
// webSocketTestServer wraps a test HTTP server and broadcast hook for WebSocket tests.
|
||||
type webSocketTestServer struct {
|
||||
server *httptest.Server
|
||||
url string
|
||||
hook *logger.BroadcastHook
|
||||
}
|
||||
|
||||
// resetLogger reinitializes the global logger with an in-memory buffer to avoid cross-test leakage.
|
||||
func resetLogger(t *testing.T) *logger.BroadcastHook {
|
||||
t.Helper()
|
||||
var buf bytes.Buffer
|
||||
logger.Init(true, &buf)
|
||||
return logger.GetBroadcastHook()
|
||||
}
|
||||
|
||||
// newWebSocketTestServer builds a gin router exposing the WebSocket handler and starts an httptest server.
|
||||
func newWebSocketTestServer(t *testing.T) *webSocketTestServer {
|
||||
t.Helper()
|
||||
gin.SetMode(gin.TestMode)
|
||||
hook := resetLogger(t)
|
||||
|
||||
router := gin.New()
|
||||
router.GET("/logs/live", LogsWebSocketHandler)
|
||||
|
||||
srv := httptest.NewServer(router)
|
||||
t.Cleanup(srv.Close)
|
||||
|
||||
wsURL := "ws" + strings.TrimPrefix(srv.URL, "http")
|
||||
return &webSocketTestServer{server: srv, url: wsURL, hook: hook}
|
||||
}
|
||||
|
||||
// dial opens a WebSocket connection to the provided path and asserts upgrade success.
|
||||
func (s *webSocketTestServer) dial(t *testing.T, path string) *websocket.Conn {
|
||||
t.Helper()
|
||||
conn, resp, err := websocket.DefaultDialer.Dial(s.url+path, nil)
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, resp)
|
||||
require.Equal(t, http.StatusSwitchingProtocols, resp.StatusCode)
|
||||
t.Cleanup(func() {
|
||||
_ = resp.Body.Close()
|
||||
})
|
||||
conn.SetReadLimit(1 << 20)
|
||||
t.Cleanup(func() {
|
||||
_ = conn.Close()
|
||||
})
|
||||
return conn
|
||||
}
|
||||
|
||||
// sendEntry broadcasts a log entry through the shared hook.
|
||||
func (s *webSocketTestServer) sendEntry(t *testing.T, lvl logrus.Level, msg string, fields logrus.Fields) {
|
||||
t.Helper()
|
||||
entry := &logrus.Entry{
|
||||
Level: lvl,
|
||||
Message: msg,
|
||||
Time: time.Now().UTC(),
|
||||
Data: fields,
|
||||
}
|
||||
require.NoError(t, s.hook.Fire(entry))
|
||||
}
|
||||
|
||||
// readLogEntry reads a LogEntry from the WebSocket with a short deadline to avoid flakiness.
|
||||
func readLogEntry(t *testing.T, conn *websocket.Conn) LogEntry {
|
||||
t.Helper()
|
||||
require.NoError(t, conn.SetReadDeadline(time.Now().Add(5*time.Second)))
|
||||
var entry LogEntry
|
||||
require.NoError(t, conn.ReadJSON(&entry))
|
||||
return entry
|
||||
}
|
||||
|
||||
// waitForListenerCount waits until the broadcast hook reports the desired listener count.
|
||||
func waitForListenerCount(t *testing.T, hook *logger.BroadcastHook, expected int) {
|
||||
t.Helper()
|
||||
require.Eventually(t, func() bool {
|
||||
return hook.ActiveListeners() == expected
|
||||
}, 2*time.Second, 20*time.Millisecond)
|
||||
}
|
||||
|
||||
// subscriberIDs introspects the broadcast hook to return the active subscriber IDs.
|
||||
func (s *webSocketTestServer) subscriberIDs(t *testing.T) []string {
|
||||
t.Helper()
|
||||
return s.hook.ListenerIDs()
|
||||
}
|
||||
@@ -84,7 +84,7 @@ func TestPerf_GetStatus_AssertThreshold(t *testing.T) {
|
||||
db := setupPerfDB(t)
|
||||
|
||||
// seed settings to emulate production path
|
||||
_ = db.Create(&models.Setting{Key: "security.cerberus.enabled", Value: "true", Category: "security"})
|
||||
_ = db.Create(&models.Setting{Key: "feature.cerberus.enabled", Value: "true", Category: "feature"})
|
||||
_ = db.Create(&models.Setting{Key: "security.waf.enabled", Value: "true", Category: "security"})
|
||||
cfg := config.SecurityConfig{CerberusEnabled: true}
|
||||
h := NewSecurityHandler(cfg, db, nil)
|
||||
|
||||
@@ -25,6 +25,22 @@ type ProxyHostHandler struct {
|
||||
uptimeService *services.UptimeService
|
||||
}
|
||||
|
||||
// safeIntToUint safely converts int to uint, returning false if negative (gosec G115)
|
||||
func safeIntToUint(i int) (uint, bool) {
|
||||
if i < 0 {
|
||||
return 0, false
|
||||
}
|
||||
return uint(i), true
|
||||
}
|
||||
|
||||
// safeFloat64ToUint safely converts float64 to uint, returning false if invalid (gosec G115)
|
||||
func safeFloat64ToUint(f float64) (uint, bool) {
|
||||
if f < 0 || f != float64(uint(f)) {
|
||||
return 0, false
|
||||
}
|
||||
return uint(f), true
|
||||
}
|
||||
|
||||
// NewProxyHostHandler creates a new proxy host handler.
|
||||
func NewProxyHostHandler(db *gorm.DB, caddyManager *caddy.Manager, ns *services.NotificationService, uptimeService *services.UptimeService) *ProxyHostHandler {
|
||||
return &ProxyHostHandler{
|
||||
@@ -210,11 +226,13 @@ func (h *ProxyHostHandler) Update(c *gin.Context) {
|
||||
} else {
|
||||
switch t := v.(type) {
|
||||
case float64:
|
||||
id := uint(t)
|
||||
host.CertificateID = &id
|
||||
if id, ok := safeFloat64ToUint(t); ok {
|
||||
host.CertificateID = &id
|
||||
}
|
||||
case int:
|
||||
id := uint(t)
|
||||
host.CertificateID = &id
|
||||
if id, ok := safeIntToUint(t); ok {
|
||||
host.CertificateID = &id
|
||||
}
|
||||
case string:
|
||||
if n, err := strconv.ParseUint(t, 10, 32); err == nil {
|
||||
id := uint(n)
|
||||
@@ -229,11 +247,13 @@ func (h *ProxyHostHandler) Update(c *gin.Context) {
|
||||
} else {
|
||||
switch t := v.(type) {
|
||||
case float64:
|
||||
id := uint(t)
|
||||
host.AccessListID = &id
|
||||
if id, ok := safeFloat64ToUint(t); ok {
|
||||
host.AccessListID = &id
|
||||
}
|
||||
case int:
|
||||
id := uint(t)
|
||||
host.AccessListID = &id
|
||||
if id, ok := safeIntToUint(t); ok {
|
||||
host.AccessListID = &id
|
||||
}
|
||||
case string:
|
||||
if n, err := strconv.ParseUint(t, 10, 32); err == nil {
|
||||
id := uint(n)
|
||||
|
||||
122
backend/internal/api/handlers/security_geoip_endpoints_test.go
Normal file
122
backend/internal/api/handlers/security_geoip_endpoints_test.go
Normal file
@@ -0,0 +1,122 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/config"
|
||||
"github.com/Wikid82/charon/backend/internal/services"
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestSecurityHandler_GetGeoIPStatus_NotInitialized(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
h := NewSecurityHandler(config.SecurityConfig{}, nil, nil)
|
||||
r := gin.New()
|
||||
r.GET("/security/geoip/status", h.GetGeoIPStatus)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodGet, "/security/geoip/status", http.NoBody)
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
assert.Equal(t, http.StatusOK, w.Code)
|
||||
|
||||
var body map[string]any
|
||||
require.NoError(t, json.Unmarshal(w.Body.Bytes(), &body))
|
||||
assert.Equal(t, false, body["loaded"])
|
||||
assert.Equal(t, "GeoIP service not initialized", body["message"])
|
||||
}
|
||||
|
||||
func TestSecurityHandler_GetGeoIPStatus_Initialized_NotLoaded(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
h := NewSecurityHandler(config.SecurityConfig{}, nil, nil)
|
||||
h.SetGeoIPService(&services.GeoIPService{})
|
||||
|
||||
r := gin.New()
|
||||
r.GET("/security/geoip/status", h.GetGeoIPStatus)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodGet, "/security/geoip/status", http.NoBody)
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
assert.Equal(t, http.StatusOK, w.Code)
|
||||
|
||||
var body map[string]any
|
||||
require.NoError(t, json.Unmarshal(w.Body.Bytes(), &body))
|
||||
assert.Equal(t, false, body["loaded"])
|
||||
assert.Equal(t, "GeoIP service available", body["message"])
|
||||
}
|
||||
|
||||
func TestSecurityHandler_ReloadGeoIP_NotInitialized(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
h := NewSecurityHandler(config.SecurityConfig{}, nil, nil)
|
||||
r := gin.New()
|
||||
r.POST("/security/geoip/reload", h.ReloadGeoIP)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/security/geoip/reload", http.NoBody)
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
assert.Equal(t, http.StatusServiceUnavailable, w.Code)
|
||||
}
|
||||
|
||||
func TestSecurityHandler_ReloadGeoIP_LoadError(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
h := NewSecurityHandler(config.SecurityConfig{}, nil, nil)
|
||||
h.SetGeoIPService(&services.GeoIPService{}) // dbPath empty => Load() will error
|
||||
|
||||
r := gin.New()
|
||||
r.POST("/security/geoip/reload", h.ReloadGeoIP)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/security/geoip/reload", http.NoBody)
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
assert.Equal(t, http.StatusInternalServerError, w.Code)
|
||||
assert.Contains(t, w.Body.String(), "Failed to reload GeoIP database")
|
||||
}
|
||||
|
||||
func TestSecurityHandler_LookupGeoIP_MissingIPAddress(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
h := NewSecurityHandler(config.SecurityConfig{}, nil, nil)
|
||||
r := gin.New()
|
||||
r.POST("/security/geoip/lookup", h.LookupGeoIP)
|
||||
|
||||
payload := []byte(`{}`)
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/security/geoip/lookup", bytes.NewReader(payload))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
assert.Equal(t, http.StatusBadRequest, w.Code)
|
||||
assert.Contains(t, w.Body.String(), "ip_address is required")
|
||||
}
|
||||
|
||||
func TestSecurityHandler_LookupGeoIP_ServiceUnavailable(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
h := NewSecurityHandler(config.SecurityConfig{}, nil, nil)
|
||||
h.SetGeoIPService(&services.GeoIPService{}) // present but not loaded
|
||||
|
||||
r := gin.New()
|
||||
r.POST("/security/geoip/lookup", h.LookupGeoIP)
|
||||
|
||||
payload, _ := json.Marshal(map[string]string{"ip_address": "8.8.8.8"})
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/security/geoip/lookup", bytes.NewReader(payload))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
assert.Equal(t, http.StatusServiceUnavailable, w.Code)
|
||||
assert.Contains(t, w.Body.String(), "GeoIP service not available")
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"net"
|
||||
"net/http"
|
||||
@@ -17,12 +18,27 @@ import (
|
||||
"github.com/Wikid82/charon/backend/internal/services"
|
||||
)
|
||||
|
||||
// WAFExclusionRequest represents a rule exclusion for false positives
|
||||
type WAFExclusionRequest struct {
|
||||
RuleID int `json:"rule_id" binding:"required"`
|
||||
Target string `json:"target,omitempty"` // e.g., "ARGS:password"
|
||||
Description string `json:"description,omitempty"` // Human-readable reason
|
||||
}
|
||||
|
||||
// WAFExclusion represents a stored rule exclusion
|
||||
type WAFExclusion struct {
|
||||
RuleID int `json:"rule_id"`
|
||||
Target string `json:"target,omitempty"`
|
||||
Description string `json:"description,omitempty"`
|
||||
}
|
||||
|
||||
// SecurityHandler handles security-related API requests.
|
||||
type SecurityHandler struct {
|
||||
cfg config.SecurityConfig
|
||||
db *gorm.DB
|
||||
svc *services.SecurityService
|
||||
caddyManager *caddy.Manager
|
||||
geoipSvc *services.GeoIPService
|
||||
}
|
||||
|
||||
// NewSecurityHandler creates a new SecurityHandler.
|
||||
@@ -31,121 +47,130 @@ func NewSecurityHandler(cfg config.SecurityConfig, db *gorm.DB, caddyManager *ca
|
||||
return &SecurityHandler{cfg: cfg, db: db, svc: svc, caddyManager: caddyManager}
|
||||
}
|
||||
|
||||
// SetGeoIPService sets the GeoIP service for the handler.
|
||||
func (h *SecurityHandler) SetGeoIPService(geoipSvc *services.GeoIPService) {
|
||||
h.geoipSvc = geoipSvc
|
||||
}
|
||||
|
||||
// GetStatus returns the current status of all security services.
|
||||
// Priority chain:
|
||||
// 1. Settings table (highest - runtime overrides)
|
||||
// 2. SecurityConfig DB record (middle - user configuration)
|
||||
// 3. Static config (lowest - defaults)
|
||||
func (h *SecurityHandler) GetStatus(c *gin.Context) {
|
||||
// Start with static config defaults
|
||||
enabled := h.cfg.CerberusEnabled
|
||||
// Check runtime setting override
|
||||
var settingKey = "security.cerberus.enabled"
|
||||
if h.db != nil {
|
||||
var setting struct{ Value string }
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", settingKey).Scan(&setting).Error; err == nil && setting.Value != "" {
|
||||
if strings.EqualFold(setting.Value, "true") {
|
||||
enabled = true
|
||||
} else {
|
||||
enabled = false
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Allow runtime overrides for CrowdSec mode + API URL via settings table
|
||||
mode := h.cfg.CrowdSecMode
|
||||
apiURL := h.cfg.CrowdSecAPIURL
|
||||
if h.db != nil {
|
||||
var m struct{ Value string }
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", "security.crowdsec.mode").Scan(&m).Error; err == nil && m.Value != "" {
|
||||
mode = m.Value
|
||||
}
|
||||
var a struct{ Value string }
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", "security.crowdsec.api_url").Scan(&a).Error; err == nil && a.Value != "" {
|
||||
apiURL = a.Value
|
||||
}
|
||||
}
|
||||
|
||||
// Allow runtime override for CrowdSec enabled flag via settings table
|
||||
crowdsecEnabled := mode == "local"
|
||||
if h.db != nil {
|
||||
var cs struct{ Value string }
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", "security.crowdsec.enabled").Scan(&cs).Error; err == nil && cs.Value != "" {
|
||||
if strings.EqualFold(cs.Value, "true") {
|
||||
crowdsecEnabled = true
|
||||
// If enabled via settings and mode is not local, set mode to local
|
||||
if mode != "local" {
|
||||
mode = "local"
|
||||
}
|
||||
} else if strings.EqualFold(cs.Value, "false") {
|
||||
crowdsecEnabled = false
|
||||
mode = "disabled"
|
||||
apiURL = ""
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Only allow 'local' as an enabled mode. Any other value should be treated as disabled.
|
||||
if mode != "local" {
|
||||
mode = "disabled"
|
||||
apiURL = ""
|
||||
}
|
||||
|
||||
// Allow runtime override for WAF enabled flag via settings table
|
||||
wafEnabled := h.cfg.WAFMode != "" && h.cfg.WAFMode != "disabled"
|
||||
wafMode := h.cfg.WAFMode
|
||||
rateLimitMode := h.cfg.RateLimitMode
|
||||
crowdSecMode := h.cfg.CrowdSecMode
|
||||
crowdSecAPIURL := h.cfg.CrowdSecAPIURL
|
||||
aclMode := h.cfg.ACLMode
|
||||
|
||||
// Override with database SecurityConfig if present (priority 2)
|
||||
if h.db != nil {
|
||||
var w struct{ Value string }
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", "security.waf.enabled").Scan(&w).Error; err == nil && w.Value != "" {
|
||||
if strings.EqualFold(w.Value, "true") {
|
||||
wafEnabled = true
|
||||
if wafMode == "" || wafMode == "disabled" {
|
||||
wafMode = "enabled"
|
||||
}
|
||||
} else if strings.EqualFold(w.Value, "false") {
|
||||
wafEnabled = false
|
||||
var sc models.SecurityConfig
|
||||
if err := h.db.Where("name = ?", "default").First(&sc).Error; err == nil {
|
||||
// SecurityConfig in DB takes precedence over static config
|
||||
enabled = sc.Enabled
|
||||
if sc.WAFMode != "" {
|
||||
wafMode = sc.WAFMode
|
||||
}
|
||||
if sc.RateLimitMode != "" {
|
||||
rateLimitMode = sc.RateLimitMode
|
||||
} else if sc.RateLimitEnable {
|
||||
rateLimitMode = "enabled"
|
||||
}
|
||||
if sc.CrowdSecMode != "" {
|
||||
crowdSecMode = sc.CrowdSecMode
|
||||
}
|
||||
if sc.CrowdSecAPIURL != "" {
|
||||
crowdSecAPIURL = sc.CrowdSecAPIURL
|
||||
}
|
||||
}
|
||||
|
||||
// Check runtime setting overrides from settings table (priority 1 - highest)
|
||||
var setting struct{ Value string }
|
||||
|
||||
// Cerberus enabled override
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", "feature.cerberus.enabled").Scan(&setting).Error; err == nil && setting.Value != "" {
|
||||
enabled = strings.EqualFold(setting.Value, "true")
|
||||
}
|
||||
|
||||
// WAF enabled override
|
||||
setting = struct{ Value string }{}
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", "security.waf.enabled").Scan(&setting).Error; err == nil && setting.Value != "" {
|
||||
if strings.EqualFold(setting.Value, "true") {
|
||||
wafMode = "enabled"
|
||||
} else {
|
||||
wafMode = "disabled"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Allow runtime override for Rate Limit enabled flag via settings table
|
||||
rateLimitEnabled := h.cfg.RateLimitMode == "enabled"
|
||||
rateLimitMode := h.cfg.RateLimitMode
|
||||
if h.db != nil {
|
||||
var rl struct{ Value string }
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", "security.rate_limit.enabled").Scan(&rl).Error; err == nil && rl.Value != "" {
|
||||
if strings.EqualFold(rl.Value, "true") {
|
||||
rateLimitEnabled = true
|
||||
if rateLimitMode == "" || rateLimitMode == "disabled" {
|
||||
rateLimitMode = "enabled"
|
||||
}
|
||||
} else if strings.EqualFold(rl.Value, "false") {
|
||||
rateLimitEnabled = false
|
||||
// Rate Limit enabled override
|
||||
setting = struct{ Value string }{}
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", "security.rate_limit.enabled").Scan(&setting).Error; err == nil && setting.Value != "" {
|
||||
if strings.EqualFold(setting.Value, "true") {
|
||||
rateLimitMode = "enabled"
|
||||
} else {
|
||||
rateLimitMode = "disabled"
|
||||
}
|
||||
}
|
||||
|
||||
// CrowdSec enabled override
|
||||
setting = struct{ Value string }{}
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", "security.crowdsec.enabled").Scan(&setting).Error; err == nil && setting.Value != "" {
|
||||
if strings.EqualFold(setting.Value, "true") {
|
||||
crowdSecMode = "local"
|
||||
} else {
|
||||
crowdSecMode = "disabled"
|
||||
}
|
||||
}
|
||||
|
||||
// CrowdSec mode override
|
||||
setting = struct{ Value string }{}
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", "security.crowdsec.mode").Scan(&setting).Error; err == nil && setting.Value != "" {
|
||||
crowdSecMode = setting.Value
|
||||
}
|
||||
|
||||
// ACL enabled override
|
||||
setting = struct{ Value string }{}
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", "security.acl.enabled").Scan(&setting).Error; err == nil && setting.Value != "" {
|
||||
if strings.EqualFold(setting.Value, "true") {
|
||||
aclMode = "enabled"
|
||||
} else {
|
||||
aclMode = "disabled"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Allow runtime override for ACL enabled flag via settings table
|
||||
aclEnabled := h.cfg.ACLMode == "enabled"
|
||||
aclEffective := aclEnabled && enabled
|
||||
if h.db != nil {
|
||||
var a struct{ Value string }
|
||||
if err := h.db.Raw("SELECT value FROM settings WHERE key = ? LIMIT 1", "security.acl.enabled").Scan(&a).Error; err == nil && a.Value != "" {
|
||||
if strings.EqualFold(a.Value, "true") {
|
||||
aclEnabled = true
|
||||
} else if strings.EqualFold(a.Value, "false") {
|
||||
aclEnabled = false
|
||||
}
|
||||
// Map unknown/external mode to disabled
|
||||
if crowdSecMode != "local" && crowdSecMode != "disabled" {
|
||||
crowdSecMode = "disabled"
|
||||
}
|
||||
|
||||
// If Cerberus is disabled, ACL should not be considered enabled even
|
||||
// if the ACL setting is true. This keeps ACL tied to the Cerberus
|
||||
// suite state in the UI and APIs.
|
||||
aclEffective = aclEnabled && enabled
|
||||
}
|
||||
// Compute effective enabled state for each feature
|
||||
wafEnabled := wafMode != "" && wafMode != "disabled"
|
||||
rateLimitEnabled := rateLimitMode == "enabled"
|
||||
crowdsecEnabled := crowdSecMode == "local"
|
||||
aclEnabled := aclMode == "enabled"
|
||||
|
||||
// All features require Cerberus to be enabled
|
||||
if !enabled {
|
||||
wafEnabled = false
|
||||
rateLimitEnabled = false
|
||||
crowdsecEnabled = false
|
||||
aclEnabled = false
|
||||
wafMode = "disabled"
|
||||
rateLimitMode = "disabled"
|
||||
crowdSecMode = "disabled"
|
||||
aclMode = "disabled"
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"cerberus": gin.H{"enabled": enabled},
|
||||
"crowdsec": gin.H{
|
||||
"mode": mode,
|
||||
"api_url": apiURL,
|
||||
"mode": crowdSecMode,
|
||||
"api_url": crowdSecAPIURL,
|
||||
"enabled": crowdsecEnabled,
|
||||
},
|
||||
"waf": gin.H{
|
||||
@@ -157,8 +182,8 @@ func (h *SecurityHandler) GetStatus(c *gin.Context) {
|
||||
"enabled": rateLimitEnabled,
|
||||
},
|
||||
"acl": gin.H{
|
||||
"mode": h.cfg.ACLMode,
|
||||
"enabled": aclEffective,
|
||||
"mode": aclMode,
|
||||
"enabled": aclEnabled,
|
||||
},
|
||||
})
|
||||
}
|
||||
@@ -187,6 +212,12 @@ func (h *SecurityHandler) UpdateConfig(c *gin.Context) {
|
||||
if payload.Name == "" {
|
||||
payload.Name = "default"
|
||||
}
|
||||
// Sync RateLimitMode with RateLimitEnable for backward compatibility
|
||||
if payload.RateLimitEnable {
|
||||
payload.RateLimitMode = "enabled"
|
||||
} else if payload.RateLimitMode == "" {
|
||||
payload.RateLimitMode = "disabled"
|
||||
}
|
||||
if err := h.svc.Upsert(&payload); err != nil {
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
|
||||
return
|
||||
@@ -443,3 +474,323 @@ func (h *SecurityHandler) Disable(c *gin.Context) {
|
||||
}
|
||||
c.JSON(http.StatusOK, gin.H{"enabled": false})
|
||||
}
|
||||
|
||||
// GetRateLimitPresets returns predefined rate limit configurations
|
||||
func (h *SecurityHandler) GetRateLimitPresets(c *gin.Context) {
|
||||
presets := []map[string]interface{}{
|
||||
{
|
||||
"id": "standard",
|
||||
"name": "Standard Web",
|
||||
"description": "Balanced protection for general web applications",
|
||||
"requests": 100,
|
||||
"window_sec": 60,
|
||||
"burst": 20,
|
||||
},
|
||||
{
|
||||
"id": "api",
|
||||
"name": "API Protection",
|
||||
"description": "Stricter limits for API endpoints",
|
||||
"requests": 30,
|
||||
"window_sec": 60,
|
||||
"burst": 10,
|
||||
},
|
||||
{
|
||||
"id": "login",
|
||||
"name": "Login Protection",
|
||||
"description": "Aggressive protection against brute-force",
|
||||
"requests": 5,
|
||||
"window_sec": 300,
|
||||
"burst": 2,
|
||||
},
|
||||
{
|
||||
"id": "relaxed",
|
||||
"name": "High Traffic",
|
||||
"description": "Higher limits for trusted, high-traffic apps",
|
||||
"requests": 500,
|
||||
"window_sec": 60,
|
||||
"burst": 100,
|
||||
},
|
||||
}
|
||||
c.JSON(http.StatusOK, gin.H{"presets": presets})
|
||||
}
|
||||
|
||||
// GetGeoIPStatus returns the current status of the GeoIP service.
|
||||
func (h *SecurityHandler) GetGeoIPStatus(c *gin.Context) {
|
||||
if h.geoipSvc == nil {
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"loaded": false,
|
||||
"message": "GeoIP service not initialized",
|
||||
"db_path": "",
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"loaded": h.geoipSvc.IsLoaded(),
|
||||
"db_path": h.geoipSvc.GetDatabasePath(),
|
||||
"message": "GeoIP service available",
|
||||
})
|
||||
}
|
||||
|
||||
// ReloadGeoIP reloads the GeoIP database from disk.
|
||||
func (h *SecurityHandler) ReloadGeoIP(c *gin.Context) {
|
||||
if h.geoipSvc == nil {
|
||||
c.JSON(http.StatusServiceUnavailable, gin.H{
|
||||
"error": "GeoIP service not initialized",
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
if err := h.geoipSvc.Load(); err != nil {
|
||||
log.WithError(err).Error("Failed to reload GeoIP database")
|
||||
c.JSON(http.StatusInternalServerError, gin.H{
|
||||
"error": "Failed to reload GeoIP database: " + err.Error(),
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
// Log audit event
|
||||
actor := c.GetString("user_id")
|
||||
if actor == "" {
|
||||
actor = c.ClientIP()
|
||||
}
|
||||
_ = h.svc.LogAudit(&models.SecurityAudit{Actor: actor, Action: "reload_geoip", Details: "GeoIP database reloaded successfully"})
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"message": "GeoIP database reloaded successfully",
|
||||
"loaded": h.geoipSvc.IsLoaded(),
|
||||
"db_path": h.geoipSvc.GetDatabasePath(),
|
||||
})
|
||||
}
|
||||
|
||||
// LookupGeoIP performs a GeoIP lookup for a given IP address.
|
||||
func (h *SecurityHandler) LookupGeoIP(c *gin.Context) {
|
||||
var req struct {
|
||||
IPAddress string `json:"ip_address" binding:"required"`
|
||||
}
|
||||
if err := c.ShouldBindJSON(&req); err != nil {
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": "ip_address is required"})
|
||||
return
|
||||
}
|
||||
|
||||
if h.geoipSvc == nil || !h.geoipSvc.IsLoaded() {
|
||||
c.JSON(http.StatusServiceUnavailable, gin.H{
|
||||
"error": "GeoIP service not available",
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
country, err := h.geoipSvc.LookupCountry(req.IPAddress)
|
||||
if err != nil {
|
||||
if errors.Is(err, services.ErrInvalidGeoIP) {
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid IP address"})
|
||||
return
|
||||
}
|
||||
if errors.Is(err, services.ErrCountryNotFound) {
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"ip_address": req.IPAddress,
|
||||
"country_code": "",
|
||||
"found": false,
|
||||
"message": "No country found for this IP address",
|
||||
})
|
||||
return
|
||||
}
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "GeoIP lookup failed: " + err.Error()})
|
||||
return
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"ip_address": req.IPAddress,
|
||||
"country_code": country,
|
||||
"found": true,
|
||||
})
|
||||
}
|
||||
|
||||
// GetWAFExclusions returns current WAF rule exclusions from SecurityConfig
|
||||
func (h *SecurityHandler) GetWAFExclusions(c *gin.Context) {
|
||||
cfg, err := h.svc.Get()
|
||||
if err != nil {
|
||||
if err == services.ErrSecurityConfigNotFound {
|
||||
c.JSON(http.StatusOK, gin.H{"exclusions": []WAFExclusion{}})
|
||||
return
|
||||
}
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to read security config"})
|
||||
return
|
||||
}
|
||||
|
||||
var exclusions []WAFExclusion
|
||||
if cfg.WAFExclusions != "" {
|
||||
if err := json.Unmarshal([]byte(cfg.WAFExclusions), &exclusions); err != nil {
|
||||
log.WithError(err).Warn("Failed to parse WAF exclusions")
|
||||
exclusions = []WAFExclusion{}
|
||||
}
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{"exclusions": exclusions})
|
||||
}
|
||||
|
||||
// AddWAFExclusion adds a rule exclusion to the WAF configuration
|
||||
func (h *SecurityHandler) AddWAFExclusion(c *gin.Context) {
|
||||
var req WAFExclusionRequest
|
||||
if err := c.ShouldBindJSON(&req); err != nil {
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": "rule_id is required"})
|
||||
return
|
||||
}
|
||||
|
||||
if req.RuleID <= 0 {
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": "rule_id must be a positive integer"})
|
||||
return
|
||||
}
|
||||
|
||||
cfg, err := h.svc.Get()
|
||||
if err != nil {
|
||||
if err == services.ErrSecurityConfigNotFound {
|
||||
// Create default config with the exclusion
|
||||
cfg = &models.SecurityConfig{Name: "default"}
|
||||
} else {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to read security config"})
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// Parse existing exclusions
|
||||
var exclusions []WAFExclusion
|
||||
if cfg.WAFExclusions != "" {
|
||||
if err := json.Unmarshal([]byte(cfg.WAFExclusions), &exclusions); err != nil {
|
||||
log.WithError(err).Warn("Failed to parse existing WAF exclusions")
|
||||
exclusions = []WAFExclusion{}
|
||||
}
|
||||
}
|
||||
|
||||
// Check for duplicate rule_id with same target
|
||||
for _, e := range exclusions {
|
||||
if e.RuleID == req.RuleID && e.Target == req.Target {
|
||||
c.JSON(http.StatusConflict, gin.H{"error": "exclusion for this rule_id and target already exists"})
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// Add the new exclusion - convert request to WAFExclusion type
|
||||
newExclusion := WAFExclusion(req)
|
||||
exclusions = append(exclusions, newExclusion)
|
||||
|
||||
// Marshal back to JSON
|
||||
exclusionsJSON, err := json.Marshal(exclusions)
|
||||
if err != nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to serialize exclusions"})
|
||||
return
|
||||
}
|
||||
|
||||
cfg.WAFExclusions = string(exclusionsJSON)
|
||||
if err := h.svc.Upsert(cfg); err != nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to save exclusion"})
|
||||
return
|
||||
}
|
||||
|
||||
// Apply updated config to Caddy
|
||||
if h.caddyManager != nil {
|
||||
if err := h.caddyManager.ApplyConfig(c.Request.Context()); err != nil {
|
||||
log.WithError(err).Warn("failed to apply WAF exclusion changes to Caddy")
|
||||
}
|
||||
}
|
||||
|
||||
// Log audit event
|
||||
actor := c.GetString("user_id")
|
||||
if actor == "" {
|
||||
actor = c.ClientIP()
|
||||
}
|
||||
_ = h.svc.LogAudit(&models.SecurityAudit{
|
||||
Actor: actor,
|
||||
Action: "add_waf_exclusion",
|
||||
Details: strconv.Itoa(req.RuleID),
|
||||
})
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{"exclusion": newExclusion})
|
||||
}
|
||||
|
||||
// DeleteWAFExclusion removes a rule exclusion by rule_id
|
||||
func (h *SecurityHandler) DeleteWAFExclusion(c *gin.Context) {
|
||||
ruleIDParam := c.Param("rule_id")
|
||||
if ruleIDParam == "" {
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": "rule_id is required"})
|
||||
return
|
||||
}
|
||||
|
||||
ruleID, err := strconv.Atoi(ruleIDParam)
|
||||
if err != nil || ruleID <= 0 {
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": "invalid rule_id"})
|
||||
return
|
||||
}
|
||||
|
||||
// Get optional target query parameter (for exclusions with specific targets)
|
||||
target := c.Query("target")
|
||||
|
||||
cfg, err := h.svc.Get()
|
||||
if err != nil {
|
||||
if err == services.ErrSecurityConfigNotFound {
|
||||
c.JSON(http.StatusNotFound, gin.H{"error": "exclusion not found"})
|
||||
return
|
||||
}
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to read security config"})
|
||||
return
|
||||
}
|
||||
|
||||
// Parse existing exclusions
|
||||
var exclusions []WAFExclusion
|
||||
if cfg.WAFExclusions != "" {
|
||||
if err := json.Unmarshal([]byte(cfg.WAFExclusions), &exclusions); err != nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to parse exclusions"})
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// Find and remove the exclusion
|
||||
found := false
|
||||
newExclusions := make([]WAFExclusion, 0, len(exclusions))
|
||||
for _, e := range exclusions {
|
||||
// Match by rule_id and target (empty target matches exclusions without target)
|
||||
if e.RuleID == ruleID && e.Target == target {
|
||||
found = true
|
||||
continue // Skip this one (delete it)
|
||||
}
|
||||
newExclusions = append(newExclusions, e)
|
||||
}
|
||||
|
||||
if !found {
|
||||
c.JSON(http.StatusNotFound, gin.H{"error": "exclusion not found"})
|
||||
return
|
||||
}
|
||||
|
||||
// Marshal back to JSON
|
||||
exclusionsJSON, err := json.Marshal(newExclusions)
|
||||
if err != nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to serialize exclusions"})
|
||||
return
|
||||
}
|
||||
|
||||
cfg.WAFExclusions = string(exclusionsJSON)
|
||||
if err := h.svc.Upsert(cfg); err != nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to save exclusions"})
|
||||
return
|
||||
}
|
||||
|
||||
// Apply updated config to Caddy
|
||||
if h.caddyManager != nil {
|
||||
if err := h.caddyManager.ApplyConfig(c.Request.Context()); err != nil {
|
||||
log.WithError(err).Warn("failed to apply WAF exclusion changes to Caddy")
|
||||
}
|
||||
}
|
||||
|
||||
// Log audit event
|
||||
actor := c.GetString("user_id")
|
||||
if actor == "" {
|
||||
actor = c.ClientIP()
|
||||
}
|
||||
_ = h.svc.LogAudit(&models.SecurityAudit{
|
||||
Actor: actor,
|
||||
Action: "delete_waf_exclusion",
|
||||
Details: ruleIDParam,
|
||||
})
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{"deleted": true})
|
||||
}
|
||||
|
||||
@@ -223,25 +223,35 @@ func TestSecurityHandler_GetStatus_SettingsOverride(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
db := setupAuditTestDB(t)
|
||||
|
||||
// Seed settings that should override config defaults
|
||||
// Create SecurityConfig with all security features enabled (DB priority)
|
||||
secCfg := &models.SecurityConfig{
|
||||
Name: "default", // Required - GetStatus looks for name='default'
|
||||
Enabled: true,
|
||||
WAFMode: "block", // "block" mode enables WAF
|
||||
RateLimitMode: "enabled",
|
||||
CrowdSecMode: "local", // "local" mode enables CrowdSec
|
||||
RateLimitEnable: true,
|
||||
}
|
||||
require.NoError(t, db.Create(secCfg).Error)
|
||||
|
||||
// Seed settings (these won't override DB SecurityConfig for WAF/Rate Limit/CrowdSec)
|
||||
settings := []models.Setting{
|
||||
{Key: "security.cerberus.enabled", Value: "true", Category: "security"},
|
||||
{Key: "feature.cerberus.enabled", Value: "true", Category: "feature"},
|
||||
{Key: "security.waf.enabled", Value: "true", Category: "security"},
|
||||
{Key: "security.rate_limit.enabled", Value: "true", Category: "security"},
|
||||
{Key: "security.crowdsec.enabled", Value: "true", Category: "security"},
|
||||
{Key: "security.acl.enabled", Value: "true", Category: "security"},
|
||||
}
|
||||
for _, s := range settings {
|
||||
require.NoError(t, db.Create(&s).Error)
|
||||
}
|
||||
|
||||
// Config has everything disabled
|
||||
// Static config has everything disabled (lowest priority)
|
||||
cfg := config.SecurityConfig{
|
||||
CerberusEnabled: false,
|
||||
WAFMode: "disabled",
|
||||
RateLimitMode: "disabled",
|
||||
CrowdSecMode: "disabled",
|
||||
ACLMode: "disabled",
|
||||
ACLMode: "enabled", // ACL comes from static config only
|
||||
}
|
||||
h := NewSecurityHandler(cfg, db, nil)
|
||||
|
||||
@@ -258,12 +268,13 @@ func TestSecurityHandler_GetStatus_SettingsOverride(t *testing.T) {
|
||||
err := json.Unmarshal(w.Body.Bytes(), &resp)
|
||||
require.NoError(t, err)
|
||||
|
||||
// Verify settings override config
|
||||
assert.True(t, resp["cerberus"]["enabled"].(bool), "cerberus should be enabled via settings")
|
||||
assert.True(t, resp["waf"]["enabled"].(bool), "waf should be enabled via settings")
|
||||
assert.True(t, resp["rate_limit"]["enabled"].(bool), "rate_limit should be enabled via settings")
|
||||
assert.True(t, resp["crowdsec"]["enabled"].(bool), "crowdsec should be enabled via settings")
|
||||
assert.True(t, resp["acl"]["enabled"].(bool), "acl should be enabled via settings")
|
||||
// Verify DB config is used (highest priority) for SecurityConfig features
|
||||
assert.True(t, resp["cerberus"]["enabled"].(bool), "cerberus should be enabled via DB config")
|
||||
assert.True(t, resp["waf"]["enabled"].(bool), "waf should be enabled via DB config")
|
||||
assert.True(t, resp["rate_limit"]["enabled"].(bool), "rate_limit should be enabled via DB config")
|
||||
assert.True(t, resp["crowdsec"]["enabled"].(bool), "crowdsec should be enabled via DB config")
|
||||
// ACL comes from static config only (not in SecurityConfig model)
|
||||
assert.True(t, resp["acl"]["enabled"].(bool), "acl should be enabled via static config")
|
||||
}
|
||||
|
||||
func TestSecurityHandler_GetStatus_DisabledViaSettings(t *testing.T) {
|
||||
@@ -272,7 +283,7 @@ func TestSecurityHandler_GetStatus_DisabledViaSettings(t *testing.T) {
|
||||
|
||||
// Seed settings that disable everything
|
||||
settings := []models.Setting{
|
||||
{Key: "security.cerberus.enabled", Value: "false", Category: "security"},
|
||||
{Key: "feature.cerberus.enabled", Value: "false", Category: "feature"},
|
||||
{Key: "security.waf.enabled", Value: "false", Category: "security"},
|
||||
{Key: "security.rate_limit.enabled", Value: "false", Category: "security"},
|
||||
{Key: "security.crowdsec.enabled", Value: "false", Category: "security"},
|
||||
|
||||
@@ -62,7 +62,7 @@ func TestSecurityHandler_Cerberus_DBOverride(t *testing.T) {
|
||||
|
||||
db := setupTestDB(t)
|
||||
// set DB to enable cerberus
|
||||
if err := db.Create(&models.Setting{Key: "security.cerberus.enabled", Value: "true"}).Error; err != nil {
|
||||
if err := db.Create(&models.Setting{Key: "feature.cerberus.enabled", Value: "true"}).Error; err != nil {
|
||||
t.Fatalf("failed to insert setting: %v", err)
|
||||
}
|
||||
|
||||
@@ -146,7 +146,7 @@ func TestSecurityHandler_ACL_DisabledWhenCerberusOff(t *testing.T) {
|
||||
if err := db.Create(&models.Setting{Key: "security.acl.enabled", Value: "true"}).Error; err != nil {
|
||||
t.Fatalf("failed to insert setting: %v", err)
|
||||
}
|
||||
if err := db.Create(&models.Setting{Key: "security.cerberus.enabled", Value: "false"}).Error; err != nil {
|
||||
if err := db.Create(&models.Setting{Key: "feature.cerberus.enabled", Value: "false"}).Error; err != nil {
|
||||
t.Fatalf("failed to insert setting: %v", err)
|
||||
}
|
||||
|
||||
@@ -179,7 +179,7 @@ func TestSecurityHandler_CrowdSec_Mode_DBOverride(t *testing.T) {
|
||||
t.Fatalf("failed to insert setting: %v", err)
|
||||
}
|
||||
|
||||
cfg := config.SecurityConfig{CrowdSecMode: "disabled"}
|
||||
cfg := config.SecurityConfig{CerberusEnabled: true, CrowdSecMode: "disabled"}
|
||||
handler := NewSecurityHandler(cfg, db, nil)
|
||||
router := gin.New()
|
||||
router.GET("/security/status", handler.GetStatus)
|
||||
|
||||
112
backend/internal/api/handlers/security_handler_fixed_test.go
Normal file
112
backend/internal/api/handlers/security_handler_fixed_test.go
Normal file
@@ -0,0 +1,112 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/stretchr/testify/assert"
|
||||
|
||||
"github.com/Wikid82/charon/backend/internal/config"
|
||||
)
|
||||
|
||||
func TestSecurityHandler_GetStatus_Fixed(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
cfg config.SecurityConfig
|
||||
expectedStatus int
|
||||
expectedBody map[string]interface{}
|
||||
}{
|
||||
{
|
||||
name: "All Disabled",
|
||||
cfg: config.SecurityConfig{
|
||||
CrowdSecMode: "disabled",
|
||||
WAFMode: "disabled",
|
||||
RateLimitMode: "disabled",
|
||||
ACLMode: "disabled",
|
||||
},
|
||||
expectedStatus: http.StatusOK,
|
||||
expectedBody: map[string]interface{}{
|
||||
"cerberus": map[string]interface{}{"enabled": false},
|
||||
"crowdsec": map[string]interface{}{
|
||||
"mode": "disabled",
|
||||
"api_url": "",
|
||||
"enabled": false,
|
||||
},
|
||||
"waf": map[string]interface{}{
|
||||
"mode": "disabled",
|
||||
"enabled": false,
|
||||
},
|
||||
"rate_limit": map[string]interface{}{
|
||||
"mode": "disabled",
|
||||
"enabled": false,
|
||||
},
|
||||
"acl": map[string]interface{}{
|
||||
"mode": "disabled",
|
||||
"enabled": false,
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "All Enabled",
|
||||
cfg: config.SecurityConfig{
|
||||
CerberusEnabled: true, // Required for ACL to be effective
|
||||
CrowdSecMode: "local",
|
||||
WAFMode: "enabled",
|
||||
RateLimitMode: "enabled",
|
||||
ACLMode: "enabled",
|
||||
},
|
||||
expectedStatus: http.StatusOK,
|
||||
expectedBody: map[string]interface{}{
|
||||
"cerberus": map[string]interface{}{"enabled": true},
|
||||
"crowdsec": map[string]interface{}{
|
||||
"mode": "local",
|
||||
"api_url": "",
|
||||
"enabled": true,
|
||||
},
|
||||
"waf": map[string]interface{}{
|
||||
"mode": "enabled",
|
||||
"enabled": true,
|
||||
},
|
||||
"rate_limit": map[string]interface{}{
|
||||
"mode": "enabled",
|
||||
"enabled": true,
|
||||
},
|
||||
"acl": map[string]interface{}{
|
||||
"mode": "enabled",
|
||||
"enabled": true,
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
handler := NewSecurityHandler(tt.cfg, nil, nil)
|
||||
router := gin.New()
|
||||
router.GET("/security/status", handler.GetStatus)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req, _ := http.NewRequest("GET", "/security/status", http.NoBody)
|
||||
router.ServeHTTP(w, req)
|
||||
|
||||
assert.Equal(t, tt.expectedStatus, w.Code)
|
||||
|
||||
var response map[string]interface{}
|
||||
err := json.Unmarshal(w.Body.Bytes(), &response)
|
||||
assert.NoError(t, err)
|
||||
|
||||
expectedJSON, _ := json.Marshal(tt.expectedBody)
|
||||
var expectedNormalized map[string]interface{}
|
||||
if err := json.Unmarshal(expectedJSON, &expectedNormalized); err != nil {
|
||||
t.Fatalf("failed to unmarshal expected JSON: %v", err)
|
||||
}
|
||||
|
||||
assert.Equal(t, expectedNormalized, response)
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -31,9 +31,10 @@ func TestSecurityHandler_GetStatus_RespectsSettingsTable(t *testing.T) {
|
||||
{
|
||||
name: "WAF enabled via settings overrides disabled config",
|
||||
cfg: config.SecurityConfig{
|
||||
WAFMode: "disabled",
|
||||
RateLimitMode: "disabled",
|
||||
CrowdSecMode: "disabled",
|
||||
CerberusEnabled: true,
|
||||
WAFMode: "disabled",
|
||||
RateLimitMode: "disabled",
|
||||
CrowdSecMode: "disabled",
|
||||
},
|
||||
settings: []models.Setting{
|
||||
{Key: "security.waf.enabled", Value: "true"},
|
||||
@@ -45,9 +46,10 @@ func TestSecurityHandler_GetStatus_RespectsSettingsTable(t *testing.T) {
|
||||
{
|
||||
name: "Rate Limit enabled via settings overrides disabled config",
|
||||
cfg: config.SecurityConfig{
|
||||
WAFMode: "disabled",
|
||||
RateLimitMode: "disabled",
|
||||
CrowdSecMode: "disabled",
|
||||
CerberusEnabled: true,
|
||||
WAFMode: "disabled",
|
||||
RateLimitMode: "disabled",
|
||||
CrowdSecMode: "disabled",
|
||||
},
|
||||
settings: []models.Setting{
|
||||
{Key: "security.rate_limit.enabled", Value: "true"},
|
||||
@@ -59,9 +61,10 @@ func TestSecurityHandler_GetStatus_RespectsSettingsTable(t *testing.T) {
|
||||
{
|
||||
name: "CrowdSec enabled via settings overrides disabled config",
|
||||
cfg: config.SecurityConfig{
|
||||
WAFMode: "disabled",
|
||||
RateLimitMode: "disabled",
|
||||
CrowdSecMode: "disabled",
|
||||
CerberusEnabled: true,
|
||||
WAFMode: "disabled",
|
||||
RateLimitMode: "disabled",
|
||||
CrowdSecMode: "disabled",
|
||||
},
|
||||
settings: []models.Setting{
|
||||
{Key: "security.crowdsec.enabled", Value: "true"},
|
||||
@@ -73,9 +76,10 @@ func TestSecurityHandler_GetStatus_RespectsSettingsTable(t *testing.T) {
|
||||
{
|
||||
name: "All modules enabled via settings",
|
||||
cfg: config.SecurityConfig{
|
||||
WAFMode: "disabled",
|
||||
RateLimitMode: "disabled",
|
||||
CrowdSecMode: "disabled",
|
||||
CerberusEnabled: true,
|
||||
WAFMode: "disabled",
|
||||
RateLimitMode: "disabled",
|
||||
CrowdSecMode: "disabled",
|
||||
},
|
||||
settings: []models.Setting{
|
||||
{Key: "security.waf.enabled", Value: "true"},
|
||||
@@ -89,9 +93,10 @@ func TestSecurityHandler_GetStatus_RespectsSettingsTable(t *testing.T) {
|
||||
{
|
||||
name: "WAF disabled via settings overrides enabled config",
|
||||
cfg: config.SecurityConfig{
|
||||
WAFMode: "enabled",
|
||||
RateLimitMode: "enabled",
|
||||
CrowdSecMode: "local",
|
||||
CerberusEnabled: true,
|
||||
WAFMode: "enabled",
|
||||
RateLimitMode: "enabled",
|
||||
CrowdSecMode: "local",
|
||||
},
|
||||
settings: []models.Setting{
|
||||
{Key: "security.waf.enabled", Value: "false"},
|
||||
@@ -105,9 +110,10 @@ func TestSecurityHandler_GetStatus_RespectsSettingsTable(t *testing.T) {
|
||||
{
|
||||
name: "No settings - falls back to config (enabled)",
|
||||
cfg: config.SecurityConfig{
|
||||
WAFMode: "enabled",
|
||||
RateLimitMode: "enabled",
|
||||
CrowdSecMode: "local",
|
||||
CerberusEnabled: true,
|
||||
WAFMode: "enabled",
|
||||
RateLimitMode: "enabled",
|
||||
CrowdSecMode: "local",
|
||||
},
|
||||
settings: []models.Setting{},
|
||||
expectedWAF: true,
|
||||
@@ -164,7 +170,8 @@ func TestSecurityHandler_GetStatus_WAFModeFromSettings(t *testing.T) {
|
||||
|
||||
// WAF config is disabled, but settings says enabled
|
||||
cfg := config.SecurityConfig{
|
||||
WAFMode: "disabled",
|
||||
CerberusEnabled: true,
|
||||
WAFMode: "disabled",
|
||||
}
|
||||
db.Create(&models.Setting{Key: "security.waf.enabled", Value: "true"})
|
||||
|
||||
@@ -196,7 +203,8 @@ func TestSecurityHandler_GetStatus_RateLimitModeFromSettings(t *testing.T) {
|
||||
|
||||
// Rate limit config is disabled, but settings says enabled
|
||||
cfg := config.SecurityConfig{
|
||||
RateLimitMode: "disabled",
|
||||
CerberusEnabled: true,
|
||||
RateLimitMode: "disabled",
|
||||
}
|
||||
db.Create(&models.Setting{Key: "security.rate_limit.enabled", Value: "true"})
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user