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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added images/advanced_search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/advanced_search_location.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/branch_picker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/cwe_filters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/file_ignore_rules.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/policies_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/scan_log.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/scan_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
"false_positive",
"issue_assignment",
"issue_export",
"project_settings"
"project"
]
},
{
Expand Down
120 changes: 120 additions & 0 deletions project.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
---
title: 'Project Management'
description: 'Configure scanning behavior for your project including CWE filters and file ignore rules'
---

## Overview

Corgea’s project management live inside each project’s dashboard. Use this page to tailor scanning behavior so it aligns with your codebase, compliance needs, and team workflows. You can block noisy files, ignore irrelevant CWEs, document policies, and see the operational views you need to keep your application secure.

Every change you make here applies to future scans for the selected branch. If you’re new to these controls, start with the Default Settings and gradually refine the filters after reviewing a few scan reports.

## File Ignore Rules

File ignore rules help you keep scanning focused on the code that matters. We already exclude common build artifacts, dependency folders, and generated files, so you typically only need to add rules that are unique to your project structure.

### Default exclusions

- **Test files**: `*_test.*`, `test_*.*`, `*.test.*`, `*.spec.*`, `*__tests__/*`, `*test/*`, `*tests/*`
- **Dependencies**: `*node_modules/*`, `*python*/site-packages/*`
- **Generated code**: `*generated.*`, `*.gen.go`, `*.pb.*`, `*.designer.cs`, `*.d.ts`
- **Build artifacts**: `*build/*`, `*dist/*`, `*coverage/*`
- **Configuration**: `tsconfig.json`, `webpack.config.js`, `pnpm-lock.yaml`, `*compose*.yml`
- **Other common folders**: `*migrations/*`, `*mock/*`, `*mocks/*`, `*fixtures*`, `*tmp/*`, `*log/*`, `*logs/*`

### How to add custom ignores

<Steps>
<Step title="Open Projects">
From the project dashboard, click **Settings** and choose **File ignore rules** from the sidebar.
<img src="/images/scan_settings.png" style={{ borderRadius: '0.5rem' }} alt="Scan Settings" />
</Step>
<Step title="Add or edit patterns">
Use glob syntax to include paths (`src/tools/`) or directories (`**/legacy/**`). Each line accepts a single pattern, so you can mix directories, files, and wildcard expressions.
<Card>
<img src="/images/file_ignore_rules.png" style={{ borderRadius: '0.5rem' }} alt="File Ignore Rules Configuration" />
</Card>
</Step>
<Step title="Save and monitor">
Save the rule list and run a test scan to make sure the behavior matches your expectations. Revisit this list whenever you add new generated outputs or temporary directories.
</Step>
</Steps>

### When to add rules

- **Internal tooling**: Scripts or utilities that should never be scanned (e.g., internal deploy scripts or CLI helpers).
- **Legacy or deprecated code**: Modules you’re no longer shipping but still keep for reference.
- **Vendor or third-party artifacts**: Files provided by hardware vendors or partners that don’t change and you don’t control.
- **Documentation or content**: Rule out large doc folders when only code matters.
- **Custom output**: Non-standard build directories created during CI or local experimentation.

Always explain why a rule exists so teammates know why a folder is skipped during future reviews.

## CWE Filters

CWEs let you align Corgea’s findings with your project’s threat model. Think of this section as your security policy in code: you can disable specific vulnerability families that you’re already protecting through other controls or that don’t apply to your stack.

### How to configure filters

<Steps>
<Step title="Go to CWE filters">
In the project settings sidebar, open the **CWE filters** tab.
</Step>
<Step title="Pick the CWEs you want to ignore">
Browse the list grouped by category (e.g., Injection, Authentication) or search for a specific CWE identifier. Toggle off entries that should no longer surface in new scan results.
<Card>
<img src="/images/cwe_filters.png" style={{ borderRadius: '0.5rem' }} alt="CWE Filters Configuration" />
</Card>
</Step>
<Step title="Document why">
Add an internal note explaining why each rule exists—this helps new contributors understand whether the filter should remain in place.
</Step>
</Steps>

### Common scenarios

- **Focus on critical paths**: Temporarily mute low-impact CWEs until you finish triaging high-severity findings.
- **Framework-level protection**: Skip CWEs covered by built-in framework hardening (e.g., managed auth providers).
- **Compliance tailoring**: Disallow CWEs that violate organizational policies while keeping scans manageable.
- **Early-stage development**: Move fast by hiding noise but re-enable the filters later before shipping.

> Tip: Periodically re-run scans with the full CWE list enabled so you don’t miss regressions when filters change.


## Project Views and Controls

### Trigger a Scan for a Specific Branch

Select the branch you care about from the branch picker at the top of the dashboard before hitting **Scan now**. Corgea locks the scan to that branch's latest commit and stores branch metadata so you can compare results across lines of development.

<Card>
<img src="/images/branch_picker.png" style={{ borderRadius: '0.5rem' }} alt="Branch picker in project dashboard" />
</Card>


### Scan Log

The Scan Log tracks every run you kick off. It records status, duration, branch, and who triggered each scan. Use this page to rerun scans, compare results side by side, and jump into the findings that caused failures.

<Card>
<img src="/images/scan_log.png" style={{ borderRadius: '0.5rem' }} alt="Scan log view listing scan runs" />
</Card>


### Advanced Vulnerability Search

Click the **Advanced** button on the project page to open the Advanced Vulnerability Search page and zero in on findings across every scan run. The view surfaces totals plus severity counts at the top, and you can expand any project to reveal its files, CWE badges, urgency levels, detection times, and other context without leaving the list.

- **Filters**: Narrow results by Vulnerability Category, Urgency, Confidence, Status, Fix Status, Scan Type, Project, Branch, policies, or other metadata. A Date Range (preset or custom) is required so the system knows which span of time to examine.
- **Date reminder**: The interface highlights what’s missing if you try to run a search without selecting a date range, and keeps the controls disabled until you pick a preset or custom window.
- **Results exploration**: Click any row to load more context in the side panel while keeping your active filters in place. This lets you review evidence, remediation guidance, and related scan details without disrupting the list.


<CardGroup cols={1}>
<Card>
<img src="/images/advanced_search_location.png" style={{ borderRadius: '0.5rem' }} alt="Advanced search location" />
</Card>
<Card>
<img src="/images/advanced_search.png" style={{ borderRadius: '0.5rem' }} alt="Advanced vulnerability search screen" />
</Card>
</CardGroup>
117 changes: 0 additions & 117 deletions project_settings.mdx

This file was deleted.