Skip to content

Do not return NULL when failing to parse a key provider config #562

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

Open
jeltz wants to merge 2 commits into
base: main
Choose a base branch
from
+31 −49
Open

Do not return NULL when failing to parse a key provider config #562

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c405337
Do not return NULL when failing to parse a key provider config
jeltz Apr 2, 2026
c0055ea
Merge two functions in tde_keyring.c
jeltz Apr 2, 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
80 changes: 31 additions & 49 deletions src/catalog/tde_keyring.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ static bool fetch_next_key_provider(int fd, off_t *curr_pos, KeyringProviderReco
static inline void get_keyring_infofile_path(char *resPath, Oid dbOid);
static FileKeyring *load_file_keyring_provider_options(char *keyring_options);
static GenericKeyring *load_keyring_provider_from_record(KeyringProviderRecord *provider);
static GenericKeyring *load_keyring_provider_options(ProviderType provider_type, char *keyring_options);
static KmipKeyring *load_kmip_keyring_provider_options(char *keyring_options);
static VaultV2Keyring *load_vaultV2_keyring_provider_options(char *keyring_options);
static int open_keyring_infofile(Oid dbOid, int flags);
Expand Down Expand Up @@ -540,13 +539,6 @@ check_provider_record(KeyringProviderRecord *provider_record)
/* Validate that the provider record can be properly parsed. */
provider = load_keyring_provider_from_record(provider_record);

if (provider == NULL)
{
ereport(ERROR,
errcode(ERRCODE_DATA_EXCEPTION),
errmsg("Invalid provider options."));
}

KeyringValidate(provider);

if (provider->keyring_id != 0)
Expand Down Expand Up @@ -801,16 +793,13 @@ scan_key_provider_file(ProviderScanType scanType, void *scanKey, Oid dbOid)
{
GenericKeyring *keyring = load_keyring_provider_from_record(&provider);

if (keyring)
{
#ifndef FRONTEND
providers_list = lappend(providers_list, keyring);
providers_list = lappend(providers_list, keyring);
#else
if (providers_list == NULL)
providers_list = palloc0_object(SimplePtrList);
simple_ptr_list_append(providers_list, keyring);
if (providers_list == NULL)
providers_list = palloc0_object(SimplePtrList);
simple_ptr_list_append(providers_list, keyring);
#endif
}
}
}
CloseTransientFile(fd);
Expand All @@ -823,34 +812,30 @@ load_keyring_provider_from_record(KeyringProviderRecord *provider)
{
GenericKeyring *keyring;

keyring = load_keyring_provider_options(provider->provider_type, provider->options);

if (keyring)
{
keyring->keyring_id = provider->provider_id;
memcpy(keyring->provider_name, provider->provider_name, sizeof(keyring->provider_name));
keyring->type = provider->provider_type;
memcpy(keyring->options, provider->options, sizeof(keyring->options));
debug_print_kerying(keyring);
}

return keyring;
}

static GenericKeyring *
load_keyring_provider_options(ProviderType provider_type, char *keyring_options)
{
switch (provider_type)
switch (provider->provider_type)
{
case FILE_KEY_PROVIDER:
return (GenericKeyring *) load_file_keyring_provider_options(keyring_options);
keyring = (GenericKeyring *) load_file_keyring_provider_options(provider->options);
break;
case VAULT_V2_KEY_PROVIDER:
return (GenericKeyring *) load_vaultV2_keyring_provider_options(keyring_options);
keyring = (GenericKeyring *) load_vaultV2_keyring_provider_options(provider->options);
break;
case KMIP_KEY_PROVIDER:
return (GenericKeyring *) load_kmip_keyring_provider_options(keyring_options);
keyring = (GenericKeyring *) load_kmip_keyring_provider_options(provider->options);
break;
default:
return NULL;
ereport(ERROR,
errcode(ERRCODE_INVALID_PARAMETER_VALUE),
errmsg("unknown key provider type: %d", provider->provider_type));
}

keyring->keyring_id = provider->provider_id;
memcpy(keyring->provider_name, provider->provider_name, sizeof(keyring->provider_name));
keyring->type = provider->provider_type;
memcpy(keyring->options, provider->options, sizeof(keyring->options));
debug_print_kerying(keyring);

return keyring;
}

static FileKeyring *
Expand All @@ -865,12 +850,11 @@ load_file_keyring_provider_options(char *keyring_options)

if (file_keyring->file_name == NULL || file_keyring->file_name[0] == '\0')
{
ereport(WARNING,
free_keyring((GenericKeyring *) file_keyring);

ereport(ERROR,
errcode(ERRCODE_INVALID_PARAMETER_VALUE),
errmsg("file path is missing in the keyring options"));

free_keyring((GenericKeyring *) file_keyring);
return NULL;
}

return file_keyring;
Expand All @@ -891,15 +875,14 @@ load_vaultV2_keyring_provider_options(char *keyring_options)
vaultV2_keyring->vault_url == NULL || vaultV2_keyring->vault_url[0] == '\0' ||
vaultV2_keyring->vault_mount_path == NULL || vaultV2_keyring->vault_mount_path[0] == '\0')
{
ereport(WARNING,
free_keyring((GenericKeyring *) vaultV2_keyring);

ereport(ERROR,
errcode(ERRCODE_INVALID_PARAMETER_VALUE),
errmsg("missing in the keyring options:%s%s%s",
(vaultV2_keyring->vault_token_path != NULL && vaultV2_keyring->vault_token_path[0] != '\0') ? "" : " tokenPath",
(vaultV2_keyring->vault_url != NULL && vaultV2_keyring->vault_url[0] != '\0') ? "" : " url",
(vaultV2_keyring->vault_mount_path != NULL && vaultV2_keyring->vault_mount_path[0] != '\0') ? "" : " mountPath"));

free_keyring((GenericKeyring *) vaultV2_keyring);
return NULL;
}

/* TODO: the vault_token mem should be protected from paging to the swap */
Expand All @@ -924,17 +907,16 @@ load_kmip_keyring_provider_options(char *keyring_options)
kmip_keyring->kmip_cert_path == NULL || kmip_keyring->kmip_cert_path[0] == '\0' ||
kmip_keyring->kmip_key_path == NULL || kmip_keyring->kmip_key_path[0] == '\0')
{
ereport(WARNING,
free_keyring((GenericKeyring *) kmip_keyring);

ereport(ERROR,
errcode(ERRCODE_INVALID_PARAMETER_VALUE),
errmsg("missing in the keyring options:%s%s%s%s%s",
(kmip_keyring->kmip_host != NULL && kmip_keyring->kmip_host[0] != '\0') ? "" : " host",
(kmip_keyring->kmip_port != NULL && kmip_keyring->kmip_port[0] != '\0') ? "" : " port",
(kmip_keyring->kmip_ca_path != NULL && kmip_keyring->kmip_ca_path[0] != '\0') ? "" : " caPath",
(kmip_keyring->kmip_cert_path != NULL && kmip_keyring->kmip_cert_path[0] != '\0') ? "" : " certPath",
(kmip_keyring->kmip_key_path != NULL && kmip_keyring->kmip_key_path[0] != '\0') ? "" : " keyPath"));

free_keyring((GenericKeyring *) kmip_keyring);
return NULL;
}

return kmip_keyring;
Expand Down
Loading