PG-1710 Create helpers for decrypting/encrypting archived WAL #487
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jeltz
force-pushed
the
tde/archive-restore-helpers
branch
from
5dc0f74 to
6c75dba
Compare
|
I am aware documentation us missing but I want some early feedback so that I don't waste more time if this is wrong. |
jeltz
force-pushed
the
tde/archive-restore-helpers
branch
from
6c75dba to
39cdf06
Compare
Codecov Report❌ Patch coverage is ❌ Your project status has failed because the head coverage (81.87%) is below the target coverage (90.00%). You can increase the head coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## TDE_REL_17_STABLE #487 +/- ##
=====================================================
- Coverage 83.68% 81.87% -1.82%
=====================================================
Files 21 24 +3
Lines 2771 3001 +230
Branches 435 489 +54
=====================================================
+ Hits 2319 2457 +138
- Misses 368 446 +78
- Partials 84 98 +14
🚀 New features to boost your workflow:
|
jeltz
force-pushed
the
tde/archive-restore-helpers
branch
16 times, most recently
from
aea6c32 to
1903471
Compare
dAdAbird
approved these changes
Jul 28, 2025
dutow
reviewed
Jul 28, 2025
| pg_fatal("mismatch of segment size in WAL file \"%s\" (header: %d bytes, file size: %ld bytes)", | ||
| segname, walsegsz, fsize); | ||
|
|
||
| if (!IsValidWalSegSize(walsegsz)) |
There was a problem hiding this comment.
Couldn't this part be a helper function to avoid the duplication in the two tools? And is_segment is also common
There was a problem hiding this comment.
I don't think the duplicated code is enough to bother but I could give it a shot and see if anything improves.
Now that we will soon be adding more bianries having them at the top level only makes things confusing for developers.
jeltz
force-pushed
the
tde/archive-restore-helpers
branch
3 times, most recently
from
e555fa8 to
56f4484
Compare
To support some common WAL archiving tools, e.g. PgBackRest, we implement an archive_command and a restore_command which can wrap any command and use pipe() to create fake file to either read from or write to. The restore command makes sure to write encrypted files if WAL encryption is enabled. It uses the fresh WAL key generated by the server on the current start which works fine because we then just let the first invocation of the restore command set the start LSN of the key. For e.g. PgBackRest you would have the following commands: archive_command = 'pg_tde_archive_decrypt %p pgbackrest --stanza=demo archive-push %p' restore_command = 'pg_tde_restore_encrypt %f %p pgbackrest --stanza=demo archive-get %f "%p"'
jeltz
force-pushed
the
tde/archive-restore-helpers
branch
from
56f4484 to
675d3f0
Compare
artemgavrilov
approved these changes
Jul 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To support some common WAL archiving tools, e.g. PgBackRest, we implement an
archive_commandand arestore_commandwhich can wrap any command and usepipe()to create fake file to either read from or write to. The restore command makes sure to write encrypted files if WAL encryption is enabled. It uses the fresh WAL key generated by the server on the current start which works fine because we then just let the first invocation of the restore command set the start LSN of the key.For e.g. PgBackRest you would have the following commands:
An alternative if we want to make sure to use
system()likearchive_commandandrestore_commandit would instead be, but feels a bit risky since people would have to remember to do %% for it to work.