ssh

Description:

ssh

ssh #
SSH and SFTP client for Flutter. Wraps iOS library NMSSH and Android library JSch.
Installation #
Add ssh as a dependency in your pubspec.yaml file.
Known issue #


Platform exception in release mode for Android:
PlatformException(connection_failure, java.lang.ClassNotFoundException: com.jcraft.jsch.jce.Random, null)
copied to clipboard
There are 2 workarounds:


Disable shrink:
flutter build apk --no-shrink


Configure proguard-rules. Refer to this comment for details.




Usage #
Create a client using password authentication #
import 'package:ssh/ssh.dart';

var client = new SSHClient(
host: "my.sshtest",
port: 22,
username: "sha",
passwordOrKey: "Password01.",
);
copied to clipboard
Create a client using public key authentication #
import 'package:ssh/ssh.dart';

var client = new SSHClient(
host: "my.sshtest",
port: 22,
username: "sha",
passwordOrKey: {
"privateKey": """-----BEGIN RSA PRIVATE KEY-----
......
-----END RSA PRIVATE KEY-----""",
"passphrase": "passphrase-for-key",
},
);
copied to clipboard
OpenSSH keys
Recent versions of OpenSSH introduce a proprietary key format that is not supported by most other software, including this one, you must convert it to a PEM-format RSA key using the puttygen tool. On Windows this is a graphical tool. On the Mac, install it per these instructions. On Linux install your distribution's putty or puttygen packages.

Temporarily remove the passphrase from the original key (enter blank password as the new password)
ssh-keygen -p -f id_rsa
convert to RSA PEM format
puttygen id_rsa -O private-openssh -o id_rsa_unencrypted
re-apply the passphrase to the original key
ssh-keygen -p -f id_rsa
apply a passphrase to the converted key:
puttygen id_rsa_unencrypted -P -O private-openssh -o id_rsa_flutter
remove the unencrypted version:
rm id_rsa_unencrypted

Connect client #
await client.connect();
copied to clipboard
Close client #
await client.disconnect();
copied to clipboard
Execute SSH command #
var result = await client.execute("ps");
copied to clipboard
Shell #
Start shell:

Supported ptyType: vanilla, vt100, vt102, vt220, ansi, xterm

var result = await client.startShell(
ptyType: "xterm", // defaults to vanilla
callback: (dynamic res) {
print(res); // read from shell
}
);
copied to clipboard
Write to shell:
await client.writeToShell("ls\n");
copied to clipboard
Close shell:
await client.closeShell();
copied to clipboard
SFTP #
Connect SFTP:
await client.connectSFTP();
copied to clipboard
List directory:
var array = await client.sftpLs("/home"); // defaults to .
copied to clipboard
Create directory:
await client.sftpMkdir("testdir");
copied to clipboard
Rename file or directory:
await client.sftpRename(
oldPath: "testfile",
newPath: "newtestfile",
);
copied to clipboard
Remove directory:
await client.sftpRmdir("testdir");
copied to clipboard
Remove file:
await client.sftpRm("testfile");
copied to clipboard
Download file:
var filePath = await client.sftpDownload(
path: "testfile",
toPath: tempPath,
callback: (progress) {
print(progress); // read download progress
},
);

// Cancel download:
await client.sftpCancelDownload();
copied to clipboard
Upload file:
await client.sftpUpload(
path: filePath,
toPath: ".",
callback: (progress) {
print(progress); // read upload progress
},
);

// Cancel upload:
await client.sftpCancelUpload();
copied to clipboard
Close SFTP:
await client.disconnectSFTP();
copied to clipboard
Demo #
Refer to the example.