feat: add --password to soul export for AES-256-GCM encryption at rest#294
Open
sshekhar563 wants to merge 2 commits into
Open
feat: add --password to soul export for AES-256-GCM encryption at rest#294sshekhar563 wants to merge 2 commits into
--password to soul export for AES-256-GCM encryption at rest#294sshekhar563 wants to merge 2 commits into
Conversation
- Changed --password to be a prompt-only flag (is_flag=True) so passwords aren't passed inline and leaked to shell history - Tests now use interactive prompts for export - Added warning when password is used with non-soul format - Added missing cryptography dependency check
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This PR implements Phase 2 of the encryption feature by wiring the
--passwordflag through thesoul exportCLI command. The underlying AES-256-GCM encryption and scrypt key derivation logic was already implemented in theruntime/export/crypto.pylayer; this PR surfaces it securely to the user.Key Changes
--passwordoption is implemented as a prompt-only flag (is_flag=True). This prevents users from passing passwords inline (e.g.--password mysecret), ensuring passwords do not leak into shell history or process listings.cryptographypackage is missing.manifest.jsonfile remains unencrypted so readers can inspect metadata and see the"encrypted": trueflag without needing the password.docs/cli-reference.mdwith the new option and an example of its interactive usage.tests/test_cli/test_export_password.pywith 9 tests covering archive structure, interactive prompt simulation, mismatched confirmation handling, format warnings, and async encryption/decryption round-trips.Verification
ruff checkandruff format --checkpass.tests/test_cli/test_export_password.py.