CMU - CodeMeter Universal Support Tool

You have also the option to alternatively execute some CodeMeter Control Center functions by the commandline based CodeMeter Universal Support Tool (cmu).

cmu supports you in:

•listing of CmContainer contents

•creating a simple test environment for CmContainer

•executing a certified time update, and creating and importing of license request and update files (Context Files and Update Files, *.WibuRaC and *.WibuRaU).

Call cmu in the directory %\Program Files%\CodeMeter\Runtime\bin using the command cmu[32].exe.

WIN

Alternatively, on Windows call cmu by the start menu item "Start | All Programs | CodeMeter | Tools | CodeMeter Command Prompt".

win8_logo

Press "Windows" key to open Start screen | Type "CodeMeter Command Prompt" | Press "Enter" key.

For the operating systems MacOS macOS and LINUX Linux this command is provided by the usual search path parameter.

The following list shows all existing cmu commands. A short example section is appended.

•General settings

•CodeMeter Time Server settings

•

•Named User licenses

•Additional cmu options

•Examples

 

General settings

Command

Description

/h or --help

shows this help in the commandline window.

/v or --version

shows the versions of all available CodeMeter components.

/l or--list

lists all connected CmContainer by way of their serial numbers.

/x or --list-content

lists the contents of all connected CmContainer.

/k or --list-server

lists all available network license server.

/n or –-list-network

lists the network license information of the own server.

For explanations of terms, e.g. access modes, please see information on license monitoring and terms in license display in CodeMeter WebAdmin.

 

lists network license information also of remote CodeMeter server.

-list-network [--server <servername>|--all-servers] [--serial <serial>] [--firmcode <firmcode> [--productcode <productcode> [--featuremap <featuremap>]]]

 

--all-servers

lists the network license information for all found servers.

 

--server <servername>

lists the network license information for the specified server <servername>.

 

--serial <serial>
--firmcode <firmcode>
--productcode <productcode>
--featuremap <featuremap>

specified parameter configure the output according to criteria selected.

--add-server

adds a server to the end of your server search list. As an argument pass the server's name, IP or CmWAN URL.

Examples:

server.domain.local

192.168.0.72

fe80::ea06:88ff:fecf:df6f

https://user:secretpassword@server.domain.local/cmwan

--delete-server

deletes a server from the server search list. As an argument pass the server's name, IP or CmWan URL as it is listed.

-- clear-serversearchlist

deletes all the entries from the server search list. To reactivate automatic server broadcast, please add broadcast using option "--add-server 255.255.255.255".

--show-serversearchlist

shows the entries in the server search list.

/c <FI> or --context <FI>

creates a license request file (Context File) for Firm Item <FI> (see here).

Using option --file specifies the output file. If no option is set the standard output is used (stdout).

/i or --import

imports a license update file (Update File) for the available CodeMeter license (see here).

Using option --file specifies the file name. The update can cover a CmDongle or a CmActLicense license file.

/d or --firmware-update

starts the firmware update of a CmContainer.

/u or --time-update

starts the update of the Certified Time in each connected CmContainer.

/e <s> or --enable <s>

allows the activation or deactivation of the selected CmContainer. Specifying the CodeMeter password is required.

The required new Enabling status is specified by the parameter <s>. Parameter values cover 1 (disable), 2 (temporary enable), 3 (enable).

/t <no> or --test<no>

starts some simple tests for each connected CmContainer. The number of tests is specified by parameter <no>.

It is required that the CmContainer must be (temporarily) enabled.

/vv or --cmdust

creates a CmDust report. This report is useful and required when requesting support. Wibu-Systems recommends to create a CmDust report before contacting the support.

Using the option --file writes the result into a text file.

--borrow

allows the borrowing of licenses from a license server to the local PC. You have to specify the Firm Code and the Product Code of the license using the options --firmcode and --productcode. As an additional option you may specify the Feature Map using the option --featuremap. Moreover, you have to specify the serial number of the client CmContainer and the server name using the options --serial and --server.

