From nobody Mon Feb 9 03:58:46 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1643632583; cv=none; d=zohomail.com; s=zohoarc; b=VgKqNwe7qDDLqpVKe047vtZ1OoJCVJaCcLLh9npT9dQagr0aYnwrCTUKtXxKak4IW+6p2FSbpUuYkOQ0RAiVx1kehHvbryHhgzIWi1lb4u/PM3e6GC9BsD9g8/3k/bahaP5R0y7x0IwULaIH+IipOBfUrSR5FKEhx+qksUnRCHA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1643632583; h=Content-Type:Content-Transfer-Encoding:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=MV/pQ3Ki/ExAA+793A14wCC9sH6DFJGmQK5Sawl1Fkg=; b=BZVijj/dLObF0h/BqSNDxLZf1SRu/Hnx3pKcwIcqRRTueVndWvxkm+TTovLSDKJRWQDxuQhhAAo0MJxVpIi2zmEnsiWNKyqv6s/KUL0DIGRzBEoSCTrmfRlj+Kyj0SjdHan2PI1T6SiVe2B41jaLDzZHwlqMESMIQejomBrZXFc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1643632583454354.8461813803598; Mon, 31 Jan 2022 04:36:23 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-375-ItCXtMBzPV-bHQt3TXW75Q-1; Mon, 31 Jan 2022 07:36:18 -0500 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id AC8408465FE; Mon, 31 Jan 2022 12:36:12 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 61F9526373; Mon, 31 Jan 2022 12:36:12 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 103E14CA93; Mon, 31 Jan 2022 12:36:12 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 20VCaA1i026165 for ; Mon, 31 Jan 2022 07:36:10 -0500 Received: by smtp.corp.redhat.com (Postfix) id B7F4F282FA; Mon, 31 Jan 2022 12:36:10 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.40.208.41]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1E40426373 for ; Mon, 31 Jan 2022 12:36:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1643632582; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=MV/pQ3Ki/ExAA+793A14wCC9sH6DFJGmQK5Sawl1Fkg=; b=d2veWh3UarU72cornKSJS79xngfM8JH1T2Kknhj0PIIOQJO7Rp+KttcMPJlyesPK0Vd/vE Nw7ThKAkLjHddsyi4Y3MgsQcb03WfrqRFM+sn45OaB2lV5G1A2Eu6C1t8gEHzW6j2gEW6w 5CFsWEp4/UEHYluRN2nZgsl3IwVF2zI= X-MC-Unique: ItCXtMBzPV-bHQt3TXW75Q-1 From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH] kbase: debuglogs: Add note about sensitive information in the logs Date: Mon, 31 Jan 2022 13:36:08 +0100 Message-Id: <81c5dfb7b0fe0e8cf9917244703577a6044d25f1.1643632568.git.pkrempa@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1643632585848100001 Content-Type: text/plain; charset="utf-8" Outline information commonly logged which users could consider sensitive. Add a note that VNC/SPICE passwords are logged in plaintext. Signed-off-by: Peter Krempa Reviewed-by: Michal Privoznik --- docs/kbase/debuglogs.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/kbase/debuglogs.rst b/docs/kbase/debuglogs.rst index c361c698c5..00dbc9bbf7 100644 --- a/docs/kbase/debuglogs.rst +++ b/docs/kbase/debuglogs.rst @@ -300,6 +300,8 @@ Now you should go and reproduce the bug. Once you're fi= nished, attach: - If you are asked for client logs, ``/tmp/libvirt_client.log``. - Ideally don't tear down the environment in case additional information = is required. +- Consider whether you consider any of the information in the debug logs + sensitive: `Sensitive information in debug logs`_. Example filter settings =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D @@ -339,3 +341,25 @@ This filter logs only QMP traffic and skips most of li= bvirt's messages. :: 2:qemu.qemu_monitor 3:* + +Sensitive information in debug logs +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Debug logs may contain information that certain users may consider sensiti= ve +although generally it's okay to share debuglogs publicly. + +Information which could be deemed sensitive: + + - hostname of the host + - names of VMs and other objects + - paths to disk images + - IP addresses of guests and the host + - hostnames/IP addresses of disks accessed via network + + +Libvirt's debug logs only ever have passwords and disk encryption secrets = in +encrypted form without the key being part of the log. There's one notable +exception, that ``VNC/SPICE`` passwords can be found in the logs. + +In case you decide to mask information you consider sensitive from the pos= ted +debug logs, make sure that the masking doesn't introduce ambiguity. --=20 2.34.1