Merge pull request #46 from laravel/feat/improve-ssh-configure-command

Improves `ssh:configure` command
laravel · Nov 10, 2021 · 51dd724 · 51dd724
2 parents 855b150 + e5a2ad7
commit 51dd724
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 4 deletions.
diff --git a/app/Commands/SshConfigureCommand.php b/app/Commands/SshConfigureCommand.php
@@ -38,7 +38,9 @@ public function handle()
 
         $key = $this->getKey();
 
-        $this->ensureKeyExists($this->getKeyName($key), $key);
+        $privateKey = $this->ensureKeyExists($this->getKeyName($key), $key);
+
+        $this->callSilently('ssh:test', ['--key' => $privateKey]);
 
         $this->successfulStep('SSH key based secure authentication configured successfully');
     }
@@ -48,7 +50,7 @@ public function handle()
      *
      * @param  string  $name
      * @param  string|null  $key
-     * @return void
+     * @return string
      */
     protected function ensureKeyExists($name, $key = null)
     {
@@ -65,6 +67,8 @@ protected function ensureKeyExists($name, $key = null)
         $this->step('Adding Key <comment>['.$localName.']</comment>'.' With The Name <comment>['.$name.']</comment> To Server <comment>['.$server->name.']</comment>');
 
         $this->forge->createSSHKey($server->id, ['key' => $key, 'name' => $name], true);
+
+        return $this->keys->keysPath().'/'.basename($localName, '.pub');
     }
 
     /**

diff --git a/app/Commands/SshTestCommand.php b/app/Commands/SshTestCommand.php
@@ -10,7 +10,8 @@ class SshTestCommand extends Command
      * @var string
      */
     protected $signature = 'ssh:test
-        {server? : The server name}';
+        {server? : The server name}
+        {--key= : The path to the private key}';
 
     /**
      * The description of the command.
@@ -34,6 +35,12 @@ public function handle()
 
         $this->step('Establishing secure connection');
 
+        if ($this->option('key')) {
+            $this->remote->resolvePrivateKeyUsing(function () {
+                return $this->option('key');
+            });
+        }
+
         $this->remote->ensureSshIsConfigured();
 
         $this->successfulStep('SSH key based secure authentication is configured');

diff --git a/app/Repositories/RemoteRepository.php b/app/Repositories/RemoteRepository.php
@@ -7,6 +7,13 @@
 
 class RemoteRepository
 {
+    /**
+     * The private key resolver.
+     *
+     * @var callable|null
+     */
+    protected $privateKeyResolver = null;
+
     /**
      * The sockets path.
      *
@@ -129,7 +136,18 @@ public function exec($command)
     }
 
     /**
-     * Sets the current server.
+     * Sets the current private key resolver.
+     *
+     * @param  callable  $resolver
+     * @return void
+     */
+    public function resolvePrivateKeyUsing($resolver)
+    {
+        $this->privateKeyResolver = $resolver;
+    }
+
+    /**
+     * Sets the current server resolver.
      *
      * @param  callable  $resolver
      * @return void
@@ -195,6 +213,13 @@ protected function ssh($command = null)
             return "-o $option=$value";
         })->values()->implode(' ');
 
+        if ($this->privateKeyResolver) {
+            $options .= sprintf(
+                ' -o "IdentitiesOnly=yes" -i "%s"',
+                call_user_func($this->privateKeyResolver)
+            );
+        }
+
         return trim(sprintf(
             'ssh %s -t forge@%s %s',
             $options,

diff --git a/tests/Feature/SshConfigureCommandTest.php b/tests/Feature/SshConfigureCommandTest.php
@@ -34,6 +34,9 @@
         'key' => 'MY KEY Content',
     ], true)->once();
 
+    $this->remote->shouldReceive('resolvePrivateKeyUsing')->once();
+    $this->remote->shouldReceive('ensureSshIsConfigured')->once();
+
     $this->artisan('ssh:configure')
         ->expectsQuestion('<fg=yellow>‣</> <options=bold>Which Server Would You Like To Configure The SSH Key Based Secure Authentication</>', 1)
         ->expectsQuestion('<fg=yellow>‣</> <options=bold>Which Key Would You Like To Use</>', 0)
@@ -77,6 +80,9 @@
         'key' => 'MY KEY Content',
     ], true)->once();
 
+    $this->remote->shouldReceive('resolvePrivateKeyUsing')->once();
+    $this->remote->shouldReceive('ensureSshIsConfigured')->once();
+
     $this->artisan('ssh:configure', ['server' => 2])
         ->expectsQuestion('<fg=yellow>‣</> <options=bold>Which Key Would You Like To Use</>', 1)
         ->expectsQuestion('<fg=yellow>‣</> <options=bold>What Should The SSH Key Be Named In Forge</>', 'driesvints')