Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

Make private security reporting findable before deployment guidance

pulse-triage[bot]b2b329baeabb
diff --git a/SECURITY.md b/SECURITY.md
index 85ece46351..5c7e0b640e 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -9,6 +9,28 @@ For a high-level overview of the system design and data flow, please refer to
---
+## Reporting a vulnerability
+
+Email <[email protected]> for suspected vulnerabilities or sensitive
+security details. **Do not open a public issue or discussion for these reports.**
+
+Start with a short description of the problem, its impact and the affected
+Pulse and agent versions, if known. Use existing, locally reviewed evidence;
+do not send live credentials, private keys, full diagnostics or configuration
+exports. Do not repeat a risky action just to make a report.
+
+If private information has already been posted, follow the
+[containment steps](docs/TROUBLESHOOTING.md#if-you-already-posted-private-information).
+Removing a public copy is not credential revocation or proof that every copy
+is gone. Do not repost the original sensitive material.
+
+For ordinary bugs and usage questions, use the
+[public issue tracker](https://github.com/rcourtman/Pulse/issues) or
+[Discussions](https://github.com/rcourtman/Pulse/discussions), with secrets and
+identifying details removed. The security address is not a general support route.
+
+---
+
## Critical Security Notice for Container Deployments
### Container SSH Key Handling
@@ -139,7 +161,7 @@ incident, defer live checks and follow [backup safety](docs/VM_DISK_MONITORING.m
**Documentation:** [Critical security notice for container deployments](#critical-security-notice-for-container-deployments)
**Issues:** <https://github.com/rcourtman/pulse/issues>
-**Private disclosures:** <[email protected]>
+**Private disclosures:** [Reporting a vulnerability](#reporting-a-vulnerability)
---
diff --git a/frontend-modern/public/docs/SECURITY.md b/frontend-modern/public/docs/SECURITY.md
index 85ece46351..5c7e0b640e 100644
--- a/frontend-modern/public/docs/SECURITY.md
+++ b/frontend-modern/public/docs/SECURITY.md
@@ -9,6 +9,28 @@ For a high-level overview of the system design and data flow, please refer to
---
+## Reporting a vulnerability
+
+Email <[email protected]> for suspected vulnerabilities or sensitive
+security details. **Do not open a public issue or discussion for these reports.**
+
+Start with a short description of the problem, its impact and the affected
+Pulse and agent versions, if known. Use existing, locally reviewed evidence;
+do not send live credentials, private keys, full diagnostics or configuration
+exports. Do not repeat a risky action just to make a report.
+
+If private information has already been posted, follow the
+[containment steps](docs/TROUBLESHOOTING.md#if-you-already-posted-private-information).
+Removing a public copy is not credential revocation or proof that every copy
+is gone. Do not repost the original sensitive material.
+
+For ordinary bugs and usage questions, use the
+[public issue tracker](https://github.com/rcourtman/Pulse/issues) or
+[Discussions](https://github.com/rcourtman/Pulse/discussions), with secrets and
+identifying details removed. The security address is not a general support route.
+
+---
+
## Critical Security Notice for Container Deployments
### Container SSH Key Handling
@@ -139,7 +161,7 @@ incident, defer live checks and follow [backup safety](docs/VM_DISK_MONITORING.m
**Documentation:** [Critical security notice for container deployments](#critical-security-notice-for-container-deployments)
**Issues:** <https://github.com/rcourtman/pulse/issues>
-**Private disclosures:** <[email protected]>
+**Private disclosures:** [Reporting a vulnerability](#reporting-a-vulnerability)
---
diff --git a/frontend-modern/src/features/docs/__tests__/securityReportingGuide.test.ts b/frontend-modern/src/features/docs/__tests__/securityReportingGuide.test.ts
new file mode 100644
index 0000000000..4a2e534b46
--- /dev/null
+++ b/frontend-modern/src/features/docs/__tests__/securityReportingGuide.test.ts
@@ -0,0 +1,49 @@
+import { readFileSync } from 'node:fs';
+import path from 'node:path';
+import { describe, expect, it } from 'vitest';
+import { renderDocMarkdown, stripLeadingTitle } from '../docMarkdown';
+
+const read = (name: string) => readFileSync(path.resolve(process.cwd(), '..', name), 'utf8');
+const source = read('SECURITY.md');
+const article = () => {
+ const element = document.createElement('article');
+ element.innerHTML = renderDocMarkdown(stripLeadingTitle(source), 'SECURITY');
+ return element;
+};
+
+describe('private vulnerability reporting guidance', () => {
+ it('puts the existing private route before unrelated deployment guidance', () => {
+ expect(read('frontend-modern/public/docs/SECURITY.md')).toBe(source);
+ const rendered = article();
+ const headings = Array.from(rendered.querySelectorAll('h2'), (heading) => heading.id);
+ expect(headings[0]).toBe('reporting-a-vulnerability');
+ expect(headings[1]).toBe('critical-security-notice-for-container-deployments');
+ const contact = rendered.querySelector('a[href="mailto:[email protected]"]');
+ expect(contact?.textContent).toBe('[email protected]');
+ // Opening the contact must not prefill credentials or diagnostic material.
+ expect(contact?.getAttribute('href')).not.toContain('?');
+ expect(rendered.querySelectorAll('a[href^="mailto:"]')).toHaveLength(1);
+ expect(rendered.querySelector('a[href="#reporting-a-vulnerability"]')).not.toBeNull();
+ });
+
+ it('separates sensitive reports from public support without requesting unsafe evidence', () => {
+ const rendered = article();
+ const heading = rendered.querySelector('#reporting-a-vulnerability')!;
+ const paragraphs: string[] = [];
+ for (let next = heading.nextElementSibling; next && next.tagName !== 'HR'; next = next.nextElementSibling) {
+ paragraphs.push(next.textContent ?? '');
+ }
+ const text = paragraphs.join(' ').replace(/\s+/g, ' ');
+ expect(text).toContain('Do not open a public issue or discussion for these reports.');
+ expect(text).toMatch(/affected Pulse and agent versions, if known/);
+ expect(text).toMatch(/do not send live credentials, private keys, full diagnostics or configuration exports/);
+ expect(text).toContain('Do not repeat a risky action just to make a report.');
+ expect(text).toMatch(/Removing a public copy is not credential revocation/);
+ expect(text).toContain('The security address is not a general support route.');
+ expect(
+ rendered.querySelector('a[href="/docs/TROUBLESHOOTING#if-you-already-posted-private-information"]'),
+ ).not.toBeNull();
+ expect(rendered.querySelector('a[href="https://github.com/rcourtman/Pulse/issues"]')).not.toBeNull();
+ expect(rendered.querySelector('a[href="https://github.com/rcourtman/Pulse/discussions"]')).not.toBeNull();
+ });
+});