Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Clean up static functions in tde_keyring.c #394

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
merged 1 commit into from
Jun 5, 2025
Merged

Clean up static functions in tde_keyring.c #394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
293 changes: 147 additions & 146 deletions contrib/pg_tde/src/catalog/tde_keyring.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@ static Datum pg_tde_delete_key_provider_internal(PG_FUNCTION_ARGS, Oid dbOid);
static Datum pg_tde_list_all_key_providers_internal(PG_FUNCTION_ARGS, const char *fname, Oid dbOid);
static Size required_shared_mem_size(void);
static List *scan_key_provider_file(ProviderScanType scanType, void *scanKey, Oid dbOid);
static void save_new_key_provider_info(KeyringProviderRecord *provider, Oid databaseId);
static void modify_key_provider_info(KeyringProviderRecord *provider, Oid databaseId);
static void delete_key_provider_info(char *provider_name, Oid databaseId);
static void check_provider_record(KeyringProviderRecord *provider_record);

#define PG_TDE_LIST_PROVIDERS_COLS 4

Expand Down Expand Up @@ -235,7 +239,7 @@ pg_tde_change_key_provider_internal(PG_FUNCTION_ARGS, Oid dbOid)

pfree(keyring);

modify_key_provider_info(&provider, dbOid, true);
modify_key_provider_info(&provider, dbOid);

PG_RETURN_VOID();
}
Expand All @@ -252,7 +256,7 @@ pg_tde_add_global_key_provider(PG_FUNCTION_ARGS)
return pg_tde_add_key_provider_internal(fcinfo, GLOBAL_DATA_TDE_OID);
}

Datum
static Datum
pg_tde_add_key_provider_internal(PG_FUNCTION_ARGS, Oid dbOid)
{
char *provider_type;
Expand Down Expand Up @@ -294,7 +298,7 @@ pg_tde_add_key_provider_internal(PG_FUNCTION_ARGS, Oid dbOid)
memcpy(provider.provider_name, provider_name, nlen);
memcpy(provider.options, options, olen);
provider.provider_type = get_keyring_provider_from_typename(provider_type);
save_new_key_provider_info(&provider, dbOid, true);
save_new_key_provider_info(&provider, dbOid);

PG_RETURN_VOID();
}
Expand All @@ -311,7 +315,7 @@ pg_tde_delete_global_key_provider(PG_FUNCTION_ARGS)
return pg_tde_delete_key_provider_internal(fcinfo, GLOBAL_DATA_TDE_OID);
}

Datum
static Datum
pg_tde_delete_key_provider_internal(PG_FUNCTION_ARGS, Oid db_oid)
{
char *provider_name;
Expand Down Expand Up @@ -343,7 +347,7 @@ pg_tde_delete_key_provider_internal(PG_FUNCTION_ARGS, Oid db_oid)
errmsg("Can't delete a provider which is currently in use"));
}

delete_key_provider_info(provider_name, db_oid, true);
delete_key_provider_info(provider_name, db_oid);

PG_RETURN_VOID();
}
Expand Down Expand Up @@ -431,144 +435,11 @@ GetKeyProviderByID(int provider_id, Oid dbOid)
return keyring;
}

#endif /* !FRONTEND */

void
write_key_provider_info(KeyringProviderRecordInFile *record, bool write_xlog)
{
off_t bytes_written;
int fd;
char kp_info_path[MAXPGPATH];

Assert(record != NULL);
Assert(record->offset_in_file >= 0);
Assert(LWLockHeldByMeInMode(tde_provider_info_lock(), LW_EXCLUSIVE));

get_keyring_infofile_path(kp_info_path, record->database_id);
fd = BasicOpenFile(kp_info_path, O_CREAT | O_RDWR | PG_BINARY);
if (fd < 0)
{
ereport(ERROR,
errcode_for_file_access(),
errmsg("could not open tde file \"%s\": %m", kp_info_path));
}

/*
* emit the xlog here. So that we can handle partial file write errors but
* cannot make new WAL entries during recovery.
*/
if (write_xlog)
{
#ifndef FRONTEND
XLogBeginInsert();
XLogRegisterData((char *) record, sizeof(KeyringProviderRecordInFile));
XLogInsert(RM_TDERMGR_ID, XLOG_TDE_WRITE_KEY_PROVIDER);
#else
Assert(false);
#endif
}

bytes_written = pg_pwrite(fd, &(record->provider),
sizeof(KeyringProviderRecord),
record->offset_in_file);
if (bytes_written != sizeof(KeyringProviderRecord))
{
close(fd);
ereport(ERROR,
errcode_for_file_access(),
errmsg("key provider info file \"%s\" can't be written: %m",
kp_info_path));
}
if (pg_fsync(fd) != 0)
{
close(fd);
ereport(ERROR,
errcode_for_file_access(),
errmsg("could not fsync file \"%s\": %m", kp_info_path));
}
close(fd);
}

