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

* feat: add interactive mode for env:encrypt & env:decrypt

* style: remove whitespace changes

* feat: use password prompt & isInteractive()

* style: added end of line comma in array

* test: change/provide tests for interactive mode

* style: remove empty line

* formatting

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: hhermsen

src/Illuminate/Foundation/Console/EnvironmentDecryptCommand.php

@@ -10,6 +10,8 @@
 use Illuminate\Support\Str;
 use Symfony\Component\Console\Attribute\AsCommand;
 
+use function Laravel\Prompts\password;
+
 #[AsCommand(name: 'env:decrypt')]
 class EnvironmentDecryptCommand extends Command
 {
@@ -62,6 +64,10 @@ public function handle()
     {
         $key = $this->option('key') ?: Env::get('LARAVEL_ENV_ENCRYPTION_KEY');
 
+        if (! $key && $this->input->isInteractive()) {
+            $key = password('What is the decryption key?');
+        }
+
         if (! $key) {
             $this->fail('A decryption key is required.');
         }

src/Illuminate/Foundation/Console/EnvironmentEncryptCommand.php

@@ -9,6 +9,9 @@
 use Illuminate\Support\Str;
 use Symfony\Component\Console\Attribute\AsCommand;
 
+use function Laravel\Prompts\password;
+use function Laravel\Prompts\select;
+
 #[AsCommand(name: 'env:encrypt')]
 class EnvironmentEncryptCommand extends Command
 {
@@ -62,6 +65,21 @@ public function handle()
 
         $key = $this->option('key');
 
+        if (! $key && $this->input->isInteractive()) {
+            $ask = select(
+                label: 'What encryption key would you like to use?',
+                options: [
+                    'generate' => 'Generate a random encryption key',
+                    'ask' => 'Provide an encryption key',
+                ],
+                default: 'generate'
+            );
+
+            if ($ask == 'ask') {
+                $key = password('What is the encryption key?');
+            }
+        }
+
         $keyPassed = $key !== null;
 
         $environmentFile = $this->option('env')

tests/Integration/Console/EnvironmentDecryptCommandTest.php

@@ -284,4 +284,28 @@ public function testItCannotOverwriteEncryptedFiles()
             ->expectsOutputToContain('Invalid filename.')
             ->assertExitCode(1);
     }
+
+    public function testItGeneratesTheEnvironmentFileWithInteractivelyUserProvidedKey()
+    {
+        $this->filesystem->shouldReceive('exists')
+            ->once()
+            ->andReturn(true)
+            ->shouldReceive('exists')
+            ->once()
+            ->andReturn(false)
+            ->shouldReceive('get')
+            ->once()
+            ->andReturn(
+                (new Encrypter($key = 'abcdefghijklmnop', 'aes-128-gcm'))
+                    ->encrypt('APP_NAME="Laravel Two"')
+            );
+
+        $this->artisan('env:decrypt', ['--cipher' => 'aes-128-gcm'])
+            ->expectsQuestion('What is the decryption key?', $key)
+            ->expectsOutputToContain('Environment successfully decrypted.')
+            ->assertExitCode(0);
+
+        $this->filesystem->shouldHaveReceived('put')
+            ->with(base_path('.env'), 'APP_NAME="Laravel Two"');
+    }
 }

tests/Integration/Console/EnvironmentEncryptCommandTest.php

@@ -34,6 +34,7 @@ public function testItFailsWithInvalidCipherFails()
             ->andReturn(false);
 
         $this->artisan('env:encrypt', ['--cipher' => 'invalid'])
+            ->expectsQuestion('What encryption key would you like to use?', 'generate')
             ->expectsOutputToContain('Unsupported cipher')
             ->assertExitCode(1);
     }
@@ -62,6 +63,7 @@ public function testItGeneratesTheCorrectFileWhenUsingEnvironment()
             ->andReturn(false);
 
         $this->artisan('env:encrypt', ['--env' => 'production'])
+            ->expectsQuestion('What encryption key would you like to use?', 'generate')
             ->expectsOutputToContain('.env.production.encrypted')
             ->assertExitCode(0);
 
@@ -80,6 +82,7 @@ public function testItGeneratesTheCorrectFileWhenNotUsingEnvironment()
             ->shouldReceive('get');
 
         $this->artisan('env:encrypt')
+            ->expectsQuestion('What encryption key would you like to use?', 'generate')
             ->expectsOutputToContain('.env.encrypted')
             ->assertExitCode(0);
 
@@ -92,6 +95,7 @@ public function testItFailsWhenEnvironmentFileCannotBeFound()
         $this->filesystem->shouldReceive('exists')->andReturn(false);
 
         $this->artisan('env:encrypt')
+            ->expectsQuestion('What encryption key would you like to use?', 'generate')
             ->expectsOutputToContain('Environment file not found.')
             ->assertExitCode(1);
     }
@@ -101,6 +105,7 @@ public function testItFailsWhenEncryptionFileExists()
         $this->filesystem->shouldReceive('exists')->andReturn(true);
 
         $this->artisan('env:encrypt')
+            ->expectsQuestion('What encryption key would you like to use?', 'generate')
             ->expectsOutputToContain('Encrypted environment file already exists.')
             ->assertExitCode(1);
     }
@@ -115,6 +120,7 @@ public function testItGeneratesTheEncryptionFileWhenForcing()
             ->andReturn(true);
 
         $this->artisan('env:encrypt', ['--force' => true])
+            ->expectsQuestion('What encryption key would you like to use?', 'generate')
             ->expectsOutputToContain('.env.encrypted')
             ->assertExitCode(0);
 
@@ -166,6 +172,7 @@ public function testItCanRemoveTheOriginalFile()
             ->andReturn(false);
 
         $this->artisan('env:encrypt', ['--prune' => true])
+            ->expectsQuestion('What encryption key would you like to use?', 'generate')
             ->expectsOutputToContain('.env.encrypted')
             ->assertExitCode(0);
 
@@ -175,4 +182,22 @@ public function testItCanRemoveTheOriginalFile()
         $this->filesystem->shouldHaveReceived('delete')
             ->with(base_path('.env'));
     }
+
+    public function testItEncryptsWithInteractivelyGivenKeyAndDisplaysIt()
+    {
+        $this->filesystem->shouldReceive('exists')
+            ->once()
+            ->andReturn(true)
+            ->shouldReceive('exists')
+            ->once()
+            ->andReturn(false);
+
+        $this->artisan('env:encrypt')
+            ->expectsQuestion('What encryption key would you like to use?', 'ask')
+            ->expectsQuestion('What is the encryption key?', $key = 'ANvVbPbE0tWMHpUySh6liY4WaCmAYKXP')
+            ->expectsOutputToContain('Environment successfully encrypted')
+            ->expectsOutputToContain($key)
+            ->expectsOutputToContain('.env.encrypted')
+            ->assertExitCode(0);
+    }
 }