From patchwork Thu Aug 22 15:08:41 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dorjoy Chowdhury X-Patchwork-Id: 13773702 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id A2FABC5321D for ; Thu, 22 Aug 2024 15:10:07 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sh9R8-0007Qg-BX; Thu, 22 Aug 2024 11:09:21 -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 1sh9R0-0007OC-8F for qemu-devel@nongnu.org; Thu, 22 Aug 2024 11:09:12 -0400 Received: from mail-pj1-x102d.google.com ([2607:f8b0:4864:20::102d]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sh9Qx-000504-Sl for qemu-devel@nongnu.org; Thu, 22 Aug 2024 11:09:09 -0400 Received: by mail-pj1-x102d.google.com with SMTP id 98e67ed59e1d1-2d427fb7c92so715514a91.1 for ; Thu, 22 Aug 2024 08:09:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1724339346; x=1724944146; darn=nongnu.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=X1UhToeBVg/MrM0YCqmJBUVyOAKXdnnoybA03epgNJA=; b=XTRB+ZTY03OjF4p49pvilxMXTLp9kqc80dsSBUijzNsH/XrcTMTehyN7f9WY1sW4Ny KFI0dqKc48eojlRicqVY7iiY5fGs6oobXf9i3ZhbAsCKweNaPGmtATw7V597CNwHSUc0 BP9ToGGi9th6kKZLim6k/887WjM5zs6Ekz10s0ClE5hri+tF2guSBXsYzcKHdtS69B/R 2TypJ4k2UevbBCsV2redVpR3G2PunpMX/+/9yxsWpoET46Y3HF9QtPUaF+ZfEcJu8GzP NN6Zs6Zk1lerm3P4/BtPB+E/vN1eGFPXGfeyr0mvSPzefUdGkwnFtkn4lsb0sE9Njxpk foqA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724339346; x=1724944146; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=X1UhToeBVg/MrM0YCqmJBUVyOAKXdnnoybA03epgNJA=; b=T7/cOkx5KIuiLhuMTAnwBsiSIpv6qceDfnzk6Wbp7polGTwKscT3Zzo67LM5mb34jT /mETRv7TuQnPU+l+ortMuyGzAGpwrD0wKqXHf/hL8T0BM8Kd44P1lcA8sA9g29uyi5FX le7J1FekZBLtP9UzgFzbekur2jJg9e1DvgwjDc1Lbq+Vfq//w38MVwcLtpewv/gDZcWk X4GPv7FPUKCYFTfPWANYnNLWNzG2VnWzZ4/AklgmqBFVB8PW1H1kd6xynSDDFAS9KfH0 HZAh41/1+1EGDLz6NTaaJoz3/yg+iBZ+YIOKIcM+Pw5JIs+xqLRlix8bys5QL2njgMyR c8ZA== X-Gm-Message-State: AOJu0YyfoFzl7RCHsNqocXuP15Q4z4/RFtPdBwjzxivCZKomdw6w/3ac TFuz15I3RxWF1MHCTZfcIrd2H+yTtjBSGfEQw0fStqY7zISnl5BhWfyhfIHT X-Google-Smtp-Source: AGHT+IHP8K12csu9/E3dbDw3Z0Y6N6ayGbv4X9B98t2MvcFA939B5R8azuUnLeRCZDNSMIdHHD09Vw== X-Received: by 2002:a17:90b:1c0f:b0:2cd:b915:c80b with SMTP id 98e67ed59e1d1-2d61716ff6bmr2569822a91.27.1724339345607; Thu, 22 Aug 2024 08:09:05 -0700 (PDT) Received: from localhost.localdomain ([103.103.35.175]) by smtp.gmail.com with ESMTPSA id 98e67ed59e1d1-2d613919fd2sm1991567a91.13.2024.08.22.08.08.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 22 Aug 2024 08:09: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 v5 0/8] AWS Nitro Enclave emulation support Date: Thu, 22 Aug 2024 21:08:41 +0600 Message-Id: <20240822150849.21759-1-dorjoychy111@gmail.com> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 Received-SPF: pass client-ip=2607:f8b0:4864:20::102d; envelope-from=dorjoychy111@gmail.com; helo=mail-pj1-x102d.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, T_SCC_BODY_TEXT_LINE=-0.01 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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org This is v5 submission for AWS Nitro Enclave emulation in QEMU. From the QEMU side the implementation for nitro enclaves is complete. v4 is at: https://mail.gnu.org/archive/html/qemu-devel/2024-08/msg02675.html Changes in v5: - bunch of use of glib utilities like g_autofree, g_memdup2, GList etc - updated libvirt-ci and added libcbor dependency - files in this patch are built under libcbor and gnutls dependency check now and libcbor dependency has been moved to root meson.build file - separated and re-ordered commits as suggested - user_data and nonce are added as null to attestation when empty and payload_map_size is fixed - variables in eif.c have been shortened for readability Changes in v4: - fixed error_setv assertion failed. I could not reproduce this but I think this was happening because I did not set Error *err = NULL in x86_load_eif - qemu_cbor.. helpers moved to a separate file now - libcbor version requirement reduced from 0.8.0 to 0.7.0 - replaced GChecksum uses with qcrypto apis - timestamp multiplied by 1000 in virtio-nsm - user_data and nonce are now included in attestation even when they are empty - added x509-utils in crypto - added G_CHECKSUM_SHA384 support in hash-glib.c - PCR3 and PCR4 can be set from nitro-enclave machine options. I did not add the options for virtio-nsm device though. I think the PCR states are set by machines so it made sense to add the options for machine only. Changes in v3: - Support for virtio-nsm device - The EIF related logic has been removed from microvm.c i.e., the logic is contained in enclave related code - For vsock emulation in nitro-enclave, now vhost-user-vsock is being used instead of vhost-vsock (more details in the cover-letter below) - updated documentation accordingly Changes in v2: - moved eif.c and eif.h files from hw/i386 to hw/core Hi, Hope everyone is doing well. This is a patch series adding AWS Nitro Enclave[1] emulation support in QEMU. Alexander Graf is mentoring me on this work. I have a gitlab branch where you can view the patches in the gitlab web UI for each commit: https://gitlab.com/dorjoy03/qemu/-/tree/nitro-enclave-emulation AWS nitro enclaves is an Amazon EC2[2] feature that allows creating isolated execution environments, called enclaves, from Amazon EC2 instances, which are used for processing highly sensitive data. Enclaves have no persistent storage and no external networking. The enclave VMs are based on Firecracker microvm and have 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 while the enclave VM gets a dynamic CID. The enclave VMs can communicate with the parent instance over various ports to CID 3, for example, the init process inside an enclave sends a heartbeat to port 9000 upon boot, expecting a heartbeat reply, letting the parent instance know that the enclave VM has successfully booted. From inside an EC2 instance, nitro-cli[3] is used to spawn an enclave VM using an EIF (Enclave Image Format)[4] file. EIF files can be built using nitro-cli as well. The EIF specification can be found in the README of the github aws-nitro-enclaves-image-format repository[4]. An EIF file contains the kernel, cmdline and ramdisk(s) in different sections which are used to boot the enclave VM. Adding nitro enclave emulation support in QEMU will make the life of AWS Nitro Enclave users easier as they will be able to test their EIF images locally without having to run real nitro enclaves which can be difficult for debugging due to its roots in security. This will also make quick prototyping easier. In QEMU, the new nitro-enclave machine type is implemented based on the microvm machine type similar to how AWS Nitro Enclaves are based on Firecracker microvm. The vsock emulation support is added using vhost-user-vsock device. This is needed as nitro VMs always talk to parent VM (CID 3) but there is no support for sibling VM communication in vhost-vsock. So to run nitro-enclave, a process that does vsock emulation in user-space like vhost-device-vsock[5] from rust-vmm must be run. I am working on adding proxying using vsock (right now it uses unix domain socket) to the host machine in vhost-device-vsock which I have already posted a PR[6] in rust-vmm repo. This will allow users to run the necessary parent VM applications in the host machine instead of a separate VM with CID 3. A new device virtio-nsm support has been added to QEMU. This device is built-into the nitro-enclave VM. The virtio-nsm spec can be found here[7]. For local testing you need to generate a hello.eif image by first building nitro-cli locally[8]. Then you can use nitro-cli to build a hello.eif image[9]. More details about testing can be found in the docs/system/i386/nitro-enclave.rst file. Thanks. Regards, Dorjoy [1] https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html [2] https://aws.amazon.com/ec2/ [3] https://docs.aws.amazon.com/enclaves/latest/user/getting-started.html [4] https://github.com/aws/aws-nitro-enclaves-image-format?tab=readme-ov-file#enclave-image-file-eif-specification [5] https://github.com/rust-vmm/vhost-device/tree/main/vhost-device-vsock [6] https://github.com/rust-vmm/vhost-device/pull/706 [7] https://lists.oasis-open.org/archives/virtio-comment/202310/msg00387.html [8] https://github.com/aws/aws-nitro-enclaves-cli/blob/main/docs/ubuntu_20.04_how_to_install_nitro_cli_from_github_sources.md [9] https://github.com/aws/aws-nitro-enclaves-cli/blob/main/examples/x86_64/hello/README.md Dorjoy Chowdhury (8): crypto: Define macros for hash algorithm digest lengths crypto: Support SHA384 hash when using glib crypto: Introduce x509 utils tests/lcitool: Update libvirt-ci and add libcbor dependency device/virtio-nsm: Support for Nitro Secure Module device hw/core: Add Enclave Image Format (EIF) related helpers machine/nitro-enclave: New machine type for AWS Nitro Enclaves docs/nitro-enclave: Documentation for nitro-enclave machine type .gitlab-ci.d/cirrus/macos-13.vars | 2 +- .gitlab-ci.d/cirrus/macos-14.vars | 2 +- MAINTAINERS | 19 + backends/hostmem-memfd.c | 2 - configs/devices/i386-softmmu/default.mak | 1 + crypto/hash-glib.c | 2 +- crypto/hash.c | 14 +- crypto/meson.build | 4 + crypto/x509-utils.c | 75 + docs/system/i386/nitro-enclave.rst | 85 + hw/core/eif.c | 719 ++++++++ hw/core/eif.h | 22 + hw/core/machine.c | 71 +- hw/core/meson.build | 3 + hw/i386/Kconfig | 6 + hw/i386/meson.build | 3 + hw/i386/microvm.c | 6 +- hw/i386/nitro_enclave.c | 355 ++++ hw/virtio/Kconfig | 5 + hw/virtio/cbor-helpers.c | 326 ++++ hw/virtio/meson.build | 6 + hw/virtio/virtio-nsm-pci.c | 73 + hw/virtio/virtio-nsm.c | 1638 +++++++++++++++++ include/crypto/hash.h | 8 + include/crypto/x509-utils.h | 22 + include/hw/boards.h | 2 + include/hw/i386/microvm.h | 2 + include/hw/i386/nitro_enclave.h | 62 + include/hw/virtio/cbor-helpers.h | 46 + include/hw/virtio/virtio-nsm.h | 59 + include/sysemu/hostmem.h | 2 + meson.build | 2 + .../ci/setup/ubuntu/ubuntu-2204-aarch64.yaml | 1 + .../ci/setup/ubuntu/ubuntu-2204-s390x.yaml | 1 + tests/docker/dockerfiles/alpine.docker | 1 + .../dockerfiles/debian-amd64-cross.docker | 1 + .../dockerfiles/debian-arm64-cross.docker | 1 + .../dockerfiles/debian-armel-cross.docker | 1 + .../dockerfiles/debian-armhf-cross.docker | 1 + .../dockerfiles/debian-i686-cross.docker | 1 + .../dockerfiles/debian-mips64el-cross.docker | 1 + .../dockerfiles/debian-mipsel-cross.docker | 1 + .../dockerfiles/debian-ppc64el-cross.docker | 1 + .../dockerfiles/debian-s390x-cross.docker | 1 + tests/docker/dockerfiles/debian.docker | 1 + tests/docker/dockerfiles/fedora.docker | 1 + tests/docker/dockerfiles/opensuse-leap.docker | 3 +- tests/docker/dockerfiles/ubuntu2204.docker | 1 + tests/lcitool/libvirt-ci | 2 +- tests/lcitool/projects/qemu.yml | 1 + 50 files changed, 3617 insertions(+), 48 deletions(-) create mode 100644 crypto/x509-utils.c create mode 100644 docs/system/i386/nitro-enclave.rst create mode 100644 hw/core/eif.c create mode 100644 hw/core/eif.h create mode 100644 hw/i386/nitro_enclave.c create mode 100644 hw/virtio/cbor-helpers.c create mode 100644 hw/virtio/virtio-nsm-pci.c create mode 100644 hw/virtio/virtio-nsm.c create mode 100644 include/crypto/x509-utils.h create mode 100644 include/hw/i386/nitro_enclave.h create mode 100644 include/hw/virtio/cbor-helpers.h create mode 100644 include/hw/virtio/virtio-nsm.h