--return

returns the borrowed license to the license server. You have to specify the Firm Code and the Product Code of the license using the options --firmcode and --productcode and the serial number of the client CmContainer and the server name using the options --serial and --server.

--borrowlist

lists the borrowed licenses for the client and the server.

--transferlist

creates a listing of the license transfer relevant data.

--enabling

lists the enabling stati of all connected CmContainer.

Combined with the command –x you can also display additional enabling information of the CmContainer content.

--create-io

is used in combination with the option --file and makes sense only when using the hardware form factors CmCard/SD or CmCard/CF. A new codemtr.io file is created.

Please call this command only if the codemtr.io file is deleted.

--detect-proxy

prints the system proxy to standard output..

Please note, that under LINUX Linux, the environment variable http_proxy is considered as system proxy. https_proxy is not yet supported.

--delete-cmact-license

deletes a CmActLicense license you specify using the command --serial.

information_grau_klein26

Once you delete a CmActLicense license it cannot be restored.

--set-access-data

activates WebAdmin write authentication and saves the password. Use with option --password to define password.

--set-proxy

sets CodeMeter proxy configuration. As argument pass the name or IP address of the proxy server.

A port different to the default port (80) may be defined by --port followed by the port number.

A user password authentication may be set by --username <name of the user> --password <password>.

To remove the authentication use --username followed by "".

--use-system-proxy

on setting the proxy the system proxy is used.
In the profiling or the server.ini file then the entry UseSystemProxy is set to a value of 1.
The entry has the value 0, if --set-proxy is used.

Please note, that under LINUX Linux, the environment variable http_proxy is considered as system proxy. https_proxy is not yet supported.

Examples:

cmu --set-proxy proxy.company.com --username johndoe --password mypassword --port 90

cmu --set-proxy proxy.company.com --username ""

--reset-access-data

deletes both passwords for WebAdmin authentication (read- and write-passwords) and sets default (no read authentication, no write authentication). "Local Access only" will be set.

--device-id

sets this parameter on import of WibuCmLiF files (--import) with binding scheme "Binding Extension".

The input of the device-id is as 128 hex digits preceeded by "0x".

--hid

sets the USB communication standard to the Human Interface Device (HID) class specification.

Shortcut for --set-config-disk HidCommunication.

May be used with or without specifying a serial number via --serial.

Without specifying the command will be executed for all connected CmDongles.

--msd

sets the USB communication standard to the Mass Storage Device (MSD) class specification.

Shortcut for --set-config-disk MsdCommunication.

May be used with or without specifying a serial number via --serial.

Without specifying the command will be executed for all connected CmDongles.

CodeMeter Time Server Settings

information_weiss_klein26

Please note that only Wibu-Systems CodeMeter Time Servers may be specified here.

You cannot specify your own NTP (Network Time Protocol) time servers here, as this time synchronization does not guarantee a Certified Time, which plays an important role, for example, when retrieving and subsequently validating time-based licenses.

--add-timeserver

appends a single CodeMeter Time Server to your Time Server list. As argument, pass the Server name or IP address (IPv5 or IPv6).

--delete-timeserver

deletes a single CodeMeter Time Server from your Time Server list. As argument, pass the Server name or IP address (IPv5 or IPv6).

--clear-timeserver-list

removes all entries from the CodeMeter Time Server list.

--set-timeserver-default

sets the CodeMeter Time Server settings to default parameters.

•CodeMeter Time Servers: cmtime.codemeter.com, cmtime.codemeter.de, cmtime.codemeter.us

•Timeout: 20 seconds

•Protocol: http

--show-timeserver-info

shows the entries in the CodeMeter Time Server list.

--set-timeserver-timeout

sets the timeout of the CodeMeter Time Server in seconds.

Value range is between 1 and 120. Default value is 20 seconds.

--set-timeserver-protocol

sets one of the protocols HTTP or HTTPS for CodeMeter Time Server.

Creating and importing a namelist of Named User

To restrict access to licenses to so-called named users, external namelist files must be used. This process is done in two steps:

1.Creating the namelist file

A namelist file includes a list of authorized users in plain text entries and must conform to a JSON format. The format is specified by Wibu-Systems.

2.Mandatory importing of the namelist file

Cmu converts the plaintext entries of the namelist file into a list of hash values

achtung

After importing and converting the plaintext entries into hash values by cmu, the hash values cannot be exported back to the original plaintext entries: recovery is not possible in any case.

You are therefore responsible for saving the data yourself!

Creating a namelist

To create the namelist file you need information from software vendors about

•the Firm Code used,

•the JSON format version and

•the unique identifier of the name list (NamelistId).

The following applies to a namelist:

•There is a format version that is easy to edit and extend.

•It is possible to change the namelist file without restarting CodeMeter.
That is importing a changed namelist file is possible at any time without a restart, which then becomes valid, but this does not mean that it is possible to change the file in CodeMeter itself.

•For security reasons no plain names are kept in memory.

•The file can be assigned to one or more product items via NameListId and Firm Code.

•A maximum of 5000 named users are allowed per namelist.

•CodeMeter uses a maximum of 250 namelists.

It is possible to add users to the namelist multiple times, whereby the total frequency, the entry position and the License Quantity are taken into account and allow list control.

With a number of licenses n and a number of m entries applies:

•If the number of entries m is greater than the number n of available licenses, only the first n entries are used.

•If, on the other hand, the number of entries m is less than the number n of available licenses, only the m entries are used; if the license is created with the singlealloc option, the remaining n-m licenses cannot be used.

Please find example files for each credential type with parameters and descriptions below.

•Credential type: UserName

•Credential type: UserDomain

•Credential type: UserDefined

Credential type: UserName

{ 

    "NameList": {

        "FirmCode": 6000010,

        "FormatVersion": 2,

        "Mode": "User",

        "NameListId": 1234,

        "Users": [

            {

                "Name": "Jane"

            },

            {

                "Name": "Alice"

            },

            {

                "Name": "Bob"

            }

        ]

    }

}

 

Parameter

Description

FirmCode

holds the Firm Code to which the namelist refers.

FormatVersion

holds the valid version of the JSON format.

Mode

holds the credential type and the respective check mode.
Here the mode "User".

NameListId

holds the unique identification number of the namelist.

Users

holds the array of elements of type "Users".

Name

holds the respective name of the user eligible for an authorized license access as NamedUser.

 

Credential type: UserDomain

{

    "NameList": {

        "FirmCode": 6000010,

        "FormatVersion": 2,

        "Mode": "UserDomain"

        "NameListId": 5678,

        "Users": [

            {

                "Domain": "MyCompany",

                "Name": "Jane"

            },

            {

                "Domain": "MyCompany",

                "Name": "Alice"

            },

            {

                "Domain": "MyCompany",

                "Name": "Bob"

            }

        ]

    }

}

 

Parameter

Description

FirmCode

holds the Firm Code to which the namelist refers.

FormatVersion

holds the valid version of the JSON format.

Mode

holds the credential type and the respective check mode.
Here the mode "UserDomain".

NameListId

holds the unique identification number of the namelist.

Users

holds the array of elements of type "Users".

Domain

holds the respective name of the domain eligible for an authorized license acccess as NamedUser.

Name

holds the respective name of the user eligible for an authorized license acccess as NamedUser.

 

Credential type: UserDefined

{

    "NameList": {

        "FirmCode": 6000010,

        "FormatVersion": 2,

        "Mode": "UserDefined"

        "NameListId": 91011,

        "Users": [

            {

                "UserDefinedText": "ABCSoftwareModule1"

            },

            {

                "UserDefinedText": "ABCSoftwareModule2"

            },

            {

                "UserDefinedText": "ABCSoftwareModule3"

            }

        ]

    }

}

 

Parameter

Description

FirmCode

holds the Firm Code to which the namelist refers.

