Skip to content

Commit 3381f84

Browse files
Anders ÅstrandAndersAstrand
authored andcommitted
Clarify some namings in keyring code
It's not clear to someone new to the code that "key provider" in these files refers to what's called "key provider type" elsewhere. Rename these to make it easier for the next person.
1 parent 3b8a234 commit 3381f84

File tree

5 files changed

+25
-25
lines changed

5 files changed

+25
-25
lines changed

contrib/pg_tde/src/include/keyring/keyring_api.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ typedef struct KmipKeyring
8787
char *kmip_cert_path;
8888
} KmipKeyring;
8989

90-
extern void RegisterKeyProvider(const TDEKeyringRoutine *routine, ProviderType type);
90+
extern void RegisterKeyProviderType(const TDEKeyringRoutine *routine, ProviderType type);
9191

9292
extern KeyInfo *KeyringGetKey(GenericKeyring *keyring, const char *key_name, KeyringReturnCodes *returnCode);
9393
extern KeyInfo *KeyringGenerateNewKeyAndStore(GenericKeyring *keyring, const char *key_name, unsigned key_len);

contrib/pg_tde/src/keyring/keyring_api.c

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,31 @@
1111
#include <assert.h>
1212
#include <openssl/rand.h>
1313

14-
typedef struct KeyProviders
14+
typedef struct RegisteredKeyProviderType
1515
{
1616
TDEKeyringRoutine *routine;
1717
ProviderType type;
18-
} KeyProviders;
18+
} RegisteredKeyProviderType;
1919

2020
#ifndef FRONTEND
21-
static List *registeredKeyProviders = NIL;
21+
static List *registeredKeyProviderTypes = NIL;
2222
#else
23-
static SimplePtrList registeredKeyProviders = {NULL, NULL};
23+
static SimplePtrList registeredKeyProviderTypes = {NULL, NULL};
2424
#endif
2525

26-
static KeyProviders *find_key_provider(ProviderType type);
26+
static RegisteredKeyProviderType *find_key_provider_type(ProviderType type);
2727
static void KeyringStoreKey(GenericKeyring *keyring, KeyInfo *key);
2828
static KeyInfo *KeyringGenerateNewKey(const char *key_name, unsigned key_len);
2929

