Difference between revisions of "SSH Multiplexing"

From UFRC
Jump to navigation Jump to search
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
If use use a Linux or MacOS computer and your workflow involves making a lot of connections to HiPerGator you may want to use SSH Multiplexing to avoid having to go through MFA for every connection.  
+
If you use a Linux or MacOS computer and your workflow involves making
 +
a lot of connections to HiPerGator you may want to use SSH
 +
Multiplexing to avoid having to go through MFA for every
 +
connection. Again, this does not work for Windows computers natively!
 +
The [https://www.bitvise.com/ BitVise] and [https://tabby.sh/ Tabby] clients are the only SFTP/ssh
 +
client we are aware of that support ssh multiplexing.
  
{{Note|Unfortunately, our testing has shown that this generally does not work for Windows computers.|warn}}
+
In a nutshell, ssh multiplexing works by creating a TCP socket the
 +
first time a connection is made. That socket can be used by subsequent
 +
connections within the idle timeout period to create new connections
 +
without triggering MFA.
  
In a nutshell, ssh multiplexing works by creating a TCP socket the first time a connection is made. That socket can be used by subsequent connections within the idle timeout period to create new connections without triggering MFA.
+
See [https://blog.scottlowe.org/2015/12/11/using-ssh-multiplexing/]
 +
for reference.
  
See [https://blog.scottlowe.org/2015/12/11/using-ssh-multiplexing/] for reference.
+
==Multiplexing with username and password==
 +
To use SSH multiplexing with your username and password (without SSH key authentication).
 +
edit the ssh configuration file on your local computer (typically
 +
<code>~/.ssh/config</code>) and add or modify the following entry.  Be
 +
sure to change the 'albertgator' <code>User</code> to your username:
  
Example with SSH key authentication that enables SSH multiplexing. Each subsequent connection resets the idle timeout countdown:
+
<pre>
 +
Host hpg
 +
    User albertgator
 +
    HostName hpg.rc.ufl.edu
 +
    ControlPath ~/.ssh/cm-%r@%l-%h:%p
 +
    ControlMaster auto
 +
    ControlPersist 8h
 +
</pre>
 +
 
 +
Note: On a MacOS system, if you see a 'unix listener too long' error, you may have to create a ~/.ssh/control directory and use
 +
  ControlPath ~/.ssh/control/%C
 +
in the ~/.ssh/config
 +
 
 +
After the <code>~/.ssh/config</code> changes, use this ssh command:
 +
$ ssh hpg
 +
 
 +
NOTE: The "hpg" hostname is not a real hostname, instead it's a virtual hostname that you defined in the above configuration.
 +
 
 +
==Multiplexing with SSH keys==
 +
If you are using SSH key-based authentication, add this block instead. This configures the connection to go to a different port (2222) which is expecting ssh keys:
  
Edit the ssh configuration file on your local computer (typically <code>~/.ssh/config</code>) and add or modify the following entry:
 
 
<pre>
 
<pre>
 
Host hpg
 
Host hpg
Line 19: Line 50:
 
     ControlPersist 8h
 
     ControlPersist 8h
 
</pre>
 
</pre>
 
{{Note|If you use username and password remove the <code>Port 2222</code> line from the configuration.<br>Be sure to change the <code>User</code> to your username.|info}}
 

Latest revision as of 20:15, 2 May 2022

If you use a Linux or MacOS computer and your workflow involves making a lot of connections to HiPerGator you may want to use SSH Multiplexing to avoid having to go through MFA for every connection. Again, this does not work for Windows computers natively! The BitVise and Tabby clients are the only SFTP/ssh client we are aware of that support ssh multiplexing.

In a nutshell, ssh multiplexing works by creating a TCP socket the first time a connection is made. That socket can be used by subsequent connections within the idle timeout period to create new connections without triggering MFA.

See [1] for reference.

Multiplexing with username and password

To use SSH multiplexing with your username and password (without SSH key authentication). edit the ssh configuration file on your local computer (typically ~/.ssh/config) and add or modify the following entry. Be sure to change the 'albertgator' User to your username:

Host hpg
    User albertgator
    HostName hpg.rc.ufl.edu
    ControlPath ~/.ssh/cm-%r@%l-%h:%p
    ControlMaster auto
    ControlPersist 8h

Note: On a MacOS system, if you see a 'unix listener too long' error, you may have to create a ~/.ssh/control directory and use

  ControlPath ~/.ssh/control/%C

in the ~/.ssh/config

After the ~/.ssh/config changes, use this ssh command:

$ ssh hpg

NOTE: The "hpg" hostname is not a real hostname, instead it's a virtual hostname that you defined in the above configuration.

Multiplexing with SSH keys

If you are using SSH key-based authentication, add this block instead. This configures the connection to go to a different port (2222) which is expecting ssh keys:

Host hpg
    User albertgator
    HostName hpg.rc.ufl.edu
    Port 2222
    ControlPath ~/.ssh/cm-%r@%l-%h:%p
    ControlMaster auto
    ControlPersist 8h