ftp_exec()

Understanding the PHP Function ftp_exec()

This tutorial explains the historical ftp_exec() function, why it was removed, and how to securely execute remote commands in modern PHP.

What is ftp_exec()?

The ftp_exec() function was a built-in PHP function that allowed you to execute a command on a remote FTP server. It previously took two parameters:

1. ftp_stream: The connection identifier returned by the ftp_connect() function.
2. command: The command you want to execute on the FTP server.

The function returned a boolean value. If the function was successful in executing the command, it returned true. Otherwise, it returned false.

Important: ftp_exec() relied on the FTP server supporting the SITE EXECUTE command. Due to severe security risks, this feature was disabled by default on most modern FTP servers (such as vsftpd and ProFTPD). More importantly, ftp_exec() was deprecated in PHP 5.3.0 and removed in PHP 7.0.0, making it completely unavailable in modern PHP versions.

Syntax of ftp_exec()

The historical syntax of the ftp_exec() function was as follows:

Syntax of ftp_exec()

bool ftp_exec ( resource $ftp_stream , string $command )

(Note: This function historically accepted a resource connection identifier. The OOP FTP\Connection class was introduced in PHP 8.0, after ftp_exec() had already been removed.)

Secure Remote Command Execution

Because ftp_exec() is removed and FTP lacks secure command execution, you should use SSH-based libraries instead. The ssh2 extension or phpseclib are the standard approaches for modern PHP.

Usage with ssh2 extension

<?php

// Set up an SSH connection
$conn = ssh2_connect('ftp.example.com', 22);
if (!$conn) {
    die("Could not connect to server.");
}

// Login with SSH credentials
if (!ssh2_auth_password($conn, 'username', 'password')) {
    die("SSH login failed.");
}

// Execute a command
$stream = ssh2_exec($conn, 'ls -al');
if ($stream === false) {
    die("Failed to execute command.");
}

// Read output
$output = stream_get_contents($stream);

// Close the connection
ssh2_disconnect($conn);

In this example, we establish an SSH connection using the ssh2_connect() function. Then we authenticate using ssh2_auth_password(). Finally, we execute a command using ssh2_exec() and close the connection using ssh2_disconnect().

Error handling in modern remote execution

It's important to handle errors properly when executing remote commands. If the function returns false, it means that the command couldn't be executed for some reason. Here's an example of how to handle errors:

Error handling in ssh2_exec()

<?php

$stream = ssh2_exec($conn, 'ls -al');
if ($stream === false) {
    echo "Failed to execute the command.\n";
} else {
    echo "Command executed successfully.\n";
}

In this example, we check the return value of the ssh2_exec() function. If it's false, we display an error message; otherwise, we display a success message.

Conclusion

The ftp_exec() function was deprecated in PHP 5.3.0 and removed in PHP 7.0.0 due to security vulnerabilities and the lack of secure command execution over FTP. For remote command execution in modern PHP, always use SSH-based solutions like the ssh2 extension or phpseclib.

Practice