How to get a proper error message when SFTP host is invalid

Question

I wrote a function in Laravel to test an SFTP connection with user-supplied server credentials. This function works fine and shows an appropriate message regarding connection status.

public function testConnection(Request $request)
{
    $data = $request->all();
    $this->protocol = $data['protocol'];
    $this->host = $data['domain_name'];
    $this->username = $data['username'];
    $this->password = $data['password'];
    $this->port = $data['port'];
    $returnData = $this->checkFtp();
    return response()->json(['status' => true, 'connectionStatus' => $returnData]);
}

public function checkFtp()
{
    // Variable initialization
    $returnData = 'success';

    // SFTP connection test
    if ($this->protocol === 'sftp') {
        $sftp = new SFTP($this->host, $this->port, $this->timeout);
        if ($sftp) {
            if (!$sftp->login($this->username, $this->password)) {
                $returnData = 'Unable to login to the SFTP server';
            }
        } else {
            $returnData = 'Unable to connect to SFTP server';
        }
    }
}

When a user provides an invalid host, Internal server error is happening. So I can't get a message in returns to display.

How can I get a proper error message in return of this function?

Sample (While providing actual credentials)

{  
   "status":true,
   "connectionStatus":"success"
}

Internal server error (While giving a wrong hostname or IP)

{
"message": "Cannot connect to invalid.host.com:22. Error 113. No route to host",
"exception": "ErrorException",
"file": "/var/www/html/rvhost_admin/vendor/phpseclib/phpseclib/phpseclib/Net/SSH2.php",
"line": 1139,
"trace": [
    {
        "function": "handleError",
        "class": "Illuminate\\Foundation\\Bootstrap\\HandleExceptions",
        "type": "->"
    },
    {
        "file": "/var/www/html/rvhost_admin/vendor/phpseclib/phpseclib/phpseclib/Net/SSH2.php",
        "line": 1139,
        "function": "user_error"
    },
    {
        "file": "/var/www/html/rvhost_admin/vendor/phpseclib/phpseclib/phpseclib/Net/SSH2.php",
        "line": 2158,
        "function": "_connect",
        "class": "phpseclib\\Net\\SSH2",
        "type": "->"
    },

Update: I have rewritten the function by adding try -- catch, but still i am getting the same error...

// SFTP connection test
    if ($this->protocol === 'sftp') {
        try {
            $sftp = new SFTP($this->host, $this->port, $this->timeout);
            if ($sftp) {
                if (!$sftp->login($this->username, $this->password)) {
                    $returnData = 'Unable to login to the SFTP server';
                }
            } else {
                $returnData = 'Unable to connect to SFTP server';
            }
        } catch(Exception $e) {
            $returnData = $e->getMessage();
        }
    }

You haven't mentioned how you call this function. Return is a json response, i think you are using this as api, right? — VishnuPrasad, Apr 05 '19 at 11:22
@rbvishnu sorry to mention that in my question. I wrote this file as api for an angular project. I called this function from angular6 service.ts file. — Anoop Sankar, Apr 05 '19 at 11:34
Is your code namespace'd? If so you may need to do `} catch(\Exception $e) {` instead of `} catch(Exception $e) {`. — neubert, Apr 05 '19 at 12:17

score 2 · Accepted Answer · answered Apr 05 '19 at 12:01

2

I think you can handle this within subscribe() like the one below. The 500 internal error message will get in 'error'. just console that 'error' to view the message

this.service.functionname(this.form.value).subscribe(data => {
    console.log(data);
}, error => {
    console.log(error);
});

answered Apr 05 '19 at 12:01

Pranav s

164
1
11

I haven't think that from angular's side. Still i am thinking to fix this issue from PHP's end. Anyway thanks for the answer.. – Anoop Sankar Apr 05 '19 at 12:07

How to get a proper error message when SFTP host is invalid

1 Answers1