FormatVersion

holds the valid version of the JSON formatv.

Mode

holds the credential type and the respective check mode.
Here the mode "UserDefined".

NameListId

holds the unique identification number of the namelist.

Users

holds the array of elements of type "Users".

UserDefinedText

holds the respective user-defined text eligible for an authorized license acccess as NamedUser.

Importing a namelist of named users

Using external namelist files requires an import via the following cmu command after their creation.

Options

Description

--import-namelist -f <NameList.txt>

imports a list of of name user (namelist) in the JSON format to allow using the feature Named User. Using -f allows to specify path information and file name, e.g. NameList.txt.

Cmu converts the entries of the namelist file into a list of hashes. Using another cmu command allows the hash output of this Namelist to stdout.

achtung

After importing and converting the plaintext entries into hash values by cmu, the hash values cannot be exported back to the original plaintext entries: recovery is not possible in any case.

You are therefore responsible for saving the data yourself!

The cryptographic hash function Secure Hash Algorithm sha256 is used to ensure the integrity of the data.

Only the first 8 bytes are used for the user hash values, but the full 32 bytes are used for the hash value of the entire file.

If an empty namelist file is imported, i.e. without specification of named users, CodeMeter deletes the associated file if it exists.

If a namelist file is re-imported, occupied license accesses are not released. If users suddenly no longer have authorization due to a change in the namelist file, they will also no longer be assigned new license accesses. However, previous license accesses can still be used.

The locations of the imported namelist then generated by cmu for the different operating systems are:

Operating system

Location

WIN win8_logoWindows

%ProgramData%/CodeMeter/NamedUser

MacOS macOS

/Library/Application Support/CodeMeter/NamedUser

LINUX Linux

/var/lib/CodeMeter/NamedUser

The notation bases on Firm Code and NameListId, e.g. 6000010-2222.txt.

Subsequently, CodeMeter handles license accesses of users on the namelist.

Hash output of a namelist file

Option

Description

--show-namelisthashes -f <filename>

outputs the hashes of a namelist file into file <filename>..

Each line outputs a single Named User entry of the namelist.

Each line contains exactly two fields separated by a tab.  

Field

Description

1

contains the credential type entry (modes), i.e. either User, UserDomain or Userdefined.

The strings are shortened here to the lengths that are specified internally by the CMCREDENTIAL structure and over which hashing is performed.

2

represents the credential type entry as an 8-byte hash in hex string format.

The output is in UTF-8 format on stdout and can be further processed from there with appropriate applications, e.g. programming language awk for processing and evaluation of any text data.

beispiel

cmu[32].exe --show-namelist-hashes -f NamedUserHashing_user.json

Output is:

abcdefghijklmn\abcdefghijklmnopqrstuvwxyz01234        8094ca566d14d155

abcdefghijklmn\abcdefghijklmnopqrstuvwxyz01234        8094ca566d14d155

abcdefghijklmn\abcdefghijklmnopqrstuvwxyz01234        8094ca566d14d155

abcdefghijklmn\abcdefghijklmnopqrstuvwxyz01234        8094ca566d14d155

abcdefghijklmn\abcdefghijklmnopqrstuvwxyz01234        8094ca566d14d155

abcdefghijklmn\abcdefghijklmnopqrstuvwxyz0123        f25227d24bb65ac4

abcdefghijklmn\abcdefghijklmnopqrstuvwxyz0123        f25227d24bb65ac4

abcdefghijklmn\abcdefghijklmnopqrstuvwxyz012ä        de77086674e55409

abcdefghijklmn\abcdefghijklmnopqrstuvwxyz012        a1c4b5951eb70a1f

 

Additional cmu options

The following list shows additional cmu options:

Options

Description

/f <file> or --file <file>

Additional option which writes the command result into a file <file>. This option is used in combination with the commands --context, --import, --cmdust.

/s <serial> or --serial <serial>

Additional option which defines that a command is valid only for a CmContainer specified by its serial number <serial>, e.g. "1-10234242".

