Monkeybread Software - MBS FileMaker Plugin: SSH

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

MBS FileMaker Plugin Example Databases

SSH

All examples are included with download of MBS FileMaker Plugin.

SSH.fmp12

Overview
Tables	1
Relationships	0
Layouts	1
Scripts	2
Value Lists	0
Custom Functions	0
Custom Menus	33

File Options
Default custom menu set	[Standard FileMaker Menus]
When opening file
Minimum allowed version	12.0
Login using	Account Name; Account= Admin
Allow user to save password	Off
Require iOS passcode	Off
Switch to layout	Off
Hide all toolbars	Off
Script triggers
OnFirstWindowOpen	Off
OnLastWindowClose	Off
OnWindowOpen	Off
OnWindowClose	Off
OnFileAVPlayerChange	Off
Thumbnail Settings
Generate Thumbnails	On; Temporary

Tables

Table Name	Statistics	Occurrences in Relationship Graph
SSH	8 fields defined, 3 records	SSH

Fields

Table Name: SSH - 8 Fields
Field Name	Type	Options	Comments	On Layouts	In Relationships	In Scripts	In Value Lists
Host	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Global Repetitions: 1 Index Language: German		SSH		Run
Port	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Global Repetitions: 1 Index Language: German		SSH		Run
Username	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Global Repetitions: 1 Index Language: German		SSH		Run
Password	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Global Repetitions: 1 Index Language: German		SSH		Run
Command	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		SSH		Run
Result	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		SSH		Run Clear
HostKeyHash	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		SSH		Run Clear
UserAuthList	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		SSH		Run Clear

Layout Objects: SSH

Regular Fields

Field Name: SSH::Host

Layout Name:

Top: 60 pt
Left: 138 pt
Bottom: 74 pt
Right: 391 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Field Name: SSH::Port

Layout Name:

Top: 78 pt
Left: 138 pt
Bottom: 92 pt
Right: 391 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Field Name: SSH::Username

Layout Name:

Top: 96 pt
Left: 138 pt
Bottom: 110 pt
Right: 391 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Field Name: SSH::Password

Layout Name:

Top: 114 pt
Left: 138 pt
Bottom: 128 pt
Right: 391 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Field Name: SSH::Command

Layout Name:

Top: 138 pt
Left: 138 pt
Bottom: 152 pt
Right: 391 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Yes

Field Name: SSH::Result

Layout Name:

Top: 156 pt
Left: 138 pt
Bottom: 362 pt
Right: 475 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Yes

Field Name: SSH::HostKeyHash

Layout Name:

Top: 366 pt
Left: 138 pt
Bottom: 380 pt
Right: 391 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Yes

Field Name: SSH::UserAuthList

Layout Name:

