Skip to content

[KeyManager] End-to-end FFI error handling standardization #722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NilanjanDaw merged 8 commits into from
Mar 23, 2026
Merged

[KeyManager] End-to-end FFI error handling standardization #722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2a62443
refactor(keymanager): standardize error handling across Rust FFI and Go
NilanjanDaw Mar 17, 2026
223bd85
lint refactors
NilanjanDaw Mar 20, 2026
17777ae
fix cbindgen issues with prost
NilanjanDaw Mar 20, 2026
86964b9
Rename Error to Status across keymanager FFI and services
NilanjanDaw Mar 20, 2026
955f79f
Further simplify and improve FFI status handling in Go and Rust
NilanjanDaw Mar 20, 2026
4edf303
Refactor httpStatusFromError to use idiomatic errors.Is pattern
NilanjanDaw Mar 20, 2026
cb4fdbd
fix status code unspecified merge
NilanjanDaw Mar 20, 2026
7fea15e
some more simplifications
NilanjanDaw Mar 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions keymanager/generate_ffi_headers.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ set -euo pipefail
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
CBINDGEN_BIN="${CBINDGEN_BIN:-cbindgen}"

"${CBINDGEN_BIN}" --quiet \
"${ROOT_DIR}/km_common" \
--crate km_common \
--config "${ROOT_DIR}/km_common/cbindgen.toml" \
--output "${ROOT_DIR}/km_common/include/km_common_ffi.h"

"${CBINDGEN_BIN}" --quiet \
"${ROOT_DIR}/workload_service/key_custody_core" \
Expand All @@ -16,3 +21,4 @@ CBINDGEN_BIN="${CBINDGEN_BIN:-cbindgen}"
--crate kps_key_custody_core \
--config "${ROOT_DIR}/key_protection_service/key_custody_core/cbindgen.toml" \
--output "${ROOT_DIR}/key_protection_service/key_custody_core/include/kps_key_custody_core.h"

10 changes: 7 additions & 3 deletions keymanager/key_protection_service/key_custody_core/cbindgen.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,18 @@ style = "type"
documentation = false
usize_is_size_t = true
sys_includes = ["stdbool.h", "stddef.h", "stdint.h"]
includes = ["km_common_ffi.h"]


[parse]
parse_deps = false
parse_deps = true
include = ["km_common"]
clean = true

[export]
item_types = ["functions", "structs", "constants", "enums"]
include = ["key_manager_generate_kem_keypair", "key_manager_get_kem_key", "key_manager_destroy_kem_key", "key_manager_enumerate_kem_keys", "KpsKeyInfo", "MAX_ALGORITHM_LEN", "MAX_PUBLIC_KEY_LEN"]

include = ["key_manager_generate_kem_keypair", "key_manager_get_kem_key", "key_manager_destroy_kem_key", "key_manager_enumerate_kem_keys", "KpsKeyInfo"]
exclude = ["Status", "MAX_ALGORITHM_LEN", "MAX_PUBLIC_KEY_LEN"]

[enum]
prefix_with_name = true
57 changes: 27 additions & 30 deletions keymanager/key_protection_service/key_custody_core/include/kps_key_custody_core.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#define MAX_ALGORITHM_LEN 128

#define MAX_PUBLIC_KEY_LEN 2048
#include "km_common_ffi.h"

