From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [IPv6:2a0f:8001:1:32::40]) by lore.proxmox.com (Postfix) with ESMTPS id 97C8F1FF09D for ; Sun, 01 Nov 2026 22:39:55 +0100 (CET) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id 794BF21769; Sun, 01 Nov 2026 22:38:54 +0100 (CET) From: Thomas Lamprecht To: pve-devel@lists.proxmox.com Subject: [PATCH manager 10/10] pvereport: man page: document which values get redacted Date: Sun, 1 Nov 2026 22:34:59 +0100 Message-ID: <20261101213835.353604-11-t.lamprecht@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20261101213835.353604-1-t.lamprecht@proxmox.com> References: <20261101213835.353604-1-t.lamprecht@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1793569121387 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.413 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: 3PPNMKNXEIRYCN7ZBFCUXLM6RNZ5PMYH X-Message-ID-Hash: 3PPNMKNXEIRYCN7ZBFCUXLM6RNZ5PMYH X-MailFrom: t.lamprecht@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Admins who send a report to support need to know which secrets it leaves out, and which possibly sensitive information it still contains. Signed-off-by: Thomas Lamprecht --- bin/pvereport | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/bin/pvereport b/bin/pvereport index 8658a0424..fb9320a98 100755 --- a/bin/pvereport +++ b/bin/pvereport @@ -22,3 +22,34 @@ pvereport =head1 DESCRIPTION Display various information related to a Proxmox VE system + +The report replaces the following values with C<< >>: + +=over + +=item * + +Values of options marked as secret in guest, storage, SDN IPAM and SDN DNS +configurations, like the cloud-init password of guests and the API tokens of +IPAM and DNS plugins. + +=item * + +Passwords in URLs, for example in APT sources or the HTTP proxy setting. + +=item * + +Values in C form whose name suggests a credential, like +C in mount options or C in the environment of a +container. + +=back + +This only covers the cases above. Credentials can remain elsewhere, for example +in command lines, in QEMU C, in the output of C, in +error messages, or in options of storage plugins that are not installed on this +node. The report also contains other information that can be sensitive, like +guest descriptions, user names, SSH public keys, IP addresses and host names. +Check the report before you share it. + +The same applies to the system report generated in the web interface. -- 2.47.3