Skip to content
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

feat: interactive env:encrypt & env:decrypt #53081

Merged
merged 7 commits into from
Oct 10, 2024
Merged

feat: interactive env:encrypt & env:decrypt #53081

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8033af2
feat: add interactive mode for env:encrypt & env:decrypt
hhermsen Oct 9, 2024
80b0d32
style: remove whitespace changes
hhermsen Oct 9, 2024
13abe03
feat: use password prompt & isInteractive()
hhermsen Oct 10, 2024
84a9bbd
style: added end of line comma in array
hhermsen Oct 10, 2024
f8789d3
test: change/provide tests for interactive mode
hhermsen Oct 10, 2024
6a12016
style: remove empty line
hhermsen Oct 10, 2024
5ac6f93
formatting
taylorotwell Oct 10, 2024
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
4 changes: 4 additions & 0 deletions src/Illuminate/Foundation/Console/EnvironmentDecryptCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ public function handle()
{
$key = $this->option('key') ?: Env::get('LARAVEL_ENV_ENCRYPTION_KEY');

if (! $key) {
$key = $this->ask('Decryption key');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe better to use https://laravel.com/docs/11.x/prompts#password

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea, have changed this now

}

if (! $key) {
$this->fail('A decryption key is required.');
}
Expand Down
7 changes: 6 additions & 1 deletion src/Illuminate/Foundation/Console/EnvironmentEncryptCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ class EnvironmentEncryptCommand extends Command
{--cipher= : The encryption cipher}
{--env= : The environment to be encrypted}
{--prune : Delete the original environment file}
{--force : Overwrite the existing encrypted environment file}';
{--force : Overwrite the existing encrypted environment file}
{--interactive : Prompt the encryption key}';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should just use $this->input->isInteractive() instead of adding new option. https://github.com/symfony/console/blob/7.1/Input/InputInterface.php#L125

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did not know the existence of this one. Have used that instead. However, I've then also added a select prompt since I do want the interactive user to be able to opt for a generated key instead of having to provide one. This will however change the current interactive command line experience. Not sure if that would be a problem.


/**
* The console command description.
Expand Down Expand Up @@ -62,6 +63,10 @@ public function handle()

$key = $this->option('key');

if (! $key && $this->option('interactive')) {
$key = $this->ask('Encryption key');
}

$keyPassed = $key !== null;

$environmentFile = $this->option('env')
Expand Down