From nobody Tue Oct 7 04:05:08 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1582717144; cv=none; d=zohomail.com; s=zohoarc; b=XQinGE5fSZO/8DEXm0SKDAdEPTshgRriazkJana9tmgh3ZtncJmObXk0rW4g2iG7DtvVTbt3lN7oim7cp3d1akyM7kcNQUsj+6cYT7ZEGTqKXRzYAH9F3oldBBQRcxjFQ2zWhPAXI2pRpFudDX1MOKmYDrmZm2hmRQWckROc6Yg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1582717144; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=jQCthPnR6y1TZUUgQIYVSn60kzDk9kwVXC4q84W9SeE=; b=nmQqO2UQLxk/+P2u+QNx4yr57JR9CrF9kBGYZ0V6cQUH/QSrsurpMgGExfinyn1ekBnxb56tDVmVFlS1VVgNkNus9iFMDCHHsCNgYgA8iyXWU/0W+rLAiSuq6X8uvxoP488e5wAY/NlHN2i+qANBnIeUZc87ZrujmEUgeJKJfD4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1582717144744178.82222853499366; Wed, 26 Feb 2020 03:39:04 -0800 (PST) Received: from localhost ([::1]:42818 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j6v1p-00038m-K9 for importer@patchew.org; Wed, 26 Feb 2020 06:39:03 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:52841) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j6utx-0000zM-VG for qemu-devel@nongnu.org; Wed, 26 Feb 2020 06:30:56 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j6utw-0006pc-0d for qemu-devel@nongnu.org; Wed, 26 Feb 2020 06:30:53 -0500 Received: from mail-wr1-x436.google.com ([2a00:1450:4864:20::436]:46474) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j6utv-0006l3-Nn for qemu-devel@nongnu.org; Wed, 26 Feb 2020 06:30:51 -0500 Received: by mail-wr1-x436.google.com with SMTP id j7so2493419wrp.13 for ; Wed, 26 Feb 2020 03:30:51 -0800 (PST) Received: from donizetti.lan ([2001:b07:6468:f312:d0d9:ea10:9775:f33f]) by smtp.gmail.com with ESMTPSA id h128sm2628154wmh.33.2020.02.26.03.30.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 26 Feb 2020 03:30:49 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=jQCthPnR6y1TZUUgQIYVSn60kzDk9kwVXC4q84W9SeE=; b=MA9H0Evrqm8eXA6q2MF1l0SI8lKcIQ+XmsMFqU4mdcW3eqqMEjufRX+SjgA3rlNmrP FdJeR2J9ZutmG0nsXuAyTJJJ6pbK24hV2oYpSk0zToM7OSURNsjRP4EHQ8qgHFHnV9Mf pLT77cngrGAhR5ewcNP65H2YcLRFnkbbci+5L5fJxFmeqc06c1GyOspk1myvoMN/3g0q /+veChHgJAx4JY4yYTErJ3mIkh/AQaZp0rr1WLcVOq+elxirh6VUiLdSXUL0bP5rX1zI ZFXU0dGCtAVpiAmTKLiNvUildpzJZZyuI3rY2ezgcTvxTL9kHdA4kdPR0zMrwMc/zz6v OkOA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=jQCthPnR6y1TZUUgQIYVSn60kzDk9kwVXC4q84W9SeE=; b=Ahp/0Davv6m7tceiRks/P4vyVtwiwPvx/QmmPS6Zv7iy3r0FZgAtStl30QDhd/jMRd ZZyHr9LTzE56hUXPnkbkQ0rYQqF0IDdhPaflN3hhKPzcWeOTtWOfLA+LICKdmH0anwO2 vI8KUiA3/UWGRvaI9MBZSPlGdIu2a/rZzaLhs8iNYlvNDVUzWZwBRhrZL7hgUTlYTqxM uECkQnM+llWQm3laAIaUeBP7co6CDoHj5U4e62WIx5fhedouJH3QsxWnNfRvk7rV+l7V S4fURNBB8hgJb/K/C7j+z3+iHDEq0XuiLOukLeZetV2gRFP1iBgscN8IuQy2FZmGVETb Jqhg== X-Gm-Message-State: APjAAAVVMMODHpiA2jjQxc122L6dLKuWgcJ3KSuKei0IOIphx19ur+G4 fGo+VAEPyG73KloRULfFTrLg10Lo X-Google-Smtp-Source: APXvYqzUjZN4OKkAcCDT3P8FR4U1ZC9UsDGaZHCbNZRHyU/xVWmNsCwmQs5XSADfXoDXFBgsqkYInQ== X-Received: by 2002:a5d:66ca:: with SMTP id k10mr4916113wrw.194.1582716650217; Wed, 26 Feb 2020 03:30:50 -0800 (PST) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PATCH 15/18] docs/system: Convert security.texi to rST format Date: Wed, 26 Feb 2020 12:30:31 +0100 Message-Id: <20200226113034.6741-16-pbonzini@redhat.com> X-Mailer: git-send-email 2.21.1 In-Reply-To: <20200226113034.6741-1-pbonzini@redhat.com> References: <20200226113034.6741-1-pbonzini@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::436 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: peter.maydell@linaro.org Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" From: Peter Maydell security.texi is included from qemu-doc.texi but is not used in the qemu.1 manpage. So we can do a straightforward conversion of the contents, which go into the system manual. Signed-off-by: Peter Maydell Signed-off-by: Paolo Bonzini --- docs/system/index.rst | 1 + docs/system/security.rst | 173 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 174 insertions(+) create mode 100644 docs/system/security.rst diff --git a/docs/system/index.rst b/docs/system/index.rst index 21b5a18b67..d38addb2a0 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -13,3 +13,4 @@ Contents: =20 .. toctree:: :maxdepth: 2 + security diff --git a/docs/system/security.rst b/docs/system/security.rst new file mode 100644 index 0000000000..f2092c8768 --- /dev/null +++ b/docs/system/security.rst @@ -0,0 +1,173 @@ +Security +=3D=3D=3D=3D=3D=3D=3D=3D + +Overview +-------- + +This chapter explains the security requirements that QEMU is designed to m= eet +and principles for securely deploying QEMU. + +Security Requirements +--------------------- + +QEMU supports many different use cases, some of which have stricter securi= ty +requirements than others. The community has agreed on the overall security +requirements that users may depend on. These requirements define what is +considered supported from a security perspective. + +Virtualization Use Case +''''''''''''''''''''''' + +The virtualization use case covers cloud and virtual private server (VPS) +hosting, as well as traditional data center and desktop virtualization. T= hese +use cases rely on hardware virtualization extensions to execute guest code +safely on the physical CPU at close-to-native speed. + +The following entities are untrusted, meaning that they may be buggy or +malicious: + +- Guest +- User-facing interfaces (e.g. VNC, SPICE, WebSocket) +- Network protocols (e.g. NBD, live migration) +- User-supplied files (e.g. disk images, kernels, device trees) +- Passthrough devices (e.g. PCI, USB) + +Bugs affecting these entities are evaluated on whether they can cause dama= ge in +real-world use cases and treated as security bugs if this is the case. + +Non-virtualization Use Case +''''''''''''''''''''''''''' + +The non-virtualization use case covers emulation using the Tiny Code Gener= ator +(TCG). In principle the TCG and device emulation code used in conjunction= with +the non-virtualization use case should meet the same security requirements= as +the virtualization use case. However, for historical reasons much of the +non-virtualization use case code was not written with these security +requirements in mind. + +Bugs affecting the non-virtualization use case are not considered security +bugs at this time. Users with non-virtualization use cases must not rely = on +QEMU to provide guest isolation or any security guarantees. + +Architecture +------------ + +This section describes the design principles that ensure the security +requirements are met. + +Guest Isolation +''''''''''''''' + +Guest isolation is the confinement of guest code to the virtual machine. = When +guest code gains control of execution on the host this is called escaping = the +virtual machine. Isolation also includes resource limits such as throttli= ng of +CPU, memory, disk, or network. Guests must be unable to exceed their reso= urce +limits. + +QEMU presents an attack surface to the guest in the form of emulated devic= es. +The guest must not be able to gain control of QEMU. Bugs in emulated devi= ces +could allow malicious guests to gain code execution in QEMU. At this poin= t the +guest has escaped the virtual machine and is able to act in the context of= the +QEMU process on the host. + +Guests often interact with other guests and share resources with them. A +malicious guest must not gain control of other guests or access their data. +Disk image files and network traffic must be protected from other guests u= nless +explicitly shared between them by the user. + +Principle of Least Privilege +'''''''''''''''''''''''''''' + +The principle of least privilege states that each component only has acces= s to +the privileges necessary for its function. In the case of QEMU this means= that +each process only has access to resources belonging to the guest. + +The QEMU process should not have access to any resources that are inaccess= ible +to the guest. This way the guest does not gain anything by escaping into = the +QEMU process since it already has access to those same resources from with= in +the guest. + +Following the principle of least privilege immediately fulfills guest isol= ation +requirements. For example, guest A only has access to its own disk image = file +``a.img`` and not guest B's disk image file ``b.img``. + +In reality certain resources are inaccessible to the guest but must be +available to QEMU to perform its function. For example, host system calls= are +necessary for QEMU but are not exposed to guests. A guest that escapes in= to +the QEMU process can then begin invoking host system calls. + +New features must be designed to follow the principle of least privilege. +Should this not be possible for technical reasons, the security risk must = be +clearly documented so users are aware of the trade-off of enabling the fea= ture. + +Isolation mechanisms +'''''''''''''''''''' + +Several isolation mechanisms are available to realize this architecture of +guest isolation and the principle of least privilege. With the exception = of +Linux seccomp, these mechanisms are all deployed by management tools that +launch QEMU, such as libvirt. They are also platform-specific so they are= only +described briefly for Linux here. + +The fundamental isolation mechanism is that QEMU processes must run as +unprivileged users. Sometimes it seems more convenient to launch QEMU as +root to give it access to host devices (e.g. ``/dev/net/tun``) but this po= ses a +huge security risk. File descriptor passing can be used to give an otherw= ise +unprivileged QEMU process access to host devices without running QEMU as r= oot. +It is also possible to launch QEMU as a non-root user and configure UNIX g= roups +for access to ``/dev/kvm``, ``/dev/net/tun``, and other device nodes. +Some Linux distros already ship with UNIX groups for these devices by defa= ult. + +- SELinux and AppArmor make it possible to confine processes beyond the + traditional UNIX process and file permissions model. They restrict the = QEMU + process from accessing processes and files on the host system that are n= ot + needed by QEMU. + +- Resource limits and cgroup controllers provide throughput and utilization + limits on key resources such as CPU time, memory, and I/O bandwidth. + +- Linux namespaces can be used to make process, file system, and other sys= tem + resources unavailable to QEMU. A namespaced QEMU process is restricted = to only + those resources that were granted to it. + +- Linux seccomp is available via the QEMU ``--sandbox`` option. It disabl= es + system calls that are not needed by QEMU, thereby reducing the host kern= el + attack surface. + +Sensitive configurations +------------------------ + +There are aspects of QEMU that can have security implications which users & +management applications must be aware of. + +Monitor console (QMP and HMP) +''''''''''''''''''''''''''''' + +The monitor console (whether used with QMP or HMP) provides an interface +to dynamically control many aspects of QEMU's runtime operation. Many of t= he +commands exposed will instruct QEMU to access content on the host file sys= tem +and/or trigger spawning of external processes. + +For example, the ``migrate`` command allows for the spawning of arbitrary +processes for the purpose of tunnelling the migration data stream. The +``blockdev-add`` command instructs QEMU to open arbitrary files, exposing +their content to the guest as a virtual disk. + +Unless QEMU is otherwise confined using technologies such as SELinux, AppA= rmor, +or Linux namespaces, the monitor console should be considered to have priv= ileges +equivalent to those of the user account QEMU is running under. + +It is further important to consider the security of the character device b= ackend +over which the monitor console is exposed. It needs to have protection aga= inst +malicious third parties which might try to make unauthorized connections, = or +perform man-in-the-middle attacks. Many of the character device backends d= o not +satisfy this requirement and so must not be used for the monitor console. + +The general recommendation is that the monitor console should be exposed o= ver +a UNIX domain socket backend to the local host only. Use of the TCP based +character device backend is inappropriate unless configured to use both TLS +encryption and authorization control policy on client connections. + +In summary, the monitor console is considered a privileged control interfa= ce to +QEMU and as such should only be made accessible to a trusted management +application or user. --=20 2.21.1