diff --git a/guides/coco-dev.md b/guides/coco-dev.md index dde9165..fbd5979 100644 --- a/guides/coco-dev.md +++ b/guides/coco-dev.md @@ -77,16 +77,13 @@ and confidential hardware. CoCo has a modular attestation interface and there are a few options for attestation. CoCo provides a generic Key Broker Service (KBS) that the rest of this guide will be focused on. -The SEV runtime class uses `simple-kbs`, which is described in the [SEV guide](../guides/sev.md). ### Select Runtime Class To use CoCo with confidential hardware, first switch to the appropriate runtime class. TDX has one runtime class, `kata-qemu-tdx`. -For SEV(-ES) use the `kata-qemu-sev` runtime class and follow the [SEV guide](../guides/sev.md). - -For SNP, use the `kata-qemu-snp` runtime class and follow the [SNP guide](../guides/snp.md). +For SNP, use the `kata-qemu-snp` runtime class and follow the [SNP guide](https://confidentialcontainers.org/docs/examples/snp-container-launch/). For `enclave-cc` follow the [enclave-cc guide](../guides/enclave-cc.md). diff --git a/guides/sev.md b/guides/sev.md deleted file mode 100644 index 7994c87..0000000 --- a/guides/sev.md +++ /dev/null @@ -1,286 +0,0 @@ -# SEV-ES Guide - -## Platform Setup - - -> [!WARNING] -> -> In order to launch SEV or SNP memory encrypted guests, the host must be prepared with a compatible kernel, `6.8.0-rc5-next-20240221-snp-host-cc2568386`. AMD custom changes and required components and repositories will eventually be upstreamed. - -> [Sev-utils](https://github.com/amd/sev-utils/blob/coco-202402240000/docs/snp.md) is an easy way to install the required host kernel, but it will unnecessarily build AMD compatible guest kernel, OVMF, and QEMU components. The additional components can be used with the script utility to test launch and attest a base QEMU SNP guest. However, for the CoCo use case, they are already packaged and delivered with Kata. -Alternatively, refer to the [AMDESE guide](https://github.com/confidential-containers/amdese-amdsev/tree/amd-snp-202402240000?tab=readme-ov-file#prepare-host) to manually build the host kernel and other components. - -## Getting Started - -This guide covers platform-specific setup for SEV and walks through the complete flows for the different CoCo use cases: - -- [Container Launch with Memory Encryption](#container-launch-with-memory-encryption) -- [Pre-Attestation Utilizing Signed and Encrypted Images](#pre-attestation-utilizing-signed-and-encrypted-images) - -## Container Launch With Memory Encryption - -### Launch a Confidential Service - -To launch a container with SEV memory encryption, the SEV runtime class (`kata-qemu-sev`) must be specified as an annotation in the yaml. A base alpine docker container ([Dockerfile](https://github.com/kata-containers/kata-containers/blob/main/tests/integration/kubernetes/runtimeclass_workloads/confidential/unencrypted/Dockerfile)) has been previously built for testing purposes. This image has also been prepared with SSH access and provisioned with a [SSH public key](https://github.com/kata-containers/kata-containers/blob/main/tests/integration/kubernetes/runtimeclass_workloads/confidential/unencrypted/ssh/unencrypted.pub) for validation purposes. - -Here is a sample service yaml specifying the SEV runtime class: - -```yaml -kind: Service -apiVersion: v1 -metadata: - name: "confidential-unencrypted" -spec: - selector: - app: "confidential-unencrypted" - ports: - - port: 22 ---- -kind: Deployment -apiVersion: apps/v1 -metadata: - name: "confidential-unencrypted" -spec: - selector: - matchLabels: - app: "confidential-unencrypted" - template: - metadata: - labels: - app: "confidential-unencrypted" - annotations: - io.containerd.cri.runtime-handler: kata-qemu-sev - spec: - runtimeClassName: kata-qemu-sev - containers: - - name: "confidential-unencrypted" - image: ghcr.io/kata-containers/test-images:unencrypted-nightly - imagePullPolicy: Always -``` - -Save the contents of this yaml to a file called `confidential-unencrypted.yaml`. - -Start the service: - -```shell -kubectl apply -f confidential-unencrypted.yaml -``` - -Check for errors: - -```shell -kubectl describe pod confidential-unencrypted -``` - -If there are no errors in the Events section, then the container has been successfully created with SEV memory encryption. - -### Validate SEV Memory Encryption - -The container dmesg log can be parsed to indicate that SEV memory encryption is enabled and active. The container image defined in the yaml sample above was built with a predefined key that is authorized for SSH access. - -Get the pod IP: - -```shell -pod_ip=$(kubectl get pod -o wide | grep confidential-unencrypted | awk '{print $6;}') -``` - -Download and save the [SSH private key](https://github.com/kata-containers/kata-containers/raw/main/tests/integration/kubernetes/runtimeclass_workloads/confidential/unencrypted/ssh/unencrypted) and set the permissions. - -```shell -wget https://github.com/kata-containers/kata-containers/raw/main/tests/integration/kubernetes/runtimeclass_workloads/confidential/unencrypted/ssh/unencrypted -O confidential-image-ssh-key - -chmod 600 confidential-image-ssh-key -``` - -The following command will run a remote SSH command on the container to check if SEV memory encryption is active: - -```shell -ssh -i confidential-image-ssh-key \ - -o "StrictHostKeyChecking no" \ - -t root@${pod_ip} \ - 'dmesg | grep "Memory Encryption Features"' -``` - -If SEV is enabled and active, the output should return: - -```shell -[ 0.150045] Memory Encryption Features active: AMD SEV -``` - -## Create an Encrypted Image - -If SSH access to the container is desired, create a keypair: - -```shell -ssh-keygen -t ed25519 -f encrypted-image-tests -P "" -C "" <<< y -``` - -The above command will save the keypair in a file named `encrypted-image-tests`. - -Here is a sample Dockerfile to create a docker image: - -```Dockerfile -FROM alpine:3.16 - -# Update and install openssh-server -RUN apk update && apk upgrade && apk add openssh-server - -# Generate container ssh key -RUN ssh-keygen -t ed25519 -f /etc/ssh/ssh_host_ed25519_key -P "" - -# A password needs to be set for login to work. An empty password is -# unproblematic as password-based login to root is not allowed. -RUN passwd -d root - -# Copy the remote generated public key to the container authorized_keys -# Generate with 'ssh-keygen -t ed25519 -f encrypted-image-tests -P "" -C ""' -COPY encrypted-image-tests.pub /root/.ssh/authorized_keys - -# Entry point - run sshd -ENTRYPOINT /usr/sbin/sshd -D -``` - -Store this `Dockerfile` in the same directory as the `encrypted-image-tests` ssh keypair. - -Build image: - -```shell -docker build -t encrypted-image-tests . -``` - -Tag and upload this unencrypted docker image to a registry: - -```shell -docker tag encrypted-image-tests:latest [REGISTRY_URL]:unencrypted -docker push [REGISTRY_URL]:unencrypted -``` - -Be sure to replace `[REGISTRY_URL]` with the desired registry URL. - -[skopeo](https://github.com/containers/skopeo) is required to encrypt the container image. Follow the instructions here to install `skopeo`: - -[skopeo Installation](https://github.com/containers/skopeo/blob/main/install.md) - -The Attestation Agent hosts a grpc service to support encrypting the image. Clone the repository: - -```shell -attestation_agent_tag="v0.1.0" -git clone https://github.com/confidential-containers/attestation-agent.git -(cd attestation-agent && git checkout -b "branch_${attestation_agent_tag}" "${attestation_agent_tag}") -``` - -Run the offline_fs_kbs: - -```shell -(cd attestation-agent/sample_keyprovider/src/enc_mods/offline_fs_kbs \ -&& cargo run --release --features offline_fs_kbs -- --keyprovider_sock 127.0.0.1:50001 &) -``` - -Create the Attestation Agent keyprovider: - -```shell -cat > attestation-agent/sample_keyprovider/src/enc_mods/offline_fs_kbs/ocicrypt.conf < keys.json < [!WARNING] -> -> In order to launch SEV or SNP memory encrypted guests, the host must be prepared with a compatible kernel, `6.8.0-rc5-next-20240221-snp-host-cc2568386`. AMD custom changes and required components and repositories will eventually be upstreamed. - -> [Sev-utils](https://github.com/amd/sev-utils/blob/coco-202402240000/docs/snp.md) is an easy way to install the required host kernel, but it will unnecessarily build AMD compatible guest kernel, OVMF, and QEMU components. The additional components can be used with the script utility to test launch and attest a base QEMU SNP guest. However, for the CoCo use case, they are already packaged and delivered with Kata. - -Alternatively, refer to the [AMDESE guide](https://github.com/confidential-containers/amdese-amdsev/tree/amd-snp-202402240000?tab=readme-ov-file#prepare-host) to manually build the host kernel and other components. - -## Getting Started - -This guide covers platform-specific setup for SNP and walks through the complete flows for the different CoCo use cases: - -- [Container Launch with Memory Encryption](#container-launch-with-memory-encryption) - -## Container Launch With Memory Encryption - -### Launch a Confidential Service - -To launch a container with SNP memory encryption, the SNP runtime class (`kata-qemu-snp`) must be specified as an annotation in the yaml. A base alpine docker container ([Dockerfile](https://github.com/kata-containers/kata-containers/blob/main/tests/integration/kubernetes/runtimeclass_workloads/confidential/unencrypted/Dockerfile)) has been previously built for testing purposes. This image has also been prepared with SSH access and provisioned with a [SSH public key](https://github.com/kata-containers/kata-containers/blob/main/tests/integration/kubernetes/runtimeclass_workloads/confidential/unencrypted/ssh/unencrypted.pub) for validation purposes. - -Here is a sample service yaml specifying the SNP runtime class: - -```yaml -kind: Service -apiVersion: v1 -metadata: - name: "confidential-unencrypted" -spec: - selector: - app: "confidential-unencrypted" - ports: - - port: 22 ---- -kind: Deployment -apiVersion: apps/v1 -metadata: - name: "confidential-unencrypted" -spec: - selector: - matchLabels: - app: "confidential-unencrypted" - template: - metadata: - labels: - app: "confidential-unencrypted" - annotations: - io.containerd.cri.runtime-handler: kata-qemu-snp - spec: - runtimeClassName: kata-qemu-snp - containers: - - name: "confidential-unencrypted" - image: ghcr.io/kata-containers/test-images:unencrypted-nightly - imagePullPolicy: Always -``` - -Save the contents of this yaml to a file called `confidential-unencrypted.yaml`. - -Start the service: - -```shell -kubectl apply -f confidential-unencrypted.yaml -``` - -Check for errors: - -```shell -kubectl describe pod confidential-unencrypted -``` - -If there are no errors in the Events section, then the container has been successfully created with SNP memory encryption. - -### Validate SNP Memory Encryption - -The container dmesg log can be parsed to indicate that SNP memory encryption is enabled and active. The container image defined in the yaml sample above was built with a predefined key that is authorized for SSH access. - -Get the pod IP: - -```shell -pod_ip=$(kubectl get pod -o wide | grep confidential-unencrypted | awk '{print $6;}') -``` - -Download and save the SSH private key and set the permissions. - -```shell -wget https://github.com/kata-containers/kata-containers/raw/main/tests/integration/kubernetes/runtimeclass_workloads/confidential/unencrypted/ssh/unencrypted -O confidential-image-ssh-key - -chmod 600 confidential-image-ssh-key -``` - -The following command will run a remote SSH command on the container to check if SNP memory encryption is active: - -```shell -ssh -i confidential-image-ssh-key \ - -o "StrictHostKeyChecking no" \ - -t root@${pod_ip} \ - 'dmesg | grep "Memory Encryption Features""' -``` - -If SNP is enabled and active, the output should return: - -```shell -[ 0.150045] Memory Encryption Features active: AMD SNP -``` \ No newline at end of file diff --git a/quickstart.md b/quickstart.md index 90de93d..59e9218 100644 --- a/quickstart.md +++ b/quickstart.md @@ -22,7 +22,7 @@ hardware support and limitations. You can enable Confidential Containers in an existing Kubernetes cluster using the Confidential Containers Operator. When installation is finished, your cluster will have new runtime classes for different hardware platforms, including a generic runtime for testing CoCo without confidential hardware support, a runtime using a remote hypervisor -that allows for cloud integration, a runtime for process-based isolation using SGX, as well as runtimes for TDX and SEV. +that allows for cloud integration, a runtime for process-based isolation using SGX, as well as runtimes for TDX and SNP. ## Prerequisites @@ -148,7 +148,6 @@ Details on each of the runtime classes: - *kata-clh* - standard kata runtime using the cloud hypervisor - *kata-qemu* - same as kata - *kata-qemu-coco-dev* - standard kata runtime using the QEMU hypervisor including all CoCo building blocks for a non CC HW -- *kata-qemu-sev* - using QEMU, and support for AMD SEV HW - *kata-qemu-snp* - using QEMU, and support for AMD SNP HW - *kata-qemu-tdx* -using QEMU, and support Intel TDX HW based on what's provided by [Ubuntu](https://github.com/canonical/tdx) and [CentOS 9 Stream](https://sigs.centos.org/virt/tdx/). @@ -202,8 +201,7 @@ With some TEEs, the CoCo use cases and/or configurations are implemented differe [guide](./guides) section. To get started using CoCo without TEE hardware, follow the CoCo-dev guide below: - [CoCo-dev](./guides/coco-dev.md) -- [SEV(-ES)](./guides/sev.md) -- [SNP](./guides/snp.md) +- [SNP](https://confidentialcontainers.org/docs/getting-started/prerequisites/hardware/snp/) - TDX: No additional steps required. - [SGX](./guides/enclave-cc.md) - [IBM Secure Execution](./guides/ibm-se.md)