Top: 384 pt
Left: 138 pt
Bottom: 398 pt
Right: 391 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Script Name	Run
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	# Start a new SSH session Set Variable [ $ssh; Value:MBS( "SSH.New" ) ] # Connect to an IP Set Variable [ $r; Value:MBS( "SSH.Connect"; $ssh; SSH::Host; SSH::Port ) ] If [ MBS("IsError") ] Show Custom Dialog [ Title: "Connect error"; Message: $r; Default Button: “OK”, Commit: “Yes”; Button 2: “Cancel”, Commit: “No” ] Else # Run the session handshake. Set Variable [ $r; Value:MBS( "SSH.SessionHandshake"; $ssh) ] If [ MBS("IsError") ] Show Custom Dialog [ Title: "Connect error"; Message: $r; Default Button: “OK”, Commit: “No”; Button 2: “Cancel”, Commit: “No” ] Else # We can show the hostkey. You can compare it to known hostkey. Set Field [ SSH::HostKeyHash; MBS( "SSH.HostKey"; $ssh ) ] # We query supported authentication ways Set Variable [ $authuserlist; Value:MBS( "SSH.userauthlist"; $ssh; SSH::Username) ] Set Field [ SSH::UserAuthList; $authuserlist ] Set Variable [ $pos1; Value:Position ( $authuserlist ; "password"; 1; 1 ) ] Set Variable [ $pos2; Value:Position ( $authuserlist ; "keyboard-interactive"; 1; 1 ) ] Set Variable [ $pos3; Value:Position ( $authuserlist ; "publickey"; 1; 1 ) ] If [ $pos1 > 0 ] # Authenticate with password Set Variable [ $r; Value:MBS( "SSH.UserAuthPassword"; $ssh; SSH::Username; SSH::Password ) ] If [ MBS("IsError") ] Show Custom Dialog [ Title: "Connect error"; Message: $r; Default Button: “OK”, Commit: “No”; Button 2: “Cancel”, Commit: “No” ] End If Else If [ $pos2 > 0 ] # Authenticate with answering question. Plugin passes password for answer. Set Variable [ $r; Value:MBS( "SSH.UserAuthKeyboardInteractive"; $ssh; SSH::Username; SSH::Password ) ] If [ MBS("IsError") ] Show Custom Dialog [ Title: "Connect error"; Message: $r; Default Button: “OK”, Commit: “No”; Button 2: “Cancel”, Commit: “No” ] End If Else If [ $pos3 > 0 ] # Authenticate with public key file Set Variable [ $r; Value:MBS( "SSH.UserAuthPublicKey"; $ssh; SSH::Username; "your key path"; "your key path"; SSH::Password ) ] If [ MBS("IsError") ] Show Custom Dialog [ Title: "Connect error"; Message: $r; Default Button: “OK”, Commit: “No”; Button 2: “Cancel”, Commit: “No” ] End If End If If [ MBS( "SSH.IsAuthenticated"; $ssh ) ≠ 1 ] Show Custom Dialog [ Title: "Authentication"; Message: "no authenticated. Supported ways: " & $authuserlist; Default Button: “OK”, Commit: “Yes”; Button 2: “Cancel”, Commit: “No” ] Else # Start a new channel Set Variable [ $r; Value:MBS( "SSH.OpenSession"; $ssh ) ] If [ MBS("IsError") ] Show Custom Dialog [ Title: "Connect error"; Message: $r; Default Button: “OK”, Commit: “No”; Button 2: “Cancel”, Commit: “No” ] Else # Execute a command Set Variable [ $r; Value:MBS( "SSH.Execute"; $ssh; SSH::Command ) ] If [ MBS("IsError") ] Show Custom Dialog [ Title: "Connect error"; Message: $r; Default Button: “OK”, Commit: “No”; Button 2: “Cancel”, Commit: “No” ] Else # We read text in several chunks until no new text is coming any more: Set Variable [ $text; Value:"" ] Loop Pause/Resume Script [ Duration (seconds): ,1 ] # Read some text: Set Variable [ $newtext; Value:MBS( "SSH.ReadText"; $ssh; 10000; "UTF8" ) ] If [ MBS("iserror") = 0 ] If [ Length($newText) > 0 ] Set Variable [ $text; Value:$text & $newText ] End If Exit Loop If [ Length($newText) = 0 ] End If End Loop Set Field [ SSH::Result; $text ] End If End If # Close channel Set Variable [ $r; Value:MBS( "SSH.CloseChannel"; $ssh ) ] # Disconnect Set Variable [ $r; Value:MBS( "SSH.Disconnect"; $ssh ) ] End If End If End If # Release memory. Set Variable [ $r; Value:MBS( "SSH.Release"; $ssh ) ]
Fields used in this script	SSH::Host SSH::Port SSH::HostKeyHash SSH::Username SSH::UserAuthList SSH::Password SSH::Command SSH::Result
Scripts used in this script
Layouts used in this script
Tables used in this script	SSH
Table occurrences used by this script	SSH
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Run]

Script Name	Clear
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	Go to Record/Request/Page [ First ] Loop Set Field [ SSH::HostKeyHash; "" ] Set Field [ SSH::UserAuthList; "" ] Set Field [ SSH::Result; "" ] Go to Record/Request/Page [ Next; Exit after last ] End Loop Go to Record/Request/Page [ First ]
Fields used in this script	SSH::HostKeyHash SSH::UserAuthList SSH::Result
Scripts used in this script
Layouts used in this script
Tables used in this script	SSH
Table occurrences used by this script	SSH
Custom Functions used by this script
Custom menu set used by this script

Download example: SSH

Used functions: