Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5   8.0    Statistic  


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

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
SSH 6.3 Yes Yes Yes Yes Yes

MBS( "SSH.UserAuthPublicKeyFile"; SSH; Username; PublicKey; PrivateKey { ; Passphrase } )


Parameter Description Example value
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 Optional
Passphrase to use when decoding privatekey.
Can be empty.


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

SSH.UserAuthPublicKey   -   SSH.WaitClosed

Feedback: Report problem or ask question.

MBS Xojo tutorial videos