| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
SSH.UserAuthPublicKey
Authenticate a session with a public key, read from memory.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| SSH | 6.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "SSH.UserAuthPublicKey"; SSH; Username; PublicKey; PrivateKey; Passphrase ) More
Parameters
| Parameter | Description | Example |
|---|---|---|
| SSH | The SSH session reference number from the plugin. | $ssh |
| Username | user name to authenticate as. | "cs" |
| PublicKey | The public key. Optional. Pass empty text if you only have private key. |
"" |
| PrivateKey | The private key. A PEM encoded private key file stored in memory. |
|
| Passphrase | Passphrase to use when decoding privatekey. |
Result
Returns OK or error.
Description
Authenticate a session with a public key, read from memory.Attempt public key authentication using a PEM encoded private key file stored in text variable or field.
Examples
Login with keys:
Set Variable [$r; Value: MBS( "SSH.UserAuthPublicKey"; $ssh; "cs"; "";
"-----BEGIN RSA PRIVATE KEY-----¶
MIIEpQIBAAKCAQEAzXhH+HE2k8bpRvm4q9TlbD7B7/p2I0NXmVDz1CULU1FqN2OC¶
Q+3sUlUxWS2Fbyt5eTWeM5FkiYJyofjy6S+AK8C9+LmTS1NpMra8i4hnlgHwIfKk¶
LnzxzmECgYEA1hopk2yfGXZg8yMYKdRD1JToH0QDxpIRHjHFy17eKbj79opB6zfU¶
WuCgiy1S0oNZfM/5gzYrUCBSdjbpk23rN3JqKI8J9/E2Ry7q4z0uVlRuQUS6mBnn¶
+r6DhI+hCQP7nR5APxJkLPdOCanMKfjvEcwVwtcIAVz7sljR53J3e/A=¶
-----END RSA PRIVATE KEY-----"; "" ) ]
See also
- MongoDB.Connect
- SQL.Connect
- SSH.Connect
- SSH.Execute
- SSH.New
- SSH.Tunnel.Run
- SSH.UserAuthPublicKeyFile
Example Databases
This function checks for a license.
Created 8th June 2016, last changed 20th June 2016
