Task: ssh Tunnel to a Hub

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

Sometimes for one reason or another you might want to access a hub running on machine A from machine B, but cannot do so directly. For example, it may be the case that:

Machine A has, or is behind, a firewall that prevents direct connections to the hub.
The two machines are on entirely different networks.
For security reasons, you do not want to expose the hub to everyone with network access to A.

An ssh tunnel can provide a connection path from B to A with the encryption and authentication facilities of ssh, provided that an ssh daemon is running on A or some machine C with direct network access to A. Note that all users on B will have access to the hub, not just the user who created the ssh tunnel.

The method for setting up an ssh tunnel from B to A depends on whether or not A is running an ssh daemon.

If A is running an ssh daemon:

Check: is a hub already running at location A?

YES: Take note of the port. The default is 7340.
NO: At location A, select a port for the hub, then start the hub on that port. We will refer to this port as hubport.
codesonar hub-start [::1]:hubport
(See the IPv4 note if your system does not support IPv6 addresses.)

At location B, map local port Bport to the hub port with an ssh command:

ssh -LBport:[::1]:hubport A

Now use [::1]:Bport on B to access the hub:

Use http://[::1]:Bport as the base URL for accessing the CodeSonar GUI.
Specify http://[::1]:Bport as the hub when running CodeSonar analyses on B.

If A is not running an ssh daemon, but some machine C with unrestricted network access to A is running an ssh daemon:

Check: is a hub already running at location A?

YES: Take note of the port. The default is 7340. Make sure A is listening on all interfaces.
NO: At location A, select a port for the hub, then start the hub on that port. We will refer to this port as hubport.
codesonar hub-start [::]:hubport
(See the IPv4 note if your system does not support IPv6 addresses.)

At location B, map local port Bport to the hub port with an ssh command:

ssh -LBport:A:hubport C

Now use [::1]:Bport on B to access the hub:

Use http://[::1]:Bport as the base URL for accessing the CodeSonar GUI.
Specify http://[::1]:Bport as the hub when running CodeSonar analyses on B.

If your system does not support IPv6 addresses, use IPv4 to specify addresses instead.

127.0.0.1 instead of ::1

0.0.0.0 instead of ::