PG-1400: Correct pg_tde_change_key_provider naming

Previusly the tool was named pg_tde_alter_key_provider, but in the
help message it referred to itself as pg_tde_modify_key_provider.

Instead of any of that, the name should align with the online
function, which i pg_tde_change_key_provider.

This commit renames the tool and addresses the help message.

Also, the help message is now more detailed to make the parameters
cleaner.
pull/209/head
Zsolt Parragi 6 months ago committed by Zsolt Parragi
parent 3824063e66
commit e973d95d7c
  1. 2
      src/bin/Makefile
  2. 2
      src/bin/meson.build
  3. 1
      src/bin/pg_tde_alter_key_provider/.gitignore
  4. 1
      src/bin/pg_tde_change_key_provider/.gitignore
  5. 18
      src/bin/pg_tde_change_key_provider/Makefile
  6. 12
      src/bin/pg_tde_change_key_provider/meson.build
  7. 31
      src/bin/pg_tde_change_key_provider/pg_tde_change_key_provider.c

@ -31,7 +31,7 @@ SUBDIRS = \
pg_dump \
pg_resetwal \
pg_rewind \
pg_tde_alter_key_provider \
pg_tde_change_key_provider \
pg_test_fsync \
pg_test_timing \
pg_upgrade \

@ -12,7 +12,7 @@ subdir('pg_ctl')
subdir('pg_dump')
subdir('pg_resetwal')
subdir('pg_rewind')
subdir('pg_tde_alter_key_provider')
subdir('pg_tde_change_key_provider')
subdir('pg_test_fsync')
subdir('pg_test_timing')
subdir('pg_upgrade')

@ -1 +0,0 @@
/pg_tde_alter_key_provider

@ -0,0 +1 @@
/pg_tde_change_key_provider

@ -1,13 +1,13 @@
# src/bin/pg_tde_alter_key_provider/Makefile
# src/bin/pg_tde_change_key_provider/Makefile
PGFILEDESC = "pg_tde_alter_key_provider"
PGFILEDESC = "pg_tde_change_key_provider"
subdir = src/bin/pg_tde_alter_key_provider
subdir = src/bin/pg_tde_change_key_provider
top_builddir = ../../..
include $(top_builddir)/src/Makefile.global
OBJS = \
pg_tde_alter_key_provider.o
pg_tde_change_key_provider.o
override CPPFLAGS := -DFRONTEND $(CPPFLAGS)
@ -17,20 +17,20 @@ OBJS += \
override CPPFLAGS := -I$(top_srcdir)/contrib/pg_tde/src/include -I$(top_srcdir)/contrib/pg_tde/src/libkmip/libkmip/include $(CPPFLAGS)
all: pg_tde_alter_key_provider
all: pg_tde_change_key_provider
pg_tde_alter_key_provider: $(OBJS) | submake-libpgport
pg_tde_change_key_provider: $(OBJS) | submake-libpgport
$(CC) $(CFLAGS) $^ $(LDFLAGS) $(LDFLAGS_EX) $(LIBS) -o $@$(X)
install: all installdirs
$(INSTALL_PROGRAM) pg_tde_alter_key_provider$(X) '$(DESTDIR)$(bindir)/pg_tde_alter_key_provider$(X)'
$(INSTALL_PROGRAM) pg_tde_change_key_provider$(X) '$(DESTDIR)$(bindir)/pg_tde_change_key_provider$(X)'
installdirs:
$(MKDIR_P) '$(DESTDIR)$(bindir)'
uninstall:
rm -f '$(DESTDIR)$(bindir)/pg_tde_alter_key_provider$(X)'
rm -f '$(DESTDIR)$(bindir)/pg_tde_change_key_provider$(X)'
clean distclean:
rm -f pg_tde_alter_key_provider$(X) $(OBJS) $(RMGRDESCSOURCES) xlogreader.c xlogstats.c
rm -f pg_tde_change_key_provider$(X) $(OBJS) $(RMGRDESCSOURCES) xlogreader.c xlogstats.c
rm -rf tmp_check

