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

Skip to content

Fix some comments referencing the old pg_tde.dat and pg_tde.map files. #379

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 2 commits into from
May 30, 2025
Merged

Fix some comments referencing the old pg_tde.dat and pg_tde.map files. #379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13aba84
Remove non-sensical comment
AndersAstrand May 30, 2025
864191f
Clean up some comments referencing old key files
AndersAstrand May 30, 2025
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
5 changes: 2 additions & 3 deletions contrib/pg_tde/documentation/docs/command-line-tools/pg-waldump.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
To read encrypted WAL records, `pg_waldump` supports the following additional arguments:

* `keyring_path`: the directory where keyring configuration files for WAL are stored. These files include:
* `pg_tde.map`
* `pg_tde.dat`
* `pg_tde_keyrings`
* `1664_keys`
* `1664_providers`

!!! note

Expand Down
36 changes: 8 additions & 28 deletions contrib/pg_tde/src/access/pg_tde_tdemap.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,3 @@
/*-------------------------------------------------------------------------
*
* pg_tde_tdemap.c
* tde relation fork manager code
*
*
* IDENTIFICATION
* src/access/pg_tde_tdemap.c
*
*-------------------------------------------------------------------------
*/

#include "postgres.h"
#include "access/pg_tde_tdemap.h"
#include "common/file_perm.h"
Expand Down Expand Up @@ -133,7 +121,7 @@ tde_sprint_key(InternalKey *k)
}

/*
* Generates a new internal key for WAL and adds it to the _dat file.
* Generates a new internal key for WAL and adds it to the key file.
*
* We have a special function for WAL as it is being called during recovery
* start so there should be no XLog records and aquired locks. The key is
Expand Down Expand Up @@ -164,7 +152,7 @@ pg_tde_create_wal_key(InternalKey *rel_key_data, const RelFileLocator *newrlocat
}

/*
* Deletes the key map file for a given database.
* Deletes the key file for a given database.
*/
void
pg_tde_delete_tde_files(Oid dbOid)
Expand Down Expand Up @@ -195,7 +183,7 @@ pg_tde_save_principal_key_redo(const TDESignedPrincipalKeyInfo *signed_key_info)
}

/*
* Creates the key map file and saves the principal key information.
* Creates the key file and saves the principal key information.
*
* If the file pre-exist, it truncates the file before adding principal key
* information.
Expand Down Expand Up @@ -327,15 +315,7 @@ pg_tde_write_one_map_entry(int fd, const TDEMapEntry *map_entry, off_t *offset,
}

/*
* Calls the create map entry function to get an index into the keydata. This
* The keydata function will then write the encrypted key on the desired
* location.
*
* Key Map Table [pg_tde.map]:
* header: {Format Version, Principal Key Name}
* data: {OID, Flag, index of key in pg_tde.dat}...
*
* The caller must hold an exclusive lock on the map file to avoid
* The caller must hold an exclusive lock on the key file to avoid
* concurrent in place updates leading to data conflicts.
*/
void
Expand Down Expand Up @@ -613,7 +593,7 @@ pg_tde_wal_last_key_set_lsn(XLogRecPtr lsn, const char *keyfile_path)
}

/*
* Open for write and Validate File Header [pg_tde.*]:
* Open for write and Validate File Header:
* header: {Format Version, Principal Key Name}
*
* Returns the file descriptor in case of a success. Otherwise, error
Expand Down Expand Up @@ -748,7 +728,7 @@ tde_decrypt_rel_key(TDEPrincipalKey *principal_key, TDEMapEntry *map_entry)
}

/*
* Open for read and Validate File Header [pg_tde.*]:
* Open for read and Validate File Header:
* header: {Format Version, Principal Key Name}
*
* Returns the file descriptor in case of a success. Otherwise, error
Expand All @@ -774,7 +754,7 @@ pg_tde_open_file_read(const char *tde_filename, bool ignore_missing, off_t *curr
}

/*
* Open a TDE file [pg_tde.*]:
* Open a TDE file:
*
* Returns the file descriptor in case of a success. Otherwise, error
* is raised except when ignore_missing is true and the file does not exit.
Expand Down Expand Up @@ -864,7 +844,7 @@ pg_tde_read_one_map_entry2(int fd, int32 key_index, TDEMapEntry *map_entry, Oid
}

/*
* Get the principal key from the map file. The caller must hold
* Get the principal key from the key file. The caller must hold
* a LW_SHARED or higher lock on files before calling this function.
*/
TDESignedPrincipalKeyInfo *
Expand Down