Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old


Authenticate a session with a public key, read from a file.

Component Version macOS Windows Linux Server iOS SDK
SSH 6.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "SSH.UserAuthPublicKeyFile"; SSH; Username; PublicKey; PrivateKey { ; Passphrase } )   More


Parameter Description Example Flags
SSH The SSH session reference number from the plugin. $ssh
Username user name to authenticate as. "cs"
PublicKey Path of the public key file. (e.g. /etc/ssh/
Optional. Pass empty text if you only have private key.
PrivateKey Path of the private key file. (e.g. /etc/ssh/hostkey) "/Users/cs/Desktop/id_rsa"
Passphrase Passphrase to use when decoding privatekey.
Can be empty.
"" Optional


Returns OK or error.


Authenticate a session with a public key, read from a file.
Attempt public key authentication using a PEM encoded private key file stored on disk.


Login with public key:

Set Variable [$r; Value:MBS( "SSH.UserAuthPublicKeyFile"; $ssh; SSH::Username; "your key path"; "your key path"; SSH::Password )]

Login with keys:

Set Variable [$r; Value: MBS( "SSH.UserAuthPublicKeyFile"; $ssh; SSH::Username; "/Users/cs/Desktop/"; "/Users/cs/Desktop/id_rsa"; SSH::Password ) ]

See also

This function checks for a license.

Created 29th May 2016, last changed 20th June 2016

SSH.UserAuthPublicKey - SSH.WaitClosed