3030
#ifndef FRONTEND
31-
static KeyProviders *
32-
find_key_provider(ProviderType type)
31+
static RegisteredKeyProviderType *
32+
find_key_provider_type(ProviderType type)
3333
{
3434
ListCell *lc;
3535

36-
foreach(lc, registeredKeyProviders)
36+
foreach(lc, registeredKeyProviderTypes)
3737
{
38-
KeyProviders *kp = (KeyProviders *) lfirst(lc);
38+
RegisteredKeyProviderType *kp = (RegisteredKeyProviderType *) lfirst(lc);
3939

4040
if (kp->type == type)
4141
{
@@ -45,14 +45,14 @@ find_key_provider(ProviderType type)
4545
return NULL;
4646
}
4747
#else
48-
static KeyProviders *
49-
find_key_provider(ProviderType type)
48+
static RegisteredKeyProviderType *
49+
find_key_provider_type(ProviderType type)
5050
{
5151
SimplePtrListCell *lc;
5252

53-
for (lc = registeredKeyProviders.head; lc; lc = lc->next)
53+
for (lc = registeredKeyProviderTypes.head; lc; lc = lc->next)
5454
{
55-
KeyProviders *kp = (KeyProviders *) lc->ptr;
55+
RegisteredKeyProviderType *kp = (RegisteredKeyProviderType *) lc->ptr;
5656

5757
if (kp->type == type)
5858
{
@@ -64,9 +64,9 @@ find_key_provider(ProviderType type)
6464
#endif /* !FRONTEND */
6565

6666
void
67-
RegisterKeyProvider(const TDEKeyringRoutine *routine, ProviderType type)
67+
RegisterKeyProviderType(const TDEKeyringRoutine *routine, ProviderType type)
6868
{
69-
KeyProviders *kp;
69+
RegisteredKeyProviderType *kp;
7070
#ifndef FRONTEND
7171
MemoryContext oldcontext;
7272
#endif
@@ -75,29 +75,29 @@ RegisterKeyProvider(const TDEKeyringRoutine *routine, ProviderType type)
7575
Assert(routine->keyring_get_key != NULL);
7676
Assert(routine->keyring_store_key != NULL);
7777

78-
kp = find_key_provider(type);
78+
kp = find_key_provider_type(type);
7979
if (kp)
8080
ereport(ERROR,
8181
(errmsg("Key provider of type %d already registered", type)));
8282

8383
#ifndef FRONTEND
8484
oldcontext = MemoryContextSwitchTo(TopMemoryContext);
8585
#endif
86-
kp = palloc_object(KeyProviders);
86+
kp = palloc_object(RegisteredKeyProviderType);
8787
kp->routine = (TDEKeyringRoutine *) routine;
8888
kp->type = type;
8989
#ifndef FRONTEND
90-
registeredKeyProviders = lappend(registeredKeyProviders, kp);
90+
registeredKeyProviderTypes = lappend(registeredKeyProviderTypes, kp);
9191
MemoryContextSwitchTo(oldcontext);
9292
#else
93-
simple_ptr_list_append(&registeredKeyProviders, kp);
93+
simple_ptr_list_append(&registeredKeyProviderTypes, kp);
9494
#endif
9595
}
9696

9797
KeyInfo *
9898
KeyringGetKey(GenericKeyring *keyring, const char *key_name, KeyringReturnCodes *returnCode)
9999
{
100-
KeyProviders *kp = find_key_provider(keyring->type);
100+
RegisteredKeyProviderType *kp = find_key_provider_type(keyring->type);
101101

102102
if (kp == NULL)
103103
{
@@ -112,7 +112,7 @@ KeyringGetKey(GenericKeyring *keyring, const char *key_name, KeyringReturnCodes
112112
static void
113113
KeyringStoreKey(GenericKeyring *keyring, KeyInfo *key)
114114
{
115-
KeyProviders *kp = find_key_provider(keyring->type);
115+
RegisteredKeyProviderType *kp = find_key_provider_type(keyring->type);
116116

117117
if (kp == NULL)
118118
ereport(ERROR,

contrib/pg_tde/src/keyring/keyring_file.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ const TDEKeyringRoutine keyringFileRoutine = {
3737
void
3838
InstallFileKeyring(void)
3939
{
40-
RegisterKeyProvider(&keyringFileRoutine, FILE_KEY_PROVIDER);
40+
RegisterKeyProviderType(&keyringFileRoutine, FILE_KEY_PROVIDER);
4141
}
4242

4343
static KeyInfo *

contrib/pg_tde/src/keyring/keyring_kmip.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ const TDEKeyringRoutine keyringKmipRoutine = {
3535
void
3636
InstallKmipKeyring(void)
3737
{
38-
RegisterKeyProvider(&keyringKmipRoutine, KMIP_KEY_PROVIDER);
38+
RegisterKeyProviderType(&keyringKmipRoutine, KMIP_KEY_PROVIDER);
3939
}
4040

4141
typedef struct KmipCtx

contrib/pg_tde/src/keyring/keyring_vault.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ const TDEKeyringRoutine keyringVaultV2Routine = {
7979
void
8080
InstallVaultV2Keyring(void)
8181
{
82-
RegisterKeyProvider(&keyringVaultV2Routine, VAULT_V2_KEY_PROVIDER);
82+
RegisterKeyProviderType(&keyringVaultV2Routine, VAULT_V2_KEY_PROVIDER);
8383
}
8484

8585
static bool

0 commit comments

Comments
 (0)