static void
check_provider_record(KeyringProviderRecord *provider_record)
{
GenericKeyring *provider;

if (provider_record->provider_type == UNKNOWN_KEY_PROVIDER)
{
ereport(ERROR,
errcode(ERRCODE_DATA_EXCEPTION),
errmsg("Invalid provider type."));
}

/* 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);

#ifndef FRONTEND /* We can't scan the pg_database catalog from
* frontend. */
if (provider->keyring_id != 0)
{
/*
* If we are modifying an existing provider, verify that all of the
* keys already in use are the same.
*/
pg_tde_verify_provider_keys_in_use(provider);
}
#endif

pfree(provider);
}

/* Returns true if the record is found, false otherwise. */
bool
get_keyring_info_file_record_by_name(char *provider_name, Oid database_id,
KeyringProviderRecordInFile *record)
{
off_t current_file_offset = 0;
off_t next_file_offset = 0;
int fd;
KeyringProviderRecord existing_provider;

Assert(provider_name != NULL);
Assert(record != NULL);

fd = open_keyring_infofile(database_id, O_RDONLY);

while (fetch_next_key_provider(fd, &next_file_offset, &existing_provider))
{
/* Ignore deleted provider records */
if (existing_provider.provider_type != UNKNOWN_KEY_PROVIDER
&& strcmp(existing_provider.provider_name, provider_name) == 0)
{
record->database_id = database_id;
record->offset_in_file = current_file_offset;
record->provider = existing_provider;
close(fd);
return true;
}

current_file_offset = next_file_offset;
}

/* No matching key provider found */
close(fd);
return false;
}

/*
* Save the key provider info to the file
*/
void
save_new_key_provider_info(KeyringProviderRecord *provider, Oid databaseId, bool write_xlog)
static void
save_new_key_provider_info(KeyringProviderRecord *provider, Oid databaseId)
{
off_t next_file_offset;
int fd;
Expand Down Expand Up @@ -631,8 +502,8 @@ save_new_key_provider_info(KeyringProviderRecord *provider, Oid databaseId, bool
LWLockRelease(tde_provider_info_lock());
}

void
modify_key_provider_info(KeyringProviderRecord *provider, Oid databaseId, bool write_xlog)
static void
modify_key_provider_info(KeyringProviderRecord *provider, Oid databaseId)
{
KeyringProviderRecordInFile record;

Expand All @@ -658,13 +529,13 @@ modify_key_provider_info(KeyringProviderRecord *provider, Oid databaseId, bool w
}

record.provider = *provider;
write_key_provider_info(&record, write_xlog);
write_key_provider_info(&record, true);

LWLockRelease(tde_provider_info_lock());
}

void
delete_key_provider_info(char *provider_name, Oid databaseId, bool write_xlog)
static void
delete_key_provider_info(char *provider_name, Oid databaseId)
{
int provider_id;
KeyringProviderRecordInFile record;
Expand All @@ -684,11 +555,141 @@ delete_key_provider_info(char *provider_name, Oid databaseId, bool write_xlog)
provider_id = record.provider.provider_id;
memset(&(record.provider), 0, sizeof(KeyringProviderRecord));
record.provider.provider_id = provider_id;
write_key_provider_info(&record, write_xlog);
write_key_provider_info(&record, true);

LWLockRelease(tde_provider_info_lock());
}

static void
check_provider_record(KeyringProviderRecord *provider_record)
{
GenericKeyring *provider;

if (provider_record->provider_type == UNKNOWN_KEY_PROVIDER)
{
ereport(ERROR,
errcode(ERRCODE_DATA_EXCEPTION),
errmsg("Invalid provider type."));
}

/* 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)
{
/*
* If we are modifying an existing provider, verify that all of the
* keys already in use are the same.
*/
pg_tde_verify_provider_keys_in_use(provider);
}

pfree(provider);
}