typedef struct {
uint8_t uuid[16];
Expand All @@ -26,40 +23,40 @@ typedef struct {
extern "C" {
#endif // __cplusplus

int32_t key_manager_generate_kem_keypair(const uint8_t *algo_ptr,
size_t algo_len,
const uint8_t *binding_pubkey,
size_t binding_pubkey_len,
uint64_t expiry_secs,
uint8_t *out_uuid,
uint8_t *out_pubkey,
size_t out_pubkey_len);
Status key_manager_generate_kem_keypair(const uint8_t *algo_ptr,
size_t algo_len,
const uint8_t *binding_pubkey,
size_t binding_pubkey_len,
uint64_t expiry_secs,
uint8_t *out_uuid,
uint8_t *out_pubkey,
size_t out_pubkey_len);

int32_t key_manager_destroy_kem_key(const uint8_t *uuid_bytes);
Status key_manager_destroy_kem_key(const uint8_t *uuid_bytes);

int32_t key_manager_enumerate_kem_keys(KpsKeyInfo *out_entries,
size_t max_entries,
size_t offset,
bool *out_has_more);

int32_t key_manager_decap_and_seal(const uint8_t *uuid_bytes,
const uint8_t *encapsulated_key,
size_t encapsulated_key_len,
const uint8_t *aad,
size_t aad_len,
uint8_t *out_encapsulated_key,
size_t out_encapsulated_key_len,
uint8_t *out_ciphertext,
size_t out_ciphertext_len);
Status key_manager_decap_and_seal(const uint8_t *uuid_bytes,
const uint8_t *encapsulated_key,
size_t encapsulated_key_len,
const uint8_t *aad,
size_t aad_len,
uint8_t *out_encapsulated_key,
size_t out_encapsulated_key_len,
uint8_t *out_ciphertext,
size_t out_ciphertext_len);

int32_t key_manager_get_kem_key(const uint8_t *uuid_bytes,
uint8_t *out_kem_pubkey,
size_t out_kem_pubkey_len,
uint8_t *out_binding_pubkey,
size_t out_binding_pubkey_len,
uint8_t *out_algo,
size_t *out_algo_len,
uint64_t *out_delete_after);
Status key_manager_get_kem_key(const uint8_t *uuid_bytes,
uint8_t *out_kem_pubkey,
size_t out_kem_pubkey_len,
uint8_t *out_binding_pubkey,
size_t out_binding_pubkey_len,
uint8_t *out_algo,
size_t *out_algo_len,
uint64_t *out_remaining_lifespan_secs);

#ifdef __cplusplus
} // extern "C"
Expand Down
2 changes: 1 addition & 1 deletion keymanager/key_protection_service/key_custody_core/integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ func TestIntegrationGetKEMKeyNotFound(t *testing.T) {
t.Fatal("expected error for non-existent UUID")
}

expectedErrMsg := "key_manager_get_kem_key failed with code -1"
expectedErrMsg := "FFI status: STATUS_NOT_FOUND"
if !strings.Contains(err.Error(), expectedErrMsg) {
t.Fatalf("expected error containing %q, got: %v", expectedErrMsg, err)
}
Expand Down
23 changes: 11 additions & 12 deletions keymanager/key_protection_service/key_custody_core/kps_key_custody_core_cgo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
package kpskcc

/*
#cgo CFLAGS: -I${SRCDIR}/../../km_common/include
#cgo LDFLAGS: -L${SRCDIR}/../../target/release -L${SRCDIR}/../../target/debug -lkps_key_custody_core
#cgo LDFLAGS: -lcrypto -lssl
#cgo LDFLAGS: -lpthread -ldl -lm -lstdc++
Expand Down Expand Up @@ -57,8 +58,8 @@ func GenerateKEMKeypair(algo *keymanager.HpkeAlgorithm, bindingPubKey []byte, li
(*C.uint8_t)(unsafe.Pointer(&uuidBytes[0])),
(*C.uint8_t)(unsafe.Pointer(&pubkeyBuf[0])),
pubkeyLen,
); rc != 0 {
return uuid.Nil, nil, fmt.Errorf("key_manager_generate_kem_keypair failed with code %d", rc)
); keymanager.Status(rc) != keymanager.Status_STATUS_SUCCESS {
Copy link
Copy Markdown
Collaborator

@pgonda pgonda Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is gonna get old.

Should you add a .ok() or similar method for:

if !keymanager.Status(rc).ok() {
...
}

return uuid.Nil, nil, keymanager.Status(rc).ToStatus()
}

id, err := uuid.FromBytes(uuidBytes[:])
Expand Down Expand Up @@ -91,7 +92,7 @@ func EnumerateKEMKeys(limit, offset int) ([]KEMKeyInfo, bool, error) {
&hasMore,
)
if rc < 0 {
return nil, false, fmt.Errorf("key_manager_enumerate_kem_keys failed with code %d", rc)
return nil, false, keymanager.Status(-rc).ToStatus()
}

count := int(rc)
Expand Down Expand Up @@ -124,12 +125,10 @@ func EnumerateKEMKeys(limit, offset int) ([]KEMKeyInfo, bool, error) {
// DestroyKEMKey destroys the KEM key identified by kemUUID via Rust FFI.
func DestroyKEMKey(kemUUID uuid.UUID) error {
uuidBytes := kemUUID[:]
if rc := C.key_manager_destroy_kem_key(
rc := C.key_manager_destroy_kem_key(
(*C.uint8_t)(unsafe.Pointer(&uuidBytes[0])),
); rc != 0 {
return fmt.Errorf("key_manager_destroy_kem_key failed with code %d", rc)
}
return nil
)
return keymanager.Status(rc).ToStatus()
}

// GetKEMKey retrieves KEM and binding public keys, HpkeAlgorithm and remaining lifespan via Rust FFI.
Expand All @@ -153,8 +152,8 @@ func GetKEMKey(id uuid.UUID) ([]byte, []byte, *keymanager.HpkeAlgorithm, uint64,
&algoLenC,
&remainingLifespanSecs,
)
if rc != 0 {
return nil, nil, nil, 0, fmt.Errorf("key_manager_get_kem_key failed with code %d", rc)
if keymanager.Status(rc) != keymanager.Status_STATUS_SUCCESS {
return nil, nil, nil, 0, keymanager.Status(rc).ToStatus()
}

kemPubkey := make([]byte, len(kemPubkeyBuf))
Expand Down Expand Up @@ -201,8 +200,8 @@ func DecapAndSeal(kemUUID uuid.UUID, encapsulatedKey, aad []byte) ([]byte, []byt
outEncKeyLen,
(*C.uint8_t)(unsafe.Pointer(&outCT[0])),
outCTLen,
); rc != 0 {
return nil, nil, fmt.Errorf("key_manager_decap_and_seal failed with code %d", rc)
); keymanager.Status(rc) != keymanager.Status_STATUS_SUCCESS {
return nil, nil, keymanager.Status(rc).ToStatus()
}

sealEnc := make([]byte, outEncKeyLen)
Expand Down
Loading
Loading