From nobody Wed Oct 23 01:24:37 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; 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=pass(p=none dis=none) header.from=gmail.com ARC-Seal: i=1; a=rsa-sha256; t=1726998343; cv=none; d=zohomail.com; s=zohoarc; b=lzvWa6mVB2Y4g4LrkrfOGfX94kh0LY/cbUekzd11L0QHEnuvWDvPdOXVmS/WghsXqyTG8cvOmr6HUxZW0KFb+7s2UmOwfJDHNsUfp5Io4nUJXvaya8rMCJUKNokJtdtEsknuwIW5fODCkmlz0asAn3hGgWQQAK2SG5lZA2jUTp0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1726998343; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=XAM2ajGai7aizJdmXhXNlKOjlJgI3eHk1Fp7U2UEh0k=; b=ikAcLmCl2p2s89aJehkKrbYUlUv6LiLSwW9RUpb28odSW5vJlFh81f6JJjOzsc7WPN2iMJP5GDv9vTlR0uNSTkejwf/bX0uAH51Q7tLWsiNChiYje0oQx25BAkvRAe5fqAA8/fv1f+KlJX6nDIbDauKb0p/mvwTyr2YMgt1poBE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; 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=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1726998343552240.24374316920637; Sun, 22 Sep 2024 02:45:43 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ssJ9T-0000FZ-JY; Sun, 22 Sep 2024 05:45:11 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ssJ9S-0000A1-4N for qemu-devel@nongnu.org; Sun, 22 Sep 2024 05:45:10 -0400 Received: from mail-pl1-x632.google.com ([2607:f8b0:4864:20::632]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ssJ9Q-0005tw-3Z for qemu-devel@nongnu.org; Sun, 22 Sep 2024 05:45:09 -0400 Received: by mail-pl1-x632.google.com with SMTP id d9443c01a7336-20570b42f24so36989945ad.1 for ; Sun, 22 Sep 2024 02:45:07 -0700 (PDT) Received: from localhost.localdomain ([103.103.35.151]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-20794735810sm117622885ad.278.2024.09.22.02.45.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 22 Sep 2024 02:45:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1726998306; x=1727603106; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=XAM2ajGai7aizJdmXhXNlKOjlJgI3eHk1Fp7U2UEh0k=; b=cYYBhlNJ8YI3fcr7x6i+M9IGDk1U5MCmG0udaMdPURS2YoE4C9f7x+oRNKtudTiF9E HAXx/L9lZGflk8uv0PJYMqJh1dkzeGqN+3nHNmxXaY+zs/oVhPq7++9I99hxa0wMPZdQ zqY2bX594ZYtiiiTZU6bhI7XMzV8v6RKchu4XHmUubF/dbPdN/2qYCdWSbL2d6kkxCjM 1V3iuWSbFoDIBAx6hEcSd/9NXP75Be/ZkIx0AJvDcdnwUzioyXtT+Ntg504PBVsfszy9 flZzkfzphjcgu0AguqpczswuMAB9n5K3KGu40D19xFUfV3GqkRBkVXlAGWd+3+mfom5A Xz3Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1726998306; x=1727603106; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=XAM2ajGai7aizJdmXhXNlKOjlJgI3eHk1Fp7U2UEh0k=; b=brhZ9vhskkl4V8MjruKx+otZaQ+K8XdSqL65O+I0J5/Fd2lXA6eAYhIolXgnrTWySV x6RZN4oM+oI7ApFusVGJ6snSk0cLuTilwwD3XmtjQA0nNd5jWTJaHnjZKog75sgI3Hxz Yh3ghULZHWeQw1Vg+QD7YO3Dn8N0UoI59ClldoOsh1iEoklh2VKgRSumOuka8VMT0b69 pkk52oMEaipXJcv5+aW0tLPcCxwpBzELQi7FjdQhEeLjpYC1W4hgAorQIhjgSCqxR/cR RIlWt+rx73Zg+VBLKSfu8mmQKKgoFKIYF66qFgzscMH1p+NGsNYSH/34iK02E3Gwi9n0 ICDQ== X-Gm-Message-State: AOJu0YxsIf31bwtQ2fqE4U5f0nUQr2/NbGzUp35ob7qBeFBMUZbccCJ8 WLpLNGyEMJQMrR1OEtRwLnD7aFctYF7ee2a7ULUqf6wkGR6M28O1Tf3u3A== X-Google-Smtp-Source: AGHT+IETWuhynzPBKF40CXNcAPqhHGXJjOT4TOdmYGtfBrrbcOIZdCU3g+w+7AceVT/NVL1sFIUlgA== X-Received: by 2002:a17:902:e80d:b0:202:2cd5:2095 with SMTP id d9443c01a7336-208d8343d38mr118106305ad.18.1726998305990; Sun, 22 Sep 2024 02:45:05 -0700 (PDT) From: Dorjoy Chowdhury To: qemu-devel@nongnu.org Cc: graf@amazon.com, agraf@csgraf.de, stefanha@redhat.com, pbonzini@redhat.com, slp@redhat.com, richard.henderson@linaro.org, eduardo@habkost.net, mst@redhat.com, marcel.apfelbaum@gmail.com, berrange@redhat.com, philmd@linaro.org Subject: [PATCH v7 5/5] docs/nitro-enclave: Documentation for nitro-enclave machine type Date: Sun, 22 Sep 2024 15:44:41 +0600 Message-Id: <20240922094441.23802-6-dorjoychy111@gmail.com> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20240922094441.23802-1-dorjoychy111@gmail.com> References: <20240922094441.23802-1-dorjoychy111@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable 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; Received-SPF: pass client-ip=2607:f8b0:4864:20::632; envelope-from=dorjoychy111@gmail.com; helo=mail-pl1-x632.google.com X-Spam_score_int: 15 X-Spam_score: 1.5 X-Spam_bar: + X-Spam_report: (1.5 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_ENVFROM_END_DIGIT=0.25, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_SBL_CSS=3.335, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @gmail.com) X-ZM-MESSAGEID: 1726998345341116600 Content-Type: text/plain; charset="utf-8" Signed-off-by: Dorjoy Chowdhury --- MAINTAINERS | 1 + docs/system/i386/nitro-enclave.rst | 78 ++++++++++++++++++++++++++++++ 2 files changed, 79 insertions(+) create mode 100644 docs/system/i386/nitro-enclave.rst diff --git a/MAINTAINERS b/MAINTAINERS index 37411dfffa..ca06473869 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1877,6 +1877,7 @@ F: hw/core/eif.c F: hw/core/eif.h F: hw/i386/nitro_enclave.c F: include/hw/i386/nitro_enclave.h +F: docs/system/i386/nitro-enclave.rst =20 Machine core M: Eduardo Habkost diff --git a/docs/system/i386/nitro-enclave.rst b/docs/system/i386/nitro-en= clave.rst new file mode 100644 index 0000000000..3fb9e06893 --- /dev/null +++ b/docs/system/i386/nitro-enclave.rst @@ -0,0 +1,78 @@ +'nitro-enclave' virtual machine (``nitro-enclave``) +=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=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D + +``nitro-enclave`` is a machine type which emulates an ``AWS nitro enclave`` +virtual machine. `AWS nitro enclaves`_ is an `Amazon EC2`_ feature that al= lows +creating isolated execution environments, called enclaves, from Amazon EC2 +instances which are used for processing highly sensitive data. Enclaves ha= ve +no persistent storage and no external networking. The enclave VMs are based +on Firecracker microvm with a vhost-vsock device for communication with the +parent EC2 instance that spawned it and a Nitro Secure Module (NSM) device +for cryptographic attestation. The parent instance VM always has CID 3 whi= le +the enclave VM gets a dynamic CID. Enclaves use an EIF (`Enclave Image For= mat`_) +file which contains the necessary kernel, cmdline and ramdisk(s) to boot. + +In QEMU, ``nitro-enclave`` is a machine type based on ``microvm`` similar = to how +``AWS nitro enclaves`` are based on ``Firecracker`` microvm. This is usefu= l for +local testing of EIF files using QEMU instead of running real AWS Nitro En= claves +which can be difficult for debugging due to its roots in security. The vso= ck +device emulation is done using vhost-user-vsock which means another proces= s that +can do the userspace emulation, like `vhost-device-vsock`_ from rust-vmm c= rate, +must be run alongside nitro-enclave for the vsock communication to work. + +``libcbor`` and ``gnutls`` are required dependencies for nitro-enclave mac= hine +support to be added when building QEMU from source. + +.. _AWS nitro enlaves: https://docs.aws.amazon.com/enclaves/latest/user/ni= tro-enclave.html +.. _Amazon EC2: https://aws.amazon.com/ec2/ +.. _Enclave Image Format: https://github.com/aws/aws-nitro-enclaves-image-= format +.. _vhost-device-vsock: https://github.com/rust-vmm/vhost-device/tree/main= /vhost-device-vsock + +Using the nitro-enclave machine type +------------------------------ + +Machine-specific options +~~~~~~~~~~~~~~~~~~~~~~~~ + +It supports the following machine-specific options: + +- nitro-enclave.vsock=3Dstring (required) (Id of the chardev from '-charde= v' option that vhost-user-vsock device will use) +- nitro-enclave.id=3Dstring (optional) (Set enclave identifier) +- nitro-enclave.parent-role=3Dstring (optional) (Set parent instance IAM r= ole ARN) +- nitro-enclave.parent-id=3Dstring (optional) (Set parent instance identif= ier) + + +Running a nitro-enclave VM +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +First, run `vhost-device-vsock`_ (or a similar tool that supports vhost-us= er-vsock). +The forward-cid option below with value 1 forwards all connections from th= e enclave +VM to the host machine and the forward-listen (port numbers separated by '= +') is used +for forwarding connections from the host machine to the enclave VM. + + $ vhost-device-vsock \ + --vm guest-cid=3D4,forward-cid=3D1,forward-listen=3D9001+9002,socket= =3D/tmp/vhost4.socket + +Now run the necessary applications on the host machine so that the nitro-e= nclave VM +applications' vsock communication works. For example, the nitro-enclave VM= 's init +process connects to CID 3 and sends a single byte hello heartbeat (0xB7) t= o let the +parent VM know that it booted expecting a heartbeat (0xB7) response. So yo= u must run +a AF_VSOCK server on the host machine that listens on port 9000 and sends = the heartbeat +after it receives the heartbeat for enclave VM to boot successfully. You s= hould run all +the applications on the host machine that would typically be running in th= e parent EC2 +VM for successful communication with the enclave VM. + +Then run the nitro-enclave VM using the following command where ``hello.ei= f`` is +an EIF file you would use to spawn a real AWS nitro enclave virtual machin= e: + + $ qemu-system-x86_64 -M nitro-enclave,vsock=3Dc,id=3Dhello-world \ + -kernel hello-world.eif -nographic -m 4G --enable-kvm -cpu host \ + -chardev socket,id=3Dc,path=3D/tmp/vhost4.socket + +In this example, the nitro-enclave VM has CID 4. If there are applications= that +connect to the enclave VM, run them on the host machine after enclave VM s= tarts. +You need to modify the applications to connect to CID 1 (instead of the en= clave +VM's CID) and use the forward-listen (e.g., 9001+9002) option of vhost-dev= ice-vsock +to forward the ports they connect to. + +.. _vhost-device-vsock: https://github.com/rust-vmm/vhost-device/tree/main= /vhost-device-vsock#using-the-vsock-backend --=20 2.39.5