Hub Directory and Database

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 Directory and Database

The primary hub directory contains a results database and settings for both the database and the primary hub itself.

A satellite hub directory contains settings for a satellite hub. It does not contain any database information, because the satellite hub uses the same database as its associated primary hub.

Security Note
Primary Hub Directory
Satellite Hub Directory
Other Hub Sections

Security Note

For security reasons, the hub directory should only be accessible to the hub administrator or administrators.

In particular, this means that the hub directory should not be located under the CodeSonar installation directory, since the latter is mounted by the hub for all users to access.

Primary Hub Directory

The directory location depends on the command used to start the primary hub: it is the dir argument in

codesonar hub-start dir interface:port

If dir is located under the CodeSonar installation directory, the hub-start command will fail.
If dir exists and contains a hub database, the hub will be associated with that database.
If dir exists but was previously associated with a satellite hub, the hub-start command will fail.
Otherwise, CodeSonar will create a new database in dir for the hub to use. If dir does not already exist, it will be created.

Deleting a primary hub directory deletes the hub database. Do not delete the directory while the associated hub process is running. (Also, do not delete a hub database unless you are no longer interested in any of the results stored there.)

Hub Database

The hub database is PostgreSQL-based.

The CodeSonar GUI accesses the hub database through the hub: individual GUI pages such as warning reports and file search results are generated by querying the hub database. To execute your own queries on the hub database, use the SQL Console.

The hub database runs as PostgreSQL user cshubuser. If you need to directly run PostgreSQL commands that require PostgreSQL user authorization (for example, to back up/restore the hub database or move the hub to a new machine), specify -U cshubuser in the command, then provide the cshubuser password when prompted. For convenience, the password for the cshubuser PostgreSQL user is coupled to that for the Administrator hub account.

If you set the hub Administrator password as part of starting a hub or through the web GUI, the PostgreSQL cshubuser password will also be set to the same value.
The password is stored in plain text in file hubdir/dbpass, where hubdir is the hub directory. When this file is present, the password it contains is used to authenticate the CodeSonar hub-start command unless -setadminpw is also specified.
CodeSonar will set a new password when you start a hub if
- you specify -setadminpw as part of the CodeSonar hub-start command, or
- file hubdir/dbpass is not present.
In these cases, CodeSonar will set the new password as follows.
- If environment variable CSHUB_PASSWORD is defined, CodeSonar will use its value for the new password.
- Otherwise, CodeSonar will prompt you to enter the new password, then to enter it again for confirmation.

PostgreSQL Environment Variables

Setting any of the PostgreSQL environment variables, especially any that deal with connecting via TLS, can prevent new hubs from being created and may prevent you from starting existing hubs.

In particular:

New hubs are always created with TLS disabled in the hub database. Any PostgreSQL environment variable settings that specify the use of TLS will result in failed communication with the new hub database and so hub creation will fail.
Existing hubs and their databases have coordinated configurations. PostgreSQL environment variable settings will take precedence over these configurations, so any conflict will cause hub connections — and thus hub startup — to fail.

Satellite Hub Directory

The directory location depends on the command used to start the satellite hub: it is the dir argument in

codesonar hub-start
[-auth authtype] [-hubuser username] [-hubpwfile pwfile] [-hubbearerfile bearerfile] [-hubcert certfile] [-hubkey privatekeyfile]
-satellite-of primhost:primport dir sathost:satport

If dir is located under the CodeSonar installation directory, the hub-start command will fail.

Other Hub Sections

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