degagne / libssh2

src/Authentication/Agent.php

Doc Comments +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
     /**
      * Constructor.
      *
-     * @param  object $configuration Configuration object
+     * @param  Configuration $configuration Configuration object
      * @return void
      */
     public function __construct(Configuration $configuration)

src/Authentication/Hostbased.php

Doc Comments +1 added lines, -1 removed lines

@@ -56,7 +56,7 @@
     /**
      * Constructor.
      *
-     * @param  object $configuration Configuration object
+     * @param  Configuration $configuration Configuration object
      * @return void
      */
     public function __construct(Configuration $configuration)

src/Authentication/None.php

Doc Comments +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
     /**
      * Constructor.
      *
-     * @param  object $configuration Configuration object
+     * @param  Configuration $configuration Configuration object
      * @return void
      */
     public function __construct(Configuration $configuration)

src/Authentication/Password.php

Doc Comments +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
     /**
      * Constructor.
      *
-     * @param  object $configuration Configuration object
+     * @param  Configuration $configuration Configuration object
      * @return void
      */
     public function __construct(Configuration $configuration)

src/Authentication/PublicKey.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
     /**
      * Constructor.
      *
-     * @param  object $configuration Configuration object
+     * @param  Configuration $configuration Configuration object
      * @return void
      */
     public function __construct(Configuration $configuration)

src/Builder.php

Doc Comments +3 added lines, -3 removed lines

@@ -49,7 +49,7 @@ 
      * Set command line prefix.
      *
      * @param  string $prefix command line prefix
