Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

ppk decrypt

Decrypt a .ppke encrypted archive into a .ppk file, optionally extracting it immediately afterward. Use this command for new recovery workflows.

Command Format:

ppk decrypt --input <INPUT_FILE> --output <OUTPUT_FILE> [--apply] [--config-home <DIR>]
ppk decrypt --input <INPUT_FILE> --extract --output-dir <DIR> [--apply] [--config-home <DIR>]

Description

  • --input <INPUT_FILE>: The .ppke file to decrypt.
  • --output <OUTPUT_FILE>: The resulting decrypted .ppk file.
  • --extract: Extract the archive immediately after decryption.
  • --output-dir <DIR>: Destination directory when using --extract.
  • --apply: Perform decryption; without it, only report checks.
  • --config-home <DIR>: Configuration directory containing recovery decryption settings.

Usage Sample

ppk decrypt --input /tmp/backup.ppke --output /tmp/backup.ppk --apply --config-home /path/to/conf
ppk decrypt --input /tmp/backup.ppke --extract --output-dir /tmp/restore --apply --config-home /path/to/conf

Behaviour description

  • Decrypt using private_key_file from [restore_encryption].
  • If the private key is password-protected, provide its password securely for the runtime environment.
  • Before decrypting or extracting into production, verify the archive contents in an isolated directory.

Compatibility

Legacy .tar.gz.enc and transitional .ppk.enc files remain supported for decryption. Existing automation may continue using restore decrypt, but new workflows should use .ppke, .ppk and ppk decrypt.

v26.10.2001+202610201530