/p <pwd> or --password <pwd>

Additional option in combination with the commands --enable and --firmware-update. This option defines the required CodeMeter Password for this command.

--firmcode <fc>

Additional option in combination with the commands --borrow or --return specifying the Firm Code of the borrowed license.

--productcode <pc>

Additional option in combination with the commands --borrow or --return specifying the Product Code of the borrowed license.

--featuremap <fm>

Additional option in combination with the commands --borrow or --return specifying the Feature Map of the borrowed license.

--server <servername>

Additional option to borrow a license from another server. Is used in combination with command --borrow.

--write

Additional option used in combination with the command --detect-proxy which saves the setting using the CodeMeter profiling. These settings are written only if no proxy has been previously set in the profiling. For overwriting the settings use the option --force.

--force

Additional option used in combination with the command --detect-proxy which overwrites already existing proxy settings in the CodeMeter®profiling.

--show-config-disk

Shows the current settings of removable/fixed drives or of the type of the defined Master Boot Record (MBR).

This option concerns the behavior of virtual flash memory partitions. Use only for CmStick and CmStick/M.

--set-config-disk <parameter>

Allows to define a special behavior of virtual flash memory partitions, e.g. drive settings, boot code or activations (CmDongle only).

information_grau_klein26

Please note that replugging of the CmDongle is required.

Description

Parameter

Drive settings

RemovableDisk,LocalDisk

Boot Code

Int18Boot,ZeroBoot,LoopBoot,SwapBoot,VbrBoot

Activation

ActivePartition,InactivePartition

FAT

Fat16,Fat32

USB-Communication Device Class

HidCommunication; MsdCommunication

--check-cm-integrity

Allows to check the CodeMeter signature.

--licensing-terms

Print licensing terms of GNU Lesser General Public License (LGPL) 3.0.

--export-acl

allows you to export the list of License Access Permissions (ACL, Access Control List).

Please use the --file option to specify the file name.

The specification of absolute paths is supported. If no path is specified, the file is located in the local directory.

The export is possible during operation, the CodeMeter WebAdmin service does not have to be stopped or started separately.

The list is exported in *.json format. No file extension must be specified. The file is editable. For information about format conventions to be used please contact Wibu-Systems Support.

information_grau_klein26

Currently this command is only supported for Windows operating systems. A support of Triple Mode Redundancy (TMR) is currently not implemented.

--import-acl

allows you to import the list of License Access Permissions (ACL, Access Control List).

Please use the --file option to specify the file name.

The specification of absolute paths is supported. If no path is specified, the file is located in the local directory.

The import is possible during operation, the CodeMeter WebAdmin service does not have to be stopped or started separately.

The list is imported in *.json format. No file extension must be specified. The file is editable. For information about format conventions to be used please contact Wibu-Systems Support.

information_grau_klein26

Currently this command is only supported for Windows operating systems. A support of Triple Mode Redundancy (TMR) is currently not implemented.

Application examples

Action

Parameter

Displaying cmu options

Cmu[32].exe -h

Creating a CodeMeter Remote Activation Context File (here:1-1040870.WibuCmRaC) for the Firm Code 10 (Firm Item level)

Cmu[32].exe -c10 -f1-140870.WibuCmRaC

Importing a CodeMeter Remote Activation Update File (here:1-1040870.WibuCmRaU) --> reprograms the connected CmContainer

Cmu[32].exe -i -f1-1040870.WibuCmRaU

Showing the versions of current CodeMeter components.

cmu[32] --version

Listing all available CodeMeter network license server and if existing all related licenses.

cmu[32] --list-server --list-content

Starting 100 simple tests. The tests are executed only for the CmContainer specified by the serial number of 1-233232.

cmu[32] --test 100 --serial 1-233232

Changing the enabling status to "temporarily enabled" for the CmContainer 1-2345 by using the CodeMeter password "SECRET".

cmu[32] --enable2 --serial 1-2345 --password SECRET