@ -1,22 +1,22 @@
pg_tde_alter_key_provider_sources = files(
'pg_tde_alter_key_provider.c',
pg_tde_change_key_provider_sources = files(
'pg_tde_change_key_provider.c',
)
link_w = [pg_tde_frontend]
include_dirs = [postgres_inc, pg_tde_inc]
pg_tde_alter_key_provider = executable('pg_tde_alter_key_provider',
pg_tde_alter_key_provider_sources,
pg_tde_change_key_provider = executable('pg_tde_change_key_provider',
pg_tde_change_key_provider_sources,
dependencies: [frontend_code, lz4, zstd],
c_args: ['-DFRONTEND'], # needed for xlogreader et al
kwargs: default_bin_args,
include_directories: include_dirs,
link_with: link_w
)
bin_targets += pg_tde_alter_key_provider
bin_targets += pg_tde_change_key_provider
tests += {
'name': 'pg_tde_alter_key_provider',
'name': 'pg_tde_change_key_provider',
'sd': meson.current_source_dir(),
'bd': meson.current_build_dir(),
'tap': {

@ -10,20 +10,29 @@
#include <stdarg.h>
#include <stdio.h>
/* version string we expect back from pg_tde_modify_key_provider */
#define PROGNAME "pg_tde_modify_key_provider (PostgreSQL) " PG_VERSION "\n"
/* version string we expect back from pg_tde_change_key_provider */
#define PROGNAME "pg_tde_change_key_provider (PostgreSQL) " PG_VERSION "\n"
static void
help(void)
{
printf("pg_tde_modify_key_provider changes the configuration of a pg_tde key provider\n");
puts("pg_tde_change_key_provider changes the configuration of a pg_tde key provider");
puts("");
printf("Usage:\n");
printf("pg_tde_modify_key_provider [-D <datadir>] <dbOid> <provider_name> file <filename>\n");
printf("pg_tde_modify_key_provider [-D <datadir>] <dbOid> <provider_name> vault <token> <url> <mount_path> [<ca_path>]\n");
printf("pg_tde_modify_key_provider [-D <datadir>] <dbOid> <provider_name> kmip <host> <port> <cert_path> [<ca_path>]\n");
printf("\nWARNING:\n");
printf("This tool only changes the values, without properly XLogging the changes. Only use it in case the database is inaccessible and can't be started.\n");
puts("Usage:");
puts("");
puts("pg_tde_change_key_provider [-D <datadir>] <dbOid> <provider_name> <new_provider_type> <provider_parameters...>");
puts("");
puts(" Where <new_provider_type> can be file, vault or kmip");
puts("");
puts("Depending on the provider type, the complete parameter list is:");
puts("");
puts("pg_tde_change_key_provider [-D <datadir>] <dbOid> <provider_name> file <filename>");
puts("pg_tde_change_key_provider [-D <datadir>] <dbOid> <provider_name> vault <token> <url> <mount_path> [<ca_path>]");
puts("pg_tde_change_key_provider [-D <datadir>] <dbOid> <provider_name> kmip <host> <port> <cert_path> [<ca_path>]");
puts("");
puts("WARNING:");
puts("");
puts("This tool only changes the values, without properly XLogging the changes, or adjusting the configuration in the running postgres processes. Only use it in case the database is inaccessible and can't be started.\n");
}
#define BUFFER_SIZE 1024
@ -110,7 +119,7 @@ main(int argc, char *argv[])
pg_logging_init(argv[0]);
pg_logging_set_level(PG_LOG_WARNING);
set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_tde_alter_key_provider"));
set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_tde_change_key_provider"));
if (argc > 1)
{
@ -121,7 +130,7 @@ main(int argc, char *argv[])
}
if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
{
puts("pg_tde_alter_key_provider (PostgreSQL) " PG_VERSION);
puts("pg_tde_change_key_provider (PostgreSQL) " PG_VERSION);
exit(0);
}
}
Loading…
Cancel
Save