When you're using Sublime Text with the SFTP plugin, you might encounter a frustrating situation where your SSH key works seamlessly in PuTTY but is rejected in Sublime SFTP. This inconsistency can be confusing and disrupt your workflow. In this article, we will explore the reasons behind the "key refused" error in Sublime SFTP, how to fix it, and provide you with some useful tips to streamline your development process.
Understanding the Problem
You may run into an error message similar to this when trying to connect to your server using the Sublime SFTP plugin:
Key refused
However, when using PuTTY, the same SSH key successfully connects to the server without any issues. This disparity suggests there might be differences in the way these applications handle SSH keys.
Why Does This Happen?
The issue typically stems from the format and configuration of the SSH keys used in both applications. Here are some common reasons why the SSH key is refused in Sublime SFTP:
-
Key Format: Sublime SFTP may require the private key to be in OpenSSH format rather than PuTTY’s PPK format. PuTTY uses its own key format, which isn’t compatible with all applications.
-
Key Permissions: The permissions of the SSH private key file are crucial. If they are too open (for example, readable by others), the SSH service on the server will refuse the key for security reasons.
-
Configuration Errors: Incorrect configuration in the Sublime SFTP settings can lead to connectivity problems. It’s important to check that the settings reflect the correct host, username, and key path.
How to Fix the Issue
To resolve the "key refused" error, follow these steps:
Step 1: Convert PPK to OpenSSH Format
If your SSH key is in PPK format, you need to convert it to OpenSSH format. You can do this using PuTTYgen:
- Open PuTTYgen.
- Click "Load" and select your PPK file.
- Once loaded, go to "Conversions" in the menu.
- Select "Export OpenSSH key" and save the file in a safe location.
Step 2: Update Permissions for the Private Key
Ensure that the permissions on your private key are set correctly. On Unix-like systems, you can change the permissions by running:
chmod 600 /path/to/your/private_key
Step 3: Configure Sublime SFTP
Ensure that your sftp-config.json file is correctly configured. It should resemble the following example:
{
"type": "sftp",
"host": "your.server.com",
"user": "your_username",
"remote_path": "/path/to/remote/directory",
"private_key": "/path/to/your/private_key"
}
Make sure that the path to the private key matches the format you exported in Step 1.
Testing Your Configuration
After making the above changes, attempt to reconnect using Sublime SFTP. If all configurations are correct, the connection should establish without any errors. If the issue persists, double-check each step for accuracy and ensure the server settings permit your access.
Additional Tips
- Server Logs: If you have access to server logs, check them for additional error messages that may indicate the problem.
- Firewall Settings: Ensure that your firewall or security groups allow the connection from your IP address.
- Plugins and Updates: Make sure that both Sublime Text and the SFTP plugin are up to date, as updates may address compatibility issues.
Useful Resources
Conclusion
Encountering a "key refused" error in Sublime SFTP while your key works in PuTTY can be resolved by converting the key format, adjusting file permissions, and correctly configuring the SFTP settings. By following the steps outlined in this article, you can quickly resolve the issue and continue your development work without interruption. For additional support, consider visiting the documentation linked above to explore more in-depth solutions and community discussions.
By keeping these points in mind, you can troubleshoot and streamline your development process using Sublime Text and SFTP effectively.