#endif /* !FRONTEND */

void
write_key_provider_info(KeyringProviderRecordInFile *record, bool write_xlog)
{
off_t bytes_written;
int fd;
char kp_info_path[MAXPGPATH];

Assert(record != NULL);
Assert(record->offset_in_file >= 0);
Assert(LWLockHeldByMeInMode(tde_provider_info_lock(), LW_EXCLUSIVE));

get_keyring_infofile_path(kp_info_path, record->database_id);
fd = BasicOpenFile(kp_info_path, O_CREAT | O_RDWR | PG_BINARY);
if (fd < 0)
{
ereport(ERROR,
errcode_for_file_access(),
errmsg("could not open tde file \"%s\": %m", kp_info_path));
}

/*
* emit the xlog here. So that we can handle partial file write errors but
* cannot make new WAL entries during recovery.
*/
if (write_xlog)
{
#ifndef FRONTEND
XLogBeginInsert();
XLogRegisterData((char *) record, sizeof(KeyringProviderRecordInFile));
XLogInsert(RM_TDERMGR_ID, XLOG_TDE_WRITE_KEY_PROVIDER);
#else
Assert(false);
#endif
}

bytes_written = pg_pwrite(fd, &(record->provider),
sizeof(KeyringProviderRecord),
record->offset_in_file);
if (bytes_written != sizeof(KeyringProviderRecord))
{
close(fd);
ereport(ERROR,
errcode_for_file_access(),
errmsg("key provider info file \"%s\" can't be written: %m",
kp_info_path));
}
if (pg_fsync(fd) != 0)
{
close(fd);
ereport(ERROR,
errcode_for_file_access(),
errmsg("could not fsync file \"%s\": %m", kp_info_path));
}
close(fd);
}

/* Returns true if the record is found, false otherwise. */
bool
get_keyring_info_file_record_by_name(char *provider_name, Oid database_id,
KeyringProviderRecordInFile *record)
{
off_t current_file_offset = 0;
off_t next_file_offset = 0;
int fd;
KeyringProviderRecord existing_provider;

Assert(provider_name != NULL);
Assert(record != NULL);

fd = open_keyring_infofile(database_id, O_RDONLY);

while (fetch_next_key_provider(fd, &next_file_offset, &existing_provider))
{
/* Ignore deleted provider records */
if (existing_provider.provider_type != UNKNOWN_KEY_PROVIDER
&& strcmp(existing_provider.provider_name, provider_name) == 0)
{
record->database_id = database_id;
record->offset_in_file = current_file_offset;
record->provider = existing_provider;
close(fd);
return true;
}

current_file_offset = next_file_offset;
}

/* No matching key provider found */
close(fd);
return false;
}

#ifdef FRONTEND
GenericKeyring *
GetKeyProviderByID(int provider_id, Oid dbOid)
Expand Down
6 changes: 0 additions & 6 deletions contrib/pg_tde/src/include/catalog/tde_keyring.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,6 @@ extern GenericKeyring *GetKeyProviderByID(int provider_id, Oid dbOid);
extern ProviderType get_keyring_provider_from_typename(char *provider_type);
extern void InitializeKeyProviderInfo(void);
extern void key_provider_startup_cleanup(Oid databaseId);
extern void save_new_key_provider_info(KeyringProviderRecord *provider,
Oid databaseId, bool write_xlog);
extern void modify_key_provider_info(KeyringProviderRecord *provider,
Oid databaseId, bool write_xlog);
extern void delete_key_provider_info(char *provider_name,
Oid databaseId, bool write_xlog);
extern bool get_keyring_info_file_record_by_name(char *provider_name,
Oid database_id,
KeyringProviderRecordInFile *record);
Expand Down