Home GitHub
Buckit Object Storage User Guide

Server-Side Object Encryption with KES

This procedure assumes you have access to a Kubernetes cluster with an active Buckit Operator installation. For instructions on running KES, see the KES docs.

As part of this procedure, you will:

  1. Create or modify a Buckit deployment with support for SSE using KES. Defer to the Deploy Distributed Buckit tutorial for guidance on production-ready Buckit deployments.

  2. Use the Buckit Operator Console to create or manage a Buckit Tenant.

  3. Access the Encryption settings for that tenant and configure SSE using a supported Key Management System.

  4. Create a new EK for use with SSE.

  5. Configure automatic bucket-default SSE-KMS.

This procedure provides guidance for deploying Buckit configured to use KES and enable Server Side Encryption. For instructions on running KES, see the KES docs.

As part of this procedure, you will:

  1. Create a new EK for use with SSE.

  2. Create or modify a Buckit deployment with support for SSE using KES. Defer to the Deploy Distributed Buckit tutorial for guidance on production-ready Buckit deployments.

  3. Configure automatic bucket-default SSE-KMS

Important

Enabling SSE on a Buckit deployment automatically encrypts the backend data for that deployment using the default encryption key.

Buckit requires access to KES and the external KMS to decrypt the backend and start normally. The KMS must maintain and provide access to the MINIO_KMS_KES_KEY_NAME. You cannot disable KES later or “undo” the SSE configuration at a later point.

Prerequisites

Access to Buckit Cluster

You must have access to the Kubernetes cluster, with administrative permissions associated to your kubectl configuration.

This procedure assumes your permission sets extends sufficiently to support deployment or modification of Buckit-associated resources on the Kubernetes cluster, including but not limited to pods, statefulsets, replicasets, deployments, and secrets.

This procedure uses bm for performing operations on the Buckit cluster. Install bm on a machine with network access to the cluster. See the bm Installation Quickstart for instructions on downloading and installing bm.

This procedure assumes a configured alias for the Buckit cluster.

Ensure KES Access to a Supported KMS Target

This procedure assumes an existing supported KMS installation accessible from the Kubernetes cluster.

  • For deployments within the same Kubernetes cluster as the Buckit Tenant, you can use Kubernetes service names to allow the Buckit Tenant to establish connectivity to the target KMS service.

  • For deployments external to the Kubernetes cluster, you must ensure the cluster supports routing communications between Kubernetes services and pods and the external network. This may require configuration or deployment of additional Kubernetes network components and/or enabling access to the public internet.

Defer to the documentation for your chosen KMS solution for guidance on deployment and configuration.

This procedure assumes an existing KES installation connected to a supported KMS installation accessible, both accessible from the local host. Refer to the installation instructions for your supported KMS target to deploy KES and connect it to a KMS solution.

KES Operations Require Unsealed Target

Some supported KMS targets allow you to seal or unseal the vault instance. KES returns an error if the configured KMS service is sealed.

If you restart or otherwise seal your vault instance, KES cannot perform any cryptographic operations against the vault. You must unseal the Vault to ensure normal operations.

See the documentation for your chosen KMS solution for more information on whether unsealing may be required.

Refer to the configuration instruction in the KES documentation for your chosen supported KMS:

Procedure

This procedure provides instructions for configuring and enabling Server-Side Encryption using your selected supported KMS solution in production environments. Specifically, this procedure assumes the following:

  • An existing production-grade KMS target

  • One or more KES servers connected to the KMS target

  • One or more hosts for a new or existing Buckit deployment

  1. Review the Tenant CRD

    Review the TenantSpec.kes object, the TenantSpec.configuration object, and the KES Configuration reference.

    You must prepare all necessary configurations associated to your external Key Management Service of choice before proceeding.

  2. Create or Modify your Tenant YAML to set the values of KesConfig as necessary:

    You must modify your Tenant YAML or Kustomize templates to reflect the necessary KES configuration. The following example is taken from the Buckit Operator Kustomize examples

    kes:
   image: "" # minio/kes:2024-06-17T15-47-05Z
   env: [ ]
   replicas: 2
   kesSecret:
      name: kes-configuration
   imagePullPolicy: "IfNotPresent"

    The kes-configuration secret must reference a Kubernetes Opaque Secret which contains a stringData object with the full KES configuration as server-config.yaml. The keystore field must contain the full configuration associated with your preferred Key Management System.

    Reference the Kustomize example for additional guidance.

  3. Create or Modify your Tenant YAML to set the values of TenantSpec.configuration as necessary.

    TODO

  4. Generate a New Encryption Key

    Unseal Vault Before Creating Key

    If required by your chosen provider, you must unseal the backing vault instance before creating new encryption keys. See the documentation for your chosen KMS solution for more information.

    Buckit requires that the EK for a given bucket or object exist on the root KMS before performing SSE operations using that key. You can use the bm admin kms key create command against the Buckit Tenant.

    You must ensure your local host can access the Buckit Tenant pods and services before using bm to manage the Tenant. For hosts internal to the Kubernetes cluster, you can use the service DNS name. For hosts external to the Kubernetes cluster, specify the hostname of the service exposed by Ingress, Load Balancer, or similar Kubernetes network control component.

    Run this command in a separate Terminal or Shell:

    # Replace '-n minio' with the namespace of the Buckit deployment
# If you deployed the Tenant without TLS you may need to change the port range

# You can validate the ports in use by running
#  kubectl get svc/minio -n minio

kubectl port forward svc/minio 443:443 -n minio

    The following commands in a new Terminal or Shell window:

    • Connect a local bm client to the Tenant.

    • Create the encryption key.

    See Quickstart for instructions on installing bm on your local host.

    # Replace USERNAME and PASSWORD with a user on the tenant with administrative permissions