-     * @return object class object
+     * @return Builder class object
      */
     final public function setPrefix($prefix)
     {
@@ -61,7 +61,7 @@ 
      * Set command line options
      *
      * @param  array  $opts command line options
-     * @return object class object
+     * @return Builder class object
      */
     final public function setOptions(array $opts)
     {
@@ -85,7 +85,7 @@ 
      * Set command line arguments
      *
      * @param  array  $args command line arguments
-     * @return object class object
+     * @return Builder class object
      */
     final public function setArguments(array $args)
     {

Indentation +26 added lines, -26 removed lines

@@ -11,21 +11,21 @@ 
 class Builder
 {
 
-	/**
+    /**
      * Command prefix.
      *
      * @var string
      */
-	public $prefix;
+    public $prefix;
 	
-	/**
+    /**
      * Command options.
      *
      * @var array
      */
     public $options;
 	
-	/**
+    /**
      * Command arguments.
      *
      * @var array
@@ -67,16 +67,16 @@ 
     {
         $this->options = [];
         foreach ($opts as $key => $value)
-		{
-			if (preg_match('/^-.*$/', $key, $matches))
-			{
-				$this->options[] = is_bool($value) ? $key : str_pad($key, strlen($key) + 1, ' ', STR_PAD_RIGHT) . $value;
-			}
-			if (preg_match('/^-.*$/', $value, $matches))
-			{
-				$this->options[] = $value;
-			}
-		}
+        {
+            if (preg_match('/^-.*$/', $key, $matches))
+            {
+                $this->options[] = is_bool($value) ? $key : str_pad($key, strlen($key) + 1, ' ', STR_PAD_RIGHT) . $value;
+            }
+            if (preg_match('/^-.*$/', $value, $matches))
+            {
+                $this->options[] = $value;
+            }
+        }
         $this->options = implode(' ', array_filter($this->options, 'strlen'));
         return $this;
     }
@@ -89,19 +89,19 @@ 
      */
     final public function setArguments(array $args)
     {
-		$this->arguments = [];
+        $this->arguments = [];
         foreach ($args as $key => $value)
-		{
-			if (preg_match('/^-.*$/', $key, $matches))
-			{
-				$this->arguments[] = is_bool($value) ? $key : str_pad($key, strlen($key) + 1, ' ', STR_PAD_RIGHT) . $value;
-			}
-			else
-			{
-				$this->arguments[] = is_array($value) ? implode(' ', $value) : $value;
-			}
-		}
-		$this->arguments = implode(' ', array_filter($this->arguments, 'strlen'));
+        {
+            if (preg_match('/^-.*$/', $key, $matches))
+            {
+                $this->arguments[] = is_bool($value) ? $key : str_pad($key, strlen($key) + 1, ' ', STR_PAD_RIGHT) . $value;
+            }
+            else
+            {
+                $this->arguments[] = is_array($value) ? implode(' ', $value) : $value;
+            }
+        }
+        $this->arguments = implode(' ', array_filter($this->arguments, 'strlen'));
         return $this;
     }
 }

src/Configuration.php

Doc Comments +13 added lines, -14 removed lines

@@ -92,7 +92,7 @@ 
      * Sets username.
      *
      * @param  string $username username
-     * @return object \LibSSH2\Configuration object
+     * @return Configuration \LibSSH2\Configuration object
      */
     final public function set_username($username)
     {
@@ -104,7 +104,7 @@ 
      * Sets user password.
      *
      * @param  string $password password
-     * @return object \LibSSH2\Configuration object
+     * @return Configuration \LibSSH2\Configuration object
      */
     final public function set_password($password)
     {
@@ -115,8 +115,8 @@ 
 	/**
      * Sets RSA public key.
      *
-     * @param  string $publickey RSA public key
-     * @return object \LibSSH2\Configuration object
+     * @param  string $public_key RSA public key
+     * @return Configuration \LibSSH2\Configuration object
      */
     final public function set_publickey($public_key)
     {
@@ -127,8 +127,8 @@ 
 	/**
      * Sets RSA private key.
      *
-     * @param  string $privatekey RSA private key
-     * @return object \LibSSH2\Configuration object
+     * @param  string $private_key RSA private key
+     * @return Configuration \LibSSH2\Configuration object
      */
     final public function set_privatekey($private_key)
     {
@@ -140,7 +140,7 @@ 
      * Sets passphrase.
      *
      * @param  string $passphrase passphrase
-     * @return object \LibSSH2\Configuration object
+     * @return Configuration \LibSSH2\Configuration object
      */
     final public function set_passphrase($passphrase)
     {
@@ -152,7 +152,7 @@ 
      * Sets hostname.
      *
      * @param  string $host hostname
-     * @return object \LibSSH2\Configuration object
+     * @return Configuration \LibSSH2\Configuration object
      */
     final public function set_host($host)
     {
@@ -164,7 +164,7 @@ 
      * Sets port.
      *
      * @param  int    $port port
-     * @return object \LibSSH2\Configuration object
+     * @return Configuration \LibSSH2\Configuration object
      */
     final public function set_port($port)
     {
@@ -176,7 +176,7 @@ 
      * Sets methods.
      *
      * @param  array  $methods remote connection methods
-     * @return object \LibSSH2\Configuration object
+     * @return Configuration \LibSSH2\Configuration object
      */
     final public function set_methods(array $methods = null)
     {
@@ -190,7 +190,7 @@ 
 	/**
      * Sets tunnel.
      *
-     * @return object \LibSSH2\Configuration object
+     * @return Configuration \LibSSH2\Configuration object
      */
     final public function set_tunnel()
     {
@@ -201,8 +201,7 @@ 
     /**
      * Sets tunnel hostname.
      *
-     * @param  string $hostname hostname
-     * @return object \LibSSH2\Configuration object
+     * @return Configuration \LibSSH2\Configuration object
      */
     final public function set_tunnel_host($host)
     {
@@ -215,7 +214,7 @@ 
      * Sets tunnel port.
      *
      * @param  int    $port port
-     * @return object \LibSSH2\Configuration object
+     * @return Configuration \LibSSH2\Configuration object
      */
     final public function set_tunnel_port($port)
     {

Indentation +19 added lines, -19 removed lines

@@ -11,35 +11,35 @@ 
 class Configuration
 {
 
-	/**
+    /**
      * Username.
      *
      * @var string
      */
     protected $username = null;
 	
-	/**
+    /**
      * User password.
      *
      * @var string
      */
     protected $password = null;
 
-	/**
+    /**
      * RSA public key.
      *
      * @var string
      */
     protected $publickey = null;
 	
-	/**
+    /**
      * RSA private key.
      *
      * @var string
      */
     protected $privatekey = null;
 	
-	/**
+    /**
      * Passphrase.
      *
      * @var string
@@ -67,7 +67,7 @@ 
      */
     protected $methods = [];
     
-	/**
+    /**
      * SSH tunnel requested.
      *
      * @var boolean
@@ -88,7 +88,7 @@ 
      */
     protected $tunnel_port = 22;
 
-	/**
+    /**
      * Sets username.
      *
      * @param  string $username username
@@ -100,7 +100,7 @@ 
         return $this;
     }
 	
-	/**
+    /**
      * Sets user password.
      *
      * @param  string $password password
@@ -112,7 +112,7 @@ 
         return $this;
     }
 
-	/**
+    /**
      * Sets RSA public key.
      *
      * @param  string $publickey RSA public key
@@ -124,7 +124,7 @@ 
         return $this;
     }
 
-	/**
+    /**
      * Sets RSA private key.
      *
      * @param  string $privatekey RSA private key
@@ -136,7 +136,7 @@ 
         return $this;
     }
 	
-	/**
+    /**
      * Sets passphrase.
      *
      * @param  string $passphrase passphrase
@@ -187,7 +187,7 @@ 
         return $this;
     }
 
-	/**
+    /**
      * Sets tunnel.
      *
      * @return object \LibSSH2\Configuration object
@@ -206,7 +206,7 @@ 
      */
     final public function set_tunnel_host($host)
     {
-		$this->set_tunnel();
+        $this->set_tunnel();
         $this->tunnel_host = $host;
         return $this;
     }
@@ -223,7 +223,7 @@ 
         return $this;
     }
 
-	/**
+    /**
      * Returns username.
      *
      * @return string username
@@ -237,7 +237,7 @@ 
         return $this->username;
     }
 
-	/**
+    /**
      * Returns user's password.
      *
      * @return string password
@@ -251,7 +251,7 @@ 
         return $this->password;
     }
 
-	/**
+    /**
      * Returns RSA public key.
      *
      * @return string RSA public key
@@ -265,7 +265,7 @@ 
         return $this->publickey;
     }
 	
-	/**
+    /**
      * Returns RSA private key.
      *
      * @return string privatekey
@@ -279,7 +279,7 @@ 
         return $this->privatekey;
     }
 	
-	/**
+    /**
      * Returns passphrase.
      *
      * @return string passphrase
@@ -326,7 +326,7 @@ 
         }
     }
 
-	/**
+    /**
      * Returns tunnel.
      *
      * @return boolean

src/Connection.php

Doc Comments +4 added lines, -7 removed lines

@@ -22,9 +22,8 @@ 
     /**
      * Constructor.
      *
-     * @param  instance $configuration  Configuration class instance
-     * @param  instance $authentication Authentication class instance
-     * @param  boolean  $tunnel         require SSH tunnel
+     * @param  Configuration $configuration  Configuration class instance
+     * @param  Authentication $authentication Authentication class instance
      * @return void
      */
     public function __construct(Configuration $configuration, Authentication $authentication)
@@ -56,7 +55,7 @@ 
     /**
      * Create remote connection resource.
      *
-     * @param  resource $configuration \LibSSH2\Configuration object
+     * @param  Configuration $configuration \LibSSH2\Configuration object
      * @return void
      */
     final public function connect(Configuration $configuration)
@@ -71,8 +70,6 @@ 
     /**
      * Create remote tunnel connection resource.
      *
-     * @param  string $host hostname
-     * @param  int    $port port (default=22)
      * @return void
      */
     final public function tunnel(Configuration $configuration)
@@ -87,7 +84,7 @@ 
     /**
      * Authenticate remote connection resource.
      *
-     * @param  resource $authentication \LibSSH2\Authentication\Authentication interface object
+     * @param  Authentication $authentication \LibSSH2\Authentication\Authentication interface object
      * @return void
      */
     final public function authenticate(Authentication $authentication)

Indentation +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
      */
     public function __construct(Configuration $configuration, Authentication $authentication)
     {
-		if (extension_loaded('ssh2') == false)
+        if (extension_loaded('ssh2') == false)
         {
             throw new \RuntimeException('The libssh2 extension is not loaded.');
         }

src/Kerberos.php

Doc Comments +3 added lines, -2 removed lines

@@ -24,8 +24,8 @@ 
 	/**
      * Constructor.
      *
-     * @param  instance $configuration  Configuration instance
-     * @param  instance $authentication Authentication instance
+     * @param  Configuration $configuration  Configuration instance
+     * @param  Authentication $authentication Authentication instance
      * @return void
      */
     public function __construct(Configuration $configuration, Authentication $authentication)
@@ -131,6 +131,7 @@ 
 	 * Execute Kerberos command.
 	 *
 	 * @param  string  $command   command to be executed
+	 * @param boolean $strict
 	 * @return array   return code and STDOUT
 	 */
 	final private function _exec($command, $strict)

Indentation +110 added lines, -110 removed lines

@@ -17,11 +17,11 @@ 
  */
 class Kerberos
 {
-	private $configuration;
+    private $configuration;
 
-	private $authentication;
+    private $authentication;
 
-	/**
+    /**
      * Constructor.
      *
      * @param  instance $configuration  Configuration instance
@@ -31,121 +31,121 @@ 
     public function __construct(Configuration $configuration, Authentication $authentication)
     {
         if (get_class($authentication) != 'LibSSH2\Authentication\Password')
-		{
-			throw new \RuntimeException("Kerberos authentication requires Password authentication to remote server.");
-		}
-		$this->configuration = $configuration;
-		$this->authentication = $authentication;
+        {
+            throw new \RuntimeException("Kerberos authentication requires Password authentication to remote server.");
+        }
+        $this->configuration = $configuration;
+        $this->authentication = $authentication;
     }
 
-	/**
-	 * kcreate creates a Kerberos credential (ticket) cache and sets the
-	 * KRB5CCNAME environmental variable.
-	 *
-	 * @return string Kerberos credential cache
-	 */
-	final public function kcreate($principle)
-	{
-		$username = $this->configuration->get_username();
-		$command = (new Builder())
-			->setPrefix('kinit')
-			->setArguments([$principle]);
+    /**
+     * kcreate creates a Kerberos credential (ticket) cache and sets the
+     * KRB5CCNAME environmental variable.
+     *
+     * @return string Kerberos credential cache
+     */
+    final public function kcreate($principle)
+    {
+        $username = $this->configuration->get_username();
+        $command = (new Builder())
+            ->setPrefix('kinit')
+            ->setArguments([$principle]);
 
-		$shell = new Shell($this->configuration, $this->authentication);
-		$shell
-			->shell()
-			->write("export KRB5CCNAME=`mktemp /tmp/krb5cc_{$username}_XXXXXXXXXXXXX`;")
-			->write($command)
-			->write($this->configuration->get_password())
-			->write('echo KRB5CCNAME:$KRB5CCNAME', true)
-			->output();
+        $shell = new Shell($this->configuration, $this->authentication);
+        $shell
+            ->shell()
+            ->write("export KRB5CCNAME=`mktemp /tmp/krb5cc_{$username}_XXXXXXXXXXXXX`;")
+            ->write($command)
+            ->write($this->configuration->get_password())
+            ->write('echo KRB5CCNAME:$KRB5CCNAME', true)
+            ->output();
 
-		if (!preg_match("/KRB5CCNAME:(\/tmp\/krb5cc_.*)/", $shell->get_output(), $matches))
-		{
-			throw new \RuntimeException('Failed to create the Kerberos credential cache and set the KRB5CCNAME environmental variable.');
-		}
-		return $matches[1];
-	}
+        if (!preg_match("/KRB5CCNAME:(\/tmp\/krb5cc_.*)/", $shell->get_output(), $matches))
+        {
+            throw new \RuntimeException('Failed to create the Kerberos credential cache and set the KRB5CCNAME environmental variable.');
+        }
+        return $matches[1];
+    }
 
-	/**
-	 * The kdestroy utility destroys the user’s active Kerberos 
-	 * authorization tickets by overwriting and deleting the 
-	 * credentials cache that contains them. If the credentials 
-	 * cache is not specified, the default credentials cache is 
-	 * destroyed.
-	 *
-	 * @param  array  $options   klist command line options
-	 * @param  array  $arguments klist command line arguments
-	 * @return int    return code (exit status code)
-	 */
-	final public function kdestroy(array $options = [], array $arguments = [], $strict = true)
-	{
-		$command = (new Builder())
-			->setPrefix('kdestroy')
-			->setOptions($options)
-			->setArguments($arguments);
-		list($retval, $output) = $this->_exec($command, $strict);
-		return $retval;
-	}
+    /**
+     * The kdestroy utility destroys the user’s active Kerberos 
+     * authorization tickets by overwriting and deleting the 
+     * credentials cache that contains them. If the credentials 
+     * cache is not specified, the default credentials cache is 
+     * destroyed.
+     *
+     * @param  array  $options   klist command line options
+     * @param  array  $arguments klist command line arguments
+     * @return int    return code (exit status code)
+     */
+    final public function kdestroy(array $options = [], array $arguments = [], $strict = true)
+    {
+        $command = (new Builder())
+            ->setPrefix('kdestroy')
+            ->setOptions($options)
+            ->setArguments($arguments);
+        list($retval, $output) = $this->_exec($command, $strict);
+        return $retval;
+    }
 
-	/**
-	 * klist lists the Kerberos principal and Kerberos tickets held 
-	 * in a credentials cache, or the keys held in a keytab file.
-	 *
-	 * @param  array  $options   klist command line options
-	 * @param  array  $arguments klist command line arguments
-	 * @return string klist results
-	 */
-	final public function klist(array $options = [], array $arguments = [], $strict = true)
-	{
-		$command = (new Builder())
-			->setPrefix('klist')
-			->setOptions($options)
-			->setArguments($arguments);
-		list($retval, $output) = $this->_exec($command, $strict);
-		return $output;
-	}
+    /**
+     * klist lists the Kerberos principal and Kerberos tickets held 
+     * in a credentials cache, or the keys held in a keytab file.
+     *
+     * @param  array  $options   klist command line options
+     * @param  array  $arguments klist command line arguments
+     * @return string klist results
+     */
+    final public function klist(array $options = [], array $arguments = [], $strict = true)
+    {
+        $command = (new Builder())
+            ->setPrefix('klist')
+            ->setOptions($options)
+            ->setArguments($arguments);
+        list($retval, $output) = $this->_exec($command, $strict);
+        return $output;
+    }
 
-	/**
-	 * kinit obtains and caches an initial ticket-granting ticket for 
-	 * principal. If principal is absent, kinit chooses an appropriate 
-	 * principal name based on existing credential cache contents or 
-	 * the local username of the user invoking kinit. Some options 
-	 * modify the choice of principal name.
-	 *
-	 * @param  array  $options   kinit command line options
-	 * @param  array  $arguments kinit command line arguments
-	 * @return int    exit status code
-	 */
-	final public function kinit(array $options = [], array $arguments = [], $strict = true)
-	{
-		$command = (new Builder())
-			->setPrefix('kinit')
-			->setOptions($options)
-			->setArguments($arguments);
-		list($retval, $output) = $this->_exec($command, $strict);
-		return $retval;
-	}
+    /**
+     * kinit obtains and caches an initial ticket-granting ticket for 
+     * principal. If principal is absent, kinit chooses an appropriate 
+     * principal name based on existing credential cache contents or 
+     * the local username of the user invoking kinit. Some options 
+     * modify the choice of principal name.
+     *
+     * @param  array  $options   kinit command line options
+     * @param  array  $arguments kinit command line arguments
+     * @return int    exit status code
+     */
+    final public function kinit(array $options = [], array $arguments = [], $strict = true)
+    {
+        $command = (new Builder())
+            ->setPrefix('kinit')
+            ->setOptions($options)
+            ->setArguments($arguments);
+        list($retval, $output) = $this->_exec($command, $strict);
+        return $retval;
+    }
 
-	/**
-	 * Execute Kerberos command.
-	 *
-	 * @param  string  $command   command to be executed
-	 * @return array   return code and STDOUT
-	 */
-	final private function _exec($command, $strict)
-	{
-		$ssh = new SSH($this->configuration, $this->authentication);
-		$ssh->exec($command);
+    /**
+     * Execute Kerberos command.
+     *
+     * @param  string  $command   command to be executed
+     * @return array   return code and STDOUT
+     */
+    final private function _exec($command, $strict)
+    {
+        $ssh = new SSH($this->configuration, $this->authentication);
+        $ssh->exec($command);
 
-		$output = $ssh->get_output();
-		$error = $ssh->get_error();
-		$retval = $ssh->get_exitstatus();
+        $output = $ssh->get_output();
+        $error = $ssh->get_error();
+        $retval = $ssh->get_exitstatus();
 
-		if ($strict && $retval != 0 )
-		{
-			throw new \RuntimeException($error);
-		}
-		return [$retval, $output];
-	}
+        if ($strict && $retval != 0 )
+        {
+            throw new \RuntimeException($error);
+        }
+        return [$retval, $output];
+    }
 }