Skip to main content
These module-level functions persist a per-index KMS envelope describing how the index KEK is wrapped by an external Key Management Service. The envelope is stored as a FlatBuffer next to the index keystore.
KMS key wrapping is primarily for the service layer. Embedded SDK users who supply their own KEK directly can ignore these functions, or use provider = "none". They are advanced and optional.
#include "cyborgdb_core/index_kms.hpp"

​
Concepts

  • KMS envelope. A KMSBlob records how an index’s KEK is wrapped by an external KMS. Callers never store the plaintext KEK in the envelope; they store the wrapped form plus the metadata needed to unwrap it.
  • Providers.
    • "aws" — the KEK is wrapped with AES-256-GCM under a value stored in AWS Secrets Manager.
    • "aws-kms" — the KEK is wrapped via kms.Encrypt.
    • "none" — nothing is stored; the SDK supplies the plaintext KEK per request.
  • Strict insert vs. upsert. CreateIndexKMS fails if an envelope already exists for the index; PushIndexKMS is an idempotent upsert.

​
CreateIndexKMS

void CreateIndexKMS(const StorageConfig& config_location,
                    const std::string& index_name,
                    const KMSBlob& blob);
Stores a new KMS envelope for the index. Strict insert — throws if one already exists.

​
Parameters

ParameterTypeDescription
config_locationStorageConfigBacking store where the envelope is persisted.
index_nameconst std::string&Name of the index.
blobKMSBlobThe KMS envelope to store.

​
PushIndexKMS

void PushIndexKMS(const StorageConfig& config_location,
                  const std::string& index_name,
                  const KMSBlob& blob);
Idempotent upsert of the KMS envelope for the index. Creates it if absent, overwrites it otherwise.

​
Parameters

ParameterTypeDescription
config_locationStorageConfigBacking store where the envelope is persisted.
index_nameconst std::string&Name of the index.
blobKMSBlobThe KMS envelope to store.

​
GetIndexKMS

KMSBlob GetIndexKMS(const StorageConfig& config_location,
                    const std::string& index_name);
Retrieves the stored KMS envelope for the index.

​
Parameters

ParameterTypeDescription
config_locationStorageConfigBacking store where the envelope lives.
index_nameconst std::string&Name of the index.

​
Returns

KMSBlob: The stored KMS envelope.

​
DeleteIndexKMS

void DeleteIndexKMS(const StorageConfig& config_location,
                    const std::string& index_name);
Deletes the stored KMS envelope for the index. Idempotent.

​
Parameters

ParameterTypeDescription
config_locationStorageConfigBacking store where the envelope lives.
index_nameconst std::string&Name of the index.

​
KMSBlob

The KMS envelope struct (see KMSBlob): 
struct KMSBlob {
    std::string kms_name;
    std::string provider;         // "aws" | "aws-kms" | "none"
    std::string key_id;
    std::string region;
    std::vector<uint8_t> wrapped_kek;
    uint32_t version = 0;
    int64_t created_at = 0;       // unix epoch seconds
};

​
Example Usage

#include "cyborgdb_core/client.hpp"
#include "cyborgdb_core/index_kms.hpp"

auto config_location = cyborg::StorageConfig::Disk("/tmp/cyborgdb");

cyborg::KMSBlob blob;
blob.kms_name = "my-kms";
blob.provider = "aws-kms";
blob.key_id = "arn:aws:kms:us-east-1:123456789012:key/abcd";
blob.region = "us-east-1";
blob.wrapped_kek = {/* wrapped KEK bytes */};
blob.version = 1;

// Strict insert
cyborg::CreateIndexKMS(config_location, "my_index", blob);

// Idempotent upsert
cyborg::PushIndexKMS(config_location, "my_index", blob);

// Retrieve
cyborg::KMSBlob stored = cyborg::GetIndexKMS(config_location, "my_index");

// Delete
cyborg::DeleteIndexKMS(config_location, "my_index");