# such as the root user

bm alias add k8s https://localhost:443 ROOTUSER ROOTPASSWORD

# Replace my-new-key with the name of the key you want to use for SSE-KMS
bm admin kms key create k8s encrypted-bucket-key

  5. Enable SSE-KMS for a Bucket

    You can use either the Buckit Tenant Console or the Buckit bm CLI to enable bucket-default SSE-KMS with the generated key:

    Connect to the Buckit Tenant Console service and log in. For clients internal to the Kubernetes cluster, you can specify the service DNS name. For clients external to the Kubernetes cluster, specify the hostname of the service exposed by Ingress, Load Balancer, or similar Kubernetes network control component.

    Once logged in, create a new Bucket and name it to your preference. Select the Gear icon to open the management view.

    Select the pencil icon next to the Encryption field to open the modal for configuring a bucket default SSE scheme.

    Select SSE-KMS, then enter the name of the key created in the previous step.

    Once you save your changes, try to upload a file to the bucket. When viewing that file in the object browser, note that in the sidebar the metadata includes the SSE encryption scheme and information on the key used to encrypt that object. This indicates the successful encrypted state of the object.

    Use the Buckit API service to create a new alias for the Buckit deployment. You can then use the bm encrypt set command to enable SSE-KMS encryption for a bucket:

    bm alias set k8s https://minio.minio-tenant-1.svc.cluster-domain.example:443 ROOTUSER ROOTPASSWORD

bm mb k8s/encryptedbucket
bm encrypt set SSE-KMS encrypted-bucket-key k8s/encryptedbucket

    For clients external to the Kubernetes cluster, specify the hostname of the service exposed by Ingress, Load Balancer, or similar Kubernetes network control component.

    Write a file to the bucket using bm cp or any S3-compatible SDK with a PutObject function. You can then run bm stat on the file to confirm the associated encryption metadata.

  1. Generate a KES API Key for use by Buckit

    Use the kes identity new command to generate a new API key for use by the Buckit Server:

    kes identity new

    The output includes both the API Key for use with Buckit and the Identity hash for use with the KES Policy configuration.

  2. Configure the Buckit Environment File

    Create or modify the Buckit Server environment file for all hosts in the target deployment to include the following environment variables:

    Add the following lines to the Buckit Environment file on each Buckit host. See the tutorials for Installation and Management, Installation and Management, or Installation and Management for more detailed descriptions of a base Buckit environment file.

    # Add these environment variables to the existing environment file

MINIO_KMS_KES_ENDPOINT=https://HOSTNAME:7373
MINIO_KMS_KES_API_KEY="kes:v1:ACTpAsNoaGf2Ow9o5gU8OmcaG6Af/VcZ1Mt7ysuKoBjv"

# Allows validation of the KES Server Certificate (Self-Signed or Third-Party CA)
# Change this path to the location of the KES CA Path
MINIO_KMS_KES_CAPATH=|kescertpath|/kes-server.cert

# Sets the default KMS key for the backend and SSE-KMS/SSE-S3 Operations)
MINIO_KMS_KES_KEY_NAME=minio-backend-default-key

    Replace HOSTNAME with the IP address or hostname of the KES server. If the Buckit server host machines cannot resolve or reach the specified HOSTNAME, the deployment may return errors or fail to start.

    • If using a single KES server host, specify the IP or hostname of that host

    • If using multiple KES server hosts, specify a comma-separated list of IPs or hostnames of each host

    Buckit uses the MINIO_KMS_KES_KEY_NAME key for the following cryptographic operations:

    • Encrypting the Buckit backend (IAM, configuration, etc.)

    • Encrypting objects using SSE-KMS if the request does not include a specific EK.

    • Encrypting objects using SSE-S3.

    Buckit defaults to expecting this file at /etc/default/minio. If you modified your deployment to use a different location for the environment file, modify the file at that location.

  3. Start Buckit

    KES Operations Requires Unsealed Vault

    Depending on your selected KMS solution, you may need to unseal the key instance to allow normal cryptographic operations, including key creation or retrieval. KES requires an unsealed key target to perform its operations.

    Refer to the documentation for your chosen KMS solution for information regarding whether sealing and unsealing the instance is required for operations.

    You must start KES before starting Buckit. The Buckit deployment requires access to KES as part of its startup.

    You can use the bm admin service restart command to restart Buckit:

    bm admin service restart ALIAS

  4. Generate a New Encryption Key

    Buckit requires that the EK exist on the KMS before performing SSE operations using that key. Use kes key create or bm admin kms key create to add a new EK for use with SSE.

    The following command uses the bm admin kms key create command to add a new External Key (EK) stored on the KMS server for use with encrypting the Buckit backend.

    bm admin kms key create ALIAS KEYNAME

  5. Enable SSE-KMS for a Bucket

    Use the Buckit bm CLI to enable bucket-default SSE-KMS with the generated key:

    The following commands:

    • Create a new alias for the Buckit deployment

    • Create a new bucket for storing encrypted data

    • Enable SSE-KMS encryption on that bucket

    bm alias set local http://127.0.0.1:9000 ROOTUSER ROOTPASSWORD

bm mb local/encryptedbucket
bm encrypt set SSE-KMS encrypted-bucket-key ALIAS/encryptedbucket

    Write a file to the bucket using bm cp or any S3-compatible SDK with a PutObject function. You can then run bm stat on the file to confirm the associated encryption metadata.

Buckit documentation adapted from MinIO Open Source documentation. Licensed under the Creative Commons Attribution 4.0 International License. Creative Commons License