From 73797914c7f800c848e1565e3b3cd22309be6064 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anders=20=C3=85strand?= Date: Wed, 11 Jun 2025 11:46:39 +0200 Subject: [PATCH] Remove provider_ prefix from parameter names There was no reason for name and type to be prefixed in the add/change key provider functions while options was not. The output from the list_providers functions had them for name and type, but not id nor options. So remove the prefixes there aswell. In other functions the prefixes serve to show what parameters is about the provider and which are about something else. --- .../pg_tde/expected/default_principal_key.out | 4 +- contrib/pg_tde/expected/key_provider.out | 50 +++++++++---------- contrib/pg_tde/pg_tde--1.0-rc.sql | 16 +++--- contrib/pg_tde/sql/default_principal_key.sql | 2 +- contrib/pg_tde/sql/key_provider.sql | 12 ++--- .../pg_tde/t/expected/change_key_provider.out | 18 +++---- .../pg_tde/t/pg_tde_change_key_provider.pl | 20 ++++---- 7 files changed, 61 insertions(+), 61 deletions(-) diff --git a/contrib/pg_tde/expected/default_principal_key.out b/contrib/pg_tde/expected/default_principal_key.out index ad5870cc198..1de794060aa 100644 --- a/contrib/pg_tde/expected/default_principal_key.out +++ b/contrib/pg_tde/expected/default_principal_key.out @@ -39,8 +39,8 @@ SELECT key_provider_id, key_provider_name, key_name -- fails SELECT pg_tde_delete_global_key_provider('file-provider'); ERROR: Can't delete a provider which is currently in use -SELECT id, provider_name FROM pg_tde_list_all_global_key_providers(); - id | provider_name +SELECT id, name FROM pg_tde_list_all_global_key_providers(); + id | name ----+--------------- -2 | file-provider (1 row) diff --git a/contrib/pg_tde/expected/key_provider.out b/contrib/pg_tde/expected/key_provider.out index c77c2653657..b7a3105fa28 100644 --- a/contrib/pg_tde/expected/key_provider.out +++ b/contrib/pg_tde/expected/key_provider.out @@ -22,10 +22,10 @@ SELECT pg_tde_add_database_key_provider_file('file-provider2','/tmp/pg_tde_test_ SELECT pg_tde_add_database_key_provider_file('file-provider','/tmp/pg_tde_test_keyring_dup.per'); ERROR: Key provider "file-provider" already exists. SELECT * FROM pg_tde_list_all_database_key_providers(); - id | provider_name | provider_type | options -----+----------------+---------------+-------------------------------------------- - 1 | file-provider | file | {"path" : "/tmp/pg_tde_test_keyring.per"} - 2 | file-provider2 | file | {"path" : "/tmp/pg_tde_test_keyring2.per"} + id | name | type | options +----+----------------+------+-------------------------------------------- + 1 | file-provider | file | {"path" : "/tmp/pg_tde_test_keyring.per"} + 2 | file-provider2 | file | {"path" : "/tmp/pg_tde_test_keyring2.per"} (2 rows) SELECT pg_tde_verify_key(); @@ -45,19 +45,19 @@ SELECT pg_tde_verify_key(); SELECT pg_tde_change_database_key_provider_file('not-existent-provider','/tmp/pg_tde_test_keyring.per'); ERROR: key provider "not-existent-provider" does not exists SELECT * FROM pg_tde_list_all_database_key_providers(); - id | provider_name | provider_type | options -----+----------------+---------------+-------------------------------------------- - 1 | file-provider | file | {"path" : "/tmp/pg_tde_test_keyring.per"} - 2 | file-provider2 | file | {"path" : "/tmp/pg_tde_test_keyring2.per"} + id | name | type | options +----+----------------+------+-------------------------------------------- + 1 | file-provider | file | {"path" : "/tmp/pg_tde_test_keyring.per"} + 2 | file-provider2 | file | {"path" : "/tmp/pg_tde_test_keyring2.per"} (2 rows) SELECT pg_tde_change_database_key_provider('file', 'file-provider', '{"path": {"foo": "/tmp/pg_tde_test_keyring.per"}}'); ERROR: key provider value cannot be an object SELECT * FROM pg_tde_list_all_database_key_providers(); - id | provider_name | provider_type | options -----+----------------+---------------+-------------------------------------------- - 1 | file-provider | file | {"path" : "/tmp/pg_tde_test_keyring.per"} - 2 | file-provider2 | file | {"path" : "/tmp/pg_tde_test_keyring2.per"} + id | name | type | options +----+----------------+------+-------------------------------------------- + 1 | file-provider | file | {"path" : "/tmp/pg_tde_test_keyring.per"} + 2 | file-provider2 | file | {"path" : "/tmp/pg_tde_test_keyring2.per"} (2 rows) SELECT pg_tde_add_global_key_provider_file('file-keyring','/tmp/pg_tde_test_keyring.per'); @@ -72,8 +72,8 @@ SELECT pg_tde_add_global_key_provider_file('file-keyring2','/tmp/pg_tde_test_key (1 row) -SELECT id, provider_name FROM pg_tde_list_all_global_key_providers(); - id | provider_name +SELECT id, name FROM pg_tde_list_all_global_key_providers(); + id | name ----+--------------- -4 | file-keyring -5 | file-keyring2 @@ -82,8 +82,8 @@ SELECT id, provider_name FROM pg_tde_list_all_global_key_providers(); -- fails SELECT pg_tde_delete_database_key_provider('file-provider'); ERROR: Can't delete a provider which is currently in use -SELECT id, provider_name FROM pg_tde_list_all_database_key_providers(); - id | provider_name +SELECT id, name FROM pg_tde_list_all_database_key_providers(); + id | name ----+---------------- 1 | file-provider 2 | file-provider2 @@ -96,14 +96,14 @@ SELECT pg_tde_delete_database_key_provider('file-provider2'); (1 row) -SELECT id, provider_name FROM pg_tde_list_all_database_key_providers(); - id | provider_name +SELECT id, name FROM pg_tde_list_all_database_key_providers(); + id | name ----+--------------- 1 | file-provider (1 row) -SELECT id, provider_name FROM pg_tde_list_all_global_key_providers(); - id | provider_name +SELECT id, name FROM pg_tde_list_all_global_key_providers(); + id | name ----+--------------- -4 | file-keyring -5 | file-keyring2 @@ -118,8 +118,8 @@ SELECT pg_tde_set_key_using_global_key_provider('test-db-key', 'file-keyring', f -- fails SELECT pg_tde_delete_global_key_provider('file-keyring'); ERROR: Can't delete a provider which is currently in use -SELECT id, provider_name FROM pg_tde_list_all_global_key_providers(); - id | provider_name +SELECT id, name FROM pg_tde_list_all_global_key_providers(); + id | name ----+--------------- -4 | file-keyring -5 | file-keyring2 @@ -132,9 +132,9 @@ SELECT pg_tde_delete_global_key_provider('file-keyring2'); (1 row) -SELECT id, provider_name FROM pg_tde_list_all_global_key_providers(); - id | provider_name -----+--------------- +SELECT id, name FROM pg_tde_list_all_global_key_providers(); + id | name +----+-------------- -4 | file-keyring (1 row) diff --git a/contrib/pg_tde/pg_tde--1.0-rc.sql b/contrib/pg_tde/pg_tde--1.0-rc.sql index 897e1664bbb..716fa003e11 100644 --- a/contrib/pg_tde/pg_tde--1.0-rc.sql +++ b/contrib/pg_tde/pg_tde--1.0-rc.sql @@ -2,7 +2,7 @@ \echo Use "CREATE EXTENSION pg_tde" to load this file. \quit -- Key Provider Management -CREATE FUNCTION pg_tde_add_database_key_provider(provider_type TEXT, provider_name TEXT, options JSON) +CREATE FUNCTION pg_tde_add_database_key_provider(type TEXT, name TEXT, options JSON) RETURNS VOID LANGUAGE C AS 'MODULE_PATHNAME'; @@ -50,8 +50,8 @@ END; CREATE FUNCTION pg_tde_list_all_database_key_providers (OUT id INT, - OUT provider_name TEXT, - OUT provider_type TEXT, + OUT name TEXT, + OUT type TEXT, OUT options JSON) RETURNS SETOF RECORD LANGUAGE C @@ -60,8 +60,8 @@ REVOKE ALL ON FUNCTION pg_tde_list_all_database_key_providers() FROM PUBLIC; CREATE FUNCTION pg_tde_list_all_global_key_providers (OUT id INT, - OUT provider_name TEXT, - OUT provider_type TEXT, + OUT name TEXT, + OUT type TEXT, OUT options JSON) RETURNS SETOF RECORD LANGUAGE C @@ -69,7 +69,7 @@ AS 'MODULE_PATHNAME'; REVOKE ALL ON FUNCTION pg_tde_list_all_global_key_providers() FROM PUBLIC; -- Global Tablespace Key Provider Management -CREATE FUNCTION pg_tde_add_global_key_provider(provider_type TEXT, provider_name TEXT, options JSON) +CREATE FUNCTION pg_tde_add_global_key_provider(type TEXT, name TEXT, options JSON) RETURNS VOID LANGUAGE C AS 'MODULE_PATHNAME'; @@ -116,7 +116,7 @@ BEGIN ATOMIC END; -- Key Provider Management -CREATE FUNCTION pg_tde_change_database_key_provider(provider_type TEXT, provider_name TEXT, options JSON) +CREATE FUNCTION pg_tde_change_database_key_provider(type TEXT, name TEXT, options JSON) RETURNS VOID LANGUAGE C AS 'MODULE_PATHNAME'; @@ -163,7 +163,7 @@ BEGIN ATOMIC END; -- Global Tablespace Key Provider Management -CREATE FUNCTION pg_tde_change_global_key_provider(provider_type TEXT, provider_name TEXT, options JSON) +CREATE FUNCTION pg_tde_change_global_key_provider(type TEXT, name TEXT, options JSON) RETURNS VOID LANGUAGE C AS 'MODULE_PATHNAME'; diff --git a/contrib/pg_tde/sql/default_principal_key.sql b/contrib/pg_tde/sql/default_principal_key.sql index b91744390da..ec24ccd4d4c 100644 --- a/contrib/pg_tde/sql/default_principal_key.sql +++ b/contrib/pg_tde/sql/default_principal_key.sql @@ -18,7 +18,7 @@ SELECT key_provider_id, key_provider_name, key_name -- fails SELECT pg_tde_delete_global_key_provider('file-provider'); -SELECT id, provider_name FROM pg_tde_list_all_global_key_providers(); +SELECT id, name FROM pg_tde_list_all_global_key_providers(); -- Should fail: no principal key for the database yet SELECT key_provider_id, key_provider_name, key_name diff --git a/contrib/pg_tde/sql/key_provider.sql b/contrib/pg_tde/sql/key_provider.sql index 008858d8944..9cfb21ee2f5 100644 --- a/contrib/pg_tde/sql/key_provider.sql +++ b/contrib/pg_tde/sql/key_provider.sql @@ -22,27 +22,27 @@ SELECT pg_tde_add_global_key_provider_file('file-keyring','/tmp/pg_tde_test_keyr SELECT pg_tde_add_global_key_provider_file('file-keyring2','/tmp/pg_tde_test_keyring2.per'); -SELECT id, provider_name FROM pg_tde_list_all_global_key_providers(); +SELECT id, name FROM pg_tde_list_all_global_key_providers(); -- fails SELECT pg_tde_delete_database_key_provider('file-provider'); -SELECT id, provider_name FROM pg_tde_list_all_database_key_providers(); +SELECT id, name FROM pg_tde_list_all_database_key_providers(); -- works SELECT pg_tde_delete_database_key_provider('file-provider2'); -SELECT id, provider_name FROM pg_tde_list_all_database_key_providers(); +SELECT id, name FROM pg_tde_list_all_database_key_providers(); -SELECT id, provider_name FROM pg_tde_list_all_global_key_providers(); +SELECT id, name FROM pg_tde_list_all_global_key_providers(); SELECT pg_tde_set_key_using_global_key_provider('test-db-key', 'file-keyring', false); -- fails SELECT pg_tde_delete_global_key_provider('file-keyring'); -SELECT id, provider_name FROM pg_tde_list_all_global_key_providers(); +SELECT id, name FROM pg_tde_list_all_global_key_providers(); -- works SELECT pg_tde_delete_global_key_provider('file-keyring2'); -SELECT id, provider_name FROM pg_tde_list_all_global_key_providers(); +SELECT id, name FROM pg_tde_list_all_global_key_providers(); -- Creating a file key provider fails if we can't open or create the file SELECT pg_tde_add_database_key_provider_file('will-not-work','/cant-create-file-in-root.per'); diff --git a/contrib/pg_tde/t/expected/change_key_provider.out b/contrib/pg_tde/t/expected/change_key_provider.out index 4d912c77936..fc7858c7f68 100644 --- a/contrib/pg_tde/t/expected/change_key_provider.out +++ b/contrib/pg_tde/t/expected/change_key_provider.out @@ -6,9 +6,9 @@ SELECT pg_tde_add_database_key_provider_file('file-vault', '/tmp/change_key_prov (1 row) SELECT * FROM pg_tde_list_all_database_key_providers(); - id | provider_name | provider_type | options -----+---------------+---------------+--------------------------------------------- - 1 | file-vault | file | {"path" : "/tmp/change_key_provider_1.per"} + id | name | type | options +----+------------+------+--------------------------------------------- + 1 | file-vault | file | {"path" : "/tmp/change_key_provider_1.per"} (1 row) SELECT pg_tde_set_key_using_database_key_provider('test-key', 'file-vault'); @@ -46,9 +46,9 @@ SELECT pg_tde_change_database_key_provider_file('file-vault', '/tmp/change_key_p (1 row) SELECT * FROM pg_tde_list_all_database_key_providers(); - id | provider_name | provider_type | options -----+---------------+---------------+--------------------------------------------- - 1 | file-vault | file | {"path" : "/tmp/change_key_provider_2.per"} + id | name | type | options +----+------------+------+--------------------------------------------- + 1 | file-vault | file | {"path" : "/tmp/change_key_provider_2.per"} (1 row) SELECT pg_tde_verify_key(); @@ -109,9 +109,9 @@ SELECT pg_tde_change_database_key_provider_file('file-vault', '/tmp/change_key_p (1 row) SELECT * FROM pg_tde_list_all_database_key_providers(); - id | provider_name | provider_type | options -----+---------------+---------------+--------------------------------------------- - 1 | file-vault | file | {"path" : "/tmp/change_key_provider_1.per"} + id | name | type | options +----+------------+------+--------------------------------------------- + 1 | file-vault | file | {"path" : "/tmp/change_key_provider_1.per"} (1 row) SELECT pg_tde_verify_key(); diff --git a/contrib/pg_tde/t/pg_tde_change_key_provider.pl b/contrib/pg_tde/t/pg_tde_change_key_provider.pl index 47380a940be..fbcae2e77b9 100644 --- a/contrib/pg_tde/t/pg_tde_change_key_provider.pl +++ b/contrib/pg_tde/t/pg_tde_change_key_provider.pl @@ -43,7 +43,7 @@ $node->start; is( $node->safe_psql( 'postgres', - q{SELECT provider_type FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'} + q{SELECT type FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'} ), 'file', 'provider type is set to file'); @@ -51,7 +51,7 @@ is( $node->safe_psql( $options = decode_json( $node->safe_psql( 'postgres', - q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'} + q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'} )); is( $options->{path}, '/tmp/pg_tde_change_key_provider-database-2', @@ -78,7 +78,7 @@ $node->start; is( $node->safe_psql( 'postgres', - q{SELECT provider_type FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'} + q{SELECT type FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'} ), 'vault-v2', 'provider type is set to vault-v2'); @@ -86,7 +86,7 @@ is( $node->safe_psql( $options = decode_json( $node->safe_psql( 'postgres', - q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'} + q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'} )); is( $options->{url}, 'https://vault-server.example:8200/', @@ -118,7 +118,7 @@ $node->start; is( $node->safe_psql( 'postgres', - q{SELECT provider_type FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'} + q{SELECT type FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'} ), 'vault-v2', 'provider type is set to vault-v2'); @@ -126,7 +126,7 @@ is( $node->safe_psql( $options = decode_json( $node->safe_psql( 'postgres', - q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'} + q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'} )); is( $options->{url}, 'http://vault-server.example:8200/', @@ -159,7 +159,7 @@ $node->start; is( $node->safe_psql( 'postgres', - q{SELECT provider_type FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'} + q{SELECT type FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'} ), 'kmip', 'provider type is set to kmip'); @@ -167,7 +167,7 @@ is( $node->safe_psql( $options = decode_json( $node->safe_psql( 'postgres', - q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'} + q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'} )); is($options->{host}, 'kmip-server.example', 'host is set correctly for kmip provider'); @@ -200,7 +200,7 @@ $node->start; is( $node->safe_psql( 'postgres', - q{SELECT provider_type FROM pg_tde_list_all_global_key_providers() WHERE provider_name = 'global-provider'} + q{SELECT type FROM pg_tde_list_all_global_key_providers() WHERE name = 'global-provider'} ), 'vault-v2', 'provider type is set to vault-v2 for global provider'); @@ -208,7 +208,7 @@ is( $node->safe_psql( $options = decode_json( $node->safe_psql( 'postgres', - q{SELECT options FROM pg_tde_list_all_global_key_providers() WHERE provider_name = 'global-provider'} + q{SELECT options FROM pg_tde_list_all_global_key_providers() WHERE name = 'global-provider'} )); is( $options->{url}, 'http://vault-server.example:8200/',