hsc_codesafe

hsc_codesafe

Automatically loads, configures, and starts a CodeSafe 5 container on a specified nShield module. It is typically executed during module startup by the hardserver, but it can also be run interactively for troubleshooting or testing purposes.

Privileges and access requirements

All nCore operations require a privileged client. On Windows, run the command from an elevated command prompt. On Linux, the invoking user must be a member of the nfast group.

Launcher (csadmin) operations additionally require membership of the nfastadmin group on Linux, or an elevated command prompt on Windows.

For auto-enrollment to succeed with an nShield 5 HSM, the module must be enrolled as privileged on the local hard server. You must run this utility as nfast or root on Linux, or from an elevated command prompt on Windows.

Options

Option Description

Option	Description
`-m MODULE`, `--module MODULE`	Module number of the HSM on which to load the CodeSafe container.
`-c CONFIG`, `--config CONFIG`	Configuration file path. You only need this option if the configuration file is not in the standard location.
`-h`, `--help`	Displays help for `hsc_codesafe`.

-m MODULE, --module MODULE

Module number of the HSM on which to load the CodeSafe container.

-c CONFIG, --config CONFIG

Configuration file path. You only need this option if the configuration file is not in the standard location.

-h, --help

Displays help for hsc_codesafe.

Positional arguments and interactive execution

hsc_codesafe accepts optional positional arguments in the form name=value. These arguments override fields from the [codesafe] section of the configuration file for the current invocation. The argument names must exactly match field names in the CodeSafe configuration.

If a -- argument separator is supplied, all subsequent arguments are treated as a command line to run after the CodeSafe container has been loaded. The following special values are supported:

pause Runs until interrupted with Ctrl-C.
exit Terminates successfully after the container has finished loading.

When a command line is executed in this way, the SEEJobs SSH tunnel and any published objects are removed after the command terminates. The exit code of hsc_codesafe is the exit code of the executed command.

If no command line is provided, the behavior matches execution during hardserver startup. The process continues running only if an SSH tunnel has been established for SEEJobs support. In this case, any published object is removed automatically.