Skip to content

Commit 01f80ac

Browse files
Sanitize Postgres connection string examples to avoid TruffleHog detection
Remove literal postgresql:// URL examples from documentation and replace with component-based format description to prevent security scanner false positives while maintaining clarity for users. Signed-off-by: Peter Arsenault <parsenau@progress.com>
1 parent 963ff06 commit 01f80ac

2 files changed

Lines changed: 7 additions & 9 deletions

File tree

.github/actions/notify-new-cves/SETUP.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,13 @@ Add these secrets to the `chef/chef-vuln-scan-orchestrator` repository (or at or
3737
**Note**: The notification workflow only performs `SELECT` queries on `scan_runs`, `native_cve_details`, and `native_scan_results`. No write operations are performed—you can use a dedicated read-only database user for security.
3838

3939
#### Database URL Format
40-
```
41-
postgresql://USERNAME:PASSWORD@HOSTNAME:5432/DATABASE_NAME
42-
```
4340

44-
Example:
45-
```
46-
postgresql://scanwriter:***@chef-vuln-db.abc123.us-east-2.rds.amazonaws.com:5432/chef_vuln_analytics
47-
```
41+
PostgreSQL connection string format:
42+
- Scheme: `postgresql`
43+
- Format: `<scheme>://<username>:<password>@<hostname>:<port>/<database>`
44+
- Default port: `5432`
45+
46+
Replace the angle-bracketed placeholders with your actual connection details.
4847

4948
#### Teams Webhook URL
5049
1. In Microsoft Teams, go to the channel where you want notifications

.github/actions/notify-new-cves/action.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ inputs:
1616
database-url:
1717
description: >
1818
Full PostgreSQL connection string (DSN). Read-only permissions sufficient
19-
(only performs SELECT queries).
20-
Example: postgresql://USERNAME:PASSWORD@HOST:5432/dbname
19+
(only performs SELECT queries). See SETUP.md for connection string format.
2120
required: true
2221

2322
# ── Data repository ──────────────────────────────────────────────────────

0 commit comments

Comments
 (0)