ssh2_auth_password - PHP code example

PHP Function SSH2_AUTH_PASSWORD

The php function ssh2_auth_password allows you to authenticate over SSH with a plain text password. This can be useful when you need to perform SSH or SFTP tasks and have no access to a Unix shadow file, homebrewed authentication script with root privileges, or need to connect to a host that requires a challenge response authentication.

You should note that ssh2_auth_password raises a PHP warning on failure, so you may want to set display_errors and error_reporting to On when using this function. Additionally, the ssh2 library doesn't support partial auths very cleanly (e.g. if you pass public key and password, it will fail).

To get this function to work properly you'll need a full ssh2 installation on your host machine. Installing this will allow you to leverage a number of handy classes which simplify the code needed to perform SSH and SFTP operations. ssh2_scp_send() and ssh2_sftp_send() will both return a boolean which indicates whether the operation was successful or not. This will allow you to make sure that the SSH and SFTP connections were made before attempting to copy or move files from your local computer to the remote server.

ssh2_auth_password example

parent::__construct($jail);
  }

  /** * {@inheritdoc} */
  public function connect() {
    $this->connection = @ssh2_connect($this->hostname, $this->port);
    if (!$this->connection) {
      throw new FileTransferException('SSH Connection failed to @host:@port', 0, ['@host' => $this->hostname, '@port' => $this->port]);
    }
    if (!@ssh2_auth_password($this->connection, $this->username, $this->password)) {
      throw new FileTransferException('The supplied username/password combination was not accepted.');
    }
  }

  /** * {@inheritdoc} */
  public static function factory($jail, $settings) {
    $username = empty($settings['username']) ? '' : $settings['username'];
    $password = empty($settings['password']) ? '' : $settings['password'];
    $hostname = empty($settings['advanced']['hostname']) ? 'localhost' : $settings['advanced']['hostname'];

sprintf(
                    /* translators: %s: hostname:port */
                    __( 'Failed to connect to SSH2 Server %s' ),
                    $this->options['hostname'] . ':' . $this->options['port']
                )
            );

            return false;
        }

        if ( ! $this->keys ) {
            if ( ! @ssh2_auth_password( $this->link, $this->options['username'], $this->options['password'] ) ) {
                $this->errors->add(
                    'auth',
                    sprintf(
                        /* translators: %s: Username. */
                        __( 'Username/Password incorrect for %s' ),
                        $this->options['username']
                    )
                );

                return false;
            }
        }