Hub Location

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.

CodeSonar^® 9.2p0

CONFIDENTIAL

CodeSecure Inc

General

Hub Location

A hub's location refers to its network host and port.

The location is established when the hub is started; further interactions with the same hub must specify a compatible network address. For example, if you were on a machine with address 2001:db8::abcd and started a hub at [::1]:7340, you would not be able to access that hub through [2001:db8::abcd]:7340.

Choosing A Location
SaaS Hub Location
Is A Hub Running At host:port?
How CodeSonar Determines Hub Location
I've Forgotten My Hub Location
Other Hub Sections

Choosing A Hub Location

Choose a hub location that all hub users can access.

All analysis machines must be able to connect to the hub.
All users that will want to use the web GUI must be able to connect to the hub.

For advice on selecting a hub interface, see Setting Up The Hub: Important Decisions.

Important: do not run a hub at a location that is visible to the whole internet.

Your analyzed code will be exposed.
Malicious users may be able to gain access to other locations in your file system.
The CodeSonar functionality and interface will be exposed, in violation of the license agreement.

If you need to access the hub from offsite locations, use a VPN. For example, you can run a hub at location A and access it through an SSH tunnel from location B as described in ssh Tunnel to a Hub.

SaaS Hub Location

CodeSonar SaaS hubs always have a location of the form:

https://hmname.codesonar.com:port

SaaS hubs always use HTTPS.
The combination of hmname and port will uniquely identify your hub.

Is A Hub Running At host:port?

To check whether a hub is running at location host:port, use a web browser to open the URL:

http://host:port
[or]
https://host:port

Depending on whether or not the hub is configured to use HTTPS.

If a hub is running at host:port, the hub Home page will be displayed. If no hub is running, the browser will display an error message (or a completely unrelated page, if some other web server is running at host:port).

Warning: do not omit the protocol (http:// or https://) component of the URL. This can confuse the browser and cause it to display an error message even if a hub is running.

How CodeSonar Determines Hub Location

The following codesonar commands have associated hub locations.

CodeSonar determines the hub locations associated with these commands as follows.

If the command explicitly specifies a hub location, CodeSonar will use that location.
[Command line only.] Otherwise, if the HUB_ADDRESS configuration file parameter is defined, CodeSonar will use the value of that parameter.
Note that the CodeSonar configuration tool sets this parameter to an appropriate value in the general template configuration file when you connect to an existing hub or create a hub and specify that you would like to use it as the default hub for your installation.
- hub-info, hub-start, hub-stop, generate-hub-cert, dump_warnings.py:
  HUB_ADDRESS must be set in the general template configuration file.
- analyze, build, relocate:
  HUB_ADDRESS can be set in any configuration file used by the command.
Otherwise, if the CODESONAR_HUB environment variable is defined, CodeSonar will use the value of that variable. The value should have one of the following forms.
- host:port
- http://host:port
- https://host:port
We recommend using CODESONAR_HUB only if you have exactly one hub.
Otherwise,
- hub-start commands will fail.
- All other commands will use the factory default location, specified as either 127.0.0.1:7340 or [::1]:7340 depending on the default loopback adapter suggested by your OS.

Protocol Note

For CodeSonar commands that take hub location arguments, you can optionally specify a protocol for the command to use to connect to the hub.

host:port	If you don't specify a protocol with your hub location, CodeSonar will will try http:// first, then redirect to the equivalent https:// URL if directed to do so by the hub.
http://host:port	CodeSonar will try to connect to the hub with HTTP. If the hub is configured to use HTTPS, the connection will fail.
https://host:port	CodeSonar will try to connect to the hub with HTTPS. If the hub is not configured to use HTTPS, the connection will fail. Always explicitly specify https:// if you are concerned about security, otherwise you may be sending unencrypted data to an imposter hub.

I've Forgotten My Hub Location

See FAQ: I don't remember where I put my hub: how can I find it?

Other Hub Sections

To report problems with this documentation, please visit https://support.codesecure.com/.